JDBC Driver for SAP ERP

Build 23.0.8839

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.

For more information on establishing a connection, see Establishing a Connection.


ConnectionTypeThe type of connection you are making.
ConnectionSchemeSpecifies whether you are connecting to a SAP system with a message server (GroupServer) or without one (ApplicationServer).
HostHost name of the target system.
SystemNumberThe number by which the target system is defined. Used when setting the Host connection property.
UserThe user that is authenticating to the SAP system.
PasswordThe password used to authenticate to the SAP system.
ClientThe client authenticating to the SAP system.
X509CertificateThe X509 certificate used for login as an alternative to User , and Password .
MessageServerThe message server must be specified when connecting to an SAP system that uses load balancing.
GroupThe Logon Group being used. This typically only needs to be specified when connecting to an SAP system that uses load balancing.
SystemIdThe System Id or R3Name of the SAP System is a string with a maximum of three characters. It is often used in load balancing connections.
RFCURLThe URL of the SOAP interface to connect with SAP.
MessageServerServiceThe message server service you wish to connect to.


SNCModeA boolean determining if you are using SNC. Set this to true to use SNC.
SNCNameAn optional input with the name of your SNC connection.
SNCQopThe quality of protection for your SNC connection.
SNCPartnerNameThe application server's SNC name. This is a required input when using SNC.
SNCLibPathAn optional input detailing the path and file name of the external library.
SNCSSOWhether to use the SNC identity for authenticating the caller when connnection via SNC mode.


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


FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.


ProxyAutoDetectThis indicates whether to use the system proxy settings or not.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .


LogfileA filepath which designates the name and location of the log file.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
LogModulesCore modules to be included in the log file.
MaxLogFileSizeA string specifying the maximum size in bytes for a log file (for example, 10 MB).
MaxLogFileCountA string specifying the maximum file count of log files.


BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.


AutoCacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheDriverThe database driver used to cache data.
CacheConnectionThe connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
CacheLocationSpecifies the path to the cache when caching to a file.
CacheToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
OfflineUse offline mode to get the data from the cache instead of the live source.
CacheMetadataThis property determines whether or not to cache the table metadata to a file store.


BatchSizeThe maximum size of each batch operation to submit.
CharsetThe system code page used for Unicode to multibyte translations.
CheckDecimalNotationA boolean indicating if you need to use the Decimal Notation of the SAP user profile to format the decimal data.
ConnectionLifeTimeThe maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectOnOpenThis property specifies whether to connect to the SAP ERP when the connection is opened.
EndianTypeThe endian type for the SAP server. Enter either Big or Little.
GatewayHostThe gateway host you wish to connect to.
GatewayServiceThe gateway service you wish to connect to.
GenerateSchemaFilesDetermines how schema files should be generated.
InitialValueModeHow to treat initial values in SAP.
LanguageThe language value to be used when connecting to the SAP system.
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures to work with your chosen data source. This must be set in order to add new tables to provider.
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe number of results to return per page from SAP. Only used for SAP tables.
PoolIdleTimeoutThe allowed idle time for a connection before it is closed.
PoolMaxSizeThe maximum connections in the pool.
PoolMinSizeThe minimum number of connections in the pool.
PoolWaitTimeThe max seconds to wait for an available connection.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
QueryModeDetermines which SAP queries will be displayed as views, if any.
ReadTableFunctionThe function to use for reading table data.
RTKThe runtime key used for licensing.
StoredProcedureFilterA filter indicating which function modules to report as stored procedures.
TableModeDetermines which SAP tables will be displayed as views if any.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
TrimStringsA boolean indicating if varchar columns should be trimmed or not.
UseConnectionPoolingThis property enables connection pooling.
UseInternalNamesSpecifies the whether to use the internalName of columns.
UseLabelsSet this property to determine if labels should be used for table and column names.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.
UseSimpleNamesBoolean determining if simple names should be used for tables and columns.
UseUnicodeRFCA boolean indicating if you want to use RFC_GET_UNICODE_STRUCTURE to get structure information.

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