Matillion ETL Data Model for SAP NetWeaver
Version - 21.0.8137.0

Note: Data models are true for the latest version of Matillion ETL. If you are on an older version or using a component from an old job, your experience may differ.



Connection String OptionsBack To Top

  1. ConnectionType
  2. Host
  3. SystemNumber
  4. User
  5. Password
  6. Client
  7. X509Certificate
  8. MessageServer
  9. Group
  10. SystemId
  11. RFCURL
  12. MessageServerService
  13. SNCMode
  14. SNCName
  15. SNCQop
  16. SNCPartnerName
  17. SNCLibPath
  18. SSLServerCert
  19. FirewallType
  20. FirewallServer
  21. FirewallPort
  22. FirewallUser
  23. FirewallPassword
  24. ProxyAutoDetect
  25. ProxyServer
  26. ProxyPort
  27. ProxyAuthScheme
  28. ProxyUser
  29. ProxyPassword
  30. ProxySSLType
  31. ProxyExceptions
  32. Logfile
  33. Verbosity
  34. LogModules
  35. MaxLogFileSize
  36. MaxLogFileCount
  37. BrowsableSchemas
  38. Tables
  39. Views
  40. AutoCache
  41. CacheDriver
  42. CacheConnection
  43. CacheLocation
  44. CacheTolerance
  45. Offline
  46. CacheMetadata
  47. BatchSize
  48. Charset
  49. ConnectionLifeTime
  50. ConnectOnOpen
  51. Destination
  52. EndianType
  53. GatewayHost
  54. GatewayService
  55. GenerateSchemaFiles
  56. InitialValueMode
  57. Language
  58. Location
  59. MaxRows
  60. Other
  61. Pagesize
  62. PoolIdleTimeout
  63. PoolMaxSize
  64. PoolMinSize
  65. PoolWaitTime
  66. PseudoColumns
  67. QueryMode
  68. ReadTableFunction
  69. RTK
  70. StoredProcedureFilter
  71. SupportEnhancedSQL
  72. TableMode
  73. Timeout
  74. UseConnectionPooling
  75. UseLabels
  76. UseSimpleNames
  77. UseUnicodeRFC

ConnectionType

Data Type

string

Default Value

"NetWeaver"

Remarks

The type of connection you are making to SAP.
Use CLASSIC for the librfc32.dll.
Use CLASSIC_UNICODE for the librfc32u.dll.
Use NETWEAVER to indicate you are using the sapnwrfc.dll.
Use JCO to indicate you are using the sapjco.jar.
Use SOAP to indicate you are using SOAP and setting the RFC URL.



Host

Data Type

string

Default Value

""

Remarks

Host names can be regular host names defined in a hosts file, an IP address like 123.123.123.123, or an SAProuter address such as "/H/hostname/S/port/H/host/S/port/ ..."

This property is required when connecting through the SAP librfc32.dll interface. The "librfc32.dll" is included in R/3 (NetWeaver) and RFC API installations, or may be acquired directly from SAP.

This property is necessary only when not using the RSBSAP_p_RFCURL property to connect with SAP.



SystemNumber

Data Type

string

Default Value

"0"

Remarks

The valid range is 0 to 99. In general, this value is 0.



User

Data Type

string

Default Value

""

Remarks

Client, User, and Password are needed for authentication to the R/3 server.



Password

Data Type

string

Default Value

""

Remarks

Client, User, and Password are needed for authentication to the R/3 server.



Client

Data Type

string

Default Value

""

Remarks

Client, User, and Password are needed for authentication to the R/3 server.



X509Certificate

Data Type

string

Default Value

""

Remarks

Using an X509 certificate for login requires also setting the SNC connection properties. The X509 certificate may be specified using a file path pointing to a file containing an X509 certificate in PEM format, a PEM blob beginning with the "-----BEGIN ..." header, or a PEM blob without the "-----BEGIN ..." header.



MessageServer

Data Type

string

Default Value

""

Remarks

The message server is used instead of an individual application server when connecting to an SAP system using load balancing. The load is balanced between several application servers and clients only need to know the name of the message server to connect.



Group

Data Type

string

Default Value

""

Remarks

The default in most SAP systems will be PUBLIC.



SystemId

Data Type

string

Default Value

""

Remarks

The System Id is a string with a maximum of three characters. It often used in connections to SAP systems with load balancing, but may also be used in SAP systems with a dedicated application server.



RFCURL

Data Type

string

Default Value

""

Remarks

If connecting to SAP through the SOAP interface, this property must be set to the SOAP URL of your SAP system.

An example of this is http://localhost:8000/sap/bc/soap/rfc.

The SOAP service must be enabled in your SAP system for this type of connection to work properly.



MessageServerService

Data Type

string

Default Value

""

Remarks

If not specified, http will be used. On windows machines, these services to their port mappings are stored on C:\windows\system32\drivers\etc\services.



SNCMode

Data Type

bool

Default Value

false

Remarks

SNC security will only be used when you establish a connection to SAP using one of the RFC SDKs outlined in the ConnectionType. You should be able to find the values you need to specify by going to your SAP Logon, right-clicking your connection and opening Properties. On the System Entry Properties dialog, open the Network --> Secure Network Settings window. This window should have the information you need to specify for the SNC properties.



SNCName

Data Type

string

Default Value

""

Remarks

Although this parameter is optional, we recommend setting it to make sure that the correct SNC name is used for the connection.



SNCQop

Data Type

string

Default Value

""

Remarks

This is an integer that will be -1 if unspecified and can potentially go to a maximum of 9 depending on your application server. Valid values are 1, 2, 3, 8, or 9, which correspond to the following protection levels:

1Apply authentication only.
2Apply integrity protection (authentication).
3Apply privacy protection (integrity and authentication).
8Apply the default protection.
9Apply the maximum protection.



SNCPartnerName

Data Type

string

Default Value

""

Remarks

The application server's SNC name.



SNCLibPath

Data Type

string

Default Value

""

Remarks

The default is the system-defined library as defined in the environment variable SNC_LIB.



SSLServerCert

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:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate C:\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

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.



FirewallType

Data Type

string

Default Value

"NONE"

Remarks

This property specifies the protocol that the driver will use to tunnel traffic through the FirewallServer proxy. Note that by default, the driver connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type Default Port Description
TUNNEL 80 When this is set, the driver opens a connection to SAP ERP and traffic flows back and forth through the proxy.
SOCKS4 1080 When this is set, the driver sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5 1080 When this is set, the driver sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.



FirewallServer

Data Type

string

Default Value

""

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the driver uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.



FirewallPort

Data Type

int

Default Value

0

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.



FirewallUser

Data Type

string

Default Value

""

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.



FirewallPassword

Data Type

string

Default Value

""

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.



ProxyAutoDetect

Data Type

bool

Default Value

false

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

NOTE: When this property is set to True, the proxy used is determined as follows:

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.



ProxyServer

Data Type

string

Default Value

""

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The driver can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the driver uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.



ProxyPort

Data Type

int

Default Value

80

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.



ProxyAuthScheme

Data Type

string

Default Value

"BASIC"

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the driver will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.



ProxyUser

Data Type

string

Default Value

""

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain

domain\user



ProxyPassword

Data Type

string

Default Value

""

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the driver uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.



ProxySSLType

Data Type

string

Default Value

"AUTO"

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTODefault setting. If the URL is an HTTPS URL, the driver will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.



ProxyExceptions

Data Type

string

Default Value

""

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the driver uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.



Logfile

Data Type

string

Default Value

""

Remarks

Once this property is set, the driver will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.

Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.

If a relative filepath is supplied, the location of the log file will be resolved based on the path found in the Location connection property.

For more control over what is written to the log file, you can adjust the Verbosity property.

Log contents are categorized into several modules. You can show/hide individual modules using the LogModules property.

To edit the maximum size of a single logfile before a new one is created, see MaxLogFileSize.

If you would like to place a cap on the number of logfiles generated, use MaxLogFileCount.

Java Logging

Java logging is also supported. To enable Java logging, set Logfile to:

Logfile=JAVALOG://myloggername

As in the above sample, JAVALOG:// is a required prefix to use Java logging, and you will substitute your own Logger.

The supplied Logger's getLogger method is then called, using the supplied value to create the Logger instance. If a logging instance already exists, it will reference the existing instance.

When Java logging is enabled, the Verbosity will now correspond to specific logging levels.



Verbosity

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.



LogModules

Data Type

string

Default Value

""

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.



MaxLogFileSize

Data Type

string

Default Value

"100MB"

Remarks

When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.

Adjust the maximum number of logfiles generated with MaxLogFileCount.



MaxLogFileCount

Data Type

int

Default Value

-1

Remarks

When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.

The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.

Adjust the maximum size of the logfiles generated with MaxLogFileSize.



BrowsableSchemas

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

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

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

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

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.



AutoCache

Data Type

bool

Default Value

false

Remarks

When AutoCache = true, the driver automatically maintains a cache of your table's data in the database of your choice. By default, the driver incrementally updates the cache, retrieving only changes since the last SELECT query was run if the length of time since the last run has exceeded the CacheTolerance. After the cache is updated, the query is executed against the cached data.

Setting the Caching Database

When AutoCache = true, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:

See Also



CacheDriver

Data Type

string

Default Value

""

Remarks

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

The cache database is determined based on the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you want to use to cache data.

Note that you must also add the CacheDriver JAR file to the classpath.

The following examples show how to cache to several major databases. Refer to CacheConnection for more information on the JDBC URL syntax and typical connection properties.

Derby and Java DB

The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR file is shipped in the JDK. You can find the JAR file, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath:

jdbc:saperp:CacheLocation='c:/Temp/cachedir';Host=sap.mydomain.com;User=EXT90033;Password=xxx;Client=800;System Number=09;ConnectionType=Classic;
To customize the Derby JDBC URL, use CacheDriver and CacheConnection. For example, to cache to an in-memory database, use a JDBC URL like the following:
jdbc:saperp:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';Host=sap.mydomain.com;User=EXT90033;Password=xxx;Client=800;System Number=09;ConnectionType=Classic;
SQLite

The following is a JDBC URL for the SQLite JDBC driver:

jdbc:saperp:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';Host=sap.mydomain.com;User=EXT90033;Password=xxx;Client=800;System Number=09;ConnectionType=Classic;
MySQL

The following is a JDBC URL for the included CData JDBC Driver for MySQL:

  jdbc:saperp:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';Host=sap.mydomain.com;User=EXT90033;Password=xxx;Client=800;System Number=09;ConnectionType=Classic;

  
SQL Server

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:

jdbc:saperp:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';Host=sap.mydomain.com;User=EXT90033;Password=xxx;Client=800;System Number=09;ConnectionType=Classic;
Oracle

The following is a JDBC URL for the Oracle Thin Client:

jdbc:saperp:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';Host=sap.mydomain.com;User=EXT90033;Password=xxx;Client=800;System Number=09;ConnectionType=Classic;
NOTE: If using a version of Oracle older than 9i, the cache driver will instead be oracle.jdbc.driver.OracleDriver .
PostgreSQL

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:saperp:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';Host=sap.mydomain.com;User=EXT90033;Password=xxx;Client=800;System Number=09;ConnectionType=Classic;



CacheConnection

Data Type

string

Default Value

""

Remarks

The cache database is determined based on the CacheDriver and CacheConnection properties. Both properties are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheDriver.

The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. Consult the documentation for the specific JDBC driver for more information on the available properties. Make sure to include the JDBC driver in your application's classpath.

Derby and Java DB

The driver simplifies caching to Derby, only requiring you to set the CacheLocation property to make a basic connection.

Alternatively, you can configure the connection to Derby manually using CacheDriver and CacheConnection. The following is the Derby JDBC URL syntax:

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]
For example, to cache to an in-memory database, use the following:
jdbc:derby:memory

SQLite

To cache to SQLite, you can use the SQLite JDBC driver. The following is the syntax of the JDBC URL:

jdbc:sqlite:dataSource

MySQL

The installation includes the CData JDBC Driver for MySQL. The following is an example JDBC URL:

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
The following are typical connection properties:

SQL Server

The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax:

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]
For example:
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
The following are typical SQL Server connection properties:
Oracle

The following is the conventional JDBC URL syntax for the Oracle JDBC Thin driver:

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]
For example:
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
The following are typical connection properties:
PostgreSQL

The following is the JDBC URL syntax for the official PostgreSQL JDBC driver:

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]
For example, the following connection string connects to a database on the default host (localhost) and port (5432):
jdbc:postgresql:postgres
The following are typical connection properties:



CacheLocation

Data Type

string

Default Value

"%APPDATA%\\CData\\SAPERP Data Provider"

Remarks

The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR file to the classpath. The JAR file, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

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

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

See Also



CacheTolerance

Data Type

int

Default Value

600

Remarks

The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The driver checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.



Offline

Data Type

bool

Default Value

false

Remarks

When Offline = true, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.



CacheMetadata

Data Type

bool

Default Value

false

Remarks

As you execute queries with this property set, table metadata in the SAP ERP catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.

When to Use CacheMetadata

The driver automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.

When Not to Use CacheMetadata



BatchSize

Data Type

int

Default Value

0

Remarks

When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the size of the request that can be submitted.

Setting BatchSize to 0 will submit the entire batch as specified.



Charset

Data Type

string

Default Value

""

Remarks

SAP returns data in byte arrays, which the driver converts to a string. This property specifies the code page to use to do the conversion. For example, UTF-8. The driver defaults to the machine's code page.

The default can typically be used, but this property can be useful to fix Unicode-to-multibyte encoding problems. For instance, if you are on a U.S. machine and reading from a Japanese SAP server with Japanese characters, you may need to set Charset to shift_jis to get them to display properly.



ConnectionLifeTime

Data Type

int

Default Value

0

Remarks

The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. The default is 0 which indicates there is no limit to the connection lifetime.



ConnectOnOpen

Data Type

bool

Default Value

false

Remarks

When set to true, a connection will be made to SAP ERP when the connection is opened. This property enables the Test Connection feature available in various database tools.

This feature acts as a NOOP command as it is used to verify a connection can be made to SAP ERP and nothing from this initial connection is maintained.

Setting this property to false may provide performance improvements (depending upon the number of times a connection is opened).



Destination

Data Type

string

Default Value

""

Remarks

If the connection is not described completely by the remaining properties, this property is used as a key into an .ini file where the connection should then be described.

See the SAP RFC SDK for more information about using .ini files with the RFC library.



EndianType

Data Type

string

Default Value

"Auto"

Remarks

If you do not know the endian type for the SAP server, set this value to Auto. The driver attempts to automatically detect the endian type. However, if your SAP server does not have the RFC needed to determine this, you can set this property to avoid an error.



GatewayHost

Data Type

string

Default Value

""

Remarks

The gateway host you wish to connect to. If not specified, the driver will attempt to connect to the SAP system specified by Host.



GatewayService

Data Type

string

Default Value

""

Remarks

The gateway service you wish to connect to. This property determines the port the driver will use to connect to the GatewayHost server. If not specified, the SAP system will use the default "sapgw##" where the "##" is the SystemNumber.



GenerateSchemaFiles

Data Type

string

Default Value

"Never"

Remarks

Schema files may be used to give the highest degree of control over the CData JDBC Driver for SAP ERP.

For example, it can be inefficient to retrieve the metadata for the entire SAP system. Or, you may want to only display certain SAP entities. Basic filtering of these entities is possible with the TableMode, QueryMode, and StoredProcedureFilter properties. However, you may need more granular control.

Control Over Individual Schemas

Schema files override the schemas the driver generates when you connect. The CData JDBC Driver for SAP ERP reports views and stored procedures defined in the folder specified by Location. This enables you to work with individual schemas; for example, you can remove an individual schema by deleting its schema file. Or, you can customize how columns are reported.

How to Use GenerateSchemaFiles

Use GenerateSchemaFiles along with Location to specify how files should be generated and where they should be written. Setting GenerateSchemaFiles to OnUse will generate a schema file when a metadata request is made for the specific view. Setting GenerateSchemaFiles to OnStart will attempt to generate schema files for all the views reported on connection open.

Schema files will not be overwritten if they already exist in the Location folder. To pick up changes in the metadata, first delete the schema file.



InitialValueMode

Data Type

string

Default Value

"Null"

Remarks

Set to Null to treat them as if they were null. Set to InitialValue to return the values exactly as they come back from SAP.



Language

Data Type

string

Default Value

"EN"

Remarks

Set this property to the language you specify when you log into SAP. This property is a ISO 639-1 code for the language the SAP system uses. By default, EN will be used.



Location

Data Type

string

Default Value

""

Remarks

The path to a directory which contains the schema files for the driver (.rsd files for tables and views; .rsb files for stored procedures). The Location property allows the driver to interface with a variety of data sources.

The schema files used in your application must be deployed with other assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.



MaxRows

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.



Other

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.

Caching Configuration

CachePartial=TrueCaches only a subset of columns, which you can specify in your query.
QueryPassthrough=TruePasses the specified query to the cache database instead of using the SQL parser of the driver.

Integration and Formatting

DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMTDetermines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.



Pagesize

Data Type

string

Default Value

""

Remarks

The number of results to return per page from SAP. Only used for SAP tables. The RFC_READ_TABLE uses the rowcount and rowskips parameters for paging. This can cause unusual behavior if you are paging through data while it is being interacted with. For instance, if a new row is inserted to a table while you are paging through data, you may see a duplicate entry show up. Also, if a row is deleted from a table, the results you get back may be missing a row. This can be avoided by increasing the pagesize to a degree that there is only one page of data returned. However, please note that this can significantly decrease performance for large tables.



PoolIdleTimeout

Data Type

int

Default Value

60

Remarks

The allowed idle time a connection can remain in the pool until the connection is closed. The default is 60 seconds.



PoolMaxSize

Data Type

int

Default Value

100

Remarks

The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.



PoolMinSize

Data Type

int

Default Value

1

Remarks

The minimum number of connections in the pool. The default is 1.



PoolWaitTime

Data Type

int

Default Value

60

Remarks

The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.



PseudoColumns

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



QueryMode

Data Type

string

Default Value

"None"

Remarks

Just like tables can be displayed as views, so can SAP queries. Depending on your use case, you may not be planning to use this feature. In that case, set the QueryMode to None so that SAP queries do not display as available views. Otherwise, use the settings Global, Local, or All to specify what workspace to draw SAP queries from.



ReadTableFunction

Data Type

string

Default Value

"RFC_READ_TABLE"

Remarks

The function to use for reading table data. Change this to a custom function to remove limitations on the buffer size.



RTK

Data Type

string

Default Value

""

Remarks

The RTK property may be used to license a build. See the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.



StoredProcedureFilter

Data Type

string

Default Value

"BAPI*"

Remarks

You can execute any function module in SAP through the driver as a stored procedure if the stored procedure is remote enabled. There are many function modules that may be useful to execute in SAP, but to try and keep things readable you may choose to only display certain function modules. By default, the driver lists only BAPI function modules. Set StoredProcedureFilter to * to list all functon modules.

Note that not all function modules in SAP are remote enabled. If there is a function module you are interested in using that does not display, check the TFDIR system table to verify its FMODE is set to 'R'.



SupportEnhancedSQL

Data Type

bool

Default Value

true

Remarks

When SupportEnhancedSQL = true, the driver offloads as much of the SELECT statement processing as possible to SAP ERP and then processes the rest of the query in memory. In this way, the driver can execute unsupported predicates, joins, and aggregation.

When SupportEnhancedSQL = false, the driver limits SQL execution to what is supported by the SAP ERP API.

Execution of Predicates

The driver determines which of the clauses are supported by the data source and then pushes them to the source to get the smallest superset of rows that would satisfy the query. It then filters the rest of the rows locally. The filter operation is streamed, which enables the driver to filter effectively for even very large datasets.

Execution of Joins

The driver uses various techniques to join in memory. The driver trades off memory utilization against the requirement of reading the same table more than once.

Execution of Aggregates

The driver retrieves all rows necessary to process the aggregation in memory.



TableMode

Data Type

string

Default Value

"TransparentApplication"

Remarks

There are many tables in SAP that could potentially be displayed. The TableMode property enables you to specify which tables are important to you. The list of tables is retrieved from the DD02L system table, with each mode acting as a different filter on a set of transparent tables. Transparent tables contain your business and application data.

SettingFilterDescription
TransparentApplication TABCLASS = 'TRANSP' AND CONTFLAG = 'A'Master and transaction data.
TransparentCustomer TABCLASS = 'TRANSP' AND ( CONTFLAG = 'C' OR CONTFLAG = 'G' )Data maintained by the customer only
TransparentSystem TABCLASS = 'TRANSP' AND ( CONTFLAG = 'E' OR CONTFLAG = 'S' OR CONTFLAG = 'W' )Customer namespaces, program status changes, development environment tables, etc.
Pooled TABCLASS = 'POOL'All pooled tables.
Cluster TABCLASS = 'CLUSTER'All cluster tables such as BSEG and KONV.
All All tables regardless of type. Warning: This will cause a massive amount of tables to be retrieved and may result in a noticable delay in table listing.
None No filter. No SAP tables are displayed. This may be useful if you intend to use schema files instead or SAP queries.

Alternatively you can specify your own filter if the tables you want to work with are not available in these examples.



Timeout

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 driver throws an exception.



UseConnectionPooling

Data Type

bool

Default Value

false

Remarks

This property enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.



UseLabels

Data Type

bool

Default Value

false

Remarks

If set to true, tables and columns will show up with a language specific name instead of the internal table names used in SAP. The language used will be taken from the Language connection property. If no entries exist for the specific column or table, the internal names will be used instead.



UseSimpleNames

Data Type

bool

Default Value

false

Remarks

SAP ERP tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the driver 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.



UseUnicodeRFC

Data Type

bool

Default Value

true

Remarks

A boolean indicating if you want to use RFC_GET_UNICODE_STRUCTURE to get structure information from your SAP system. Required for SAP systems in Unicode, but should be set to false for SAP systems that do not support RFC_GET_UNICODE_STRUCTURE.





ViewsBack To Top

  1. SearchFunctions

SearchFunctions

A list of SAP functions available in your system.

Columns

Name Type Description
Name String The name of the function.
Group String The group name for the function.
Filter String The filter you are using to search for functions with.

The default value is RFC*.