Microsoft Power BI XMLA Connector for CData Sync

Build 25.0.9540
  • Microsoft Power BI XMLA
    • 接続の確立
      • Entra ID でのサービスプリンシパルアプリの作成
      • OAuth の権限とエンドポイント
      • PowerBI データの取得
      • データアクセスのファインチューニング
      • 接続のトラブルシューティング
    • 高度な機能
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • ストアドプロシージャ
        • GetAdminConsentURL
        • GetOAuthAccessToken
        • GetOAuthAuthorizationUrl
        • RefreshOAuthAccessToken
    • 接続文字列オプション
      • Authentication
        • AuthScheme
      • Azure Authentication
        • AzureTenant
        • AzureEnvironment
        • PowerBIEnvironment
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • JWT OAuth
        • OAuthJWTCert
        • OAuthJWTCertType
        • OAuthJWTCertPassword
        • OAuthJWTCertSubject
      • SSL
        • SSLClientCert
        • SSLClientCertType
        • SSLClientCertPassword
        • SSLClientCertSubject
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
        • Catalog
        • IncludeJoinColumns
      • Miscellaneous
        • CustomHeaders
        • ExposeMemberKeys
        • ExpressionInDescription
        • ExtraProperties
        • MaxRows
        • Other
        • ResponseRowLimit
        • ShowHiddenEntities
        • SplitMeasures
        • SplitMeasuresOn
        • Timeout
        • UseMDX
        • UserDefinedViews
        • Workspace
    • Third Party Copyrights

Microsoft Power BI XMLA Connector for CData Sync

概要

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

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

Microsoft Power BI XMLA バージョンサポート

Sync App は、標準ドライバーでのMicrosoft Power BI XMLA への接続の複雑さを軽減します。SQL-92 クエリを実行したり、リレーショナルツールからMDX をパススルーしたりできます。

Microsoft Power BI XMLA Connector for CData Sync

接続の確立

Microsoft Power BI XMLA への接続を追加

Microsoft Power BI XMLA への接続を追加するには:

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

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

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

Microsoft Power BI XMLA への接続

Microsoft Power BI XMLA への接続を確立するには、主に3つのステップがあります。

  1. ご利用の環境に応じて、適切な認証方法を選択します。
  2. 必要な接続プロパティ(トークン、シークレット、証明書など)を設定します。
  3. 対象のPower BI ワークスペースを設定します。

重要: Power BI Premium 容量でホストされているワークスペースのみがサポートされます。 ワークスペースがPremium 容量でない場合、接続は失敗します。これをPower BI で確認するには、ブラウザでワークスペースを開き、ワークスペース名の横にあるダイヤモンドのアイコンを探してください。 これは、Premium 容量に対応したワークスペースを識別するための、Power BI ユーザーインターフェースに組み込まれたインジケータです。アイコンが表示されていない場合、そのワークスペースはXMLA 接続に対応していません。詳細はPower BI ライセンスの種類 を参照してください。

ステップ1:認証方法の選択

AuthScheme プロパティを設定して、導入シナリオに適した認証フローを選択してします。サポートされている値には、次のものが含まれます。

  • AzureAD – 対話型のユーザーベースのログインフロー向け。
    • デスクトップアプリケーション、開発環境、またはユーザーがブラウザを介して認証するシナリオに最適です。
    • 組み込みOAuth アプリケーションをサポートし、セットアップを簡素化します。ただし、組織で高度なセキュリティポリシーが必要な場合や、登録済みのリダイレクトURI が必要なWeb ベースのソリューションを展開する場合は、代わりにカスタムアプリを使用してください。
    • この認証方法を使用するためにカスタムOAuth アプリケーションを登録するには、Entra ID(Azure AD)アプリケーションの作成 を参照してください。
  • AzureServicePrincipal – クライアントID とシークレットを使用した、ヘッドレスなサービス間認証向け。
    • CI/CD パイプライン、バックグラウンドサービス、自動化されたワークフローに最適です。
    • この方法では、カスタムOAuth アプリケーションと、安全に保管されたクライアント資格情報が必要です。
    • 重要: Power BI 管理者は、Power BI 管理ポータルのテナント設定 -> 開発者向け設定でサービスプリンシパル認証を有効にする必要があります。
      • これは、組織全体で有効にすることも、特定のセキュリティグループに制限することもできます(きめ細かな制御を行う場合に推奨)。
      • Entra アプリの登録には、追加のAPI 権限や OAuth スコープは必要ありません。アクセスは、Power BI 管理者の設定とワークスペースのロールの割り当てによって制御されます。
    • この方法を使用するためにカスタムOAuth アプリケーションを登録し、クライアント資格情報を構成するには、Entra ID でのサービスプリンシパルアプリの作成 を参照してください。
  • AzureServicePrincipalCert – セキュアまたは規制された環境における証明書ベースの認証向け。
    • コンプライアンス要件が厳しいセキュリティ重視の環境での長時間実行されるジョブに最適です。
    • この方法では、カスタムOAuth アプリケーションと有効なクライアント証明書が必要です。
    • 重要: Power BI 管理者は、Power BI 管理ポータルのテナント設定 -> 開発者向け設定でサービスプリンシパル認証を有効にする必要があります。
      • これは、組織全体で有効にすることも、特定のセキュリティグループに制限することもできます(きめ細かな制御を行う場合に推奨)。
      • Entra アプリの登録には、追加のAPI 権限や OAuth スコープは必要ありません。アクセスは、Power BI 管理者の設定とワークスペースのロールの割り当てによって制御されます。
    • カスタムOAuth アプリケーションを登録してクライアント証明書をアップロードするには、Entra ID でのサービスプリンシパルアプリの作成 を参照してください。

Note: Power BI ワークスペースと登録されたサービスプリンシパルは、同じMicrosoft Entra テナントに属している必要があります。XMLA 接続は、クロステナントアクセスをサポートしていません。

ステップ2:必要な接続プロパティの設定

AuthScheme を設定した後、選択した認証方法に必要な接続プロパティを設定します。 これらのプロパティは、ドライバーが安全に認証を行い、Microsoft Entra ID(旧称:Azure Active Directory)からアクセストークンを取得できるようにします。 使用するOAuth アプリケーションが埋め込み型かカスタムか、またユーザー資格情報、クライアントシークレット、または証明書のいずれで認証するかによって、必要なプロパティの内容は異なります。

Note:AzureAD 認証の場合、組み込みOAuth アプリケーションは、必要なDelegated アクセス許可を自動的に要求します。 カスタムOAuth アプリケーションを登録する場合は、Microsoft Entra ID でDelegated アクセス許可Dataset.Read.All とWorkspace.Read.All を追加します。 サービスプリンシパル認証では、API のアクセス許可を追加する必要はありません。アクセスは、Power BI 管理者の設定とワークスペースのロールの割り当てによって完全に制御されます。

ステップ3:対象のPower BI ワークスペースの設定

認証の設定が完了したら、Workspace プロパティを設定して、接続したいMicrosoft Power BI ワークスペースを指定します。 Power BI Premium 容量でホストされているワークスペースのみがサポートされます。 ワークスペースがPremium 容量でない場合、接続は失敗します。

Power BI でワークスペースを開くことで、そのワークスペースの容量を確認できます。 ワークスペース名の横にあるダイヤモンドのアイコンを探してください。これは、そのワークスペースがPremium 容量に割り当てられていることを示しています。

詳細はPower BI ライセンスの種類 を参照してください。

重要:サービスプリンシパルは、XMLA エンドポイントにアクセスするために、対象ワークスペースで少なくともMember ロールを持っている必要があります。Admin アクセスはオプションであり、必須ではありません。

Entra ID(Azure AD)

Note:Microsoft はAzure AD をEntra ID にリブランドしました。ユーザーがEntra ID 管理サイトを操作する必要があるトピックでは、Microsoft が使用している名称と同じものを使用します。ただし、名前または値が"Azure AD" を参照しているCData 接続プロパティは、依然として存在します。

Microsoft Entra ID は、マルチテナント型のクラウドベースのID およびアクセス管理プラットフォームです。 OAuth ベースの認証フローに対応しており、ドライバーによるMicrosoft Power BI XMLA エンドポイントへのセキュアなアクセスを実現します。

Web アプリケーションを介したEntra ID への認証には、必ずはじめにカスタムOAuth アプリケーションを作成して登録する必要があります。 これにより、アプリケーションは独自のリダイレクトURI を定義し、クレデンシャルのスコープを管理し、組織固有のセキュリティポリシーに準拠することができるようになります。

カスタムOAuth アプリケーションの作成および登録方法の詳細については、Entra ID(Azure AD)アプリケーションの作成 を参照してください。

AuthScheme をAzureAD に設定した後の認証手順は、環境によって異なります。 デスクトップアプリケーション、Web ベースのワークフロー、またはヘッドレスシステムから接続する方法の詳細については、以下のセクションを参照してください。

Azure サービスプリンシパル

Note:Microsoft はAzure AD をEntra ID にリブランドしました。ユーザーがEntra ID 管理サイトを操作する必要があるトピックでは、Microsoft が使用している名称と同じものを使用します。ただし、名前または値が"Azure AD" を参照しているCData 接続プロパティは、依然として存在します。

サービスプリンシパルは、Microsoft Entra ID(Azure AD)アプリケーション内のセキュリティオブジェクトであり、そのアプリケーションが特定のテナント内で何を行えるかを定義します。 サービスプリンシパルはEntra 管理センターで作成でき、Azure ポータルからもアクセス可能です。 作成プロセスの過程で、サービスプリンシパルがクライアントシークレットまたは証明書のどちらを経由してEntra リソースにアクセスするかも指定します。

接続先のサービスによっては、テナント管理者がサービスプリンシパル認証を有効にするか、サービスプリンシパルを適切なロールまたはセキュリティグループに割り当てる必要があります。

サービスプリンシパルの権限は、特定のユーザーに紐づくのではなく、割り当てられたロールに基づきます。 これらのロールは、アプリケーションがアクセスできるリソースと、実行できる操作を決定します。

サービスプリンシパルを使用して認証する場合、Entra ID でのサービスプリンシパルアプリの作成 で説明するようにEntra テナントにアプリケーションを登録する必要があります。

このサブセクションでは、接続前に設定する必要があるプロパティについて説明します。 これらは、クライアントシークレットで認証するか、証明書で認証するかによって異なります。

クライアントシークレットによる認証

  • AuthScheme:AzureServicePrincipal。
  • AzureTenant:接続するAzure AD テナント。
  • OAuthClientId:アプリケーション設定のクライアントID。
  • OAuthClientSecret:アプリケーション設定のクライアントシークレット。
  • InitiateOAuth:GETANDREFRESH。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。

証明書による認証

  • AuthScheme:AzureServicePrincipalCert。
  • AzureTenant:接続するAzure AD テナント。
  • OAuthClientId:アプリケーション設定のクライアントId。
  • OAuthJWTCert:JWT 証明書のストア。
  • OAuthJWTCertType:JWT 証明書ストアの種類。
  • InitiateOAuth:GETANDREFRESH。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。

接続のトラブルシューティング

よくあるエラーやセットアップの問題については、接続のトラブルシューティング を参照してください。

Microsoft Power BI XMLA Connector for CData Sync

Entra ID でのサービスプリンシパルアプリの作成

Entra ID(Azure AD)でのサービスプリンシパルアプリの作成

Note:Microsoft はAzure AD をEntra ID にリブランドしました。ユーザーがEntra ID 管理サイトを操作する必要があるトピックでは、Microsoft が使用している名称と同じものを使用します。ただし、名前または値が"Azure AD" を参照しているCData 接続プロパティは、依然として存在します。

Microsoft Power BI XMLA はサービスプリンシパルベースの認証をサポートしており、これはロールベースです。 つまり、サービスプリンシパルの権限は、割り当てられたロールによって決まります。 ロールは、サービスプリンシパルがアクセスできるリソースと実行可能な操作を指定します。

Microsoft Power BI XMLA に対してサービスプリンシパルを使用して認証を行いたい場合は、Microsoft Entra ID でカスタムアプリケーションを作成する必要があります。

サービスプリンシパル認証を有効にするには:

  • テナント内でアプリケーションの登録とロールの割り当てを行う権限があることを確認します。
  • Entra 管理センターで新しいアプリケーションを登録し、認証情報とアクセス許可を構成してください。

アプリケーションの登録

  1. https://portal.azure.com に移動します。
  2. 左側のナビゲーションペインでMicrosoft Entra ID ->アプリの登録を選択します。
  3. 新規登録をクリックします。
  4. アプリケーションの名前を入力します。
  5. 希望するテナント設定を選択します。このカスタムアプリケーションはサービスプリンシパル用であるため、任意のMicrosoft Entra ID テナント - マルチテナントを選択します。

  6. 登録をクリックします。アプリケーション管理画面が開きます。OAuthClientId としてアプリケーション(クライアント)ID の値、AzureTenant としてディレクトリ(テナント)ID の値をメモします。

  7. For AzureAD (user-based authentication), no additional API permissions are required when using the embedded OAuth application because the necessary Delegated permissions are preconfigured and requested automatically. If you register a custom OAuth application, add the Delegated permissions Dataset.Read.All and Workspace.Read.All in Microsoft Entra ID. For Service Principal authentication, no API permissions are required because access is controlled through Power BI Admin settings and workspace role assignments.
  8. 証明書とシークレットセクションに移動して、アプリケーションの認証タイプを定義します。証明書(推奨)とクライアントシークレットの2種類の認証方法が利用可能です。

    • 証明書による認証: 証明書とシークレットで証明書のアップロードを選択し、ローカルマシンから証明書をアップロードします。 自己署名証明書の作成についての詳細は、自己署名証明書の作成 を参照してください。
    • 新しいクライアントシークレットの作成: 証明書とシークレットで新しいクライアントシークレットを選択し、有効期限を指定します。クライアントシークレットが保存されると、Microsoft Power BI XMLA はキーの値を表示します。この値は一度しか表示されないので、後で使用するために記録しておきます。この値をOAuthClientSecret に使用します。

  9. 認証に移動し、アクセストークンオプションを選択します。
  10. 変更を保存します。

クライアント資格情報の同意

OAuth は、認証のためのクライアント資格情報の使用をサポートします。 クライアント資格情報の認証フローでは、認証するアプリケーション自身の資格情報が作成されます。 認証フローは通常の認証フローと同じように動作しますが、関連するユーザーに対して資格情報の提供を求めるプロンプトは表示されません。 アプリケーションで受理されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。

Note: 埋め込まれたOAuth 資格情報はユーザーごとに認証されるため、 クライアント認証フローで使用することはできません。クライアント資格情報を使用するには、必ずカスタムOAuth アプリケーションを作成する必要があります。

  1. https://portal.azure.com にログインします。
  2. 前述のように、カスタムOAuth アプリケーションを作成します。
  3. アプリの登録に移動します。
  4. 作成したアプリケーションを探し、API のアクセス許可を開きます。
  5. Microsoft Graph アクセス許可を選択します。アクセス許可には2つの異なるアクセス許可セットがあります。委任されたアクセス許可とアプリケーションの許可です。
  6. サービスプリンシパルで使用する場合は、アプリケーションの許可を指定します。
  7. インテグレーションに必要な追加のアクセス許可を選択します。

証明書を使用したクライアントOAuth フロー

クライアント認証フローに関連するすべてのアクセス許可には、管理者の同意が必要です。 これは、CData Sync App が埋め込まれたアプリケーションをクライアント認証フローでは使用できないことを意味します。 前述のとおり、クライアント資格情報を使用するには、独自のOAuth アプリケーションの作成が必要になります。

OAuth アプリケーションが作成されたら:

  1. https://portal.azure.com に戻ります。
  2. アプリの登録に移動します。
  3. 作成したアプリケーションを見つけます。
  4. API のアクセス許可の下で、Microsoft Graph アクセス許可を選択します。
    アクセス許可には2つの異なるアクセス許可セットがあります。 委任されたアクセス許可とアプリケーションの許可です。 クライアントの資格情報認証時に使用されるアクセス許可は、アプリケーションの許可の下にあります。
  5. 自身のインテグレーションに適用させるアクセス許可を選択します。

Microsoft Power BI XMLA Connector for CData Sync

OAuth の権限とエンドポイント

Required Permissions and Endpoint Domains for Microsoft Power BI XMLA

When integrating with Microsoft Power BI XMLA, your application needs specific permissions to interact with the API. This topic provides information about the required OAuth permissions and endpoint domains for the Microsoft Power BI XMLA Sync App.

Understanding Permissions

Microsoft Power BI XMLA uses different permission models depending on the authentication method:

  • User-based authentication (AzureAD): The embedded OAuth application automatically requests the required Delegated permissions. If you register a custom OAuth application, you must add the Delegated permissions Dataset.Read.All and Workspace.Read.All in Microsoft Entra ID.
  • Service Principal authentication (AzureServicePrincipal or AzureServicePrincipalCert): No API permissions are required in Microsoft Entra ID. Access is controlled through Power BI Admin settings and workspace role assignments.

Required Permissions for Microsoft Power BI XMLA

If you register a custom OAuth application for AzureAD authentication, add the following Delegated permissions in Microsoft Entra ID:

Permission Type Description
Dataset.Read.All Delegated Grants the app permission to read datasets in all workspaces accessible to the signed-in user..
Workspace.Read.All Delegated Grants the app permission to read metadata for all workspaces accessible to the signed-in user.

Understanding Endpoint Domains

Endpoint domains are the specific URLs that the application needs to communicate with in order to authenticate, retrieve records, and perform other essential operations. Allowlisting these domains ensures that the network traffic between your application and the API is not blocked by firewalls or security settings.

Note: Most users do not need to make any special configurations. Allowlisting is typically only necessary for environments with strict security measures, such as restricted outbound network traffic.

Required Endpoint Domains for Microsoft Power BI XMLA

Domain Always Required Description
api.powerbi.com FALSE If AzureEnvironment=GLOBAL (default)
api.powerbigov.us FALSE If AzureEnvironment=USGOVT
api.high.powerbigov.us FALSE If AzureEnvironment=USGOVTHIGH
api.mil.powerbigov.us FALSE If AzureEnvironment=USGOVTDOD
*.pbidedicated.windows.net FALSE If AzureEnvironmnet=GLOBAL (default); the exact cluster used (added in the *) is determined by calling the api.powerbi.com
*.pbidedicated.usgovcloudapi.net FALSE If AzureEnvironment=USGOVT, USGOVTHIGH, or USGOVTDOD; the exact cluster used (added in the *) is determined by calling the api.* endpoint
login.microsoftonline.com FALSE If AzureEnvironment=GLOBAL (default)
login.microsoftonline.us FALSE If AzureEnvironment=USGOVT, USGOVTHIGH, or USGOVTDOD

Microsoft Power BI XMLA Connector for CData Sync

PowerBI データの取得

Microsoft Power BI XMLA は、データをキューブとして公開するOLAP データベースで、MDX(マルチディメンション式)でクエリします。 Sync App は、これらのキューブをSQL-92 でクエリできるリレーショナルビューにモデル化します。以下のマッピングは、モデルのレイアウト用です:

  • Catalog - Sync App にカタログとして表示されます。
  • Cube - Sync App にスキーマとして表示されます。
  • Measure - Sync App の特別なMeasures ビューの下で利用可能です。
  • Dimension - 各ディメンションはビューとして公開されます。
  • Level - 階層の個々のレベルは、適切なディメンションビューのカラムとして公開されます。

メジャーとディメンションの結合

特定のレベル値ごとにメジャーを取得するには、Measure ビューと任意のDimension もしくはディメンションのセット間でJOIN を発行します。 例えば、次のように発行すると、各都市の顧客数を取得できます。

SELECT m.[Customer Count], c.[City] 
FROM [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Customer AS c 
INNER JOIN [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Measures AS m

ON 条件は必要ないことに注意してください。これは、テーブルがMicrosoft Power BI XMLA ですでに適切に関連付けられているためです。 ON 条件を必要とするツールを使用している場合は、IncludeJoinColumns をtrue に設定してください。 これにより、各ビューに複数の外部キーカラムが追加され、相互に関連付けられます。 これらのカラムはそれ自体ではデータを返しませんが、必要に応じて結合のON 条件を構築するツールを使用して自動的に取得できます。

データの集計

Microsoft Power BI XMLA に格納されているデータはすでに集計済みです。多くの場合、集計を取得しようとすることは、何も指定しないことと構文的に同じになるかもしれません。 例えば、次のクエリは、前のクエリとまったく同じデータを返します。

SELECT SUM(m.[Customer Count]), c.[City] 
FROM [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Customer AS c 
INNER JOIN [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Measures AS m
GROUP BY c.[City]

このルールの例外は、フィルタリングされた結果の集計がリクエストされた場合です。 そのような場合、計算はMicrosoft Power BI XMLA からリクエストされます。例えば、 フランスとドイツの顧客の合計と平均を計算するには:

SELECT SUM(m.[Customer Count]), AVG(m.[Customer Count]), c.[Country] 
FROM [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Customer AS c 
INNER JOIN [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Measures AS m
WHERE c.[Country] IN ('France', 'Germany')
GROUP BY c.[Country]

複数の階層の選択

Microsoft Power BI XMLA では、個々のディメンジョンは、1つ以上のレベルを持つ階層で構成されています。例えば、 AdventureWorks Customers テーブルにはCity、Country およびGender があります。City とCountry は同じ階層の一部ですが、 Gender は独自の階層です。

複数の階層を選択する場合、これをサポートする方法はMDX の値をクロス結合することです。Sync App が提示するデータのリレーショナルテーブルモデルからは明らかではありませんが、これにより非常に負荷の高いクエリが実行される可能性があります。 例えば、次のように実行すると:

SELECT c.[Country], m.[Customer Count]
FROM [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Customer AS c 
INNER JOIN [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Measures AS m

結果は6行になります。しかし、Gender も選択すると:

SELECT c.[Country], c.[Gender], m.[Customer Count]
FROM [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Customer AS c 
INNER JOIN [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Measures AS m

結果は12行になります。これは、Gender とCountry が異なる階層にあるため、両方一緒に返すにはクロス結合が必要だからです。 SELECT に追加された各階層は、その階層で利用可能な値の数で合計結果を乗算します。 したがって、期待する行数を取得するには、次のように実行します:

SELECT (COUNT(c.[Country])*COUNT(c.[Gender])) AS totalrows
FROM [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Customer AS c 

応答行の制限

複数の階層を選択すると、結果行の合計数が倍になるため、応答行の数が非常に速く膨らみタイムアウトが発生します。 どのクエリが非常に高負荷になるかをある程度可視化するために、理想的な設定に導くメカニズムとしてResponseRowLimit 接続プロパティが追加されました。 設定すると、クエリが実行される前に予想される行数が計算されます。 予想された行の数が制限を超えると、クエリで予想される行数を表示するエラーがスローされます。

必要なカラムのみを選択するか、WHERE 条件を適用することをお勧めします。どちらも応答行の数を大幅に減らすことができ、パフォーマンスに大きな影響を与えます。 Sync App に精通していて、どのクエリが高負荷になる可能性があるかをすでにお分かりの場合は、ResponseRowLimit を0に設定することで無効にできます。

Microsoft Power BI XMLA Connector for CData Sync

データアクセスのファインチューニング

データアクセスのファインチューニング

以下は、データ接続をよりきめ細かく制御できるプロパティです。

  • UseMDX:MDX クエリが送信されているかどうかを示します。デフォルトではこれはfalse で、ドライバーはSQL-92 準拠のクエリのみを受け入れます。

    このプロパティをtrue に設定すると、すべてのクエリが直接Microsoft Power BI XMLA に渡されます。

  • ExtraProperties:MDX クエリと併せて送信する追加のプロパティ。UseMDX がtrue の場合にのみ意味があります。
  • IncludeJoinColumns:結合でON 条件を作成するために使用される余分なカラムを追加する必要があるかどうかを示すboolean。

    これらは値を返しません。結合を作成するときにテーブル間のリレーションシップを自動的に設定するために、それらを必要とするツールを有効にするために純粋に追加されています。

  • ResponseRowLimit:エラーを返す前にユーザーが選択できるように、計算上の行数の制限を設定します。

    クエリはMDX に変換されているため、少数のカラムのみを選択すると、期待される結果の数が指数関数的に倍になることがあります。

    このため、ResponseRowLimit はどのタイプのクエリがタイムアウトになる可能性が高いかについて、いくつかのガイダンスを提供するために利用できます。 0に設定すると無効にできます。

Microsoft Power BI XMLA Connector for CData Sync

接続のトラブルシューティング

認証には成功しているのにデータが返されない場合、またはメタデータやワークスペースへのアクセス時にエラーが発生する場合は、以下の点を確認してください。

データセットのプレビューが空白、またはテーブルが返されない場合

  • AzureTenant の値が正しいか確認してください。この値は、Power BI ワークスペースが存在するテナントID(GUID または確認済みドメイン)と一致している必要があります。
  • Power BI ワークスペースがPremium 容量に割り当てられていることを確認してください。Premium でないワークスペースは、XMLA エンドポイント経由ではアクセスできません。
  • サービスプリンシパルを使用する場合は、そのワークスペースの管理者(Admin)として割り当てられている必要があります。Viewer やContributor ロールでは不十分です。

OAuth トークンのリフレッシュに関する問題

  • トークンの有効期限切れに関するエラーが発生した場合は、初回のトークン交換後にInitiateOAuth がREFRESH に設定されていることを確認してください。
  • 特にヘッドレス環境では、OAuthSettingsLocation がドライバーの読み書き可能なファイルを指していることを確認してください。
  • リフレッシュトークンは、有効期限が切れたり、取り消されたりする場合があります。その場合は、OAuth フロー全体を再実行する必要があります。

管理者の同意がない、またはアクセス許可の構成ミス

  • Entra 管理センターのAPI のアクセス許可セクションで、アプリケーションのアクセス許可を確認してください。
  • アプリがアプリケーションのアクセス許可を使用する場合、管理者によるテナント全体への同意が必要です。。
  • 必要なアクセス許可(Dataset.Read.All)が不足していたり、アクセス許可の種類(委任されたアクセス許可とアプリケーションのアクセス許可)が誤っていると、エラーが表示されずに失敗することがあります。

Azure テナントの問題

  • テナントID が欠落しているか誤っている場合、認証には成功してもデータが取得できないことがあります。
  • GUID またはテナントの確認済みドメイン名のいずれかを使用できますが、ワークスペースがホストされているテナントと一致している必要があります。

アクセス許可の反映に時間がかかる場合

  • ロール(ワークスペースへのサービスプリンシパルのアクセスなど)を割り当てた後、アクセス許可が反映されるまでに数分かかることがあります。
  • アプリが登録または更新されたばかりの場合は、数分待ってから接続を再試行してください。

Microsoft Power BI XMLA Connector for CData Sync

高度な機能

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

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

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

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

ログ

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

Microsoft Power BI XMLA Connector for CData Sync

SSL の設定

SSL 設定のカスタマイズ

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

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

Microsoft Power BI XMLA 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 に設定します。

Microsoft Power BI XMLA Connector for CData Sync

データモデル

CData Sync App は、ディメンションをテーブル、キューブをスキーマとしてモデル化し、ワークスペースとデータセットカタログの組み合わせをカタログとしてモデル化します。 これらのオブジェクトへのライブ接続により、Sync App を使用するとMicrosoft Power BI XMLA アカウントへのあらゆる変更が即座に反映されます。

Notes:

  • Sync App を複数のワークスペースに同時に接続するには、Workspace プロパティにカンマ区切りのワークスペースのリストを指定します。その結果、各ワークスペースはカタログにWorkspaceName_CatalogName として表示されます。

  • Sync App はドキュメント、フォルダ、およびグループなどのMicrosoft Power BI XMLA エンティティをリレーショナルビューとしてモデル化し、SQL を記述してMicrosoft Power BI XMLA データをクエリできるようにします。

メジャー属性

デフォルトでは、すべてのメジャー属性が'Measures' ビューにリストされます。ただし、SplitMeasures を'true' に設定することでMeasures ビューを分割できます。その結果、各メジャー属性はメジャーグループの値に基づいてそれぞれのビューに含まれます。'Measure Directories' に基づくさらなる分類は含まれていません。

ストアドプロシージャ

ストアドプロシージャ は、SQLクエリを介して呼び出されるアクションです。標準的なCRUD 操作だけでなく、ドキュメントのダウンロードやエンベロープの移動など、より高度なタスクも実行します。

Microsoft Power BI XMLA Connector for CData Sync

ストアドプロシージャ

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

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

Microsoft Power BI XMLA Connector for CData Sync ストアドプロシージャ

Name Description
GetAdminConsentURL Retrieves the admin consent URL, which must be opened by an administrator of the specified domain to grant your application access. This is required only when using custom OAuth credentials.

Microsoft Power BI XMLA Connector for CData Sync

GetAdminConsentURL

Retrieves the admin consent URL, which must be opened by an administrator of the specified domain to grant your application access. This is required only when using custom OAuth credentials.

Input

Name Type Required Description
CallbackUrl String False The URL where the user is redirected after authorizing the application. Must match the Reply URL specified in the Azure AD app settings.
State String False A value sent with the authorization request to maintain the state between the request and callback. Recommended for security purposes.

Result Set Columns

Name Type Description
URL String The admin consent URL that an administrator must open in a browser to authorize the application and generate the verifier token.

Microsoft Power BI XMLA Connector for CData Sync

GetOAuthAccessToken

Fetches the OAuth Access Token, which is used to authenticate and authorize API calls made to Power BI XMLA.

Input

Name Type Required Description
AuthMode String False The type of authentication you are attempting. Use App for a Windows application, or Web for Web-based applications.

デフォルト値はAPPです。

Verifier String False A verifier returned by the service that must be input to return the access token. Needed only when using the Web auth mode. Obtained by navigating to the URL returned in GetOAuthAuthorizationUrl.
CallbackUrl String False The URL the user will be redirected to after authorizing your application.
State String False This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to Dynamics authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
Prompt String False Defaults to 'select_account' which prompts the user to select account while authenticating. Set to 'None', for no prompt, 'login' to force user to enter their credentials or 'consent' to trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app.

Result Set Columns

Name Type Description
OAuthAccessToken String The OAuth Access Token.
OAuthRefreshToken String A token that may be used to obtain a new access token.
ExpiresIn String The remaining lifetime on the access token.

Microsoft Power BI XMLA Connector for CData Sync

GetOAuthAuthorizationUrl

Retrieves the OAuth authorization URL, allowing the client to direct the user's browser to the authorization server and initiate the OAuth process.

Input

Name Type Required Description
CallbackURL String False The URL the user will be redirected to after authorizing your application.
State String False This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to Dynamics authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
Prompt String False Defaults to 'select_account' which prompts the user to select account while authenticating. Set to 'None', for no prompt, 'login' to force user to enter their credentials or 'consent' to trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app.

Result Set Columns

Name Type Description
Url String The authorization url that will need to be opened for the user to authorize your app.

Microsoft Power BI XMLA Connector for CData Sync

RefreshOAuthAccessToken

Refreshes an expired OAuth access token to maintain continuous authenticated access to Power BI XMLA resources without requiring reauthorization from the user.

Input

Name Type Required Description
OAuthRefreshToken String True The refresh token returned from the original authorization code exchange.

Result Set Columns

Name Type Description
OAuthAccessToken String The new OAuth Access Token returned from the service.
OAuthRefreshToken String A token that may be used to obtain a new access token.
ExpiresIn String The remaining lifetime on the access token.

Microsoft Power BI XMLA Connector for CData Sync

接続文字列オプション

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

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

Authentication


プロパティ説明
AuthSchemeThe type of authentication to use when connecting to Microsoft Power BI XMLA.

Azure Authentication


プロパティ説明
AzureTenantデータにアクセスするために使用されているMicrosoft Power BI XMLA テナントを識別します。テナントのドメイン名(例: contoso.onmicrosoft.com )またはディレクトリ(テナント)ID のいずれかを受け付けます。
AzureEnvironmentThe Azure Environment to use when establishing a connection.
PowerBIEnvironmentSpecifies the PowerBI environment to use for API requests.

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

JWT OAuth


プロパティ説明
OAuthJWTCertクライアント証明書のJWT 証明書ストアの名前を指定します。
OAuthJWTCertTypeJWT 証明書を格納しているキーストアの種類を指定します。
OAuthJWTCertPasswordパスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubjectストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。

SSL


プロパティ説明
SSLClientCertSSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。
SSLClientCertTypeSSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。
SSLClientCertPasswordTLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。
SSLClientCertSubjectTLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。
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 です。
CatalogSpecifies the Power BI workspace and dataset to use, combined into a single catalog name. For example, MyWorkspace_MyDataset. Leave this blank to search across all available workspaces and datasets.
IncludeJoinColumnsEnable this property to add extra join columns to each table. These columns reference foreign keys for use in ON conditions when performing joins.

Miscellaneous


プロパティ説明
CustomHeaders他のプロパティ(ContentType やFrom など)から作成されたリクエストヘッダーに追加する、追加HTTP ヘッダーを指定します。このプロパティは、特殊または非標準のAPI 用にリクエストをカスタマイズするために使用します。
ExposeMemberKeysEnable this property to convert each level into a measure, which is a numeric value that supports calculations like summing, averaging, and other aggregations. By default, levels remain as String types, so they do not support direct calculations.
ExpressionInDescriptionEnable this property to append measure expressions in the descriptions of measure columns. By default, the provider includes only remarks in measure column descriptions.
ExtraPropertiesSpecifies additional properties to include in each MDX request sent to Microsoft Power BI XMLA. Use this property to customize the PropertiesList of the XMLA request when UseMDX is enabled.
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
Other特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
ResponseRowLimitSpecifies the maximum number of response rows allowed before triggering an error. Use 0 to remove the limit entirely. This property helps prevent performance issues caused by large queries.
ShowHiddenEntitiesEnable this property to include hidden dimensions, measures, and levels in query results. By default, the provider excludes entities marked as hidden.
SplitMeasuresEnable this property to split the Measures table into individual tables and distribute measures into their respective dimension tables.
SplitMeasuresOnSpecifies the priority for organizing measures into tables when SplitMeasures is enabled. Provide a comma-delimited list of attributes to determine the sorting order.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseMDXEnable this property to pass MDX queries directly to Microsoft Power BI XMLA. When disabled, the provider translates SQL-92 queries into operations on the modeled views.
UserDefinedViewsカスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
WorkspaceSpecifies the Premium Power BI workspace(s) to connect to, using a comma-separated list of workspace names.
Microsoft Power BI XMLA Connector for CData Sync

Authentication

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


プロパティ説明
AuthSchemeThe type of authentication to use when connecting to Microsoft Power BI XMLA.
Microsoft Power BI XMLA Connector for CData Sync

AuthScheme

The type of authentication to use when connecting to Microsoft Power BI XMLA.

解説

Use this property to select the authentication flow that matches your environment and deployment scenario. This setting determines how the driver acquires OAuth credentials for accessing Microsoft Power BI XMLA.

  • AzureAD: Use for interactive, user-based authentication with Microsoft Entra ID (formerly Azure Active Directory). Best for desktop applications, development environments, or any scenario where a user logs in through a browser. Supports embedded and custom OAuth applications. For step-by-step instructions, see 接続の確立 and Entra ID でのサービスプリンシパルアプリの作成.
  • AzureServicePrincipal: Use for non-interactive, automated authentication using a service principal and client credentials (client ID + secret). Recommended for CI/CD, ETL, or server-based deployments. To configure this method, see Entra ID でのサービスプリンシパルアプリの作成.
  • AzureServicePrincipalCert: Use for service principal authentication with a certificate, typically in security-sensitive or compliance-focused environments. This method requires a registered Microsoft Entra ID application (formerly Azure AD application) and a valid client certificate. To configure certificate-based auth, see the “Client OAuth Flow With a Certificate” section in Entra ID でのサービスプリンシパルアプリの作成.

Microsoft Power BI XMLA Connector for CData Sync

Azure Authentication

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


プロパティ説明
AzureTenantデータにアクセスするために使用されているMicrosoft Power BI XMLA テナントを識別します。テナントのドメイン名(例: contoso.onmicrosoft.com )またはディレクトリ(テナント)ID のいずれかを受け付けます。
AzureEnvironmentThe Azure Environment to use when establishing a connection.
PowerBIEnvironmentSpecifies the PowerBI environment to use for API requests.
Microsoft Power BI XMLA Connector for CData Sync

AzureTenant

データにアクセスするために使用されているMicrosoft Power BI XMLA テナントを識別します。テナントのドメイン名(例: contoso.onmicrosoft.com )またはディレクトリ(テナント)ID のいずれかを受け付けます。

解説

テナントとは、Microsoft Entra ID(旧称:Azure AD)を通じて管理される、組織のユーザーやリソースのためのデジタルコンテナです。 各テナントには一意のディレクトリID が関連付けられており、多くの場合、カスタムドメイン(例:microsoft.com やcontoso.onmicrosoft.com)も関連付けられています。

Microsoft Entra 管理センターでディレクトリ(テナント)ID を確認するには、Microsoft Entra ID -> プロパティに移動し、「ディレクトリ(テナント)ID」と表示されている値をコピーします。

このプロパティは以下の場合に必要です。

  • AuthScheme がAzureServicePrincipal またはAzureServicePrincipalCert に設定されている場合
  • AuthScheme がAzureAD で、ユーザーアカウントが複数のテナントに属している場合

テナントの値は、2つの形式のいずれかで指定できます。

  • ドメイン名(例:contoso.onmicrosoft.com)
  • GUID 形式のディレクトリ(テナント)ID(例:c9d7b8e4-1234-4f90-bc1a-2a28e0f9e9e0)

テナントを明示的に指定することで、認証リクエストが正しいディレクトリにルーティングされるようになります。これは、ユーザーが複数のテナントに所属している場合や、サービスプリンシパルベースの認証を使用する場合に特に重要です。

この値が必要な場面で省略されると、認証に失敗したり、誤ったテナントに接続されたりする可能性があります。その結果、認可されていないまたはリソースが見つからないといったエラーが発生する可能性があります。

Microsoft Power BI XMLA Connector for CData Sync

AzureEnvironment

The Azure Environment to use when establishing a connection.

解説

Azure アカウントがGlobal ネットワークとは異なるネットワーク(China、USGOVT、USGOVTDOD など)の一部である場合は、必要です。

In most cases, leaving the environment set to global will work. However, if your Azure Account has been added to a different environment, the AzureEnvironment may be used to specify which environment. The available values are GLOBAL, USGOVT, USGOVTHIGH, USGOVTDOD.

Microsoft Power BI XMLA Connector for CData Sync

PowerBIEnvironment

Specifies the PowerBI environment to use for API requests.

解説

Use this property to select the appropriate PowerBI environment for your account. When set to NONE, the environment that aligns with AzureEnvironment will be automatically selected.

If your PowerBI account resides in a sovereign or restricted environment, set this property accordingly.

Available values:

  • NONE: Setting this value will use the environment which matches the value of AzureEnvironment.
  • GLOBAL: Default environment for commercial Microsoft 365 accounts.
  • USGOVT: U.S. Government Community Cloud (GCC).
  • USGOVTDOD: U.S. Department of Defense environment.
  • USGOVTHIGH: U.S. Government High Cloud environment.

This property is useful when connecting to region-specific or government-restricted PowerBI tenants.

Microsoft Power BI XMLA Connector for CData Sync

OAuth

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


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
Microsoft Power BI XMLA Connector for CData Sync

OAuthClientId

カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

解説

このプロパティは2つのケースで必要となります:

  • カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
  • ドライバーが埋め込みOAuth 資格情報を提供しない場合。

(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにSync App によって設定されており、手動で入力する必要がないことがあります。)

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

Microsoft Power BI XMLA Connector for CData Sync

OAuthClientSecret

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

解説

このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes:

  • この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
  • クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

Microsoft Power BI XMLA Connector for CData Sync

JWT OAuth

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


プロパティ説明
OAuthJWTCertクライアント証明書のJWT 証明書ストアの名前を指定します。
OAuthJWTCertTypeJWT 証明書を格納しているキーストアの種類を指定します。
OAuthJWTCertPasswordパスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubjectストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
Microsoft Power BI XMLA Connector for CData Sync

OAuthJWTCert

クライアント証明書のJWT 証明書ストアの名前を指定します。

解説

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword を使用してパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値が設定され、かつOAuthJWTCertSubject が設定されている場合、CData Sync App は証明書の検索を開始します。 詳しくは、OAuthJWTCertSubject を参照してください。

証明書ストアの指定はプラットフォームに依存します。

注記

  • Windows の共通のユーザーとシステム証明書ストアは以下のとおりです。
    • MY:個人証明書と関連付けられた秘密キーを 格納している証明書ストア。
    • CA:証明機関の証明書。
    • ROOT:ルート証明書。
    • SPC:ソフトウェア発行元証明書。
  • Javaでは、証明書ストアは通常、証明書および 任意の秘密キーを含むファイルです。
  • 証明書ストアの種類がPFXFile の場合は、 このプロパティにファイル名を設定します。
  • PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ(例えば、PKCS12証明書ストア)に設定する必要があります。

Microsoft Power BI XMLA Connector for CData Sync

OAuthJWTCertType

JWT 証明書を格納しているキーストアの種類を指定します。

解説

値説明注記
USER現在のユーザーが所有する証明書ストア。 Windows のみ使用可能です。
MACHINEマシンストア。Java やその他の非Windows 環境では使用できません。
PFXFILE証明書を含むPFX(PKCS12)ファイル。
PFXBLOBPFX(PKCS12)形式の証明書ストアをbase-64 でエンコードした文字列。
JKSFILE証明書を含むJava キーストア(JKS)ファイル。Java 専用。
JKSBLOBJava キーストア(JKS)形式の証明書ストアをbase-64 でエンコードした文字列。 Java 専用。
PEMKEY_FILE秘密鍵とオプションの証明書を含むPEM でエンコードされたファイル。
PEMKEY_BLOB秘密鍵とオプションの証明書をbase-64 でエンコードした文字列。
PUBLIC_KEY_FILEPEM またはDER でエンコードされた公開鍵証明書を含むファイル。
PUBLIC_KEY_BLOBPEM またはDER でエンコードされた公開鍵証明書をbase-64 でエンコードした文字列。
SSHPUBLIC_KEY_FILESSH 形式の公開鍵を含むファイル。
SSHPUBLIC_KEY_BLOBSSH 形式の公開鍵ををbase-64 でエンコードした文字列。
P7BFILE証明書を含むPKCS7 ファイル。
PPKFILEPuTTY 秘密キー(PPK)を含むファイル。
XMLFILEXML 形式の証明書を含むファイル。
XMLBLOBXML 形式の証明書を含む文字列。
BCFKSFILEBouncy Castle キーストアを含むファイル。
BCFKSBLOBBouncy Castle キーストアを含む文字列(base-64エンコード)。

Microsoft Power BI XMLA Connector for CData Sync

OAuthJWTCertPassword

パスワードで保護された証明書ストアにアクセスするために使用されるOAuth JWT 証明書のパスワードを指定します。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。

解説

このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。

Microsoft Power BI XMLA Connector for CData Sync

OAuthJWTCertSubject

ストアで一致する証明書を検索するために使用される、OAuth JWT 証明書のサブジェクトを指定します。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。

解説

このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。

  • サブジェクトに完全に一致する証明書が見つかれば、該当する証明書が選択されます。
  • 完全に一致するものがない場合、ストアは、サブジェクトがプロパティ値を含む証明書を検索します。
  • 一致する証明書がない場合、証明書は選択されません。

値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例:CN=www.server.com, OU=test, C=US, [email protected]。

一般的なフィールドには以下のものが含まれます。

フィールド説明
CN共通名。一般的には、www.server.com のようなホスト名です。
O法人名
OU法人の部署名
L法人の住所(市町村名)
S法人の住所(都道府県)
C国名
EE メールアドレス

フィールド値にカンマが含まれる場合は、引用符で囲んでください。例:"O=ACME, Inc."。

Microsoft Power BI XMLA Connector for CData Sync

SSL

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


プロパティ説明
SSLClientCertSSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。
SSLClientCertTypeSSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。
SSLClientCertPasswordTLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。
SSLClientCertSubjectTLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
Microsoft Power BI XMLA Connector for CData Sync

SSLClientCert

SSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。

解説

このプロパティは、SSL クライアント認証のためのクライアント証明書ストアを指定します。 このプロパティは、証明書ストアの種類を定義するSSLClientCertType、およびパスワードで保護されたストア用のパスワードを指定するSSLClientCertPassword と一緒に使用します。 SSLClientCert が設定され、SSLClientCertSubject が設定されている場合、ドライバーは指定されたサブジェクトに一致する証明書を検索します。

証明書ストアの指定はプラットフォームによって異なります。 Windowsでは、証明書ストアはMY(個人証明書)などの名前で識別されますが、Java では、証明書ストアは通常、証明書とオプションの秘密キーを含むファイルです。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

MY個人証明書と関連付けられた秘密キーを格納している証明書ストア。
CA証明機関の証明書。
ROOTルート証明書。
SPCソフトウェア発行元証明書。

PFXFile タイプの場合、このプロパティをファイル名に設定します。PFXBlob タイプの場合は、このプロパティをPKCS12 形式のファイルのバイナリコンテンツに設定します。

Microsoft Power BI XMLA Connector for CData Sync

SSLClientCertType

SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。

解説

このプロパティは、クライアント証明書を指定するために使用されるキーストアの形式と場所を決定します。 サポートされている値には、プラットフォーム固有およびユニバーサルなキーストア形式があります。 有効な値と使用方法は以下のとおりです。

USER - デフォルトWindows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。この種類はJava では利用できませんので注意してください。
MACHINEWindows の場合、この証明書ストアがシステムストアであることを指定します。この種類はJava では利用できませんので注意してください。
PFXFILEこの証明書ストアは、証明書を含むPFX(PKCS12)ファイルの名前です。
PFXBLOBこの証明書ストアは、PFX(PKCS12)形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILEこの証明書ストアは、証明書を含むJava key store(JKS)ファイルの名前です。この種類はJava でのみ利用できますので注意してください。
JKSBLOBこの証明書ストアは、Java key store(JKS)形式の証明書ストアを表すBase-64でエンコードされた文字列です。この種類はJava でのみ利用できますので注意してください。
PEMKEY_FILEこの証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。
PEMKEY_BLOBこの証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。
PUBLIC_KEY_FILEこの証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。
PUBLIC_KEY_BLOBこの証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。
SSHPUBLIC_KEY_FILEこの証明書ストアは、SSH 公開キーを含むファイルの名前です。
SSHPUBLIC_KEY_BLOBこの証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。
P7BFILEこの証明書ストアは、証明書を含むPKCS7 ファイルの名前です。
PPKFILEこの証明書ストアは、PuTTY 秘密キー(PPK)を含むファイルの名前です。
XMLFILEこの証明書ストアは、XML 形式の証明書を含むファイルの名前です。
XMLBLOBこの証明書ストアは、XML 形式の証明書を含む文字列の名前です。
BCFKSFILEこの証明書ストアは、Bouncy Castle キーストアを含むファイルの名前です。
BCFKSBLOBこの証明書ストアは、Bouncy Castle キーストアを含む文字列(Base-64エンコード)です。

Microsoft Power BI XMLA Connector for CData Sync

SSLClientCertPassword

TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。

解説

このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 このプロパティは、PFX やJKS タイプのストアによく推奨されるように、復号化のためにパスワードを必要とする証明書ストアを使用する場合に必要です。

証明書ストアの種類がパスワードを必要としない場合(Windows のUSER やMACHINE など)、このプロパティは空白のままにできます。 認証エラーを回避するため、パスワードが指定された証明書ストアに関連付けられたものと一致していることを確認してください。

Microsoft Power BI XMLA Connector for CData Sync

SSLClientCertSubject

TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。

解説

このプロパティは、サブジェクトに基づいてロードするクライアント証明書を決定します。Sync App は、指定されたサブジェクトに完全に一致する証明書を検索します。 完全に一致するものが見つからない場合、Sync App はサブジェクトの値を含む証明書を検索します。 一致する証明書がない場合、証明書は選択されません。

サブジェクトは、識別名フィールドと値のカンマ区切りリストという標準の形式に従うべきです。 例えば、CN=www.server.com, OU=Test, C=US です。一般的なフィールドには以下のものが含まれます。

フィールド説明
CN共通名。一般的には、www.server.com のようなホスト名です。
O法人名
OU法人の部署名
L法人の住所(市町村名)
S法人の住所(都道府県)
C国名
EE メールアドレス

Note: フィールドにカンマなどの特殊文字が含まれている場合は、値を引用符で囲む必要があります。例:CN="Example, Inc.", C=US。

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

Microsoft Power BI XMLA Connector for CData Sync

Firewall

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


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

FirewallType

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

解説

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

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

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

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

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

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

Microsoft Power BI XMLA Connector for CData Sync

FirewallServer

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

解説

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

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

Microsoft Power BI XMLA Connector for CData Sync

FirewallPort

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

解説

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

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

Microsoft Power BI XMLA Connector for CData Sync

FirewallUser

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

解説

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

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

Microsoft Power BI XMLA Connector for CData Sync

FirewallPassword

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

解説

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

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

Microsoft Power BI XMLA Connector for CData Sync

Proxy

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


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

ProxyAutoDetect

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

解説

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

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

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

Microsoft Power BI XMLA Connector for CData Sync

ProxyServer

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

解説

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

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

Microsoft Power BI XMLA Connector for CData Sync

ProxyPort

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

解説

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

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

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

Microsoft Power BI XMLA 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 を参照してください。

Microsoft Power BI XMLA 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 は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

Microsoft Power BI XMLA 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 は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

Microsoft Power BI XMLA 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接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

Microsoft Power BI XMLA Connector for CData Sync

ProxyExceptions

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

解説

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

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

Microsoft Power BI XMLA Connector for CData Sync

Logging

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


プロパティ説明
LogModulesログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
Microsoft Power BI XMLA 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 低レベルの製品操作に関する高度なメッセージ。 —

Microsoft Power BI XMLA Connector for CData Sync

Schema

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


プロパティ説明
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesレポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Viewsレポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
CatalogSpecifies the Power BI workspace and dataset to use, combined into a single catalog name. For example, MyWorkspace_MyDataset. Leave this blank to search across all available workspaces and datasets.
IncludeJoinColumnsEnable this property to add extra join columns to each table. These columns reference foreign keys for use in ON conditions when performing joins.
Microsoft Power BI XMLA Connector for CData Sync

Location

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

解説

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

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

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

Microsoft Power BI XMLA Connector for CData Sync

BrowsableSchemas

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

解説

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

Microsoft Power BI XMLA Connector for CData Sync

Tables

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

解説

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

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

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

Microsoft Power BI XMLA Connector for CData Sync

Views

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

解説

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

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

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

Microsoft Power BI XMLA Connector for CData Sync

Catalog

Specifies the Power BI workspace and dataset to use, combined into a single catalog name. For example, MyWorkspace_MyDataset. Leave this blank to search across all available workspaces and datasets.

解説

The Sync App combines each Power BI workspace and dataset into a single catalog name. The catalog name is constructed by appending the dataset name to the workspace name, separated by an underscore. For example, if the workspace is called MyWorkspace and the dataset is called MyDataset, the catalog name will be MyWorkspace_MyDataset. By default, the Sync App lists all workspaces and datasets as separate catalogs. You can query a specifc catalog by specifying a name or search for a table across all catalogs:

-- Use this specific catalog
SELECT ... FROM MyWorkspace_MyDataset.Model.MyDimension

-- Search for a catalog containing this table
SELECT ... FROM Model.MyDimension

When you enable UseMDX, set this property to route MDX queries to the correct workspace and dataset. The Sync App cannot automatically detect the workspace and dataset for MDX queries.

Microsoft Power BI XMLA Connector for CData Sync

IncludeJoinColumns

Enable this property to add extra join columns to each table. These columns reference foreign keys for use in ON conditions when performing joins.

解説

Set IncludeJoinColumns to true if your tool requires ON conditions or generates them automatically based on foreign key references. When enabled, the Sync App adds foreign key references to every table, even though these columns do not return any data. Their sole purpose is to provide references for ON conditions in join operations.

In Microsoft Power BI XMLA, dimensions and measures within tables are naturally related, so ON conditions are optional. The CData Sync App supports joins without requiring these conditions.

Microsoft Power BI XMLA Connector for CData Sync

Miscellaneous

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


プロパティ説明
CustomHeaders他のプロパティ(ContentType やFrom など)から作成されたリクエストヘッダーに追加する、追加HTTP ヘッダーを指定します。このプロパティは、特殊または非標準のAPI 用にリクエストをカスタマイズするために使用します。
ExposeMemberKeysEnable this property to convert each level into a measure, which is a numeric value that supports calculations like summing, averaging, and other aggregations. By default, levels remain as String types, so they do not support direct calculations.
ExpressionInDescriptionEnable this property to append measure expressions in the descriptions of measure columns. By default, the provider includes only remarks in measure column descriptions.
ExtraPropertiesSpecifies additional properties to include in each MDX request sent to Microsoft Power BI XMLA. Use this property to customize the PropertiesList of the XMLA request when UseMDX is enabled.
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
Other特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
ResponseRowLimitSpecifies the maximum number of response rows allowed before triggering an error. Use 0 to remove the limit entirely. This property helps prevent performance issues caused by large queries.
ShowHiddenEntitiesEnable this property to include hidden dimensions, measures, and levels in query results. By default, the provider excludes entities marked as hidden.
SplitMeasuresEnable this property to split the Measures table into individual tables and distribute measures into their respective dimension tables.
SplitMeasuresOnSpecifies the priority for organizing measures into tables when SplitMeasures is enabled. Provide a comma-delimited list of attributes to determine the sorting order.
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseMDXEnable this property to pass MDX queries directly to Microsoft Power BI XMLA. When disabled, the provider translates SQL-92 queries into operations on the modeled views.
UserDefinedViewsカスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
WorkspaceSpecifies the Premium Power BI workspace(s) to connect to, using a comma-separated list of workspace names.
Microsoft Power BI XMLA Connector for CData Sync

CustomHeaders

他のプロパティ(ContentType やFrom など)から作成されたリクエストヘッダーに追加する、追加HTTP ヘッダーを指定します。このプロパティは、特殊または非標準のAPI 用にリクエストをカスタマイズするために使用します。

解説

このプロパティを使用して、Sync App から送信されるHTTP リクエストにカスタムヘッダーを追加します。

このプロパティは、追加ヘッダーや非標準ヘッダーを必要とするAPI とやり取りするためにリクエストを微調整する際に役立ちます。 ヘッダーはHTTP 仕様で記述されているとおり"header: value" の形式に従う必要があり、各ヘッダー行はキャリッジリターンとラインフィード(CRLF)文字で区切る必要があります。 重要:このプロパティを設定する際は注意してください。無効なヘッダーを指定するとHTTP リクエストが失敗する場合があります。

Microsoft Power BI XMLA Connector for CData Sync

ExposeMemberKeys

Enable this property to convert each level into a measure, which is a numeric value that supports calculations like summing, averaging, and other aggregations. By default, levels remain as String types, so they do not support direct calculations.

解説

When you enable this property, the Sync App resolves each level to its key property, creating a measure with the level's DBType data type. This allows you to perform calculations on the measure, such as aggregations or mathematical operations. Use this property when you need to analyze levels numerically or include them in computations.

Microsoft Power BI XMLA Connector for CData Sync

ExpressionInDescription

Enable this property to append measure expressions in the descriptions of measure columns. By default, the provider includes only remarks in measure column descriptions.

解説

The Sync App uses remarks to generate descriptions for several types of entities, including dimensions, measures, measure groups, and hierarchies. This property provides additional context for understanding the calculation logic of measures without modifying the descriptions of non-measure entities. Set this to true to improve visibility into how measures are defined when expressions are essential for analysis.

Microsoft Power BI XMLA Connector for CData Sync

ExtraProperties

Specifies additional properties to include in each MDX request sent to Microsoft Power BI XMLA. Use this property to customize the PropertiesList of the XMLA request when UseMDX is enabled.

解説

When you enable UseMDX, you can use the ExtraProperties connection property to add extra values to the PropertiesList in the XMLA request. Specify these properties as name=value pairs, separated by semicolons. For example: Catalog=MyCatalog;Cube=MyCube;.

You can retrieve a list of valid property names by executing the following query:

SELECT * FROM $System.DISCOVER_PROPERTIES

This property is useful for fine-tuning MDX requests to include custom parameters required by your specific Power BI environment.

Microsoft Power BI XMLA Connector for CData Sync

MaxRows

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

解説

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

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

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

Microsoft Power BI XMLA Connector for CData Sync

Other

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

解説

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

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

統合およびフォーマット

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

Microsoft Power BI XMLA Connector for CData Sync

ResponseRowLimit

Specifies the maximum number of response rows allowed before triggering an error. Use 0 to remove the limit entirely. This property helps prevent performance issues caused by large queries.

解説

Selecting a large number of columns can create multiple crossjoins when the query is translated into MDX, as required by Microsoft Power BI XMLA. Crossjoins often lead to very large response sets, which may time out or degrade performance. If the response exceeds the specified row limit, the Sync App triggers an error to alert you to the high cost of the query.

This property provides a safeguard against unintentionally expensive requests. If you know your queries will generate large responses and want to process them, you can increase the limit or set it to 0 to disable the restriction. However, use caution when setting a very high limit or removing the limit altogether, as it may lead to performance degradation or timeouts.

Microsoft Power BI XMLA Connector for CData Sync

ShowHiddenEntities

Enable this property to include hidden dimensions, measures, and levels in query results. By default, the provider excludes entities marked as hidden.

解説

By default, the Sync App omits dimensions, measures, and levels that Microsoft Power BI XMLA flags as hidden. Enabling this property allows you to query these entities, which may contain supplemental or advanced data not typically exposed in standard views.

This property is useful for users who need to access hidden metadata or perform advanced analyses involving non-visible entities. However, use caution when enabling this property, as hidden entities may be experimental, deprecated, or irrelevant to standard queries.

Microsoft Power BI XMLA Connector for CData Sync

SplitMeasures

Enable this property to split the Measures table into individual tables and distribute measures into their respective dimension tables.

解説

By default, the Sync App groups all measures into a single table called Measures. When you enable SplitMeasures, the Sync App reorganizes the measures in the following ways:

  • Separate Tables for Measures-Only Groups: If a table contains only measures, the driver creates a dedicated table for those measures.
  • Integration with Dimensions: The driver includes measures in their corresponding dimension tables if applicable.

This property is useful for creating a more intuitive schema layout when analyzing datasets with numerous measures and dimensions. Use this property with the SplitMeasuresOn property to control how measures are grouped into subtables based on attributes such as MeasureGroup or DisplayFolder.

Microsoft Power BI XMLA Connector for CData Sync

SplitMeasuresOn

Specifies the priority for organizing measures into tables when SplitMeasures is enabled. Provide a comma-delimited list of attributes to determine the sorting order.

解説

The Sync App names the split-measure tables based on the first populated attribute in the list. Available attribute values include:

  • MeasureGroup
  • DisplayFolder

If none of the attributes in the list are populated for a measure, the Sync App places the measure in a generic Measures table. For example, setting SplitMeasures to MeasureGroup,DisplayFolder prioritizes grouping measures by their MeasureGroup. If the MeasureGroup attribute is not populated for a measure, the Sync App uses the DisplayFolder attribute as the fallback grouping method.

Microsoft Power BI XMLA Connector for CData Sync

Timeout

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

解説

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

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

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

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

Microsoft Power BI XMLA Connector for CData Sync

UseMDX

Enable this property to pass MDX queries directly to Microsoft Power BI XMLA. When disabled, the provider translates SQL-92 queries into operations on the modeled views.

解説

This property determines whether the Sync App processes SQL-92 queries or passes MDX queries directly to Microsoft Power BI XMLA. By default, the driver allows SQL-92 SELECT queries to interact with views modeled by the driver. When you enable this property, the driver bypasses the SQL translation layer and sends MDX queries as-is to the XMLA endpoint.

This property is useful for advanced users familiar with MDX who need direct access to multidimensional queries for more granular or complex operations.

Microsoft Power BI XMLA Connector for CData Sync

UserDefinedViews

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

解説

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

次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM [AdventureWorksDW2012Multidimensional-SE].[Adventure Works].Customer WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

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

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

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

Microsoft Power BI XMLA Connector for CData Sync

Workspace

Specifies the Premium Power BI workspace(s) to connect to, using a comma-separated list of workspace names.

解説

This property is useful for narrowing the scope of queries to specific workspaces, optimizing performance, and focusing on relevant datasets. Use a comma-separated list of workspace names, ensuring they exactly match the case-sensitive names displayed in Power BI. Only Premium Workspaces are supported; standard workspaces are not compatible.

To find workspace names in Power BI, follow these steps:

  1. Log in to Power BI.
  2. Navigate to the Workspaces section in the left-hand panel.
  3. Locate the exact name of the Premium Workspace(s) you want to connect to.
  4. Use these names in the property configuration, ensuring they match exactly.

If no value is specified, the driver attempts to connect to all Premium Workspaces accessible to the user. While this can be helpful for exploring datasets, it may increase processing time due to the additional requests required to retrieve objects from all workspaces. For example, to connect to two Premium Workspaces named SalesAnalysis and MarketingReports, set the property as follows:

Workspace=SalesAnalysis,MarketingReports

Microsoft Power BI XMLA 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