intra-mart Accel Platform IM-Workflow 仕様書 第30版 2021-04-01

1.3. 申請モーダルを表示する

申請モーダルを表示して、ワークフローを申請するアクションです。 申請画面にて、申請を実施します。

コラム

「アクションエディタ」にて、当アクションの後続アクションを設定した場合、後続アクションは次の契機で実行開始します。
  • 処理を実行し、モーダル画面が閉じた
  • 処理を実行せずに、×ボタン押下でモーダル画面を閉じた

1.3.1. 入力値

項目名 必須/任意 型(最大バイト数) 説明
フローID 任意 文字列
「申請一覧」「案件一覧(一時保存)」画面から遷移した場合は、一覧で選択したフローIDが設定されるため不要
「申請一覧」「案件一覧(一時保存)」画面以外から遷移した場合は、必須
案件名 任意 文字列(200)
案件名に初期値を設定したい場合に指定
申請基準日 任意 日付/文字列
未指定の場合、「申請一覧」「案件一覧(一時保存)」画面から遷移した場合は、一覧で選択した申請基準日が設定される
「申請一覧」「案件一覧(一時保存)」画面以外から遷移した場合は、アカウントコンテキストのタイムゾーンにおける現在日付で申請
"yyyy/MM/dd"形式の文字列指定も可能
申請権限者コード 任意 文字列
申請権限者に初期値を設定したい場合に指定
ユーザデータID 任意 文字列(20)
未指定の場合、申請処理時に採番されるシステム案件IDと同じ値で申請
一時保存状態から申請する場合、一時保存情報のユーザデータIDを指定
権限者所属組織情報 任意 下記参照
担当組織に初期値を設定したい場合に指定
優先度 任意 文字列
優先度に初期値を設定したい場合に指定
設定値は「 CodeList 」を参照
処理コメント 任意 文字列(2000)
処理コメントに初期値を設定したい場合に指定
分岐先選択情報 任意 下記参照
ルート選択に初期値を設定したい場合に指定
動的承認ノード設定情報 任意 下記参照
動的処理対象者設定機能 」を利用する場合に指定
確認ノード設定情報 任意 下記参照
動的処理対象者設定機能 」を利用する場合に指定
横配置ノード設定情報 任意 下記参照
動的処理対象者設定機能 」を利用する場合に指定
縦配置ノード設定情報 任意 下記参照
動的処理対象者設定機能 」を利用する場合に指定
インタフェース制御 任意 下記参照
モーダル画面のインタフェースを変更したい場合に指定
オプションパラメータ 任意 下記参照
IM-Workflow のuserParameterとして受け取る値を設定
または、 IM-FormaDesigner / IM-BIS のformaParamとして受け取る値を設定
前回情報破棄フラグ 任意 boolean
trueの場合、×ボタン押下でモーダル画面を閉じた後に再表示する際、前回設定したパラメータや入力情報を破棄して再表示する
falseの場合、×ボタン押下でモーダル画面を閉じた後に再表示する際、前回閉じた際の状態を復元する
未指定の場合、falseで動作
案件処理後の自動画面遷移 任意 boolean
trueの場合、案件処理後に「申請一覧」「案件一覧」画面や、各種ワークフローポートレットから渡された「imwCallOriginalPagePath」に遷移

コラム

1つのコンポーネント内で申請モーダルを複数用いる場合は「前回情報破棄フラグ」にtrueを指定してください。

1.3.1.1. 権限者所属組織情報

{
  "authUserDepartmentInfo": {
    "companyCd": "string",
    "departmentSetCd": "string",
    "departmentCd": "string"
  }
}
項目名 必須/任意 説明
companyCd 必須 文字列
会社コードを指定します。
departmentSetCd 必須 文字列
組織セットコードを指定します。
departmentCd 必須 文字列
組織コードを指定します。

1.3.1.2. 分岐先選択情報

{
  "branchSelects": [
    {
      "branchStartNodeId": "string",
      "forwardNodeIds": [
        "string"
      ]
    }
  ]
}
項目名 必須/任意 説明
branchStartNodeId 必須 文字列
初期値を指定するルート選択の分岐開始ノードのノードIDを指定します。
forwardNodeIds 必須 配列(文字列)
初期値として選択するノードのノードIDを配列で指定します。
単一選択の場合は1つ、複数選択の場合は選択したいノードをすべて設定してください。

1.3.1.3. 動的承認ノード/確認ノード設定情報

{
  "dcNodeConfigs": [
    {
      "enable": true,
      "nodeId": "string",
      "nodeInformation": "string",
      "display": true,
      "readonly": false,
      "searchCondition": {
        "criteria": "any"
      },
      "processTargetConfigs": [
        {
          "pluginId": "string",
          "parameter": "string"
        }
      ]
    }
  ]
}
項目名 必須/任意 説明
enable 任意 boolean
「フロー設定」においてノードを設定するか否かの初期値を制御します。
この設定は、動的承認ノードに対してのみ有効です。
フロー定義における動的承認ノードの削除設定が削除可能な場合に、有効な項目です。
true の場合、処理対象者を設定する状態で表示します。
false の場合、ノードを削除する状態で表示します。
「display」と組み合わせて、両方にfalseを設定した場合、該当の動的承認ノードを削除(ノードスキップ)できます。
未指定の場合、trueとして動作。
nodeId 必須 文字列
設定対象のノードIDを指定
nodeInformation 任意 文字列
ノードに対する任意のメッセージを指定します。
display 任意 boolean
指定したノードに対する項目の表示可否を制御します。
true の場合は表示、false の場合は非表示が設定されます。
未指定の場合はtrueとして動作します。
readonly 任意 boolean
指定したノードに対する項目の入力可否を制御します。
true の場合は入力不可、false の場合は入力可が設定されます。
未指定の場合はfalseとして動作します。
searchCondition 任意 オブジェクト
処理対象者の検索時条件を指定します。
「criteria」プロパティを設定することで、検索時の暗黙条件を指定可能です。
当プロパティを指定した場合、処理対象者を検索する際に利用可能なプラグインと検索タブは「ユーザ検索(キーワード タブ)」のみです。
criteria 任意 オブジェクト
ユーザ検索(キーワード タブ)に対する暗黙条件を指定可能です。
具体的には、「 IM-共通マスタ 検索画面起動引数一覧 」において以下に該当する引数を指定可能です。
  • 対象となる検索画面・タブ
    機能グループ = 「ユーザ検索画面」
    検索画面タブ = 「キーワード」
  • 対象となる引数
    分類 = 「暗黙条件」
「searchCondition」を指定した場合、省略することはできません。
「searchCondition」・「criteria」の両方が省略された場合、検索条件(暗黙条件)指定なしで動作します。
processTargetConfigs 任意 オブジェクト
処理対象プラグイン情報を指定します。
利用可能なプラグインIDについては「 処理権限者プラグイン一覧 」を参照してください。
未指定の場合、現在設定済みの処理対象者が適用されます。

コラム

「searchCondition」、または、「processTargetConfigs」を設定した場合、保存済み設定機能は利用できません。

コラム

ノードの削除可否や利用可能なプラグインは、 動的承認・横配置・縦配置ノード設定 の範囲で指定できます。

1.3.1.4. 横配置ノード/縦配置ノード設定情報

{
  "hvNodeConfigs": [
    {
      "nodeId": "string",
      "nodeInformation": "string",
      "display": true,
      "readonly": false,
      "searchCondition": {
        "criteria": "string"
      },
      "matterNodeExpansions": [
        {
          "nodeName": "string",
          "searchCondition": {
            "criteria": "any"
          },
          "processTargetConfigs": [
            {
              "pluginId": "string",
              "parameter": "string"
            }
          ]
        }
      ]
    }
  ]
}
項目名 必須/任意 型(最大バイト数) 説明
nodeId 必須 文字列
設定対象のノードIDを指定
nodeInformation 任意 文字列
ノードに対する任意のメッセージを指定します。
display 任意 boolean
指定したノードに対する項目の表示可否を制御します。
true の場合は表示、false の場合は非表示が設定されます。
未指定の場合はtrueとして動作します。
readonly 任意 boolean
指定したノードに対する項目の入力可否を制御します。
true の場合は入力不可、false の場合は入力可が設定されます。
未指定の場合はfalseとして動作します。
searchCondition 任意 オブジェクト
処理対象者の検索時条件を指定します。
「criteria」プロパティを設定することで、検索時の暗黙条件を指定可能です。
当プロパティを指定した場合、処理対象者を検索する際に利用可能なプラグインと検索タブは「ユーザ検索(キーワード タブ)」のみです。
criteria 任意 オブジェクト
ユーザ検索(キーワード タブ)に対する暗黙条件を指定可能です。
具体的には、「 IM-共通マスタ 検索画面起動引数一覧 」において以下に該当する引数を指定可能です。
  • 対象となる検索画面・タブ
    機能グループ = 「ユーザ検索画面」
    検索画面タブ = 「キーワード」
  • 対象となる引数
    分類 = 「暗黙条件」
「searchCondition」を指定した場合、省略することはできません。
「searchCondition」・「criteria」の両方が省略された場合、検索条件(暗黙条件)指定なしで動作します。
matterNodeExpansions 任意 オブジェクト
ノード展開情報を指定します。展開するノード数分オブジェクトを定義します。

「display」false(表示しない) の場合の動作仕様は以下の通りです。
  • フロー定義で設定されている「割当可能ノード数」の「最小」「最大」値の範囲で、当パラメータで定義したノード数で展開されます。
「display」true(表示する) の場合の動作仕様は以下の通りです。
  • 展開可能なノード数の最小個数は、常にフロー定義で設定されている「割当可能ノード数」の「最小」値です。フロー定義の最小値より当パラメータで指定したノード数の方が小さい場合、処理を行うためには標準画面上での追加設定が必要です。
  • 展開可能なノード数の最大個数は、フロー定義で設定されている「割当可能ノード数」の「最大」値です。当パラメータで指定したノード数が「割当可能ノード数」の「最大」値を超えた分は設定されません。
対象のノードを削除(ノードスキップ)する場合、以下の設定を行ってください。
  • 「matterNodeExpansions」の設定を省略または空で指定、かつ、displayにfalseを指定。
nodeName 任意 文字列(50)
ノード名を指定します。
processTargetConfigs 任意 オブジェクト
処理対象プラグイン情報を指定します。
利用可能なプラグインIDについては「 処理権限者プラグイン一覧 」を参照してください。
未指定の場合、現在設定済みの処理対象者が適用されます。

コラム

「searchCondition」、または、「matterNodeExpansions」を設定した場合、保存済み設定機能は利用できません。

コラム

割当可能ノード数や利用可能なプラグインは、 動的承認・横配置・縦配置ノード設定 の範囲で指定できます。

1.3.1.5. インタフェース制御

申請モーダルの各項目に対するインタフェースの制御(表示、参照、必須)を指定します。
制御の内容と設定値ごとの動作は以下の通りです。
  • 表示(display)
    • true : 項目を表示します。(初期値)
    • false : 項目を非表示にします。
  • 参照(readonly)
    • true : 項目を入力不可(参照のみ)にします。
    • false : 項目を入力可とします。(初期値)
  • 必須(required)
    • true : 項目を必須入力にします。
    • false : 項目を任意入力にします。(初期値)
項目ごとに制御できる内容は異なります。
{
  "interfaceControl": {
    "matterName": {
      "display": true,
      "readonly": false
    },
    "applyBaseDate": {
      "display": true
    },
    "applyAuthUserCd": {
      "display": true
    },
    "authUserDepartmentInfo": {
      "display": true,
      "readonly": false
    },
    "priorityLevel": {
      "display": true,
      "readonly": false
    },
    "processComment": {
      "display": true,
      "readonly": false,
      "required": false
    },
    "attachmentFile": {
      "display": true
    },
    "branchSelects": [
      {
        "branchStartNodeId": "string",
        "display": true,
        "readonly": false
      }
    ],
    "stamp": {
      "display": true
    },
    "nego": {
      "display": true
    }
  }
}
項目名 必須/任意 説明
matterName 任意 オブジェクト
案件名に対するインタフェース制御を指定します。
「display」と「readonly」を設定できます。
applyBaseDate 任意 オブジェクト
申請基準日に対するインタフェース制御を指定します。
「display」を設定できます。
applyAuthUserCd 任意 オブジェクト
申請権限者に対するインタフェース制御を指定します。
「display」を設定できます。
authUserDepartmentInfo 任意 オブジェクト
担当組織に対するインタフェース制御を指定します。
「display」と「readonly」を設定できます。
priorityLevel 任意 オブジェクト
優先度に対するインタフェース制御を指定します。
「display」と「readonly」を設定できます。
processComment 任意 オブジェクト
処理コメントに対するインタフェース制御を指定します。
「display」と「readonly」と「required」を設定できます。
attachmentFile 任意 オブジェクト
添付ファイルに対するインタフェース制御を指定します。
「display」を設定できます。
branchSelects 任意 配列(オブジェクト)
分岐先選択のインタフェース制御を指定します。
分岐先選択では、分岐先となる分岐先開始ノード(branchStartNodeId)ごとに「display」、「readonly」を設定できます。
stamp 任意 オブジェクト
印影に対するインタフェース制御を指定します。
「display」を設定できます。
nego 任意 オブジェクト
根回しメールに対するインタフェース制御を指定します。
「display」を設定できます。

1.3.1.6. オプションパラメータ

userParameterには、アクション処理に受け渡したいパラメータを指定してください。
formaParamは IM-FormaDesigner / IM-BIS で作成したワークフローの場合のみ有効です。
印影を指定する場合、imwStampIdを指定してください。
印影を利用していて、imwStampIdを指定しない場合、常用印が利用されます。
{
  "optionalParameter": {
      "userParameter": {
          "imwStampId": "string",
          "xxxx": "string"
      },
      "formaParam": {
          "items": {
            "textbox1": "string"
          }
      }
  }
}

コラム

IM-BloomMaker では上記のJSON文字列を利用することで、変数のJSON入力機能で取り込むことができます。

1.3.2. 出力値

項目名 説明
処理実行によるクローズであるか boolean
処理を実行し、モーダル画面が閉じた場合にtrueを返却
処理を実行せずに、×ボタン押下でモーダル画面を閉じた場合にfalseを返却
案件番号 文字列
処理正常終了時に返却
処理を実行せずに、×ボタン押下でモーダル画面を閉じた場合は、出力先として設定した変数への代入処理は行いません。
システム案件ID 文字列
処理正常終了時に返却
処理を実行せずに、×ボタン押下でモーダル画面を閉じた場合は、出力先として設定した変数への代入処理は行いません。
ユーザデータID 文字列
処理正常終了時に返却
処理を実行せずに、×ボタン押下でモーダル画面を閉じた場合は、出力先として設定した変数への代入処理は行いません。