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

Microsoft Dynamics 365 Business Central への接続

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

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

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

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

クラウドエンドポイント

データに接続するには、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 を空白のままにすると、Cloud はすべての会社を個別のスキーマとして取得します。

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

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 に設定する必要があります。

Azure サービスプリンシパル

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

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

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

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

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

• Azure AD またはAzure サービスプリンシパル用のカスタムOAuth アプリケーションの作成と登録
• カスタムOAuth アプリケーションに管理者の同意を提供

Azure AD

portal.azure.com で：

1. https://portal.azure.com にログインします。
2. 左側のナビゲーションペインでAzure Active Directory -> アプリの登録を選択します。
3. 新規登録をクリックします。
4. アプリケーションの名前を入力します。
5. シングルかマルチテナントか、パブリックかプライベートか、希望するテナント設定を選択します。
   • デフォルトのオプション［この組織ディレクトリ内のアカウントのみ］を選択する場合は、CData Cloud への接続を確立するときにAzureTenant 接続プロパティをAzure AD テナントのId に設定する必要があります。それ以外の場合は、認証に失敗しエラーが発生します。
   • アプリケーションが個人使用のみの場合は、この組織ディレクトリ内のアカウントのみを指定します。
   • アプリケーションを配布する場合は、マルチテナントオプションのいずれか1つを選択してください。

6. リダイレクトURL をhttp://localhost:33333（Cloud のデフォルト）に設定するか、または別のポートを指定し、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 で外部アプリケーションアカウントを作成します。

管理者の同意

カスタムアプリケーションの中には、Azure Active Directory テナント内で操作するために管理者権限が必要なものがあります。管理者の同意は、新しいカスタムOAuth アプリケーションを作成する際に、すでに"Admin Consent Required" とマークされている関連パーミッションを追加することで付与できます。管理者の同意は、OAuth フローでクライアント資格情報を使用する場合にも必要です。

管理者の同意を付与するには：

1. 管理者にportal.azure.com にログインしてもらいます。
2. アプリの登録に移動し、作成したカスタムOAuth アプリケーションを見つけます。
3. API のアクセス許可で、同意の付与をクリックします。

これで、アプリケーションが作成されたテナントにアクセス権限が付与されます。

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 は、データに接続するためのいくつかの異なるエンドポイントをサポートしています。主な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 に変更します。

Kerberos

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

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

Kerberos チケットの取得

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

Cloud は、 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 チケットマネージャーに表示され、クレデンシャルキャッシュファイルに保存されます。

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

Note： KRB5CCNAME を編集したくない場合は、KerberosTicketCache プロパティを使用してファイルパスを手動で設定することができます。この設定後に、Cloud は指定されたキャッシュファイルを使用して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 プロパティを、 サービスチケットの取得に必要な値に設定します。

SSL 設定のカスタマイズ

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

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

Firewall またはProxy 経由の接続

HTTP プロキシ

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

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

その他のプロキシ

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

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

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

テーブル

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

ストアドプロシージャ

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

その他の情報

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

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

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

テーブルの追加表示

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

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 の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

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

CData Cloud - Microsoft Dynamics 365 Business Central ストアドプロシージャ

Name	Description
GetAdminConsentURL	Gets the admin consent URL that must be opened separately by an admin of a given domain to grant access to your application. Only needed when using custom OAuth credentials.

Gets the admin consent URL that must be opened separately by an admin of a given domain to grant access to your application. Only needed when using custom OAuth credentials.

Input

Name	Type	Description
CallbackUrl	String	The URL the user will be redirected to after authorizing your application. This value must match the Reply URL in the Azure AD app settings.
State	String	The same value for state that you sent when you requested the authorization code.

Result Set Columns

Name	Type	Description
URL	String	The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app.

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

スキーマテーブル

以下のテーブルは、Microsoft Dynamics 365 Business Central のデータベースメタデータを返します。

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

データソーステーブル

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

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

クエリ情報テーブル

次のテーブルは、データ変更クエリ（バッチ処理を含む）のクエリ統計を返します。

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

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

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

SELECT * FROM sys_catalogs

Columns

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

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

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

          SELECT * FROM sys_schemas
          

Columns

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

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

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

          SELECT * FROM sys_tables
          

Columns

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

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Accounts テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Accounts' 

Columns

Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベースの名前。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	カラムを含むテーブルまたはビューの名前。
ColumnName	String	カラム名。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	カラムのストレージサイズ。
DisplaySize	Int32	指定されたカラムの通常の最大幅（文字数）。
NumericPrecision	Int32	数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	カラムのスケール（小数点以下の桁数）。
IsNullable	Boolean	カラムがNull を含められるかどうか。
Description	String	カラムの簡単な説明。
Ordinal	Int32	カラムのシーケンスナンバー。
IsAutoIncrement	String	カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn	String	生成されたカラムであるかどうか。
IsHidden	Boolean	カラムが非表示かどうか。
IsArray	Boolean	カラムが配列かどうか。
IsReadOnly	Boolean	カラムが読み取り専用かどうか。
IsKey	Boolean	sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。

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

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

          SELECT * FROM sys_procedures
          

Columns

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

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

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

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

Columns

Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベースの名前。
SchemaName	String	ストアドプロシージャを含むスキーマの名前。
ProcedureName	String	パラメータを含むストアドプロシージャの名前。
ColumnName	String	ストアドプロシージャパラメータの名前。
Direction	Int32	パラメータのタイプに対応する整数値：input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericPrecision	Int32	数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	数値データの小数点以下の桁数。
IsNullable	Boolean	パラメータがNull を含められるかどうか。
IsRequired	Boolean	プロシージャの実行にパラメータが必要かどうか。
IsArray	Boolean	パラメータが配列かどうか。
Description	String	パラメータの説明。
Ordinal	Int32	パラメータのインデックス。

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

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

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

Columns

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

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

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

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

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

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

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

         SELECT * FROM sys_primarykeys
          

Columns

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

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

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

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

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

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

このテーブルをクエリする際は、config 接続文字列を使用する必要があります。

jdbc:cdata:d365businesscentral:config:

この接続文字列を使用すると、有効な接続がなくてもこのテーブルをクエリできます。

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

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

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

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

データソースのSELECT 機能

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

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

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

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

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

Columns

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

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

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

         SELECT * FROM sys_identity
          

Columns

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

データ型のマッピング

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

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

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

Authentication

---

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

Azure Authentication

---

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

OAuth

---

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

JWT OAuth

---

プロパティ	説明
OAuthJWTCert	JWT 証明書のストア。
OAuthJWTCertType	JWT 証明書を格納するキーストアの種類。
OAuthJWTCertPassword	OAuth JWT 証明書のパスワード。
OAuthJWTCertSubject	OAuth JWT 証明書のサブジェクト。

SSL

---

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

Logging

---

プロパティ	説明
Verbosity	ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

Schema

---

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

Miscellaneous

---

プロパティ	説明
EndpointType	OrganizationUrl が解決すべきエンドポイントタイプ。
IncludeNavigationProperties	ナビゲーションプロパティをカラムのリストに含めるかどうかを示すboolean。
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UseSimpleNames	スキーマ、テーブル、カラムの名前に簡略名を使用するかどうかを決定するboolean。

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

---

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

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

Possible Values

Negotiate, AzureAD, AzureServicePrincipal, AzureServicePrincipalCert, NTLM

データ型

string

デフォルト値

"Auto"

解説

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 Cloud will negotiate an authentication mechanism with the server. Set AuthScheme to NEGOTIATE if you want to use Kerberos authentication.

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

データ型

string

デフォルト値

""

解説

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 サーバーへの認証に使用されるDynamics 365 OnPremise アカウントのユーザー名。

データ型

string

デフォルト値

""

解説

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

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

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

データ型

string

デフォルト値

""

解説

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

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

データ型

string

デフォルト値

""

解説

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

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

Microsoft Dynamics 365 Business Central 会社名。

データ型

string

デフォルト値

""

解説

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

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

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

データ型

bool

デフォルト値

false

解説

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

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

---

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

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

データ型

string

デフォルト値

""

解説

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

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

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

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

Possible Values

GLOBAL, CHINA, USGOVT, USGOVTDOD

データ型

string

デフォルト値

"GLOBAL"

解説

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

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

---

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

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

データ型

string

デフォルト値

""

解説

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

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

データ型

string

デフォルト値

""

解説

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

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

---

プロパティ	説明
OAuthJWTCert	JWT 証明書のストア。
OAuthJWTCertType	JWT 証明書を格納するキーストアの種類。
OAuthJWTCertPassword	OAuth JWT 証明書のパスワード。
OAuthJWTCertSubject	OAuth JWT 証明書のサブジェクト。

JWT 証明書のストア。

データ型

string

デフォルト値

""

解説

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

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

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

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

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

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

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

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

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

データ型

string

デフォルト値

"PEMKEY_BLOB"

解説

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

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 形式の証明書を含む文字列の名前です。

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

データ型

string

デフォルト値

""

解説

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

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

データ型

string

デフォルト値

"*"

解説

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

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

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

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

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

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

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

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

---

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

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

データ型

string

デフォルト値

""

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

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

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

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

---

プロパティ	説明
Verbosity	ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

データ型

string

デフォルト値

"1"

解説

Verbosity レベルは、Cloud がLogfile にどの程度の詳細さで記載するかを決定します。1 から5 までのVerbosity レベルがサポートされています。より詳しい説明は、ログ ページに記載されています。

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

---

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

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

データ型

string

デフォルト値

""

解説

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

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

---

プロパティ	説明
EndpointType	OrganizationUrl が解決すべきエンドポイントタイプ。
IncludeNavigationProperties	ナビゲーションプロパティをカラムのリストに含めるかどうかを示すboolean。
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UseSimpleNames	スキーマ、テーブル、カラムの名前に簡略名を使用するかどうかを決定するboolean。

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

Possible Values

CSProduction, CSTesting, WSProduction, WSTesting

データ型

string

デフォルト値

"CSProduction"

解説

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

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

データ型

bool

デフォルト値

false

解説

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

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

複数の値を設定するには、カンマ区切りリストを使用します。次に例を示します。

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

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

データ型

int

デフォルト値

-1

解説

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

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

データ型

string

デフォルト値

""

解説

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

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

データ型

int

デフォルト値

60

解説

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

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

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

データ型

bool

デフォルト値

false

解説

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

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