The CData Sync App provides a straightforward way to continuously pipeline your SAP ERP data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The SAP ERP connector can be used from the CData Sync application to pull data from SAP ERP and move it to any of the supported destinations.
The Sync App enables relational access to tables, queries, and function modules in your SAP R/3, NetWeaver, or ERP/ECC 6.0+ system. See Supported Editions and Content for further details about what editions of SAP and content is supported.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
The CData Sync App uses the SAP RFC interface to connect to an SAP system. The ConnectionType specifies the RFC API you want to use to connect.
You must obtain the SAP libraries corresponding to your RFC API to connect.
The RFCs used by the CData Sync App are listed as follows. If any listed below are not available, some or all functionality may not work. T-Code SE37 may be used to view available function modules in SAP.
Set the following to connect:
To connect to a machine different from the Host machine, substitute Host with the following:
To connect to a distributed system or systems with other configurations, see Fine-Tuning Data Access.
In addition to User and Password, the CData Sync App also supports certificate authentication. To use certificate authentication, set the X509Certificate connection property to either point to a file that contains an X509 certificate in PEM format, or the PEM blob directly used for authentication during SAP Logon. In addition to setting X509Certificate, you will need to specify the appropriate SNC connection properties. The SNC connection properties are described under Fine-Tuning Data Access.
To use the Classic RFC SDK without Unicode support provided with the library librfc32.dll, set ConnectionType to Classic. Place the assembly in a location where it is accessible at run time, such as system32 or the bin folder in your installation directory or your path.
To use the Classic RFC SDK with Unicode support, set ConnectionType to Classic_Unicode.
Place the following assemblies in a location where they are accessible at run time, such as system32 or the bin folder in your installation directory.
Note: Earlier SAP configurations may have used version 34 of the ICU libraries. However, version 50 is required for compatibility with supported SAP RFC SDK versions.
To use the NetWeaver RFC SDK, set ConnectionType to NetWeaver.
Place the following assemblies in a location where they are accessible at run time, such as system32 or the bin folder in your installation directory.
For SDK version 7.50, ensure the following DLLs are available:
To connect using the SOAP interface, set the following:
The SOAP service must be enabled in your SAP system for this type of connection to work properly.
To access the RFC SDK used to communicate with SAP, you can use the SAP JCo (Java Connector). You need to include the sapjco3.jar in your build path and ensure that the native library location for the JAR is set to the folder containing the sapjco3 library.
You must also ensure that the bitness (32-bit or 64-bit) of the libraries matches the bitness of the Java Virtual Machine (JVM) on which your application is running. A mismatch between these can lead to errors where the JVM cannot load the native library, resulting in a failure to establish a connection to the SAP system. Before downloading, check your system's architecture and download the corresponding version of the library.
Follow these steps to download the relevant jar file:
The CData Sync App can communicate with SAP R/3 systems using the following methods:
SAP: The term SAP is an umbrella term for all supported SAP editions. This in general indicates SAP ECC version 6+ and SAP S/4 Hana on-premise, but includes other editions that also support the RFC SDK. For the CData Sync App to work, it requires a connection to an edition of SAP that supports the RFC SDK.
Function Module: A function module is a type of program or function in SAP that can be used to execute almost any operation. These modules can be tested and written in SAP via the SE37 TCode.
RFC: A Remote Function Call (RFC) is a type of function module that has been modeled as an API call that can be executed by external applications. This includes using libraries distributed by SAP that are installed on the SAP server, and may also be downloaded from sap.com. Specific RFCs may or may not be maintained across SAP upgrades. There are standard RFCs supplied by SAP, and thus may have differences or may not exist in older editions. Custom RFCs can (and frequently are) built to support integrations, and must be maintained by the SAP customer. By convention, custom RFCs begin with the letter Z.
BAPI: A Business API (BAPI) is a type of RFC distributed and maintained by SAP to give access to business logic operations. BAPIs have methods that are specific to a type of business object. For example, there are about 60 BAPIs related solely to the Customer object. In practice, only a few are typically used.
SAP Table: An SAP table is a table that stores data in SAP. These are not the same as business objects. For instance, there is no Purchase Order table in SAP. Instead, there are many tables that include purchase order data in them, such as EBAN, EBKN, EINA, EKPO, etc. Custom tables by convention begin with the letter Z.
SAP Queries: An SAP Query is a saved object in SAP that details information to retrieve from one or more tables. These are typically used for reporting purposes.
Our support for RFC connections means any edition of SAP that supports an RFC connection and the specific RFCs we require for the connection will work. Specifically, we support connections to:
Other editions that support RFC connections may also be supported.
The following SAP content is accessible from the CData Sync App:
SAP Tables: SAP Tables are exposed as views automatically via the TableMode connection property. If you know exactly which SAP Tables you want to work with, you can specify them via the Views connection property, which overrides TableMode. Because they contain pieces of the business objects, SAP discourages directly modifying the tables themselves. Instead, it recommends using BAPIs to modify any tablular data. For this reason, our tools do not support direct modification of SAP Tables.
BAPIs and RFCs: BAPIs and RFCs are exposed directly as stored procedures. By default, all RFCs starting with the keyword BAPI are displayed as an available stored procedure. This behavior can be modified by changing the StoredProcedureFilter connection property.
SAP Queries: SAP Queries are also exposed as views, but they are turned off by default. They are less commonly required than SAP Tables and BAPIs. If you want to expose SAP Queries, change the QueryMode connection property.
Raw IDoc and IDoc XML: Intermediate Document (IDoc) files are SAP objects that carry business transaction data from one system to another in the form of an electronic message. IDocs transfer data from SAP to non-SAP systems via Electronic Data Interchange (EDI) systems. When the transfer is between two SAP systems, IDocs employ ALE technology.
For further information, see Data Model.
The number of entities in an SAP system can make it difficult to work with when all the entities are surfaced at the same time. The following sections provide an overview of how to choose the SAP entities you want to work with.
See Data Model for more information on working with SAP entities.
The following connection properties provide basic functionality to select the entities you need:
The Sync App uses the SAP RFC_READ_TABLE function to get data from SAP tables. However, it has certain limitations.
As an example, consider the DATA_BUFFER_EXCEEDED exception. The SAP RFC_READ_TABLE has a fixed size of 512 bytes. It can buffer for each row of data, and thus you cannot select more columns than the amount that would fit in this buffer. If you select more than 512 bytes, an exception will occur indicating that you have exceeded the maximum buffer size allowed per row and need to select fewer columns.
The Sync App also supports the RFC_READ_TABLE2 table read function. You can switch the active table read function to RFC_READ_TABLE2 by setting ReadTableFunction to "/SAPDS/RFC_READ_TABLE2".
The Sync App includes the code for Z_CUSTOM_READ_TABLE, a custom read-table RFC that is similar to the SAP RFC_READ_TABLE, but with a larger buffer to address the DATA_BUFFER_EXCEEDED problem as well as bypass other RFC_READ_TABLE limitations.
Follow the steps below to use the included custom read-table RFC to bypass limitations with the default RFC_READ_TABLE.
Along with Z_CUSTOM_READ_TABLE.txt, there is also a Z_CUSTOM_READ_TABLE_752.txt file, designed for ABAP version 7.52 and above.
It is mostly the same as Z_CUSTOM_READ_TABLE, but it takes advantage of newly available keywords in ABAP 7.52 to perform paging within the database instead of in the ABAP script itself. This makes paging far more efficient and causes a very noticeable performance boost when working with large tables.
It is recommended to use the Z_CUSTOM_READ_TABLE_752 RFC if at all possible. Note: please follow the link https://www.cdata.com/kb/entries/sap-custom-read-table-function.rst to get the Z_CUSTOM_READ_TABLE_752.txt and Z_CUSTOM_READ_TABLE_752.txt files.
If you are connecting to a distributed SAP system, such as a system using load balancing, you must set the following additional properties. An administrator can obtain these connection properties on the Connection tab of the System Entry Properties dialog.
SystemId: Set this property to the value in the System Id box.
The SystemId property is the System Id or R3Name of the SAP system. The system Id is a string with a maximum of three characters.
MessageServer: Set this property to the value in the Message Server box. If a value is specified in the SAProuter box, prepend the value in the SAProuter box onto the value for the MessageServer connection string property.
The MessageServer property must be specified when connecting to an SAP system using load balancing.
Group: If a value is specified, set this property to the value in the Group/Server box.
The Group property specifies the logon group being used. The default in most SAP systems will be PUBLIC.
If you are connecting to an SAP system with a dedicated application server or a custom application server, you can obtain the following connection properties on the Connection tab of the System Entry Properties dialog.
SystemId: Set this property to the value in the System Id box.
The SystemId property is the System Id or R3Name of the SAP system. The system Id is a string with a maximum of three characters.
Host: Set this property to the value in the Application Server box.
The Host property specifies the host name of the target system. This value can be a regular host name, IP address, or SAProuter address.
SystemNumber: Set this property to the value in the SystemNumber box.
The SystemNumber property defines the target system.
If the administrator has configured Secure Network Communication (SNC), you need to set the following additional properties. You can obtain the following SNC connection string properties on the Network tab of the System Entry Properties dialog.
SNCMode: If the "Activate Secure Network Connections" checkbox is enabled, set the SNCMode connection string property to True. If this checkbox is disabled, set the SNCMode connection property to False.
The SNCMode connection property is a boolean value determining if you are using SNC. The default value is False.
SNCPartnerName: Set this property to the value in the SNC Name box.
The SNCPartnerName property specifies the application server's SNC name. For example: p:CN=IDS, OU=IT, O=CSW, C=DE
SNCName: Optional. Set this property to the value in the SNC Name box.
The SNCName property specifies the name of the SNC connection. Set this property to make sure that the correct SNC name is used for the connection.
SNCQop: Set this property to the selected option in the Secure Network Settings section. For example, if the Integrity option is selected, set the SNCQop property to 3.
The SNCQop property specifies the level (or quality) of data protection. If this property is not specified, the integer -1 is set for this property. Valid values are 1, 2, 3, 8, or 9, which correspond to the following protection levels:
| 1 | Apply authentication only. The identities of communication partners are verified. |
| 2 | Apply integrity protection. The SAP system detects any changes or manipulation of the data exchanged. |
| 3 | Apply privacy protection. This level provides integrity and authentication. The SAP system encrypts the messages being transferred. No one but the two communication partners can read or tamper with the data. This is the maximum level of protection. |
| 8 | Apply the default protection. |
| 9 | Apply the maximum protection. |
SNCLibPath: Set this property to the path and filename of your SNC library.
The SNCLibPath property specifies the full path to the security library you are using. For example, C:\Secude\secude.xll.
This section details a selection of advanced features of the SAP ERP Sync App.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Sync App dynamically retrieves schemas for SAP tables, queries, and function modules at run time. However, since it can be inefficient to retrieve the metadata for the entire SAP system, the Sync App also applies default filters to represent only a slice of your SAP system.
Below is an explanation of how the Sync App models each type of SAP object. How the Sync App determines what to display is highly customizable; see Accessing SAP Entities for more information on selecting the SAP objects you want.
SAP tables are listed as views. This is because SAP strongly discourages directly making changes to SAP tables. Instead, function modules such as BAPIs should be used for making changes to table data. See Function Modules below for more on that.
Table data is retrieved from SAP using either the RFC_READ_TABLE or Z_CUSTOM_READ_TABLE function module if you have it installed. These give access to basic SQL support, but more complex queries such as joins and group by must be handled locally. More complex queries are handled automatically by the Sync App.
See Using a Custom Read Table Function for more information on circumventing limitations with RFC_READ_TABLE.
Just like tables, you can also work with SAP queries as relational views. By default they are turned off to try and avoid cluttering the Sync App with too many options. They can be turned on by using the QueryMode connection property.
Unlike tables, SAP queries might require certain values to be specified as inputs. You can specify these query inputs as part of the predicate in the SQL. For instance:
SELECT * FROM Z_SAP_QUERY WHERE InputName='x' All SAP query views include a Variant column that you can also input as part of the projection.
Be aware that values that are only inputs in an SAP query are reflected back in the results as the same value that was specified. This does not actually indicate that SAP returned the value that way. It is just something that is required to keep the SQL statement valid.
Function modules in SAP can be used for almost any task. These include the very RFC calls that the Sync App makes such as RFC_READ_TABLE and function modules that modify data such as BAPI_PO_CREATE.
You can execute a function module directly as a stored procedure. SAP function modules accept and return primitive values and complex structures; the corresponding stored procedures accept and return SQL types and tables. For instance:
EXEC STFC_CONNECTION
For a more complex example, try RFC_READ_TABLE:
EXEC RFC_READ_TABLE @QUERY_TABLE='MARA', @FIELDS='FIELDS#TEMP', @ROWCOUNT=1
In the above example, the RFC_READ_TABLE function module is executed to return the MARA table. The QUERY_TABLE and ROWCOUNT parameters are passed in as primitive values. In this function module, FIELDS is an input table. To provide this input, you can populate a temporary table with the #TEMP syntax and INSERT statements. For example:
INSERT INTO FIELDS#TEMP (FIELDNAME) VALUES ('MANDT');
INSERT INTO FIELDS#TEMP (FIELDNAME) VALUES ('MATNR');
INSERT INTO FIELDS#TEMP (FIELDNAME) VALUES ('ERSDA');
INSERT INTO FIELDS#TEMP (FIELDNAME) VALUES ('ERNAM');
Alternatively, JSON or XML can be used to submit tabular data for environments where the #TEMP tables would be difficult to use. For example:
EXEC RFC_READ_TABLE OPTIONS='{ \"TEXT\": \"TABNAME LIKE ''MARA%''\" }', QUERY_TABLE='DD02L', ROWCOUNT='1', ReturnTables='DATA'
Instead of using the dynamic, in-memory schemas, you can use GenerateSchemaFiles to save static schema files that are easy to customize. A common use case is to remove extra unwanted inputs and outputs that the Sync App may report for a stored procedure.
In SAP, there is nothing in the metadata that distinguishes tables in function modules as either inputs or outputs. Since there is no way to know which tables are actually used for inputs and which are used for outputs, the Sync App reports the tables as being available for both inputs and outputs.
To generate the schema file, set GenerateSchemaFiles to "OnUse" and call the stored procedure. Also, set the Location property to the folder where you want the schema to be output.
To modify the schema file, open the generated schema file in the Location folder with any text editor. Then find the <input> or <output> tags that are not needed and remove them. Refresh the connection in the Sync App to pick up the schema and your changes.
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| SearchFunctions | View listing all SAP remote-enabled function modules available in the connected SAP system, useful for discovery and integration. |
View listing all SAP remote-enabled function modules available in the connected SAP system, useful for discovery and integration.
| Name | Type | Description |
| Name | String | Name of the SAP remote-enabled function module returned by the search. |
| Group | String | Function group that the SAP function belongs to, typically representing a logical module or area. |
| Filter | String | Search term or pattern used to filter and locate SAP function modules by name or group.
The default value is RFC*. |
Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT operations with SAP ERP.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from SAP ERP, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| ClearCache | Clears the JCoRepository cache to refresh metadata definitions for SAP functions and tables, ensuring the latest versions are used. |
| CreateFunctionSchema | Generates an .rsd schema file based on the metadata of a specified SAP function module, enabling integration tools to map its structure. |
| CreateQuerySchema | Builds a schema file for a specified SAP query, allowing external tools to understand the input and output fields for data extraction. |
| CreateTableSchema | Generates a schema file for a specific SAP table using RFC_READ_TABLE, enabling data retrieval from the SAP backend through remote function calls. |
| ListQueries | Retrieves metadata about available SAP queries and their fields, helping users select the correct query structure for data extraction. |
| PushIDoc | Sends IDoc or IDoc XML data to an SAP system using synchronous or asynchronous modes. Useful for B2B messaging, system integration, or transactional updates. |
Clears the JCoRepository cache to refresh metadata definitions for SAP functions and tables, ensuring the latest versions are used.
To execute this procedure, enter:
EXEC ClearCache
Generates an .rsd schema file based on the metadata of a specified SAP function module, enabling integration tools to map its structure.
| Name | Type | Description |
| Function | String | Name of the SAP function module for which the schema will be generated. |
| FunctionDescription | String | Optional user-provided description of the SAP function module being processed. |
| ReturnTables | String | Comma-separated list of SAP function tables to include in the schema. Use an asterisk (*) to return all available tables.
The default value is *. |
| SchemaType | String | Specifies the schema format to generate, such as a flat schema or one using nested structures.
The allowed values are StoredProcedure, View. The default value is StoredProcedure. |
| Name | Type | Description |
| Result | String | Indicates whether the schema generation process completed successfully. |
| SchemaFile | String | Path or name of the generated schema file representing the structure of the SAP function. |
| Columns | String | Total number of columns detected and included in the generated schema. |
Builds a schema file for a specified SAP query, allowing external tools to understand the input and output fields for data extraction.
| Name | Type | Description |
| Query | String | The query for which to generate a schema. This must match the query defined in SAP Query (SQ01). |
| UserGroup | String | The SAP user group that owns or has access to the specified query. |
| Variant | String | The default variant to apply when executing the query. This can predefine field selections and filters. |
| QueryDescription | String | Optional description of the SAP query, used for documentation or display purposes. |
| Workspace | String | Optional workspace name for organizing or categorizing the generated schema.
The allowed values are Global, Local. The default value is Global. |
| TableName | String | Name to assign to the resulting table or schema file. If not specified, the query name is used by default. |
| Name | Type | Description |
| Result | String | Indicates whether the schema generation succeeded or failed. |
| SchemaFile | String | Path or filename of the generated schema file that represents the structure of the query results. |
| Columns | String | Total number of columns identified in the query and included in the generated schema. |
Creates a schema file for a specified SAP table or view, facilitating structured access to SAP data from external applications.
EXEC CreateSchema TableName = 'MARA', FileName = 'C:\schemas\MARA.rsd'
The TableName input specifies the SAP table or view, and the FileName input defines the path for the generated schema file.
| Name | Type | Description |
| TableName | String | Name of the SAP table or view to generate a schema for. This is used to retrieve metadata from the SAP system. |
| FileName | String | Full path and filename for the generated schema file. For example: 'C:\\Users\\User\\Desktop\\SmartSheet\\sheet.rsd'. |
| Name | Type | Description |
| Result | String | Indicates whether the schema creation process was successful or failed. |
Generates a schema file for a specific SAP table using RFC_READ_TABLE, enabling data retrieval from the SAP backend through remote function calls.
| Name | Type | Description |
| Table | String | Name of the SAP table to generate a schema for. This is typically used with RFC_READ_TABLE to retrieve metadata and data. |
| TableDescription | String | Optional user-defined description of the SAP table for documentation purposes. |
| Name | Type | Description |
| Result | String | Indicates whether the schema generation was successful or encountered an error. |
| SchemaFile | String | Name or path of the generated schema file that represents the structure of the SAP table. |
| Columns | String | Number of columns identified in the specified SAP table and included in the schema. |
Retrieves metadata about available SAP queries and their fields, helping users select the correct query structure for data extraction.
EXEC ListQueries UserGroup = 'ZGROUP', Query = 'ZQUERY', Workspace = 'Global'
The UserGroup input specifies the SAP user group, and the Query input filters results to a specific query name.
| Name | Type | Description |
| UserGroup | String | SAP user group for which to list available queries. User groups control access to queries in SAP Query (SQ01). |
| Query | String | Optional filter to return a specific query by name within the specified user group. |
| Workspace | String | Optional name of the workspace used to organize the query metadata results.
The allowed values are Global, Local. The default value is Global. |
| Name | Type | Description |
| QueryName | String | Name of the SAP query returned in the result set. |
| UserGroup | String | SAP user group associated with the returned query. |
| Variant | String | Default variant configured for the query, used to prefill selection criteria and layout options. |
Sends IDoc or IDoc XML data to an SAP system using synchronous or asynchronous modes. Useful for B2B messaging, system integration, or transactional updates.
| Name | Type | Description |
| IDocFile | String | Full file path to the IDoc or IDoc XML file to be sent to the SAP system. |
| FileType | String | Format of the file being uploaded, such as 'IDoc' for standard format or 'XML' for structured XML content.
The allowed values are XML, IDoc. The default value is IDoc. |
| Mode | String | Specifies how the IDoc should be sent. Options include synchronous (immediate response) or asynchronous (background processing).
The allowed values are Sync, ASync. The default value is ASync. |
| Name | Type | Description |
| Result | String | Indicates whether the IDoc was successfully transmitted to SAP. Returns 'Success' or 'Failure'. |
| Message | String | Descriptive message returned by SAP or the interface, especially useful for identifying errors if the transmission fails. |
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.
| 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 |
| 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. |
| 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 |
| 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. |
| 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. |
| CustomTableFilter | Specifies which SAP ERP tables are displayed as views when the TableMode is set to 'Custom'. |
| 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 advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| 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. |
| 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. |
| ServerTimeZone | The timezone by which the server is expected to report date and times values. |
| 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 | Specifies which SAP ERP tables are displayed as views. |
| 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. |
| UseAdvancedReplication | Indicates if advanced replication features should be used when caching data. |
| 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. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| 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. |
The method used to connect to SAP ERP data.
The Sync App connects to your SAP ERP data using the specified method.
Available methods include:
Specifies whether to connect to an SAP system with a message server (GroupServer) or without one (ApplicationServer).
Set this connection property to one of the following values:
| ApplicationServer (default) | Connect to the SAP system directly without using a message server. |
| GroupServer | Connect to the SAP system using a message server. Choose this option if you are using a load-balancing server. |
Host name of the target SAP system.
This connection property is required when the ConnectionScheme connection property is set to ApplicationServer and ConnectionType is set to a value other than SOAP.
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/ ..."
You can find this value in SAP Logon by right-clicking a connection, selecting Properties, and inspecting the Connection tab's Application Server field.
The instance number associated with the server specified in the Host connection property.
This connection property is always required, except when the ConnectionType connection property is set to SOAP.
The valid range of values for this connection propery is 0 to 99. Typically, this value is 0.
You can find this value in SAP Logon by right-clicking a connection, selecting Properties, and inspecting the Instance Number field in the Connection tab.
The name of the SAP client, among those in the targeted SAP installation, that you want to connect to.
In order to connect with your SAP ERP data via the Sync App, you must specify a client name.
You can find the available client values in the MANDT column of the T000 SAP table.
You can access this table either using t-code SE16 in the SAP UI or in the table list of the Sync App (this table is accessible when TableMode is set to TransparentCustomer).
The X509 certificate used for login as an alternative to logging in with User and Password.
This connection property is only supported when you are connecting using SNC (in which case the SNCMode connection property should be set to True).
Set this connection property to a path pointing to a file containing:
The host name or IP address of the message server (central load balancing server) you want to use to connect to SAP data.
This connection property must be set when connecting to an SAP system that uses load balancing (in which case the ConnectionScheme connection property should be set to GroupServer).
When this connection property is set, the message server specified in the value of this connection property is used to connect instead of an individual application server.
The Logon Group on your message server to which the current user belongs.
This connection property is mainly used for connection to an SAP system that uses load balancing. In such situations, you must also set ConnectionScheme to GroupServer.
The default group name in most SAP systems is "PUBLIC".
The System Id or R3Name of the message server specified in the MessageServer connection property.
This connection property is required when connecting to a message server.
You can find this value in SAP Logon by right-clicking a connection, selecting Properties, and inspecting the System ID field in the Connection tab.
The URL of the SOAP interface you want to use to connect to SAP.
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.
The process for enabling the SOAP service varies across different SAP versions. If you want to enable the SOAP service in your SAP installation, please contact your SAP administrator for assistance.
The name of the service where the message server specified in the MessageServer connection property can be reached.
This connection property is required when the ConnectionScheme connection property is set to GroupServer.
To find the value for this connection property, open the SAP GUI and navigate as follows:
If not specified, the Sync App connects with HTTP.
On Windows machines, the mappings between these services and their ports are stored on C:\windows\system32\drivers\etc\services.
On Unix machines, these mappings are stored in the /etc/services file or on the domain name server.
This section provides a complete list of the Security properties you can configure in the connection string for this provider.
| 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). |
Specifies whether to use Secure Network Communications (SNC).
SAP Secure Network Communications (SNC) provides an interface for augmenting SAP with additional non-native security features.
If you have SNC features enabled in your SAP instance, set this connection property to True.
If your SAP instance has SNC features enabled, you must describe the details of your SNC configuration to the Sync App to connect.
See the SNCSSO, SNCName, SNCLibPath, SNCPartnerName, SNCQop connection properties for more information.
You can only enable SNC security features when the ConnectionType connection property is set to CLASSIC, CLASSIC_UNICODE, or NETWEAVER.
An optional input with the name of your SNC connection.
Although this parameter is optional, it is recommended that you set it in order to ensure that the correct SNC name is used for the connection.
To find the value you need to specify, open SAP Logon, right-click your connection and select Properties. In the System Entry Properties dialog, click the Network tab and look at the value in Secure Network Settings -> SNC Name.
The quality of protection for your SNC connection.
You can set an integer up to 9 depending on your application server.
Valid values are 1, 2, 3, 8, or 9, which correspond to the following protection levels:
| 1 | Apply authentication only. |
| 2 | Apply integrity protection (authentication). |
| 3 | Apply privacy protection (integrity and authentication). |
| 8 | Apply the default protection. |
| 9 | Apply the maximum protection. |
The SNC name of the SAP instance you want to connect to.
Setting this connection property is required when using SNC (when the SNCMode connection property is set to True).
The value for this connection property can be found as follows:
An optional input detailing the path and file name of the SAP cryptographic library.
Set this connection property to the file path of the version of the SAP cryptographic library specific to your operating system.
On Windows systems, this assembly is called "sapcrypto.dll".
On Linux systems, this assembly is called "libsapcrypto.dll".
These libraries are available for download from SAP.
By default, the Sync App uses the library defined in the environment variable SNC_LIB.
Specifies whether to connect via the SAP SSO (using the Secure Login Library).
The default value is 1. Valid values are 0,1.
The SNCMode connection property must be set to True to use this feature.
Available values are:
| 0 | Use User/password or other non-SSO identity-related connection properties to authenticate. |
| 1 | Authenticate via SNC SSO (using the Secure Login Library). |
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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 |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| 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. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to SAP ERP. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to SAP ERP. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to SAP ERP. If the SOCKS 5 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.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| 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. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
Supported authentication types :
For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The username of a user registered with the proxy server. |
| DIGEST | The username of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.
Specifies the password of the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.
Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
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.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note: The Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| 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. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.
Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.
When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;
By default, logged operations from all modules are included.
You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP
To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res
Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.
The available modules and submodules are:
| Module Name | Module Description | Submodules |
| INFO | General Information. Includes the connection string, product version (build number), and initial connection messages. |
|
| EXEC | Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well. |
|
| HTTP | HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages. |
|
| WSDL | Messages pertaining to the generation of WSDL/XSD files. | — |
| SSL | SSL certificate messages. |
|
| AUTH | Authentication related failure/success messages. |
|
| SQL | Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages. |
|
| META | Metadata cache and schema messages. |
|
| FUNC | Information related to executing SQL functions. |
|
| TCP | Incoming and outgoing raw bytes on TCP transport layer messages. |
|
| FTP | Messages pertaining to the File Transfer Protocol. |
|
| SFTP | Messages pertaining to the Secure File Transfer Protocol. |
|
| POP | Messages pertaining to data transferred via the Post Office Protocol. |
|
| SMTP | Messages pertaining to data transferred via the Simple Mail Transfer Protocol. |
|
| CORE | Messages relating to various internal product operations not covered by other modules. | — |
| DEMN | Messages related to SQL remoting. | — |
| CLJB | Messages about bulk data uploads (cloud job). |
|
| SRCE | Miscellaneous messages produced by the product that don't belong in any other module. | — |
| TRANCE | Advanced messages concerning low-level product operations. | — |
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| 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 . |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| 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. |
| 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. |
| CustomTableFilter | Specifies which SAP ERP tables are displayed as views when the TableMode is set to 'Custom'. |
| 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 advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| 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. |
| 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. |
| ServerTimeZone | The timezone by which the server is expected to report date and times values. |
| 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 | Specifies which SAP ERP tables are displayed as views. |
| 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. |
| UseAdvancedReplication | Indicates if advanced replication features should be used when caching data. |
| 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. |
The edition of SAP you want to use.
Set this connection property to OnPremise to connect to an on-premises SAP instance.
Set this connection property to Cloud to connect to SAP S/4 HANA Cloud.
To connect to SAP S/4 HANA Cloud, you need the SAP JCO 3.1.2 or later.
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.
When a function module (the Sync App makes function modules available as stored procedures) selects from multiple structures that share one or more column names, each identically-named column is given a prefix consisting of the name its containing table, followed by the character(s) specified in this connection property.
For example, if this connection property is set to "_", and you execute a stored procedure corresponding to a function module which selects from the structures "X" and "Y", and those structures both contain a column called "FIELD", two columns appear in the query results: "X_FIELD" and "Y_FIELD".
The system code page to use when converting SAP Unicode byte arrays to strings.
SAP returns data in byte arrays, which the Sync App converts to a string.
This property specifies the code page the Sync App uses to do the conversion. For example, 'UTF-8'.
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 display the characters properly.
Specifies whether to read decimal values using the decimal notation specified in the user profile of the connected SAP user.
When this connection property is set to False (the default), decimal values are read in US format.
When this connection property is set to True, the Sync App detects the decimal format from the connected SAP user profile's decimal format setting. Set this connection property to True when the Sync App returns improperly formatted decimal values in query results.
Specifies which SAP ERP tables are displayed as views when the TableMode is set to 'Custom'.
The Sync App lists SAP ERP tables as read-only views. If you need to write to SAP ERP tables, you can use BAPIs.
Most SAP ERP installations contain a very large number of tables. While the Sync App can list all tables as available views, this may result in long load times. This property allows you to define a custom filter against the DD02L system table to retrieve only the tables important to your use case.
To use this property, set the TableMode to Custom and define a valid SQL WHERE clause here (without the "WHERE" keyword).
For example, to retrieve transparent tables used for application data:
CustomTableFilter = TABCLASS = 'TRANSP' AND CONTFLAG = 'A' AND AS4LOCAL = 'A'
By default, the Sync App applies internal filters to exclude certain tables, such as those with names containing forward slashes. For example, Customer/Orders.
To override this behavior and explicitly include such tables, you can set a custom filter that matches your use case. For example, to retrieve only tables with slashes in their names:
CustomTableFilter = TABNAME LIKE '/%'
Note: Use custom filters with caution. Tables containing slashes are often system or namespace-reserved and may not be appropriate for general access.
The endian type of your SAP server.
The endian type of your SAP server determines whether it orders bytes from the most significant to least significant bytes (big-endian) or from the least significant to most significant byte (little-endian).
The Sync App needs to know the endian type of your SAP server in order to retrieve SAP data.
If you do not know the endian type for the SAP server, set this value to Auto. The Sync App attempts to automatically detect the endian type.
However, if the Sync App returns an error indicated that your SAP server does not have the RFC needed to automatically determine its endian type, use this connection property to set the Endian type manually. If you need to set this manually and you do not know the value that you should set, ask your SAP administrator for assistance.
The gateway host you want to connect to.
Set this connection property if you want to connect to your SAP installation via a specific SAP Gateway server.
If not specified, the Sync App attempts to connect to the SAP system specified by the Host connection property.
The port used to connect to the SAP Gateway server specified in the GatewayHost connection property.
If no value is specified in this connection property, the Sync App uses the value "sapgw##", where the "##" is the value specified in the SystemNumber connection property, to connect.
Determines how and when schema files are generated.
The Sync App can generate schema files corresponding to views returned by the Sync App. Editing these generated schema files gives you granular control over the metadata (such as columns) returned by the Sync App when the corresponding views are queried.
For example, removing a column (<attr> element) from a generated schema file causes that column not to be reported.
Schema files generated by the Sync App are output to the folder specified in the Location connection property.
When this connection property is set to OnUse, upon making a metadata request for a view, the Sync App generates a schema file for that view.
When this connection property is set to OnStart, the Sync App generates schema files for all the views that are discovered when the connection begins.
Schema files are not overwritten if they already exist in the Location folder. To update a specific schema file with updated metadata, first delete that schema file from this folder, then trigger the schema file creation again.
Controls whether empty column values are displayed as NULL or an initial (non-NULL) value.
Some fields in SAP tables are configured to have an initial value.
This means that, when a record is inserted into the SAP table without including a value for those fields, instead of being considered NULL, the fields are initialized with a set generic value that represents an empty value without technically being NULL.
For example, a field may be set to initialize with the value 0, or "" (empty string) instead of being NULL.
When this connection property is set to Null, records in fields with the InitialValue indicator enabled in SAP, and whose value matches the initial value for their data type (0, "", etc.), are returned as NULL in query results.
When this connection property is set to InitialValue, records in fields with the InitialValue indicator enabled in SAP, and whose value matches the initial value for their data type (0, "", etc.), are returned as-is in query results.
The ISO 639-1 language code used by your SAP system.
Set this connection property to the language value you specify when you log into SAP.
By default, "EN" (English) is used. Other codes include "DE" for German and "JA" for Japanese.
This connection property's value informs the column names returned when querying SAP tables. See the UseLabels connection property for more details.
The path where generated schema files are placed.
Through the use of schema files, you can customize the metadata returned by views and stored procedures. Any view with a corresponding schema file in the path set in this connection property are always persisted in the list of queryable views, regardless of the current value of TableMode.
Schema files can be generated manually by executing stored procedures such as CreateSchema, or generated automatically when the conditions specified in the GenerateSchemaFiles connection property are met.
Schema files generated by the Sync App are output to the directory specified in this connection property.
The value of this connection property can be an absolute path or a relative path from the location of the Sync App executable.
Specifies whether to map SAP table fields of NUMC and ACCP types to Varchar type.
The SAP NUMC type is a long character field that only allows numeric entries. The length of this field is limited to a maximum of 255 characters.
The SAP ACCP type represents a posting period. This field is 6 characters long, with the format YYYYMM.
If this connection property is set to False, NUMC and ACCP type fields are returned with a numeric type.
If this connection property is set to True, NUMC and ACCP fields are returned as Varchar type.
Specifies whether to map the SAP RAW and LRAW types to Varchar type.
If this connection property is set to True, the Sync App maps the SAP RAW and LRAW types to Varchar type.
If this connection property is set to False, the Sync App maps RAW and LRAW types to Binary type.
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.
| Property | Description |
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT=True | Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
The maximum number of records per page the provider returns when requesting data from SAP ERP. Only used for SAP tables.
When processing a query, instead of requesting all of the queried data at once from SAP ERP, the Sync App can request the queried data in pieces called pages.
This connection property determines the maximum number of results that the Sync App requests per page.
The RFC_READ_TABLE function module 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 page size to such a degree that the Sync App only needs one page to return all data requested in the problematic query.
Note that, while setting large page sizes can resolve this issue and may improve overall query execution time, doing so also causes the Sync App to use more memory when executing queries and risks triggering a timeout.
Determines how to handle the pagination query.
Allowed values are:
Note: When PaginationScheme is set to Default or Key, the driver orders results by the table's primary key(s) only when the table class supports a server-side ORDER BY clause. This behavior prevents duplicate records across paginated result sets.
If a table does not support server-side ORDER BY, the driver does not apply primary-key ordering by default. In this case, if an ORDER BY clause is explicitly specified in the query, it is not sent to SAP; instead, the driver applies the ordering client-side.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
Determines which SAP Queries are displayed as views, if any.
Like SAP tables, SAP Queries can also be displayed as views.
If this connection property is set to None, SAP Queries are not included in the data model of the Sync App. This is the default behavior.
You can expose some or all of your SAP Queries as views:
The delimiter used by the read table function specified in the ReadTableFunction connection property.
If your SAP installation includes SAP Note 2246160, the Sync App uses "~" as the default delimiter for the RFC_READ_TABLE function module. If your data contains the "~" character in any records, change the delimiter to a character that does not appear in any of your records. If your SAP installation does not include SAP Note 2246160, the Sync App does not use a delimiter by default.
The function to use for reading table data.
The Sync App can use various read table functions when retrieving SAP ERP data, including custom function that remove limitations on the buffer size.
See Using a Custom Read Table Function for more information.
The timezone by which the server is expected to report date and times values.
The CData Sync App uses the CDPOS and CDHDR tables to replicate data incrementally. SAP ERP does not actually store a timezone when it returns a date and time to the CData Sync App from these tables. In order to ensure dates can be converted from your local time to SAP ERP, you may specify the ServerTimeZone. For example, EST, JST, PST. The CData Sync App will assume values coming from CDPOS and CDHDR match the specified timezone so that when values are passed to it requesting only the latest results, nothing is skipped over when converting from your local time to the server's.
A filter controlling which function modules are reported as stored procedures.
The Sync App can execute remote enabled function modules, and makes them available for query in the form of stored procedures.
Due to the large number of function modules available in your SAP installation, you may find it useful to hide a portion of these stored procedures in the reported metadata of the Sync App.
Use wildcards (*) to select the procedures you want to include based on a name pattern.
For example, the default value for this connection property, "BAPI*" matches all remote enabled function modules that start with "BAPI", and function modules whose names do not start with "BAPI" are not displayed.
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 column is set to 'R'. If TFDIR is not visible in your metadata listing, set TableMode to TransparentSystem to make it available for querying.
Enables server-side execution of the COUNT function in supported SAP installations.
The feature enabled by this connection property is only supported in SAP installations that include SAP Note 3390051.
Specifies which SAP ERP tables are displayed as views.
The Sync App lists SAP ERP tables as read-only views. If you need to write to SAP ERP tables, you can use BAPIs.
Most SAP ERP installations contain a very large number of tables, and while the Sync App can list all tables in your installation as available views, the more tables you have access to, the longer the process of displaying this list takes.
This property allows you to only list the tables that are important to you. This both avoids the need to scroll through a massive list of tables and allows the Sync App to display the now-filtered list of tables more quickly.
The Sync App retrieves the list of tables from the DD02L system table. Set this property either to the name of one of the filter presets below, or write a custom filter for DD02L directly in this connection property's value.
In addition to the selected filter, the Sync App applies internal filtering logic to avoid displaying system-reserved or special-use tables. For example, by default, the Sync App excludes tables that contain a forward slash in the name. This can cause tables such as /Customer/Orders/ to be omitted from the table list, even if they would otherwise match your selected filter.
To override the default filtering behavior, you can set the TableMode to Custom and define your own filter using the CustomTableFilter property.
Available values:
| Setting | Filter | Description |
| 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. |
| InternalTable | TABCLASS = 'INTTAB' | All internal tables. |
| View | TABCLASS = 'VIEW' | All general view tables. |
| AppendTable | TABCLASS = 'APPEND' | All append tables. |
| All | All tables regardless of type. Warning: This will cause a massive amount of tables to be retrieved and may result in a noticeable delay in table listing. | |
| None | No filter. No SAP tables are displayed. This may be useful if you intend to use schema files or SAP queries. | |
| Custom | User-defined filter. Please set this filter in the CustomTableFilter property. |
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies which, if any, leading and trailing whitespaces are omitted from varchar columns.
In SAP, the RFC_READ_TABLE function module pads Varchar columns with spaces.
Typically, trailing spaces are not deliberately added to SAP table records, so the Sync App defaults to removing any trailing spaces in query results.
If, however, you have deliberately added trailing spaces in your SAP table records, you may use this connection property to customize (or disable) this behavior.
| Value of TrimStrings | Description |
| TrimLeft | Trim the leading spaces of the string value. |
| TrimRight | Trim the trailing spaces of the string value. |
| TrimAll | Trim the leading and trailing spaces of the string value. |
| None | Do not trim any spaces from the string value. |
Indicates if advanced replication features should be used when caching data.
Typically replication is done using a modified column on the specific table to incrementially cache the data to a database. However, many SAP tables lack a a modified date column, or use a different name for this column. To get around this limitation, we attempt to use the CDHDR and CDPOS tables to find changes that have occurred to records in tables. This is not a perfect solution as CDHDR and CDPOS do not contain entries for every possible table. Setting UseAdvancedReplication to true will attempt to use CDHDR and CDPOS tables for replication in most tables.
Specifies whether to use the internal names of columns in query results rather than the display name.
When this connection property is set to False (the default), the Sync App displays columns by their display names (a more readable name for the column specific to your SAP client's language).
When this connection property is set to True, the Sync App displays columns by their internal names.
For example, the ADRC table has a column with the internal name "ADDRNUMBER".
If this connection property is set to False and you have your SAP client language set to "en", the Sync App uses the name "Address Number" for the column.
If this connection property is set to True, the Sync App uses the internal name ("ADDRNUMBER") as-is for the column name.
Controls whether the human-readable names or internal names of tables and columns are displayed in query results.
You can set this connection property to one of the following values:
If you have set this connection property to display human-readable names for tables/columns, and no human-readable name exists for a specific column or table, the Sync App displays its internal name instead.
Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM MARA WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can use this property to define multiple views in a single file and specify the filepath.
For example:
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonWhen you specify a view in UserDefinedViews, the Sync App only sees that view.
For further information, see User Defined Views.
Specifies whether or not simple names should be used for tables and columns.
SAP ERP tables can include special characters in their names that are typically not allowed in standard databases. This property makes the Sync App easier to use with traditional database tools.
Setting UseSimpleNames to True simplifies the names of the columns that are returned. It enforces a naming scheme where only alphanumeric characters and underscores are valid for displayed column names.
Notes:
Specifies whether to use the RFC_GET_UNICODE_STRUCTURE function module to get structure information.
This connection property must be set to True (this is the default) when using SAP systems that are Unicode-enabled.
If you are connecting with a SOAP service (when the ConnectionType connection property is set to SOAP) and that SOAP service is not Unicode-enabled, set this connection property to False.
You can confirm whether your SAP system is Unicode-enabled by navigating in the SAP GUI to System > Status > SAP System data > Unicode System.
Specifies whether to return string fields with an empty value as null.
When this connection property is set to True, empty column values (empty strings or strings that only contain whitespace characters) are returned as null.
This connection property only affects fields with the datatype "string".
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.