案件開始処理

案件開始処理は、ワークフローの案件が開始する際に実行される業務ロジックです。
以下のタイミングで実行されます。

• 申請者が「申請」を行ったとき
• 業務ロジック等を使用して案件の「起票」を行ったとき

利用例

• 案件開始時に定型文をメールで送信するワークフローを作成する

業務ロジックの概要

案件開始処理の業務ロジックを新規作成すると、初期状態では以下の図のように設定されています。
タスクを追加し、実現したい業務ロジックを作成してください。

注意

案件開始処理は、ワークフローのデータベーストランザクション内で実行されます。
そのため、業務ロジックの中で独自にデータベーストランザクション制御を行うことはできません。
JavaScriptユーザ定義タスクで、データベーストランザクション制御を伴う処理は実施しないでください。

入力値

入力値	型	説明
imwProcessCommon	object	ワークフローに関するパラメータを保持します。

imwProcessCommonオブジェクト

入力値	型	説明
localeId	string	処理実行時のロケールID ja：日本語 en：英語 zh_CN：中国語（簡体字）
tenantId	string	テナントID
applyBaseDate	string	申請基準日（ yyyy/MM/dd 形式）
parameter	string	当業務ロジックのロジックフロー情報を表すパラメータ
targetLocales	string[]	システムで利用しているロケールID
contentsId	string	コンテンツID
contentsVersionId	string	コンテンツバージョンID
routeId	string	ルートID
routeVersionId	string	ルートバージョンID
flowId	string	フローID
flowVersionId	string	フローバージョンID
processDate	string	処理日（ yyyy/MM/dd 形式）
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