SAP connector prerequisites

Introduction

This page documents the prerequisites for the SAP connector and additional prerequisites for its Receive IDoc (Beta) activity.

SAP connector prerequisites

An SAP instance using ECC version 6 or later, or SAP S/4HANA single-tenant is required.

To use the SAP connector, agent version 10.1 or later is required. These agent versions automatically download the latest version of the connector.

If private agents are used, they must have certain libraries provided by SAP installed.

Receive IDoc activity prerequisites

The Receive IDoc (Beta) activity has additional prerequisites in addition to the SAP connector prerequisites.

To use the Receive IDoc (Beta) activity, the following prerequisites must be met:

• The SAP system must be configured with the following, each described later on this page:

  • Create an RFC destination (transaction SM59)
  • Create a transactional RFC (tRFC) port (transaction WE21)
  • Specify a logical system (transaction BD54)
  • Set up a partner profile (transaction WE20)
  • Configure the distribution model (transaction BD64)

• Private agent version 11.30 or later must be used. To fully benefit from the listening service's load-balancing and fault-tolerance features, it is recommended to have a minimum of two private agents in the agent group. The private agent must have certain libraries provided by SAP installed.

• The private agent must have the listening service enabled as described in Enable the listening service on the agent. This is a manual step in configuration and is not enabled by default.

• Once an operation is deployed, the Integration Studio project must have the listening service enabled at both the operation level and the activity level as described in Enable the listening service on the operation and activity. This is manual step performed at the time of project design or project management.

Create an RFC destination

An RFC destination must be created at the SAP gateway system so that it can be bound to the transactional RFC (tRFC) port.

Follow these steps to create an RFC destination in the SAP system:

1. Log in to the SAP GUI.

2. In the search box, enter the SAP transaction code SM59.

3. The Configuration of RFC Connections screen is displayed. Click the create button to create a new RFC destination:

   

4. The RFC Destination configuration screen is displayed. Complete the configuration as follows:

   

   1. In the RFC Destination field, enter a name for the RFC destination, such as JITTERBIT.

   2. In the Connection Type field, select T for TCP/IP Connection.

   3. In the Description, enter a description, such as SAP Destination for Jitterbit.

   4. In the Technical Settings tab:

      1. Under Activation Type, select Registered Server Program.
      2. Under Registered Server Program, in the Program ID field, enter a name for the program to be used by the SAP Event Listener to connect to the SAP gateway, such as JITTERBIT.

   5. Save the RFC destination.

      Note

      The Connection Test button should not be used at this point in the configuration. If used, an error is expected. To test the connection after all configuration is completed, see Verify connectivity with the SAP Gateway at the end of this page.

Create a transactional RFC (tRFC) port

The transactional RFC (tRFC) port is the logical port used by the RFC destination for exchanging information with the Receive IDoc (Beta) activity. In order to be able to communicate with the SAP server, a port must be created on the SAP system and linked to the RFC destination.

Follow these steps to create a tRFC port:

1. Log in to the SAP GUI.

2. In the search box, enter the SAP transaction code WE21.

3. The Ports in IDoc processing screen is displayed. Select the Transactional RFC folder and then click the Create button:

   

4. The Ports in IDoc processing dialog is displayed. Select own port name and specify the port name for the program, such as JITTERBIT:

   

5. In the Ports in IDoc processing screen for the new port, complete the configuration as follows:

   

   1. In the Description field, enter a description, such as Jitterbit tRFC Port for Destination JITTERBIT.

   2. Under Version:

      1. Select the version of IDoc record types to be exchanged using this port.

      2. In the RFC destination field, enter the name of the RFC destination that you previously defined, such as JITTERBIT.

   3. Save the port.

Specify a logical system

A logical system must be specified before setting up a partner profile. Follow these steps to specify a logical system:

1. Log in to the SAP GUI.

2. In the search box, enter the SAP transaction code BD54.

3. The Change View "Logical Systems": Overview screen is displayed. Click the New Entries button:

   

4. In the Logical Systems table, in both the Log.System and Name table columns, enter a name for the logical system, such as JITTERBIT.

5. Save the logical system.

Set up a partner profile

A partner profile must be created on the SAP system to specify the type of information that is exchanged with Jitterbit. The partner profile specifies the IDoc types that can be sent by Jitterbit to the SAP system (inbound parameters) and the IDoc types that are sent by the SAP system to Jitterbit.

Follow these steps to create a partner profile:

1. Log in to the SAP GUI.

2. In the search box, enter the SAP transaction code WE20.

3. The Partner profiles screen is displayed. Click the Create button.

4. In the Partner profiles screen for the new profile, complete the configuration as follows:

   

   1. In the Partner No. field, enter the name of the logical system, such as JITTERBIT.
   2. In the Partn. Type field, enter LS.
   3. In the Post processing: permitted agent tab:
      1. In the Ty. field, enter US as the user type.
      2. In the Agent field, enter the ID of the permitted user, such as JITTERBIT.
      3. In the Lang. field, enter EN to use English as the notification language.

5. Under Outbound Paramtrs., click the create parameter button to add as many outbound parameters as needed. The Partner profiles: Outbound parameters screen opens. For each outbound parameter, complete the configuration as follows:

   

   1. In the Message Type field, enter the type of message that is to be sent.

   2. In the Outbound Options tab:

      1. In the Receiver port field, enter the previously defined receiver port, such as JITTERBIT.
      2. Under Output Mode, for most use cases, select Transfer IDoc Immed. Choose other options as appropriate for the use case.
      3. Under IDoc Type, enter the information for the IDoc type that is to be sent.

   3. Save the outbound parameter.

6. Under Inbound Parmtrs., click the create parameter button to add as many inbound parameters as needed. The Partner profiles: Inbound parameters screen opens. For each inbound parameter, complete the configuration as follows:

   

   1. In the Partner Role field, enter LS for logical system.

   2. In the Message type field, enter the type of message that is to be received.

   3. In the Inbound options tab, enter the Process code for the functional module that is to process the received IDoc.

   4. Save the inbound parameter.

Configure the distribution model

The distribution model must be configured for the IDoc message type being received by the Receive IDoc (Beta) activity.

Follow these steps to configure the distribution model:

1. Log in to the SAP GUI.

2. In the search box, enter the SAP transaction code BD64.

3. Select the central logical system.

4. Click Add message type and enter the type of message that is to be received, and then save.

5. Repeat as necessary to add all message types:

   

Verify connectivity with the SAP Gateway

Connectivity is not expected to be established until all configuration steps are complete both in the SAP system (described on this page), the SAP connector connection, and the Receive IDoc (Beta) activity.

Once those configuration steps are complete, an SAP administrator can test the connection of the configured RFC destination in the SAP system to verify that connectivity has been established between the SAP gateway and Jitterbit's listening service.

To test the connection of the RFC destination:

1. Log in to the SAP GUI.

2. In the search box, enter the SAP transaction code SM59.

3. In the RFC Connections column, expand TCP/IP Connections and double-click to open the RFC destination name.

4. Click the Connection Test button to verify connectivity between the SAP gateway and Jitterbit's listening service: