SAP Gateway Connection Details¶

Introduction¶

Connector Version

This documentation is based on version 23.0.8804 of the connector.

Get Started¶

SAP Gateway Version Support

The connector leverages the SAP Gateway API to enable bidirectional access to SAP services that use the gateway. This includes but is not limited to S/4 HANA, S/4 HANA Cloud, ERP, and any other editions that support the SAP Gateway.

Establish a Connection¶

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

Authenticate 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 connector opens SAP Gateway's OAuth endpoint in your default browser.

Log in and grant permissions to the application. The connector then completes the OAuth process:

1. The connector obtains an access token from SAP Gateway and uses it to request data.
2. The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.

When the access token expires, the connector refreshes the access token automatically.

Create a Custom OAuth Application¶

Creating an OAuth application for accessing SAP Gateway entails creating a service user in the SAP APAB Security and Identity Management Console and registering the new OAuth 2.0 Client ID with the creation wizard.

Create a Service User for the OAuth 2.0 Client¶

This procedure creates a service user whose Client ID is identical with the username the OAuth client uses to request an access token.

This user is normally named LEAVEAPP.

1. Navigate to the SAP ABAP Security and Identity Management console.

2. Start transaction SU01. The console displays the User Maintenance: Initial Screen.

3. Enter the user name for the OAuth client's service user; for example, LEAVEAPP.

4. Click Create or press F8. The console displays the Maintain Users screen.

5. Ensure that the Address tab is selected, and enter a last name for the new user; for example, LEAVEAPP.

6. Still in the Maintain Users window, click the Logon Data tab.

7. At the User Type dropdown, choose System.

8. At the Password section, in the New Password field, choose Generate. The system generates a password for the new user

   and displays it in the Maintain Users message section.

9. Copy the displayed password and use it in the configuration of your Client Application.

10. Click the Save icon and exit transaction SU01.

Register the New User With the Creation Wizard¶

This procedure registers the new user you just created, and creates a new leave request application, also named LEAVEAPP.

1. Navigate to the SAP ABAP Security and Identity Management console.

2. Start transaction SU02. The console displays the OAuth 2.0 Administration screen.

3. Choose Create. The console starts the Create OAuth 2.0 Client wizard.

4. At the Client ID field, enter LEAVEAPP.

5. Enter a short description for the new client.

6. If desired, adjust the value in the Token Lifetime field. (The default lifetime of an issued access token is one hour, expressed as

   3600s. You may want to shorten this lifetime for security reasons.)

7. Click Next. The console displays the Client Authentication Details screen.

8. Define the resource owner authentication details:

   • To permit Research Owner authentication with authorization code type "grand", select "Grant Type Authorization Code Active".
   • Specify a redirect URL of https://oauth.cdata.com/oauth/.

9. Click Next. The console displays the Scope Assignment screen.

10. At Scope Assignment, add the following two scopes: ZLEAVEREQUEST_0001 and ZLEAVEREQUESTAPPR_0001. (For an overview of available OAuth 2.0 Scope IDs, press F4-Help.)

11. Click Next. The console displays the OAuth 2.0 Client Summary screen.

12. Check the OAuth 2.0 Client Summary to be sure it looks as you expect, then click Finish.

Important Notes¶

Configuration Files and Their Paths¶

• All references to adding configuration files and their paths refer to files and locations on the Harmony Agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features¶

This section details a selection of advanced features of the SAP Gateway connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to SAP Gateway and then processes the rest of the query in memory (client-side).

User Defined Views¶

The SAP Gateway connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File¶

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM SampleTable_1 WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements¶

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View¶

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View¶

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View¶

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views¶

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views¶

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration¶

Customize the SSL Configuration¶

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model¶

The SAP Gateway connector models SAP Gateway entities in relational Tables, Views, and Stored Procedures. The table definitions are dynamically obtained from the OData service you connect to. Any changes in the metadata, such as added or removed columns or changes in data type, can be loaded by reconnecting.

Tables

The connector models the writable entity sets and singletons described in the service metadata document as bidirectional Tables.

Views

Some OData entities can only be accessed through Navigation Properties. By default, the connector models navigation properties as separate views. See Views for more information on querying navigation properties.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information

in the data source.

Tables¶

The connector exposes tables for every entity set and singleton defined on the OData service document. Entities on these tables may be inserted, updated, or deleted using standard SQL insert, update, or delete statements.

Executing Deep Inserts with SQL¶

The connector supports OData deep inserts, in which you simultaneously create a base entity and link it to related entities, by specifying navigation properties. To specify Navigation Properties for an entity, you create a temporary table for the navigation property and then reference the temporary table in the insert to the base table. Reference the temporary table in the appropriate navigation property column on the base table. Each navigation property column is prefixed with the word "Linked".

Note that you must define the temporary tables and insert to the base entity within the same connection. Alternatively you can provide a JSON/XML aggregate to instead of the temporary table.

Example: Deep Inserts in SAP Gateway¶

For example, consider the GWSAMPLE_BASIC service. On GWSAMPLE_BASIC, there is a SalesOrder table. When creating a SalesOrder, you must specify a new SalesOrderLineItem and an existing BusinessPartner. To do so, you can specify the following navigation properties.

Creating Temporary Tables¶

Insert the related entities into temporary tables that correspond to each navigation property. You can specify an existing entity's primary key or you can insert a new entity.

• SalesOrderLineItems: The following statements add two SalesOrderLineItems to the SalesOrder:

  INSERT INTO SalesOrderLineItems#TEMP (ProductID, Quantity) VALUES ('P001', 15)
  
  
  INSERT INTO SalesOrderLineItems#TEMP (ProductID, Quantity) VALUES ('P002', 10)
  

• BusinessPartners: The following statement specifies the existing BusinessPartner:

  INSERT INTO BusinessPartners#TEMP (BusinessPartnerID)
  VALUES ('BP001')
  

The SAP Gateway connector will assume that the BusinessPartner already exists and will only link to the existing references since only the primary keys was specified. When more than just the primary key is defined, such as the example for SalesOrderLines, the SAP Gateway connector will attempt to create new entries - triggering the deep insert.

Inserting the Entity¶

In the INSERT statement for the base entity, reference the temporary tables in the LinkedToLineItems and LinkedToBusinessPartner columns:

INSERT INTO SalesOrders (Note, LinkedToLineItems, LinkedToBusinessPartner)
VALUES ('New sales order', 'SalesOrderLineItems#TEMP', 'BusinessPartners#TEMP')

Code Example¶

Below is the complete code to create the new ExternalUser:

Connection conn = DriverManager.getConnection(connectionStr);
Statement stat = conn.createStatement();
stat.executeUpdate("INSERT INTO SalesOrderLineItems#TEMP (ProductID, Quantity) VALUES ('P001', 15)");

stat.executeUpdate("INSERT INTO SalesOrderLineItems#TEMP (ProductID, Quantity) VALUES ('P002', 10)");

stat.executeUpdate("INSERT INTO BusinessPartners#TEMP (BusinessPartnerID) VALUES ('BP001')");

stat.executeUpdate("INSERT INTO SalesOrders (Note, LinkedToLineItems, LinkedToBusinessPartner) VALUES ('New sales order', 'SalesOrderLineItems#TEMP', 'BusinessPartners#TEMP')");

stat.close();

Using Aggregates¶

Below is an example of providing multiple Order Line Items as a JSON aggregate:

INSERT INTO SalesOrderSet (Note, CustomerID, LinkedToLineItems) VALUES ('New sales order', '0100000001', '
    [
      {
          "ProductID": "HT-1001",
          "Quantity": 2,
          "Note": "Test aggregate 1",
          "DeliveryDate": "2024-12-20 13:20:10"
      },
      {
          "ProductID": "HT-1001",
          "Quantity": 4,
          "Note": "Test aggregate 2",
          "DeliveryDate": "2024-12-20 13:20:10"
      }
  ]
')

Views¶

Modeling Navigation Properties¶

By default, the connector models Navigation Properties as separate views. The views are named in the format ParentTable_NavigationProperty.

Querying Navigation Properties¶

For an example of working with a navigation property as a view, consider the GWSAMPLE_BASIC service. The SalesOrder entity has the ToLineItems navigation property. The SAP Gateway connector will display a view called SalesOrders_ToLineItems. Retrieving data from SalesOrders_ToLineItems will display the SalesOrderLineItems objects associated with a given SalesOrder. The SalesOrders_ToLineItems view has a primary key made up of the ID of the parent entity and the ID of the related entity.

Note that the GWSAMPLE_BASIC sample service also contains foreign keys directly on each entity, such as a SalesOrderID directly on the SalesOrderLineItems table. In this case, the same effect can be achieved by simply retrieving data from the SalesOrderLineItems table directly. However, it is not a requirement in OData to have these foreign keys, nor is it a guarantee that each navigation property will be exposed individually as thier own table. Since there is no way of knowing beforehand what might be exposed on its own endpoint, the SAP Gateway connector will display both the view and the table. In general, it is best to use Tables when available, and views only when necessary (ie: not table is displayed, or no foreign keys can be used to identify relationships).

Navigation Properties¶

In OData, a navigation property is a property on an entity that is itself either a single entity or list of entities.

A single-entity navigation property signifies a one-to-one relationship. For example, consider the GWSAMPLE_BASIC SAP Gateway endpoint. The ProductSet contains a ToSupplier navigation property, which references a single BusinessPartner entity.

An entity set navigation property signifies a one-to-many relationship. For example, consider the GWSAMPLE_BASIC SAP Gateway endpoint. The ProductSet contains a ToSalesOrderLineItems navigation property, which references many SalesOrderLineItem objects.

Working with Navigation Properties Relationally¶

Navigation properties in OData link related entities. Similarly, in a relational database, a foreign key serves to link tables. For example, the SalesOrderLineItem record contains the ProductID column, which uniquely identifies what Product the SalesOrderLineItem is using.

Select¶

It can be used to retrieve associated entites. See Views for more information on querying navigation properties.

Insert¶

The connector supports OData deep inserts. See Tables for more information on specifying navigation properties when you create an entity.

Stored Procedures¶

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with SAP Gateway.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from SAP Gateway, along with an indication of whether the procedure succeeded or failed.

SAP Gateway Connector Stored Procedures¶

GetOAuthAccessToken¶

Gets the OAuth access token from SAPGateway.

Input¶

Result Set Columns¶

GetOAuthAuthorizationURL¶

Gets the SAPGateway authorization URL. Access the URL returned in the output in a Web browser. This requests the access token that can be used as part of the connection string to SAPGateway.

Input¶

Result Set Columns¶

RefreshOAuthAccessToken¶

Refreshes the OAuth access token used for authentication with SAPGateway.

Input¶

Result Set Columns¶

System Tables¶

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables¶

The following tables return database metadata for SAP Gateway:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables¶

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables¶

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

sys_catalogs¶

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns¶

sys_schemas¶

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns¶

sys_tables¶

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns¶

sys_tablecolumns¶

Describes the columns of the available tables and views.

The following query returns the columns and data types for the SampleTable_1 table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='SampleTable_1'

Columns¶

sys_procedures¶

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns¶

sys_procedureparameters¶

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SampleProcedure stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' AND Direction=1 OR Direction=2

Columns¶

sys_keycolumns¶

Describes the primary and foreign keys.

The following query retrieves the primary key for the SampleTable_1 table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='SampleTable_1'

Columns¶

sys_foreignkeys¶

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns¶

sys_primarykeys¶

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys

Columns¶

sys_indexes¶

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns¶

sys_connection_props¶

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:sapgateway:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns¶

sys_sqlinfo¶

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities¶

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns¶

sys_identity¶

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity

Columns¶

Advanced Configurations Properties¶

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

Authentication

OAuth

SSL

Schema

Miscellaneous

Authentication¶

This section provides a complete list of authentication properties you can configure.

AuthScheme¶

The type of authentication to use when connecting to SAP Gateway.

Possible Values¶

Auto, OAuth, Basic, Token

Data Type¶

string

Default Value¶

Auto

Remarks¶

• Auto: Lets the driver decide automatically based on the other connection properties you have set.
• OAuth: Set this to perform OAuth authentication.
• Basic: Set this to use BASIC user / password authentication.
• Token: Set this to authenticate using an APIKey.

URL¶

Set this to the URL your SAP Gateway environment or to the full URL of the OData service. Any additional properties must be added using the CustomUrlParams property.

Data Type¶

string

Default Value¶

""

Remarks¶

Set this to the URL your SAP Gateway environment or to the full URL of the OData service. Any additional properties must be added using the CustomUrlParams property.

Namespace¶

Specify the service namespace you want to retrieve data from. This is required if the service is not specified in the URL.

Data Type¶

string

Default Value¶

""

Remarks¶

Specify the namespace you want to retrieve data from. For example, in the external OData service, http://services.odata.org/Northwind/Northwind.svc/ , 'Northwind' is the Service Namespace. This is required if the service is not specified in the URL.

Service¶

Specify the service you want to retrieve data from. This is required if the service is not specified in the URL.

Data Type¶

string

Default Value¶

""

Remarks¶

Specify the service you want to retrieve data from. This is required if the service is not specified in the URL.

User¶

The SAP Gateway user account used to authenticate.

Data Type¶

string

Default Value¶

""

Remarks¶

Together with Password, this field is used to authenticate against the SAP Gateway server.

Password¶

The password used to authenticate the user.

Data Type¶

string

Default Value¶

""

Remarks¶

The User and Password are together used to authenticate with the server.

APIKey¶

Set this to the key of the application you have created. If you set this, User and Password are not used for authentication.

Data Type¶

string

Default Value¶

""

Remarks¶

Set this to the key of the application you have created. If you set this, User and Password are not used for authentication.

OAuth¶

This section provides a complete list of OAuth properties you can configure.

InitiateOAuth¶

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values¶

OFF, GETANDREFRESH, REFRESH

Data Type¶

string

Default Value¶

OFF

Remarks¶

The following options are available:

1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId¶

The client ID assigned when you register your application with an OAuth authorization server.

Data Type¶

string

Default Value¶

""

Remarks¶

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret¶

The client secret assigned when you register your application with an OAuth authorization server.

Data Type¶

string

Default Value¶

""

Remarks¶

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken¶

The access token for connecting using OAuth.

Data Type¶

string

Default Value¶

""

Remarks¶

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation¶

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.

Data Type¶

string

Default Value¶

%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt

Remarks¶

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.

Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

The default location is "%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt" with %APPDATA% set to the user's configuration directory. The default values are

• Windows: "register://%DSN"
• Unix: "%AppData%..."

where DSN is the name of the current DSN used in the open connection.

The following table lists the value of %APPDATA% by OS:

Scope¶

The permission scopes in space separated values. This is required when authenticating via OAuth2.0 flow.

Data Type¶

string

Default Value¶

""

Remarks¶

The permission scopes you have configured when creating the service user for the OAuth 2.0 client, in space separated values. This is required when authenticating via OAuth2.0 flow.

CallbackURL¶

The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.

Data Type¶

string

Default Value¶

""

Remarks¶

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

OAuthVerifier¶

The verifier code returned from the OAuth authorization URL.

Data Type¶

string

Default Value¶

""

Remarks¶

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines¶

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken¶

The OAuth refresh token for the corresponding OAuth access token.

Data Type¶

string

Default Value¶

""

Remarks¶

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn¶

The lifetime in seconds of the OAuth AccessToken.

Data Type¶

string

Default Value¶

""

Remarks¶

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp¶

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type¶

string

Default Value¶

""

Remarks¶

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

SSL¶

This section provides a complete list of SSL properties you can configure.

SSLServerCert¶

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type¶

string

Default Value¶

""

Remarks¶

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema¶

This section provides a complete list of schema properties you can configure.

Location¶

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type¶

string

Default Value¶

%APPDATA%\SAPGateway Data Provider\Schema

Remarks¶

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\SAPGateway Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

BrowsableSchemas¶

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type¶

string

Default Value¶

""

Remarks¶

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables¶

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type¶

string

Default Value¶

""

Remarks¶

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views¶

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type¶

string

Default Value¶

""

Remarks¶

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

UseDisplayNames¶

Boolean determining whether or not to use SAP labels.

Data Type¶

bool

Default Value¶

false

Remarks¶

Boolean determining whether or not to use SAP labels.

If set to true, the labels you have configured in your account for the OData properties, will serve as column names. Otherwise, the name of the property will be the column name.

Miscellaneous¶

This section provides a complete list of miscellaneous properties you can configure.

CustomUrlParams¶

The custom query string to be included in the request.

Data Type¶

string

Default Value¶

""

Remarks¶

The CustomUrlParams allow you to specify custom query string parameters that are included with the HTTP request. The parameters must be encoded as a query string in the form field1=value1&field2=value2&field3=value3. The values in the query string must be URL encoded.

DataFormat¶

The data format to retrieve data in. Select either XML or JSON.

Possible Values¶

XML, JSON

Data Type¶

string

Default Value¶

XML

Remarks¶

The data format to retrieve data in. Possible values are JSON and XML. If not specified, XML will be set by default.

MaxRows¶

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type¶

int

Default Value¶

-1

Remarks¶

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Other¶

These hidden properties are used only in specific use cases.

Data Type¶

string

Default Value¶

""

Remarks¶

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting¶

Pagesize¶

The maximum number of results to return per page from SAP Gateway.

Data Type¶

int

Default Value¶

5000

Remarks¶

The Pagesize property affects the maximum number of results to return per page from SAP Gateway. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

PseudoColumns¶

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type¶

string

Default Value¶

""

Remarks¶

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout¶

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type¶

int

Default Value¶

60

Remarks¶

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.

UseDynamicStoredProcedures¶

A boolean indicating if dynamic stored procedures should be exposed.

Data Type¶

bool

Default Value¶

false

Remarks¶

A boolean indicating if dynamic stored procedures should be exposed.

UserDefinedViews¶

A filepath pointing to the JSON configuration file containing your custom views.

Data Type¶

string

Default Value¶

""

Remarks¶

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM SampleTable_1 WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.