Excel Add-In for SAP Gateway

Build 24.0.9060

Establishing a Connection

Configure a Connection Profile

From the CData ribbon, click Get Data and select From SAP Gateway connection/s to launch the CData Query window. To setup a new connection, you will have to click the New SAP Gateway Connection button. Here you can set the connection settings, test the connection, and save the connection profile.

Connecting to SAP Gateway

SAP Gateway provides two ways to connect to data:

  • To connect to your own local data via the desktop (non-browser connection, referred to below as "basic authentication"), use the CData-supplied embedded OAuth application.
  • To connect to shared data over the network (browser connection), use a custom OAuth application.

To access SAP Gateway tables, set the following connection properties:

  • Url = the URL of your environment, or the full URL of the service. For example, the full URL might appear as: https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/. In this example, the environment url would just be: https://sapes5.sapdevcenter.com. Add any additional properties using the CustomUrlParams property.
  • Namespace = the appropriate Service Namespace. In the example above, IWBEP is the namespace. It is optional if the full url to the service is specified.
  • SAP Gateway = the service from which you want to retrieve data. In the example above, the service is GWSAMPLE_BASIC. It is not required if the full url is specified.
  • CustomUrlParams = any required additional properties that need to be included with the HTTP request; for example, sap-client=001&sap-language=EN.

Authenticating to SAP Gateway

SAP Gateway allows both basic and OAuth 2.0 authentication. Use basic authentication to connect to your own account, or use OAuth to authenticate to shared data via a browser connection.

Basic

To enable basic authentication, set the following properties:

  • AuthScheme = Basic.
  • User = the username you use to log in to SAP Gateway.
  • Password = the password you use to log in to SAP Gateway.

After you set the above properties are set, you are ready to connect. Use your personal credentials to access your local data.

OAuth

The following subsections provide details about authenticating from a desktop application, the web, or a headless machine. For information about creating a custom OAuth application, see Creating a Custom OAuth Application.

Desktop Applications

To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.

Get and Refresh the OAuth Access Token

  • OAuthClientId = the client Id assigned when you registered your application.
  • OAuthClientSecret = the client secret that was assigned when you registered your application.
  • CallbackURL = the redirect URI that was defined when you registered your application.
When you connect, the add-in opens SAP Gateway's OAuth endpoint in your default browser.

Log in and grant permissions to the application. When the access token expires, the add-in refreshes the access token automatically.

Connection Properties

The Connection properties describe the various options that can be used to establish a connection.

Managing Connections

After successfully authenticating to SAP Gateway you will be able to customize the data you are importing. To learn more about this, see Managing Connections.

See Also

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060