サポートされているプラグインのメッセージおよびエンティティ
このトピックは、オフライン アクセス対応 Dynamics 365 for Microsoft Office Outlook のプラグインでオフライン実行をサポートするメッセージとエンティティの組み合わせを明らかにします。 オフライン実行を要求しないサーバー登録済みのプラグインの詳細は 使用可能なイベント を参照してください。
以下に示す表の メッセージの可用性 列は、メッセージがオンライン、オフライン、またはその両方で使用可能かどうかを示しています。 エンティティの展開列は、エンティティをサーバー、クライアント、またはその両方に展開できるかどうかを示しています。 主エンティティ列が null 値の場合は、メッセージに主エンティティが関連付けられていないことを意味します。 これは、副エンティティ列でも同じです。
プラグイン コードで、メタデータを作成または更新するメッセージを除くどんなメッセージでも Web サービスに送信できます。
ユーザー定義エンティティは、エンティティが組織所有またはユーザー所有であるかによって、システム エンティティと同じベース メッセージをサポートしています。 詳しくは、「エンティティ レコードに対する操作」をご覧ください。
Note
"オフライン"という用語は、オフライン アクセス対応 Dynamics 365 for Microsoft Office Outlook に適用されます。 クライアント という用語は、Dynamics 365 for Outlook Online またはオフライン アクセス対応 Dynamics 365 for Microsoft Office Outlook に適用されます。
メッセージをオンラインまたはオフラインで使用できるかどうかは、プログラムまたはクエリを使用して SdkMessage.Availability
属性を調べることによって判断できます。 組織のエンティティ メタデータを表示するには、メタデータ ブラウザー ソリューションをインストールしてください。メタデータ ブラウザー ソリューションについては、「組織のメタデータの参照」を参照してください。 「エンティティ参照」でエンティティの参照ドキュメントを参照することもできます。
サポートされているユーザー定義エンティティのメッセージ
ユーザー定義エンティティは、組織所有またはユーザー所有のいずれかで、エンティティに使用できるメッセージのセットを定義します。 次の表は、プラグインの実行をサポートするユーザー定義エンティティのメッセージを示します。
メッセージ名 | 所有権の種類 | メッセージの可用性 | 展開をサポートしているエンティティ |
---|---|---|---|
割り当て | ユーザー所有のエンティティのみ | サーバー | サーバー |
作成 | ユーザー所有と組織所有のエンティティ | 両方 | サーバー |
削除 | ユーザー所有と組織所有のエンティティ | 両方 | サーバー |
GrantAccess | ユーザー所有のエンティティのみ | サーバー | サーバー |
ModifyAccess | ユーザー所有のエンティティのみ | サーバー | サーバー |
取得 | ユーザー所有と組織所有のエンティティ | 両方 | サーバー |
RetrieveMultiple | ユーザー所有と組織所有のエンティティ | 両方 | サーバー |
RetrievePrincipalAccess | ユーザー所有のエンティティのみ | 両方 | サーバー |
RetrieveSharedPrincipalsAndAccess | ユーザー所有のエンティティのみ | 両方 | サーバー |
RevokeAccess | ユーザー所有のエンティティのみ | サーバー | サーバー |
SetState | ユーザー所有と組織所有のエンティティ | 両方 | サーバー |
更新 | ユーザー所有と組織所有のエンティティ | 両方 | サーバー |
サポートされている既定のエンティティのメッセージ
プラグインの作成を検討する前に、ターゲット メッセージとエンティティ要求がプラグインの実行をサポートしているか確認する必要があります。Dynamics 365 は新しいメッセージやエンティティで定期的に更新されるため、この情報については組織に問い合わせるのが最善です。 プラグイン登録ツールを使用するか、または後述のように fetchXML クエリを実行することでこれを行うことができます。
メッセージとエンティティの組み合わせがプラグイン登録ツールを使用したプラグインの実行をサポートしているか確認するには、これらの手順に従います。
- ツールを実行して D365 組織に接続します。
- 登録済みプラグインおよびユーザー定義のワークフロー活動 リストでは、登録済みプラグインを含むアセンブリを展開します。実際にはステップ登録を完了していないので、システム アセンブリでこのステップを実行することもできます。
- 一覧でプラグインを右クリックして 新しいステップの登録 を選択します。
- 適切なフィールドにターゲット メッセージと主エンティティを入力して、その組み合わせがプラグイン登録でサポートされているかどうか確認します。
- ステップ登録フォームをキャンセル(閉じる)してツールを終了します。
メッセージとエンティティの組み合わせがデータベース クエリを使用したプラグインの実行をサポートしているかどうかを確認するには、高度な検索またはコミュニティ ツール (FetchXML Builder など) を使用して次の fetchXML クエリを実行します。 高度な検索を使用する場合は、クエリを対話的に作成する必要があります。
Outlook クライアントのオフライン プラグインの場合:
<fetch>
<entity name='sdkmessage' >
<attribute name='name' />
<link-entity name='sdkmessagefilter' alias='filter' to='sdkmessageid' from='sdkmessageid' link-type='inner' >
<filter type='and' >
<condition attribute='iscustomprocessingstepallowed' operator='eq' value='1' />
<condition attribute='isvisible' operator='eq' value='1' />
<condition attribute='availability' operator='ne' value='0' />
</filter>
<attribute name='primaryobjecttypecode' />
</link-entity>
<filter>
<condition attribute='isprivate' operator='eq' value='0' />
<condition attribute='name' operator='not-in' >
<value>SetStateDynamicEntity</value>
<value>RemoveRelated</value>
<value>SetRelated</value>
<value>Execute</value>
</condition>
</filter>
<order attribute='name' />
</entity>
</fetch>