SapABAPCode Component
Properties Methods Events Configuration Settings Errors
The SapABAPCode provides an easy way to execute ABAP code on a remote R/3 (NetWeaver) system.
Syntax
TibiSapABAPCode
Remarks
The purpose of this component 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.SapConnectionConnectionType = ctNetWeaver SapClient1.SapConnectionClient = "000" SapClient1.SapConnectionDestination = "" SapClient1.SapConnectionHost = "localhost" SapClient1.SapConnectionUser = "BCUSER" SapClient1.SapConnectionPassword = "minisap" SapClient1.SapConnectionSystemNumber = 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 component 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 SapConnectionType 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 SapConnectionType 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 SapConnectionType 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 SapConnectionType 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 components. 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 component 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. |
SapAttributeApplicationName | The name of the calling program. |
SapAttributeClient | The client authenticating to the SAP system. |
SapAttributeDestination | Destination that you are currently connected to. |
SapAttributeKernelVersion | The release version of the kernel. |
SapAttributeLanguage | One character code indicating the language of the system. |
SapAttributeLanguageCode | Two-character ISO 639-1 code indicating the language of the system. |
SapAttributeOwnCodePage | The code page of your system. |
SapAttributeOwnHost | The name of the host you're connected to. |
SapAttributeOwnType | The type of your own system. |
SapAttributeOwnVersion | The release version of your system. |
SapAttributePartnerCharSize | The length of a character on the partner's system. |
SapAttributePartnerCodePage | The code page of your partner's system. |
SapAttributePartnerHost | Partner host name. |
SapAttributePartnerType | The type of the partner's system. |
SapAttributePartnerVersion | The release version of the partner's system. |
SapAttributePasswordState | The state of the password. |
SapAttributeReserved | This property may contain an additional 160 bytes of data which is reserved for future new attributes returned by the R/3 server. |
SapAttributeRole | Indicates whether you're connected as a client or server application. |
SapAttributeSystemName | The name or id of the R/3 system you're currently connected to. |
SapAttributeSystemNumber | The system number of the R/3 server you're connected to. |
SapAttributeTraceOn | Indicates whether debug tracing is active or not. |
SapAttributeUser | The login credential which was used to connect to the R/3 server. |
SapConnectionClient | The client authenticating to the SAP system. |
SapConnectionType | Specifies how the connection is made to the SAP server. |
SapConnectionDestination | Reference to an existing destination that is specified in a local saprfc. |
SapConnectionGatewayHost | The gateway host you wish to connect to. |
SapConnectionGatewayService | The gateway service you wish to connect to. |
SapConnectionHost | Host name of the target system. |
SapConnectionLanguage | The language value to be used when connecting SAP system. |
SapConnectionPassword | The password used to authenticate to the SAP system. |
SapConnectionSoapURL | The URL of the SOAP service on the SAP system. |
SapConnectionSystemNumber | The number by which the target system is defined. |
SapConnectionUser | The user that is authenticating to the SAP system. |
SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
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 component 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 component 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 component 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. |