This page provides a guide to Establishing a Connection to SAP BusinessObjects BI in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to SAP BusinessObjects BI

Establishing a Connection shows how to authenticate to SAP BusinessObjects BI and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from SAP BusinessObjects BI through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to SAP BusinessObjects BI by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

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 Cloud initiates the out-of-band mechanism. The Cloud 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 Cloud should continue polling the API until the challenge is completed through user interaction. By default, the Cloud 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;

Customizing the SSL Configuration

To enable TLS, set the following:

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

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

CData Cloud - SAP BusinessObjects BI Stored Procedures

Name	Description

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

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

CData Cloud - SAP BusinessObjects BI 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 Cloud 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.

CData Cloud - SAP BusinessObjects BI 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 Cloud exposes SAP BusinessObjects BI reporting endpoints as views, tables and stored procedures.

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

CData Cloud - SAP BusinessObjects BI 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 Cloud uses the SAP BusinessObjects BI API to process search criteria that refer to the DocumentId and ReportId columns. The Cloud 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.

CData Cloud - SAP BusinessObjects BI 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 Cloud uses the SAP BusinessObjects BI API to process search criteria that refer to the DocumentId column. The Cloud 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 Cloud 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.

CData Cloud - SAP BusinessObjects BI 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.

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for SAP BusinessObjects BI:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the MyCustomReport table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='MyCustomReport' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
Path	String	Item path on the SAP Universe.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SampleProcedure stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure' AND IncludeResultColumns='True'

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native SAP BusinessObjects BI procedure.

Pseudo-Columns

Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

Describes the primary and foreign keys.

The following query retrieves the primary key for the MyCustomReport table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='MyCustomReport' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

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.

Logging

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

---

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

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

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.

Possible Values

Basic, Enterprise, LDAP, WinAD, CyberArk

Data Type

string

Default Value

"Basic"

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.

Possible Values

SAPBusinessObjectsBI, Administration, Reporting

Data Type

string

Default Value

"SAPBusinessObjectsBI"

Remarks

The available schemas are SAPBusinessObjectsBI, Administration and Reporting.

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

Data Type

string

Default Value

""

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.

Data Type

string

Default Value

""

Remarks

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

Specifies the authenticating user's password.

Data Type

string

Default Value

""

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.

Data Type

string

Default Value

""

Remarks

The identity provider's login URL.

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

Data Type

string

Default Value

""

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.

Data Type

string

Default Value

""

Remarks

The CData Cloud 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.

Data Type

string

Default Value

""

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 Logging properties you can configure in the connection string for this provider.

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

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

---

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

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

Data Type

string

Default Value

""

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.

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

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

Data Type

bool

Default Value

false

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.

Data Type

int

Default Value

-1

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 how many records the SAP BusinessObjects BI will return on a single page.

Data Type

string

Default Value

""

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

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud 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.

Data Type

string

Default Value

""

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.

Data Type

int

Default Value

60

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.

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.