チュートリアル: プラグイン登録ツールを使用したプラグインの登録

公開日: 2017年1月

対象: Dynamics 365 (online)、Dynamics 365 (on-premises)、Dynamics CRM 2016、Dynamics CRM Online

このチュートリアルでは、SDK で提供されている Plug-in Registration ツールを使用してプラグインを登録する方法について説明します。 登録するプラグインは、「サンプル: 基本プラグインの作成」トピックの FollowupPlugin です。

プラグインは、account エンティティ、CreateRequest メッセージ、ポスト イベント、およびサンドボックスに登録されます。 プラグインは、ユーザー アカウントにシステム カスタマイザー ロールまたはシステム管理者ロールのある Microsoft Dynamics 365 (オンラインおよび設置型) の任意の展開に登録できます。

このチュートリアルを開始する前に、次の前提条件を満たしておく必要があります。

• SDK の Tools\PluginRegistration フォルダーにある PluginRegistration.exe を取得します。Microsoft Dynamics CRM SDK パッケージをダウンロードします。

• Microsoft Dynamics 365 サーバーのシステム アカウントを取得します。

• ユーザー アカウントにはシステム カスタマイザー ロールまたはシステム管理者ロールが必要です。 「ロールベースのセキュリティを使用して Microsoft Dynamics 365 におけるエンティティへのアクセスを制御する方法」を参照してください。

Microsoft Dynamics 365 Server に接続する

1. Plug-in Registration ツールを実行します。

2. [新しい接続の作成] をクリックします。

3. ログイン ダイアログで、プラグインを登録する Microsoft Dynamics 365サーバーに対応する展開の種類のラジオボタンを選択します。[設置型]ラジオ ボタンには、IFD の展開が含まれます。[オンライン]ボタンはMicrosoft Dynamics 365 (オンライン)のWindows Liveプロバイダー用です。[Office 365] ボタンは、Microsoft Dynamics 365 (オンライン)のMicrosoft Online Servicesプロバイダー用です。

   オンライン展開のログイン ウィンドウ

   設置型展開のログイン ウィンドウ

4. [使用可能な組織の一覧を常に表示する] チェックボックスをオンにする場合、[ログイン] をクリックした後、所属している組織の一覧が表示されます。 これにより、プラグインを登録する組織を選択することができます。 選択しない場合は、既定の組織が使用されます。

5. サーバーおよびログインのアカウントに関する指示される情報を入力し、[ログイン] をクリックします。

登録済みのプラグインまたはユーザー定義のワークフロー活動アセンブリおよびサービス エンドポイントの折りたたまれた一覧が表示されます。 アクティビティ フィードおよび Microsoft.Crm.ObjectModel アセンブリは、Microsoft Dynamics 365が適切に機能して、それらを変更できないようにするために必要です。 一覧でアイテムを選択すると、 プロパティ と の詳細 タブ ウィンドウにリスト アイテムに関する情報が表示されます。

アプリケーションのメイン ウィンドウ

プラグイン アセンブリを登録する

1. アクティブにする組織タブを選択します。

2. タブのツールバーで、[登録]、[新しいアセンブリの登録] を順にクリックします。

3. [新しいアセンブリの登録] ダイアログ ボックスで、[手順 1] フィールドの右側の省略記号 […] ボタンをクリックします。

4. [開く] ダイアログ ボックスで、コンパイル済み SamplePlugin.dll アセンブリの場所に移動します。 既定の場所は SDK\SampleCode\CS\Plug-ins\bin\Debug です。 アセンブリを選択し、[開く] をクリックします。

5. 手順 2 セクションで、 SamplePlugins アセンブリを展開し、 アセンブリ内のすべてのプラグインを表示します。Microsoft.Crm.Sdk.Samples.FollowupPlugin プラグインだけを選択 (チェック) します。

6. [手順 3] セクションで、[サンドボックス] オプションを選択します。

7. [手順 4] セクションで、[データベース] オプションを選択します。

   

   アセンブリの登録へのダイアログ

8. [選択したプラグインの登録] をクリックします。 開いている任意のダイアログ ボックスを閉じることができます。

   

   ツリー ビューに表示された登録されたプラグイン

   ヒント

   ログ領域にエラーが表示されログに次のメッセージが含まれていますか。

   <Message>Action failed for assembly 'SamplePlugins, Version=0.0.0.0, Culture=neutral, PublicKeyToken=829f574d80e89132': Deployment/Scalegroup does not allow running external code.</Message>

   その場合は、サーバー上のカスタムのコードを有効にしてもう一度やり直してください。 詳細については、「カスタム コード実行の有効化または無効化」を参照してください。

SamplePlugins.dll アセンブリと FollowupPlugin プラグインが登録されて、サーバーに展開されます。 ツールを使用してユーザー定義のワークフロー活動アセンブリを登録した場合は、手順の登録に関する次のセクションは適用されません。

イベントにプラグイン ステップを登録する

1. 登録されたプラグイン & ユーザー定義のワークフロー活動 ツリー ビューで、(アセンブリ) SamplePlugins ノードを展開し、登録されたプラグインを選択します。

2. ツール バーで、[登録] メニューに移動し、次に [新しいステップの登録] をクリックします。

   注意

   イベントがイベント実行パイプライン内で処理されるときに実行するように、プラグインが登録されます。 各イベントには、パイプライン内での位置 (コア プラットフォーム操作の前または後) を示すステージ名と番号があります。"手順" は、プラグインの実行方法とタイミングを構成するために使用される SDK メッセージ処理手順エンティティを示します。

3. 次の図に示すように、[新しい手順の登録] ダイアログ ボックスを終了します。

   

   新しいステップの登録へのダイアログ

4. [新しい手順の登録] をクリックします。

5. [(アセンブリ) SamplePlugins] ノードとサブノードを展開し、作成したプラグインと手順ノードを表示します。 ここでツールを閉じることもできますが、プラグインをテストしてアセンブリの登録を解除するまで開いたままにしておいてもかまいません。

   注意

   手順、プラグイン、またはアセンブリの登録を解除するには、ツリーでそのノードを選択して、ツール バーの [登録を解除] をクリックします。 アセンブリまたはステップの登録を変更するには、ツリー ビューで、アセンブリまたはステップのノードをダブルクリックします。 代わりに、ノードを選択し、ツール バーの [更新] をクリックします。

プラグインは、サンドボックス内で、アカウント作成イベントに対して、コア操作が実行した後で実行するように登録されています。 フォローアップ タスク活動の作成はタイム クリティカルではないので、非同期に実行するようにプラグインを登録しました。 アカウントが作成された後、次に非同期サービスがキューを処理するときに、プラグインが実行します。

プラグインのテスト

プラグインを登録した後、必要に応じて、以下の手順を使用してプラグインの実行をオプションでテストできます。

1. プラグイン アセンブリを登録したのと同じ組織に対して Microsoft Dynamics 365 Web アプリケーションを開きます。

2. ワークプレースに移動し、[取引先企業] を選択し、[新規] をクリックします。

3. [取引先企業名] ボックスに取引先企業の名前を入力し (たとえば「Adventure Works Cycle」)、[保存して閉じる] をクリックします。

4. [取引先企業] グリッドでフォーム名をダブルクリックして、フォームを開きます。

5. [活動] をクリックして、取引先企業に関連する活動の一覧を表示します。 プラグインが作成した “Send email to the new customer“ という名前の活動が表示されます。

6. 非同期に実行するようにプラグインを登録し、[新しい手順の登録] フォームで [AsyncOperation if StatusCode の削除 = 成功] オプションを選択しなかった場合は、“FollowupPlugin: Create of account” という名前の新しいシステム ジョブが表示されます。 関連するシステム ジョブを表示するには、[設定] をクリックし、[システム ジョブ] をクリックします。 前述のシステム ジョブをダブルクリックします。

必要に応じて、手順、プラグイン、およびアセンブリの登録を解除できるようになります。 また、作成したシステム ジョブと取引先企業を削除してもかまいません。

関連項目

プラグインの開発
チュートリアル: オフライン プラグインのアセンブリ セキュリティの構成
プラグインの登録および展開
イベント実行パイプライン
プラグイン分離、信頼、および統計
サポートされているプラグインのメッセージおよびエンティティ

Microsoft Dynamics 365

© 2017 Microsoft. All rights reserved. 著作権