Cloud

Build 25.0.9434
  • SAP BusinessObjects BI
    • はじめに
      • 接続の確立
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • Universes データモデル
        • ストアドプロシージャ
      • 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
      • システムテーブル
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • 接続文字列オプション
      • Authentication
        • AuthScheme
        • Schema
        • URL
        • User
        • Password
      • SSO
        • SSOLoginURL
        • SSOProperties
        • SSOExchangeURL
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • AddFolderPrefix
        • MaxRows
        • PageSize
        • PseudoColumns
        • ServerTimezone
        • Timeout
    • Third Party Copyrights

SAP BusinessObjects BI - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるSAP BusinessObjects BI へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してSAP BusinessObjects BI に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、SAP BusinessObjects BI への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート:SAP BusinessObjects BI は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート:読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス:管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー:CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

このページでは、CData Cloud でのSAP BusinessObjects BI への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

SAP BusinessObjects BI への接続

接続の確立 は、CData Cloud にデータベースを作成するためのSAP BusinessObjects BI への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してSAP BusinessObjects BI からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

CData Cloud

接続の確立

Database タブで対応するアイコンを選択して、SAP BusinessObjects BI に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

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

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

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

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

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

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

CData Cloud

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

Firewall またはProxy 経由の接続

HTTP プロキシ

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

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

その他のプロキシ

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

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

CData Cloud

データモデル

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

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

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

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

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

CData Cloud

Universes データモデル

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

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

ビュー

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

例えば、EFashion という名前のユニバースがあるとしましょう。そして、それは次のオブジェクトを持っているとします:Year(ディメンション)、StoreName(ディメンション)、SalesRevenue(メジャー)、ThisYear(フィルタ)。 CData Cloud は、以下のカラムを持つ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 Cloud will raise an error stating that the query is ambiguous.

Custom Schemas

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

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

Supported Operators

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

Some examples:

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

CData Cloud

ストアドプロシージャ

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

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

CData Cloud - SAP BusinessObjects BI ストアドプロシージャ

Name Description

CData Cloud

Administration データモデル

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

CData Cloud

テーブル

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

CData Cloud - SAP BusinessObjects BI テーブル

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

ストアドプロシージャ

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

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

CData Cloud - SAP BusinessObjects BI ストアドプロシージャ

Name Description
CreateUser Create a user.

CData Cloud

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.

CData Cloud

Reporting データモデル

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

CData Cloud

テーブル

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

CData Cloud - SAP BusinessObjects BI テーブル

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

ReportComments

Query report comments for a SAP Business Objects BI instance.

Select

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

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

Insert

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

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

Update

The following examples illustrate how to update the ReportComments table.

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

Delete

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

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

Columns

Name Type ReadOnly Description
DocumentId [KEY] Integer False

The document ID.

ReportId [KEY] Integer False

The report ID.

Id [KEY] Integer True

The comment ID.

Value String False

The comment value.

ElementID String False

The comment element ID.

ElementReference String True

The comment element Reference.

Created Datetime True

The date time when the comment was created.

CreatedByName String True

The comment creator name.

CreatedByCUID String True

The comment creator CUID.

Updated Datetime True

The date time when the comment was last updated.

LastAuthorName String True

The comment last author name.

LastAuthorCUID String True

The comment last author CUID.

CData Cloud

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.

CData Cloud

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

CData Cloud

ビュー

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

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

CData Cloud - SAP BusinessObjects BI ビュー

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

ReportElements

Query report elements for a SAP Business Objects BI instance.

Select

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

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

Columns

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

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

ストアドプロシージャ

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

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

CData Cloud - SAP BusinessObjects BI ストアドプロシージャ

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

システムテーブル

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、SAP BusinessObjects BI のデータベースメタデータを返します。

  • sys_catalogs:利用可能なデータベースをリスト。
  • sys_schemas:利用可能なスキーマをリスト。
  • sys_tables:利用可能なテーブルおよびビューをリスト。
  • sys_tablecolumns:利用可能なテーブルおよびビューのカラムについて説明。
  • sys_procedures:利用可能なストアドプロシージャについて説明。
  • sys_procedureparameters:ストアドプロシージャパラメータについて説明。
  • sys_keycolumns:主キーおよび外部キーについて説明。
  • sys_indexes:利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

  • sys_connection_props:利用可能な接続プロパティについての情報を返す。
  • sys_sqlinfo:Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

  • sys_identity:バッチ処理または単一の更新に関する情報を返す。

CData Cloud

sys_catalogs

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String データベース名。

CData Cloud

sys_schemas

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String データベース名。
SchemaName String スキーマ名。

CData Cloud

sys_tables

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベース。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String テーブル名またはビュー名。
TableType String テーブルの種類(テーブルまたはビュー)。
Description String テーブルまたはビューの説明。
IsUpdateable Boolean テーブルが更新可能かどうか。

CData Cloud

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

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

CData Cloud

sys_procedures

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベース。
SchemaName String ストアドプロシージャを含むスキーマ。
ProcedureName String ストアドプロシージャの名前。
Description String ストアドプロシージャの説明。
ProcedureType String PROCEDURE やFUNCTION などのプロシージャのタイプ。

CData Cloud

sys_procedureparameters

ストアドプロシージャパラメータについて説明します。

次のクエリは、SampleProcedure ストアドプロシージャのすべての入力パラメータについての情報を返します。

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

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

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

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベースの名前。
SchemaName String ストアドプロシージャを含むスキーマの名前。
ProcedureName String パラメータを含むストアドプロシージャの名前。
ColumnName String ストアドプロシージャパラメータの名前。
Direction Int32 パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName String データ型の名前。
NumericPrecision Int32 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。
Length Int32 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale Int32 数値データの小数点以下の桁数。
IsNullable Boolean パラメータがNull を含められるかどうか。
IsRequired Boolean プロシージャの実行にパラメータが必要かどうか。
IsArray Boolean パラメータが配列かどうか。
Description String パラメータの説明。
Ordinal Int32 パラメータのインデックス。
Values String このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams Boolean パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath Boolean パラメータがスキーマ作成操作のターゲットパスかどうか。
Default String 何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName String 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided Boolean プロシージャがネイティブのSAP BusinessObjects BI プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

CData Cloud

sys_keycolumns

主キーおよび外部キーについて説明します。

次のクエリは、MyCustomReport テーブルの主キーを取得します。

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

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
IsKey Boolean カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey Boolean カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。

CData Cloud

sys_foreignkeys

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前 タイプ 説明
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。
ForeignKeyType String 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。

CData Cloud

sys_primarykeys

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前。
KeySeq String 主キーのシーケンス番号。
KeyName String 主キーの名前。

CData Cloud

sys_indexes

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String インデックスを含むデータベースの名前。
SchemaName String インデックスを含むスキーマの名前。
TableName String インデックスを含むテーブルの名前。
IndexName String インデックス名。
ColumnName String インデックスに関連付けられたカラムの名前。
IsUnique Boolean インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary Boolean インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type Int16 インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder String 並べ替え順序:A が昇順、D が降順。
OrdinalPosition Int16 インデックスのカラムのシーケンスナンバー。

CData Cloud

sys_connection_props

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String 接続プロパティ名。
ShortDescription String 簡単な説明。
Type String 接続プロパティのデータ型。
Default String 明示的に設定されていない場合のデフォルト値。
Values String 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value String 設定した値またはあらかじめ設定されたデフォルト。
Required Boolean プロパティが接続に必要かどうか。
Category String 接続プロパティのカテゴリ。
IsSessionProperty String プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity String プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName String キャメルケースの短縮形の接続プロパティ名。
Ordinal Int32 パラメータのインデックス。
CatOrdinal Int32 パラメータカテゴリのインデックス。
Hierarchy String このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible Boolean プロパティが接続UI に表示されるかどうかを通知します。
ETC String プロパティに関するその他のさまざまな情報。

CData Cloud

sys_sqlinfo

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前説明有効な値
AGGREGATE_FUNCTIONSサポートされている集計関数。AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTCOUNT 関数がサポートされているかどうか。YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR識別子をエスケープするための開始文字。[
IDENTIFIER_QUOTE_CLOSE_CHAR識別子をエスケープするための終了文字。]
SUPPORTED_OPERATORSサポートされているSQL 演算子。=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYGROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESサポートされている外部結合の種類。NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS外部結合がサポートされているかどうか。YES, NO
SUBQUERIESサブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSサポートされている文字列関数。LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSサポートされている数値関数。ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSサポートされている日付および時刻関数。NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESレプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNSレプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTIONプロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。YES, NO
DIALECT使用するSQL ダイアレクトを示します。
KEY_PROPERTIESUniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMASプロバイダー用に複数のスキームが存在するかどうかを示します。YES, NO
SUPPORTS_MULTIPLE_CATALOGSプロバイダー用に複数のカタログが存在するかどうかを示します。YES, NO
DATASYNCVERSIONこのドライバーにアクセスするために必要な、CData Sync のバージョン。Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYこのドライバーのCData Sync カテゴリ。Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLAPI で提供されている以上の、追加SQL 機能がサポートされているかどうか。TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSバッチ操作がサポートされているかどうか。YES, NO
SQL_CAPこのドライバーでサポートされているすべてのSQL 機能。SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERYドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。YES, NO
PSEUDO_COLUMNS利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。TRUE, FALSE
REPLICATION_MIN_DATE_QUERYレプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTIONサーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATEレプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERYレプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTIONサーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTIDCheckCache 構文を親キーカラムに対して実行するかどうかを示します。TRUE, FALSE
CREATE_SCHEMA_PROCEDURESスキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name Type Description
NAME String SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE String サポートされるSQL またはSQL 構文の詳細。

CData Cloud

sys_identity

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String データ変更処理から返された、データベース生成Id。
Batch String バッチの識別子。1 は単一処理。
Operation String バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。
Message String SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

CData Cloud

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductString製品名。
VersionString製品のバージョン番号。
DatasourceString製品が接続するデータソースの名前。
NodeIdString製品がインストールされているマシンの固有識別子。
HelpURLString製品のヘルプドキュメントのURL。
LicenseString製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。)
LocationString製品のライブラリが格納されているファイルパスの場所。
EnvironmentString製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersionString本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategoryStringCData Sync 機能のカテゴリ(例:Source、Destination)。

CData Cloud

接続文字列オプション

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

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 を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema


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

Miscellaneous


プロパティ説明
AddFolderPrefixSet whether to include the folder name as a prefix of the column name.
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
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 がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
CData Cloud

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認証するユーザーのパスワードを指定します。
CData Cloud

AuthScheme

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

Possible Values

Basic, Enterprise, LDAP, WinAD, CyberArk

データ型

string

デフォルト値

"Basic"

解説

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.

CData Cloud

Schema

The type of schema to use.

Possible Values

SAPBusinessObjectsBI, Administration, Reporting

データ型

string

デフォルト値

"SAPBusinessObjectsBI"

解説

The available schemas are SAPBusinessObjectsBI, Administration and Reporting.

CData Cloud

URL

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

データ型

string

デフォルト値

""

解説

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.

CData Cloud

User

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

Password

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

SSO

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


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

SSOLoginURL

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

SSOProperties

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

データ型

string

デフォルト値

""

解説

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

SSOLoginURL と一緒に使用します。

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

CData Cloud

SSOExchangeURL

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

SSL

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


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

SSLServerCert

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

Logging

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


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
CData Cloud

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

CData Cloud

Schema

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


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

BrowsableSchemas

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

Miscellaneous

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


プロパティ説明
AddFolderPrefixSet whether to include the folder name as a prefix of the column name.
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
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 がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
CData Cloud

AddFolderPrefix

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

データ型

bool

デフォルト値

false

解説

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

CData Cloud

MaxRows

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

データ型

int

デフォルト値

-1

解説

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

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

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

CData Cloud

PageSize

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

データ型

string

デフォルト値

""

解説

The default value changes based on the selected Schema.

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

CData Cloud

PseudoColumns

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

データ型

string

デフォルト値

""

解説

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

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

Table1=Column1;Table1=Column2;Table2=Column3

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

*=*

CData Cloud

ServerTimezone

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

データ型

string

デフォルト値

""

解説

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.

CData Cloud

Timeout

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

データ型

int

デフォルト値

60

解説

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

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

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

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

CData Cloud

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) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434