Skip to Content

SAP Gateway Connection

Introduction

An SAP Gateway connection, created using the SAP Gateway connector, establishes access to SAP Gateway. These activities, once configured, interact with SAP Gateway through the connection.

Create or Edit an SAP Gateway Connection

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

An existing SAP Gateway connection can be edited from these locations:

Configure an SAP Gateway Connection

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

Tip

Fields with a variable icon 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 connection. The name must be unique for each SAP Gateway connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the SAP Gateway endpoint, which refers to both a specific connection and its activities.

  • Authentication: When selected (default), shows additional settings. For documentation, see Establishing a Connection and Additional Configurations Properties:

    • Auth Scheme: Select the authorization scheme, one of:

      • Auto

      • OAuth

      • Basic

      • Token

    • URL: Enter the URL.

    • Namespace: Enter the namespace.

    • Service: Enter the service.

    • User: Enter the user.

    • Password: Enter the password.

    • API Key: Enter the API key.

  • OAuth: When selected, shows additional settings. For documentation, see Establishing a Connection and Additional Configurations Properties:

    • Initiate OAuth: Select the OAuth setting, one of:

      • OFF

      • GETANDREFRESH

      • REFRESH

    • OAuth Client Id: Enter the OAuth client ID.

    • OAuth Client Secret: Enter the OAuth client secret.

    • OAuth Access Token: Enter the OAuth access token.

    • Callback URL: Enter the callback URL.

    • Scope: Enter the scope.

    • OAuth Verifier: Enter the OAuth verifier.

    • OAuth Refresh Token: Enter the OAuth refresh token.

    • OAuth Expires In: Enter the time in seconds that the OAuth token expires in.

    • OAuth Token Timestamp: Enter the OAuth token timestamp.

  • SSL: When selected, shows additional settings. For documentation, see Establishing a Connection and Additional Configurations Properties:

    • SSL Server Cert: Enter the SSL server certificate.
  • Use Proxy Settings: Select to use Private Agent proxy settings.

  • Advanced Configurations: When selected, shows the Advanced Configurations Properties table, which is used to add additional configuration properties as key-value pairs.

    Click the add icon add icon to add a row to the table below and enter a key-value pair for each property.

    To save the row, click the submit icon submit icon in the rightmost column.

    To edit or delete a single row, hover over the rightmost column and use the edit icon edit icon or delete icon delete icon.

    To delete all rows, click Clear All.

    Important

    Fields in the Advanced Configurations table display the variable icon Variable icon only in edit mode. For these fields' variable values to be populated at runtime, the agent version must be at least 10.75 / 11.13.

  • Test: Click to verify the connection using the specified 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.

  • 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.

Configure OAuth Connections

This connector supports a connection using OAuth by using specific configuration properties. After selecting an auth scheme that includes Initiate OAuth, you will be able to specify the configuration in the fields that are displayed.

Note

Additional IDs, secrets, scopes, and other authentication tokens may be required in order to successfully complete the OAuth authentication. Check the endpoint documentation for additional information on their requirements.

For this connector, two scenarios are supported. In either scenario, you will need to use a third-party tool (such as Postman or a similar tool) to obtain the required access token or tokens from the endpoint involved. Both of these scenarios work only for single-agent groups. These are Agent Groups that consist of a single agent.

  • Scenario 1: Using an OAuth access token that expires after a set period of time.

    With this configuration, you supply an OAuth access token that lasts for a set period of time, as determined by the particular endpoint. The connector will use the token to make the connection. The connection, however, will no longer work once the access token expires. You would configure the connector to use the token by setting these properties:

    Configuration Property Value
    Initiate OAuth OFF
    OAuth Access Token Set to the value of the OAuth access token obtained from the endpoint
  • Scenario 2: Using an OAuth access token combined with an OAuth refresh token to enable automatic refresh of access.

    With this configuration, the connector will use a refresh token to obtain a new access token once the current access token has expired. This is generally the best method of configuring OAuth.

    You supply an OAuth access token and an OAuth refresh token, as determined by the particular endpoint. You would configure the connector to use these tokens by setting these properties:

    Configuration Property Value
    Initiate OAuth REFRESH
    OAuth Access Token Set to the value of the OAuth access token obtained from the endpoint
    OAuth Refresh Token Set to the value of the OAuth refresh token obtained from the endpoint

Note

If using multiple OAuth-based SAP Gateway connections on the same Private Agent, set the configuration property OAuthSettingsLocation to a unique writeable agent path for each connection. In the jitterbit.conf file for the agent, set EnableLocalFileLocation=true. If you don't perform these two steps, the multiple connections will use the same default path and overwrite each other.

Next Steps

After an SAP Gateway connector 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:

  • Query: Retrieves records from a table at SAP Gateway and is intended to be used as a source in an operation.

  • Create: Inserts a record into a table at SAP Gateway and is intended to be used as a target in an operation.

  • Update: Updates a record in a table at SAP Gateway and is intended to be used as a target in an operation.

  • Delete: Deletes a record from a table at SAP Gateway and is intended to be used as a target in an operation.

  • Execute: Executes a procedure at SAP Gateway and is intended to be used as a target in an operation.