intra-mart Accel Platform IM-Workflow プログラミングガイド 第25版 2021-08-01

1.3.4. showTemporarySave

imWorkflow.modal.showTemporarySave(Object parameter) : Promise<Object>

一時保存モーダルを表示します。

1.3.4.1. サンプルコード

imWorkflow.modal.showTemporarySave({
   processParameter: {
       userDataId: "",
       flowId: "",
       matterName: "",
       applyBaseDate: "",
       applyAuthUserCd: "",
       processComment: "",
       interfaceControl: {}
   },
   optionalParameter: {},
   rebootModal: false
})
.then(function(result) {
   // modal close
   if (result.isProcessDone) {
      // success
      alert("done");
   }
   imWorkflow.transition.afterProcess();
});

1.3.4.2. パラメータ

  • parameter : Object

  • parameter.processParameter : Object(下記参照)
    一時保存用パラメータ情報オブジェクト
  • parameter.optionalParameter : Object(下記参照)
    ユーザパラメータ、および、Forma用ユーザパラメータを内包するオブジェクト
  • parameter.rebootModal : boolean
    モーダルを閉じた際に入力した内容を保持するかを指定
    true: モーダルを閉じる度に入力内容を破棄し、再度このメソッドを実行した際はモーダル表示処理を再実行します。
    false: モーダルを閉じても入力内容はコンテンツ画面に保持され、再度このメソッドを実行した際は保持された情報を表示します。画面遷移をした場合、入力内容は破棄されます。(初期値)

1.3.4.2.1. processParameter

項目名 必須/任意 型(最大バイト数) 説明
userDataId 任意 文字列(20)
ユーザデータID
「案件一覧」画面から遷移した場合は、一覧で選択した一時保存情報のユーザデータIDが設定されるため不要
未指定の場合、Identifier.get()で一時保存情報を新規作成
指定した場合、当該キーで特定される一時保存情報が存在しない場合、一時保存情報を新規作成
当該キーで特定される一時保存情報が存在する場合、一時保存情報を更新
flowId 任意 文字列
フローID
一時保存情報を新規作成時は必須
一時保存情報を更新時は不要
matterName 任意 文字列(200)
案件名
案件名に初期値を設定したい場合に指定
applyBaseDate 任意 日付/文字列
申請基準日
未指定の場合、「申請一覧」「案件一覧(一時保存)」画面から遷移した場合は、一覧で選択した申請基準日が設定される
「申請一覧」「案件一覧(一時保存)」画面以外から遷移した場合は、アカウントコンテキストのタイムゾーンにおける現在日付で一時保存
“yyyy/MM/dd”形式の文字列指定も可能
applyAuthUserCd 任意 文字列
申請権限者コード
申請権限者に初期値を設定したい場合に指定
processComment 任意 文字列(2000)
処理コメント
処理コメントに初期値を設定したい場合に指定
interfaceControl 任意 下記参照
インタフェース制御
モーダル画面のインタフェースを変更したい場合に指定

1.3.4.2.1.1. interfaceControl

一時保存モーダルの各項目に対するインタフェースの制御(表示、参照、必須)を指定します。
制御の内容と設定値ごとの動作は以下の通りです。
  • 表示(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.3.4.2.2. optionalParameter

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

1.3.4.3. 返却値

  • Promise<Object>
    返却オブジェクト(下記参照)
  • 当APIはPromiseを返します。
    正常終了時はpromise.then()で返却値を受け取ってください。
項目名 説明
isProcessDone boolean
処理実行フラグ
処理を実行し、モーダル画面が閉じた場合に true を返却します。
処理を実行せずに、×ボタン押下でモーダル画面を閉じた場合は false を返却します。
data.userDataId 文字列
ユーザデータID
処理を実行して正常終了したときに返却します。
処理を実行せずに、×ボタンをクリックしてモーダルを閉じた場合は、返却されません。