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

1.2. 一時保存モーダルを表示する

一時保存モーダルを表示して、ワークフローを一時保存するアクションです。 一時保存画面にて、一時保存の新規作成/更新を実施します。

コラム

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

1.2.1. 入力値

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

コラム

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

1.2.1.1. インタフェース制御

一時保存モーダルの各項目に対するインタフェースの制御(表示、参照、必須)を指定します。
制御の内容と設定値ごとの動作は以下の通りです。
  • 表示(display)
    • true : 項目を表示します。(初期値)
    • false : 項目を非表示にします。
  • 参照(readonly)
    • true : 項目を入力不可(参照のみ)にします。
    • false : 項目を入力可とします。(初期値)
  • 必須(required)
    • true : 項目を必須入力にします。
    • false : 項目を任意入力にします。(初期値)
項目ごとに制御できる内容は異なります。
{
  "interfaceControl": {
    "matterName": {
      "display": true,
      "readonly": false
    },
    "applyBaseDate": {
      "display": true
    },
    "applyAuthUserCd": {
      "display": true
    },
    "processComment": {
      "display": true,
      "readonly": false,
      "required": false
    }
  }
}
項目名 必須/任意 説明
matterName 任意 オブジェクト
案件名に対するインタフェース制御を指定します。
「display」と「readonly」を設定できます。
applyBaseDate 任意 オブジェクト
申請基準日に対するインタフェース制御を指定します。
「display」を設定できます。
applyAuthUserCd 任意 オブジェクト
申請権限者に対するインタフェース制御を指定します。
「display」を設定できます。
processComment 任意 オブジェクト
処理コメントに対するインタフェース制御を指定します。
「display」と「readonly」と「required」を設定できます。

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

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

1.2.2. 出力値

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