intra-mart Accel Platform IM-Workflow プログラミングガイド 第20版 2018-04-01

5.1. 案件開始処理


案件開始処理とは、案件が開始する時に、一度実行される処理です。下記の場合に実行されます。
  • 申請者が”申請”を行った場合
  • “起票”の案件を作成した場合(APIのみ)
案件開始処理は、 IM-Workflow モジュールのトランザクション内で実行されるため、このプログラム中ではDBトランザクション制御を行うことはできません。

5.1.1. パラメータ

案件開始処理では、以下の情報をパラメータとして受け取る事ができます。
No パラメータ(物理名) パラメータ(論理名) 属性 詳細
1 loginGroupId ログイングループID 文字列
処理実行時のログイングループID
ログイングループIDは、テナントIDと同値です。
2 localeId ロケールID 文字列 処理実行時のロケールID
3 targetLocales ターゲットロケールID 文字列[] システムで利用しているロケールID
4 contentsId コンテンツID 文字列 該当案件のコンテンツID
5 contentsVersionId コンテンツバージョンID 文字列 該当案件のコンテンツバージョンID
6 routeId ルートID 文字列 該当案件のルートID
7 routeVersionId ルートバージョンID 文字列 該当案件のルートバージョンID
8 flowId フローID 文字列 該当案件のフローID
9 flowVersionId フローバージョンID 文字列 該当案件のフローバージョンID
10 applyBaseDate 申請基準日 文字列 申請基準日(”yyyy/MM/dd”)
11 processDate 処理日 文字列 処理日(”yyyy/MM/dd”)
12 systemMatterId システム案件ID 文字列 該当案件のシステム案件ID
13 userDataId ユーザデータID 文字列 該当案件のユーザデータID
14 parameter 実行プログラムパス 文字列 該当処理の実行プログラムパス

5.1.2. 返却値

案件開始処理では、以下の情報を返却します。(任意/必須・・・●:必須 △:任意)
  • スクリプト開発モデル

    No 返却値(物理名) 返却値(論理名) 属性 必須/任意 詳細
    1 resultFlag 結果フラグ 真偽値   △
    true:成功 false:失敗
    指定しない場合、成功(true)として扱います。
    2 message 結果メッセージ 文字列   △ 結果フラグが失敗の場合のみ、設定します。
    ※ 結果メッセージを設定した場合、画面にエラーメッセージを表示します。

    コラム

    結果フラグとして”false”(失敗)を設定した場合の動作は以下の通りです。

    • 該当の案件開始処理以外に設定されている後続の案件開始処理は実行されません。
  • JavaEE開発モデル

    返却値はありません。
    ※ 「jp.co.intra_mart.foundation.workflow.exception.WorkflowExternalException」をスローした場合、引数に設定したエラーメッセージを画面に表示します。詳細は「 APIドキュメント 」を参照してください。

    コラム

    WorkflowExternalException をスローした場合の動作は以下の通りです。

    • 該当の案件開始処理以外に設定されている後続の案件開始処理は実行されません。