Skip to main content
The SAP IDoc connector supports sending and receiving IDoc files to and from a variety of SAP systems. It is a data container that is used to exchange information between SAP and another process that can understand the syntax and semantics of the data.

Overview

IDoc connectors can connect to SAP using the following methods: Windows
  • NetWeaver RFC SDK
  • Classic RFC SDK
  • Classic RFC SDK with Unicode support
  • SOAP (send-only)
Java
  • Java connector (JCO)
  • SOAP (send-only)
IDoc connectors can send and retrieve files formatted either as raw IDoc or as IDoc XML.

Connector Configuration

This section contains all of the configurable connector properties.

Settings Tab

Host Configuration

Settings related to establishing the connection to the SAP system.

Client Authentication

Settings related to authenticating against the SAP system.

Receiver Options

Settings related to receiving IDoc files.

Control Record Information Options

This section allows you to overwrite the control headers for IDoc files before sending them to SAP. This is useful when you are receiving IDoc files from one SAP system and sending them to another SAP system: in this situation you should change the control record without changing the IDoc file data. See Sending IDocs to SAP for more information.

Advanced Tab

Language Settings

Settings related to communication language.

Gateway

Settings related to communicating with SAP through a gateway.

Logon Load Balancing

Settings related to logging in to the SAP system as a group to enable load balancing.

Secure Network Communications (SNC)

Settings related to using an external security product to enhance the SAP connection security.

Advanced Settings

Settings not included in the previous categories.

Message

Logging

Miscellaneous

Automation Tab

Automation Settings

Settings related to the automatic processing of files by the connector.

Performance

Alerts Tab

SLAs Tab

Establishing a Connection

Using NetWeaver RFC SDK

The following libraries from the NetWeaver RFC SDK must be placed into the www\\bin\\x64 folder (www\\bin\\x86 on 32-bit operating systems):
  • sapnwrfc.dll
  • icudt30.dll
  • icuin30.dll
  • icuuc30.dll
  • libicudecnumber.dll
  • libsapucum.dll
  • The .dll names might be different based on the version of the SAP RFC SDK you have installed. The examples above are for version 3.0.
  • You need to add the sapgw00 service to your listed services for the NetWeaver SDK connection to work on your client machine. You can add it to the services file at C:\\Windows\\System32\\drivers\\etc\\services.

Using Classic RFC SDK

The non-Unicode library does not require anything other than librfc32.dll. Place librfc32.dll into the www\\bin\\x64 folder (www\\bin\\x86 on 32-bit operating systems).
These libraries are provided in both x86 and x64, so you must use the same platform that the process is using. If the application is running on a 64-bit version of Windows, the process is 64-bit.

Using Classic RFC SDK with Unicode Support

The following libraries from the SAP RFC SDK must be placed into the www\\bin\\x64 folder (www\\bin\\x86 on 32-bit operating systems):
  • librfc32u.dll
  • icudt30.dll
  • icuin30.dll
  • icuuc30.dll
  • The .dll names might be different based on the version of the SAP RFC SDK you have installed. The examples above are for version 3.0.
  • These libraries are provided in both x86 and x64, so you must use the same platform that the process is using. If the application is running on a 64-bit version of Windows, the process is 64-bit.

Using the Java Connector

To use the Java connector, add sapjco3.jar to the lib folder of your Java servlet container.

Using SOAP

SOAP can only be used to send IDocs to SAP. You must use a different connection type to receive IDocs from SAP.
This requires enabling SOAP connections on the SAP system.

Configuring Services

In addition to the dependencies above, the following services must be added to %WINDIR%\\system32\\drivers\\etc\\services, or /etc/services if your system is running Linux or Mac OS X. If SAP NetWeaver is already installed on the machine, no further action is required.

Logging on to SAP

The following settings are required to connect with your SAP system.

Gateway

When connecting to SAP via a gateway, use the options in the Gateway section of the Advanced tab.

Load Balancing

To log on via load balancing, set the properties in the Logon Load Balancing section of the Advanced tab.

Secure Network Communications (SNC)

To enable secure network communications, check the Enable SNC box in the Secure Network Communications (SNC) section of the Advanced tab. Set SNC Library to the .dll of the SNC library you want to use to connect with SAP.

Sending IDocs to SAP

Once you have configured the IDoc connector to connect to your SAP system, you can begin sending IDoc files to SAP. The IDoc connector can send files formatted in raw IDoc or XML IDoc. You can configure the connector to automatically insert control record information into the IDoc being sent to SAP: the DOCREL, SNDPOR, SNDPRT, and so on. This makes it easier to process outgoing IDocs to the configured system. Configure these settings in the Control Record Information Options section of the Settings tab. Before sending an IDoc to your SAP system, make sure that you have properly configured a partner profile in SAP. If no partner profile in SAP matches the control record information in the IDoc you are sending, the data will not be processed by your SAP system. See Test Sending an IDoc to SAP for more information on setting up a partner profile.
You can use transaction code WE60 to search for segment documentation for different IDoc types.

Test Sending an IDoc to SAP

To test sending an IDoc to SAP, you first need to configure your SAP system to have a partner profile for . The following steps describe how to do this with an ORDERS IDoc.
  1. Create a partner: Go to transaction code WE20 and define a partner profile. Set Partn Type to KU for Customer and Partner No to a valid customer number. Create a Partner
  2. Add an inbound parameter for the ORDERS document: The message type for this document is ORDERS. On the Inbound Options tab, set Process code to ORDE to tell SAP how to create a sales order when a purchase order ORDERS document is received by the SAP system. Set Parameters
  3. Assign the customer to a sales division: The customer configured in step one must be assigned to a sales organization, distribution channel, and division. Go to transaction VOE2 to configure these settings in the EDSDC table.

Receiving IDocs from SAP

Once you have configured the IDoc connector to connect to your SAP system, you can begin receiving IDoc files from SAP. The IDoc connector can receive files formatted in raw IDoc or XML IDoc. To receive files from SAP, create an RFC destination for . You can then check Enable IDoc Receiver in the Receiver Options section of the Settings tab, then enter the Program Id that you registered in your SAP system for .

Test Receiving an IDoc from SAP

This example describes how to configure your SAP system to send a MATMAS IDoc to .
  1. Define a logical system: First, go to transaction SALE. Then navigate to Basic Settings > Logical Systems > Define Logical System. Create a new entry with a valid name (for example, ) and description.
  2. Create an RFC destination: Open transaction code SM59. Click the create button and fill in the fields for the RFC destination described below. After you save the settings, test the connection to make sure you can successfully connect to .
  3. Create a processing connector: Go to transaction code WE21. Create a new Transactional RFC connector with a unique name and the same destination you created in step 2.
  4. Create a partner profile: Open transaction WE20. Create a partner profile for the logical system that you added in step 1. Next, add an outbound parameter for the MATMAS document. Set the Message Type to MATMAS. On the Outbound Options tab, set the Receiver port to the value of the connector you configured in step 3, set the Output Mode to Transfer IDoc Immed, and set the IDoc Basic type to MATMAS05.
  5. Send a test IDoc: Use transaction BD10 to send a test IDoc to for a specified material number. You need to configure the Message Type and Logical System before sending the message. Use transaction BD87 to monitor outgoing messages and process them again if necessary.

Macros

Examples