SAP Gateway

Setup Guide

Follow these steps to connect SAP Gateway to your Connect AI account:

1. Open the Connections page of the Connect AI dashboard.

2. Click + Add Connection in the upper-right corner.

3. Type SAP Gateway into the search field, then click the data source name.

4. On the Basic Settings tab of the new connection, enter a connection name or keep the default name.

5. Enter the URL for your SAP Gateway environment or the full URL of the OData service. Any additional properties must be added using Custom URL Params.

6. (Optional) Enter the service Namespace you want to retrieve data from. This is only required if the service is not specified in the URL.

7. (Optional) Enter the Service, which is a comma-delimited list of services you want to retrieve data from. If the service is set in the URL, this property is ignored. In cases where the service is not set in the URL or in Service, the SAP Gateway’s catalog service is used to discover all available services.

8. (Optional) Enter any Custom URL Params to be included with the HTTP request. The parameters should be in the form field1=value1&field2=value2&field3=value3.

9. Select an AuthScheme and follow the relevant instructions below.

Authentication Methods

Basic

1. Enter the User Id for the authenticating user.

2. Enter the Password for the authenticating user.

3. At the top of the Connect AI Add Connection page, click Save & Test.

   • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.
   • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
   • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

OAuth

1. Enter the OAuth Client Id assigned to your custom OAuth application. This Id is required to identify the application to the OAuth authorization server during authentication.

2. Enter the OAuth Client Secret assigned to your custom OAuth application. This value is used to authenticate the custom application to the OAuth authorization server.

3. Enter the Scope, or permission scopes, in space separated values. Scopes define what kind of access the authenicating user has, such as read or read/write. Scopes are required for OAuth 2.0.

4. At the top of the Connect AI Add Connection page, click Save & Test.

   • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.
   • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
   • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

Token

1. Enter the API Key of the application you have created.

2. At the top of the Connect AI Add Connection page, click Save & Test.

   • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.
   • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
   • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

OAuthPKCE

1. Set authentication to OAuthPKCE to use the Proof Key of Code Exchange (PKCE) extension of the standard OAuth2 flow. Set your own PKCEVerifier or let the driver automatically generate one for you.

2. At the top of the Connect AI Add Connection page, click Save & Test.

   • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.
   • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
   • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

SAPBTP

1. In Advanced Settings, enter the Destination URL of the SAP BTP destination source. This URL is found in the service key of your Destination Service instance in the SAP BTP Cockpit, in the URI field.

2. In Advanced Settings, enter the Destination Name of the SAP BTP destination to retrieve the authentication details from.

3. At the top of the Connect AI Add Connection page, click Save & Test.

   • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.
   • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
   • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

More Information

For more information about interactions between Connect AI and SAP Gateway, see this information page.