案件退避処理
案件退避処理は、ワークフローの案件を退避（アーカイブ）した際に実行される業務ロジックです。
通常、ジョブネット「IM-Workflow > アーカイブ」を実施した際に実行されます。
利用例
- 案件退避時に添付ファイルをストレージや外部連携サービスに格納する
- 案件退避時に案件の参照権限を付与する
注記
案件を退避すると、製品標準の処理で参照権限が変更されます。
案件退避後の参照権限を標準から変更したい場合は、案件退避処理の業務ロジックで参照権限を付与してください。
製品標準で変更される参照権限の詳細は以下を参照してください。
業務ロジックの概要
案件退避処理の業務ロジックを新規作成すると、初期状態では以下の図のように設定されています。
タスクを追加し、実現したい業務ロジックを作成してください。
案件退避処理の業務ロジックには、「業務データ取得」タスクが初期配置されています。
当該タスクで、ワークフローのフォームへの入力情報を取得します。
業務ロジック内でフォームの入力情報を使用したい場合は、「業務データ取得」タスクの返却値を利用してください。
注意
案件退避処理は、ワークフローのデータベーストランザクション内で実行されます。
そのため、業務ロジックの中で独自にデータベーストランザクション制御を行うことはできません。
JavaScriptユーザ定義タスクで、データベーストランザクション制御を伴う処理は実施しないでください。
入力値
| 入力値 | 型 | 説明 |
|---|---|---|
| imwMatterArchiveProcess | object | 案件退避処理情報 |
imwMatterArchiveProcessオブジェクト
| 入力値 | 型 | 説明 |
|---|---|---|
| tenantId | string | テナントID |
| localeId | string | 処理実行時のロケールID
|
| systemMatterId | string | システム案件ID |
| userDataId | string | ユーザデータID |
出力値
| 出力値 | 型 | 説明 |
|---|---|---|
| error | boolean | エラーフラグtrue を指定した場合、当処理をエラー終了します。処理が正常に終了した場合は false を設定してください。 |
| message | string | 指定したメッセージを例外ログとして出力します。 ロケールごとにメッセージを用意する必要がなければこのプロパティを利用してください。 |
| localizedMessages | object | 指定したメッセージを例外ログとして出力します。 案件退避処理のコンテキストから解決されたロケールに一致するメッセージを使用します。 message が指定されている場合はこのプロパティは使用されません。 |
localizedMessagesオブジェクト
| 出力値 | 型 | 説明 |
|---|---|---|
| ja | string | 日本語ロケールメッセージ |
| en | string | 英語ロケールメッセージ |
| zh_CN | string | 中国語ロケールメッセージ |
定数
| 定数ID | 説明 |
|---|---|
| FALSE | 出力値 error へのマッピングに利用する定数です。 |
| imfrApplicationId | アプリケーションID 「ファイルアップロード情報取得」タスクの入力値等に使用します。 |
| imwFlowId | フローID |
ユーザ定義タスク
案件退避処理作成時に初期配置される「業務データ取得」タスクに関する情報です。
注記
「業務データ取得」タスクは「Forma登録情報定義」という種類のユーザ定義です。
「ノーコード開発業務ロジック」というユーザカテゴリに業務ロジック名と同じユーザ定義名で登録されます。
入力値
| 入力値 | 型 | 説明 |
|---|---|---|
| insertId | string | データ登録ID 業務ロジック入力値の userDataId を設定してください。 |
出力値
| 入力値 | 型 | 説明 |
|---|---|---|
| formaItemInfo | object | 画面アイテム入力情報 フォームの各画面アイテムの入力情報を保持するオブジェクトです。 配下のパラメータ名は画面アイテムのフィールド識別IDです。 複数項目選択可能な画面アイテム（「チェックボックス」、「リストボックス」）は選択された値をカンマ区切りにして値が設定されます。 |
| formaTableItemInfo | object | テーブル系画面アイテム入力項目 配下にテーブル識別IDをパラメータ名とするオブジェクトの配列を保持します。 |
| formaSystemInfo | object | システム情報 |
formaSystemInfoオブジェクト
| 出力値 | 型 | 説明 |
|---|---|---|
| imfr_sd_insert_id | string | データ登録ID |
| imfr_sd_application_id | string | アプリケーションID |
| imfr_sd_application_no | long | アプリケーション履歴番号 |
| imfr_sd_version_no | long | バージョン |
| imfr_sd_create_date | date | 登録日時 |
| imfr_sd_create_user_cd | string | 登録者ユーザコード |
| imfr_sd_record_date | date | 更新日時 |
| imfr_sd_record_user_cd | string | 更新者ユーザコード |
| imfr_sd_preserve_flag | string | 一時保存フラグ
|