リアルタイムワークフローの作成

[アーティクル]
03/22/2023

非同期ワークフローと同様、リアルタイムワークフローは、現実のビジネスプロセスをモデル化および自動化するのに使用できます。必要に応じてユーザー入力を求めることもでき、特定のイベント状況に応じて自動で開始したり、ユーザーが手動で開始したりすることもできます。リアルタイムワークフローはビジネスユーザー向けで、たとえばアナリストの場合は、.NET Framework プログラミングの経験を必要とせず、同様の機能を同期プラグインに実装できるようになります。 Dynamics 365 Customer Engagement (on-premises) Web アプリケーションまたはコードでは、非同期またはリアルタイムにワークフローを作成できます。

リアルタイムワークフローについてのいくつかの重要な点には、次の項目が含まれています。

非同期ワークフローのような Workflow エンティティレコードを使用して定義します。
同期プラグインのように、イベント実行パイプラインのステージで実行します。リアルタイムワークフローは、コア操作の前 (事前操作)、後(事後操作)、またはコア操作中に実行することができます。コア操作の実行中に実行されるリアルタイムワークフローは、ユーザー定義アクションの実装です。リアルタイムワークフローは、プラグインを処理するのと同様に、ステージ内でランク付けすることができます。詳細: イベント実行パイプライン
オンデマンドで実行されるか、イベントに応答して実行されるように構成すると、リアルタイムワークフローは後で実行するようキューに置かれず、すぐに実行されます。
ワークフローのログオンユーザーまたは所有者のセキュリティコンテキストで実行できます。ただし、オンデマンド実行に設定されているワークフローでは、ログオンユーザーのセキュリティコンテキストで必ず実行します。
遅延または待機アクティビティは許可されません。
ログ記録が有効になっている場合にのみエラーを記録します。
現在のトランザクション内で実行します。非同期ワークフロー以外のワークフローおよび子ワークフローのすべての活動は、一つのトランザクションの一部です。非同期子ワークフローは、別のトランザクション内のキューに置かれ、実行されます。
非同期ワークフローを変換し、リアルタイムに戻すことができます。

必要なセキュリティ特権

ワークフローを実行できるように、リアルタイムプロセスのアクティブ化(prvActivateSynchronousWorkflow)というセキュリティ特権が、リアルタイムにワークフローをアクティブ化するのに必要となります。ワークフロージョブの実行(prvWorkflowExecution)権限が、ワークフローの開始に必要です。リアルタイムワークフローはコアシステム操作に影響を与えるので、少数の経験のあるユーザーのグループだけにアクティブ化の特権を付与することをお勧めします。

コードでリアルタイムでワークフローを作成する

Dynamics 365 for Customer Engagement はリアルタイムワークフローをサポートしますが、Web アプリケーションで対話的に作成する必要があります。このセクションで説明した XAML ベースのワークフローは、設置型または IFD サーバーでのみサポートされます。

Workflow エンティティレコードを作成することで、コードでリアルタイムにワークフローを作成できます。メタデータブラウザーツールを使用して Workflow エンティティの属性メタデータを確認します。組織のエンティティメタデータを表示するには、メタデータブラウザーソリューションをインストールしてください。メタデータブラウザーソリューションについては、「組織のメタデータの参照」を参照してください。「エンティティ参照」でエンティティの参照ドキュメントを参照することもできます。

次の例では、非同期ワークフローを作成するコードを、リアルタイムワークフローを作成するコードと比較します。



// Create an asynchronous workflow.
// The workflow should execute after a new opportunity is created.
Workflow workflow = new Workflow()
{
    // These properties map to the New Process form settings in the web application.
    Name = "Set closeprobability on opportunity create (async)",
    Type = new OptionSetValue((int)WorkflowType.Definition),
    Category = new OptionSetValue((int)WorkflowCategory.Workflow),
    PrimaryEntity = Opportunity.EntityLogicalName,
    Mode = new OptionSetValue((int)WorkflowMode.Background),

    // Additional settings from the second New Process form.
    Description = @"When an opportunity is created, this workflow" +
        " sets the closeprobability field of the opportunity record to 40%.",
    OnDemand = false,
    Subprocess = false,
    Scope = new OptionSetValue((int)WorkflowScope.User),
    TriggerOnCreate = true,
    AsyncAutoDelete = true,
    Xaml = xamlWF,

    // Other properties not in the web forms.
    LanguageCode = 1033,  // U.S. English                        
};
_workflowId = _serviceProxy.Create(workflow);



// Create a real-time workflow. 
// The workflow should execute after a new opportunity is created
// and run in the context of the logged on user.
Workflow workflow = new Workflow()
{
    // These properties map to the New Process form settings in the web application.
    Name = "Set closeprobability on opportunity create (real-time)",
    Type = new OptionSetValue((int)WorkflowType.Definition),       
    Category = new OptionSetValue((int)WorkflowCategory.Workflow),
    PrimaryEntity = Opportunity.EntityLogicalName,
    Mode = new OptionSetValue((int)WorkflowMode.Realtime),

    // Additional settings from the second New Process form.
    Description = @"When an opportunity is created, this workflow" +
        " sets the closeprobability field of the opportunity record to 40%.",
    OnDemand = false,
    Subprocess = false,
    Scope = new OptionSetValue((int)WorkflowScope.User),
    RunAs = new OptionSetValue((int)workflow_runas.CallingUser),
    SyncWorkflowLogOnFailure = true,
    TriggerOnCreate = true,
    CreateStage = new OptionSetValue((int)workflow_stage.Postoperation),
    Xaml = xamlWF,

    // Other properties not in the web forms.
    LanguageCode = 1033,  // U.S. English
};
_workflowId = _serviceProxy.Create(workflow);

リアルタイムワークフローには、非同期ワークフローには含まれていない追加プロパティセットがあります:

ワークフローの属性	説明
`Category`	`WorkflowCategory.Workflow`に設定します。
`RunAs`	ワークフローの所有者(`workflow_runas.Owner`)またはログオンユーザー(`workflow_runas.CallingUser`)のセキュリティコンテキストで、ワークフローを実行するよう指定できます。
`SyncWorkflowLogOnError`	`true`の場合、エラーが`ProcessSession` レコードに記録されます。非同期ワークフローとは違い、リアルタイムワークフロー実行は、`System Job`レコードに記録されません。
`CreateStage`、`DeleteStage`、または `UpdateStage`	ワークフローを実行している、イベント実行パイプラインのステージを識別します: コア操作の前(`workflow_stage.Preoperation`)、または後(`workflow_stage.Postoperation`)。ステージを目的の操作のトリガーイベントと一致させる必要があります。たとえば、`TriggerOnUpdate` が `true`の場合は、`UpdateStage`を設定する必要があります。リアルタイムワークフローは取得の際に実行できます。取得のほかに、サポートされている Web サービスメッセージの残りが、これらの3件のサポートされているイベントの 1 つにマッピングされます。たとえば、状態操作の割当てまたは設定は、最終的には更新と同じです。
`Mode`	つまり、実行モードです。これは、`WorkflowMode.Realtime` へ設定されます。
`Rank`	プラグイン実行やランク設定によるステージ内リアルタイムワークフローの順番を設定できます。 1 のランクのプラグインまたはワークフローは、2 のランクの前に実行されます。
`Xaml`	リアルタイムワークフローを定義する XAML コードに設定します。

リアルタイムワークフローを作成するための完全なサンプルコードは、サンプル: コードでリアルタイムでワークフローを作成するのトピックにあります。

非同期ワークフローをリアルタイムまたは操作後に変換する

非同期ワークフローが待機または遅延アクティビティを含んでいない限り、ワークフローの書き直しを必要とせずにUpdateRequest を使用して、ワークフローを非同期からリアルタイムおよび操作後へ変換します。 Web アプリケーションを使用して、対話的に変換を操作することもできます。変換を実行する前は、ワークフローは下書きの状態(非アクティブ)である必要があります。

非同期ワークフローをリアルタイムに変換する

ワークフローの UpdateRequest を作成します。
ワークフローの Mode プロパティをWorkflowMode.Realtimeに設定します。
必要に応じて、CreateStage、UpdateStage、または DeleteStage を設定します。たとえば、ワークフローにTriggerOnDelete 設定があると、DeleteStage プロパティも設定されます。
パラメーターとして更新要求を渡して Execute メソッドを呼び出します。

リアルタイムワークフローを非同期に変換する

ワークフローの UpdateRequest を作成します。
ワークフローの Mode プロパティをWorkflowMode.Backgroundに設定します。
パラメーターとして更新要求を渡して Execute メソッドを呼び出します。

エラー処理とロールバック

データベーストランザクション中に実行され、例外をプラットフォームに返すワークフロー活動は、コア操作を取り消します。すでに発生しているなら、これはコア操作のロールバックを発生させます。また、イベント前とイベント後は、まだ実行されていないプラグインまたはリアルタイムワークフローを登録しました。同じイベントによって起動された非同期ワークフローは実行されません。

停止ワークフロー ( TerminateWorkflow クラス) 活動をワークフローのキャンセルされたオプションに含める場合、カスタムステータスメッセージ(Reason プロパティ) にビジネスプロセスエラー ダイアログでユーザーに表示される単一行のテキストを含むその活動に追加できます。

SyncWorkflowLogOnError がtrueに設定されている場合、リアルタイムワークフローエラーはProcessSession エンティティレコードにログオンされます。

配布のリアルタイムワークフローをパッケージする

Dynamics 365 Customer Engagement (on-premises) 組織にインポートできるようにワークフローを配布するには、Dynamics 365 Customer Engagement (on-premises) ソリューションにワークフローを追加します。これは、Web アプリケーションを使用して設定 > カスタマイズ > ソリューションと移動すれば、容易に行えます。ソリューションを作成するコードを記述できます。ソリューションの使用に関する詳細については、拡張機能のパッケージ化および配布を参照してください。

次の方法で共有

リアルタイムワークフローの作成

必要なセキュリティ特権

コードでリアルタイムでワークフローを作成する

非同期ワークフローをリアルタイムまたは操作後に変換する

非同期ワークフローをリアルタイムに変換する

リアルタイムワークフローを非同期に変換する

エラー処理とロールバック

配布のリアルタイムワークフローをパッケージする

関連項目

フィードバック

その他のリソース

次の方法で共有

リアルタイム ワークフローの作成

必要なセキュリティ特権

コードでリアルタイムでワークフローを作成する

非同期ワークフローをリアルタイムまたは操作後に変換する

非同期ワークフローをリアルタイムに変換する

リアルタイムワークフローを非同期に変換する

エラー処理とロールバック

配布のリアルタイム ワークフローをパッケージする

関連項目

フィードバック

その他のリソース

リアルタイムワークフローの作成

配布のリアルタイムワークフローをパッケージする