setActiveProcess (クライアント API 参照)
アクティブなプロセスとしてプロセスを設定します。
アクティブとして設定されているビジネス プロセスにすでにインスタンスがある場合、インスタンスはアクティブとしてマークされ、プライマリ レコード フォームが再度読み込まれて表示されます。 プロセスにインスタンスが存在しない場合は、新しいインスタンスが作成され、アクティブとしてマークされ、プライマリ レコード フォームが再度読み込まれて表示されます。
プロセスのインスタンスが複数存在する場合、アクティブとしてマークされる既定のロジックに従って、そのうちの 1 つが選択されます。 通常、これは現在のユーザーが最近使用したプロセス インスタンスです。
注意
- レコードの作成または編集中に
setActiveProcess
メソッドを使用する必要があります。setActiveProcess
メソッドを使用して、Xrm.Navigation.openForm
メソッドでのprocessId
とprocessInstanceId
の代わりにビジネス プロセス フローのアクティブなプロセスを設定します。 setActiveProcess
メソッドはフォームを再度読み込み、保存されていないデータはすべて失われます。
構文
formContext.data.process.setActiveProcess(processId, callbackFunction);
パラメーター
件名 | タイプ | Required | Description |
---|---|---|---|
processId |
String | はい | アクティブなプロセスとして設定するプロセスの ID。 |
callbackFunction |
Function | いいえ | 操作が完了したときに呼び出す関数。 このコールバック関数に、操作が成功したかどうかを示すために次のいずれかの文字列値が渡されます。 - success : 操作が成功しました。- invalid : processId が有効でないか、またはプロセスが有効な状態になっていません。 |
関連記事
getActiveProcess
setActiveProcessInstance
formContext.data.process
注意
ドキュメントの言語設定についてお聞かせください。 簡単な調査を行います。 (この調査は英語です)
この調査には約 7 分かかります。 個人データは収集されません (プライバシー ステートメント)。