【Microsoft Dataverse】 宣言型ツールのその先へ｜Dataverse プラグインでビジネスロジックを実装する #0409

Power Platform では、Power Apps や Power Automate、Dataverse の各種機能を利用することで、多くの業務アプリケーションをローコードで構築できます。

しかし、すべての要件を宣言型のツールだけで実現できるとは限りません。

たとえば、

• Dataverse のデータ操作が行われる特定のタイミングで処理したい

• データが保存される前に独自の検証や処理を行いたい

• 更新前と更新後の値を比較して処理したい

• Dataverse の操作と密接に連動する独自のビジネスロジックを実行したい

といった要件では、コードによる拡張が必要になることがあります。

その代表的な仕組みが Dataverse プラグインです。

今回取り上げる Microsoft Learn の Implement business logic with Microsoft Dataverse plug-ins は、まさに「宣言型ツールだけでは実装が難しいビジネスロジックを、Dataverse プラグインを使ってどのように実装するか」を学ぶモジュールです。

Dataverse プラグインとは

Dataverse プラグインは、Dataverse で発生するイベントに応じて独自のコードを実行するための仕組みです。

プラグインを記述してコンパイルした後、Dataverse のイベントフレームワークに登録することで、特定のテーブルに対する特定の処理が発生したタイミングでコードを実行できます。

たとえば「取引先企業のレコードが作成された」「特定のレコードが更新された」といったデータ操作にビジネスロジックを組み込めます。

Microsoft Learn の公式ドキュメントでは、プラグインのクラスは IPlugin インターフェイスを実装し、Execute メソッドを通じて処理を実行する基本構造が説明されています。

ここが、Power Automate などを使った後続処理とは少し異なるところです。

単に「何かが起きた後に別の処理を行う」だけでなく、Dataverse のデータ操作そのものに組み込む形でビジネスロジックを実行できるのがプラグインを理解するうえで重要なポイントです。

今回の Microsoft Learn で学べること

このモジュールは 中級レベルの Developer 向けとして提供されており、学習時間の目安は 43分、7ユニット、800 XP です。

主な学習内容は次のとおりです。

1. イベント実行パイプライン

Dataverse プラグインを理解するために重要なのが、イベント実行パイプラインです。

Dataverse でデータ操作が行われると、その処理は複数のステージを通ります。

プラグインを適切なステージに登録することで、データ操作のどのタイミングで独自の処理を実行するかを制御できます。

このモジュールでは、異なるイベント実行パイプラインのステージをどのように利用するかを学習します。

2. Execution Context

プラグインでは、現在実行されている Dataverse の処理に関する情報を利用する必要があります。

そのために使用するのが Execution Context（実行コンテキスト）です。

このモジュールでは、実行コンテキストを利用するプラグインの開発が学習目標の1つに設定されています。

Dataverse プラグインを学習するときは、「コードを書く」だけではなく、いま Dataverse で何が起きているのかを取得し、その情報をもとに処理するという考え方が重要になります。

3. Pre Image と Post Image

もう1つ重要なのが Pre Image と Post Image です。

プラグインのロジックでは、処理前や処理後のレコード情報が必要になることがあります。

Microsoft Learn のこのモジュールでも、Pre Images と Post Images を使用してプラグインのロジックを支援する方法が学習目標として設定されています。

たとえば、

といったロジックを考える際に重要な仕組みです。

4. Organization service

プラグインから Dataverse に対する操作を行う場合には、Organization service を使用できます。

今回のモジュールでは、Organization service を使ってプラグインから操作を実行することも学習目標に含まれています。

つまりプラグインは、渡されたデータをチェックするだけではありません。

必要に応じて Dataverse の別のデータを扱うロジックにも発展させられます。

このあたりまで理解できるようになると、Dataverse を単なる「アプリのデータ保存先」として見るのではなく、ビジネスロジックを実行するプラットフォームとして見る感覚がつかみやすくなります。

作成したプラグインは「登録」が必要

C# でプラグインを書いただけでは、Dataverse 上では実行されません。

作成してコンパイルしたプラグインは Dataverse のイベントフレームワークへ登録し、どのイベントで実行するのかを設定する必要があります。

Microsoft Learn の今回のモジュールでは、Plug-in Registration tool を利用したプラグインコンポーネントの登録も扱います。

Microsoft の公式ドキュメントによると、Plug-in Registration tool（PRT）は、プラグインアセンブリやメッセージ処理ステップなどを Dataverse に登録するために利用できます。

つまり、

C# でロジックを作る → ビルドする → Dataverse に登録する → イベント発生時に実行される

という一連の流れまで理解することが、プラグイン開発の基本になります。

最近は Power Platform CLI から始める方法もある

今回の Microsoft Learn モジュールでは Plug-in Registration tool が中心ですが、ここは現在の Power Platform 開発環境を考えるうえで知っておきたいポイントです。

Microsoft の公式ドキュメントでは、プラグイン作成方法として Power Platform Tools for Visual Studio と Power Platform CLI も紹介されています。

Power Platform CLI では、

「pac plugin」

コマンドを利用して、基本的なプラグインプロジェクトとテンプレートコードを作成できます。また、pac tool prt から Plug-in Registration tool を利用する方法も案内されています。

Microsoft Learn のモジュールを終えた後に、Power Platform CLI を使った開発方法へ進んでみるのもよいでしょう。

プラグイン開発ではトレースも覚えておきたい

コードを書いて実行する以上、正常に動かなかったときの調査方法も必要になります。

Dataverse では ITracingService を利用して、プラグインなどのカスタムコードから実行時の情報を記録できます。これはコードの障害原因を調査するときに利用できます。

ただし、Microsoft の公式ドキュメントでは、トレースログは組織のストレージ容量を使用するため、デバッグやトラブルシューティング時に有効化し、終了後は無効化することが推奨されています。

このあたりは実際にプラグイン開発を始める際に覚えておきたいポイントです。

このモジュールを学ぶ前に確認しておきたいこと

今回のモジュールは、Power Platform 初心者向けというより、ローコードからコード開発へ一歩進みたい人向けの内容です。

Microsoft Learn では前提知識として、次の内容が挙げられています。

• C# クラスライブラリを記述・ビルドできる

• クラス、インターフェイス、例外処理を理解している

• Dataverse のテーブル、列、リレーションシップと論理名を理解している

• モデル駆動型アプリで Dataverse の行を作成・更新できる

そのため、Power Apps を初めて触る段階でいきなりこのモジュールへ進むよりも、

Power Apps → Dataverse → C# の基本 → Dataverse プラグイン

という順序で学習すると理解しやすいと思います。

宣言型ツールとコードを「どちらか」で考えない

Power Platform を学んでいると、

という点に注目しがちです。

しかし、中級レベルから先では少し視点を変える必要があります。

重要なのは、

という考え方です。

Dataverse プラグインは、その選択肢を広げるための重要な技術の1つです。

まず Power Apps や Power Automate などで実現できるのかを検討し、それだけでは要件を満たすことが難しい場合にプラグインを検討する。

このように考えることで、Power Platform を「ローコードツール」としてだけではなく、必要に応じてコードで拡張できる業務アプリケーションプラットフォームとして捉えられるようになります。

まとめ

今回紹介した Microsoft Learn の Implement business logic with Microsoft Dataverse plug-ins では、宣言型ツールだけでは実装が難しいビジネスロジックを Dataverse プラグインで実装するための基本を学習できます。

特に押さえておきたいのは、

• イベント実行パイプライン

• Execution Context

• Pre Image / Post Image

• Organization service

• Plug-in Registration tool

の5つです。これらはすべて今回のモジュールの学習内容として明示されています。 [learn.microsoft.com]

Power Apps や Dataverse の基本操作には慣れてきたけれど、

「もう少し高度なビジネスロジックを実装してみたい」

という方には、次のステップとして取り組みやすい Microsoft Learn モジュールだと思います。