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 connecting, see Establishing a Connection.
| Property | Description |
| ConnectionType | The type of connection you are making. |
| ConnectionScheme | Specifies whether you are connecting to a SAP system with a message server (GroupServer) or without one (ApplicationServer). |
| Host | Host name of the target system. |
| SystemNumber | The number by which the target system is defined. Used when setting 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 client authenticating to the SAP system. |
| X509Certificate | The X509 certificate used for login as an alternative to User , and Password . |
| MessageServer | The message server must be specified when connecting to an SAP system that uses load balancing. |
| Group | The Logon Group being used. This typically only needs to be specified when connecting to an SAP system that uses load balancing. |
| SystemId | The 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. |
| RFCURL | The URL of the SOAP interface to connect with SAP. |
| MessageServerService | The message server service you wish to connect to. |
| Property | Description |
| SNCMode | A boolean determining if you are using SNC. Set this to true to use SNC. |
| SNCName | An optional input with the name of your SNC connection. |
| SNCQop | The quality of protection for your SNC connection. |
| SNCPartnerName | The application server's SNC name. This is a required input when using SNC. |
| SNCLibPath | An optional input detailing the path and file name of the external library. |
| SNCSSO | Whether to use the SNC identity for authenticating the caller when connnection via SNC mode. |
| 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 | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) 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 | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | 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. |
| CacheProvider | The namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations. |
| CacheConnection | The connection string for the specified cache database. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance, in seconds, for stale data in the specified cache database. |
| Offline | Get 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 |
| SAPEdition | The edition of SAP being used. Set either SAP cloud or SAP OnPremise. |
| BAPINameSeparator | A separator for concatenating table and column names when the output of the stored procedure contains a table type parameter. |
| BatchSize | Specifies the maximum number of rows included in each batch operation. Set to 0 to submit the entire batch as a single request. |
| Charset | The system code page used for Unicode to multibyte translations. |
| CheckDecimalNotation | A boolean indicating if you need to use the Decimal Notation of the SAP user profile to format the decimal data. |
| ConnectionLifeTime | Specifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection. Set to 0 or leave empty for no time limit. |
| Destination | Reference to an existing destination that is specified in a local saprfc.ini or sapnwrfc.ini file. |
| EndianType | The endian type for the SAP server. Enter either Big or Little. |
| GatewayHost | The gateway host you wish to connect to. |
| GatewayService | The gateway service you wish to connect to. |
| GenerateSchemaFiles | Determines how schema files should be generated. |
| InitialValueMode | How to treat initial values in SAP. |
| Language | The language value to be used when connecting to the SAP system. |
| Location | A 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. |
| MapNUMCToVarchar | Specifies whether to map the SAP NUMC and ACCP type to number or varchar types. |
| MapRAWToVarchar | If True, the provider maps the SAP RAW and LRAW types to Varchar type. If False, the provider maps RAW and LRAW types to Binary type. |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| Pagesize | The number of results to return per page from SAP. Only used for SAP tables. |
| PoolIdleTimeout | Specifies the maximum idle time, in seconds, that a connection can remain in the pool before being closed. |
| PoolMaxSize | Specifies the maximum number of connections allowed in the connection pool. The default value is 100. Set to 0 or a negative value to disable pooling. |
| PoolMinSize | Specifies the minimum number of connections maintained in the connection pool. The default value is 1. |
| 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. The default is 60 seconds. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| QueryMode | Determines which SAP queries will be displayed as views, if any. |
| ReadTableDelimiter | The delimiter is submitted to the ReadTableFunction . |
| 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. Use this property only in environments where the standard licensing method is unsupported or requires a runtime key. |
| StoredProcedureFilter | A filter indicating which function modules to report as stored procedures. |
| SupportServerSideCount | Determines if the count function of the simple query is executed in the SAP server. For example, select count(*) from ADRC. |
| TableMode | Determines which SAP tables will be 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. The default is 60 seconds. Set to 0 to disable the timeout. |
| TrimStrings | A boolean indicating if varchar columns should be trimmed or not. |
| UseConnectionPooling | Enables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request. |
| UseInternalNames | Specifies the whether to use the internalName of columns. |
| UseLabels | Set this property to determine if labels should be used for table and column names. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
| UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
| UseUnicodeRFC | A boolean indicating if you want to use RFC_GET_UNICODE_STRUCTURE to get structure information. |
| WhitespaceToNull | Indicates whether to read the empty value as original value or as null. |