tMicrosoftCrmInputの標準プロパティ

[Authentication Type] (認証タイプ)

[CRM Version] (CRMバージョン)

ON-PREMISE CRMデータベースのバージョン、すなわちCRM 2011 (非推奨)、CRM 2015 (非推奨)、CRM 2016のいずれかを選択します。

ON-PREMISE 2016はApache Olingo OData 4.0ライブラリーを使用して実装されます。詳細は、http://olingo.apache.org/doc/odata4/index.htmlをご覧ください。

[Mode] (モード)

ON-PREMISE CRM2016認証モード、NTLM、またはOAUTH 2.0を選択します。

このオプションは、[Authentication Type] (認証タイプ)ドロップダウンリストから、ON_PREMISEを選択し、[CRM Version] (CRMバージョン)ドロップダウンリストから、CRM 2016を選択している場合に利用できます。

[Flow] (フロー)

認証トークンを取得するための認証フローとして、[Authentication Code] (認証コード)か[Resource Owner Password Credentials] (リソース所有者のパスワード認証情報 - ROPC)を選択します。

このオプションは、[Authentication Type] (認証タイプ)ドロップダウンリストから、ON_PREMISEを、[CRM Version] (CRMバージョン)ドロップダウンリストから、CRM 2016を、[Mode] (モード)ドロップダウンリストから、OAUTH 2.0をそれぞれ選択している場合に利用できます。[Resource Owner Password Credentials] (リソース所有者のパスワード認証情報 - ROPC)認証フローが利用可能になるまでは、[Authentication Code] (認証コード)フローがトークンの取得に使われます。ROPCに関する情報は、Microsoft identity platform and OAuth 2.0 Resource Owner Password Credentialsをご覧ください。

[API Version] (APIバージョン)

ONLINE CRMデータベースのAPIバージョン、すなわちv2007 (非推奨)、v2011(非推奨)、v2016 (odata)、v2018のいずれかを選択します。

ONLINE 2016と2018は、MS Dynamics WebAPI v8.1 (2016)とv9.1 (2018)を使って実装されています。詳細は、https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/use-microsoft-dynamics-365-web-api?view=dynamics-ce-odata-9をご覧ください。

デフォルト値で定義されているv2018 (v2016 を選択する時はv8.1を使用)を選択する時は、Service Root URLをWebAPI v9.1以降に設定する必要があります。

このオプションは、[Authentication Type] (認証タイプ)ドロップダウンリストから、ONLINEが選択されている場合に利用できます。

[Registered application type] (登録済みアプリケーションのタイプ)

アプリケーションのタイプ、すなわち、Native AppまたはWeb App with delegated permissionsを選択します。

このオプションはCRM ONLINE 2016および2018で利用できます。

[Microsoft WebService URL] (Microsoft WEBサービスURL)

オンプレミスCRMサーバーのWebサービスURL。

このオプションはCRM ON-PREMISE 2011で利用できます。

[OrganizeName] (組織名)

CRMデータベースにアクセスする必要がある組織の名前。

このオプションはON-PREMISE 2011、ONLINE 2007、ONLINE 2011で利用できます。

[Username] (ユーザー名)と[Password] (パスワード)

CRMデータベースへのアクセスに必要となるユーザー認証データ。

パスワードを入力するためには、パスワードフィールドの横にある[...]ボタンをクリックし、ポップアップダイアログボックスにパスワードを二重引用符で囲んで入力して[OK]をクリックし、設定を保存します。

[Domain] (ドメイン)

CRMデータベースがホストされているサーバーのドメイン名。

このオプションはCRM ON-PREMISE 2011および2016で利用できます。

[Host] (ホスト)

CRMデータベースサーバーのIPアドレス。

このオプションはCRM ON-PREMISE 2011、ON-PREMISE 2016、ONLINE 2007で利用できます。

[Port] (ポート)

CRMデータベースサーバーのリスニングポート番号。

このオプションはCRM ON-PREMISE 2011で利用できます。

[Organization Wsdl URL] (組織のWsdl URL)

組織サービスのWSDL URL。

このオプションはCRM ON-PREMISE 2015で利用できます。

[Security Service URL] (セキュリティサービスURL)

Security Token ServiceのURL。

このオプションはCRM ON-PREMISE 2015で利用できます。

[Trust Certificate] (証明書)

証明書ファイルへのパス。

このオプションはCRM ON-PREMISE 2015で利用できます。

[Discovery service endpoint] (検索サービスエンドポイント)

CRMオンライン検索サービスエンドポイント。

Microsoftリージョナル検索サービスが非推奨にされたため、このhttps://globaldisco.crm.dynamics.com/api/discovery/v2.0/InstancesというエンドポイントURLを使って、このフィールド内のエンドポイントURLを置換することを忘れないでください。

関連情報は、エラーコード: DynamicsFailedToConnectというトピックを、Azure Data Factoryコネクターのトラブルシューティングおよびコードを変更してグローバル検索サービスでご覧ください。

このオプションはCRM ONLINE 2011で利用できます。

[Service Root URL] (サービスのルートURL)

接続するサービスのルートURL。

このオプションはCRM ON-PREMISE 2016、ONLINE 2016および2018で利用できます。

[Application ID] (アプリケーションID)

Azureポータルでアプリケーションを登録する時にAzure ADによってアプリケーションに割り当てられるユニークなクライアントID。このフィールドに表示されているデフォルトクライアントIDはテスト用です。ご自分の現行のクライアントIDを適用する必要があります。クライアントIDの適用に関する詳細は、 クイックスタート: Microsoft IDプラットフォームでアプリケーションを登録をご覧ください。

このオプションは、Microsoft CRM ONLINE 2011、2016、2018で利用できます。

[Application secret] (アプリケーションシークレット)

Webアプリケーション用のアクセスキー。その値の取得方法の詳細は、アプリケーションに権限を付与をご覧ください。

このオプションは、[Registered application type] (登録済みのアプリケーションタイプ)ドロップダウンリストから、Web App with delegated permissionsが選択されている時に利用できます。

[Token endpoint] (トークンエンドポイント)

認証トークンの取得元エンドポイントのURLを入力します。

このフィールドは、[Flow] (フロー)ドロップダウンリストから、[Resource Owner Password Credentials] (リソース所有者のパスワード認証情報)が選択されている場合に利用できます。

[OAuth authorization endpoint] (OAuth認証エンドポイント)

OAuthの検索に使用するOAuth認証エンドポイント。詳細は、エンドポイントをご覧ください。

このオプションは、Microsoft CRM ONLINE 2011、2016、2018で利用できます。

このオプションは、[Flow] (フロー)ドロップダウンリストから、[Resource Owner Password Credentials] (リソース所有者のパスワード認証情報)が選択されている場合は利用できません。

[Redirect URL] (リダイレクトURL)

OAuth 2.0のリダイレクトURLを入力します。

このフィールドは、[Mode] (モード)ドロップダウンリストから、OAUTH 2.0が選択されていない場合、または[Flow] (フロー)ドロップダウンリストから、[Resource Owner Password Credentials] (リソース所有者のパスワード認証情報)が選択されている場合は利用できません。

[Time out (second)] (タイムアウト(秒))

接続を閉じる前にCRMサーバーからのレスポンスメッセージを待機する秒数。

[Entity] (エンティティ) / [EntitySet] (エンティティセット)

該当するエンティティ/エンティティセットをリストから選択するか、またはCustomEntity/CustomEntitySetをリストから選択し、[Custom Entity Name] (カスタムエンティティ名)フィールドが表示されたら、エンティティ/エンティティセットの名前を指定し、カスタムエンティティ/エンティティセットのスキーマを定義します。

[Schema] (スキーマ)と[Edit schema] (スキーマを編集)

スキーマとは行の説明のことです。処理して次のコンポーネントに渡すフィールド(カラム)数を定義します。Sparkジョブを作成する場合、フィールドの命名時は予約語のlineを避けます。

• [Built-in] (組み込み): そのコンポーネントに対してのみスキーマを作成し、ローカルに保管します。

• [Repository] (リポジトリー): スキーマは作成済みで、リポジトリーに保管されています。さまざまなプロジェクトやジョブデザインで再利用できます。

スキーマを変更するには[Edit schema] (スキーマを編集)をクリックします。現在のスキーマがリポジトリータイプの場合は、3つのオプションを利用できます。

• [View schema] (スキーマを表示): スキーマのみを表示する場合は、このオプションを選択します。

• [Change to built-in property] (組み込みのプロパティに変更): ローカルで変更を行うためにスキーマを組み込みに変更する場合は、このオプションを選択します。

• [Update repository connection] (リポジトリー接続をアップデート): リポジトリーに保存されているスキーマに変更を加え、変更後にそのコンテンツをすべてのジョブにプロパゲートするかどうかを決める場合は、このオプションを選択します。

  変更を現在のジョブにのみ反映する場合は、変更後、[No] (いいえ)を選択し、[Repository Content] (リポジトリーコンテンツ)ウィンドウで再びこのスキーマのメタデータを選択します。

このコンポーネントのスキーマは、指定されたエンティティに関連しています。

このチェックボックスをオンにすると、表示されたフィールドでcontains、endswith、startswithなどの標準のODataクエリーファンクションを使用する検索条件を指定できます。サポートされているクエリーファンクションの詳細は、Web APIを使用したクエリーデータで標準クエリーファンクションの説明をご覧ください。

このオプションはCRM ON-PREMISE 2016、ONLINE 2016および2018で利用できます。

[Logical operator used to combine conditions] (条件の結合に使用する論理演算子)

[Conditions] (条件)テーブルで定義された条件の結合に使用する論理演算子を選択します。

• [And] (および): すべての条件を満たすレコードが結果セットに含まれます。

• [Or] (または): いずれかの条件を満たすレコードが結果セットに含まれます。

条件

[+]ボタンをクリックして必要な条件を追加し、条件ごとに以下のパラメーターを指定します:

• [Input column] (入力カラム): セルをクリックし、条件を設定する入力スキーマのカラムを選択します。

• [Operator] (演算子): セルをクリックし、[Value] (値)カラムで定義されている値と入力カラムの値を比較するために使用する演算子を選択します。このパラメーターの値はEqual、NotEqual、GreaterThan、LessThan、GreaterEqual、LessEqual、およびLikeになります。

• [Value] (値): 必要に応じて、引用符の間の値を入力します。CRM ONLINEまたはON-PREMISEバージョン2016 (またはそれ以降のバージョン)を使用している場合、ID (salesorderidなど)であるカラムを使ってデータをフィルター処理するためには、そのIDをJavaUUID (java.util.UUID.fromString("your_salesorderid")など)に変換する式をこのフィールドに入力する必要があります

このチェックボックスをオンにすると、表示されたテーブルのカラムについて、取得したデータを昇順または降順のどちらでソートするか指定できます。複数のソートカラムを指定できます。ソートの階層はカラムを指定する順序に基づきます。つまり、取得したデータは最初のカラムでソートされ、次にそのソートされたリストが2番目のカラムでソートされます。

このオプションはCRM ON-PREMISE 2016、ONLINE 2016および2018で利用できます。

[Reuse Http Client] (HTTP Clientの再利用)

このチェックボックスを選択して現在の接続を保持するか、オフにして接続を解除します。

このオプションはCRM ON-PREMISE 2015では利用できません。

[Max number of reconnection attempts] (再接続試行最大回数)

トークン失効後のCRMデータベースへの再接続試行最大回数。値を0または0未満に設定すると、再接続は試行されません。

このオプションはCRM ON-PREMISE 2016、ONLINE 2011、2016、2018で利用できます。

[Force OAuth resource] (OAuthリソースを強制)

このオプションを選択すると、デフォルト以外のOAuthリソースを使用できます。[Resource] (リソース)フィールドにOAuthリソースのURLを入力します。このオプションが選択されていない場合は、このリソースが[Basic settings] (基本設定)ビューの[Service Root URL] (サービスルートURL)オプションのホストになります。

このフィールドは、[Mode] (モード)ドロップダウンリストから、OAUTH 2.0が選択されている場合に利用できます。

[Expand entity] (エンティティを展開)

展開されたエンティティプロパティを取得して、プロパティを専用カラムに書き込みます。展開されたエンティティプロパティは、カラムにJSTON文字列として書き込まれます。

カラムに展開されたエンティティの特定のプロパティを取得し、書き込むには、テーブルの下にあるプラスボタンをクリックしてテーブル内に行を追加します。[Expandable column] (展開可能なカラム)で展開されたエンティティを参照する展開可能なカラムをドロップダウンリストから選択し、[OData query option] (ODataクエリーオプション)カラムに展開されたエンティティの目的のプロパティを入力して、[Destination column] (宛先カラム)カラムでドロップダウンリストから宛先カラムを選択します。

$select={property_1_name},{property_2_name},...という形式に従って、[OData query option] (ODataクエリーオプション)カラムで1つ以上のプロパティを指定できます。プロパティを少なくとも1つ提供する必要があります。展開されたエンティティのプロパティをすべて取得して書き込むには、このカラムに$select=*と入力します。関連情報は、Olingo V4 Part 5.2: システムクエリーオプション: $select, $expandを使ってODataサービスをビルドする方法をご覧ください。

このフィールドは、ON_PREMISE (CRM 2016必須)とONLINE (APIバージョン2016以上必須)の[Authentication Type] (認証タイプ)で使用できます。

[Custom headers] (カスタムヘッダー)

HTTPリクエストにヘッダー値のペアを追加して、特定の目的(たとえば、呼び出しのたびに取得できるページの最大数を取得する)を成し遂げます。詳細は、HTTP 要求の作成とエラーの処理をご覧ください。

ヘッダー値のペアを追加するには、テーブルの下にある[+]ボタンをクリックし、新しい行を追加して、対応するカラムにヘッダー名と値を入力します。

このオプションはCRM ON-PREMISE 2016、ONLINE 2016および2018で利用できます。

[tStatCatcher Statistics] (tStatCatcher統計)

このチェックボックスを選択すると、ジョブレベルおよび各コンポーネントレベルでジョブ処理メタデータが収集されます。

NB_LINE

処理された行数。これはAfter変数で、整数を返します。

ERROR_MESSAGE

エラー発生時にコンポーネントによって生成されるエラーメッセージ。これはAfter変数で、文字列を返します。

使用ルール

このコンポーネントは、通常、ジョブまたはサブジョブの開始コンポーネントとして使い、常に出力リンクが必要です。

制限事項

tMicrosoftCRMInput(ONLINE 2016およびON-PREMISE 2016の両方)で、書き込み専用プロパティのデータの取得はサポートされていません。書き込み専用プロパティに対応するスキーマカラムが、定義済みのスキーマから削除されています。