intra-mart Accel Platform IM-Workflow 仕様書 第27版 2020-04-01

1.1.4. 処理モーダルを表示する

処理モーダルを表示して、ワークフローを処理するアクションです。 再申請/承認画面にて、以下の処理を実施します。

  • 起票案件を申請
  • 再申請
  • 承認
  • 差戻し
  • 取止め
  • 否認
  • 承認終了
  • 保留
  • 保留解除

コラム

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

1.1.4.1. 入力値

項目名 必須/任意 型(最大バイト数) 説明
システム案件ID 任意 文字列
「案件一覧」画面から遷移した場合は、一覧で選択したタスクのシステム案件IDが設定されるため不要
「案件一覧」画面以外から遷移した場合は、必須
ノードID 任意 文字列
「案件一覧」画面から遷移した場合は、一覧で選択したタスクのノードIDが設定されるため不要
「案件一覧」画面以外から遷移した場合は、必須
動的承認ノード設定情報 任意 下記参照
動的処理対象者設定機能 」を利用する場合に指定
確認ノード設定情報 任意 下記参照
動的処理対象者設定機能 」を利用する場合に指定
横配置ノード設定情報 任意 下記参照
動的処理対象者設定機能 」を利用する場合に指定
縦配置ノード設定情報 任意 下記参照
動的処理対象者設定機能 」を利用する場合に指定
オプションパラメータ 任意 下記参照
IM-Workflow のuserParameterとして受け取る値を設定
または、 IM-FormaDesigner / IM-BIS のformaParamとして受け取る値を設定
前回情報破棄フラグ 任意 boolean
trueの場合、×ボタン押下でモーダル画面を閉じた後に再表示する際、前回設定したパラメータや入力情報を破棄して再表示する
falseの場合、×ボタン押下でモーダル画面を閉じた後に再表示する際、前回閉じた際の状態を復元する
未指定の場合、falseで動作
案件処理後の自動画面遷移 任意 boolean
trueの場合、案件処理後に「申請一覧」「案件一覧」画面や、各種ワークフローポートレットから渡された「imwCallOriginalPagePath」に遷移

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

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

コラム

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

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

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

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

コラム

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

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

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

コラム

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

1.1.4.2. 出力値

項目名 説明
処理実行によるクローズであるか boolean
処理を実行し、モーダル画面が閉じた場合にtrueを返却
処理を実行せずに、×ボタン押下でモーダル画面を閉じた場合にfalseを返却