formContext.data.process (クライアント API 参照)
イベント、メソッド、およびオブジェクトを提供して、フォーム上のビジネス プロセス フローのデータを操作します。 フォーム上の業務プロセス フロー コントロールとやり取りする方法については、formContext.ui.process (クライアント API 参照) を参照してください。
プロセス イベントとイベント ハンドラー メソッド
以下のイベントとイベント ハンドラー メソッドを使用して、業務プロセス フロー用のスクリプトを記述します。
アクティブ プロセス メソッド
このメソッドを使用して、アクティブなプロセスに関する情報を取得し、 異なるプロセスをアクティブ プロセスとして設定します。
| Name | 内容 |
|---|---|
| getActiveProcess | アクティブなプロセスを表すプロセス オブジェクトを返します。 |
| setActiveProcess | アクティブなプロセスとしてプロセスを設定します。 |
プロセス メソッド
プロセスには、業務プロセス フローのデータが含まれます。 これらのメソッドを使用して、プロセスのプロパティにアクセスします。
| Name | 内容 |
|---|---|
| getId | プロセスの一意識別子を返します。 |
| getName | プロセスの名前を返します。 |
| getStages | プロセスのステージのコレクションを返します。 |
| isRendered | プロセスが表示されるかどうかを示すブール値を返します。 |
ProcessInstance メソッド
これらのメソッドを使用して、レコードのすべてのプロセス インスタンスに関する情報を取得し、プロセス インスタンスをアクティブなインスタンスとして設定します。
| Name | 内容 |
|---|---|
| getProcessInstances | 呼び出したユーザーがアクセス権を持つテーブル レコードのすべてのプロセスのインスタンスを返します。 |
| setActiveProcessInstance | アクティブなインスタンスとしてプロセス インスタンスを設定します。 |
インスタンス メソッド
プロセス インスタンスには業務プロセス フローのインスタンスのデータが含まれます。 これらのメソッドを使用して、プロセス インスタンスのプロパティにアクセスします。
| Name | 内容 |
|---|---|
| getInstanceId | プロセス インスタンスの一意識別子を返します。 |
| getInstanceName | プロセス インスタンスの名前を返します。 |
| getStatus | プロセス インスタンスの現在の状態を返します。 |
| setStatus | アクティブなプロセス インスタンスの現在の状態を設定します。 |
アクティブ ステージ メソッド
これらのメソッドを使用して、アクティブ ステージに関する情報を取得し、 異なるステージをアクティブ ステージとして設定します。
| Name | 内容 |
|---|---|
| getActiveStage | アクティブなステージを表すステージ オブジェクトを返します。 |
| setActiveStage | 完了したステージをアクティブ ステージとして設定します。 |
ステージ メソッド
ステージには、業務プロセス フローのステージのデータが含まれます。 これらのメソッドを使用して、ステージのプロパティにアクセスします。
| Name | 内容 |
|---|---|
| getCategory | 業務プロセス フロー カテゴリの整数値を返す getValue メソッドを持つオブジェクトを返します。 |
| getEntityName | フォームに関連付けられたテーブルの論理名を返します。 |
| getId | ステージの一意識別子を返します。 |
| getName | ステージの名前を返します。 |
| getNavigationBehavior | テーブル間のビジネス プロセス フロー ナビゲーションのシナリオにおいて、ユーザーが他のテーブルのレコードを作成する際に 作成 ボタンを使用できるかどうかの定義に使用できる、ステージのナビゲーション動作オブジェクトを返します。 |
| getStatus | ステージの状態を返します。 |
| getSteps | ステージのステップのコレクションを返します。 |
ステップ メソッド
ステップには、業務プロセス フローのステージに含まれるステップのデータが含まれます。 これらのメソッドを使用して、ステップのプロパティにアクセスします。
| Name | 内容 |
|---|---|
| getAttribute | ステップに関連付けられている列の論理名を返します。 |
| getName | ステップの名前を返します。 |
| getProgress | アクション ステップの進行状況を返します。 |
| isRequired | 業務プロセス フローでそのステップが必須かどうかを示すブール値を返します。 |
| setProgress | アクション ステップの進行状況を更新します。 |
ナビゲーション メソッド
これらのメソッドを使用して、次のステージや前のステージに移動します。 これらの両方のメソッドは、OnStageChange イベントが発生します。
| Name | 内容 |
|---|---|
| moveNext | 次のステージに進みます。 |
| movePrevious | 前のステージに移動します。 |
他の有用なメソッド
これらのメソッドを使用して、アクティブなパスにあるステージ、有効化されたプロセス、選択したステージに関する情報を見つけます。
| Name | 内容 |
|---|---|
| getActivePath | 業務プロセス フローのコントロールに表示されるステージを操作するメソッドで、現在アクティブ パスにあるステージのコレクションを取得します。 |
| getEnabledProcesses | 現在のユーザーが切り替え可能なテーブルに有効なビジネス プロセス フローを非同期的に取得します。 |
| getSelectedStage | 現在選択されているステージを取得します。 |
関連記事
formContext.ui.process (クライアント API 参照)
Xrm オブジェクト モデルの理解
コントロール (クライアント API 参照)
注意
ドキュメントの言語設定についてお聞かせください。 簡単な調査を行います。 (この調査は英語です)
この調査には約 7 分かかります。 個人データは収集されません (プライバシー ステートメント)。