Microsoft Dynamics 365 Business Central Connector for CData Sync

Build 23.0.8839
  • Microsoft Dynamics 365 Business Central
    • 接続の確立
      • Business Central エンドポイント
      • Kerberos の使用
    • 高度な機能
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • Tables
      • データ型マッピング
    • 接続文字列オプション
      • Authentication
        • AuthScheme
        • OrganizationURL
        • User
        • Password
        • AccessKey
        • Company
        • UseSandbox
      • Azure Authentication
        • AzureTenant
        • AzureEnvironment
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • JWT OAuth
        • OAuthJWTCert
        • OAuthJWTCertType
        • OAuthJWTCertPassword
        • OAuthJWTCertSubject
      • Kerberos
        • KerberosKDC
        • KerberosRealm
        • KerberosSPN
        • KerberosKeytabFile
        • KerberosServiceRealm
        • KerberosServiceKDC
        • KerberosTicketCache
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • EndpointType
        • IncludeNavigationProperties
        • MaxRows
        • Other
        • PseudoColumns
        • Timeout
        • UserDefinedViews
        • UseSimpleNames

Microsoft Dynamics 365 Business Central Connector for CData Sync

概要

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

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

Microsoft Dynamics 365 Business Central バージョンサポート

Sync App は、OData Web サービス経由でMicrosoft Dynamics 365 Business Central への読み/書きアクセスをサポートします。

Microsoft Dynamics 365 Business Central Connector for CData Sync

接続の確立

Microsoft Dynamics 365 Business Central への接続を追加

Microsoft Dynamics 365 Business Central への接続を追加するには:

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

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

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

クラウドエンドポイント

データに接続するには、OrganizationUrl を指定します。OrganizationUrl は、次のいずれかに設定する必要があります。

  • https://businesscentral.dynamics.com/abc123/ などのBusiness Central アカウントへのエンドポイント。
  • Web サービスのルート。
  • カスタムAPI のベースURL。

オンプレミスエンドポイント

以下はオンプレミスのエンドポイントの例です。

https://base URL:port/serverinstance/api/API publisher/API group/API version/
https://base URL:port//serverinstance/ODataV4  
https://myInstance/.local:7048/BC220/ODataV4
URL はデフォルトでブロックされているため、管理者がアクセスを許可する必要があります。

OrganizationUrl を指定する方法、および利用可能なエンドポイントについての詳細は、Business Central エンドポイント を参照してください。

組織内に複数の会社がある場合は、どの会社に接続するかを特定するためにCompany を指定できます。 Company を空白のままにすると、Sync App はすべての会社を個別のスキーマとして取得します。

ユーザーおよびアクセスキー

Note:2021年4月以降、クラウド版ではユーザーおよびアクセスキー認証がサポートされなくなります。オンプレミスの場合、Web Service Access Key(Basic Auth)は当分の間オプションとして残ります。

アクセスキー認証を使用するには、AuthScheme をAccess Key に設定します。 Microsoft Dynamics 365 Business Central に認証するには、User およびAccessKey 接続プロパティを指定します。 Microsoft では、これらをテストおよび開発目的で推奨します。ただし、運用環境での使用は推奨していません。

User およびAccessKey の値を取得するには、Microsoft Dynamics 365 Business Central の[ユーザー]ページに移動して[編集]をクリックします。User Name および Web Service Access Key の値は、User およびPassword 接続文字列プロパティとして入力する値です。User Name はE メールアドレス ではありません。短縮されたユーザー名です。

Microsoft Dynamics 365 Business Central への接続

Microsoft Dynamics 365 Business Central データソースを認証する前に、OrganizationUrl を接続先の組織のURL に設定します。v1とv2のどちらを使用しているかによって、見え方が異なります。OrganizationUrl の各種フォーマットについては、Business Central エンドポイント を参照してください。

アクセスキー

User およびAccessKey を設定し、Microsoft Dynamics 365 Business Central データソースへ認証します。

Azure AD

Azure AD は、Microsoft のマルチテナント、クラウドベースのディレクトリおよびID 管理サービスです。これはユーザーベースの認証で、AuthScheme をAzureAD に設定する必要があります。

OAuth

CData は、認証を簡略化する埋め込みOAuth アプリケーションを提供します。代わりに、認証用のカスタムアプリケーションを作成することも可能です。カスタムアプリケーションの作成およびその理由については、カスタムOAuth アプリケーションの作成 を参照してください。

認証に関して、CData が提供する(埋め込み)アプリケーションを使用する場合と独自のカスタムアプリケーションを作成する場合の唯一の違いは、カスタムOAuth アプリケーションを使用する場合に、高度な設定タブで2つの接続プロパティを追加で設定する必要があることだけです。

接続の前に、カスタムAzure AD アプリケーションの場合のみ以下の変数を設定します。

  • OAuthClientId:カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
  • OAuthClientSecret:カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。

Microsoft Dynamics 365 Business Central への接続 をクリックして、デフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

ドライバーは、以下のようにOAuth プロセスを完了します。

  • コールバックURL からアクセストークンを取得します。
  • 古いトークンの期限が切れたときは、新しいアクセストークンを取得します。
  • OAuth 値を保存し、接続間で永続化します。

Azure サービスプリンシパル

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

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

カスタムOAuth アプリケーションの作成

Microsoft Dynamics 365 Business Central は、Azure AD およびAzure サービスプリンシパルを使用した認証をサポートしています。どちらもOAuth ベースの認証です。

このトピックでは、以下の方法を説明します。

  • Azure AD またはAzure サービスプリンシパル用のカスタムOAuth アプリケーションの作成と登録

Azure AD

portal.azure.com で:
  1. https://portal.azure.com にログインします。
  2. 左側のナビゲーションペインでAzure Active Directory -> アプリの登録を選択します。
  3. 新規登録をクリックします。
  4. アプリケーションの名前を入力します。
  5. シングルかマルチテナントか、パブリックかプライベートか、希望するテナント設定を選択します。

    • デフォルトのオプション[この組織ディレクトリ内のアカウントのみ]を選択する場合は、CData Sync App への接続を確立するときにAzureTenant 接続プロパティをAzure AD テナントのId に設定する必要があります。それ以外の場合は、認証に失敗しエラーが発生します。
    • アプリケーションが個人使用のみの場合は、この組織ディレクトリ内のアカウントのみを指定します。
    • アプリケーションを配布する場合は、マルチテナントオプションのいずれか1つを選択してください。

  6. リダイレクトURL をhttp://localhost:33333(Sync App のデフォルト)に設定するか、または別のポートを指定し、CallbackURL を定義した正確なリプライURL に設定します。
  7. 登録をクリックして新しいアプリケーションを登録します。アプリケーション管理画面が表示されます。
    OAuthClientId としてApplication (client) ID の値、AzureTenant としてDirectory (tenant) ID の値をメモします。
  8. 証明書とシークレットセクションに移動して、アプリケーションの認証タイプを定義します。認証には、証明書(推奨)とクライアントシークレットの2種類があります。

    • 証明書による認証:証明書とシークレットで証明書のアップロードを選択し、ローカルマシンから証明書をアップロードします。
    • 新しいクライアントシークレットの作成:証明書とシークレットで新しいクライアントシークレットを選択し、有効期限を指定します。クライアントシークレットが保存されると、Microsoft Dynamics 365 Business Central はキーの値を表示します。 表示は一度のみなのでこの値をコピーします。 この値がOAuthClientSecret となります。

  9. API のアクセス許可 -> アクセス許可の追加 -> 委任されたアクセス許可を選択します。
  10. 変更を保存します。
  11. 管理者の同意が必要なアクセス許可を使用することを指定した場合は、API のアクセス許可ページで現在のテナントから付与することができます。

Azure サービスプリンシパル

Azure サービスプリンシパル認証を使用するには、認証アプリケーションにロールを割り当てる機能を設定したのち、Azure AD テナントにアプリケーションを登録し、新しい サービスプリンシパルを作成し、さらにBusiness Central で外部アプリケーションアカウントを作成する必要があります。この新しいサービスプリンシパルは、割り当てられたロールベースのアクセス制御を利用して、サブスクリプション内のリソースにアクセスできます。

portal.azure.com で:

  1. 前述のように、カスタムOAuth AD アプリケーションを作成します。
  2. 検索バーを使用してサブスクリプションサービスを検索します。
  3. サブスクリプションページを開きます。
  4. アプリケーションを割り当てるサブスクリプションを選択します。
  5. アクセス制御(IAM)を開きます。
  6. 追加 -> ロール割り当ての追加を選択します。Microsoft Dynamics 365 Business Central はロール割り当ての追加ページを開きます。
  7. 作成したカスタムAzure AD アプリケーションに所有者ロールを割り当てます。
  8. カスタムアプリケーション用にBusiness Central で外部アプリケーションアカウントを作成します。

Managed Service Identity (MSI)

Azure VM 上でMicrosoft Dynamics 365 Business Central を実行しており、MSI を利用して接続したい場合は、AuthScheme をAzureMSI に設定します。

User-Managed Identities

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

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

Kerberos

Kerberos 経由でMicrosoft Exchange への認証を行うには、認証プロパティを定義し、Kerberos が認証チケットを取得する方法を選択する必要があります。

Kerberos を使用してMicrosoft Exchange への認証を行うには、次のプロパティを設定します。

  • hive.server2.authentication:Kerberos。
  • AuthScheme:NEGOTIATE。
  • KerberosKDC:Kerberos KDC マシンのホスト名またはIP アドレス。
  • KerberosRealm:Microsoft Exchange Kerberos プリンシパルのレルム。この値は、主たる値の'@' 記号のすぐ後にあります。
  • KerberosSPN:Microsoft Exchange のKerberos プリンシパルのサービスとホスト。この値は、主たる値の'@' 記号のすぐ前にあります。

認証値に加えて、以下を設定します。

  • Server:接続するExchange サーバーのアドレス。
  • Platform:Microsoft Exchange のバージョン。
  • Schema:EWS.A。

Microsoft Dynamics 365 Business Central Connector for CData Sync

Business Central エンドポイント

Microsoft Dynamics 365 Business Central は、データに接続するためのいくつかの異なるエンドポイントをサポートしています。主な2つのカテゴリは、Common Service エンドポイントとWeb Services エンドポイントです。 さらに、エンドポイントの各セットはProduction エンドポイントとTesting エンドポイントに分割されます。Production エンドポイントにはOAuth 接続が必要ですが、Testing エンドポイントにはUser およびAccessKey 経由で接続できます。 Production エンドポイントとTesting エンドポイントは同じデータにアクセスし、相互作用することに注意してください。両者は、どの認証方法が許可されるかについての制限が異なるだけです。

Note: 2021年4月以降、クラウド版ではBasic 認証がサポートされなくなります。

https://businesscentral.dynamics.com/ URL が指定されている場合、OrganizationUrl はデフォルトでCommon Service Production エンドポイントへの解決を試みます。 ただし、これはEndpointType を変更することで設定ができます。さらに、https://api.businesscentral.dynamics.com/ を指定すると、指定されたOrganizationUrl が変更なしで使用されるため、EndpointType およびUseSandbox の両方がオーバーライドされます。

Common Service エンドポイント

Common Service エンドポイントには、Microsoft Dynamics 365 Business Central に関連付けられたビジネスデータが含まれています。例えば、アカウント、受注、売上請求はすべてCommon Service にあります。

Common Service エンドポイント - Production

  • https://api.businesscentral.dynamics.com/v2.0/{environment name}/api/v2.0
  • https://api.businesscentral.dynamics.com/v1.0/api/v2.0
  • https://api.businesscentral.dynamics.com/v2.0/sandbox/api/v2.0

Common Service エンドポイント - Testing

  • https://api.businesscentral.dynamics.com/v2.0/{tenant id}/{environment name}/api/v2.0
  • https://api.businesscentral.dynamics.com/v1.0/{tenant id}/api/v2.0
  • https://api.businesscentral.dynamics.com/v2.0/{tenant id}/sandbox/api/v2.0

Note: Tenant Id はBusiness Central アプリを利用できるAzure のテナントのId です。 これは、portal.azure.com にログインして、ユーザー名を選択し、[Switch Directory]に進むことで取得できます。または、portal.azure.com の[Active Directory]->[Overview]から見つけることもできます。 環境名は、https://businesscentral.dynamics.com/{tenant id}/admin にあります。

Web Services エンドポイント

Web Service エンドポイントには、Microsoft Dynamics 365 Business Central でカスタム公開されたものがすべて含まれます。これには、KPI、レポート、個々のエンティティ、もしくはその他のフィードが含まれる場合があります。 Microsoft Dynamics 365 Business Central で、虫めがねをクリックしてWeb Services を検索し、これらのエンドポイントによってすべてが公開されているものを把握します。

Web Services エンドポイント - Production

  • https://api.businesscentral.dynamics.com/v1.0/ODataV4/

Web Services エンドポイント - Testing

  • https://api.businesscentral.dynamics.com/v1.0/{tenant id}/ODataV4/

Custom API エンドポイント

カスタムAPI エンドポイントに接続するには、OrganizationUrl プロパティを次の形式のカスタムベースURL に設定する必要があります: https://api.businesscentral.dynamics.com/v2.0/{tenant}/api/{API publisher}/{API group}/{API version}

2019 からのエンドポイントのデフォルトの変更

2019 バージョンでは、OrganizationUrl にhttps://businesscentral.dynamics.com/ URL を指定した場合、デフォルトのエンドポイントはWeb Services testing エンドポイントに解決されました。 新規のデフォルトは、Common Service production エンドポイントです。Web Services testing エンドポイントの使用を継続するには、それを直接設定するか、EndpointType をWSTesting に変更します。

Microsoft Dynamics 365 Business Central Connector for CData Sync

Kerberos の使用

Kerberos

Kerberos でMicrosoft Dynamics 365 Business Central への認証を行うには、AuthScheme をNEGOTIATE に設定します。

Kerberos 経由でMicrosoft Dynamics 365 Business Central への認証を行うには、認証プロパティを定義し、Kerberos が認証チケットを取得する方法を選択する必要があります。

Kerberos チケットの取得

Kerberos チケットは、依頼者のID を認証するために使用されます。正式なログイン / パスワードの代わりにチケットを使用することで、パスワードをローカルに保存したり、ネットワーク経由で送信したりする必要がなくなります。 ユーザーは、ローカルコンピュータでログインするか、 コマンドプロンプトでkinit USER と入力するたびに、再認証されます(チケットはリフレッシュされます)。

Sync App は、 KRB5CCNAME および / またはKerberosKeytabFile 変数が存在するかどうかに応じて、必要なKerberos チケットを取得する3 つの方法を提供します。

MIT Kerberos 資格情報キャッシュファイル

このオプションを使用すると、MIT Kerberos チケットマネージャーまたはkinit コマンドを使ってチケットを取得できます。このオプションでは、User またはPassword 接続プロパティを設定する必要はありません。

このオプションは、KRB5CCNAME がシステムに作成されている必要があります。

MIT Kerberos 資格情報キャッシュファイル経由でチケット検索を有効にするには:

  1. お使いの環境にKRB5CCNAME 変数が存在することを確認します。
  2. KRB5CCNAME を資格情報キャッシュファイルを指すパスに設定します。(例えば、C:\krb_cache\krb5cc_0 または/tmp/krb5cc_0 です。)資格情報キャッシュファイルは、MIT Kerberos チケットマネージャーを使用してチケットを生成するときに作成されます。
  3. チケットを取得するには:
    1. MIT Kerberos チケットマネージャーアプリケーションを開きます。
    2. Get Ticket をクリックします。
    3. プリンシパル名とパスワードを入力します。
    4. OK をクリックします。

    チケットの取得に成功すると、チケット情報がKerberos チケットマネージャーに表示され、クレデンシャルキャッシュファイルに保存されます。

Sync App はキャッシュファイルを使用してMicrosoft Dynamics 365 Business Central に接続するためのKerberos チケットを取得します。

Note: KRB5CCNAME を編集したくない場合は、KerberosTicketCache プロパティを使用してファイルパスを手動で設定することができます。この設定後に、Sync App は指定されたキャッシュファイルを使用してMicrosoft Dynamics 365 Business Central に接続するためのKerberos チケットを取得します。

Keytab ファイル

お使いの環境にKRB5CCNAME 環境変数がない場合、Keytab ファイルを使用してKerberos チケットを取得できます。

この方法を使用するには、User プロパティを目的のユーザー名に設定し、KerberosKeytabFile プロパティをユーザーに関連付けられたキータブファイルを指すファイルパスに設定します。

User およびPassword

お使いの環境にKRB5CCNAME 環境変数およびKerberosKeytabFile プロパティが設定されていない場合、ユーザーとパスワードの組み合わせを使用してチケットを取得できます。

この方法を使用するには、User およびPassword プロパティを、Microsoft Dynamics 365 Business Central での認証に使用するユーザー / パスワードの組み合わせに設定します。

クロスレルム認証の有効化

より複雑なKerberos 環境では、複数のレルムおよびKDC サーバーが使用されるクロスレルム認証が必要になる場合があります。例えば、1つのレルム / KDC がユーザー認証に使用され、別のレルム / KDC がサービスチケットの取得に使用される場合です。

このようなクロスレルム認証を有効にするには、KerberosRealm およびKerberosKDC プロパティをユーザー認証に必要な値に設定します。また、KerberosServiceRealm およびKerberosServiceKDC プロパティを、 サービスチケットの取得に必要な値に設定します。

Microsoft Dynamics 365 Business Central Connector for CData Sync

高度な機能

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

ユーザー定義ビュー

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

SSL の設定

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

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

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

クエリ処理

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

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

ログ

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

Microsoft Dynamics 365 Business Central Connector for CData Sync

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

Microsoft Dynamics 365 Business Central Connector for CData Sync

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

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

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

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

Microsoft Dynamics 365 Business Central Connector for CData Sync

データモデル

CData Sync App は、Microsoft Dynamics 365 Business Central エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。テーブル定義は、接続先のOData サービスから動的に取得されます。メタデータのあらゆる変更(カラムの追加や削除、データ型の変更など)は、再接続によってロードされます。

テーブル

Sync App は、サービスメタデータドキュメントで記述された書き込み可能なエンティティを双方向Tables としてモデル化します。

ストアドプロシージャ

ストアドプロシージャはデータソースのファンクションライクなインターフェースです。これらは、標準的なCRUD モデル以外の追加の操作を 実行するために使用できます。

その他の情報

SalesInvoiceLines テーブルへのINSERT ステートメントは、売上請求書のステータスが'DRAFT' の場合にのみ機能することに注意してください。ステータスが'PAID' または'OPEN' の場合、INSERT ステートメントは正常に完了しません。これはAPI の制限事項です。

Microsoft Dynamics 365 Business Central Connector for CData Sync

Tables

デフォルトのテーブル表示

Sync App は、アカウントでWeb Services として設定されたテーブルのみを公開します。Microsoft Dynamics 365 Business Central のOData サービスを使用して、接続後にテーブルリストを動的に取得して表示します。追加テーブルを表示することも可能であり、次のセクションで手順を説明します。

テーブルの追加表示

Sync App が表示した以外のテーブル(エンドポイント)を表示させたい場合、はじめにアカウントでWeb Service として目的のテーブルを設定します。設定すると、Sync App が公開されたエンドポイントを検出して表示します。 これを行うには、次の手順に従います。

  1. Dynamics 365 Business Central アカウントにログインします。
  2. Web Services に移動してNew をクリックします。
  3. Object Type でPage またはQuery を選択します。Codeunit オプションは、Dynamics 365 Business Central バージョン16.3以降で利用可能です。
  4. Object ID でドロップダウンリストを開き、Select from full list をクリックします。
  5. Object Name カラムから表示したいテーブルを選択します。
  6. Service Name を指定し、サービスがどのように表示されるかを定義します。
  7. Published チェックボックスを選択し、OData V4 URL フィールドが入力されるまで待ちます。
  8. ページの右上を確認し、変更が保存されたことを確認します。
  9. 追加したい他のテーブル(Web Service として設定されているもの)についても、この手順を繰り返します。

AL Enum オブジェクトによるフィルタリング

Business Central API ページの一部(ほとんどのAPI v2.0 ページを含む)には、AL Enum オブジェクトに基づくフィールドがあります。

AL 列挙型オブジェクトに基づくフィールドは、使用している言語やOS に関係なくレポートのフィルタが常に機能するように、一貫性があり常に同じ名前でなければなりません。 このため、AL 列挙型に基づくフィールドは変換されず、Buisness Central API は特殊文字を避けるためにエンコードされる必要があります。

Enum 値でフィルタリングするには、https://www.w3.org/Style/XSL/TestSuite/results/4/XEP/symbol.pdf ドキュメントを参照し、シンボルの前後に _(アンダースコア)を付けて値をエンコードする必要があります。

例えば、スペースの場合は"_x0020_" となります。 例:SELECT * FROM DimensionSetLines WHERE parentid={id} and parentType='Sales_x0020_Order'

フィールドが列挙型オブジェクトであるかどうかを確認するには、sys_tablecolumns テーブルのIsEnumeration カラムを参照してください。

Microsoft Dynamics 365 Business Central Connector for CData Sync

データ型マッピング

データ型のマッピング

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

Microsoft Dynamics 365 Business Central (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 Dynamics 365 Business Central Connector for CData Sync

接続文字列オプション

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

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

Authentication


プロパティ説明
AuthSchemeBusiness Central への接続時にOAuth 認証またはアクセスキー認証のどちらを使用するか。
OrganizationURLDynamics 365 組織へのURL。例えば、https://businesscentral.dynamics.com/abc123/ です。
UserMicrosoft Dynamics 365 Business Central サーバーへの認証に使用されるDynamics 365 OnPremise アカウントのユーザー名。
Passwordユーザーの認証で使用されるパスワード。
AccessKeyMicrosoft Dynamics 365 Business Central への認証に使われるアクセスキー。
CompanyMicrosoft Dynamics 365 Business Central 会社名。
UseSandboxサンドボックスが使用されているかどうかを示すboolean。'sandbox'とは異なるサンドボックス名を持っている場合は、これをtrue に設定してください。

Azure Authentication


プロパティ説明
AzureTenantデータにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。
AzureEnvironment接続を確立するときに使用するAzure 環境。

OAuth


プロパティ説明
OAuthClientIdOAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecretOAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

JWT OAuth


プロパティ説明
OAuthJWTCertJWT 証明書のストア。
OAuthJWTCertTypeJWT 証明書を格納するキーストアの種類。
OAuthJWTCertPasswordOAuth JWT 証明書のパスワード。
OAuthJWTCertSubjectOAuth JWT 証明書のサブジェクト。

Kerberos


プロパティ説明
KerberosKDCユーザーの認証で使用されるKerberos キー配布センター(KDC)サービス。
KerberosRealmユーザー認証に使用されるKerberos 領域。
KerberosSPNKerberos ドメインコントローラーのサービスプリンシパル名(SPN)。
KerberosKeytabFileKerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。
KerberosServiceRealmサービスのKerberos レルム。
KerberosServiceKDCサービスのKerberos KDC。
KerberosTicketCacheMIT Kerberos 資格情報キャッシュファイルへのフルパス。

SSL


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

Firewall


プロパティ説明
FirewallTypeプロキシベースのファイアウォールで使われるプロトコル。
FirewallServerプロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPortプロキシベースのファイアウォールのTCP ポート。
FirewallUserプロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPasswordプロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy


プロパティ説明
ProxyAutoDetectこれは、システムプロキシ設定を使用するかどうかを示します。
ProxyServerHTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPortProxyServer プロキシが起動しているTCP ポート。
ProxyAuthSchemeProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUserProxyServer プロキシへの認証に使われるユーザー名。
ProxyPasswordProxyServer プロキシへの認証に使われるパスワード。
ProxySSLTypeProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptionsProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging


プロパティ説明
LogModulesログファイルに含めるコアモジュール。

Schema


プロパティ説明
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemasこのプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesこのプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Miscellaneous


プロパティ説明
EndpointTypeOrganizationUrl が解決すべきエンドポイントタイプ。
IncludeNavigationPropertiesナビゲーションプロパティをカラムのリストに含めるかどうかを示すboolean。
MaxRowsクエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumnsこのプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSimpleNamesスキーマ、テーブル、カラムの名前に簡略名を使用するかどうかを決定するboolean。
Microsoft Dynamics 365 Business Central Connector for CData Sync

Authentication

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


プロパティ説明
AuthSchemeBusiness Central への接続時にOAuth 認証またはアクセスキー認証のどちらを使用するか。
OrganizationURLDynamics 365 組織へのURL。例えば、https://businesscentral.dynamics.com/abc123/ です。
UserMicrosoft Dynamics 365 Business Central サーバーへの認証に使用されるDynamics 365 OnPremise アカウントのユーザー名。
Passwordユーザーの認証で使用されるパスワード。
AccessKeyMicrosoft Dynamics 365 Business Central への認証に使われるアクセスキー。
CompanyMicrosoft Dynamics 365 Business Central 会社名。
UseSandboxサンドボックスが使用されているかどうかを示すboolean。'sandbox'とは異なるサンドボックス名を持っている場合は、これをtrue に設定してください。
Microsoft Dynamics 365 Business Central Connector for CData Sync

AuthScheme

Business Central への接続時にOAuth 認証またはアクセスキー認証のどちらを使用するか。

解説

Business Central への接続時にOAuth 認証またはアクセスキー認証のどちらを使用するか。

Note: OAuth 認証はクラウド版専用ですが、2021年8月にオンプレミス版でサポートされる予定です。

  • Auto:他の接続プロパティに基づいて、使用する適切な認証スキームを自動的に決定しようと試みます。
  • AccessKey:アクセスキーを使用して認証を実行する場合に設定。サービスをテストするために設計されたエンドポイントでのみ機能します。
  • AzureAD:Azure Active Directory OAuth 認証を実行する場合に設定。
  • AzureServicePrincipal:クライアントシークレットを使用してAzure Service Principal として認証するように設定。
  • AzureServicePrincipalCert:証明書を使用してAzure Service Principal として認証するように設定。
  • AzureMSI:Azure VM で実行しているときにマネージドサービスID のクレデンシャルを自動的に取得する場合に設定します。
  • NTLM: Set this to use your Windows credentials for authentication.
  • Negotiate: If AuthScheme is set to NEGOTIATE, the Sync App will negotiate an authentication mechanism with the server. Set AuthScheme to NEGOTIATE if you want to use Kerberos authentication.

Microsoft Dynamics 365 Business Central Connector for CData Sync

OrganizationURL

Dynamics 365 組織へのURL。例えば、https://businesscentral.dynamics.com/abc123/ です。

解説

Dynamics 365 組織にログインする際に使用するURL。リソースとも呼ばれます。例えば、https://businesscentral.dynamics.com/abc123/ です。

Microsoft Dynamics 365 Business Central インスタンスの正確なURL を見つけます。これはリソースとしても知られています。これを見つけるには、 検索アイコンをクリックして「Web サービス」と入力します。OData v4 URL をモニタします。エンドバリューはWeb サービスエンドポイント(マイナスCompany)である必要があります。

例えば、OData v4 URL がhttps://api.businesscentral.dynamics.com/v1.0/businesscentralid/ODataV4/ の場合、Web サービスエンドポイントの正確なURL はhttps://api.businesscentral.dynamics.com/v1.0 です。

カスタムAPI に接続するには、このプロパティをDynamics 365 カスタムAPI のベースURL に設定します。 例えば、https://api.businesscentral.dynamics.com/v2.0/{environmentName}/api/{API publisher}/{API group}/{API version} または https://api.businesscentral.dynamics.com/v2.0/{tenant}/{environmentName}/api/{API publisher}/{API group}/{API version} です。

OrganizationUrl を指定する方法、および利用可能なエンドポイントについての詳細は、Business Central エンドポイント を参照してください。

Microsoft Dynamics 365 Business Central Connector for CData Sync

User

Microsoft Dynamics 365 Business Central サーバーへの認証に使用されるDynamics 365 OnPremise アカウントのユーザー名。

解説

このフィールドは、AccessKey とともに、Microsoft Dynamics 365 Business Central サーバーに対して認証をするために使われます。

Note: 2021年4月以降、クラウド版ではBasic 認証がサポートされなくなります。オンプレミスの場合、Web Service Access Key(Basic Auth)は当分の間オプションとして残ります。

Microsoft Dynamics 365 Business Central Connector for CData Sync

Password

ユーザーの認証で使用されるパスワード。

解説

User およびPassword を一緒に使用してサーバーで認証を行います。

Microsoft Dynamics 365 Business Central Connector for CData Sync

AccessKey

Microsoft Dynamics 365 Business Central への認証に使われるアクセスキー。

解説

このフィールドは、User とともに、Microsoft Dynamics 365 Business Central に対して認証をするために使われます。

Note: 2021年4月以降、クラウド版ではBasic 認証がサポートされなくなります。オンプレミスの場合、Web Service Access Key(Basic Auth)は当分の間オプションとして残ります。

Microsoft Dynamics 365 Business Central Connector for CData Sync

Company

Microsoft Dynamics 365 Business Central 会社名。

解説

Company Information ページで確認することができます。

すべての会社を個別のスキーマとして取得する場合は、空白のままにします。

Microsoft Dynamics 365 Business Central Connector for CData Sync

UseSandbox

サンドボックスが使用されているかどうかを示すboolean。'sandbox'とは異なるサンドボックス名を持っている場合は、これをtrue に設定してください。

解説

サンドボックスが使用されているかどうかを示すboolean。'sandbox'とは異なるサンドボックス名を持っている場合は、これをtrue に設定してください。

Microsoft Dynamics 365 Business Central Connector for CData Sync

Azure Authentication

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


プロパティ説明
AzureTenantデータにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。
AzureEnvironment接続を確立するときに使用するAzure 環境。
Microsoft Dynamics 365 Business Central Connector for CData Sync

AzureTenant

データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。

解説

データにアクセスするために使用されるMicrosoft Online テナント。例えば、contoso.onmicrosoft.com です。あるいは、 テナントId を指定します。この値は[Azure ポータル]->[Azure Active Directory]->[プロパティ]のディレクトリId です。

通常、Tenant を指定する必要はありません。OAuthGrantType をCODE(デフォルト)に設定している場合は、Microsoft が自動的に決定します。 ただし、ユーザーがマルチテナントに所属している場合は失敗する可能性があります。 例えば、ドメインA の管理者がドメインB のユーザーをゲストユーザーとして招待した場合。ユーザーは両方のテナントに属していることになります。 Tenant を指定するのはグッドプラクティスですが、一般的には指定しなくてもうまく動作するはずです。

OAuthGrantType をCLIENT に設定する場合は、AzureTenant が必須です。クライアント資格情報を使用する場合、ユーザーコンテキストはありません。 資格情報は、アプリ自体のコンテキストから取得されます。Microsoft ではTenant を指定せずにクライアント資格情報を取得することを許容していますが、使用する特定のテナントを選択する可能性ははるかに低くなっています。 このため、接続するドメインに適用される資格情報を確実に取得するために、すべてのクライアント資格情報接続に対してAzureTenant を明示的に指定する必要があります。

Microsoft Dynamics 365 Business Central Connector for CData Sync

AzureEnvironment

接続を確立するときに使用するAzure 環境。

解説

ほとんどの場合、環境をグローバルに設定したままにしておくとうまく機能します。ただし、 Azure アカウントが別の環境に追加されている場合は、AzureEnvironment を使用してどの環境かを 指定できます。利用可能な値はGLOBAL、CHINA、USGOVT、USGOVTDOD です。

Microsoft Dynamics 365 Business Central Connector for CData Sync

OAuth

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


プロパティ説明
OAuthClientIdOAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecretOAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
Microsoft Dynamics 365 Business Central Connector for CData Sync

OAuthClientId

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

Microsoft Dynamics 365 Business Central Connector for CData Sync

OAuthClientSecret

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

Microsoft Dynamics 365 Business Central Connector for CData Sync

JWT OAuth

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


プロパティ説明
OAuthJWTCertJWT 証明書のストア。
OAuthJWTCertTypeJWT 証明書を格納するキーストアの種類。
OAuthJWTCertPasswordOAuth JWT 証明書のパスワード。
OAuthJWTCertSubjectOAuth JWT 証明書のサブジェクト。
Microsoft Dynamics 365 Business Central 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 Dynamics 365 Business Central 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 形式の証明書を含む文字列の名前です。

Microsoft Dynamics 365 Business Central Connector for CData Sync

OAuthJWTCertPassword

OAuth JWT 証明書のパスワード。

解説

証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。

Microsoft Dynamics 365 Business Central Connector for CData Sync

OAuthJWTCertSubject

OAuth JWT 証明書のサブジェクト。

解説

証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。

完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。

それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。

"*" に設定すると、証明書ストアの1番目の証明書が選択されます。

証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。 例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。

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

フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。

Microsoft Dynamics 365 Business Central Connector for CData Sync

Kerberos

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


プロパティ説明
KerberosKDCユーザーの認証で使用されるKerberos キー配布センター(KDC)サービス。
KerberosRealmユーザー認証に使用されるKerberos 領域。
KerberosSPNKerberos ドメインコントローラーのサービスプリンシパル名(SPN)。
KerberosKeytabFileKerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。
KerberosServiceRealmサービスのKerberos レルム。
KerberosServiceKDCサービスのKerberos KDC。
KerberosTicketCacheMIT Kerberos 資格情報キャッシュファイルへのフルパス。
Microsoft Dynamics 365 Business Central Connector for CData Sync

KerberosKDC

ユーザーの認証で使用されるKerberos キー配布センター(KDC)サービス。

解説

Kerberos のプロパティは、SPNEGO またはWindows 認証を使用する場合に使用されます。Sync App は、Kerberos KDC サービスにセッションチケットと一時セッションキーを要求します。Kerberos KDC サービスは、通常、ドメインコントローラーと同じコンピュータに置かれています。

Kerberos KDC が指定されていない場合、Sync App は、これらのプロパティを自動的に次の場所から検出しようとします。

  • KRB5 Config File (krb5.ini/krb5.conf): KRB5_CONFIG 環境変数が設定され、ファイルが存在する場合、Sync App は指定されたファイルからKDC を取得します。それ以外の場合は、OS に基づいてデフォルトのMIT ロケーションからの読み取りを試みます:C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) または/etc/krb5.conf (Linux)。
  • ドメイン名およびホスト: Kerberos 領域およびKerberos KDC が別の場所から推測できなかった場合、Sync App は設定されているドメイン名およびホストからそれらを推測します。

Microsoft Dynamics 365 Business Central Connector for CData Sync

KerberosRealm

ユーザー認証に使用されるKerberos 領域。

解説

Kerberos のプロパティは、SPNEGO またはWindows 認証を使用する場合に使用されます。Kerberos 領域は、Kerberos キー配布センター(KDC)サービスを使用してユーザーを認証するために使用されます。Kerberos 領域は、管理者が任意の文字列に設定できますが、通常はドメイン名に基づいて設定されます。

Kerberos 領域が指定されていない場合、Sync App は、これらのプロパティを自動的に次の場所から検出しようとします。

  • KRB5 Config File (krb5.ini/krb5.conf): KRB5_CONFIG 環境変数が設定され、ファイルが存在する場合、Sync App は指定されたファイルからデフォルトレルムを取得します。それ以外の場合は、OS に基づいてデフォルトのMIT ロケーションからの読み取りを試みます:C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) または/etc/krb5.conf (Linux)
  • ドメイン名およびホスト: Kerberos 領域およびKerberos KDC が別の場所から推測できなかった場合、Sync App はユーザー設定されているドメイン名およびホストからそれらを推測します。これは、一部のWindows 環境で機能します。

Microsoft Dynamics 365 Business Central Connector for CData Sync

KerberosSPN

Kerberos ドメインコントローラーのサービスプリンシパル名(SPN)。

解説

Kerberos ドメインコントローラーのSPN が認証先のURL と異なる場合は、このプロパティを使用してSPN を設定します。

Microsoft Dynamics 365 Business Central Connector for CData Sync

KerberosKeytabFile

Kerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。

解説

Kerberos のプリンシパルと暗号化されたキーのペアを含むKeytab ファイル。

Microsoft Dynamics 365 Business Central Connector for CData Sync

KerberosServiceRealm

サービスのKerberos レルム。

解説

KerberosServiceRealm は、クロスレルムKerberos 認証を使用するときにサービスKerberos レルムを指定するために使われます。

ほとんどの場合、単一のレルムとKDC マシンがKerberos 認証を実行するために使用され、このプロパティは必要ありません。

このプロパティは、異なるレルムとKDC マシンを使用して認証チケット(AS リクエスト)およびサービスチケット(TGS リクエスト)を取得する、より複雑な設定で使用できます。

Microsoft Dynamics 365 Business Central Connector for CData Sync

KerberosServiceKDC

サービスのKerberos KDC。

解説

KerberosServiceKDC は、クロスレルムKerberos 認証を使用するときにサービスKerberos KDC を指定するために使われます。

ほとんどの場合、単一のレルムとKDC マシンがKerberos 認証を実行するために使用され、このプロパティは必要ありません。

このプロパティは、異なるレルムとKDC マシンを使用して認証チケット(AS リクエスト)およびサービスチケット(TGS リクエスト)を取得する、より複雑な設定で使用できます。

Microsoft Dynamics 365 Business Central Connector for CData Sync

KerberosTicketCache

MIT Kerberos 資格情報キャッシュファイルへのフルパス。

解説

このプロパティは、MIT Kerberos チケットマネージャーまたはkinit コマンドを使用して作成された資格情報キャッシュファイルを使用する場合に設定できます。

Microsoft Dynamics 365 Business Central Connector for CData Sync

SSL

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


プロパティ説明
SSLServerCertTLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
Microsoft Dynamics 365 Business Central 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 Dynamics 365 Business Central Connector for CData Sync

Firewall

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


プロパティ説明
FirewallTypeプロキシベースのファイアウォールで使われるプロトコル。
FirewallServerプロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPortプロキシベースのファイアウォールのTCP ポート。
FirewallUserプロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPasswordプロキシベースのファイアウォールへの認証に使われるパスワード。
Microsoft Dynamics 365 Business Central Connector for CData Sync

FirewallType

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。

タイプ デフォルトポート 説明
TUNNEL 80 これが設定されている場合、Sync App はMicrosoft Dynamics 365 Business Central への接続を開き、プロキシを経由して通信が行われます。
SOCKS4 1080 これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5 1080 これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

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

Microsoft Dynamics 365 Business Central Connector for CData Sync

FirewallServer

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

Microsoft Dynamics 365 Business Central Connector for CData Sync

FirewallPort

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

Microsoft Dynamics 365 Business Central Connector for CData Sync

FirewallUser

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

Microsoft Dynamics 365 Business Central Connector for CData Sync

FirewallPassword

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

Microsoft Dynamics 365 Business Central Connector for CData Sync

Proxy

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


プロパティ説明
ProxyAutoDetectこれは、システムプロキシ設定を使用するかどうかを示します。
ProxyServerHTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPortProxyServer プロキシが起動しているTCP ポート。
ProxyAuthSchemeProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUserProxyServer プロキシへの認証に使われるユーザー名。
ProxyPasswordProxyServer プロキシへの認証に使われるパスワード。
ProxySSLTypeProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptionsProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
Microsoft Dynamics 365 Business Central Connector for CData Sync

ProxyAutoDetect

これは、システムプロキシ設定を使用するかどうかを示します。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

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

Microsoft Dynamics 365 Business Central Connector for CData Sync

ProxyServer

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

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

Microsoft Dynamics 365 Business Central Connector for CData Sync

ProxyPort

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

Microsoft Dynamics 365 Business Central Connector for CData Sync

ProxyAuthScheme

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

  • BASIC: Sync App はHTTP BASIC 認証を行います。
  • DIGEST: Sync App はHTTP DIGEST 認証を行います。
  • NEGOTIATE: Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
  • PROPRIETARY: Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

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

Microsoft Dynamics 365 Business Central Connector for CData Sync

ProxyUser

ProxyServer プロキシへの認証に使われるユーザー名。

解説

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

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

Microsoft Dynamics 365 Business Central Connector for CData Sync

ProxyPassword

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

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

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

Microsoft Dynamics 365 Business Central Connector for CData Sync

ProxySSLType

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。

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

Microsoft Dynamics 365 Business Central Connector for CData Sync

ProxyExceptions

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

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

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

Microsoft Dynamics 365 Business Central Connector for CData Sync

Logging

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


プロパティ説明
LogModulesログファイルに含めるコアモジュール。
Microsoft Dynamics 365 Business Central Connector for CData Sync

LogModules

ログファイルに含めるコアモジュール。

解説

指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログ ページを参照してください。

Microsoft Dynamics 365 Business Central Connector for CData Sync

Schema

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


プロパティ説明
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemasこのプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesこのプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
Microsoft Dynamics 365 Business Central Connector for CData Sync

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

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

Platform %APPDATA%
Windows APPDATA 環境変数の値
Linux ~/.config

Microsoft Dynamics 365 Business Central Connector for CData Sync

BrowsableSchemas

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。

Microsoft Dynamics 365 Business Central Connector for CData Sync

Tables

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Microsoft Dynamics 365 Business Central Connector for CData Sync

Views

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Microsoft Dynamics 365 Business Central Connector for CData Sync

Miscellaneous

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


プロパティ説明
EndpointTypeOrganizationUrl が解決すべきエンドポイントタイプ。
IncludeNavigationPropertiesナビゲーションプロパティをカラムのリストに含めるかどうかを示すboolean。
MaxRowsクエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumnsこのプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSimpleNamesスキーマ、テーブル、カラムの名前に簡略名を使用するかどうかを決定するboolean。
Microsoft Dynamics 365 Business Central Connector for CData Sync

EndpointType

OrganizationUrl が解決すべきエンドポイントタイプ。

解説

Microsoft Dynamics 365 Business Central のエンドポイントタイプ、およびユースケースに基づいてEndpointType を設定する 適切な値の詳細は、Business Central エンドポイント を参照してください。

Microsoft Dynamics 365 Business Central Connector for CData Sync

IncludeNavigationProperties

ナビゲーションプロパティをカラムのリストに含めるかどうかを示すboolean。

解説

ナビゲーションプロパティは、データの取得時に情報を入力しません。代わりに、挿入または更新時に、ナビゲーションプロパティを使用して既存のリソースにバインドすることができます。次に例を示します。

INSERT INTO accounts (_primarycontactid_value) VALUES ('123456')
複数の値を設定するには、カンマ区切りリストを使用します。次に例を示します。
INSERT INTO accounts (lead_customer_accounts) VALUES ('123,456')

Microsoft Dynamics 365 Business Central Connector for CData Sync

MaxRows

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

解説

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

Microsoft Dynamics 365 Business Central Connector for CData Sync

Other

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

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

統合およびフォーマット

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

Microsoft Dynamics 365 Business Central Connector for CData Sync

PseudoColumns

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

Microsoft Dynamics 365 Business Central Connector for CData Sync

Timeout

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

Microsoft Dynamics 365 Business Central Connector for CData Sync

UserDefinedViews

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

  • 各ルートエレメントはビューの名前を定義します。
  • 各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Accounts WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}
UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
指定されたパスは引用符で囲まれていないことに注意してください。

Microsoft Dynamics 365 Business Central Connector for CData Sync

UseSimpleNames

スキーマ、テーブル、カラムの名前に簡略名を使用するかどうかを決定するboolean。

解説

Microsoft Dynamics 365 Business Central 会社名、またはテーブル / カラム名では、 通常のデータベースでは使うことが認められていない特殊記号・文字を名前に使うことができます。UseSimpleNames を使用すると、Sync App を従来のデータベースツールでより簡単に使用できるようになります。

UseSimpleNames をtrue に設定し、返されるスキーマ名、テーブル名およびカラム名をシンプルにします。表示されるスキーマ名、テーブル名 およびカラム名においてアルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。 英数字以外の文字はすべて、アンダースコアに変換されます。このプロパティをtrue に設定する場合、Company 接続プロパティを使用して他の接続を1つの会社に制限する前に、必ずsys_schemas をクエリしてSchemaName カラムの簡略化された会社名を取得してください。

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839