Connection String Options
The connection string 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 in the connection string for this provider. Click the links for further details.
| Property | Description |
| ConnectionType | The method used to connect to SAP ERP data. |
| ConnectionScheme | Specifies whether to connect to an SAP system with a message server (GroupServer) or without one (ApplicationServer). |
| Host | Host name of the target SAP system. |
| SystemNumber | The instance number associated with the server specified in the Host connection property. |
| User | The user that is authenticating to the SAP system. |
| Password | The password used to authenticate to the SAP system. |
| Client | The name of the SAP client, among those in the targeted SAP installation, that you want to connect to. |
| X509Certificate | The X509 certificate used for login as an alternative to logging in with User and Password. |
| MessageServer | The host name or IP address of the message server (central load balancing server) you want to use to connect to SAP data. |
| Group | The Logon Group on your message server to which the current user belongs. |
| SystemId | The System Id or R3Name of the message server specified in the MessageServer connection property. |
| RFCURL | The URL of the SOAP interface you want to use to connect to SAP. |
| MessageServerService | The name of the service where the message server specified in the MessageServer connection property can be reached. |
| Property | Description |
| SNCMode | Specifies whether to use Secure Network Communications (SNC). |
| SNCName | An optional input with the name of your SNC connection. |
| SNCQop | The quality of protection for your SNC connection. |
| SNCPartnerName | The SNC name of the SAP instance you want to connect to. |
| SNCLibPath | An optional input detailing the path and file name of the SAP cryptographic library. |
| SNCSSO | Specifies whether to connect via the SAP SSO (using the Secure Login Library). |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| Logfile | Specifes the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details. |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| MaxLogFileSize | Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name. |
| MaxLogFileCount | Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one. |
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| AutoCache | Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database. |
| CacheDriver | The driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations. |
| CacheConnection | Specifies the connection string for the specified cache database. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True. |
| Offline | Gets the data from the specified cache database instead of live SAP ERP data. |
| CacheMetadata | Determines whether the provider caches table metadata to a file-based cache database. |
| Property | Description |
| CloudServerPort | The port on which the target SAP S/4 HANA Cloud server application is running. |
| SAPEdition | The edition of SAP you want to use. |
| BAPINameSeparator | A prefix used to differentiate columns in a query result that originated in different tables, but have the same name. Each of these columns is given a prefix consisting of the name its containing table, followed by the character(s) specified in this connection property. |
| BatchSize | Specifies the maximum number of rows included in each batch submitted during batch operations. To submit the entire batch as a single request, set BatchSize to 0 . |
| Charset | The system code page to use when converting SAP Unicode byte arrays to strings. |
| CheckDecimalNotation | Specifies whether to read decimal values using the decimal notation specified in the user profile of the connected SAP user. |
| ConnectionLifeTime | Specifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection. |
| ConnectOnOpen | Specifies whether the provider establishes a connection to SAP ERP immediately upon opening the connection. Set ConnectOnOpen to True if immediate connectivity verification is necessary. |
| EndianType | The endian type of your SAP server. |
| GatewayHost | The gateway host you want to connect to. |
| GatewayService | The port used to connect to the SAP Gateway server specified in the GatewayHost connection property. |
| GenerateSchemaFiles | Determines how and when schema files are generated. |
| InitialValueMode | Controls whether empty column values are displayed as NULL or an initial (non-NULL) value. |
| Language | The ISO 639-1 language code used by your SAP system. |
| Location | The path where generated schema files are placed. |
| MapNUMCToVarchar | Specifies whether to map SAP table fields of NUMC and ACCP types to Varchar type. |
| MapRAWToVarchar | Specifies whether to map the SAP RAW and LRAW types to Varchar type. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details. |
| Pagesize | The maximum number of records per page the provider returns when requesting data from SAP ERP. Only used for SAP tables. |
| PaginationScheme | Determines how to handle the pagination query. |
| PoolIdleTimeout | Specifies the maximum idle time, in seconds, that a connection can remain in the pool before being closed. Requires UseConnectionPooling=True. |
| PoolMaxSize | Specifies the maximum number of connections allowed in the connection pool. |
| PoolMinSize | Specifies the minimum number of connections to be maintained in the connection pool at all times. |
| PoolWaitTime | Specifies the maximum number of seconds a connection request waits for an available connection in the pool. If the wait exceeds this time, an error is returned. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| QueryMode | Determines which SAP Queries are displayed as views, if any. |
| ReadTableDelimiter | The delimiter used by the read table function specified in the ReadTableFunction connection property. |
| ReadTableFunction | The function to use for reading table data. |
| RTK | Specifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key. |
| StoredProcedureFilter | A filter controlling which function modules are reported as stored procedures. |
| SupportServerSideCount | Enables server-side execution of the COUNT function in supported SAP installations. |
| TableMode | Determines which SAP tables are displayed as views, if any. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| TrimStrings | Specifies which, if any, leading and trailing whitespaces are omitted from varchar columns. |
| UseConnectionPooling | Enables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request. |
| UseInternalNames | Specifies whether to use the internal names of columns in query results rather than the display name. |
| UseLabels | Controls whether the human-readable names or internal names of tables and columns are displayed in query results. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| UseSimpleNames | Specifies whether or not simple names should be used for tables and columns. |
| UseUnicodeRFC | Specifies whether to use the RFC_GET_UNICODE_STRUCTURE function module to get structure information. |
| WhitespaceToNull | Specifies whether to return string fields with an empty value as null. |