プロセス管理でアクションを実行するときのイベント
プロセス管理でアクションを実行するときのイベント
プロセス管理機能を有効にしたアプリで、アクションを実行したときに発生するイベントです。
ステータスの変更に複数の作業者によるアクションの実行を必要とする場合など、アクションの実行によってレコードのステータスが変わらないときでも、このイベントが発生します。
イベントタイプ | イベントが発生するタイミング | |
---|---|---|
PC | app.record.detail.process.proceed | プロセス管理でアクションを実行する前 |
モバイル | mobile.app.record.detail.process.proceed | プロセス管理でアクションを実行する前 |
イベントオブジェクトのプロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
type | 文字列 | イベントタイプ 次の値が返ります。
|
record | オブジェクト | アクションを実行したときのレコードのデータ 詳細は次のページを参照してください。 フィールド形式 |
action | オブジェクト | 実行したアクション// オブジェクトのキー |
nextStatus | オブジェクト | 変更後のステータス// オブジェクトのキー |
status | オブジェクト | 変更したステータス// オブジェクトのキー |
アクションの実行をキャンセルする
イベントハンドラー内で次のいずれかを行うと、アクションの実行をキャンセルできます。
- 画面上部にエラーを表示する
false
をreturnする。- 不正な値をreturnする。
イベントオブジェクトで実行できる操作
-
フィールドの値を書き換える
レコードまたはフィールドの編集権限が必要です。 - 画面上部にエラーを表示する
- Promise対応
補足
イベントハンドラー内で何もreturnしない場合、ステータスのみが更新されます。