SAP BusinessObjects BI Connection Details

Introduction

Connector Version

This documentation is based on version 25.0.9368 of the connector.

Get Started

SAP BusinessObjects BI Version Support

The connector leverages the SAPBusinessObjectsBI API to enable read-only access to SAPBusinessObjectsBI. It supports all API versions from 4.1SP6 and above.

Establish a Connection

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

Important Notes

Configuration Files and Their Paths

• All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

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

User Defined Views

The connector supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats. For further information, see the SSLServerCert property under "Connection String Options".

Proxy

To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

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

For further information, see Query Processing.

Log

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

User Defined Views

The SAP BusinessObjects BI connector supports the use of user defined views: user-defined virtual tables whose contents are decided by a preconfigured query. User defined views are useful in situations where you cannot directly control the query being issued to the driver; for example, when using the driver from Jitterbit.

Use a user defined view to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File

User defined views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This user defined view configuration file is formatted so that each root element defines the name of a view, and includes a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM MyCustomReport WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

In order to avoid a view's name clashing with an actual entity in the data model, user defined views are exposed in the UserViews schema by default. To change the name of the schema used for UserViews, reset the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a user defined view called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a user defined view that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

To enable TLS, set the following:

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

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

Data Model

The SAP BusinessObjects BI connector 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.

Universes Data Model

The SAP BusinessObjects BI connector 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 SAP BusinessObjects BI connector 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%'

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

The naming in this case will be, MyReport_Flow0, MyReport_Flow1 etc.

Supported Operators

The SAP BusinessObjects BI connector 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 SAP BusinessObjects BI connector 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

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

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

SAP BusinessObjects BI Connector Stored Procedures

CreateSchema

Creates a custom report by providing dimensions and metrics.

CreateSchema

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

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

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

Input

Result Set Columns

Administration Data Model

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

Tables

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

SAP BusinessObjects BI Connector Tables

UserDetails

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='indritb@cdata.com', Connection=0 WHERE Id=3411

Columns

UserGroupDetails

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  connector' WHERE Id=8959

Columns

UserGroupMembershipGroups

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

UserGroupMembershipUsers

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

UserGroups

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

Update

UPDATE UserGroups SET Name='updatedName', Description='test update from ' WHERE Id=8959

UPDATE UserGroups SET Name='new updated name2', Description='test update from ' WHERE Name='test'

Delete

DELETE FROM UserGroups WHERE Id=8620

Columns

Users

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

Stored Procedures

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

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

SAP BusinessObjects BI Connector Stored Procedures

CreateUser

Create a user.

Execute

EXEC CreateUser Name='Test', Email='indritb@cdata.com', FullName='test', Password='test123', Description='testDescription'

Input

Result Set Columns

Reporting Data Model

The SAP BusinessObjects BI connector exposes SAP BusinessObjects BI reporting endpoints as views, tables and stored procedures.

Tables

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

SAP BusinessObjects BI Connector Tables

DocumentDetails

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 ', ParentId=5524 WHERE ID=5570

Columns

Documents

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

DocumentSchedules

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

Reports

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

WebIntelligenceDocuments

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

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

SAP BusinessObjects BI Connector Views

BWConnectionDetails

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

BWConnections

Query BW connections for a SAP Business Objects BI instance.

Select

The following queries are processed server-side:

SELECT * FROM BWConnections

Columns

ConnectionDetails

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

Connections

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

DocumentInstances

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

DocumentScheduleDetails

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

ReportComments

Query report comments for a SAP Business Objects BI instance.

Select

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

Columns

ReportDetails

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

UniverseCapabilities

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

UniverseDetails

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

Universes

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

WebIntelligenceDocumentDetails

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

Stored Procedures

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

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

SAP BusinessObjects BI Connector Stored Procedures

CreateSchedule

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

Result Set Columns

ExportReport

Exports the specified report.

Input

Result Set Columns

GetDocumentRefreshParameters

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

Input

Result Set Columns

PurgeReport

Purges a document or its data providers.

Execute

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

Input

Result Set Columns

RefreshDocument

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

Input

Result Set Columns

SaveDocument

Saves a Web Intelligence document in the CMS repository.

Input

Result Set Columns

UpdateDocumentState

Update the state of a document.

Execute

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

Input

Result Set Columns

UploadDocument

Uploads the specified document.

Input

Result Set Columns

System Tables

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

sys_catalogs

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns

sys_tablecolumns

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

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns

sys_procedureparameters

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

Pseudo-Columns

sys_keycolumns

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

sys_foreignkeys

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

sys_primarykeys

Describes the primary keys.

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

SELECT * FROM sys_primarykeys

Columns

sys_indexes

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

sys_connection_props

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

sys_sqlinfo

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

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.

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

sys_identity

Returns information about attempted modifications.

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

SELECT * FROM sys_identity

Columns

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Advanced Configurations Properties

The advanced configurations 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. Click the links for further details.

Authentication

SSO

SSL

Schema

Miscellaneous

Authentication

This section provides a complete list of authentication properties you can configure.

AuthScheme

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

Schema

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.

URL

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.

User

Specifies the user ID of the authenticating SAP BusinessObjects BI user account.

Data Type

string

Default Value

""

Remarks

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

Password

Specifies the password of the authenticating user account.

Data Type

string

Default Value

""

Remarks

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

SSO

This section provides a complete list of SSO properties you can configure.

SSOLoginURL

The identity provider's login URL.

Data Type

string

Default Value

""

Remarks

The identity provider's login URL.

SSOProperties

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.

SSOExchangeURL

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

Data Type

string

Default Value

""

Remarks

The SAP BusinessObjects BI connector 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.

SSL

This section provides a complete list of SSL properties you can configure.

SSLServerCert

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

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

Location

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

Data Type

string

Default Value

%APPDATA%\SAPBusinessObjectsBI Data Provider\Schema

Remarks

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

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

BrowsableSchemas

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.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

AddFolderPrefix

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.

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

This property sets an upper limit on the number of rows the connector returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Data Type

string

Default Value

""

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

PageSize

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

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the connector 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: "*=*"

ServerTimezone

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.

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Data Type

int

Default Value

60

Remarks

This property controls the maximum time, in seconds, that the connector waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the connector cancels the operation and throws an exception.

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 the timeout value if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing 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. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Data Type

string

Default Value

""

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the connector and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:

{
    "MyView": {
        "query": "SELECT * FROM MyCustomReport WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }

}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the connector.

Refer to User Defined Views for more information.