Microsoft Dataverse Connector for CData Sync

Build 24.0.9175
  • Microsoft Dataverse
    • 接続の確立
    • 高度な機能
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • エンティティデータモデル
        • ビュー
          • MultiSelectPickListAttributeMetaData
          • MultiSelectPickListOptions
          • PickListAttributeMetaData
          • PickListOptions
          • StateAttributeMetadata
          • StateAttributeOptions
          • StatusAttributeMetadata
          • StatusAttributeOptions
      • システムデータモデル
      • データ型マッピング
    • 接続文字列オプション
      • Authentication
        • AuthScheme
        • OrganizationURL
        • ApiVersion
      • Azure Authentication
        • AzureTenant
        • AzureEnvironment
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • OAuthGrantType
      • JWT OAuth
        • OAuthJWTCert
        • OAuthJWTCertType
        • OAuthJWTCertPassword
        • OAuthJWTCertSubject
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
        • Schema
      • Miscellaneous
        • ContinueOnError
        • IncludeFormattedValues
        • IncludeLookUpLogicalName
        • IncludeNavigationKeys
        • IncludeNavigationProperties
        • MaxRows
        • Other
        • PseudoColumns
        • Timeout
        • UseDisplayNames
        • UserDefinedViews

Microsoft Dataverse Connector for CData Sync

概要

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

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

Microsoft Dataverse バージョンサポート

Sync App は、Microsoft Dataverse Web API を介してMicrosoft Dataverse への読み出し / 書き込みアクセスをサポートします。

Microsoft Dataverse Connector for CData Sync

接続の確立

Microsoft Dataverse への接続を追加

Microsoft Dataverse への接続を追加するには:

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

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

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

スキーマ

Microsoft Dataverse はスキーマ値として'System' および'Entities' をサポートしており、Schema プロパティを使用して設定することができます。

Schema プロパティに'System' を使用すると、Web API を使用してエンティティ / テーブルをクエリします。

Schema プロパティに'Entities' を使用すると、EntityDefinitions エンティティセットパスを使用して、EntityMetadata EntityType エンティティ / テーブルに関する情報を取得します。これによって、よりユーザーフレンドリーな名前になることが多いですが、追加のメタデータリクエストが必要になります。

Microsoft Dataverse への接続

Microsoft Dataverse データソースを認証するには、まずOrganizationUrl をhttps://[organization].crm.dynamics.com のような接続先の組織のURL に設定する必要があります。

Azure AD

Azure AD は、OAuth を使用して認証する接続タイプです。OAuth では認証するユーザーにインターネットブラウザでMicrosoft Dataverse との通信を要求します。下記で説明するとおり、Sync App はさまざまな方法でこれをサポートします。 AuthScheme をAzureAD に設定します。以下のAzure AD フローは、すでに設定済みであることを前提として書かれています。

クライアントクレデンシャル

クライアント資格情報は、直接ユーザー認証が行われないOAuth のフローを指します。代わりに、資格情報はアプリ自体のためだけに作成されます。 アプリで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。そのため、認証フローが標準とは少し違ったものになります。

クライアントOAuth フロー

クライアントOAuth フローに関連するすべての権限には、管理者の同意が必要です。これは、CData Sync App が埋め込まれたアプリをクライアントOAuth フローでは使用できないことを意味します。クライアント資格情報を使用するには、独自のOAuth アプリの作成が必要になります。 詳しくは、Azure AD アプリケーションの作成 を参照してください。

portal.azure.com の[アプリの登録]で[API のアクセス許可]に移動し、Microsoft Graph アクセス許可を選択します。アクセス許可には、委任されたアクセス許可とアプリケーションの許可の2つの異なるアクセス許可セットがあります。 クライアントの資格情報認証時に使用されるアクセス許可は、[アプリケーションの許可]の下にあります。インテグレーションに必要なアクセス許可を選択します。

認証タイプに応じて、以下のいずれかの接続プロパティグループを設定すると、接続できるようになります。

  1. クライアントシークレット
    • InitiateOAuth:GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
    • AzureTenant:接続するテナントに設定。
    • OAuthGrantType:CLIENT に設定。
    • OAuthClientId:アプリ設定のクライアントId に設定。
    • OAuthClientSecret:アプリ設定のクライアントシークレットに設定。
  2. 証明書
    • InitiateOAuth:GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
    • AzureTenant:接続するテナントに設定。
    • OAuthGrantType:CLIENT に設定。
    • OAuthClientId:アプリ設定のクライアントId に設定。
    • OAuthJWTCert:JWT 証明書ストアに設定。
    • OAuthJWTCertType:OAuthJWTCert で指定された証明書ストアの種類に設定。

クライアント資格情報での認証は、他の接続同様に自動的に行われますが、ユーザーにプロンプトするウィンドウは表示されません。ユーザーコンテキストがないため、ブラウザのポップアップは必要ないからです。 接続が行われ、内部的に処理されます。

Azure サービスプリンシパル

Azure サービスプリンシパルは、ロールに基づいたアプリケーションベースの認証です。これは、認証がユーザーごとではなく、アプリケーションごとに行われることを意味します。 アプリケーションで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで、割り当てられたロールに基づいて実行されます。 リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。

Azure サービスプリンシパル認証の設定方法については、サービスプリンシパルによるAzure AD アプリの作成 を参照してください。

Managed Service Identity (MSI)

Azure VM 上でMicrosoft Dataverse を実行しており、マネージドID(MSI)認証情報を自動的に取得して接続したい場合は、AuthScheme を AzureMSI に設定します。

User-Managed Identities

マネージドID のトークンを取得するには、OAuthClientId プロパティを使用してマネージドID のclient_id を指定します。

VM に複数のユーザーが割り当てられたマネージドID がある場合は、OAuthClientId も指定する必要があります。

Microsoft Dataverse Connector for CData Sync

高度な機能

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

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

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

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

ログ

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

Microsoft Dataverse Connector for CData Sync

SSL の設定

SSL 設定のカスタマイズ

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

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

Microsoft Dataverse 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 Dataverse Connector for CData Sync

データモデル

CData Sync App はMicrosoft Dataverse データをテーブル、ビュー、ストアドプロシージャを備えた使いやすいSQL データベースとしてモデル化します。定義は、接続先のOData サービスから動的に取得されます。サービスに再接続することで、カラムの新規追加や削除、データ型の変更など、メタデータの変更を読み込めます。

Sync App は2つのデータモデルを公開します。

  • エンティティデータモデル では、Microsoft Dataverse への接続に使用できるスキーマについて説明します。テーブルを使用して、ライブMicrosoft Dataverse データを操作できます。
  • システムデータモデル は、セキュリティ、監査、システムレベルの操作など、プラットフォームのコア機能をサポートする基本的なフレームワークを定義します。

CData Sync App が提供するストアドプロシージャを使用して、Microsoft Dataverse データの操作を自動化できます。

Microsoft Dataverse Connector for CData Sync

エンティティデータモデル

Entities データモデルは、ビジネスアプリケーション内の構造化データを定義、格納、管理します。Microsoft Power Platform、Dynamics 365、および外部システムとのデータリレーションシップ、セキュリティ、自動化、統合を実現します。

ビュー

ビュー セクションには読み取り専用SQL テーブルの一覧が記載されています。これらには、Microsoft Dataverse アカウントでのアクセスを想定したサンプルが含まれています。

以下のビューはSync App に同梱されています。

テーブル 説明
MultiSelectPickListAttributeMetaData Stores metadata for attributes that support MultiSelect OptionSet, defining the structure and behavior of multi-option fields.
MultiSelectPickListOptions Contains the possible selectable options for MultiSelect OptionSet attributes, enabling multi-value selections.
PickListAttributeMetaData Holds metadata for attributes of type Picklist, describing the single-option selection fields in the system.
PickListOptions Defines the set of selectable options available for Picklist attributes, supporting user-defined field values.
StateAttributeMetadata Provides metadata for attributes of type State, describing state-related fields used for status tracking or categorization.
StateAttributeOptions Lists the selectable states available for State attributes, representing various predefined states.
StatusAttributeMetadata Contains metadata for attributes of type Status, often used to track the lifecycle or current condition of an entity.
StatusAttributeOptions Defines the set of statuses that can be assigned to Status attributes, supporting status-driven workflows.

ストアドプロシージャ

ストアドプロシージャ は、SQLクエリを介して呼び出されるアクションです。標準的なCRUD 操作だけでなく、OAuth アクセストークンの取得や更新などより高度なタスクも実行します。

Microsoft Dataverse Connector for CData Sync

ビュー

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

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

Microsoft Dataverse Connector for CData Sync ビュー

Name Description
MultiSelectPickListAttributeMetaData Stores metadata for attributes that support MultiSelect OptionSet, defining the structure and behavior of multi-option fields.
MultiSelectPickListOptions Contains the possible selectable options for MultiSelect OptionSet attributes, enabling multi-value selections.
PickListAttributeMetaData Holds metadata for attributes of type Picklist, describing the single-option selection fields in the system.
PickListOptions Defines the set of selectable options available for Picklist attributes, supporting user-defined field values.
StateAttributeMetadata Provides metadata for attributes of type State, describing state-related fields used for status tracking or categorization.
StateAttributeOptions Lists the selectable states available for State attributes, representing various predefined states.
StatusAttributeMetadata Contains metadata for attributes of type Status, often used to track the lifecycle or current condition of an entity.
StatusAttributeOptions Defines the set of statuses that can be assigned to Status attributes, supporting status-driven workflows.

Microsoft Dataverse Connector for CData Sync

MultiSelectPickListAttributeMetaData

Stores metadata for attributes that support MultiSelect OptionSet, defining the structure and behavior of multi-option fields.

ビュー固有の情報

Select

Sync App はMicrosoft Dataverse API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。

  • TableName は'='、'IN' 演算子をサポートしています。

TableName でフィルタリングしない場合、Sync App は最初に見つかったテーブルの結果を返します。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM MultiSelectPickListAttributeMetaData WHERE TableName = 'teams'

SELECT * FROM MultiSelectPickListAttributeMetaData WHERE TableName IN ('accounts', 'teams')

Columns

Name Type References Description
ColumnName [KEY] String The name of the column in the table where the multi-select picklist is defined.
MetadataId String The unique identifier for the metadata associated with this attribute.
OptionSet_Description_LocalizedLabels String Localized descriptions of the options in the picklist for different languages.
OptionSet_Description_UserLocalizedLabel_HasChanged String Indicates whether the user-localized description label has been modified.
OptionSet_Description_UserLocalizedLabel_IsManaged Boolean Specifies if the user-localized description label is managed (part of a managed solution).
OptionSet_Description_UserLocalizedLabel_Label String The localized label text for the option set description.
OptionSet_Description_UserLocalizedLabel_LanguageCode Integer The language code corresponding to the localized description label.
OptionSet_Description_UserLocalizedLabel_MetadataId String The unique identifier for the metadata associated with the localized description label.
OptionSet_DisplayName_LocalizedLabels String Localized display names of the picklist options for different languages.
OptionSet_DisplayName_UserLocalizedLabel_HasChanged String Indicates whether the user-localized display name label has been modified.
OptionSet_DisplayName_UserLocalizedLabel_IsManaged Boolean Specifies if the user-localized display name label is managed (part of a managed solution).
OptionSet_DisplayName_UserLocalizedLabel_Label String The localized label text for the option set display name.
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode Integer The language code corresponding to the localized display name label.
OptionSet_DisplayName_UserLocalizedLabel_MetadataId String The unique identifier for the metadata associated with the localized display name label.
OptionSet_ExternalTypeName String The external type name associated with the option set, if applicable.
OptionSet_HasChanged String Indicates if the option set has been modified.
OptionSet_IntroducedVersion String The version of the system in which the option set was introduced.
OptionSet_IsCustomizable_CanBeChanged Boolean Indicates whether the option set can be customized.
OptionSet_IsCustomizable_ManagedPropertyLogicalName String The logical name of the managed property that controls the customizability of the option set.
OptionSet_IsCustomizable_Value Boolean Specifies if the option set is customizable.
OptionSet_IsCustomOptionSet Boolean Indicates whether the option set is custom or part of a managed solution.
OptionSet_IsGlobal Boolean Specifies if the option set is global (shared across entities) or local (specific to one entity).
OptionSet_IsManaged Boolean Indicates if the option set is managed (part of a managed solution).
OptionSet_MetadataId String The unique identifier for the metadata associated with the option set.
OptionSet_Name String The name of the option set.
OptionSet_OptionSetType String The type of the option set (e.g., picklist, multi-select).
OptionSet_ParentOptionSetName String The name of the parent option set, if this option set is part of a hierarchy.
TableName String The name of the table where this multi-select picklist attribute is defined.

Microsoft Dataverse Connector for CData Sync

MultiSelectPickListOptions

Contains the possible selectable options for MultiSelect OptionSet attributes, enabling multi-value selections.

ビュー固有の情報

Select

Sync App はMicrosoft Dataverse API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。

  • TableName は'='、'IN' 演算子をサポートしています。

TableName でフィルタリングしない場合、Sync App は最初に見つかったテーブルの結果を返します。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM MultiSelectPickListOptions WHERE TableName = 'teams'

SELECT * FROM MultiSelectPickListOptions WHERE TableName IN ('accounts', 'teams')

Columns

Name Type References Description
ColumnName String

MultiSelectPickListAttributeMetaData.ColumnName

The name of the column in the table where the multi-select picklist option is defined.
Color String The color code associated with the picklist option, often used for UI display purposes.
ExternalValue String An external system value mapped to this picklist option, if applicable.
HasChanged String Indicates whether the option has been modified since its creation or last update.
IsManaged Boolean Specifies if the picklist option is managed (part of a managed solution).
Label_LocalizedLabels String Localized labels for the picklist option in different languages.
Label_UserLocalizedLabel_HasChanged String Indicates if the user-customized label for the picklist option has been modified.
Label_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized label for the picklist option is managed.
Label_UserLocalizedLabel_Label String The user-customized label text for the picklist option.
Label_UserLocalizedLabel_LanguageCode Integer The language code corresponding to the user-customized label.
Label_UserLocalizedLabel_MetadataId String The unique identifier for the metadata of the user-customized label.
Description_LocalizedLabels String Localized descriptions for the picklist option in different languages.
Description_UserLocalizedLabel_HasChanged String Indicates if the user-customized description for the picklist option has been modified.
Description_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized description for the picklist option is managed.
Description_UserLocalizedLabel_Label String The user-customized description text for the picklist option.
Description_UserLocalizedLabel_LanguageCode Integer The language code corresponding to the user-customized description.
Description_UserLocalizedLabel_MetadataId String The unique identifier for the metadata of the user-customized description.
MetadataId String The unique identifier for the metadata associated with the picklist option.
ParentValues String Specifies the parent values for hierarchical picklist options, if applicable.
Value Integer The integer value associated with this picklist option, used for storage and retrieval.
TableName String The name of the table where this picklist option is defined.

Microsoft Dataverse Connector for CData Sync

PickListAttributeMetaData

Holds metadata for attributes of type Picklist, describing the single-option selection fields in the system.

ビュー固有の情報

Select

Sync App はMicrosoft Dataverse API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。

  • TableName は'='、'IN' 演算子をサポートしています。

TableName でフィルタリングしない場合、Sync App は最初に見つかったテーブルの結果を返します。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM PickListAttributeMetaData WHERE TableName = 'teams'

SELECT * FROM PickListAttributeMetaData WHERE TableName IN ('accounts', 'teams')

Columns

Name Type References Description
ColumnName [KEY] String The name of the column in the table where the picklist attribute is defined.
MetadataId String The unique identifier for the metadata associated with this attribute.
OptionSet_Description_LocalizedLabels String Localized descriptions of the options in the picklist for various supported languages.
OptionSet_Description_UserLocalizedLabel_HasChanged String Indicates whether the user-customized description label has been modified.
OptionSet_Description_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized description label is managed (part of a managed solution).
OptionSet_Description_UserLocalizedLabel_Label String The localized label text for the description of the picklist.
OptionSet_Description_UserLocalizedLabel_LanguageCode Integer The language code associated with the user-localized description label.
OptionSet_Description_UserLocalizedLabel_MetadataId String The unique identifier for the metadata of the user-localized description label.
OptionSet_DisplayName_LocalizedLabels String Localized display names for the picklist options in various languages.
OptionSet_DisplayName_UserLocalizedLabel_HasChanged String Indicates whether the user-customized display name label has been modified.
OptionSet_DisplayName_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized display name label is managed (part of a managed solution).
OptionSet_DisplayName_UserLocalizedLabel_Label String The localized label text for the display name of the picklist.
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode Integer The language code associated with the user-localized display name label.
OptionSet_DisplayName_UserLocalizedLabel_MetadataId String The unique identifier for the metadata of the user-localized display name label.
OptionSet_ExternalTypeName String The external type name associated with the option set, if applicable.
OptionSet_HasChanged String Indicates if the option set has been modified since its creation or last update.
OptionSet_IntroducedVersion String The version of the system in which the option set was introduced.
OptionSet_IsCustomizable_CanBeChanged Boolean Indicates whether the option set can be customized by the user or administrators.
OptionSet_IsCustomizable_ManagedPropertyLogicalName String The logical name of the managed property controlling customizability of the option set.
OptionSet_IsCustomizable_Value Boolean Specifies if the option set is customizable.
OptionSet_IsCustomOptionSet Boolean Indicates whether the option set is custom or part of a default configuration.
OptionSet_IsGlobal Boolean Specifies if the option set is global (shared across entities) or local (specific to one entity).
OptionSet_IsManaged Boolean Indicates if the option set is managed (part of a managed solution).
OptionSet_MetadataId String The unique identifier for the metadata associated with the option set.
OptionSet_Name String The name of the option set.
OptionSet_OptionSetType String The type of the option set (e.g., picklist, drop-down).
OptionSet_ParentOptionSetName String The name of the parent option set, if this option set is part of a hierarchy.
TableName String The name of the table where the picklist attribute is defined.

Microsoft Dataverse Connector for CData Sync

PickListOptions

Defines the set of selectable options available for Picklist attributes, supporting user-defined field values.

ビュー固有の情報

Select

Sync App はMicrosoft Dataverse API を使用して、以下のカラムと演算子で作成されたWHERE 句条件を処理します。その他のフィルタはクライアントサイドでSync App 内部で処理されます。

  • TableName は'='、'IN' 演算子をサポートしています。

TableName でフィルタリングしない場合、Sync App は最初に見つかったテーブルの結果を返します。

例えば、次のクエリはサーバーサイドで処理されます。

SELECT * FROM PickListOptions WHERE TableName = 'teams'

SELECT * FROM PickListOptions WHERE TableName IN ('accounts', 'teams')

Columns

Name Type References Description
ColumnName String

PickListAttributeMetaData.ColumnName

The name of the column in the table where the picklist option is defined.
Color String The color code associated with the picklist option, often used for display purposes in user interfaces.
ExternalValue String An external value associated with this picklist option, used for integration with external systems.
HasChanged String Indicates whether the picklist option has been modified since its creation or last update.
IsManaged Boolean Specifies if the picklist option is managed (part of a managed solution).
Label_LocalizedLabels String Localized labels for the picklist option in multiple languages.
Label_UserLocalizedLabel_HasChanged String Indicates if the user-customized label for the picklist option has been modified.
Label_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized label for the picklist option is managed (part of a managed solution).
Label_UserLocalizedLabel_Label String The user-customized label text for the picklist option.
Label_UserLocalizedLabel_LanguageCode Integer The language code corresponding to the user-customized label.
Label_UserLocalizedLabel_MetadataId String The unique identifier for the metadata associated with the user-customized label.
Description_LocalizedLabels String Localized descriptions for the picklist option in various supported languages.
Description_UserLocalizedLabel String The user-customized description for the picklist option, providing additional context or meaning.
MetadataId String The unique identifier for the metadata associated with this picklist option.
ParentValues String Specifies the parent values for hierarchical picklist options, if applicable.
Value Integer The integer value associated with this picklist option, used for storage and retrieval.
TableName String The name of the table where this picklist option is defined.

Microsoft Dataverse Connector for CData Sync

StateAttributeMetadata

Provides metadata for attributes of type State, describing state-related fields used for status tracking or categorization.

ビュー固有の情報

Select

TableName でフィルタリングしない場合、Sync App は最初に見つかったテーブルの結果を返します。

以下の例は、特定のテーブルまたはテーブルのリストに対してビューをクエリする方法を示しています。

SELECT * FROM StateAttributeMetaData WHERE TableName='AccountLeads'

SELECT * FROM StateAttributeMetaData WHERE TableName IN ('Account','AccountLead');

Columns

Name Type References Description
ColumnName [KEY] String The name of the column in the table where the state attribute is defined.
MetadataId String The unique identifier for the metadata associated with this state attribute.
OptionSet_Description_LocalizedLabels String Localized descriptions for the state options in various supported languages.
OptionSet_Description_UserLocalizedLabel_HasChanged String Indicates whether the user-customized description label for the state options has been modified.
OptionSet_Description_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized description label for the state options is managed (part of a managed solution).
OptionSet_Description_UserLocalizedLabel_Label String The user-customized label text for the description of the state options.
OptionSet_Description_UserLocalizedLabel_LanguageCode Integer The language code associated with the user-customized description label.
OptionSet_Description_UserLocalizedLabel_MetadataId String The unique identifier for the metadata of the user-customized description label.
OptionSet_DisplayName_LocalizedLabels String Localized display names for the state options in various supported languages.
OptionSet_DisplayName_UserLocalizedLabel_HasChanged String Indicates whether the user-customized display name label for the state options has been modified.
OptionSet_DisplayName_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized display name label for the state options is managed (part of a managed solution).
OptionSet_DisplayName_UserLocalizedLabel_Label String The user-customized label text for the display name of the state options.
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode Integer The language code associated with the user-customized display name label.
OptionSet_DisplayName_UserLocalizedLabel_MetadataId String The unique identifier for the metadata of the user-customized display name label.
OptionSet_ExternalTypeName String The external type name associated with the state options, if applicable.
OptionSet_HasChanged String Indicates whether the state option set has been modified since its creation or last update.
OptionSet_IntroducedVersion String The version of the system in which the state option set was introduced.
OptionSet_IsCustomizable_CanBeChanged Boolean Indicates whether the state option set can be customized by the user or administrators.
OptionSet_IsCustomizable_ManagedPropertyLogicalName String The logical name of the managed property controlling the customizability of the state option set.
OptionSet_IsCustomizable_Value Boolean Specifies if the state option set is customizable.
OptionSet_IsCustomOptionSet Boolean Indicates whether the state option set is custom or part of a default configuration.
OptionSet_IsGlobal Boolean Specifies if the state option set is global (shared across entities) or local (specific to one entity).
OptionSet_IsManaged Boolean Indicates if the state option set is managed (part of a managed solution).
OptionSet_MetadataId String The unique identifier for the metadata associated with the state option set.
OptionSet_Name String The name of the state option set.
OptionSet_OptionSetType String The type of the state option set (e.g., picklist, drop-down).
OptionSet_ParentOptionSetName String The name of the parent option set, if this state option set is part of a hierarchy.
TableName String The name of the table where this state attribute is defined.

Microsoft Dataverse Connector for CData Sync

StateAttributeOptions

Lists the selectable states available for State attributes, representing various predefined states.

ビュー固有の情報

Select

TableName でフィルタリングしない場合、Sync App は最初に見つかったテーブルの結果を返します。

以下の例は、特定のテーブルまたはテーブルのリストに対してビューをクエリする方法を示しています。

SELECT * FROM StateAttributeOptions WHERE TableName='AccountLeads'

SELECT * FROM StateAttributeOptions WHERE TableName IN ('Account','AccountLead');

Columns

Name Type References Description
ColumnName String

StateAttributeMetadata.ColumnName

The name of the column in the table where the state option is defined.
Color String The color code associated with the state option, often used for UI representation.
ExternalValue String An external system value mapped to this state option, if applicable.
HasChanged String Indicates whether the state option has been modified since its creation or last update.
IsManaged Boolean Specifies if the state option is managed (part of a managed solution).
Label_LocalizedLabels String Localized labels for the state option in various supported languages.
Label_UserLocalizedLabel_HasChanged String Indicates if the user-customized label for the state option has been modified.
Label_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized label for the state option is managed (part of a managed solution).
Label_UserLocalizedLabel_Label String The user-customized label text for the state option.
Label_UserLocalizedLabel_LanguageCode Integer The language code corresponding to the user-customized label.
Label_UserLocalizedLabel_MetadataId String The unique identifier for the metadata associated with the user-customized label.
Description_LocalizedLabels String Localized descriptions for the state option in various supported languages.
Description_UserLocalizedLabel String The user-customized description for the state option, providing additional context or details.
MetadataId String The unique identifier for the metadata associated with the state option.
ParentValues String Specifies the parent values for hierarchical state options, if applicable.
Value Integer The integer value associated with this state option, used for storage and retrieval.
TableName String The name of the table where this state option is defined.

Microsoft Dataverse Connector for CData Sync

StatusAttributeMetadata

Contains metadata for attributes of type Status, often used to track the lifecycle or current condition of an entity.

ビュー固有の情報

Select

TableName でフィルタリングしない場合、Sync App は最初に見つかったテーブルの結果を返します。

以下の例は、特定のテーブルまたはテーブルのリストに対してビューをクエリする方法を示しています。

SELECT * FROM StatusAttributeMetaData WHERE TableName='AccountLeads'

SELECT * FROM StatusAttributeMetaData WHERE TableName IN ('Account','AccountLead');

Columns

Name Type References Description
ColumnName [KEY] String The name of the column in the table where the status attribute is defined.
MetadataId String The unique identifier for the metadata associated with this status attribute.
OptionSet_Description_LocalizedLabels String Localized descriptions for the status options in various supported languages.
OptionSet_Description_UserLocalizedLabel_HasChanged String Indicates whether the user-customized description label for the status options has been modified.
OptionSet_Description_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized description label for the status options is managed (part of a managed solution).
OptionSet_Description_UserLocalizedLabel_Label String The user-customized label text for the description of the status options.
OptionSet_Description_UserLocalizedLabel_LanguageCode Integer The language code associated with the user-customized description label.
OptionSet_Description_UserLocalizedLabel_MetadataId String The unique identifier for the metadata of the user-customized description label.
OptionSet_DisplayName_LocalizedLabels String Localized display names for the status options in various supported languages.
OptionSet_DisplayName_UserLocalizedLabel_HasChanged String Indicates whether the user-customized display name label for the status options has been modified.
OptionSet_DisplayName_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized display name label for the status options is managed (part of a managed solution).
OptionSet_DisplayName_UserLocalizedLabel_Label String The user-customized label text for the display name of the status options.
OptionSet_DisplayName_UserLocalizedLabel_LanguageCode Integer The language code associated with the user-customized display name label.
OptionSet_DisplayName_UserLocalizedLabel_MetadataId String The unique identifier for the metadata of the user-customized display name label.
OptionSet_ExternalTypeName String The external type name associated with the status options, if applicable.
OptionSet_HasChanged String Indicates whether the status option set has been modified since its creation or last update.
OptionSet_IntroducedVersion String The version of the system in which the status option set was introduced.
OptionSet_IsCustomizable_CanBeChanged Boolean Indicates whether the status option set can be customized by the user or administrators.
OptionSet_IsCustomizable_ManagedPropertyLogicalName String The logical name of the managed property controlling the customizability of the status option set.
OptionSet_IsCustomizable_Value Boolean Specifies if the status option set is customizable.
OptionSet_IsCustomOptionSet Boolean Indicates whether the status option set is custom or part of a default configuration.
OptionSet_IsGlobal Boolean Specifies if the status option set is global (shared across entities) or local (specific to one entity).
OptionSet_IsManaged Boolean Indicates if the status option set is managed (part of a managed solution).
OptionSet_MetadataId String The unique identifier for the metadata associated with the status option set.
OptionSet_Name String The name of the status option set.
OptionSet_OptionSetType String The type of the status option set (e.g., picklist, drop-down).
OptionSet_ParentOptionSetName String The name of the parent option set, if this status option set is part of a hierarchy.
TableName String The name of the table where this status attribute is defined.

Microsoft Dataverse Connector for CData Sync

StatusAttributeOptions

Defines the set of statuses that can be assigned to Status attributes, supporting status-driven workflows.

ビュー固有の情報

Select

TableName でフィルタリングしない場合、Sync App は最初に見つかったテーブルの結果を返します。

以下の例は、特定のテーブルまたはテーブルのリストに対してビューをクエリする方法を示しています。

SELECT * FROM StatusAttributesOptions WHERE TableName='AccountLeads'

SELECT * FROM StatusAttributesOptions WHERE TableName IN ('Account','AccountLead');

Columns

Name Type References Description
ColumnName String

StatusAttributeMetadata.ColumnName

The name of the column in the table where the status option is defined.
Color String The color code associated with the status option, typically used for visual representation in user interfaces.
ExternalValue String An external system value mapped to this status option, if applicable.
HasChanged String Indicates whether the status option has been modified since its creation or last update.
IsManaged Boolean Specifies if the status option is managed (part of a managed solution).
Label_LocalizedLabels String Localized labels for the status option in various supported languages.
Label_UserLocalizedLabel_HasChanged String Indicates if the user-customized label for the status option has been modified.
Label_UserLocalizedLabel_IsManaged Boolean Specifies if the user-customized label for the status option is managed (part of a managed solution).
Label_UserLocalizedLabel_Label String The user-customized label text for the status option.
Label_UserLocalizedLabel_LanguageCode Integer The language code corresponding to the user-customized label.
Label_UserLocalizedLabel_MetadataId String The unique identifier for the metadata associated with the user-customized label.
Description_LocalizedLabels String Localized descriptions for the status option in various supported languages.
Description_UserLocalizedLabel String The user-customized description for the status option, providing additional context or details.
MetadataId String The unique identifier for the metadata associated with the status option.
ParentValues String Specifies the parent values for hierarchical status options, if applicable.
Value Integer The integer value associated with this status option, used for storage and retrieval.
TableName String The name of the table where this status option is defined.

Microsoft Dataverse Connector for CData Sync

システムデータモデル

System データモデルは、セキュリティ、監査、システムレベルの操作など、プラットフォームのコア機能をサポートする基本的なフレームワークを定義します。メタデータ、ユーザーロール、ワークフロー、バックグラウンドプロセスを管理し、シームレスなデータガバナンスとビジネスアプリケーション間の統合を実現します。

ストアドプロシージャ

ストアドプロシージャ は、SQLクエリを介して呼び出されるアクションです。標準的なCRUD 操作だけでなく、OAuth アクセストークンの取得や更新などより高度なタスクも実行します。

Microsoft Dataverse Connector for CData Sync

データ型マッピング

データ型のマッピング

Sync App は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。以下のテーブルはこれらのマッピングを説明します。

Microsoft Dataverse (OData V4) CData スキーマ
Edm.Binary binary
Edm.Boolean bool
Edm.Date datetime
Edm.DateTimeOffset datetime
Edm.Decimal decimal
Edm.Double double
Edm.Guid guid
Edm.Int32 int
Edm.String string
Edm.TimeOfDay time

Microsoft Dataverse Connector for CData Sync

接続文字列オプション

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

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

Authentication


プロパティ説明
AuthSchemeMicrosoft Dataverse に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。
OrganizationURLDynamics 365 組織のURL。リソースとも呼ばれます。お使いのMicrosoft Dataverse インスタンスの正確なURL を見つけるには、Web Services ページを検索してください。
ApiVersion使用されているAPI のバージョンを示します。認証時に利用可能なAPI 機能の全範囲にアクセスできるように、この設定を最新の状態に保ってください。

Azure Authentication


プロパティ説明
AzureTenantデータにアクセスするために使用されるMicrosoft Dataverse テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き)
AzureEnvironment接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecretカスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthGrantType選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。

JWT OAuth


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

SSL


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

Firewall


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

Proxy


プロパティ説明
ProxyAutoDetectprovider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServerHTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPortクライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)の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 です。
SchemaMicrosoft Dataverse からメタデータをリストする際に使用するスキーマを指定します。

Miscellaneous


プロパティ説明
ContinueOnErrorエラーが発生した後にバッチリクエストを続行するかどうかを指定します。(OData 4.0 以降のみ。)
IncludeFormattedValuesSpecifies whether columns that hold formatted values should be exposed.
IncludeLookUpLogicalNameIndicates if the referenced entity name for a LookUp field should be exposed.
IncludeNavigationKeysSpecifies whether the column listing should include the primary keys of navigation properties. (JSON responses only)
IncludeNavigationPropertiesSpecifies whether the column listing should include navigation properties.
MaxRows集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UseDisplayNamesIf set to true, the provider will use display names for some operations.
UserDefinedViewsカスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
Microsoft Dataverse Connector for CData Sync

Authentication

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


プロパティ説明
AuthSchemeMicrosoft Dataverse に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。
OrganizationURLDynamics 365 組織のURL。リソースとも呼ばれます。お使いのMicrosoft Dataverse インスタンスの正確なURL を見つけるには、Web Services ページを検索してください。
ApiVersion使用されているAPI のバージョンを示します。認証時に利用可能なAPI 機能の全範囲にアクセスできるように、この設定を最新の状態に保ってください。
Microsoft Dataverse Connector for CData Sync

AuthScheme

Microsoft Dataverse に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。

解説

  • AzureAD:Azure Active Directory(ユーザーベース)のOAuth 認証を実行します。
  • AzureMSI:Azure VM で実行している際に、Azure AD マネージドサービスID の資格情報を自動的に取得します。
  • AzureServicePrincipal:クライアントシークレットを使用してAzure サービスプリンシパル(ロールベース、アプリケーションベース)として認証します。
  • AzureServicePrincipalCert:証明書を使用してAzure サービスプリンシパル(ロールベース、アプリケーションベース)として認証します。

Azure AD で認証するためのカスタムアプリケーションの作成方法については、Azure AD アプリケーションの作成 を参照してください。

Azure AD サービスプリンシパルで認証するためのカスタムアプリケーションの作成方法については、サービスプリンシパルによるAzure AD アプリの作成 を参照してください。

Microsoft Dataverse Connector for CData Sync

OrganizationURL

Dynamics 365 組織のURL。リソースとも呼ばれます。お使いのMicrosoft Dataverse インスタンスの正確なURL を見つけるには、Web Services ページを検索してください。

解説

リソースのURL 形式は通常https://abc123.cloudax.dynamics.com/ に類似していますが、Edition がHumanResources の場合は異なります。 HumanResources のURL は通常次のようになります:https://{cluster}.hr.talent.dynamics.com/namespaces/{namespace_guid}/。

Microsoft Dataverse Connector for CData Sync

ApiVersion

使用されているAPI のバージョンを示します。認証時に利用可能なAPI 機能の全範囲にアクセスできるように、この設定を最新の状態に保ってください。

解説

サービスAPI は、データモデルの新機能にアクセスする手段を提供します。 ApiVersion を変更すると、ドライバーによって公開されるテーブルやカラムを定義するために使用されるサービスドキュメントが変更されます。

Microsoft Dataverse Connector for CData Sync

Azure Authentication

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


プロパティ説明
AzureTenantデータにアクセスするために使用されるMicrosoft Dataverse テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き)
AzureEnvironment接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。
Microsoft Dataverse Connector for CData Sync

AzureTenant

データにアクセスするために使用されるMicrosoft Dataverse テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き)

解説

テナントは、主にドメイン(例えば、microsoft.com)に関連付けられた、組織のデジタル表現です。 テナントは、Tenant ID(ディレクトリID とも呼ばれる)によって管理されます。これは、Azure リソースへのアクセスや管理権限をユーザーに割り当てる際に指定します。

Azure ポータルでディレクトリID を見つけるには、Azure Active Directory -> プロパティに移動します。

AuthScheme = AzureServicePrincipal またはAzureServicePrincipalCert のいずれかである場合、またはAzureTenant = AzureAD であり、ユーザーが複数のテナントに属している場合は、AzureTenant を指定する必要があります。

Microsoft Dataverse Connector for CData Sync

AzureEnvironment

接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。

解説

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

Microsoft Dataverse Connector for CData Sync

OAuth

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


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecretカスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthGrantType選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。
Microsoft Dataverse Connector for CData Sync

OAuthClientId

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

Microsoft Dataverse Connector for CData Sync

OAuthClientSecret

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

Microsoft Dataverse Connector for CData Sync

OAuthGrantType

選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。

解説

ほとんどの場合、デフォルトのグラント種別は変更すべきではありません。 最も一般的なOAuth グラント種別とそれぞれのメリット・デメリットについては、https://oauth.net/2/grant-types/ を参照してください。

Microsoft Dataverse Connector for CData Sync

JWT OAuth

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


プロパティ説明
OAuthJWTCertJWT 証明書のストア。
OAuthJWTCertTypeJWT 証明書を格納するキーストアの種類。
OAuthJWTCertPasswordOAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
OAuthJWTCertSubjectOAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
Microsoft Dataverse Connector for CData Sync

OAuthJWTCert

JWT 証明書のストア。

解説

クライアント証明書のための証明書ストア名。

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

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

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

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

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

Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。

証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ(例えば、PKCS12証明書ストア)に設定する必要があります。

Microsoft Dataverse Connector for CData Sync

OAuthJWTCertType

JWT 証明書を格納するキーストアの種類。

解説

このプロパティには次の値の一つを設定できます。

USERWindows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note:この種類はJava では利用できません。
MACHINEWindows の場合、この証明書ストアがシステムストアであることを指定します。 Note:この種類はJava では利用できません。
PFXFILEこの証明書ストアは、証明書を含むPFX(PKCS12)ファイルの名前です。
PFXBLOBこの証明書ストアは、PFX(PKCS12)形式の証明書ストアを表すBase-64でエンコードされた文字列です。
JKSFILEこの証明書ストアは、証明書を含むJava key store(JKS)ファイルの名前です。 Note:この種類はJava のみで利用できます。
JKSBLOBこの証明書ストアは、Java key store(JKS)形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note:この種類は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 Dataverse Connector for CData Sync

OAuthJWTCertPassword

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

解説

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

Microsoft Dataverse 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 Dataverse Connector for CData Sync

SSL

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


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
Microsoft Dataverse 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

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

Microsoft Dataverse Connector for CData Sync

Firewall

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


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

FirewallType

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

解説

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

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

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

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

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

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

Microsoft Dataverse Connector for CData Sync

FirewallServer

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

解説

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

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

Microsoft Dataverse Connector for CData Sync

FirewallPort

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

解説

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

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

Microsoft Dataverse Connector for CData Sync

FirewallUser

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

解説

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

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

Microsoft Dataverse Connector for CData Sync

FirewallPassword

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

解説

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

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

Microsoft Dataverse Connector for CData Sync

Proxy

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


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

ProxyAutoDetect

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

解説

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

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

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

Microsoft Dataverse Connector for CData Sync

ProxyServer

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

解説

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

Microsoft Dataverse Connector for CData Sync

ProxyPort

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

解説

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

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

Microsoft Dataverse Connector for CData Sync

ProxyAuthScheme

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

解説

認証タイプは次のいずれかです。

  • BASIC:Sync App はHTTP BASIC 認証を行います。
  • DIGEST:Sync App はHTTP DIGEST 認証を行います。
  • NTLM:Sync App はNTLM トークンを取得します。
  • NEGOTIATE:Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
  • NONE:ProxyServer が認証を必要としない場合に設定します。

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

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

Microsoft Dataverse 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 接続プロパティは設定しないでください。

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

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

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

Microsoft Dataverse 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 Dataverse Connector for CData Sync

ProxyExceptions

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

解説

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

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

Microsoft Dataverse Connector for CData Sync

Logging

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


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

LogModules

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

解説

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります:INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。

Microsoft Dataverse Connector for CData Sync

Schema

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


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

Location

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

解説

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

Note: Sync App は複数のスキーマをサポートするため、Microsoft Dataverse のカスタムスキーマファイルは以下のような構造にになります。

  • 各スキーマには、そのスキーマ名に対応するフォルダが作られます。
  • すべてのスキーマフォルダは、親フォルダに含まれる必要があります。

Location は常に親フォルダに設定されるべきで、個々のスキーマのフォルダに設定すべきではありません。

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

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

Microsoft Dataverse Connector for CData Sync

BrowsableSchemas

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

解説

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

Microsoft Dataverse Connector for CData Sync

Tables

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

解説

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

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

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

Microsoft Dataverse Connector for CData Sync

Views

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

解説

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

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

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

Microsoft Dataverse Connector for CData Sync

Schema

Microsoft Dataverse からメタデータをリストする際に使用するスキーマを指定します。

解説

この接続プロパティには、以下の値を設定できます。

  • System:Microsoft Dataverse オブジェクトを、あまり詳細でないメタデータとともに公開します。テーブルはシステムレベルの名前を使用します。返されるメタデータが比較的単純なため、このスキーマからのデータ取得はより高速です。デフォルトではこのスキーマが選択されています。
  • Entities:Microsoft Dataverse オブジェクトを、より詳細なメタデータ(アノテーションやデータ型の詳細を含む)と、よりユーザーフレンドリーなテーブル名で公開します。返されるメタデータが複雑になっているため、このスキーマからのデータ取得には時間がかかります。

Microsoft Dataverse Connector for CData Sync

Miscellaneous

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


プロパティ説明
ContinueOnErrorエラーが発生した後にバッチリクエストを続行するかどうかを指定します。(OData 4.0 以降のみ。)
IncludeFormattedValuesSpecifies whether columns that hold formatted values should be exposed.
IncludeLookUpLogicalNameIndicates if the referenced entity name for a LookUp field should be exposed.
IncludeNavigationKeysSpecifies whether the column listing should include the primary keys of navigation properties. (JSON responses only)
IncludeNavigationPropertiesSpecifies whether the column listing should include navigation properties.
MaxRows集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
Other特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UseDisplayNamesIf set to true, the provider will use display names for some operations.
UserDefinedViewsカスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
Microsoft Dataverse Connector for CData Sync

ContinueOnError

エラーが発生した後にバッチリクエストを続行するかどうかを指定します。(OData 4.0 以降のみ。)

解説

ContinueOnError がtrue に設定されている場合、エラーが発生したバッチ操作は完了し、エラー応答を含む結果テーブルが作成されます。 ContinueOnError がfalse に設定されている場合、エラーが発生したバッチ操作は中止され、エラーメッセージが表示されます。

Microsoft Dataverse Connector for CData Sync

IncludeFormattedValues

Specifies whether columns that hold formatted values should be exposed.

解説

If set to true, an extra column named columnname_display is added beside each column. If the column contains a formatted value, the new column exposes that formatted values. If the field does not have a formatted value, columname_display is null.

Microsoft Dataverse Connector for CData Sync

IncludeLookUpLogicalName

Indicates if the referenced entity name for a LookUp field should be exposed.

解説

For each key column, an extra one is added to expose the LookUp logical name value. New columns will have "_lookuplogicalname" postfix.

Microsoft Dataverse Connector for CData Sync

IncludeNavigationKeys

Specifies whether the column listing should include the primary keys of navigation properties. (JSON responses only)

解説

This property is provided to make it simpler to retrieve JSON record references where possible. When true, the $prod; pushes a set of fields for each table relation.

These properties are not available for use in INSERT or UPDATE operations. (Use the Linked* navigation columns for that).

If your service supports both XML/ATOM and JSON and you want to use this property, be sure to set DataFormat to JSON.

Microsoft Dataverse Connector for CData Sync

IncludeNavigationProperties

Specifies whether the column listing should include navigation properties.

解説

Navigation properties provide a way to navigate an association between two entity types. Every object can have a navigation property for every relationship in which it participates.

Navigation properties enable you to navigate and manage relationships in two ways:

  • Two-directional navigation returns either a reference object (if the relationship is either 1 or 0-or-1) or a collection (if the relationship is 1-to-many).
  • One-directional navigation enables you to define the navigation property on just one of the types that participates in the relationship, but not both.

When retrieving data, the navigation properties in a cell do not populate with information. Rather, they act to bind the content to an existing resource during inserts or updates. For example:

INSERT INTO accounts (_primarycontactid_value) VALUES ('123456')

To specify multiple values, use a comma-separated list. For instance:

INSERT INTO accounts (lead_customer_accounts) VALUES ('123,456')

Microsoft Dataverse Connector for CData Sync

MaxRows

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

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

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

Microsoft Dataverse Connector for CData Sync

Other

特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

解説

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。

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

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット

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

Microsoft Dataverse Connector for CData Sync

PseudoColumns

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

解説

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

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"

Microsoft Dataverse Connector for CData Sync

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

解説

このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。

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

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

Microsoft Dataverse Connector for CData Sync

UseDisplayNames

If set to true, the provider will use display names for some operations.

解説

If set to true, the Sync App will use display names for some operations. This property is used only for Entities schema.

Microsoft Dataverse Connector for CData Sync

UserDefinedViews

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

解説

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


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

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例:UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

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

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175