業務プロセスフローのモデル化

[アーティクル]
10/31/2017

公開日: 2017年1月

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

業務プロセスフローにより、効率的で、より効率的な営業、サービス、および他の業務プロセスを作成できます。高効率のプロセスを適切に配置することで、成功率を最大にして、顧客満足度を向上させ、売り上げを伸ばすことができます。

業務プロセスフローでは、エンティティフォーム最上部に特別なコントロールを設定することで、ビジネスプロセスのビジュアル化を作成します。ユーザーは完了に向け、営業、マーケティング、顧客サービスプロセスのさまざまなステージで導かれます。各プロセスでは、複数のステージおよびステップをサポートします。ステップを追加または削除したり、ステップの順序を変更したり、業務プロセスフローに新しいエンティティを追加できます。

Dynamics 365 用 2016 年 12 月の更新プログラム (オンラインおよび設置型) で、さまざまな業務プロセスフロー定義をさまざまなロールに関連付けることができ、インスタンスを同じエンティティレコードに対して同時に実行できます。ユーザーは同時のビジネスプロセスインスタンスを切り替えでき、プロセスの現在の段階での作業を再開できます。新しいビジュアルなドラッグアンドドロップ方式のプロセスデザイナーを使用すると、ビジネスプロセスフロー、タスクフローなどのプロセスと、Dynamics 365 の直感的なグラフィカルインターフェイスを使用したビジネスルールを作成できます。

プロセスに関する詳細については、TechNet: 業務プロセスフローを参照してください。

このトピックの内容

業務プロセスフローのサーバー側でのプログラムのサポート

業務プロセスフローのクライアント側でのプログラムのサポート

プロセス、ステージおよび手順の最大数

業務プロセスフローのサーバー側でのプログラムのサポート

業務プロセスフローの定義は Workflow エンティティに保存されます。業務プロセスフローは、プロセスのカテゴリの 1 種類です。他のプロセスカテゴリには、アクション、ワークフロー、およびダイアログが含まれます。詳細については、「Dynamics 365 のプロセスカテゴリ」を参照してください。 UI フォームを更新したユーザー定義エンティティおよびエンティティによって、業務プロセスフローに参加できます。更新された UI エンティティには trueに設定された IsAIRUpdated プロパティがあります。業務プロセスフローのエンティティを有効にするには、trueに IsBusinessProcessEnabled プロパティを設定します。

重要

業務プロセスフローのエンティティを有効にするのは、一方向のプロセスです。これを逆にはできません。

業務プロセスフローの定義
業務プロセスフローのアクティブ化
業務プロセスフローのセキュリティを管理する
業務プロセスフローインスタンスの管理
エンティティレコードの作成時に業務プロセスフロー内を適用する

業務プロセスフローの定義

業務プロセスフローを定義するには、Dynamics 365 の新しい視覚的な業務プロセスフローデザイナーを使用します。Workflow エンティティは業務プロセスフローの定義を保存し、次の属性の値では、業務プロセスフローの Workflow エンティティレコードを指定する必要があります。name、category、businessprocesstype、primaryentity、uniquename および xaml。これらの属性の詳細については、「workflow EntityType」を参照してください。既定では、業務プロセスフローのレコードは Draft 状態で作成されます。

業務プロセスフローのアクティブ化

プロセスフローを使用するには、その前に、それをアクティブ化する必要があります。それをアクティブ化するには、Workflow エンティティの prvActivateBusinessProcessFlow の特権が必要です。Activated に、Workflow エンティティレコードの状態を設定するには UpdateRequest メッセージを使用します。詳細:[更新] を使用して特化された操作を実行する

(該当の Workflow エンティティレコードの状態を変更することで) 業務プロセスフローをアクティブ化すると、次の名前を持つユーザー定義エンティティが自動的に作成され、アクティブ化された業務プロセスフローインスタンスを保存します。「<activesolutionprefix>_<uniquename>」。

たとえば、業務プロセスフローの定義の一意の名前を「myuniquebpf1」で指定して、アクティブソリューションの既定の発行元を使用している場合、プロセスインスタンスの格納用に作成されたユーザー定義エンティティの名前は「new_myuniquebpf1」になります。

uniquename の値が業務プロセスフローの定義に使用できない場合、たとえば業務プロセスフローが以前のバージョンのソリューションの一部としてインポートされた場合、既定のユーザー定義エンティティの名前は「<activesolutionprefix>_bpf_<GUID_BPF_Definition>」になります:

重要

Dynamics 365 で使用できる業務プロセスフローレコードのサンプルは、システムエンティティを使用して対応する業務プロセスフローインスタンスのレコードを保存します。サンプル業務プロセスフローのエンティティレコードは opportunitysalesprocess EntityType および leadtoopportunitysalesprocess EntityTypeです。

ただし、作成する新しい業務プロセスフロー定義すべては、前に説明したように、ユーザー定義エンティティを使用してインスタンスレコードを保存します。

業務プロセスフローのセキュリティを管理する

業務プロセスフローをアクティブにしたときに業務プロセスフローインスタンスを格納するために自動的に作成されるユーザー定義エンティティは、他の Customer Engagement のユーザー定義エンティティと同様に標準のセキュリティモデルに従います。これは、それらのエンティティに付与される特権が、業務プロセスフローにおけるユーザー用のランタイムアクセス許可を定義することを意味します。

業務プロセスフローのユーザー定義エンティティは、組織のスコープがあります。このエンティティにおける標準の作成、取得、更新、削除の特権は、ユーザーに割り当てられたロールに基づいて与えられるアクセス許可を定義します。既定では、業務プロセスフローのユーザー定義エンティティが作成されると、システム管理者およびシステムカスタマイザーのセキュリティロールにのみアクセス許可が与えられ、他のセキュリティロールについては必要に応じてこのユーザー定義エンティティに対してアクセス許可を明示的に付与する必要があります。

業務プロセスフローインスタンスの管理

業務プロセスフローの定義をアクティブ化する際に自動的に作成されるユーザー定義エンティティは、業務プロセスフローの定義のすべてのプロセスインスタンスを保存します。ユーザー定義エンティティは、Web API、および CRM 2011 エンドポイントでのレコード (プロセスインスタンス) のプログラム作成と管理をサポートしています。たとえば、ユーザー定義エンティティの名前が「new_myuniquebpf1」である場合、次の Web API クエリを使用してユーザー定義エンティティのレコード (プロセスインスタンス) を取得できます。


[組織 URI]/api/data/v8.2/new_myuniquebpf1s

プロセスインスタンスには、次の状態のうち 1 つを使用できます。Active、Finished、または Aborted。

重要

このセクションでは、ビジネスプロセスの切り替え、エンティティレコード用のプロセスインスタンスの取得、プロセスインスタンスのアクティブパスおよびアクティブステージの取得、および次のステージまたは前のステージに移動などの、さまざまなビジネスプロセスフローシナリオのプログラム管理ついての情報を提供します。このセクションで説明されているように、業務プロセスフローをプログラム管理および自動化するには、メッセージおよび適切な業務プロセスフローのエンティティを使用する必要があります。

業務プロセスフローで有効なエンティティで、プロセスに関連する属性 (ProcessId、StageId、および TraversedPath など) を操作することは、業務プロセスフローの状態の一貫性を保証するものでなく、サポートされているシナリオではありません。唯一の例外は、業務プロセスフローの既定のアプリケーションを新しいレコードに上書きするためにエンティティレコードを作成する際に、ProcessId 属性をプログラムによって変更する場合です。詳細: エンティティレコードの作成時に業務プロセスフロー内を適用する

SetProcess Action または SetProcessRequest メッセージを使用して、ターゲットエンティティレコードのアクティブなプロセスインスタンスとして、他の業務プロセスフローを設定します。アクティブなプロセスインスタンスはエンティティレコードの UI で表示される内容です。指定された業務プロセスフロー定義のプロセスインスタンスがない場合、新しい業務プロセスフローインスタンスが作成され、アクティブなエンティティレコードとして設定されます。業務プロセスフロー定義のプロセスインスタンスがすでに存在する場合、プロセスインスタンスはエンティティレコードのアクティブプロセスインスタンスとして設定されます。特定のプロセスインスタンスをエンティティレコードのアクティブなプロセスインスタンスとして設定する場合は、NewProcessInstance プロパティを使用してインスタンスを指定できます。

プログラムでアクティブなプロセスを設定することは、UI のエンティティレコードを別のプロセスインスタンスに切り替えることと同じです。各業務プロセスフローインスタンスがそれぞれのステージとステップの進行状況に関する情報を保持するため、他の業務プロセスインスタンスに切り替えても、進行状況情報を失わず、前回と同じ場所から再開します。

次のサンプルコードは、エンティティレコードを別の業務プロセスフローに切り替える方法を示しています。

SetProcessRequest setProcReq = new SetProcessRequest
{
    Target = new EntityReference(Opportunity.EntityLogicalName, _opportunityId),
    NewProcess = new EntityReference(Workflow.EntityLogicalName, _bpfId)
};
SetProcessResponse setProcResp = (SetProcessResponse)_serviceProxy.Execute(setProcReq);

上記のコードサンプルでは、_bpfId 変数は、切り替える業務プロセスフロー定義の ID を表します。Workflow エンティティを照会することによって、必要な業務プロセスフロー定義の ID を取得できます。次のサンプルコードは、Workflow エンティティをクエリすることによって、サンプルの「営業案件営業プロセス」業務プロセスフロー定義の ID を取得する方法を示しています。

QueryExpression opportunityBpfQuery = new QueryExpression
{
    EntityName = "workflow",
    ColumnSet =  new ColumnSet("name"),
    Criteria = new FilterExpression
    {
        Conditions =
        {
            new ConditionExpression
            {
                AttributeName = "uniquename",
                Operator = ConditionOperator.Equal,
                Values = { "opportunitysalesprocess" }
            }
        }
    }
};
Workflow retrievedBPF = (Workflow)_serviceProxy.RetrieveMultiple(opportunityBpfQuery).Entities[0];
_bpfId = retrievedBPF.Id;

完全なサンプルについては、サンプル: 業務プロセスフローの使用を参照してください。

RetrieveProcessInstances Function または RetrieveProcessInstancesRequest メッセージを使用して、すべての業務プロセスの定義でエンティティレコードのすべての業務プロセスフローのインスタンスを取得します。エンティティに対して返される業務プロセスフローインスタンスは、インスタンスの modifiedon 属性に基づいて順序付けられます。たとえば、最後に変更された業務プロセスフローインスタンスは、返されたコレクションの最初のレコードになります。最後に変更された業務プロセスフローインスタンスは、エンティティレコードの UI でアクティブなインスタンスです。

次のサンプルコードは、エンティティレコードの業務プロセスフローインスタンスを取得し、エンティティレコードに関連付けられたプロセスインスタンスを一覧表示する方法を示しています。

RetrieveProcessInstancesRequest procOpp2Req = new RetrieveProcessInstancesRequest
{
    EntityId = _opportunityId,
    EntityLogicalName = Opportunity.EntityLogicalName
};

RetrieveProcessInstancesResponse procOpp2Resp = (RetrieveProcessInstancesResponse)_serviceProxy.Execute(procOpp2Req);

// Declare variables to store values returned in response
int processCount = procOpp2Resp.Processes.Entities.Count;
var activeProcessInstance = procOpp2Resp.Processes.Entities[0]; // First record is the active process instance
_processOpp2Id = activeProcessInstance.Id; // Id of the active process instance, which will be used
                                           // later to retrieve the active path of the process instance

if (processCount > 0)
{
    // Display the count of process instances concurrently associated with the opportunity record
    Console.WriteLine("\nCount of process instances for the opportunity record: {0}", processCount);

    // Display all the process instances associated with the opportunity record
    // Demonstrates that multiple processes can run concurrently against the same record
    Console.WriteLine("\nProcess instances associated with the opportunity record:");
    for (int i = 0; i<processCount; i++)
    {
        Console.WriteLine("\t{0}", procOpp2Resp.Processes.Entities[i].Attributes["name"]);
    }
}

エンティティレコードの返された業務プロセスフローインスタンスのレコードは、アクティブステージの ID を processstageid 属性に格納します。この ID は、アクティブステージを検出して、前または次のステージに移動するために使用されます。これを行うには、まず業務プロセスフローインスタンスのアクティブパスと、RetrieveActivePath Function または RetrieveActivePathRequest を使用してプロセスフローインスタンスで使用できるステージを見つける必要があります。次のサンプルコードは、業務プロセスフローインスタンスとインスタンスのアクティブステージのアクティブパスでプロセスステージを取得する方法を示しています。

// Retrieve the active stage ID of in the active process instance
_activeStageId = new Guid(activeProcessInstance.Attributes["processstageid"].ToString());

// Retrieve the process stages in the active path of the current process instance
RetrieveActivePathRequest pathReq = new RetrieveActivePathRequest
{
    ProcessInstanceId = _processOpp2Id
};
RetrieveActivePathResponse pathResp = (RetrieveActivePathResponse)_serviceProxy.Execute(pathReq);

Console.WriteLine("\nRetrieved stages in the active path of the process instance:");
for (int i = 0; i <pathResp.ProcessStages.Entities.Count; i++)
{
    Console.WriteLine("\tStage {0}: {1} (StageId: {2})", i + 1,
                            pathResp.ProcessStages.Entities[i].Attributes["stagename"], 
                            pathResp.ProcessStages.Entities[i].Attributes["processstageid"]);

    // Retrieve the active stage name and active stage position based on the activeStageId for the process instance
    if (pathResp.ProcessStages.Entities[i].Attributes["processstageid"].ToString() == _activeStageId.ToString())
    {
        _activeStageName = pathResp.ProcessStages.Entities[i].Attributes["stagename"].ToString();
        _activeStagePosition = i;
    }
}

// Display the active stage name and Id
Console.WriteLine("\nActive stage for the process instance: {0} (StageID: {1})", _activeStageName, _activeStageId);

アクティブステージと業務プロセスフローインスタンスのアクティブパス情報を取得したら、その情報を使用してアクティブパスの前または次のステージに移動できます。ステージの前方へのナビゲーションは、順番に実行する必要があります。つまり、アクティブなパスの次のステージに進むだけです。次のサンプルコードは、業務プロセスフローインスタンスの次の段階に移動する方法を示しています。

// Retrieve the stage ID of the next stage that you want to set as active
_activeStageId = (Guid)pathResp.ProcessStages.Entities[_activeStagePosition + 1].Attributes["processstageid"];

// Retrieve the process instance record to update its active stage
ColumnSet cols1 = new ColumnSet();
cols1.AddColumn("activestageid");
Entity retrievedProcessInstance = _serviceProxy.Retrieve("opportunitysalesprocess", _processOpp2Id, cols1);

// Set the next stage as the active stage
retrievedProcessInstance["activestageid"] = new EntityReference(ProcessStage.EntityLogicalName, _activeStageId);
_serviceProxy.Update(retrievedProcessInstance);

完全なサンプルについては、「サンプル: 業務プロセスフローの使用」を参照してください。

エンティティレコードの作成時に業務プロセスフロー内を適用する

このセクションでは、Customer Engagement で作成された新しいエンティティレコードに業務プロセスフローを自動的に適用するための既定の動作、およびそれを上書きして新しいエンティティレコードに自分で選択した業務プロセスフローを適用する方法について説明します。

既定では、複数の業務プロセスフローが定義されているエンティティの場合、システムは次のマルチステップロジックを使用して新しいエンティティレコードに業務プロセスフローを適用します。

業務プロセスフロー定義レコードの Workflow.PrimaryEntity 属性に基づいて、新しいエンティティレコードに適用可能なすべての業務プロセスフローを識別します。
現在のユーザーがアクセスできる業務プロセスフロー定義を識別します。業務プロセスフローへのアクセスがどのように決定され管理されるかについては、このトピックで前述した「業務プロセスフローのセキュリティを管理する」を参照してください。
システム内のすべての業務プロセスフローには、エンティティごとにグローバル順序が適用されます。業務プロセスフローの順序は、Workflow.ProcessOrder 属性に格納されています。エンティティの業務プロセスフローの定義は、この順序に基づいて並べ替えられ、順序の値が最も低いものが選択されます。
最後に、エンティティレコードがビジネスアプリ (アプリモジュール) から作成された場合、新しいエンティティレコードに自動的に適用される業務プロセスフローを選択するために、フィルタリングの追加のレベルが適用されます。アプリで操作する場合、ユーザーはビジネスアプリに割り当てられたセキュリティロールゆえにアクセスできる該当するエンティティ、業務プロセスフロー、ビュー、およびフォームにしかアクセスできません。
- ビジネスアプリに業務プロセスフローが含まれない場合、手順 3 まで説明されたとおりに業務プロセスフローが適用されます。
- ビジネスアプリに 1 つ以上の業務プロセスフローがある場合、アプリにある業務プロセスフローのみが適用されます。この場合、ユーザーがビジネスアプリのコンテキスト内で作業しているなら、手順 3 の業務プロセスフローのリストはアプリモジュール内にあるビジネスアプリの一部であるものにフィルタリングされ、プロセス順序に基づいて並べ替えられます。
- エンティティのビジネスアプリに業務プロセスフローがない場合、またはユーザーがアクセスできるものに業務プロセスフローがない場合、新しいエンティティレコードに業務プロセスフローは適用されません。

新しいエンティティレコードに自動的に適用される業務プロセスフローの既定の動作は上書きできます。上書きするには、新規エンティティレコードを作成する際にエンティティの ProcessId 属性を次のいずれかの値に設定します。

新しいエンティティレコードの業務プロセスフローの設定をスキップするには、Guid.Empty に設定します。これは、エンティティレコードを一括作成するものの業務プロセスフローを適用しない場合に行えます。
特定の業務プロセスフローのエンティティに設定します (エンティティ参照として)。この場合、システムは既定ロジックの代わりに、選択した特定の業務プロセスフローを適用します。

新しいエンティティレコードの作成時に ProcessId 属性の値を設定しない場合、システムは前述したように既定のロジックを適用します。

注意

新しいエンティティレコードに自動的に適用される業務プロセスフローの既定の動作を上書きすることは、プログラムでのみサポートされています。 UI を使用して行うことはできません。

業務プロセスフローのクライアント側でのプログラムのサポート

Dynamics 365には、フォームスクリプトの業務プロセスフローとの対話に使用できるクライアント側のオブジェクトがあります。業務プロセスフローは、プロセスがレコードに適用されたり、ステージが変更されたり、状態が Active、Finished、または Aborted に変更されたりするたびにクライアント側のイベントをトリガします。詳細:業務プロセスフローのスクリプトを作成する

プロセス、ステージおよび手順の最大数

エンティティごとの、アクティブ化された業務プロセスフローの最大数の既定値は 10 です。Organization.MaximumActiveBusinessProcessFlowsAllowedPerEntity 属性を使用して別の値を指定できます。ただし、値が 10 より大きい場合、プロセスを切り替えるとき、または業務プロセスフローが割り当てられているレコードを開くときのシステムパフォーマンスが低下することがあります。このことは、プロセスが複数のエンティティにまたがっている場合に特に顕著です。

次の設定はカスタマイズできません。

プロセス内のエンティティ当たりの最大数が 30 です。
各ステージのステップの最大数は 30 です。
プロセスフローに参加できるエンティティの最大数は 5 です。

業務プロセスフローのモデル化

このトピックの内容

業務プロセスフローのサーバー側でのプログラムのサポート

業務プロセスフローの定義

業務プロセスフローのアクティブ化

業務プロセスフローのセキュリティを管理する

業務プロセスフローインスタンスの管理

エンティティレコードの作成時に業務プロセスフロー内を適用する

業務プロセスフローのクライアント側でのプログラムのサポート

プロセス、ステージおよび手順の最大数

関連項目

その他のリソース

業務プロセス フローのモデル化

このトピックの内容

業務プロセス フローのサーバー側でのプログラムのサポート

業務プロセス フローの定義

業務プロセス フローのアクティブ化

業務プロセス フローのセキュリティを管理する

業務プロセス フロー インスタンスの管理

エンティティ レコードの作成時に業務プロセス フロー内を適用する

業務プロセス フローのクライアント側でのプログラムのサポート

プロセス、ステージおよび手順の最大数

関連項目

その他のリソース

業務プロセスフローのモデル化

業務プロセスフローのサーバー側でのプログラムのサポート

業務プロセスフローの定義

業務プロセスフローのアクティブ化

業務プロセスフローのセキュリティを管理する

業務プロセスフローインスタンスの管理

エンティティレコードの作成時に業務プロセスフロー内を適用する

業務プロセスフローのクライアント側でのプログラムのサポート