SapABAPCode Bean
Properties Methods Events Configuration Settings Errors
The SapABAPCode provides an easy way to execute ABAP code on a remote R/3 (NetWeaver) system.
Syntax
InERP.Sapabapcode
Remarks
The purpose of this bean is to make executing ABAP code on a SAP server extremely simple.
There are just a few steps you need to make before you can begin executing ABAP code: First you set your connection credentials and connect to the SAP system (see Setting Up a Connection with a SAP System for details).
Then simply add the CodeLines and then call ExecuteCode. Once ExecuteCode has successfully returned, the resulting lines will be populated in ResultLines.
The following example shows how to execute some simple ABAP code on the SAP server. First we provide
login credentials and connect.
SapClient1.SapConnection.ConnectionType = ConnectionTypes.ctNetWeaver; SapClient1.SapConnection.Client = "000"; SapClient1.SapConnection.Destination = ""; SapClient1.SapConnection.Host = "localhost"; SapClient1.SapConnection.User = "BCUSER"; SapClient1.SapConnection.Password = "minisap"; SapClient1.SapConnection.SystemNumber = 0; SapClient1.OpenConnection();Note that the credentials above are for connecting to a trial NetWeaver installation. You will need to provide your own credentials when connecting to your own SAP installation.
Now we will provide the lines of code we wish to execute and then execute them on the server.
SapAbapCode1.CodeLines = "REPORT EXTRACT LINE-SIZE 255 NO STANDARD PAGE HEADING.\n" + "TABLES: USR02.\n" + "SELECT * FROM USR02.\n" + " WRITE: / USR02-BNAME, USR02-BCODE.\n" + "ENDSELECT."; SapAbapCode1.ExecuteCode();Note that the code lines must no more than 72 characters long and be terminated by either a CR, LF, or CRLF. To output the results, you can do this:
Console.WriteLine(SapAbapCode1.ResultLines);The above code should output something similar to this:
BCUSER 299A15CAA9831803 DDIC F34FC4466D323C60 SAP* F4CE7D330D91AAB6 SAPCPIC 7D806C248F03813D TMSADM 942B9DC0F2394D85Note that the result lines will always be less than 72 characters long and each line will be terminated by an LF.
Dependency Notes
If the bean is not configured to use the SOAP interface, it will use the sapnwrfc.dll, librfc32.dll, librfc32u.dll, or the Java Connector (JCo) to connect to the SAP system. Although the Java Connector is only available when programming in Java on Windows.
The NetWeaver RFC SDK (sapnwrfc.dll) offers both a 32 bit and 64 bit version. Likewise, the SAP RFC SDK offers as 32 bit and 64 bit version of both a unicode (librfc32u.dll) and non-unicode (librfc32.dll) library.
The NetWeaver RFC SDK will be used if the ConnectionType is set to ctNetWeaver (0). The following libraries from the NetWeaver RFC SDK must be available at runtime:
- sapnwrfc.dll
- icudt30.dll
- icuin30.dll
- icuuc30.dll
- libicudecnumber.dll
- libsapucum.dll
The non-unicode library will be used if the ConnectionType is set to ctClassic (1). This simply requires that the librfc32.dll be placed in a location that is accessible at runtime. (0).
The unicode library will be used if the ConnectionType is set to ctClassicUnicode (2). The following libraries from the SAP RFC SDK must be available at runtime:
- librfc32u.dll
- icudt30.dll
- icuin30.dll
- icuuc30.dll
The Java Connector (JCo) will be used if the ConnectionType is set to ctJavaConnector (4). In order to use this, you must first add the sapjco3.jar file to your project.
The 32 bit and 64 bit versions do not require any special settings within the beans. The only requirement is that your application target the same platform as the DLL.
Property List
The following is the full list of the properties of the bean with short descriptions. Click on the links for further details.
CodeLines | The lines of ABAP code. |
Connected | Indicates whether or not the component is connected to the SAP system. |
ResultLines | The results after executing the ABAP code. |
SapAttributes | Describes the SAP R/3 system you're connected to. |
SapConnection | These properties are used to connect to the SAP system. |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLServerCert | The server certificate for the last established connection. |
Timeout | Length of time in seconds the component waits for a response from the SAP system. |
Method List
The following is the full list of the methods of the bean with short descriptions. Click on the links for further details.
abortConnection | Used to terminate a connection to the SAP system. |
closeConnection | Closes a connection to the SAP system. |
config | Sets or retrieves a configuration setting . |
doEvents | Processes events from the internal message queue. |
executeCode | Execute ABAP Code. |
getAttributes | Retrieves attributes about the SAP system you're currently connected to. |
interrupt | Interrupt the current method. |
openConnection | Opens a connection to the SAP system. |
reset | Resets the component to its initial state. |
Event List
The following is the full list of the events fired by the bean with short descriptions. Click on the links for further details.
Error | Information about errors during data delivery. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
Status | Detailed status messages for debugging purposes. |
Configuration Settings
The following is a list of configuration settings for the bean with short descriptions. Click on the links for further details.
ResultEOL | Determines the EOL for the result lines. |
LogPerformanceData | Logs the performance information when a function is called. |
LogRawData | Logs the raw data being sent and received. |
ParseTables | Indicates whether to parse tables into rows and columns. |
ResponseParamText[i] | The value of the PARAMTEXT for the specified reponse parameter. |
RequestParamText[i] | The value of the PARAMTEXT for the specified request parameter. |
Group | The logon group. |
MessageServer | Service name of load balancer service. |
SncLibPath | The external security product's library. |
SncMode | The SNC activation indicator. |
SncName | The Initiator's SNC name. |
SncPartnerName | The communication partner's SNC name. |
SncQop | The quality of protection level. |
SystemID | The system ID of the SAP system. |
LocalHost | The IP address of the local interface. |
ProxyAutoDetect | Whether or not to automatically detect and use proxy system settings, if available. |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
FirewallType | Determines the type of firewall to connect through. |
CodePage | The system code page used for Unicode to Multibyte translations. |