The connection string properties describe the various options that can be used to establish a connection.
The connection string can be set to a series of option=value strings separated by semicolons. If a connection string property value has special characters such as semicolons, single quotes, spaces, etc., then you must quote the value using either single or double quotes.
Connection options are case insensitive.
Connecting to SAP Gateway
In addition to authenticating, set the following connection properties to access SAP Gateway tables.
- RSBSAPGateway_p_URL: Set this to the URL of your environment, or to 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.
- Namespace: Set the appropriate Service Namespace. In the example above, IWBEP is the namespace. It is optional if the full url to the service is specified.
- Service: Set this to the service you want to retrieve data from. In the example above, the service is GWSAMPLE_BASIC. It is not required if the full url is specified.
Authenticating to SAP Gateway
SAP Gateway allows both basic and OAuth 2.0 authentication. You can use basic authentication to connect to your own account, or you can use OAuth to enable other users to retrieve data from your service with their accounts.
Authenticate via Basic Authentication
In basic authentication, you use your login credentials to connect. Set the following properties:
- User: This is the username you use to log in to SAP Gateway.
- Password: This is the password you use to log in to SAP Gateway.
Authenticate via OAuth Authentication
You can connect without setting any connection properties for your user credentials. Set InitiateOAuth to GETANDREFRESH to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
When you connect, the adapter opens the SAP Gateway OAuth endpoint in your default browser. Log in and grant permissions to the adapter. The adapter then completes the following OAuth process:
- Extracts the access token from the callback URL and authenticates requests.
- Obtains a new access token when the old one expires.
- Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
See Using OAuth Authentication for other OAuth authentication flows.
Connection String Options
The following is the full list of the options you can configure in the connection string for this provider. Click on the links for further details.
|Api Key||Set this to the key of the application you have created. If you set this, User and Password are not used for authentication.|
|Auth Scheme||The type of authentication to use when connecting to SAP Gateway.|
|Auto Cache||Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .|
|Cache Connection||The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.|
|Cache Location||Specifies the path to the cache when caching to a file.|
|Cache Metadata||This property determines whether or not to cache the table metadata to a file store.|
|Cache Provider||The name of the provider to be used to cache data.|
|Cache Tolerance||The tolerance for stale data in the cache specified in seconds when using AutoCache .|
|Callback URL||The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.|
|Data Format||The data format to retrieve data in. Select either XML or JSON.|
|Firewall Password||A password used to authenticate to a proxy-based firewall.|
|Firewall Port||The TCP port for a proxy-based firewall.|
|Firewall Server||The name or IP address of a proxy-based firewall.|
|Firewall Type||The protocol used by a proxy-based firewall.|
|Firewall User||The user name to use to authenticate with a proxy-based firewall.|
|Initiate OAuth||Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.|
|Location||A path to the directory that contains the schema files defining tables, views, and stored procedures.|
|Logfile||A filepath which designates the name and location of the log file.|
|Log Modules||Core modules to be included in the log file.|
|Max Log File Count||A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.|
|Max Log File Size||A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.|
|Max Rows||Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.|
|Namespace||Specify the service namespace you want to retrieve data from. This is required if the service is not specified in the URL.|
|OAuth Access Token||The access token for connecting using OAuth.|
|OAuth Client Id||The client ID assigned when you register your application with an OAuth authorization server.|
|OAuth Client Secret||The client secret assigned when you register your application with an OAuth authorization server.|
|OAuth Expires In||The lifetime in seconds of the OAuth AccessToken.|
|OAuth Refresh Token||The OAuth refresh token for the corresponding OAuth access token.|
|OAuth Settings Location||The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.|
|OAuth Token Timestamp||The Unix epoch timestamp in milliseconds when the current Access Token was created.|
|OAuth Verifier||The verifier code returned from the OAuth authorization URL.|
|Offline||Use offline mode to get the data from the cache instead of the live source.|
|Other||These hidden properties are used only in specific use cases.|
|Pagesize||The maximum number of results to return per page from SAP Gateway.|
|Password||The password used to authenticate the user.|
|Proxy Auth Scheme||The authentication type to use to authenticate to the ProxyServer proxy.|
|Proxy Auto Detect||This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.|
|Proxy Exceptions||A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .|
|Proxy Password||A password to be used to authenticate to the ProxyServer proxy.|
|Proxy Port||The TCP port the ProxyServer proxy is running on.|
|Proxy Server||The hostname or IP address of a proxy to route HTTP traffic through.|
|Proxy SSL Type||The SSL type to use when connecting to the ProxyServer proxy.|
|Proxy User||A user name to be used to authenticate to the ProxyServer proxy.|
|Pseudo Columns||This property indicates whether or not to include pseudo columns as columns to the table.|
|Readonly||You can use this property to enforce read-only access to SAP Gateway from the provider.|
|RTK||The runtime key used for licensing.|
|Scope||The permission scopes in space separated values. This is required when authenticating via OAuth2.0 flow.|
|Service||Specify the service you want to retrieve data from. This is required if the service is not specified in the URL.|
|SSL Server Cert||The certificate to be accepted from the server when connecting using TLS/SSL.|
|Support Enhanced SQL||This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.|
|Tables||This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.|
|Timeout||The value in seconds until the timeout error is thrown, canceling the operation.|
|URL||Set this to the URL your SAP Gateway environment or to the full URL of the OData service.|
|Use Display Names||Boolean determining whether or not to use SAP labels.|
|User||The SAP Gateway user account used to authenticate.|
|Views||Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.|