SAP HANA XS Advanced Connection Details

Introduction

Connector Version

This documentation is based on version 23.0.8804 of the connector.

Get Started

SAP HANA XSA Version Support

The connector leverages the SAP HANA XSA API to enable bidirectional access to SAP HANA XSA.

Establish a Connection

SAP HANA XSA uses the OAuth authentication standard. Before connecting, it is necessary to establish an SAP HANA XSA OData Service. See Creating a Custom OAuth App for a guide.

To connect to SAP HANA XSA using the OAuthPassword Grant type set the following:

• OAuthClientId: Set this to the Client ID specified in the UAA service JSON file.
• OAuthClientSecret: Set this to the Client Secret specified in the UAA service JSON file.
• URL: Set this to the OData service endpoint.
• XSUAAURL: Set this to the UAA service URL.
• User: Set your accounts username.
• Password: Set your accounts password

Once you've configured the OData Service, you can establish a connection using Custom Credentials.

Use OAuth Authentication

Use the OAuth authentication standard to connect to SAP HANA XSA V3 API. You can authenticate with a user account. The connector facilitates this as described below.

User Accounts

The user account flow requires the authenticating user to interact with SAP HANA XSA via the browser.

Create a Custom OAuth App

You will need to create a custom OAuth app to connect to data. See Creating a Custom OAuth App for a procedure.

Custom Credentials

You can register an app to obtain the OAuthClientId and OAuthClientSecret.

When to Create a Custom OAuth App

You will need to create a custom OAuth app to connect.

Use a Service Account to Connect to SAP HANA XSA

Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes to the connector.

You need to create an OAuth application in this flow. You can then connect to SAP HANA XSA data that the service account has permission to access. See Custom Credentials for an authentication guide.

Create a Custom OAuth App

This driver is able to consume an OData service deployed in one of your SAP HANA XSA application.

Configure the SAP HANA XS Advanced OData Service

The OData service in an XSA application is defined in a server module by creating a filename.xsodata file. The XSOData files contain the specifications of your created OData service.

XS UAA Configuration

In a Multi-Target SAP HANA Extended Services (XS) Advanced application, the XS User Account and Authentication (UAA) service module is used for authenticating and authorizing users for API access. The UAA uses OAuth 2.0 as its Authentication and Authorization flow. Before connecting, some configurations must be made to the XS UAA module.

In either the /path/appname or path/appname/security directory, create a JSON file named xs-security.json. In this file, define the configuration for the UAA module.

To define the module, place the scopes and roles for accessing the OData service in the xs-security.json file.

As an example:

"scopes": [{
"name": "$XSAPPNAME.odataAccess",
"description": "Access the OData service."
}]

The role created will reference the scope defined above. As an example:

"role-templates": [{
"name": "ODataAccess",
"description": "Role for accessing the OData service",
"scope-references": [
"$XSAPPNAME.odataAccess"
]
}]

Further configuration is needed if the user is planning on using the CODE grant type. In the xs-security.json file, add the following:

"oauth2-configuration": {
"token-validity": 90000, //time in seconds when an access token expires
"redirect-uris": ["http://localhost:33333"] //the default callback of  Drivers
}

Web Module Configuration

While defining the routes for the web module, define an extra route for the XSOData file. For example:

"routes": [{
"source": "^/euro.xsodata/.*$", //OData service endpoint
"destination": "js_module_service_url", //server module service url defined in mta.yaml
"authenticationType": "xsuaa",
"scope": "$XSAPPNAME.odataAccess" //the scope which grants access to the OData service
}]

Notice that there is a scope attribute referencing the scope which grants access to the OData service. After successfully building and running your application, we should go and grant Users access to our OData service.

Role Management

To create a role collection, navigate to XSA-COCKPIT -> Security -> Role Collections -> New Role Collection . Provide the collection with your desired name. Open the role collection you created and click on Add Role. In the xs-security.json file, set the application Identifier under your application and the role template on the ODataAccess role that was specified. To assign the created role to a user, navigate to XSA-COCKPIT -> User Management -> Assign Role Collections -> Add, then search for the role created by name or find it in the list, then click Save.

Obtain Client Credentials

You can find the client credentials by navigating to XSA-COCKPIT -> Your Organization -> Your Application -> Services -> Service Instances -> XSUAA Service -> Show Sensitive Data. In the JSON file shown, note the client id, the client secret and the URL. The URL specified here is the host used for authenticating and authorizing users.

Connect to an SAP HANA XSA Account

Once you have properly set up your application and already have access to the OData Service, follow the instructions on Custom Credentials in order to connect to your SAP HANA XSA Application.

The XS UAA Module uses OAuth2.0 as its authorization method. Only CODE and PASSWORD grant types are supported.

Custom Credentials

You can use a custom OAuth app to authenticate with a service account or a user account. See Using OAuth Authentication for more information.

User Accounts

Desktop Authentication with a Custom OAuth App

Follow the steps below to authenticate with the credentials for a custom OAuth app. See Creating a Custom OAuth App.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OAuthClientId: Set this to the Client ID specified in the UAA service JSON file.
• OAuthClientSecret: Set this to the Client Secret specified in the UAA service JSON file.
• URL: Set this to the OData service endpoint.
• XSUAAURL: Set this to the UAA service host.
• CallbackURL: Set this to http://localhost:33333.

When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

1. Extracts the access token from the callback URL and authenticates requests.
2. Refreshes the access token when it expires.
3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Using Password Grant Type

To connect to SAP Hana XSA using the PASSWORD Grant type set the following:

• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OAuthClientId: Set this to the Client ID specified in the UAA service JSON file.
• OAuthClientSecret: Set this to the Client Secret specified in the UAA service JSON file.
• URL: Set this to the OData service endpoint.
• OAuthGrantType: Set this to PASSWORD.
• XSUAAURL: Set this to the UAA service URL.
• User: Set your accounts username.
• Password: Set your accounts password

Headless Machines

Use OAuth on a Headless Machine

The following sections show how to authenticate a headless server or another machine on which the connector cannot open a browser. You can authenticate with a user account or with a service account.

User Accounts

To authenticate with a user account, you need to authenticate from another machine. Authentication is a two-step process.

1. Instead of installing the connector on another machine, you can follow the steps below to obtain the OAuthVerifier value. Or, you can install the connector on another machine and transfer the OAuth authentication values, after you authenticate through the usual browser-based flow.
2. You can then configure the connector to automatically refresh the access token from the headless machine.

You can follow the headless OAuth authentication flow using the OAuth credentials for your custom OAuth app.

Use the Credentials for a Custom OAuth App

Create a Custom OAuth App

You will need to create a custom OAuth app to connect.

See Creating a Custom OAuth App for a procedure. You can then follow the procedures below to authenticate and connect to data.

Obtain a Verifier Code

Set the following properties on the headless machine:

• InitiateOAuth: Set this to OFF.
• OAuthClientId: Set this to the Client ID in your app settings.
• OAuthClientSecret: Set this to the Client Secret in your app settings.
• URL: Set this to the OData service endpoint.
• XSUAAURL: Set this to the UAA service host.
• CallbackURL: Set this to http://localhost:33333.

You can then follow the steps below to authenticate from another machine and obtain the OAuthVerifier connection property.

1. Call the GetOAuthAuthorizationURL stored procedure with the CallbackURL input parameter set to the exact Redirect URI you specified in your app settings.
2. Open the returned URL in a browser. Log in and grant permissions to the connector. You are then redirected to the callback URL, which contains the verifier code.
3. Save the value of the verifier code. You will set this in the OAuthVerifier connection property.

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: Set this to the consumer key in your app settings.
• OAuthClientSecret: Set this to the consumer secret in your app settings.
• OAuthVerifier: Set this to the verifier code.
• OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified location.
• URL: Set this to the OData service endpoint.
• XSUAAURL: Set this to the UAA service host.

After the OAuth settings file is generated, set the following properties to connect to data:

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: Set this to the consumer key in your app settings.
• OAuthClientSecret: Set this to the consumer secret in your app settings.
• OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the provider to enable the automatic refreshing of the access token.
• URL: Set this to the OData service endpoint.
• XSUAAURL: Set this to the UAA service host.

Transfer OAuth Settings

Follow the steps below to install the connector on another machine, authenticate, and then transfer the resulting OAuth values.

On a second machine, install the connector and connect with the following properties set:

• InitiateOAuth: Set this to GETANDREFRESH.
• OAuthSettingsLocation: Set this to a writable location.
• OAuthClientId: Set this to the client ID assigned when you registered your app.
• OAuthClientSecret: Set this to the client secret assigned when you registered your app.
• CallbackURL: Set this to http://localhost:33333.
• URL: Set this to the OData service endpoint.
• XSUAAURL: Set this to the UAA service host.

Test the connection to authenticate. The resulting authentication values are written, encrypted, to the location specified by OAuthSettingsLocation. Once you have successfully tested the connection, copy the OAuth settings file to your headless machine. On the headless machine, set the following connection properties to connect to data:

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: Set this to the consumer key in your app settings.
• OAuthClientSecret: Set this to the consumer secret in your app settings.
• OAuthSettingsLocation: Set this to the location of your OAuth settings file. Make sure this location gives read and write permissions to the connector to enable the automatic refreshing of the access token.
• URL: Set this to the OData service endpoint.
• XSUAAURL: Set this to the UAA service host.

Important Notes

Configuration Files and Their Paths

• All references to adding configuration files and their paths refer to files and locations on the Jitterbit 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 HANA XSA 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 HANA XSA and then processes the rest of the query in memory (client-side).

User Defined Views

The Jitterbit Connector for SAP HANA XSA 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 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

Overview

This section shows the available API objects and provides more information on executing SQL to SAP HANA XSA APIs.

Key Features

• The connector models the SAP HANA XSA OData Service as relational tables and views, allowing you to write SQL to query SAP HANA XSA data.
• Stored procedures allow you to execute operations to SAP HANA XSA.
• Live connectivity to these objects means any changes to your SAP HANA XSA account are immediately reflected when using the connector.

Tables

The connector dynamically obtains table metadata from the SAP HANA XSA OData service. See Metadata Discovery for more information.

Views

The connector dynamically obtains read-only view metadata from the SAP HANA XSA OData service. See Metadata Discovery for more information.

Stored Procedures

Stored Procedures are function-like interfaces to SAP HANA XSA. Stored procedures allow you to execute operations to SAP HANA XSA, including downloading documents and moving envelopes.

Stored Procedures

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

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

Jitterbit Connector for SAP HANA XSA Stored Procedures

GetOAuthAccessToken

Gets an authentication token from SAPHanaXSA.

Input

Result Set Columns

GetOAuthAuthorizationURL

Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.

Input

Result Set Columns

RefreshOAuthAccessToken

Refreshes the OAuth access token used for authentication with various Basecamp services.

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 HANA XSA:

• 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 table:

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

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 table:

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

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:saphanaxsa: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

Metadata Discovery

Exposing Entities and Navigation Properties

The connector models SAP HANA XSA OData Service as relational tables and views.

The OData Service has relationships to other objects in the tables, which are expressed through foreign keys.

The connector dynamically obtains the metadata from the OData service exposed by the Multi Target SAP Hana XS Advanced application.

Take for example the following OData Service:

service {
"tinyworld.tinydb::tinyf.world" as "Continents" navigates ("Continet_Countries" as "Country");
"tinyworld.tinydb::tinyf.Country" as "Countries";
"tinyworld.tinydb::tinyf.pollution_data" as "pollution_data";
association "Continet_Countries" principal "Continents"("continent") multiplicity "1" dependent "Countries"("partof.continent") multiplicity "*";
}

The connector will expose 3 tables and 1 view as specified in the .xsodata file. The exposed tables would be: Continents, Countries and pollution_data, and the exposed view would be: Continents_Country. Every configuration done to the .xsodata file will affect the OData Service and the data exposed by the connector.

Exposing Parameterized Calculation Views

Apart from the standard OData entities our connector exposes and supports querying for Parameterized Calculation Views configured as separate entity sets and also as navigation properties of another entity set.

The input parameters are exposed as standard table columns and its value can be provided as a WHERE clause condition. The input parameter column can be easily identified as the connector appends the 'Parameters_' prefix to the column name. You should note the only server side supported operator for input parameters is EQUAL (=).

SELECT * FROM Orders WHERE Parameters_InputRegion='US'

The input parameters are required in the WHERE clause only if a default value is not set at design time on XSA Web IDE. This means that the example query below should be executed correctly without providing any value for the input parameters if a default value is configured for the InputRegion parameter.

SELECT * FROM Orders

Let's consider the following example OData Service:

service {
"tinyworld.tinydb::LocalOrders" as "Orders" keys("No") parameters via entity;
"tinyworld.tinydb::ThresholdOrders" as "LocalThresholdOrders" keys("No") parameters via entity "ThresholdParams" results property "Execute";
"tinyworld.tinydb::tinyf.Customer" as "Customers" navigates ("customer_res" as "CustomerReservations");
"tinyworld.tinydb::ReservationView" as "Reservations" key ("resno") parameters via key and entity;
association via parameters "customer_res" principal "Customer"("CustomerId") multiplicity "1" dependent "Reservations"("InputCustomerId") multiplicity "*";
}

The first exposed parameterized view is the 'Orders' view. Since it uses the default configuration, you can query it directly without any additional configuration.

As per the second one, 'LocalThresholdOrders', it uses a custom renamed parameters entity set 'ThresholdParams'. In order for the connector to correctly identify it as a parameterized view, you will need to provide the parameters entity name via the ParametersEntitySets connection property. If you have more than one renamed parameters entity set, then you can provide the comma separated list of the renamed parameter entity sets for each exposed parameterized view.

The connector also exposes and provides the possibility to query parameterized views configured as Navigation Properties of another entity. This type of navigation view does not support expanding, so in order to query it you will need to specify the base entity's key. You should not provide any value for the input parameters. They are neither required nor server side supported as their values are bound to the corresponding base entity fields.

In this example, the 'Reservations' calculation view is configured as the 'CustomerReservations' navigation property of the Customers' entity. The example query below returns the 'CustomerReservations' for the customer with key value 1001.

SELECT * FROM Customers_ CustomerReservations WHERE CustomerId = '1001'

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 HANA XSA.

Possible Values

Basic, OAuth, OAuthPassword

Data Type

string

Default Value

Basic

Remarks

• Basic: Set this to use Basic User / Password authentication.
• OAuth: Set this to perform OAuth authentication with code grant type.
• OAuthPassword: Set this to perform OAuth authentication with password grant type.

XSUAAURL

The URL to retrieve the OAuth access token from.

Data Type

string

Default Value

""

Remarks

In OAuth 1.0, the authorized request token is exchanged for the access token at this URL.

URL

The OData service endpoint.

Data Type

string

Default Value

""

Remarks

You can find this endpoint in your web module configurations. Check the file where you have defined all your routes. Set this connection property to a URL which points to an OData service file for ex: http://hxehost.com/euro.xsodata

User

The SAP HANA XSA user account used to authenticate.

Data Type

string

Default Value

""

Remarks

Together with Password, this field is used to authenticate against the SAP HANA XSA 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.

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:

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

http://localhost:33333

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.

OAuthGrantType

The grant type for the OAuth flow.

Possible Values

CODE, PASSWORD

Data Type

string

Default Value

PASSWORD

Remarks

The following options are available: CODE,PASSWORD

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%\SAPHanaXSA 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%\SAPHanaXSA 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.

Miscellaneous

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

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.

ODataVersion

The version of OData to use. By default the provider will attempt to autodetect the version.

Possible Values

AUTO, 2.0, 4.0

Data Type

string

Default Value

AUTO

Remarks

The version of OData to use. By default the connector will automatically attempt to determine the version the service is using. If a version cannot be resolved, 3.0 will be used. This can optionally be manually set.

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 HANA XSA.

Data Type

int

Default Value

1000

Remarks

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

ParametersEntitySets

The comma separated list of the renamed parameter entity sets for the exposed parameterized calculated views.

Data Type

string

Default Value

""

Remarks

You can provide the parameters entity set names as a comma separated list for the exposed calculated views that you are either using a renamed parameters entity set or a renamed Results navigation property.

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, "*=*".

SupportsExpand

Whether you need to specify the base entity's key to query navigation property views.

Data Type

bool

Default Value

true

Remarks

This connection property is primarily used with limited OData APIs; it determines whether navigation properties can be retrieved from the base entity set. In OData, navigation properties link a base entity to a related entity or a collection of related entities.

For more on navigation properties, see Data Model.

Working with Limited APIs

In OData, the $expand parameter is used to expand specified navigation properties when requesting data from a given entity set. In SQL, this makes it possible to execute a SELECT * to a navigation property view.

If $expand is not supported, a different request must be made to retrieve a navigation property, one that specifies the primary key of the base entity set. This API restriction is reflected in SQL: You will need to specify the base entity's primary key in the WHERE clause.

For example, consider two entities with a one-to-many relationship in the Northwind sample service, Categories and Products. In OData, the Products associated with a given Category could be represented as a navigation property on the base Category entity set. The connector models the Products navigation property as a Categories_Products view.

If $expand is not supported, use a query like the following to this view:

SELECT       *
FROM         Categories_Products
WHERE        (Categories_CategoryID = 1)

SupportsFormulas

A boolean indicating whether the OData service supports server side formulas.

Data Type

bool

Default Value

false

Remarks

OData has many server-side formulas that are built into the specifications. However, many services do not natively support them and will return errors when these formulas are appended to the $filter parameter. When supported, server-side formulas can be used to execute certain queries much faster. If your OData service supports formulas, set this connection property to true. Otherwise, leave it as false.

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.

UseClientSidePaging

Whether or not the ADO.NET Provider for SAP HANA XSA should use client side paging.

Data Type

bool

Default Value

true

Remarks

Some sources do not support server side paging. In these cases, set UseClientSidePaging to true. Otherwise, leave it as false. Setting UseClientSidePaging to true on a source that already supports paging can cause incomplete results.

UseEtags

Whether or not the OData source uses Etags.

Data Type

bool

Default Value

false

Remarks

Some OData sources do not use Etags. In these instances, set UseEtags to False.

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

UseSimpleNames

Boolean determining if simple names should be used for tables and columns.

Data Type

bool

Default Value

false

Remarks

SAP HANA XSA tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the connector easier to use with traditional database tools.

Setting UseSimpleNames to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.