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

5.3. アクション処理


アクション処理とは、下記のような行為を行った場合に実行される処理です。
No アクション メソッド
1 申請 apply
2 再申請 reapply
3 申請(一時保存) applyFromTempSave
4 申請(未処理) applyFromUnapply
5 取止め discontinue
6 引戻し pullBack
7 差戻し後引戻し sendBackToPullBack
8 承認 approve
9 承認終了 approveEnd
10 否認 deny
11 差戻し sendBack
12 保留 reserve
13 保留解除 reserveCancel
14 案件操作 matterHandle
15 一時保存(新規登録) tempSaveCreate
16 一時保存(更新) tempSaveUpdate
17 一時保存(削除) tempSaveDelete
アクション処理は、IM-Workflow モジュールのトランザクション内で実行されるため、このプログラム中ではDBトランザクション制御を行うことはできません。

5.3.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 matterName 案件名 文字列 該当案件の案件名
15 matterNumber 案件番号 文字列 該当案件の案件番号
16 priorityLevel 優先度 文字列 該当処理の優先度 ※1
17 parameter 実行プログラムパス 文字列 該当処理の実行プログラムパス
18 actFlag 代理フラグ 文字列 ”0”:本人にて処理 ”1”:代理者にて処理
19 nodeId ノードID 文字列 該当処理のノードID
20 nextNodeIds 移動先(次ノード)ノードID 文字列[]
以下処理種別の場合に、移動先ノードIDが設定されます。
 差戻し/引戻し/案件操作
21 authUserCd 処理権限者コード 文字列 処理権限者コード
22 execUserCd 処理実行者コード 文字列 処理実行者コード
23 resultStatus 処理結果ステータス 文字列 該当処理の処理結果ステータス [1]
24 authCompanyCode 権限会社コード 文字列
以下処理種別の場合、権限会社コードが設定されます。
 申請/再申請/申請(一時保存)/申請(未処理)
 取止め/承認/承認終了/否認/差戻し
25 authOrgzSetCode 権限組織セットコード 文字列
以下処理種別の場合、権限組織セットコードが設定されます。
 申請/再申請/申請(一時保存)/申請(未処理)
 取止め/承認/承認終了/否認/差戻し
26 authOrgzCode 権限組織コード 文字列
以下処理種別の場合、権限組織コードが設定されます。
 申請/再申請/申請(一時保存)/申請(未処理)
 取止め/承認/承認終了/否認/差戻し
27 processComment 処理コメント 文字列 該当処理の処理コメント
28 lumpProcessFlag 一括処理フラグ 文字列 ”0”:通常承認 ”1”:一括承認
29 autoProcessFlag 自動処理フラグ 文字列 ”0”:手動処理 ”1”:自動処理(到達処理での自動承認や、バッチでの自動処理)
[1]・・・コード値は、「 APIドキュメントのIM-Workflow CodeList 」を参照してください。

コラム

アクション処理でユーザパラメータを利用し、以下の処理を行った場合には、ユーザパラメータには「空」または「Null」が連携されます。

  • ユーザパラメータに「Null」が連携される処理

    • 引戻し
    • 差戻し後引戻し
    • 承認(「自動処理」を利用する場合)
    • 否認(「自動処理」を利用する場合)
    • 差戻し(「自動処理」を利用する場合)
    • 案件操作
    • 一時保存(削除)
  • ユーザパラメータに「空」が連携される処理

    スクリプト開発モデルでは「空のオブジェクト」、JavaEE開発モデルでは「空のMap」を返却します。

    • 承認(「一括処理」を利用する場合)

「承認」等のアクション処理でユーザパラメータを利用する場合には、「lumpProcessFlag(一括処理フラグ)」・「autoProcessFlag(自動処理フラグ)」や、「matterHandle(案件操作)」メソッドを条件分岐に活用するなどの方法を検討してください。

5.3.2. 返却値

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

    No 返却値(物理名) 返却値(論理名) 属性 必須/任意 詳細
    1 resultFlag 結果フラグ 真偽値   △
    true:成功 false:失敗
    指定しない場合、成功(true)として扱います。
    2 message 結果メッセージ 文字列   △ 結果フラグが失敗の場合のみ、設定します。
    3 data 案件番号
    文字列
    (最大20バイト)
      △ 申請/再申請/申請(一時保存)/申請(未処理)の場合のみ、null以外の場合に案件番号を上書きします。
    ※ 結果メッセージを設定した場合、画面にエラーメッセージを表示します。

    コラム

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

    • 該当のアクション処理以外に設定されている後続のアクション処理は実行されません。
  • JavaEE開発モデル

    No 返却値(論理名) 属性 必須/任意 詳細
    1 案件番号
    文字列
    (最大20バイト)
      △ 申請/再申請/申請(一時保存)/申請(未処理)の場合のみ、null以外の場合に案件番号を上書きします。
    ※ 「jp.co.intra_mart.foundation.workflow.exception.WorkflowExternalException」をスローした場合、引数に設定したエラーメッセージを画面に表示します。詳細は「 APIドキュメント 」を参照してください。

    コラム

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

    • 該当のアクション処理以外に設定されている後続のアクション処理は実行されません。