Skip to Content

SAP connection

Introduction

An SAP connection, created the SAP connector, establishes access to either SAP ECC version 6 and above or SAP S/4HANA single-tenant. Once a connection is configured, you can create instances of SAP activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Note

This connector supports the Enable Re-authentication on Change organization policy. If enabled, a change to the Host, Username, or Consumer Key in this connection requires users to re-enter the Password, Security Token, and Consumer Secret for the connection.

Create or edit an SAP connection

A new SAP connection is created using the SAP connector from one of these locations:

An existing SAP connection can be edited from these locations:

Configure an SAP connection

Each user interface element of the SAP connection configuration screen is described below.

SAP connection configuration

Tip

Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  • Connection name: Enter a name to use to identify the SAP connection. The name must be unique for each SAP connection and must not contain forward slashes (/) or colons (:).

  • SAP version: Select either ECC or S4HANA as the SAP system type. The SAP connector is compatible with either SAP ECC version 6 and above or SAP S/4HANA single-tenant.

  • Username: Enter the username for logging in to the SAP system.

  • Password: Enter the password for logging in to the SAP system.

  • Client: Enter the numeric client ID associated with the SAP system. The organization's SAP administrator can supply this information.

  • Language: Enter the language code for the language in which SAP messages should be sent. The default language is English.

  • Host: Enter the SAP Application Server HostName.

  • System number: Enter the SAP system number.

  • Optional settings: Click to expand additional optional settings:

    • Connection Additional Configuration: In this section, you can select the SAP connection type and specify additional connection settings.

      • For Direct Connection: Select if the SAP connection is a direct server connection (default). When selected, do not also select For Load Balanced Connection.

      • For Load Balanced Connection: Select if the SAP connection processes requests through a load balancer. When selected, do not also select For Direct Connection. Provide the following information to configure a load-balanced connection:

        • Group name: Enter the SAP group name of the application servers.

        • MSHost: Enter the SAP message server host name.

        • MSPort: Enter the SAP message server port.

        • System ID: Enter the SAP system ID.

      • Router: If the SAP system is protected by a firewall, enter the router string required to connect to it.

    • Connection Pool: In this section, you can specify the connection pool settings for your SAP system.

      • Maximum active connections: Enter the maximum number of concurrent connections allowed from the SAP system's connection pool. The default value is 10. The maximum value allowed is 250.

      • Maximum number of connections: Enter the number of connections stored in the connection pool. The default value is 15. The maximum value allowed is 250.

      • Idle connection timeout: Enter the maximum time (in seconds) that a connection can stay idle in the connection pool. The default and maximum value allowed is 3600 seconds.

    • Listener Activity Properties: If you intend to use the Receive IDoc (Beta) activity, these fields must be configured:

      • Listener Count: Enter the number of threads to be allocated to listen for incoming requests. The default is 1, as each listener thread is capable of accepting and processing one IDoc call at a time. Setting a higher value enables the server to handle more simultaneous RFC calls.

      • Destination: Enter the RFC Destination configured in the SAP system, as described in Prerequisites. The destination must be unique for each SAP connection.

      • Gateway Service: Enter the name of the gateway server for the SAP system.

      Note

      Confirm the values for these fields are valid, as invalid values may result in an error when deploying the operation or enabling the listener.

    • SAP Connection Additional Configuration: Use this table to add any key-value pairs to be sent with each activity request. Each value added to the table is included in each activity's request schema.

      • Add: Adds a row to the table. Enter a key-value pair for each property.
      • Submit: Saves the key-value pair to the table. Visible when hovering on a row in edit mode.
      • Discard: Discards a new row or any edits made to an existing row. Visible when hovering on a row in edit mode.
      • Edit: Allows you to edit an existing key-value pair. Visible when hovering on an existing row.
      • Delete: Deletes the row from the table. Visible when hovering on an existing row.
      • Clear All: Deletes all rows from the table.

      Note

      The minimum value allowed in the Value field is 1. Any value less than 1 will result in an error when testing the connection.

  • Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

    Tip

    When testing the connection, this error message may be returned if the required SAP libraries are not installed:

    An error occurred: Connector is partially loaded on the Jitterbit Agent or it is missing functionality. Error: NoClassDefFoundError com/sap/conn/jco/JCoException. See logs for further details.

    To install the required SAP libraries, see SAP connector installation.

  • Save Changes: Click to save and close the connection configuration.

  • Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

  • Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After an SAP connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector Basics.

These activity types are available: