intra-mart Accel Platform IM-Workflow 管理者操作ガイド 第31版 2023-10-01

アクション処理

入力設定

IM-LogicDesigner の「フロー定義編集」画面で、アクション処理に対応した入力設定を定義することで、案件のパラメータを受け取ることができます。

入力値 説明
imwProcessCommon<object> 処理系共通情報
- localeId<string> ロケールID
- tenantId<string> テナントID
- applyBaseDate<string> 申請基準日
- 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
imwActionProcess<object> アクション処理情報
- actFlag<string> 代理フラグ(0:本人処理 / 1:代理処理)
- authCompanyCode<string> 権限会社コード
- authOrgzSetCode<string> 権限組織セットコード
- authOrgzCode<string> 権限組織コード
- authUserCd<string> 処理権限者コード
- execUserCd<string> 処理実行者コード
- matterName<string> 案件名
- matterNumber<string> 案件番号
- nodeId<string> ノードID
- nextNodeIds<string[]> 移動先(次ノード)ノードID
- priorityLevel<string> 優先度
- processComment<string> 処理コメント
- resultStatus<string> 処理結果ステータス
- lumpProcessFlag<string> 一括処理フラグ(0:通常承認 / 1:一括承認)
- autoProcessFlag<string> 自動処理フラグ(0:手動処理 / 1:自動処理)
- DCNodeConfigModels<object[]> 動的・確認ノード設定情報オブジェクト
nodeId<string> ノードID
processTargetConfigs<object[]> 処理対象設定
—— extensionPointId<string> 拡張ポイントID
—— parameter<string> パラメータ
—— pluginId<string> プラグインID
- HVNodeConfigModels<object[]> 横配置・縦配置ノード設定情報
nodeId<string> ノードID
matterNodeExpansions<object[]> 案件ノード展開情報
—— nodeName<string> ノード名
—— pluginModels<object[]> プラグイン情報
——— extensionPointId<string> 拡張ポイントID
——— pluginId<string> プラグインID
——— parameter<string> パラメータ
- branchSelectModels<object[]> 分岐先選択情報
branchStartNodeId<string> 分岐開始ノードID
forwardNodeIds<string[]> 分岐先ノードID
imwUserParameter<Map> / imwUserParameter<object> ユーザパラメータ

コラム

申請、承認等、どのような処理で実行されたかを判断するには「処理結果ステータス」を利用してください。
コード値は「 APIドキュメントのIM-Workflow CodeList 」 を参照してください。

コラム

入力設定は任意です。案件のパラメータが必要ない場合は定義する必要はありません。
また、必要な項目のみを定義することも可能です。ただし、オブジェクトの構造は変更しないでください。

コラム

以下のJSON文字列を利用することで、入出力設定のJSON入力機能で取り込むことができます。
imwUserParameterをMap型で利用する場合は、imwUserParameterにnull値の型を指定してください。
{
    "imwProcessCommon":
    {
        "localeId": "",
        "tenantId": "",
        "applyBaseDate": "",
        "parameter": "",
        "targetLocales": [""],
        "contentsId": "",
        "contentsVersionId": "",
        "routeId": "",
        "routeVersionId": "",
        "flowId": "",
        "flowVersionId": "",
        "processDate": "",
        "systemMatterId": "",
        "userDataId": ""
    },
    "imwActionProcess":
    {
        "actFlag": "",
        "authCompanyCode": "",
        "authOrgzCode": "",
        "authOrgzSetCode": "",
        "authUserCd": "",
        "execUserCd": "",
        "matterName": "",
        "matterNumber": "",
        "nodeId": "",
        "nextNodeIds": [""],
        "priorityLevel": "",
        "processComment": "",
        "resultStatus": "",
        "lumpProcessFlag": "",
        "autoProcessFlag": "",
        "DCNodeConfigModels": [
            {
                "nodeId": "",
                "processTargetConfigs": [
                    {
                      "extensionPointId": "",
                      "parameter": "",
                      "pluginId": ""
                    }
                ]
            }
        ],
        "HVNodeConfigModels": [
            {
                "nodeId": "",
                "matterNodeExpansions": [
                    {
                        "nodeName": "",
                        "pluginModels": [
                            {
                                "extensionPointId": "",
                                "pluginId": "",
                                "parameter": ""
                            }
                        ]
                    }
                ]
            }
        ],
        "branchSelectModels": [
            {
                "branchStartNodeId": "",
                "forwardNodeIds": [
                    ""
                ]
            }
        ]
    },
    "imwUserParameter": null
}

コラム

imwUserParameterをObject型で利用する場合は、imwUserParameterの配下にリクエストパラメータで設定した変数を定義することで利用できます。
{
    "imwProcessCommon":
    {
        "localeId": "",
        "tenantId": "",
        "applyBaseDate": "",
        "parameter": "",
        "targetLocales": [""],
        "contentsId": "",
        "contentsVersionId": "",
        "routeId": "",
        "routeVersionId": "",
        "flowId": "",
        "flowVersionId": "",
        "processDate": "",
        "systemMatterId": "",
        "userDataId": ""
    },
    "imwActionProcess":
    {
        "actFlag": "",
        "authCompanyCode": "",
        "authOrgzCode": "",
        "authOrgzSetCode": "",
        "authUserCd": "",
        "execUserCd": "",
        "matterName": "",
        "matterNumber": "",
        "nodeId": "",
        "nextNodeIds": [""],
        "priorityLevel": "",
        "processComment": "",
        "resultStatus": "",
        "lumpProcessFlag": "",
        "autoProcessFlag": "",
        "DCNodeConfigModels": [
            {
                "nodeId": "",
                "processTargetConfigs": [
                    {
                      "extensionPointId": "",
                      "parameter": "",
                      "pluginId": ""
                    }
                ]
            }
        ],
        "HVNodeConfigModels": [
            {
                "nodeId": "",
                "matterNodeExpansions": [
                    {
                        "nodeName": "",
                        "pluginModels": [
                            {
                                "extensionPointId": "",
                                "pluginId": "",
                                "parameter": ""
                            }
                        ]
                    }
                ]
            }
        ],
        "branchSelectModels": [
            {
                "branchStartNodeId": "",
                "forwardNodeIds": [
                    ""
                ]
            }
        ]
    },
    "imwUserParameter":
    {
      "imwUserDataId": "xxxx",
      "imwSystemMatterId": "xxxx"
    }
}

コラム

パラメータ「DCNodeConfigModels」「HVNodeConfigModels」「branchSelectModels」は 2023 Autumn(Hollyhock) で追加されました。

入力値の連携方法

imwUserParameterの仕様を「 2023 Spring(Gerbera) 」 から変更しました。詳細は「 IM-Workflow 仕様書 」-「 テナント単位の設定 」-「 アクション処理ロジックフロー連携のマッピング方法 」 を確認してください。

出力設定

IM-LogicDesigner の「フロー定義編集」画面で、アクション処理に対応した出力設定を定義することで、後続処理の制御およびエラーメッセージを画面に表示できます。

出力値 必須/任意 説明
error<boolean> 必須
エラーフラグ
true を指定した場合、当処理をエラー終了します。
message<string> 任意
指定したメッセージをエラーメッセージとして画面に表示します。
ロケールごとにメッセージを用意する必要がなければこのプロパティを利用してください。
localizedMessages<object> 任意
指定したメッセージをエラーメッセージとして画面に表示します。
アクション処理のコンテキストから解決されたロケールに一致するメッセージを使用します。
message が指定されている場合はこのプロパティは使用されません。
- ja<string> 任意 日本語ロケールメッセージ
- en<string> 任意 英語ロケールメッセージ
- zh_CN<string> 任意 中国語ロケールメッセージ
matterNumber<string> 任意
案件番号を指定します。
未指定の場合は案件番号指定なしとして動作します。

コラム

以下のJSON文字列を利用することで、入出力設定のJSON入力機能で取り込むことができます。

{
    "error": false,
    "message": "",
    "localizedMessages":
    {
        "ja": "",
        "en": "",
        "zh_CN": ""
    },
    "matterNumber": ""
}

注意事項

注意

アクション処理は、 IM-Workflow モジュールのDBトランザクション内で実行されるため、ロジックフロー中ではDBトランザクション制御を行うことはできません。
JavaScriptユーザ定義タスクで、DBトランザクション制御を伴う処理は実施しないでください。