CData Sync App は、Microsoft Dynamics 365 データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Microsoft Dynamics 365 コネクタはCData Sync アプリケーションから使用可能で、Microsoft Dynamics 365 からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App はOData Web サービスを介してMicrosoft Dynamics 365 への読み取り/書き込みアクセスをサポートします。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
Notes:
接続するには、次のパラメータを設定します。
接続するには、次のプロパティを設定します。
組織がAzure テナントの新しいOAuth アプリケーションを認可するために管理者の同意を必要とする場合、組織の誰かが初めてOAuth アプリケーションをインストールして使用するときは、組織の管理者が明示的にそのアプリケーションへのアクセスを許可する必要があることを意味します。
(組織はこの要件を無効にすることができます。)
管理者の同意の付与
Azure ポータルで新しいOAuth アプリケーションを作成する場合(Azure AD アプリケーションの作成 参照)には、そのアプリケーションに必要なアクセス許可を指定する必要があります。 新しいカスタムアプリケーションに管理者の同意が必要であることが分かっている場合は、管理者の同意が必要と表示されている権限を指定することから始めることができます。 (例えば、すべてのグループのアクセス許可には管理者の同意が必要です。)
管理者の同意を付与するには2つの方法があります。
管理者が同意を付与すると、通常通り認証が行われます。
クライアントOAuth フローに関連するすべてのアクセス許可には、管理者の同意が必要です。 これは、CData Sync App が埋め込まれたアプリケーションをクライアントOAuth フローでは使用できないことを意味します。クライアントクレデンシャルを使用するには、Azure AD アプリケーションの作成 で説明するように独自のOAuth アプリケーションを作成する必要があります。
これを行うには:
接続するには、次のプロパティを設定します。
接続の準備ができたら、次のプロパティを設定します。
Azure VM 上でMicrosoft Dynamics 365 を実行しており、マネージドID(MSI)認証情報を自動的に取得して接続したい場合は、AuthScheme を AzureMSI に設定します。
VM に複数のユーザーが割り当てられたマネージドID がある場合は、OAuthClientId も指定する必要があります。
このセクションでは、Microsoft Dynamics 365 Sync App の高度な機能を厳選して説明します。
Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
詳しくは、クエリ処理 を参照してください。
デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
CData Sync App は、Microsoft Dynamics 365 データをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。テーブル定義は、接続先のMicrosoft Dynamics 365 OData サービスから動的に取得されます。カラムの新規追加や削除、データ型の変更など、メタデータに変更があった場合は再接続時に自動的に読み込まれます。
ビュー セクションには読み取り専用SQL テーブルの一覧が記載されています。これらには、Microsoft Dynamics 365 アカウントでのアクセスを想定したサンプルが含まれています。
以下のビューはSync App に同梱されています。
| ビュー | 説明 |
| MultiSelectPickListAttributeMetaData | MultiSelect OptionSet タイプの属性に対するメタデータを格納します。このメタデータは、Edition が CustomerService、FieldService、Marketing、ProjectOperations、またはSales に設定されている場合にのみ利用可能です。 |
| MultiSelectPickListOptions | MultiSelect Picklist メタデータ属性の値(オプション)を含みます。Edition が CustomerService、FieldService、Marketing、ProjectOperations、またはSales に設定されている場合にのみ利用可能です。 |
| PickListAttributeMetaData | Picklist タイプの属性に対するメタデータを保持し、そのオプションと構成の詳細を示します。Edition が CustomerService、FieldService、Marketing、ProjectOperations、またはSales に設定されている場合にのみ利用可能です。 |
| PickListOptions | Picklist メタデータ属性のオプション値を格納し、列挙されたセレクションの詳細を提供します。Edition が CustomerService、FieldService、Marketing、ProjectOperations、またはSales に設定されている場合にのみ利用可能です。 |
ストアドプロシージャ は、SQLクエリを介して呼び出されるアクションです。標準的なCRUD 操作だけでなく、関連付けの管理やOAuth アクセストークンの取得など、より高度なタスクも実行します。
Sync App は、Microsoft Dynamics 365 OData サービスを使用して接続時にすべてのMicrosoft Dynamics 365 テーブルを動的に取得します。
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| MultiSelectPickListAttributeMetaData | Stores metadata for attributes with a MultiSelect OptionSet type. This metadata is only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales. |
| MultiSelectPickListOptions | Contains the values (options) for MultiSelect Picklist metadata attributes. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales. |
| PickListAttributeMetaData | Holds metadata for attributes of the Picklist type, detailing their options and configuration. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales. |
| PickListOptions | Stores option values for Picklist metadata attributes, providing details for enumerated selections. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales. |
Stores metadata for attributes with a MultiSelect OptionSet type. This metadata is only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.
The Sync App will use the Microsoft Dynamics 365 API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM MultiSelectPickListAttributeMetaData WHERE TableName = 'teams'
SELECT * FROM MultiSelectPickListAttributeMetaData WHERE TableName IN ('accounts', 'teams')
| Name | Type | Description |
| ColumnName [KEY] | String | The name of the column representing the attribute within the table. |
| MetadataId | String | The unique identifier for the metadata of the attribute. |
| OptionSet_Description_LocalizedLabels | String | Localized labels providing descriptions for the option set in various languages. |
| OptionSet_Description_UserLocalizedLabel_HasChanged | String | Indicates if the user-defined localized label for the description has been modified. |
| OptionSet_Description_UserLocalizedLabel_IsManaged | Boolean | Specifies whether the user-defined localized label for the description is managed. |
| OptionSet_Description_UserLocalizedLabel_Label | String | The actual text of the user-defined localized label for the description. |
| OptionSet_Description_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-defined localized label for the description. |
| OptionSet_Description_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-defined localized label for the description. |
| OptionSet_DisplayName_LocalizedLabels | String | Localized labels providing display names for the option set in various languages. |
| OptionSet_DisplayName_UserLocalizedLabel_HasChanged | String | Indicates if the user-defined localized label for the display name has been modified. |
| OptionSet_DisplayName_UserLocalizedLabel_IsManaged | Boolean | Specifies whether the user-defined localized label for the display name is managed. |
| OptionSet_DisplayName_UserLocalizedLabel_Label | String | The actual text of the user-defined localized label for the display name. |
| OptionSet_DisplayName_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-defined localized label for the display name. |
| OptionSet_DisplayName_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-defined localized label for the display name. |
| OptionSet_ExternalTypeName | String | The external type name associated with the option set, if applicable. |
| OptionSet_HasChanged | String | Indicates whether the option set has been modified since its creation. |
| 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. |
| OptionSet_IsCustomizable_ManagedPropertyLogicalName | String | The logical name of the managed property that defines whether the option set is customizable. |
| OptionSet_IsCustomizable_Value | Boolean | Specifies if the option set is marked as customizable. |
| OptionSet_IsCustomOptionSet | Boolean | Specifies if the option set is custom or predefined. |
| OptionSet_IsGlobal | Boolean | Indicates whether the option set is global (shared across entities) or local to a specific entity. |
| OptionSet_IsManaged | Boolean | Specifies if the option set is part of a managed solution. |
| OptionSet_MetadataId | String | The unique identifier for the metadata of the option set. |
| OptionSet_Name | String | The name of the option set. |
| OptionSet_OptionSetType | String | The type of the option set, defining its structure and usage. |
| OptionSet_ParentOptionSetName | String | The name of the parent option set if the current option set is part of a hierarchical structure. |
| TableName | String | The name of the table containing the attribute represented by the option set. |
Contains the values (options) for MultiSelect Picklist metadata attributes. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.
The Sync App will use the Microsoft Dynamics 365 API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM MultiSelectPickListOptions WHERE TableName = 'teams'
SELECT * FROM MultiSelectPickListOptions WHERE TableName IN ('accounts', 'teams')
| Name | Type | Description |
| ColumnName | String | The name of the column representing the multi-select picklist attribute. |
| Color | String | The color associated with the picklist option, typically used for UI representation. |
| ExternalValue | String | The external value associated with the picklist option, used for integration or mapping purposes. |
| HasChanged | String | Indicates whether the picklist option has been modified since its creation. |
| IsManaged | Boolean | Specifies whether the picklist option is part of a managed solution. |
| Label_LocalizedLabels | String | Localized labels providing display names for the picklist option in various languages. |
| Label_UserLocalizedLabel_HasChanged | String | Indicates if the user-defined localized label for the picklist option's label has been modified. |
| Label_UserLocalizedLabel_IsManaged | Boolean | Specifies whether the user-defined localized label for the picklist option's label is managed. |
| Label_UserLocalizedLabel_Label | String | The actual text of the user-defined localized label for the picklist option's label. |
| Label_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-defined localized label for the picklist option's label. |
| Label_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-defined localized label for the picklist option's label. |
| Description_LocalizedLabels | String | Localized labels providing descriptions for the picklist option in various languages. |
| Description_UserLocalizedLabel_HasChanged | String | Indicates if the user-defined localized label for the picklist option's description has been modified. |
| Description_UserLocalizedLabel_IsManaged | Boolean | Specifies whether the user-defined localized label for the picklist option's description is managed. |
| Description_UserLocalizedLabel_Label | String | The actual text of the user-defined localized label for the picklist option's description. |
| Description_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-defined localized label for the picklist option's description. |
| Description_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-defined localized label for the picklist option's description. |
| MetadataId | String | The unique identifier for the metadata of the picklist option. |
| ParentValues | String | The parent values associated with the picklist option, used when the option is part of a hierarchical structure. |
| Value | Integer | The numeric value assigned to the picklist option. |
| TableName | String | The name of the table containing the multi-select picklist attribute. |
Holds metadata for attributes of the Picklist type, detailing their options and configuration. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.
The Sync App will use the Microsoft Dynamics 365 API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM PickListAttributeMetaData WHERE TableName = 'teams'
SELECT * FROM PickListAttributeMetaData WHERE TableName IN ('accounts', 'teams')
| Name | Type | Description |
| ColumnName [KEY] | String | The name of the column representing the picklist attribute within the table. |
| MetadataId | String | The unique identifier for the metadata of the picklist attribute. |
| OptionSet_Description_LocalizedLabels | String | Localized labels providing descriptions for the option set in various languages. |
| OptionSet_Description_UserLocalizedLabel_HasChanged | String | Indicates if the user-defined localized label for the description has been modified. |
| OptionSet_Description_UserLocalizedLabel_IsManaged | Boolean | Specifies whether the user-defined localized label for the description is managed. |
| OptionSet_Description_UserLocalizedLabel_Label | String | The actual text of the user-defined localized label for the description. |
| OptionSet_Description_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-defined localized label for the description. |
| OptionSet_Description_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-defined localized label for the description. |
| OptionSet_DisplayName_LocalizedLabels | String | Localized labels providing display names for the option set in various languages. |
| OptionSet_DisplayName_UserLocalizedLabel_HasChanged | String | Indicates if the user-defined localized label for the display name has been modified. |
| OptionSet_DisplayName_UserLocalizedLabel_IsManaged | Boolean | Specifies whether the user-defined localized label for the display name is managed. |
| OptionSet_DisplayName_UserLocalizedLabel_Label | String | The actual text of the user-defined localized label for the display name. |
| OptionSet_DisplayName_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-defined localized label for the display name. |
| OptionSet_DisplayName_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-defined localized label for the display name. |
| OptionSet_ExternalTypeName | String | The external type name associated with the option set, if applicable. |
| OptionSet_HasChanged | String | Indicates whether the option set has been modified since its creation. |
| 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. |
| OptionSet_IsCustomizable_ManagedPropertyLogicalName | String | The logical name of the managed property that defines whether the option set is customizable. |
| OptionSet_IsCustomizable_Value | Boolean | Specifies if the option set is marked as customizable. |
| OptionSet_IsCustomOptionSet | Boolean | Specifies if the option set is custom or predefined. |
| OptionSet_IsGlobal | Boolean | Indicates whether the option set is global (shared across entities) or local to a specific entity. |
| OptionSet_IsManaged | Boolean | Specifies if the option set is part of a managed solution. |
| OptionSet_MetadataId | String | The unique identifier for the metadata of the option set. |
| OptionSet_Name | String | The name of the option set. |
| OptionSet_OptionSetType | String | The type of the option set, defining its structure and usage. |
| OptionSet_ParentOptionSetName | String | The name of the parent option set if the current option set is part of a hierarchical structure. |
| TableName | String | The name of the table containing the picklist attribute. |
Stores option values for Picklist metadata attributes, providing details for enumerated selections. Only available when Edition is set to CustomerService, FieldService, Marketing, ProjectOperations, or Sales.
The Sync App will use the Microsoft Dynamics 365 API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM PickListOptions WHERE TableName = 'teams'
SELECT * FROM PickListOptions WHERE TableName IN ('accounts', 'teams')
| Name | Type | Description |
| ColumnName | String | The name of the column representing the picklist attribute. |
| Color | String | The color associated with the picklist option, typically used for visual representation in the UI. |
| ExternalValue | String | An external value associated with the picklist option, useful for integration or mapping purposes. |
| HasChanged | String | Indicates whether the picklist option has been modified since its creation. |
| IsManaged | Boolean | Specifies whether the picklist option is part of a managed solution. |
| Label_LocalizedLabels | String | Localized labels providing display names for the picklist option in various languages. |
| Label_UserLocalizedLabel_HasChanged | String | Indicates whether the user-defined localized label for the picklist option has been modified. |
| Label_UserLocalizedLabel_IsManaged | Boolean | Specifies whether the user-defined localized label for the picklist option is managed. |
| Label_UserLocalizedLabel_Label | String | The actual text of the user-defined localized label for the picklist option. |
| Label_UserLocalizedLabel_LanguageCode | Integer | The language code associated with the user-defined localized label for the picklist option. |
| Label_UserLocalizedLabel_MetadataId | String | The unique identifier for the metadata of the user-defined localized label for the picklist option. |
| Description_LocalizedLabels | String | Localized labels providing descriptions for the picklist option in various languages. |
| Description_UserLocalizedLabel | String | The user-defined localized label for the description of the picklist option. |
| MetadataId | String | The unique identifier for the metadata of the picklist option. |
| ParentValues | String | The parent values associated with the picklist option, used when the option is part of a hierarchical structure. |
| Value | Integer | The numeric value assigned to the picklist option. |
| TableName | String | The name of the table containing the picklist attribute. |
Sync App は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。以下のテーブルはこれらのマッピングを説明します。
| Microsoft Dynamics 365(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 |
| プロパティ | 説明 |
| AuthScheme | Microsoft Dynamics 365 に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。 |
| OrganizationURL | Dynamics 365 組織のURL。リソースとも呼ばれます。お使いのMicrosoft Dynamics 365 インスタンスの正確なURL を見つけるには、Web Services ページを検索してください。 |
| Edition | 使用しているMicrosoft Dynamics 365 のエディションを指定します。指定されていない場合は、デフォルト(FinOpsOnline)が適用されます。 |
| ADFSServer | Identifies the FinOpsOnPremise ADFS Server to be used for authentication. To find this server name, enter echo %logonserver% at the command prompt. |
| ApiVersion | 使用されているAPI のバージョンを示します。認証時に利用可能なAPI 機能の全範囲にアクセスできるように、この設定を最新の状態に保ってください。 |
| プロパティ | 説明 |
| AzureTenant | データにアクセスするために使用されるMicrosoft Dynamics 365 テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き) |
| AzureEnvironment | 接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。 |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthGrantType | 選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。 |
| プロパティ | 説明 |
| OAuthJWTCert | JWT 証明書のストア。 |
| OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
| OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。 |
| OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。 |
| OAuthJWTIssuer | Java Web Token の発行者。 |
| OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| AllowDuplicateRecords | Notes whether or not the driver will permit the adding of duplicate records during INSERT operations. To create the record (or update it if a duplicate is found), set this to true. To avoid adding duplicate records, set this to false. |
| ContinueOnError | エラーが発生した後にバッチリクエストを続行するかどうかを指定します。(OData 4.0 以降のみ。) |
| CrossCompany | Specifies whether data should be pulled only the user's default company, or for all companies. (FinOpsOnline, FinOpsOnPremise, or HumanResources only.) |
| CustomUrlParams | HTTP リクエストに含めるカスタムURL パラメータの文字列で、field1=value1&field2=value2&field3=value3 の形式。 |
| EnableAtomicBatchOperations | Specifies whether or not batch Create, Update, and Delete (CUD) operations execute independently (if one request fails, the others in the batch continue to execute) or atomically (if one request fails, the whole batch operation fails). |
| IncludeFormattedValues | Specifies whether columns that hold formatted values should be exposed. |
| IncludeLookUpLogicalName | Indicates if the referenced entity name for a LookUp field should be exposed. |
| IncludeNavigationKeys | Specifies whether the column listing should include the primary keys of navigation properties. (JSON responses only) |
| IncludeNavigationProperties | Specifies whether the column listing should include navigation properties. |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| MinimumColumnSize | Specifies the minimum size of an Edm.String column, expressed as a number of characters. If the column size reported by Microsoft Dynamics 365 has a value lower than this value, the CData ADO.NET Provider for Microsoft Dynamics 365 overrides the service value with the one defined in the connection string. |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | Microsoft Dynamics 365 から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UseClientSidePaging | Specifies whether or not Microsoft Dynamics 365 should return data using client-side paging, if your source supports it. If set to false, Microsoft Dynamics 365 uses server-side paging. |
| UseDynamicStoredProcedures | Indicates whether or not stored procedures should be listed dynamically. |
| UseEntityDefinitions | Specifies that queries should use entity definition metadata endpoints, rather than the standard $metadata endpoint. |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | Microsoft Dynamics 365 に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。 |
| OrganizationURL | Dynamics 365 組織のURL。リソースとも呼ばれます。お使いのMicrosoft Dynamics 365 インスタンスの正確なURL を見つけるには、Web Services ページを検索してください。 |
| Edition | 使用しているMicrosoft Dynamics 365 のエディションを指定します。指定されていない場合は、デフォルト(FinOpsOnline)が適用されます。 |
| ADFSServer | Identifies the FinOpsOnPremise ADFS Server to be used for authentication. To find this server name, enter echo %logonserver% at the command prompt. |
| ApiVersion | 使用されているAPI のバージョンを示します。認証時に利用可能なAPI 機能の全範囲にアクセスできるように、この設定を最新の状態に保ってください。 |
Microsoft Dynamics 365 に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。
Azure AD で認証するためのカスタムアプリケーションの作成方法については、Azure AD アプリケーションの作成 を参照してください。
Azure AD サービスプリンシパルで認証するためのカスタムアプリケーションの作成方法については、サービスプリンシパルによるAzure AD アプリの作成 を参照してください。
Dynamics 365 組織のURL。リソースとも呼ばれます。お使いのMicrosoft Dynamics 365 インスタンスの正確なURL を見つけるには、Web Services ページを検索してください。
リソースのURL 形式は通常https://abc123.cloudax.dynamics.com/ に類似していますが、Edition がHumanResources の場合は異なります。 HumanResources のURL は通常次のようになります:https://{cluster}.hr.talent.dynamics.com/namespaces/{namespace_guid}/。
使用しているMicrosoft Dynamics 365 のエディションを指定します。指定されていない場合は、デフォルト(FinOpsOnline)が適用されます。
エディションがFinOpsOnPremise の場合はADFSServer も指定する必要があります。
Identifies the FinOpsOnPremise ADFS Server to be used for authentication. To find this server name, enter echo %logonserver% at the command prompt.
Use only when Edition is set to FinOpsOnPremise. If no ADFS server name is specified, the property is ignored.
使用されているAPI のバージョンを示します。認証時に利用可能なAPI 機能の全範囲にアクセスできるように、この設定を最新の状態に保ってください。
サービスAPI は、データモデルの新機能にアクセスする手段を提供します。 ApiVersion を変更すると、ドライバーによって公開されるテーブルやカラムを定義するために使用されるサービスドキュメントが変更されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なAzure Authentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AzureTenant | データにアクセスするために使用されるMicrosoft Dynamics 365 テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き) |
| AzureEnvironment | 接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。 |
データにアクセスするために使用されるMicrosoft Dynamics 365 テナントを、名前(例えば、contoso.omnicrosoft.com)またはID で識別します。(条件付き)
テナントは、主にドメイン(例えば、microsoft.com)に関連付けられた、組織のデジタル表現です。 テナントは、Tenant ID(ディレクトリID とも呼ばれる)によって管理されます。これは、Azure リソースへのアクセスや管理権限をユーザーに割り当てる際に指定します。
Azure ポータルでディレクトリID を見つけるには、Azure Active Directory -> プロパティに移動します。
AuthScheme = AzureServicePrincipal またはAzureServicePrincipalCert のいずれかである場合、またはAzureTenant = AzureAD であり、ユーザーが複数のテナントに属している場合は、AzureTenant を指定する必要があります。
接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。
Azure アカウントがGlobal ネットワークとは異なるネットワーク(China、USGOVT、USGOVTDOD など)の一部である場合は、必要です。
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthGrantType | 選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。 |
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。
ほとんどの場合、デフォルトのグラント種別は変更すべきではありません。 最も一般的なOAuth グラント種別とそれぞれのメリット・デメリットについては、https://oauth.net/2/grant-types/ を参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthJWTCert | JWT 証明書のストア。 |
| OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
| OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。 |
| OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。 |
| OAuthJWTIssuer | Java Web Token の発行者。 |
| OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
JWT 証明書のストア。
クライアント証明書のための証明書ストア名。
OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。
OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。
証明書ストアの指定はプラットフォームに依存します。
Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。
| MY | 個人証明書と関連付けられた秘密キーを格納している証明書ストア。 |
| CA | 証明機関の証明書。 |
| ROOT | ルート証明書。 |
| SPC | ソフトウェア発行元証明書。 |
Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。
証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ(例えば、PKCS12証明書ストア)に設定する必要があります。
JWT 証明書を格納するキーストアの種類。
このプロパティには次の値の一つを設定できます。
| USER | Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note:この種類はJava では利用できません。 |
| MACHINE | Windows の場合、この証明書ストアがシステムストアであることを指定します。 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エンコード)です。 |
OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。
このプロパティは、証明書ストアを開くために必要なパスワードを指定します。ただし、ストアの種類がパスワードを必要とする場合に限ります。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。
OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。
このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。
値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例:CN=www.server.com, OU=test, C=US, [email protected]。一般的なフィールドには以下のものが含まれます。
| フィールド | 説明 |
| CN | 共通名。一般的には、www.server.com のようなホスト名です。 |
| O | 法人名 |
| OU | 法人の部署名 |
| L | 法人の住所(市町村名) |
| S | 法人の住所(都道府県) |
| C | 国名 |
| E | E メールアドレス |
フィールド値にカンマが含まれる場合は、引用符で囲んでください。例:"O=ACME, Inc."。
Java Web Token の発行者。
Java Web Token の発行者。 通常は、OAuth アプリケーションのクライアントId またはE メールアドレスとなります。
アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。
アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクトです。通常は、ユーザーのアカウント名またはE メールアドレスとなります。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
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 |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がMicrosoft Dynamics 365 への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がMicrosoft Dynamics 365 への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がMicrosoft Dynamics 365 にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
認証タイプは次のいずれかです。
"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
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 は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。
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 は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。
ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
| AUTO | デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。
例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります:INFO;EXEC;SSL。
Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。
利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\Dynamics365 Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:
| プラットフォーム | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。
レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| AllowDuplicateRecords | Notes whether or not the driver will permit the adding of duplicate records during INSERT operations. To create the record (or update it if a duplicate is found), set this to true. To avoid adding duplicate records, set this to false. |
| ContinueOnError | エラーが発生した後にバッチリクエストを続行するかどうかを指定します。(OData 4.0 以降のみ。) |
| CrossCompany | Specifies whether data should be pulled only the user's default company, or for all companies. (FinOpsOnline, FinOpsOnPremise, or HumanResources only.) |
| CustomUrlParams | HTTP リクエストに含めるカスタムURL パラメータの文字列で、field1=value1&field2=value2&field3=value3 の形式。 |
| EnableAtomicBatchOperations | Specifies whether or not batch Create, Update, and Delete (CUD) operations execute independently (if one request fails, the others in the batch continue to execute) or atomically (if one request fails, the whole batch operation fails). |
| IncludeFormattedValues | Specifies whether columns that hold formatted values should be exposed. |
| IncludeLookUpLogicalName | Indicates if the referenced entity name for a LookUp field should be exposed. |
| IncludeNavigationKeys | Specifies whether the column listing should include the primary keys of navigation properties. (JSON responses only) |
| IncludeNavigationProperties | Specifies whether the column listing should include navigation properties. |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| MinimumColumnSize | Specifies the minimum size of an Edm.String column, expressed as a number of characters. If the column size reported by Microsoft Dynamics 365 has a value lower than this value, the CData ADO.NET Provider for Microsoft Dynamics 365 overrides the service value with the one defined in the connection string. |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | Microsoft Dynamics 365 から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UseClientSidePaging | Specifies whether or not Microsoft Dynamics 365 should return data using client-side paging, if your source supports it. If set to false, Microsoft Dynamics 365 uses server-side paging. |
| UseDynamicStoredProcedures | Indicates whether or not stored procedures should be listed dynamically. |
| UseEntityDefinitions | Specifies that queries should use entity definition metadata endpoints, rather than the standard $metadata endpoint. |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
Notes whether or not the driver will permit the adding of duplicate records during INSERT operations. To create the record (or update it if a duplicate is found), set this to true. To avoid adding duplicate records, set this to false.
This property only applies when Edition is CustomerService, FieldService, Marketing, ProjectOperations or Sales.
For further information, see https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/manage-duplicate-detection-create-update.
エラーが発生した後にバッチリクエストを続行するかどうかを指定します。(OData 4.0 以降のみ。)
ContinueOnError がtrue に設定されている場合、エラーが発生したバッチ操作は完了し、エラー応答を含む結果テーブルが作成されます。 ContinueOnError がfalse に設定されている場合、エラーが発生したバッチ操作は中止され、エラーメッセージが表示されます。
Specifies whether data should be pulled only the user's default company, or for all companies. (FinOpsOnline, FinOpsOnPremise, or HumanResources only.)
This property only applies when Edition is set to FinOpsOnline, FinOpsOnPremise or HumanResources.
HTTP リクエストに含めるカスタムURL パラメータの文字列で、field1=value1&field2=value2&field3=value3 の形式。
このプロパティを使用すると、HTTP リクエストに含まれるカスタムクエリ文字列パラメータを指定できます。 パラメータは、各値がURL エンコードされた形式でfield1=value1&field2=value2&field3=value3 の形式で、クエリ文字列としてエンコードする必要があります。 URL エンコーディングは、以下のようにインターネット上で送信可能な文字列に変換する方法です。
Specifies whether or not batch Create, Update, and Delete (CUD) operations execute independently (if one request fails, the others in the batch continue to execute) or atomically (if one request fails, the whole batch operation fails).
If set to false, batch CUD operations are processed non-atomically, allowing individual operations to succeed or fail independently within the batch.
EnableAtomicBatchOperations is tightly coupled with ContinueOnError.
If ContinueOnError and EnableAtomicBatchOperations are both true, all batch rows are treated as a single unit. If a failure occurs, the API stops processing the remaining rows. The driver reports the remaining rows as failed.
If ContinueOnError is false and EnableAtomicBatchOperations is true, all batch rows are processed as a single unit. If one of the rows fails, the driver breaks the flow and displays an error. No rows are reported in LastResultInfo.
If ContinueOnError is true/false (defaults to true for EnableAtomicBatchOperations = false) and EnableAtomicBatchOperations is false, each row in the batch is treated as a single unit. the API processes all the rows. The driver populates LastResultInfo with information about each row, including their success status.
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.
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.
集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。
Specifies the minimum size of an Edm.String column, expressed as a number of characters. If the column size reported by Microsoft Dynamics 365 has a value lower than this value, the CData ADO.NET Provider for Microsoft Dynamics 365 overrides the service value with the one defined in the connection string.
For more information about column limits at your site, examine the Manage Limits admin view.
特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。
Note: 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
Microsoft Dynamics 365 から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。
テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"
すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
Specifies whether or not Microsoft Dynamics 365 should return data using client-side paging, if your source supports it. If set to false, Microsoft Dynamics 365 uses server-side paging.
Pagination is the process of batching data so that the data retrieved is displayed in batches of a particular size. (To keep paging through the data, ask for "more". The data continues to display until all the retrieved data has been shown.)
In client-side paging, the client specifies how many records to return in each request, and the order of the requests. If UseClientSidePaging is set to true, the limit/offset is calculated at the client and the requests are sent concurrently, as multiple threads.
In server-side paging, the server returns only a subset of the data requested by the client. It also provides statistics on how large the full set of requested data is, and how much of the requested data set was not displayed. Server-side pagination is best for large data sets.
Note: Server-side paging requires traversing the data set both backward and forward. Not all data sources support that natively. To explicitly enable server-side paging with a data source that does not support it natively, you must configure your server to return a limited number of records per request, along with metadata about the total number of records. For details, see your data source's API documentation.
Indicates whether or not stored procedures should be listed dynamically.
When UseDynamicStoredProcedures is true, you can pull a stored procedure from the Actions and Functions in the OData service $metadata document and use the EXEC command to list it at runtime.
In all other ways, dynamic stored procedures are just like standard static stored procedures. Like standard stored procedures, they can also be listed using CALL or via edition-specific code.
Specifies that queries should use entity definition metadata endpoints, rather than the standard $metadata endpoint.
This option is useful when precise column metadata is required, and the default data type attributes cannot be relied upon. Since EntityMetadata entities contain a lot of data, more detailed information is provided, including column length, description, precision, and scale. However, due to the larger metadata payload, response times are slower.
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。
{
"MyView": {
"query": "SELECT * FROM GoalHeadings WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例:UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
詳しくは、ユーザー定義ビュー を参照してください。