tMicrosoftCrmOutputの標準プロパティ - 7.3

Microsoft CRM

Version
7.3
Language
日本語
Product
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for ESB
Talend Real-Time Big Data Platform
Module
Talend Studio
Content
ジョブデザインと開発 > サードパーティーシステム > ビジネスアプリケーション > Microsoft CRM
データガバナンス > サードパーティーシステム > ビジネスアプリケーション > Microsoft CRM
データクオリティとプレパレーション > サードパーティーシステム > ビジネスアプリケーション > Microsoft CRM

これらのプロパティは、標準ジョブのフレームワークで実行されるtMicrosoftCrmOutputを設定するために使われます。

標準tMicrosoftCrmOutputコンポーネントは、ビジネスファミリーに属しています。

注: 特に断りのない限り、このドキュメントにおけるCRMは、使用するCRMのバージョンに応じてMicrosoft Dynamics CRMまたはMicrosoft Dynamics 365 CRMを指します。

基本設定

[Authentication Type] (認証タイプ)

特定のCRMデプロイモデルに対応する認証タイプを選択します。
  • ON_PREMISE: CRMはインハウスで顧客自身のサーバーにインストールされ、ライセンスは必要なインフラストラクチャーと共に購入されます。

  • ONLINE: 顧客は、Microsoftがデータセンターにホストしているクラウドベースサブスクリプションサービスの一部としてCRMにアクセスします。

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

ON-PREMISE CRMデータベースのバージョン、すなわち、CRM 2011CRM 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を選択している場合に利用できます。

注: このオプションは、TalendのR2020-10以降のStudioマンスリーアップデートをインストール済みである場合のみ利用できます。詳細は管理者にお問い合わせください。

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

ONLINE CRMデータベースのAPIバージョン、すなわち、v2007v2011v2016v2018のいずれかを選択します。

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

[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プラットフォームでアプリケーションを登録をご覧ください。

このプロパティはCRM ONLINE 2011、2016、2018で利用できます。

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

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

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

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

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

このプロパティはCRM ONLINE 2011、2016、2018で利用できます。

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

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

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

注: このオプションは、TalendのR2020-10以降のStudioマンスリーアップデートをインストール済みである場合のみ利用できます。詳細は管理者にお問い合わせください。

[Action] (アクション)

CRMデータに対して実行するアクションを、insert (挿入)、update (アップデート)、delete (削除)から選択します。

Apacheの制限により、CRM ONLINE2016のCRMデータをNULL値でアップデートできませんでした。制限の詳細は、https://issues.apache.org/jira/browse/OLINGO-1114ご覧ください。

[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] (リポジトリーのコンテンツ)ウィンドウで再びこのスキーマのメタデータを選択します。

ジョブで接続している先行コンポーネントからスキーマを取得するためには、[Sync columns] (カラムを同期)をクリックします。

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

[Lookup Type Mapping] (ルックアップタイプのマッピング)

この表を完成させて、ルックアッププロパティを関連するエンティティタイプまたはエンティティセット値にマップします。

  • [Input column] (インプットカラム):ルックアッププロパティのスキーマカラム名。

  • [Type] (タイプ): 対応するルックアッププロパティの関連エンティティタイプ。ON-PREMISE 2016およびONLINE 2016では使用できません。

  • [Reference entityset] (参照エンティティセット):対応するルックアッププロパティに設定された関連エンティティの名前。ON-PREMISE 2016およびONLINE 2016でのみご利用いただけます。各エンティティのルックアッププロパティのエンティティセットの詳細は、[Web API EntityType Reference] (Web APIEntityTypeリファレンス)をご覧ください。

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

詳細設定

[Reuse Http Client] (HTTPクライアントの再利用)

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

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

[Transform empty lookup string values to NULL] (空のルックアップ文字列値をNULLに変換します)

このチェックボックスをオンにすると、空のルックアップ文字列がNULL値としてCRMデータベースに書き込まれます。

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

NULLを無視

入力データのNULL値を無視するには、このチェックボックスをオンにします。

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

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

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

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

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

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

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

注: このオプションは、TalendのR2021-07以降のStudioマンスリーアップデートをインストールした時のみ利用できます。詳細は管理者にお問い合わせください。

[Return representation] (表記を返す)

このオプションを選択して、作成またはアップデートされたエンティティからデータを取得するreturn=representation環境設定のPreferヘッダーを追加します。データはJSON文字列で返されます。[Output column] (出力カラム)からカラムを選択して、取得されたデータを保持することも必要です。

詳細は、HTTPヘッダーをご覧ください。

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

注: このオプションは、TalendのR2021-07以降のStudioマンスリーアップデートをインストールした時のみ利用できます。詳細は管理者にお問い合わせください。

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

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

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

注: このオプションは、TalendのR2020-10以降のStudioマンスリーアップデートをインストール済みである場合のみ利用できます。詳細は管理者にお問い合わせください。

[tStatCatcher Statistics] (tStatCatcher統計)

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

グローバル変数

NB_LINE

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

ERROR_MESSAGE

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

使用方法

使用ルール

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