Adding a Connection to SAP BusinessObjects BI

To add a connection to SAP BusinessObjects BI:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the SAP BusinessObjects BI icon is not available, click the Add More icon to download and install the SAP BusinessObjects BI connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to SAPBusinessObjectsBI

To connect to your SAP BusinessObjects BI instance, you must set the following:

• URL: The SAP BusinessObjects BI REST API URL. To discover this:
  1. Log into the Central Management Console.
  2. Choose Applications from the combo box.
  3. Select RESTful Web Service. The Central Management Console displays the access URL, which is http://{Server-Name}:6405/biprws by default.

• AuthScheme: Set this to the type of authentication to use when connecting to SAP BusinessObjects BI.

Basic

To connect to SAP BusinessObjects BI using the default Basic authentication mechanism, set the AuthScheme to Basic, and set these properties:

• User: The username of your instance.
• Password: The password of your instance.

Enterprise

To connect to SAP BusinessObjects BI using Enterprise authentication, set the AuthScheme to Enterprise, and set these properties:

• User: The username of your instance.
• Password: The password of your instance.

LDAP

To connect to SAP BusinessObjects BI using LDAP authentication, set the AuthScheme to LDAP, and set these properties:

• User: The LDAP username.
• Password: The password of the LDAP user.

WinAD

To connect to SAP BusinessObjects BI using Windows AD authentication, set the AuthScheme to WinAD, and set these properties:

• User: The Windows Active Directory user.
• Password: The password of the user.

CyberArk

To connect to CyberArk, set the AuthScheme to CyberArk, and set these properties:

• User: The CyberArk login name (user@domain).
• Password: The CyberArk user's password.
• SSOLoginURL: The app's single sign on URL.
• SSOExchangeURL: The url used for the exchange of the SAML token for SAP BusinessObjects BI credentials.

If you have configured MFA, you must use combinations of SSOProperties to authenticate using CyberArk. Set any of the following, as applicable:

• MFAType: If you have configured MFA, set this to the name of the mechanism that should be selected during authentication.
• MFAPassCode: If you have configured MFA, set this to a valid answer for the selected mechanism.
  If you set this to an empty or an invalid value, the Sync App initiates the out-of-band mechanism. The Sync App polls the API until the challenge is completed through user interaction before deciding on closing the connection.
• MFATimeout: If you have configured MFA, set this to the number of seconds the Sync App should continue polling the API until the challenge is completed through user interaction. By default, the Sync App polls the API for 60 seconds before closing the connection.
  

Example connection string:

AuthScheme=CyberArk;SSOLoginURL='https://abc1234.id.cyberark.cloud/run?appkey=00000000-0000-0000-0000-000000000000&customerId=ABC1234';User=cyberarkUserName;Password=cyberarkPassword;SSOExchangeUrl=http://myserver:8080/biprws/saml/SSO;

This section details a selection of advanced features of the SAP BusinessObjects BI Sync App.

User Defined Views

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 .

SSL Configuration

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

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to SAP BusinessObjects BI and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Customizing the SSL Configuration

To enable TLS, set the following:

• URL: Prefix the connection string with https://

With this configuration, 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.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Sync App models SAP BusinessObjects BI API as relational tables, views and stored procedures.

Multiple schemas are exposed to make it easier to work with SAP BusinessObjects BI.

The SAPBusinessObjectsBI schema exposes SAP Universes as views that can be queried directly or can be used to generate reports.

The Administration schema exposes views, tables and stored procedures that can be used by administrator users.

The Reporting schema exposes views, tables and stored procedures to work with reporting services.

The CData Sync App models SAP BusinessObjects BI universes as relational views. The API allows you by default to retrieve only 5000 records unless changes in the Universe settings.

Schemas for most database reports are defined in simple, text-based configuration files.

Views

The universes of your SAP BusinessObjects BI instance will be listed as separate views you can query against. A universe can have several 'business views'. If that's the case, each 'business view' will be listed as a separate view you can run queries against. If the universe has no business views, than all the universe's objects will be listed as columns.

For example, let's suppose we have a universe named, EFashion. And it has these objects: Year (dimension), StoreName (dimension), SalesRevenue (measure), ThisYear (filter). The CData Sync App will expose the EFashion view that will have the following columns: Year, StoreName, SalesRevenue, ThisYear (input only column). Some queries you can run:

SELECT Year, StoreName, SalesRevenue FROM EFashion WHERE ThisYear = true
SELECT Year, StoreName, SalesRevenue FROM EFashion WHERE StoreName LIKE '%boston%'
SELECT Year, StoreName, SalesRevenue FROM EFashion WHERE Year BETWEEN 2016 AND 2018 AND StoreName LIKE '%austin%'

Note: On dynamically listed views, when you run a 'SELECT *' query, only one default dimension will be selected by default. This is done to improve performance and to make the report more readable. Since a universe can have many dimensions, the report can be unreadable.

For example, in the above example, if we'd run a 'SELECT *' query, only one of the dimensions, Year or StoreName would be selected. If you want to select all dimensions, you must explicitly write them in the query.

Query with multiple flows: If you run queries that include objects that are not related to each other, even though they are in the same universe, the SAP BusinessObjects BI will generate two query flows in the background. In that case, the CData Sync App will raise an error stating that the query is ambiguous.

Custom Schemas

You can create your own views (reports), using the CreateSchema, by providing a list of dimensions IDs and measures IDs, that will be the columns of your custom schema.

Note: If the dimension and measures you have provided generates multiple query flows, then the respective schemas will be created for each query flow. The naming in this case will be, MyReport_Flow0, MyReport_Flow1 etc.

Supported Operators

The CData Sync App does not support client side filtering, which means that all the queries you run, must be supported by the SAP BusinessObjects BI API. Otherwise an error will be raised, stating that the query is not supported. The supported operators will depend on the universe. The CData Sync App will dynamically retrieve the supported operators of each universe. Some of these can be: AND, OR, NOT, =, !=, <=, <, >=, >, IS, IS NOT, LIKE, NOT IN, IN.

Some examples:

SELECT StoreName, City, NameOfManager FROM EFashion WHERE SalesRevenue > 1000 AND (City = 'Houston' OR City = 'Boston') 
SELECT StoreName, City, NameOfManager FROM EFashion WHERE SalesRevenue <= 1000 AND City NOT IN ('Houston', 'Boston')
SELECT StoreName, City, NameOfManager FROM EFashion WHERE City LIKE ('%ston') AND NameOfManager IS NOT NULL

Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with SAP BusinessObjects BI.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from SAP BusinessObjects BI, along with an indication of whether the procedure succeeded or failed.

SAP BusinessObjects BI Connector for CData Sync Stored Procedures

Name	Description

Creates a custom report by providing dimensions and metrics.

CreateSchema

Creates a local schema file (.rsd) from an existing table or view in the data model.

The schema file is created in the directory set in the Location connection property when this procedure is executed. You can edit the file to include or exclude columns, rename columns, or adjust column datatypes.

The Sync App checks the Location to determine if the names of any .rsd files match a table or view in the data model. If there is a duplicate, the schema file will take precedence over the default instance of this table in the data model. If a schema file is present in Location that does not match an existing table or view, a new table or view entry is added to the data model of the Sync App.

Input

Name	Type	Required	Description
TableName	String	True	The name for the new table.
Dimensions	String	True	A comma-separated list of dimensions' Ids to include in the schema file.
Measures	String	True	A comma-separated list of metrics' Ids to include in the schema file.
Universe	String	True	The unique identifier of the universe you want to create report against.
WriteToFile	String	False	Whether to write the contents of this stored procedure to a file or not (Default = true) needs to be set to false to output FileStream of FileData
Description	String	False	An optional description for the table.
FileStreamIndex	String	False	The index of the schema file to stream into the output stream parameter

Result Set Columns

Name	Type	Description
FileData	String	Schema data, base64 encoded. Only returned if WriteToFile is false and FileStream is not specified.
Success	String	Whether or not the schema was created successfully.
SchemaFile	String	The generated schema file.

The CData Sync App exposes SAP BusinessObjects BI administration endpoints as views, tables and stored procedures.

The Sync App models the data in SAP BusinessObjects BI as a list of tables in a relational database that can be queried using standard SQL statements.

SAP BusinessObjects BI Connector for CData Sync Tables

Name	Description
UserDetails	Query details of users for a SAP Business Objects BI instance.
UserGroupDetails	Query details of user groups for a SAP Business Objects BI instance.
UserGroupMembershipGroups	Query group members of a user group for a SAP Business Objects BI instance.
UserGroupMembershipUsers	Query user members of a user group for a SAP Business Objects BI instance.
UserGroups	Query user groups for a SAP Business Objects BI instance.
Users	Query users for a SAP Business Objects BI instance.

Query details of users for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM UserDetails WHERE Id=11

Update

    UPDATE UserDetails SET IsAccountDisabled=true, IsPasswordToChangeAtNextLogon=true, IsPasswordChangeAllowed=true, description='Updated Description', FullName='test updated', IsPasswordExpiryAllowed=false, Title='UpdatedTitle', EmailAddress='[email protected]', Connection=0 WHERE Id=3411

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	The user ID.
CUID	String	True	The user cluster unique ID.
FullName	String	False	The full name of the user.
EmailAddress	String	False	The email address of the user.
Description	String	False	The description of the user.
Title	String	False	The title of the user.
ParentID	String	True	The parent ID.
ParentCUID	String	True	The parent CUID.
InboxID	Integer	True	The user inbox ID.
IsAccountDisabled	Bool	False	If the user account is disabled.
IsPasswordToChangeAtNextLogon	Bool	False	If the password must be changed in the next logon.
IsPasswordChangeAllowed	Bool	False	If user password change is allowed.
IsPasswordExpiryAllowed	Bool	False	If password expiration is allowed.
UserGroups	String	True	The user groups of this user.
Connection	Integer	False	The connection of this user.
LastLogonTime	Datetime	True	The last logon time of the user.
Name	String	True	The name of the user.
Type	String	True	The type of the user.
OwnerId	Integer	True	The id of the user's owner.
IsNamedUser	Bool	True	If the user is a 'named user'.
UpdatedAt	Datetime	True	The datetime when the user was last updated.

Query details of user groups for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM UserGroupDetails
    SELECT * FROM UserGroupDetails WHERE Id=1

Update

    UPDATE UserGroupDetails SET Name='updatedName', Description='test update from CData connector' WHERE Id=8959

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	The user group ID.
CUID	String	True	The user group cluster unique ID.
ParentId	String	True	The user group parent ID.
ParentCUID	String	True	The user group parent CUID.
Name	String	False	The user group name.
Description	String	False	The user group description.
Keywords	String	True	Keywords of the user group.
Created	Datetime	True	The date time when the user group was created.

Query group members of a user group for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM UserGroupMembershipGroups
    SELECT * FROM UserGroupMembershipGroups WHERE OwnerGroupId=1
    SELECT * FROM UserGroupMembershipGroups WHERE OwnerGroupId=1 AND Name='test'

Insert

    INSERT INTO UserGroupMembershipGroups (OwnerGroupId, Id) VALUES (2708, 3409)

Delete

    DELETE FROM UserGroupMembershipGroups WHERE OwnerGroupId=2708
    DELETE FROM UserGroupMembershipGroups WHERE OwnerGroupId=2708 AND Id=3409

Columns

Name	Type	ReadOnly	Description
OwnerGroupId [KEY]	Integer	False	The group owner ID.
Id [KEY]	Integer	False	The group identifier.
CUID	String	True	The group cluster unique ID.
Name	String	True	The group name.
Description	String	True	The group description.
Keywords	String	True	Keywords of the user group.
Created	Datetime	True	The date time when the user group was created.
Updated	Datetime	True	The date time when the user group was last updated.

Query user members of a user group for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM UserGroupMembershipUsers
    SELECT * FROM UserGroupMembershipUsers WHERE GroupId=1
    SELECT * FROM UserGroupMembershipUsers WHERE GroupId=1 AND Name='test'

Insert

    INSERT INTO UserGroupMembershipUsers (GroupId, Id) VALUES (2708, 11)

Delete

    DELETE FROM UserGroupMembershipUsers WHERE GroupId=2708
    DELETE FROM UserGroupMembershipUsers WHERE GroupId=2708 AND Id=533

Columns

Name	Type	ReadOnly	Description
GroupId [KEY]	Integer	False	The user group ID.
Id [KEY]	Integer	False	The user ID.
CUID	String	True	The user cluster unique ID.
Name	String	True	The user name.
FullName	String	True	The user full name.
Email	String	True	The user email.
Description	String	True	The user description.
Keywords	String	True	Keywords of the user group.
Created	Datetime	True	The date time when the user was created.
Updated	Datetime	True	The date time when the user was last updated.

Query user groups for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM UserGroups
    SELECT * FROM UserGroups WHERE Name='test'
    SELECT Id, Updated FROM UserGroups WHERE Updated > '2025-02-06T05:06:00.000-05:00'
    SELECT Id, Updated FROM UserGroups WHERE Updated >= '2025-02-06T05:06:00.000-05:00'

Insert

    INSERT INTO UserGroups (Name, Description) VALUES ('testGroup', 'test insert from CData')

Update

    UPDATE UserGroups SET Name='updatedName', Description='test update from CData' WHERE Id=8959
    UPDATE UserGroups SET Name='new updated name2', Description='test update from CData' WHERE Name='test'

Delete

    DELETE FROM UserGroups WHERE Id=8620

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	The user group identifier.
CUID	String	True	The user group cluster unique identifier.
ParentId	String	True	The user group parent id.
Name	String	False	The user group name.
Description	String	False	The user group description.
Type	String	True	The type of the user group.
Keywords	String	True	Keywords of the user group.
Updated	Datetime	True	The date time when the user group was last updated.

Query users for a SAP Business Objects BI instance.

To create Users make use of the CreateUser stored procedure.

Select

The following queries are processed server-side:

    SELECT * FROM USERS
    SELECT Id, Name FROM Users ORDER BY ID
    SELECT Id, Name FROM Users ORDER BY ID DESC
    SELECT * FROM Users WHERE ParentId=18
    SELECT * FROM Users WHERE ParentId=19 AND FullName='test'
    SELECT * FROM Users WHERE Updated > '2025-02-06T08:35:00.000-05:00'
    SELECT * FROM Users WHERE Updated >= '2025-02-06T08:35:00.000-05:00'

Delete

    DELETE FROM Users WHERE ID=8596

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	False	The user ID.
CUID	String	False	The user cluster unique ID.
Name	String	False	The name of the user.
FullName	String	False	The full name of the user.
Description	String	False	The description of the user.
Type	String	False	The type of the user.
OwnerId	String	False	The user owner ID.
ParentId	String	False	The user parent ID.
Updated	Datetime	False	The date time when the user was last updated.

Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with SAP BusinessObjects BI.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from SAP BusinessObjects BI, along with an indication of whether the procedure succeeded or failed.

SAP BusinessObjects BI Connector for CData Sync Stored Procedures

Name	Description
CreateUser	Create a user.

Create a user.

Execute

    EXEC CreateUser Name='Test', Email='[email protected]', FullName='test', Password='test123', Description='testDescription'

Input

Name	Type	Required	Description
Name	String	True	The name of the user.
FullName	String	False	The full name of the user.
Email	String	False	The email of the user.
Password	String	False	The password of the user.
Description	String	False	The description of the user.
IsNamedUser	Boolean	False	The user connection type. The default value is true.
ForcePasswordChange	Boolean	False	To force the user to change the password. The default value is true.
PasswordExpire	Boolean	False	To enable password expiry. The default value is false.
AllowChangePassword	Boolean	False	Enable or disable password change. The default value is true.

Result Set Columns

Name	Type	Description
Id	Integer	The Id of the created user.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

The CData Sync App exposes SAP BusinessObjects BI reporting endpoints as views, tables and stored procedures.

The Sync App models the data in SAP BusinessObjects BI as a list of tables in a relational database that can be queried using standard SQL statements.

SAP BusinessObjects BI Connector for CData Sync Tables

Name	Description
DocumentDetails	Query all document details for a SAP Business Objects BI instance.
Documents	Query all documents for a SAP Business Objects BI instance.
DocumentSchedules	Query document schedules for a SAP Business Objects BI instance.
ReportComments	Query report comments for a SAP Business Objects BI instance.
Reports	Query reports for a SAP Business Objects BI instance.
WebIntelligenceDocuments	Query documents for a SAP Business Objects BI instance.

Query all document details for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM DocumentDetails
    SELECT * FROM DocumentDetails WHERE Id=1

Update

    UPDATE DocumentDetails SET Keywords='test,cdata', Description='Updated', Name='document from CData', ParentId=5524 WHERE ID=5570

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	False	The document ID.
CUID	String	False	The document CUID.
Name	String	False	The document name.
Description	String	False	The document description.
Type	String	False	The document type.
Keywords	String	False	The document keywords.
OwnerID	String	False	The document owner ID.
ParentID	String	False	The document parent ID.
ParentCUID	String	False	The document parent CUID.
Created	Datetime	False	The datetime when the document created.
Updated	Datetime	False	The datetime when the document was last updated.

Query all documents for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM Documents
    SELECT Id, Type FROM Documents ORDER BY Type
    SELECT Id, Type FROM Documents ORDER BY ID DESC
    SELECT Id, Type FROM Documents ORDER BY Description DESC
    SELECT Id, Updated FROM Documents WHERE Updated>'2025-02-04T12:25:00.000-05:00'
    SELECT Id, Updated FROM Documents WHERE Updated>='2025-02-04T12:25:00.000-05:00'

Delete

    DELETE FROM Documents WHERE Id=5903

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	False	The document ID.
CUID	String	False	The document CUID.
Name	String	False	The document name.
Description	String	False	The document description.
Type	String	False	The document type.
OwnerID	String	False	The document owner ID.
ParentID	String	False	The document parent ID.
Updated	Datetime	False	The datetime when the document was last updated.

Query document schedules for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM DocumentSchedules
    SELECT * FROM DocumentSchedules WHERE Id=1

Delete

    DELETE FROM DocumentSchedules WHERE DocumentId=5525 AND Id=7840

Columns

Name	Type	ReadOnly	Description
DocumentId [KEY]	Integer	False	The document ID.
ID [KEY]	Integer	False	The schedule ID.
Name	String	False	The schedule name.
Format	String	False	The schedule format.
Status	String	False	The schedule status.
StatusID	Integer	False	The schedule status id.
Updated	Datetime	False	The datetime when the schedule was last updated.

Query report comments for a SAP Business Objects BI instance.

Select

The Sync App uses the SAP BusinessObjects BI API to process search criteria that refer to the DocumentId and ReportId columns. The Sync App processes other filters client-side within the driver. For example, the following queries are processed server side:

    SELECT * FROM ReportComments
    SELECT * FROM ReportComments WHERE DocumentId=1
    SELECT * FROM ReportComments WHERE DocumentId=1 AND ReportId=3

Insert

The following example illustrates how to insert into the ReportComments table.

    INSERT INTO ReportComments (DocumentId, ReportId, ElementId, Value) VALUES (5486, 1, 258, 'test comment from cdata connector')

Update

The following examples illustrate how to update the ReportComments table.

    UPDATE ReportComments SET Value='updated comment from cdata connector' WHERE DocumentId=5486 AND ReportId=1 AND Id=5 AND ElementId=259
    UPDATE ReportComments SET Value='updated comment from cdata connector' WHERE DocumentId=5486 AND ReportId=1 AND Id=5
    UPDATE ReportComments SET Value='updated comment from cdata connector' WHERE DocumentId=5486 AND ReportId=1

Delete

The following examples illustrate how to delete a row in ReportComments where DocumentId is 5486, ReportId is 1, and ElementId is 259:

    DELETE FROM ReportComments WHERE DocumentId=5486 AND ReportId=1 AND Id=5 AND ElementId=259
    DELETE FROM ReportComments WHERE DocumentId=5486 AND ReportId=1 AND Id=5
    DELETE FROM ReportComments WHERE DocumentId=5486 AND ReportId=1

Columns

Name	Type	ReadOnly	Description
DocumentId [KEY]	Integer	False	The document ID.
ReportId [KEY]	Integer	False	The report ID.
Id [KEY]	Integer	True	The comment ID.
Value	String	False	The comment value.
ElementID	String	False	The comment element ID.
ElementReference	String	True	The comment element Reference.
Created	Datetime	True	The date time when the comment was created.
CreatedByName	String	True	The comment creator name.
CreatedByCUID	String	True	The comment creator CUID.
Updated	Datetime	True	The date time when the comment was last updated.
LastAuthorName	String	True	The comment last author name.
LastAuthorCUID	String	True	The comment last author CUID.

Query reports for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM Reports
    SELECT * FROM Reports WHERE DocumentId=1

Insert

    INSERT INTO Reports (DocumentId, Name) VALUES (5486, 'test report from cdata connector')

Delete

    DELETE FROM Reports WHERE DocumentId=8023
    DELETE FROM Reports WHERE DocumentId=8023 AND Id=150

Columns

Name	Type	ReadOnly	Description
DocumentId [KEY]	Integer	False	The document ID.
Id [KEY]	Integer	True	The report ID.
Name	String	False	The report name.
Reference	String	True	The report reference.
Section	String	True	The report section.
HasDataFilter	Bool	True	If has data filter.
HasDriller	Bool	True	If has driller.
ShowDataChanges	Bool	False	If data changes are displayed.

Query documents for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM WebIntelligenceDocuments

Insert

    INSERT INTO WebIntelligenceDocuments (Name, FolderId) VALUES ('new_document_from_cdata', 5522)

Delete

    DELETE FROM WebIntelligenceDocuments WHERE Id=5490

Columns

Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	The document ID.
CUID	String	True	The document CUID.
Name	String	False	The document name.
Description	String	True	The document description
State	String	True	The state of document used by the service.
Occurrence	String	True	The occurrence of the document.
Scheduled	Bool	True	If the document is scheduled.
FolderId	Integer	False	The identifier of the folder of the CMS repository that contains the document

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.

SAP BusinessObjects BI Connector for CData Sync Views

Name	Description
BWConnectionDetails	Query BW connection details for a SAP Business Objects BI instance.
BWConnections	Query BW connections for a SAP Business Objects BI instance.
ConnectionDetails	Query connection details for a SAP Business Objects BI instance.
Connections	Query connections for a SAP Business Objects BI instance.
DocumentInstances	Query document instances for a SAP Business Objects BI instance.
DocumentScheduleDetails	Query document schedule details for a SAP Business Objects BI instance.
ReportDetails	Query report details for a SAP Business Objects BI instance.
ReportElements	Query report elements for a SAP Business Objects BI instance.
UniverseCapabilities	Query universe capabilities for a SAP Business Objects BI instance.
UniverseDetails	Query universe details for a SAP Business Objects BI instance.
Universes	Query universes for a SAP Business Objects BI instance.
WebIntelligenceDocumentDetails	Query document details for a SAP Business Objects BI instance.

Query BW connection details for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM BWConnectionDetails
    SELECT * FROM BWConnectionDetails WHERE Id=1

Columns

Name	Type	Description
Id [KEY]	Integer	The connection ID.
CUID	String	The connection CUID.
Name	String	The connection name.
Type	String	The connection type.
FolderId	Integer	The connection folder id.
Path	String	The path of the connection.
BWNodes	String	The list of BW node aggregates.

Query BW connections for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM BWConnections

Columns

Name	Type	Description
Id [KEY]	Integer	The connection ID.
CUID	String	The connection CUID.
Name	String	The connection name.
Type	String	The connection type.
FolderId	Integer	The connection folder id.

Query connection details for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM ConnectionDetails
    SELECT * FROM ConnectionDetails WHERE Id=1

Columns

Name	Type	Description
Id [KEY]	Integer	The connection ID.
CUID	String	The connection CUID.
Name	String	The connection name.
Type	String	The connection type.
FolderId	Integer	The connection folder id.
Path	String	The path of the connection.
Database	String	The database of the connection.
NetworkLayer	String	The network layer of the connection.
CreatedBy	String	The user that created the connection.
Updated	Datetime	The datetime the connection was last updated.

Query connections for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM Connections
    SELECT * FROM Connections WHERE Type='Relational'

Columns

Name	Type	Description
Id [KEY]	Integer	The connection ID.
CUID	String	The connection CUID.
Name	String	The connection name.
Type	String	The connection type.
FolderId	Integer	The connection folder id.

Query document instances for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM DocumentInstances
    SELECT * FROM DocumentInstances WHERE Id=1

Columns

Name	Type	Description
DocumentId [KEY]	Integer	The document ID.
ID [KEY]	Integer	The document instance ID.
CUID	String	The document instance CUID.
Owner	String	The owner of the document instance.
ScheduleStatus	String	The schedule status.
OpenDocLink	String	The open doc link.
UIStatus	String	The UI status link.
PID	Integer	The document instance PID.
Type	String	The document instance type.
Duration	String	The document instance duration.
Path	String	The document instance path.
InstanceName	String	The document instance name.
ParentDocName	String	The parent doc name.
ServerUsed	String	The server use by the document instance.
StartTime	Datetime	The start time.
EndTime	Datetime	The end time.
Expiry	Datetime	The expiry time.
Created	Datetime	The creation date time.

Query document schedule details for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM DocumentScheduleDetails WHERE Id=1

Columns

Name	Type	Description
DocumentId [KEY]	Integer	The document ID.
ID [KEY]	Integer	The schedule ID.
Name	String	The schedule name.
Format	String	The schedule format.
Status	String	The schedule status.
StatusID	Integer	The schedule status id.
Updated	Datetime	The datetime when the schedule was last updated.
Destination	String	The destination JSON aggregate.
Parameters	String	The parameters JSON aggregate.
ServerGroupId	Integer	The server group ID as defined in the CMC.
ServerGroupRequired	Bool	If false, the schedule is run preferably on the server that belongs to the specified server group. If the specified server is not available, then the schedule is run on the next available server. If true, only the specified servers found within the selected server group is used. If all of the servers in the server group are unavailable, then the schedule is not processed.

Query report details for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM ReportDetails
    SELECT * FROM ReportDetails WHERE DocumentId=1
    SELECT * FROM ReportDetails WHERE DocumentId=1 AND Id=3

Columns

Name	Type	Description
DocumentId [KEY]	Integer	The document ID.
Id [KEY]	Integer	The report ID.
Name	String	The report name.
Reference	String	The report reference.
Section	String	The report section.
HasDataFilter	Bool	If has data filter.
HasDriller	Bool	If has driller.
ShowDataChanges	Bool	If data changes are displayed.
ShowFolding	Bool	If folding is displayed.
PaginationMode	String	The report pagination mode.
PageSettings	String	The page settings aggregate.
PageSettings_Records_Vertical	Int	The number of records vertically.
PageSettings_Records_Horizontal	Int	The number of records horizontally.
PageSettings_Scaling_Factor	Int	The scaling factor.
PageSettings_Format	String	The page format.
PageSettings_Format_PaperSizeId	String	The page paper size ID.
PageSettings_Format_Height	Int	The page height.
PageSettings_Format_Width	Int	The page width.
PageSettings_Format_Orientation	String	The page orientation.
PageSettings_Margins_Top	Int	The page top margin.
PageSettings_Margins_Bottom	Int	The page bottom margin.
PageSettings_Margins_Left	Int	The page left margin.
PageSettings_Margins_Right	Int	The page right margin.
Style	String	The style aggregate.
Style_HyperLinkColors_Link	String	The link color.
Style_HyperLinkColors_Active	String	The active link color.
Style_HyperLinkColors_Hover	String	The hover link color.
Style_HyperLinkColors_Visited	String	The visited link color.

Query report elements for a SAP Business Objects BI instance.

Select

The Sync App uses the SAP BusinessObjects BI API to process search criteria that refer to the DocumentId column. The Sync App processes other filters client-side within the driver. For example, the following queries are processed server side:

    SELECT * FROM ReportElements
    SELECT * FROM ReportElements WHERE DocumentId=1
    SELECT * FROM ReportElements WHERE DocumentId=1 AND ReportId=3

Columns

Name	Type	Description
DocumentId [KEY]	Integer	The document ID.
ReportId [KEY]	Integer	The report ID.
Id [KEY]	Integer	The element ID.
Reference	String	The element reference.
Name	String	The element name.
Type	String	The element type.
Position	String	The element position.
Size	String	The element size.
Padding	String	The element padding.

Query universe capabilities for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM UniverseCapabilities
    SELECT * FROM UniverseCapabilities WHERE Id=1

Columns

Name	Type	Description
Id [KEY]	Integer	The universe ID.
GeneralCapabilities_MaxValuesForInList	Integer	Max number of values for IN value list.
GeneralCapabilities_CombinedQueriesSupported	Bool	If combined queries are supported.
GeneralCapabilities_ViewQueryScriptAvailable	Bool	If view query script is available.
GeneralCapabilities_CustomQueryScriptSupported	Bool	If view custom query script is supported.
GeneralCapabilities_ContextMultipleSelectionSupported	Bool	If context multiple selection is supported.
GeneralCapabilities_ShowHideScopeSupported	Bool	If show hide scope is supported.
DataProcessingCapabilities_SamplingLevel	String	The sampling level.
DataProcessingCapabilities_RemoveDuplicateRowsAvailable	Bool	If remove duplicate rows is available.
DataProcessingCapabilities_MaxRowRetrievedAvailable	Bool	If max row retrieved is available.
DataProcessingCapabilities_MaxRetrievalTimeAvailable	Bool	If max row retrieval time is available.
DataProcessingCapabilities_RemoveEmptyRowsAvailable	Bool	If remove empty rows is available.
DataProcessingCapabilities_QueryStrippingAvailable	Bool	If query stripping is available.
ResultObjectCapabilities_UseAttributeSeparatelyAvailable	Bool	If use attribute separately is available.
ResultObjectCapabilities_SortObjectsAvailable	Bool	If sort objects is available.
ResultObjectCapabilities_SortNonResultObjectsAvailable	Bool	If sort non result objects is available.
ResultObjectCapabilities_MultipleIntraDimensionalHierarchiesSupported	Bool	If multiple intra dimensional hierarchies is supported.
ResultObjectCapabilities_BuildLogicalSetWithMetadataFunctionsAvailable	Bool	If build logical set with metadata functions is available.
ResultObjectCapabilities_BuildLogicalSetWithMemberFunctionsAvailable	Bool	If build logical set with member functions is available.
ResultObjectCapabilities_MemberSelectionPromptSupported	Bool	If member selection prompt is supported.
ResultObjectCapabilities_SupportsMemberSelectionCompletion	Bool	If member selection completion is supported.
FilterCapabilities_SubQueriesSupported	Bool	If sub queries are supported.
FilterCapabilities_ResultObjectInFilterSupported	Bool	If result object in filter is supported.
FilterCapabilities_ObjectComparisonSupported	Bool	If object comparison is supported.
FilterCapabilities_ConstantComparisonSupported	Bool	If constant comparison is supported.
FilterCapabilities_ResultHierarchyInFilterSupported	Bool	If result hierarchy in filter is supported.
FilterCapabilities_QueryOnQuerySupported	Bool	If query on query is supported.
FilterCapabilities_FreeValuesForMultiValuesPromptSupported	Bool	If free values for multi values prompt is supported.
FilterCapabilities_HierarchyConstantOperandSupported	Bool	If hierarchy constant operand is supported.
FilterCapabilities_MultipleIntraDimensionalHierarchiesInFilterSupported	Bool	If multiple intra dimensional hierarchies in filter is supported.
FilterCapabilities_SupportedComparisonOperators	String	The list of supported comparison operators.
FilterCapabilities_SupportedLogicalOperators	String	The list of supported logical operators.
FilterCapabilities_SupportedObjects	String	The list of supported objects.
FilterCapabilities_SupportedRankings	String	The list of supported rankings.
FilterCapabilities_SupportedValueBasedHierarchyComparisonOperators	String	The list of supported value based hierarchy comparison operators.
FilterCapabilities_SupportedLevelBasedHierarchyComparisonOperators	String	The list of supported level based hierarchy comparison operators.

Query universe details for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM UniverseDetails
    SELECT * FROM UniverseDetails WHERE Id=1
    SELECT * FROM UniverseDetails WHERE Aggregated=true

Columns

Name	Type	Description
Id [KEY]	Integer	The universe ID.
CUID	String	The universe CUID.
Name	String	The universe name.
Description	String	The universe description.
Connected	Bool	The universe connected status.
FolderId	Integer	The universe folder id.
Path	String	The universe path.
Revision	Integer	The universe revision number.
Type	String	The universe type.
SubType	String	The universe sub type.
MaxRetrievalTime	Integer	The universe max retrieval time.
MaxRowsRetrieved	Integer	The universe max rows retrieved.
Outline	String	The universe outline aggregate.
Aggregated	Bool	Indicates if the outline is aggregated.

Query universes for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM Universes
    SELECT * FROM Universes WHERE Type='unx'

Columns

Name	Type	Description
Id [KEY]	Integer	The universe ID.
CUID	String	The universe CUID.
Name	String	The universe name.
Description	String	The universe description.
FolderId	Integer	The universe folder ID.
Revision	Integer	The universe revision number.
Type	String	The universe type.
SubType	String	The universe sub type.

Query document details for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

    SELECT * FROM WebIntelligenceDocumentDetails
    SELECT * FROM WebIntelligenceDocumentDetails WHERE Id=1

Columns

Name	Type	Description
Id [KEY]	Integer	The document ID.
CUID	String	The document CUID.
Name	String	The document name.
Description	String	The document description
State	String	The state of document used by the service.
Occurrence	String	The occurrence of the document.
Scheduled	Bool	If the document is scheduled.
FolderId	Integer	The identifier of the folder of the CMS repository that contains the document.
Path	String	The path to the document in the CMS repository directory.
PathIDs	String	The ids of the path to the document in the CMS repository directory.
RefreshOnOpen	Bool	If the document is set to be refreshed at the open time.
Size	Integer	The size of the document in bytes.
CreatedBy	String	The name of the document creator.
LastAuthor	String	The name of the last person who modified the document.
Updated	Datetime	The date and the time of the last update.

Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with SAP BusinessObjects BI.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from SAP BusinessObjects BI, along with an indication of whether the procedure succeeded or failed.

SAP BusinessObjects BI Connector for CData Sync Stored Procedures

Name	Description
CreateSchedule	Adds a new schedule.
ExportReport	Exports the specified report.
GetDocumentRefreshParameters	Refreshes a Web Intelligence document by filling the refresh parameters if needed and running the query.
PurgeReport	Purges a document or its data providers.
RefreshDocument	Refreshes a Web Intelligence document by filling the refresh parameters if needed and running the query.
SaveDocument	Saves a Web Intelligence document in the CMS repository.
UpdateDocumentState	Update the state of a document.

Adds a new schedule.

Execute

    EXEC CreateSchedule DocumentId=5500, Name='test', Type='xls', Destination='{"inbox": {}}', RecurrenceType='daily', RecurrenceExpression='{"@retriesAllowed":2,"@retryIntervalInSeconds":60,"startdate":"2025-04-15T01:00:00.000+02:00","enddate":"2025-08-15T01:00:00.000+02:00","dayinterval":1}', Parameters='[{"parameter":{"@optional":false,"@type":"prompt","@dpId":"DP0","id":0,"technicalName":"Enter State:","answer":{"@constrained":false,"@type":"Text","values":[{"value":"Texas"}]}}}]'

Input

Name	Type	Required	Description
DocumentID	String	True	The identifier of the document to schedule the report.
Name	String	True	The name of the schedule.
Type	String	True	The format type of the schedule.
ServerGroupId	Integer	False	The server group ID as defined in the CMC.
ServerGroupRequired	Bool	False	If false, the schedule is run preferably on the server that belongs to the specified server group. If the specified server is not available, then the schedule is run on the next available server. If true, only the specified servers found within the selected server group is used. If all of the servers in the server group are unavailable, then the schedule is not processed.
Destination	String	False	The destination aggregate in JSON format.
RecurrenceType	String	False	The recurrence type.
RecurrenceExpression	String	False	The recurrence expression aggregate in JSON format.
Parameters	String	False	The schedule parameters in JSON format.

Result Set Columns

Name	Type	Description
Id	String	The id of the created schedule.
Message	String	The message returned from the server.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

Exports the specified report.

Input

Name	Type	Required	Description
DocumentID	String	True	The identifier of the document to export.
Type	String	True	The type of the document to export. Values are Excel 2007, Excel 2003, PDF, ZIP, XML. The allowed values are Excel 2007, Excel 2003, PDF, ZIP, XML.
DPI	Int	False	Resolution in dots per inch (dpi) for generated charts. Value between 75 and 9600. Default is 300 for PDF format, 96 for all other formats.
Unit	String	False	A string that defines the unit that sizes will be reported in. Values are metric, millimeter, point, and pixel (default). The allowed values are metric, millimeter, point, pixel.
RawValues	Boolean	False	Boolean. Default is false. If true, the raw values and their types are exported with the formatted values.
Optimized	Boolean	False	Boolean. Default is false. If true, the generated output is optimized for calculations inside Microsoft Excel.
LocalPath	String	False	The absolute location where the file will be saved.

Result Set Columns

Name	Type	Description
FileData	String	If the LocalPath and FileStream inputs are empty, file data will be output encoded in base64.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

Refreshes a Web Intelligence document by filling the refresh parameters if needed and running the query.

Input

Name	Type	Required	Description
DocumentID	String	True	The identifier of the document.
ListOfValuesInfo	Bool	False	Specifies if the lists of values are computed and displayed. The default value is true.
Summary	Bool	False	Specifies if a summary of the previous values will be returned. The default value is false.

Result Set Columns

Name	Type	Description
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.
Parameters	String	Parameters to be filled before running a document refresh.

Purges a document or its data providers.

Execute

    EXEC PurgeReport DocumentId=5486, purge=true, purgeOptions='prompts', dataProviderIDs='12,1'

Input

Name	Type	Required	Description
DocumentID	String	True	The identifier of the document to purge.
Purge	Bool	False	An optional boolean that specifies whether the application should purge the document. The default value is false.
PurgeOptions	String	False	An optional string parameter that manages the purge. For now, prompt is the only value allowed. If you don't set this parameter or leave it empty, the application only purges the data provider.
DataProviderIDs	String	False	An optional string that specifies the data providers whose parameters should be retrieved. If you have multiple data providers, make sure to separate them using a comma.

Result Set Columns

Name	Type	Description
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

Refreshes a Web Intelligence document by filling the refresh parameters if needed and running the query.

Input

Name	Type	Required	Description
DocumentID	String	True	The identifier of the document to refresh.
DataProviderScope	String	False	If set to accessible, a document can be refreshed even if one or more of the data providers is not accessible. The allowed values are all, accessible.
ListOfValuesInfo	Bool	False	Specifies if the lists of values are computed and displayed. The default value is true.
Refresh	Bool	False	To avoid a data refresh at the end of the parameter workflow. The default value is true.
Strict	Bool	False	To be used with VariantIds. If set to true, an error message is returned if the variant contents and the document parameters do not match, or if the cardinality of the answer in a variant is incorrect or the data type of the answer in a variant is incorrect. The default value is false.
VariantIds	String	False	The list of variant identifiers separated with a comma that you can use to answer the prompt parameters of the document. The order of variants in the list is important. A value provided by a variant or the request body can overwrite the one provided by another variant. The last value is used to answer the parameter.
Parameters	String	False	The parameters to be used to run the document refresh.

Result Set Columns

Name	Type	Description
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

Saves a Web Intelligence document in the CMS repository.

Input

Name	Type	Required	Description
DocumentID	String	True	The identifier of the document to save.
Overwrite	Bool	False	An optional parameter that can be used to avoid overwriting an existing version of the document. If set to false, an error will be returned if the document already exists. The default value is true.
WithComments	Bool	False	An optional parameter that enables copying all the comments in the source document to the saved document. If set to true, all the comments of the source document will be copied to the target document. The default value is false.

Result Set Columns

Name	Type	Description
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

Update the state of a document.

Execute

    EXEC UpdateDocumentState DocumentId='15512', State='Unused'

Input

Name	Type	Required	Description
DocumentID	String	True	The identifier of the document.
State	String	True	The new state of the document.

Result Set Columns

Name	Type	Description
Message	String	The message returned from the server.
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

Uploads the specified document.

Input

Name	Type	Required	Description
FileName	String	True	The name of the file to upload.
FolderID	String	True	The identifier of the folder to upload into.
LocalPath	String	False	The absolute location where the file will be read from.
FileData	String	False	If the LocalPath and FileStream inputs are empty, you can input base64 encoded string.

Result Set Columns

Name	Type	Description
Success	Boolean	Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details.
Details	String	Details of execution failure. NULL if success=true.

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.

Authentication

---

Property	Description
AuthScheme	The authorization scheme to be used when server authorization is to be performed.
Schema	The type of schema to use.
URL	The URL of the rest API exposed by the SAP BusinessObjects BI.
User	Specifies the authenticating user's user ID.
Password	Specifies the authenticating user's password.

SSO

---

Property	Description
SSOLoginURL	The identity provider's login URL.
SSOProperties	Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
SSOExchangeURL	The URL used for consuming the SAML response and exchanging it for service specific credentials.

SSL

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

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.

Proxy

---

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.

Logging

---

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.

Schema

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
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 .

Miscellaneous

---

Property	Description
AddFolderPrefix	Set whether to include the folder name as a prefix of the column name.
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	Specifies how many records the SAP BusinessObjects BI will return on a single page.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ServerTimezone	The time zone configuration of your SAP Business Objects BI server. Example: GMT, EST etc.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
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.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	The authorization scheme to be used when server authorization is to be performed.
Schema	The type of schema to use.
URL	The URL of the rest API exposed by the SAP BusinessObjects BI.
User	Specifies the authenticating user's user ID.
Password	Specifies the authenticating user's password.

The authorization scheme to be used when server authorization is to be performed.

Remarks

This property specifies the type of authentication to perform. Possible values are:

• Basic: Set this to use BASIC authentication. This uses the default auth mechanism.
• Enterprise: Set this to use Enterprise authentication.
• LDAP: Set this to use LDAP authentication.
• WinAD: Set this to use WinAD authentication.

The following options are available for SSO:

• CyberArk: Set this to use a single sign on connection with CyberArk as the identify provider.

The type of schema to use.

Remarks

The available schemas are SAPBusinessObjectsBI, Administration and Reporting.

The URL of the rest API exposed by the SAP BusinessObjects BI.

Remarks

You can find the correct URL after logging in the Central Management Console. From the combo box choose 'Applications'. After that, double-click on 'RESTful Web Service' and you'll see the access URL. By default, it is http://{SERVER-NAME}:6405/biprws.

Specifies the authenticating user's user ID.

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Specifies the authenticating user's password.

Remarks

The authenticating server requires both User and Password to validate the user's identity.

This section provides a complete list of the SSO properties you can configure in the connection string for this provider.

---

Property	Description
SSOLoginURL	The identity provider's login URL.
SSOProperties	Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.
SSOExchangeURL	The URL used for consuming the SAML response and exchanging it for service specific credentials.

The identity provider's login URL.

Remarks

The identity provider's login URL.

Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.

Remarks

Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.

This is used with the SSOLoginURL.

SSO configuration is discussed further in .

The URL used for consuming the SAML response and exchanging it for service specific credentials.

Remarks

The CData Sync App will use the URL specified here to consume a SAML response and exchange it for service specific credentials. The retrieved credentials are the final piece during the SSO connection that are used to communicate with SAP BusinessObjects BI.

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.

Remarks

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.

Remarks

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 BusinessObjects BI. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to SAP BusinessObjects BI. 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 BusinessObjects BI. 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.

Remarks

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.

Remarks

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.

Remarks

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.

Remarks

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.

Remarks

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.

Remarks

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.

Remarks

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.

Remarks

Supported authentication types :

• BASIC: The Sync App performs HTTP basic authentication.
• DIGEST: The Sync App performs HTTP digest authentication.
• NTLM: The Sync App retrieves an NTLM token.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• NONE: Signifies that the ProxyServer does not require authentication.

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.

Remarks

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.

Remarks

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.

Remarks

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.

Remarks

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.

Remarks

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.	Connec – Information related to creating or destroying connections. Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
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.	Messag – Messages pertaining to query execution. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance. Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user). Page – Messages related to query paging. Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP	HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.	KERB – HTTP requests related to Kerberos. Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product. Res – Messages containing HTTP responses. Req – Messages containing HTTP requests.
WSDL	Messages pertaining to the generation of WSDL/XSD files.	—
SSL	SSL certificate messages.	Certif – Messages pertaining to SSL certificates.
AUTH	Authentication related failure/success messages.	Messag – Messages pertaining to authentication. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. OAuth – Messages related to OAuth authentication. Krbros – Kerberos-related authentication messages.
SQL	Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.	Bulk – Messages pertaining to bulk query execution. Cache – Messages related to reading row data from and writing row data to the product's cache for better performance. Messag – Messages pertaining to SQL transactions. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. ResSet – Query resultsets. Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META	Metadata cache and schema messages.	Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance. Schema – Messages related to retrieving metadata from or modifying the service schema. MemSto – Messages related to writing to or reading from in-memory metadata cache. Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC	Information related to executing SQL functions.	Errmsg – Error messages related to executing SQL functions.
TCP	Incoming and outgoing raw bytes on TCP transport layer messages.	Send – Raw data sent via the TCP protocol. Receiv – Raw data received via the TCP protocol.
FTP	Messages pertaining to the File Transfer Protocol.	Info – Status messages related to communication in the FTP protocol. Client – Messages related to actions taken by the FTP client (the product) during FTP communication. Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP	Messages pertaining to the Secure File Transfer Protocol.	Info – Status messages related to communication in the SFTP protocol. To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication. From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP	Messages pertaining to data transferred via the Post Office Protocol.	Client – Messages related to actions taken by the POP client (the product) during POP communication. Server – Messages related to actions taken by the POP server during POP communication. Status – Status messages related to communication in the POP protocol.
SMTP	Messages pertaining to data transferred via the Simple Mail Transfer Protocol.	Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication. Server – Messages related to actions taken by the SMTP server during SMTP communication. Status – Status messages related to communication in the SMTP 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).	Commit – Submissions for bulk data uploads.
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
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
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 .

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\\CData\\SAPBusinessObjectsBI Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

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 .

Remarks

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 .

Remarks

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
AddFolderPrefix	Set whether to include the folder name as a prefix of the column name.
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	Specifies how many records the SAP BusinessObjects BI will return on a single page.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ServerTimezone	The time zone configuration of your SAP Business Objects BI server. Example: GMT, EST etc.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
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.

Set whether to include the folder name as a prefix of the column name.

Remarks

Set whether to include the folder name as a prefix of the column name.

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Remarks

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.

Remarks

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.

Integration and Formatting

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.

Specifies how many records the SAP BusinessObjects BI will return on a single page.

Remarks

The default value changes based on the selected Schema.

• SAPBusinessObjectsBI: 10000
• Administration: 50
• Reporting: 50

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Remarks

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:

*=*

The time zone configuration of your SAP Business Objects BI server. Example: GMT, EST etc.

Remarks

This property specifies the time zone used to parse datetime values that are returned without a time zone. By default the time zone is resolved by querying the API.

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Remarks

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 a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Remarks

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 MyCustomReport 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.json

When you specify a view in UserDefinedViews, the Sync App only sees that view.

For further information, see User Defined Views.

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.