SAP BusinessObjects BI Connector for CData Sync

Build 25.0.9540
  • SAP BusinessObjects BI
    • 接続の確立
    • 高度な機能
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • Universes データモデル
        • ストアドプロシージャ
          • CreateSchema
      • Administration データモデル
        • テーブル
          • UserDetails
          • UserGroupDetails
          • UserGroupMembershipGroups
          • UserGroupMembershipUsers
          • UserGroups
          • Users
        • ストアドプロシージャ
          • CreateUser
      • Reporting データモデル
        • テーブル
          • DocumentDetails
          • Documents
          • DocumentSchedules
          • ReportComments
          • Reports
          • WebIntelligenceDocuments
        • ビュー
          • BWConnectionDetails
          • BWConnections
          • ConnectionDetails
          • Connections
          • DocumentInstances
          • DocumentScheduleDetails
          • ReportDetails
          • ReportElements
          • UniverseCapabilities
          • UniverseDetails
          • Universes
          • WebIntelligenceDocumentDetails
        • ストアドプロシージャ
          • CreateSchedule
          • ExportReport
          • GetDocumentRefreshParameters
          • PurgeReport
          • RefreshDocument
          • SaveDocument
          • UpdateDocumentState
          • UploadDocument
    • 接続文字列オプション
      • Authentication
        • AuthScheme
        • Schema
        • URL
        • User
        • Password
      • SSO
        • SSOLoginURL
        • SSOProperties
        • SSOExchangeURL
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • AddFolderPrefix
        • MaxRows
        • Other
        • PageSize
        • PseudoColumns
        • ServerTimezone
        • Timeout
        • UserDefinedViews
    • Third Party Copyrights

SAP BusinessObjects BI Connector for CData Sync

概要

CData Sync App は、SAP BusinessObjects BI データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。

SAP BusinessObjects BI コネクタはCData Sync アプリケーションから使用可能で、SAP BusinessObjects BI からデータを取得して、サポートされている任意の同期先に移動できます。

SAP BusinessObjects BI バージョンサポート

Sync App はSAPBusinessObjectsBI API を使用してSAPBusinessObjectsBI への読み取り専用アクセスを実現します。4.1SP6 以降のAPI バージョンをサポートしています。

SAP BusinessObjects BI Connector for CData Sync

接続の確立

SAP BusinessObjects BI への接続を追加

SAP BusinessObjects BI への接続を追加するには:

  1. アプリケーションコンソールで、接続ページに移動します。
  2. 接続の追加パネルで、追加したい接続のアイコンを選択します。
  3. SAP BusinessObjects BI アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからSAP BusinessObjects BI コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

SAPBusinessObjectsBI への接続

SAP BusinessObjects BI インスタンスに接続するには、以下を設定する必要があります。

  • URL:SAP BusinessObjects BI REST API URL。これを見つけるには:

    1. セントラル管理コンソールにログインします。
    2. コンボボックスからアプリケーションを選択します。
    3. RESTful Web Service を選択します。セントラル管理コンソールは、アクセスURL を表示します。デフォルトでは、http://{Server-Name}:6405/biprws です。

  • AuthScheme:SAP BusinessObjects BI に接続する際に使用する認証の種類に設定。

Basic

デフォルトのBasic 認証メカニズムを使用してSAP BusinessObjects BI に接続するには、AuthScheme をBasic に設定し、次のプロパティを設定します。

  • User:インスタンスのユーザー名。
  • Password:インスタンスのパスワード。

Enterprise

Enterprise 認証を使用してSAP BusinessObjects BI に接続するには、AuthScheme をEnterprise に設定し、次のプロパティを設定します。

  • User:インスタンスのユーザー名。
  • Password:インスタンスのパスワード。

LDAP

LDAP 認証を使用してSAP BusinessObjects BI に接続するには、AuthScheme をLDAP に設定し、次のプロパティを設定します。

  • User:LDAP ユーザー名。
  • Password:LDAP ユーザーのパスワード。

WinAD

Windows AD 認証を使用してSAP BusinessObjects BI に接続するには、AuthScheme をWinAD に設定し、次のプロパティを設定します。

  • User:Windows Active Directory ユーザー。
  • Password:ユーザーのパスワード。

CyberArk

CyberArk に接続するには、AuthScheme をCyberArk に設定し、次のプロパティを設定します。

  • User:CyberArk のログイン名(user@domain)。
  • Password:CyberArk ユーザーのパスワード。
  • SSOLoginURL:アプリのシングルサインオンURL。
  • SSOExchangeURL:The url used for the exchange of the SAML token for SAP BusinessObjects BI credentials.

MFA を設定している場合、CyberArk を使用して認証するにはSSOProperties を組み合わせて使用する必要があります。必要に応じて、以下のいずれかを設定します。

  • MFAType:MFA を設定している場合、認証時に選択するメカニズムの名前を設定します。
  • MFAPassCode:MFA を設定している場合、選択したメカニズムに対して有効な回答を設定します。
    この値を空欄または無効な値に設定すると、Sync App は帯域外メカニズムを開始します。Sync App は、ユーザーとの対話を通じてチャレンジが完了するまでAPI をポーリングしてから、接続を閉じるかどうかを決定します。
  • MFATimeout:MFA を設定している場合、Sync App がユーザーとの対話によってチャレンジが完了するまでAPI のポーリングを継続する秒数を設定します。デフォルトでは、Sync App は接続を閉じる前に60秒間API をポーリングします。

接続文字列の例:

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;

SAP BusinessObjects BI Connector for CData Sync

高度な機能

このセクションでは、SAP BusinessObjects BI Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、SAP BusinessObjects BI にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくは、クエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングに必要なのは2つの接続プロパティだけですが、より詳細なロギングをサポートする多くの機能があり、LogModules 接続プロパティを使用してロギングする情報のサブセットを指定することができます。

SAP BusinessObjects BI Connector for CData Sync

SSL の設定

SSL 設定のカスタマイズ

TLS を有効化するには、以下を設定します。

  • URL:接続文字列の前にhttps:// を付加します。

この設定により、Sync App はサーバーとのTLS ネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

SAP BusinessObjects BI Connector for CData Sync

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

  • ProxyServer:HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
  • ProxyPort:プロキシサーバーが起動しているTCP ポート。
  • ProxyAuthScheme:プロキシサーバーに対して認証する際にSync App が使用する認証方法。
  • ProxyUser:プロキシサーバーに登録されているユーザーアカウントのユーザー名。
  • ProxyPassword:ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

  • プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
  • 接続をトンネルするには、FirewallType をTUNNEL に設定します。
  • 認証するには、FirewallUser とFirewallPassword を設定します。
  • SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

SAP BusinessObjects BI Connector for CData Sync

データモデル

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

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

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

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

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

SAP BusinessObjects BI Connector for CData Sync

Universes データモデル

CData Sync App はSAP BusinessObjects BI のユニバースをビューとしてモデル化します。このAPI では、ユニバースの設定が変更されない限り、デフォルトで5000レコードしか取得できません。

ほとんどのデータベースレポートのスキーマは、シンプルなテキストベースのコンフィギュレーションファイルで定義されます。

ビュー

SAP BusinessObjects BI インスタンスのユニバースは、クエリ可能な個別のビューとしてリストされます。1つのユニバースは複数の'ビジネスビュー' を持つことができます。その場合、各'ビジネスビュー' は、クエリ可能な個別のビューとしてリストされます。 ユニバースがビジネスビューを持たない場合は、すべてのユニバースのオブジェクトはカラムとしてリストされます。

例えば、EFashion という名前のユニバースがあるとしましょう。そして、それは次のオブジェクトを持っているとします:Year(ディメンション)、StoreName(ディメンション)、SalesRevenue(メジャー)、ThisYear(フィルタ)。 CData Sync App は、以下のカラムを持つEFashion ビューを公開します:Year、StoreName、SalesRevenue、ThisYear(入力のみのカラム)。実行できるいくつかのクエリ:

SELECT Year, StoreName, SalesRevenue FROM EFashion WHERE ThisYear = true
SELECT Year, StoreName, SalesRevenue FROM EFashion WHERE StoreName LIKE '%boston%'
SELECT Year, StoreName, SalesRevenue FROM EFashion WHERE Year BETWEEN 2016 AND 2018 AND StoreName LIKE '%austin%'
Note: On dynamically listed views, when you run a 'SELECT *' query, only one default dimension will be selected by default. This is done to improve performance and to make the report more readable. Since a universe can have many dimensions, the report can be unreadable.

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

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

Custom Schemas

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

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

Supported Operators

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

Some examples:

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

SAP BusinessObjects BI Connector for CData Sync

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、SAP BusinessObjects BI の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSAP BusinessObjects BI から関連するレスポンスデータを返します。

SAP BusinessObjects BI Connector for CData Sync ストアドプロシージャ

Name Description

SAP BusinessObjects BI Connector for CData Sync

CreateSchema

Creates a custom report by providing dimensions and metrics.

CreateSchema

データモデル内の既存のテーブルまたはビューからローカルスキーマファイル(.rsd)を作成します。

スキーマファイルは、このプロシージャが実行されると、Location 接続プロパティで設定されたディレクトリに作成されます。ファイルを編集してカラムを含めたり除外したり、カラム名を変更したり、カラムのデータ型を変更したりできます。

Sync App はLocation を確認し、.rsd ファイルの名前がデータモデルのテーブルまたはビューに一致するかどうかを判断します。重複がある場合、スキーマファイルはデータモデル内のこのテーブルのデフォルトインスタンスよりも優先されます。既存のテーブルまたはビューに一致しないスキーマファイルがLocation に存在する場合、新しいテーブルまたはビューのエントリがSync App のデータモデルに追加されます。

Input

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

Result Set Columns

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

SAP BusinessObjects BI Connector for CData Sync

Administration データモデル

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

SAP BusinessObjects BI Connector for CData Sync

テーブル

Sync App はSAP BusinessObjects BI のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

SAP BusinessObjects BI Connector for CData Sync テーブル

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.

SAP BusinessObjects BI Connector for CData Sync

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

SAP BusinessObjects BI Connector for CData Sync

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

SAP BusinessObjects BI Connector for CData Sync

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

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.

SAP BusinessObjects BI Connector for CData Sync

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

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.

SAP BusinessObjects BI Connector for CData Sync

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

SAP BusinessObjects BI Connector for CData Sync

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

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.

SAP BusinessObjects BI Connector for CData Sync

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、SAP BusinessObjects BI の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSAP BusinessObjects BI から関連するレスポンスデータを返します。

SAP BusinessObjects BI Connector for CData Sync ストアドプロシージャ

Name Description
CreateUser Create a user.

SAP BusinessObjects BI Connector for CData Sync

CreateUser

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.

デフォルト値はtrueです。

ForcePasswordChange Boolean False To force the user to change the password.

デフォルト値はtrueです。

PasswordExpire Boolean False To enable password expiry.

デフォルト値はfalseです。

AllowChangePassword Boolean False Enable or disable password change.

デフォルト値は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.

SAP BusinessObjects BI Connector for CData Sync

Reporting データモデル

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

SAP BusinessObjects BI Connector for CData Sync

テーブル

Sync App はSAP BusinessObjects BI のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

SAP BusinessObjects BI Connector for CData Sync テーブル

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.

SAP BusinessObjects BI Connector for CData Sync

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

SAP BusinessObjects BI Connector for CData Sync

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

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.

SAP BusinessObjects BI Connector for CData Sync

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

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.

SAP BusinessObjects BI Connector for CData Sync

ReportComments

Query report comments for a SAP Business Objects BI instance.

Select

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

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

Insert

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

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

Update

The following examples illustrate how to update the ReportComments table.

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

Delete

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

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

Columns

Name Type ReadOnly Description
DocumentId [KEY] Integer False

The document ID.

ReportId [KEY] Integer False

The report ID.

Id [KEY] Integer True

The comment ID.

Value String False

The comment value.

ElementID String False

The comment element ID.

ElementReference String True

The comment element Reference.

Created Datetime True

The date time when the comment was created.

CreatedByName String True

The comment creator name.

CreatedByCUID String True

The comment creator CUID.

Updated Datetime True

The date time when the comment was last updated.

LastAuthorName String True

The comment last author name.

LastAuthorCUID String True

The comment last author CUID.

SAP BusinessObjects BI Connector for CData Sync

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

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.

SAP BusinessObjects BI Connector for CData Sync

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

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

SAP BusinessObjects BI Connector for CData Sync

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

SAP BusinessObjects BI Connector for CData Sync ビュー

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.

SAP BusinessObjects BI Connector for CData Sync

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

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.

SAP BusinessObjects BI Connector for CData Sync

BWConnections

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.

SAP BusinessObjects BI Connector for CData Sync

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

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.

SAP BusinessObjects BI Connector for CData Sync

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

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.

SAP BusinessObjects BI Connector for CData Sync

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

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.

SAP BusinessObjects BI Connector for CData Sync

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

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.

SAP BusinessObjects BI Connector for CData Sync

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

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.

SAP BusinessObjects BI Connector for CData Sync

ReportElements

Query report elements for a SAP Business Objects BI instance.

Select

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

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

Columns

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

SAP BusinessObjects BI Connector for CData Sync

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

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.

SAP BusinessObjects BI Connector for CData Sync

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

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.

SAP BusinessObjects BI Connector for CData Sync

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

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.

SAP BusinessObjects BI Connector for CData Sync

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

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.

SAP BusinessObjects BI Connector for CData Sync

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、SAP BusinessObjects BI の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSAP BusinessObjects BI から関連するレスポンスデータを返します。

SAP BusinessObjects BI Connector for CData Sync ストアドプロシージャ

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.

SAP BusinessObjects BI Connector for CData Sync

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

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.

SAP BusinessObjects BI Connector for CData Sync

ExportReport

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.

使用できる値は次のとおりです。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).

使用できる値は次のとおりです。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.

SAP BusinessObjects BI Connector for CData Sync

GetDocumentRefreshParameters

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.

デフォルト値はtrueです。

Summary Bool False Specifies if a summary of the previous values will be returned.

デフォルト値は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.

SAP BusinessObjects BI Connector for CData Sync

PurgeReport

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.

デフォルト値は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.

SAP BusinessObjects BI Connector for CData Sync

RefreshDocument

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.

使用できる値は次のとおりです。all, accessible

ListOfValuesInfo Bool False Specifies if the lists of values are computed and displayed.

デフォルト値はtrueです。

Refresh Bool False To avoid a data refresh at the end of the parameter workflow.

デフォルト値は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.

デフォルト値は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.

SAP BusinessObjects BI Connector for CData Sync

SaveDocument

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.

デフォルト値は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.

デフォルト値は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.

SAP BusinessObjects BI Connector for CData Sync

UpdateDocumentState

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.

SAP BusinessObjects BI Connector for CData Sync

UploadDocument

Uploads the specified document.

Input

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

Result Set Columns

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

SAP BusinessObjects BI Connector for CData Sync

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication


プロパティ説明
AuthSchemeThe authorization scheme to be used when server authorization is to be performed.
SchemaThe type of schema to use.
URLThe URL of the rest API exposed by the SAP BusinessObjects BI.
User認証するユーザーのユーザーID を指定します。
Password認証するユーザーのパスワードを指定します。

SSO


プロパティ説明
SSOLoginURLID プロバイダーのログインURL。
SSOPropertiesID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。
SSOExchangeURLSAML 応答を処理してサービスの資格情報と交換するために使用するURL。

SSL


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Firewall


プロパティ説明
FirewallTypeprovider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServerファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPortプロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUserプロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPasswordプロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy


プロパティ説明
ProxyAutoDetectprovider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServerHTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。
ProxyPortクライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAuthSchemeProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUserProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyPasswordProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxySSLTypeProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
ProxyExceptionsProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。

Logging


プロパティ説明
LogModulesログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

Schema


プロパティ説明
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesレポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Viewsレポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Miscellaneous


プロパティ説明
AddFolderPrefixSet whether to include the folder name as a prefix of the column name.
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
Other特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
PageSizeSpecifies how many records the SAP BusinessObjects BI will return on a single page.
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ServerTimezoneThe time zone configuration of your SAP Business Objects BI server. Example: GMT, EST etc.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UserDefinedViewsカスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
SAP BusinessObjects BI Connector for CData Sync

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。


プロパティ説明
AuthSchemeThe authorization scheme to be used when server authorization is to be performed.
SchemaThe type of schema to use.
URLThe URL of the rest API exposed by the SAP BusinessObjects BI.
User認証するユーザーのユーザーID を指定します。
Password認証するユーザーのパスワードを指定します。
SAP BusinessObjects BI Connector for CData Sync

AuthScheme

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

解説

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.

SAP BusinessObjects BI Connector for CData Sync

Schema

The type of schema to use.

解説

The available schemas are SAPBusinessObjectsBI, Administration and Reporting.

SAP BusinessObjects BI Connector for CData Sync

URL

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

解説

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.

SAP BusinessObjects BI Connector for CData Sync

User

認証するユーザーのユーザーID を指定します。

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

SAP BusinessObjects BI Connector for CData Sync

Password

認証するユーザーのパスワードを指定します。

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

SAP BusinessObjects BI Connector for CData Sync

SSO

このセクションでは、本プロバイダーの接続文字列で設定可能なSSO プロパティの全リストを提供します。


プロパティ説明
SSOLoginURLID プロバイダーのログインURL。
SSOPropertiesID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。
SSOExchangeURLSAML 応答を処理してサービスの資格情報と交換するために使用するURL。
SAP BusinessObjects BI Connector for CData Sync

SSOLoginURL

ID プロバイダーのログインURL。

解説

ID プロバイダーのログインURL。

SAP BusinessObjects BI Connector for CData Sync

SSOProperties

ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。

解説

ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。

SSOLoginURL と一緒に使用します。

SSO 設定については、 で詳しく説明します。

SAP BusinessObjects BI Connector for CData Sync

SSOExchangeURL

SAML 応答を処理してサービスの資格情報と交換するために使用するURL。

解説

CData Sync App はここで指定されたURL を使用してSAML 応答を処理し、サービスの資格情報と交換します。 取得した資格情報はSSO 接続時の最後の情報であり、SAP BusinessObjects BI との通信に使用されます。

SAP BusinessObjects BI Connector for CData Sync

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
SAP BusinessObjects BI Connector for CData Sync

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

解説

TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります:

説明 例
フルPEM 証明書(例では省略されています) -----BEGIN CERTIFICATE-----
MIIChTCCAe4CAQAwDQYJKoZIhv......Qw==
-----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。 C:\cert.cer
公開鍵(例では省略されています) -----BEGIN RSA PUBLIC KEY-----
MIGfMA0GCSq......AQAB
-----END RSA PUBLIC KEY-----
MD5 Thumbprint(hex 値はスペースまたはコロン区切り) ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint(hex 値はスペースまたはコロン区切り) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

SAP BusinessObjects BI Connector for CData Sync

Firewall

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。


プロパティ説明
FirewallTypeprovider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServerファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPortプロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUserプロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPasswordプロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
SAP BusinessObjects BI Connector for CData Sync

FirewallType

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。

プロトコル デフォルトポート 説明
TUNNEL 80 Sync App がSAP BusinessObjects BI への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4 1080 Sync App がSAP BusinessObjects BI への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5 1080 Sync App がSAP BusinessObjects BI にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

SAP BusinessObjects BI Connector for CData Sync

FirewallServer

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

SAP BusinessObjects BI Connector for CData Sync

FirewallPort

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

SAP BusinessObjects BI Connector for CData Sync

FirewallUser

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

SAP BusinessObjects BI Connector for CData Sync

FirewallPassword

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

SAP BusinessObjects BI Connector for CData Sync

Proxy

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。


プロパティ説明
ProxyAutoDetectprovider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServerHTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。
ProxyPortクライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAuthSchemeProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUserProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyPasswordProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxySSLTypeProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
ProxyExceptionsProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。
SAP BusinessObjects BI Connector for CData Sync

ProxyAutoDetect

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を構成する場合は、ProxyAutoDetect をFalse に設定します。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

SAP BusinessObjects BI Connector for CData Sync

ProxyServer

HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。

ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

SAP BusinessObjects BI Connector for CData Sync

ProxyPort

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。

ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

SAP BusinessObjects BI Connector for CData Sync

ProxyAuthScheme

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

サポートされる認証の種類:

  • BASIC:Sync App はHTTP Basic 認証を行います。
  • DIGEST:Sync App はHTTP ダイジェスト認証を行います。
  • NTLM:Sync App はNTLM トークンを取得します。
  • NEGOTIATE: Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
  • NONE:ProxyServer が認証を必要としないことを示します。

NONE 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

SAP BusinessObjects BI Connector for CData Sync

ProxyUser

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値 ProxyUser に設定する値
BASIC プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NTLM プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NONE ProxyPassword 接続プロパティは設定しないでください。

Note:Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

SAP BusinessObjects BI Connector for CData Sync

ProxyPassword

ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値 ProxyPassword に設定する値
BASIC ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE ProxyPassword 接続プロパティは設定しないでください。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

Note:Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

SAP BusinessObjects BI Connector for CData Sync

ProxySSLType

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。

AUTOデフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。
ALWAYS接続は、常にSSL 有効となります。
NEVER接続は、SSL 有効になりません。
TUNNEL接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

SAP BusinessObjects BI Connector for CData Sync

ProxyExceptions

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Note:Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。 この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

SAP BusinessObjects BI Connector for CData Sync

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。


プロパティ説明
LogModulesログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
SAP BusinessObjects BI Connector for CData Sync

LogModules

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

Sync App は、実行する各操作の詳細を Logfile 接続プロパティで指定されたログファイルに書き込みます。

ログに記録される各操作は、モジュールと呼ばれるカテゴリに分類されます。各モジュールには対応する短いコードがあり、個々の Sync App の操作がどのモジュールに属するかを示すラベルとして使用されます。

この接続プロパティにモジュールコードをセミコロン区切りのリストで設定すると、指定したモジュールに属する操作のみがログファイルに書き込まれます。この設定は今後のログ記録にのみ適用され、既存のログファイルの内容には影響しません。例: INFO;EXEC;SSL;META;

デフォルトでは、すべてのモジュールの操作がログに含まれます。

モジュールを明示的に除外するには、先頭に「-」を付けます。例: -HTTP

サブモジュールにフィルターを適用するには、<モジュール名>.<サブモジュール名> の構文で指定します。たとえば、次の値を設定すると、Sync App は HTTP モジュールに属するアクションのみをログに記録し、さらに HTTP モジュールの Res サブモジュールに属するアクションを除外します: HTTP;-HTTP.Res

Verbosity 接続プロパティによるログファイルのフィルタリングは、この接続プロパティによるフィルタリングよりも優先されます。そのため、Verbosity 接続プロパティで指定したレベルよりも高い詳細レベルの操作は、この接続プロパティで指定したモジュールに属していても、ログファイルには出力されません。

使用可能なモジュールとサブモジュールは次のとおりです。

モジュール名 モジュールの説明 サブモジュール
INFO 一般情報。接続文字列、製品バージョン(ビルド番号)、および初期接続メッセージが含まれます。
  • Connec — 接続の作成または破棄に関連する情報。
  • Messag — 接続、接続文字列、製品バージョンに関するメッセージの汎用ラベル。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。
EXEC クエリ実行。ユーザーが記述した SQL クエリ、解析済み SQL クエリ、正規化済み SQL クエリの実行メッセージが含まれます。クエリおよびクエリページの成功/失敗メッセージもここに表示されます。
  • Messag — クエリ実行に関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。
  • Normlz — クエリの正規化ステップ。クエリの正規化とは、ユーザーが送信したクエリを、最適なパフォーマンスで同じ結果を得られるように書き換える処理です。
  • Origin — ユーザーの元のクエリ(ユーザーが実行した正確で未変更の非正規化クエリ)を記録するメッセージに適用されるラベル。
  • Page — クエリのページングに関連するメッセージ。
  • Parsed — クエリの解析ステップ。解析とは、ユーザーが送信したクエリを、処理しやすい標準化された形式に変換するプロセスです。
HTTP HTTP プロトコルメッセージ。HTTP リクエスト/レスポンス(POST メッセージを含む)、および Kerberos 関連のメッセージが含まれます。
  • KERB — Kerberos に関連する HTTP リクエスト。
  • Messag — HTTP プロトコルに関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。
  • Unpack — サービス API から返された圧縮データを製品が解凍する際のメッセージに適用されるラベル。
  • Res — HTTP レスポンスを含むメッセージ。
  • Req — HTTP リクエストを含むメッセージ。
WSDL WSDL/XSD ファイルの生成に関するメッセージ。 —
SSL SSL 証明書メッセージ。
  • Certif — SSL 証明書に関するメッセージ。
AUTH 認証関連の失敗/成功メッセージ。
  • Messag — 認証に関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。
  • OAuth — OAuth 認証に関連するメッセージ。
  • Krbros — Kerberos 関連の認証メッセージ。
SQL SQL トランザクション、SQL 一括転送メッセージ、および SQL 結果セットメッセージが含まれます。
  • Bulk — 一括クエリ実行に関するメッセージ。
  • Cache — パフォーマンス向上のため、製品のキャッシュへの行データの読み書きに関連するメッセージ。
  • Messag — SQL トランザクションに関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。
  • ResSet — クエリの結果セット。
  • Transc — 実行されたジョブ数やバックアップテーブルの処理に関する情報を含む、トランザクション処理に関連するメッセージ。
META メタデータキャッシュとスキーマメッセージ。
  • Cache — パフォーマンス向上のため、製品のキャッシュ内のカラムおよびテーブル定義の読み取りと変更に関連するメッセージ。
  • Schema — サービススキーマからのメタデータの取得またはサービススキーマの変更に関連するメッセージ。
  • MemSto — インメモリメタデータキャッシュへの書き込みまたは読み取りに関連するメッセージ。
  • Storag — メモリ内ではなく、ディスクまたは外部データストアへのメタデータの保存に関連するメッセージ。
FUNC SQL 関数の実行に関連する情報。
  • Errmsg — SQL 関数の実行に関連するエラーメッセージ。
TCP TCP トランスポートレイヤーメッセージでの送受信生バイト。
  • Send — TCP プロトコル経由で送信された生データ。
  • Receiv — TCP プロトコル経由で受信した生データ。
FTP File Transfer Protocol に関するメッセージ。
  • Info — FTP プロトコルでの通信に関連するステータスメッセージ。
  • Client — FTP 通信中に FTP クライアント(製品)が実行したアクションに関連するメッセージ。
  • Server — FTP 通信中に FTP サーバーが実行したアクションに関連するメッセージ。
SFTP Secure File Transfer Protocol に関するメッセージ。
  • Info — SFTP プロトコルでの通信に関連するステータスメッセージ。
  • To_Server — SFTP 通信中に SFTP クライアント(製品)が実行したアクションに関連するメッセージ。
  • From_Server — SFTP 通信中に SFTP サーバーが実行したアクションに関連するメッセージ。
POP Post Office Protocol 経由で転送されるデータに関するメッセージ。
  • Client — POP 通信中に POP クライアント(製品)が実行したアクションに関連するメッセージ。
  • Server — POP 通信中に POP サーバーが実行したアクションに関連するメッセージ。
  • Status — POP プロトコルでの通信に関連するステータスメッセージ。
SMTP Simple Mail Transfer Protocol 経由で転送されるデータに関するメッセージ。
  • Client — SMTP 通信中に SMTP クライアント(製品)が実行したアクションに関連するメッセージ。
  • Server — SMTP 通信中に SMTP サーバーが実行したアクションに関連するメッセージ。
  • Status — SMTP プロトコルでの通信に関連するステータスメッセージ。
CORE 他のモジュールでカバーされていない、さまざまな製品内部操作に関連するメッセージ。 —
DEMN SQL リモーティングに関連するメッセージ。 —
CLJB 一括データアップロード(クラウドジョブ)に関するメッセージ。
  • Commit — 一括データアップロードの送信。
SRCE 他のモジュールに属さない、製品が生成するその他のメッセージ。 —
TRANCE 低レベルの製品操作に関する高度なメッセージ。 —

SAP BusinessObjects BI Connector for CData Sync

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。


プロパティ説明
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesレポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Viewsレポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
SAP BusinessObjects BI Connector for CData Sync

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\SAPBusinessObjectsBI Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:

プラットフォーム %APPDATA%
Windows APPDATA 環境変数の値
Linux ~/.config

SAP BusinessObjects BI Connector for CData Sync

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

SAP BusinessObjects BI Connector for CData Sync

Tables

レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。

解説

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

SAP BusinessObjects BI Connector for CData Sync

Views

レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

解説

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

SAP BusinessObjects BI Connector for CData Sync

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。


プロパティ説明
AddFolderPrefixSet whether to include the folder name as a prefix of the column name.
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
Other特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
PageSizeSpecifies how many records the SAP BusinessObjects BI will return on a single page.
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ServerTimezoneThe time zone configuration of your SAP Business Objects BI server. Example: GMT, EST etc.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UserDefinedViewsカスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
SAP BusinessObjects BI Connector for CData Sync

AddFolderPrefix

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

解説

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

SAP BusinessObjects BI Connector for CData Sync

MaxRows

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

SAP BusinessObjects BI Connector for CData Sync

Other

特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。

解説

このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

Note:特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

統合およびフォーマット

プロパティ説明
DefaultColumnSizeデータソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT=True日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換します。デフォルト値はFalse(ローカルタイムを使用)です。
RecordToFile=filename基底のソケットデータ転送を指定のファイルに記録します。

SAP BusinessObjects BI Connector for CData Sync

PageSize

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

解説

The default value changes based on the selected Schema.

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

SAP BusinessObjects BI Connector for CData Sync

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

解説

このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:

*=*

SAP BusinessObjects BI Connector for CData Sync

ServerTimezone

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

解説

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.

SAP BusinessObjects BI Connector for CData Sync

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

SAP BusinessObjects BI Connector for CData Sync

UserDefinedViews

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

UserDefinedViews を使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。

次に例を示します。

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

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 次に例を示します。

UserDefinedViews=C:\Path\To\UserDefinedViews.json
UserDefinedViews でビューを指定すると、Sync App はそのビューだけを参照します。

詳しくは、ユーザー定義ビュー を参照してください。

SAP BusinessObjects BI Connector for CData Sync

Third Party Copyrights

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.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9540