5.2.1.17.5. ファイル情報の一括置換¶
IM-BloomMakerの添付ファイル情報を一括置換するタスクです。
このタスクでは、添付ファイル情報の登録・削除を一括で行うことができます。 ファイル情報の登録 、ファイル情報の削除 も参照してください。
例えば、以下の流れを想定します。
- マルチファイルアップロードエレメントを利用して、「ファイルA」「ファイルB」をアップロード済みである。
- この状態から、「ファイルB」を削除して、新たに「ファイルC」を登録する。
- 最終的に、残るファイルキーの一覧は「ファイルA」「ファイルC」である。
「添付ファイル情報の一括置換」の入力値に、以下の情報を与えます。
- beforeFileKeys：「ファイルA」「ファイルB」のファイルキー
- afterFileKeys：「ファイルA」「ファイルC」のファイルキー
このタスクを実行すると、以下の処理が行われます。
- 「ファイルA」の変更は行われない。
- 「ファイルB」が永続化された場所から削除される。
- 「ファイルC」が新規登録（永続化）される。
出力値から以下の情報が得られます。
- createdFileKeys：「ファイルC」のファイルキー
- unchangedFileKeys：「ファイルA」のファイルキー
- deletedFileKeys：「ファイルB」のファイルキー
このように、入力されたファイルキーの情報を比較し、どのファイルが削除され、どのファイルが変更されずに残り、そしてどのファイルが新たに登録されたのかを判別し、ファイルキーの登録・削除を一括で行います。
このタスクの実行には、変更前のキーとアップロード時に返却されたキーが必要です。
5.2.1.17.5.1. 入力値¶
im_bmReplaceFileInfo <object>
├─ afterFileKeys <string[]> *
└─ beforeFileKeys <string[]> *
| 項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
|---|---|---|---|---|
| im_bmReplaceFileInfo | 任意 | object | なし | |
| afterFileKeys | 必須 | string | 配列 | ファイルアップロードエレメントで取得した、変更前のファイルを特定するキー |
| beforeFileKeys | 必須 | string | 配列 | ファイルアップロードエレメントで取得した、変更後のファイルを特定するキー |
5.2.1.17.5.2. 出力値¶
im_bmReplaceFileInfo <object>
├─ createdFileKeys <string[]>
├─ deletedFileKeys <string[]>
└─ unchangedFileKeys <string[]>
| 項目名 | 型 | 配列/リスト | 説明 |
|---|---|---|---|
| im_bmReplaceFileInfo | object | なし | |
| createdFileKeys | string | 配列 | 登録されたファイルキー |
| deletedFileKeys | string | 配列 | 削除されたファイルキー |
| unchangedFileKeys | string | 配列 | 変更されていないファイルキー |