SAP Intermediate Document
SAP Intermediate Document (IDoc) is a standard data format that SAP applications use to exchange structured data with internal and external systems over the transactional RFC (tRFC) protocol.
NeoLoad includes advanced actions that let testers connect to an SAP server and run RFC calls. For the requirements, check out this table:
| Requirements | Description |
|---|---|
| Maturity | Stable |
| Author | NeoLoad |
| License | BSD Simplified (opens in new tab) |
| Requirements | NeoLoadEnterprise and Professional editions with Integration & Advanced Usage |
| Bundled with NeoLoad | Yes |
Before you start
To use SAP RFC in NeoLoad, follow these steps:
-
Download the SAP Java Connector, IDoc .jar files, and native libraries for your operating system from the SAP Connector Repository (opens in new tab).
-
Move sapjco3.jar and sapidoc3.jar to the lib/extlib folder in your NeoLoad project.
-
Move the native library file—sapjco3.dll for Windows or libsapjco3.so for Linux and macOS—to the custom-resources folder in your NeoLoad project.
-
Restart NeoLoad.
Advanced actions
NeoLoad provides advanced actions to manage SAP IDoc testing. These actions let you listen for outbound IDocs, establish connections, and send inbound IDocs. The following sections describe each available action and its parameters.
Start an IDoc listener
Use this action to register an IDoc listener at the SAP gateway, listen for outbound IDocs from the source system, receive them, and queue them. Use the IDoc-Send Inbound action to respond to queued IDocs. For the available parameters, check out this table:
| Parameter | Description |
|---|---|
| destination | The name of the destination. A properties file with this name is created. |
| host | The SAP server's IP address or hostname. |
| sysnr | The SAP system number. |
| client | The SAP client code. |
| user | The SAP username. |
| password | The SAP password. |
| lang | The language code. The default is en. |
| gatewayHost | The SAP gateway used for vendor system connections. |
| gatewayService | The gateway service or port to listen on. |
| programID | The unique program ID assigned to the NeoLoad listener in SAP by the Basis team. |
| connectionCount | The number of parallel connections. |
| jco.client.{propertyName} | An advanced property for destination properties. |
| fileRepository | The folder in the Load Generator box where outbound files are stored. By default, files are not saved. |
| sendStatistics | Whether to send listener statistics to the Controller via the Data Exchange API. Default: false. |
| dataExchangeApiKey | The Data Exchange API identification key specified in NeoLoad. |
| IdocTypes | A comma-separated list of IDoc types to listen to. |
| capacityByType | The number of IDocs to keep in memory per type. |
| errorWaitingTime | The wait time (in milliseconds) for a server error. Default: 150000 ms. |
Create an IDoc destination
Use this action to establish a tRFC connection to an SAP server. For the available parameters, check out this table:
| Parameter | Description |
|---|---|
| destination | The name of the destination. A properties file with this name is created. |
| host | The SAP server's IP address or hostname. |
| sysnr | The SAP system number. |
| client | The SAP client code. |
| user | The SAP username. |
| password | The SAP password. |
| lang | The language code. The default is en. |
| jco.client.{propertyName} | An advanced property for destination properties. |
Send an inbound IDoc
Use this action to send an inbound IDoc based on an IDoc payload template or outbound IDocs received. For the available parameters, check out this table:
| Parameter | Description |
|---|---|
| destination | The name of the destination. A properties file with this name is created. |
| templateFile | The absolute path of the IDoc XML file to send. |
| parseXML | Whether to scan the template for NeoLoad variables. Possible values: true or false. |
| respondingToOutbound | Whether to respond to an IDoc received by the listener. Possible values: true or false. |
| idocType | The IDoc type to respond to. Only used when respondingToOutbound is true. |
Status codes
Each advanced action returns a status code that helps diagnose errors during an execution. If an error occurs, check the following status codes to understand the issue:
| Status code | Description |
|---|---|
| NL-IDOCS_LISTENER-01 | An error occurred while starting the listener. |
| NL-IDOC_DESTINATION-01 | An error occurred while connecting to the SAP server. |
| NL-IDOC_INBOUND-01 | An error occurred while sending the inbound IDoc. |