IM-FormaDesigner for Accel Platform プログラミングガイド 第14版 2019-04-01

13.3. スクリプト開発モデル

ここでは、ファイルアップロードアイテムAPI(スクリプト開発モデル)の基本的な利用方法を説明します。
APIのインタフェース情報については「 IM-FormaDesigner for Accel Platform APIドキュメント(スクリプト開発モデル) 」を参照してください。

注意

この章では、IM-FormaDesigner の API を利用した場合のサンプルコードを掲載しています。

13.3.1. コンストラクタ

  • コンストラクタ

    • FormaFileUploadItemManager(applicationId)

    • パラメータ

      applicationId アプリケーションID

13.3.2. ファイル登録処理の実装

注意

アプリケーションデータの登録、更新、削除などデータの操作が完了した時点で、ファイル登録が確定します。
データ操作完了までは、一時保存の状態です。

13.3.2.1. パラメータ

ファイル登録処理APIを実行するには、ファイル情報、ユーザデータID、およびプロセスキーの3つのパラメータが必要です。
  • パラメータ(ファイル情報)

    登録するファイルの情報です。下記は必須項目です。
    パラメータ(ファイル情報)
    パラメータ 説明
    ファイルパス
    ファイルパスを指定します。
    パブリックストレージにあるファイルを指定することが可能です。
    アイテム識別ID 登録する画面アイテム「ファイルアップロード」のアイテム識別IDを指定します。
    // パラメータ(ファイル情報)の作成
    var files = [];
    var fileObj = {};
    fileObj.uploadItemId = 'attach_fileupload_item1';
    fileObj.filePath = 'pdftest.pdf';
    files.push(fileObj);

  • パラメータ(ユーザデータID)

    作成したアプリケーションデータを一意に識別できるID情報です。
    この項目は、必須項目です。

  • パラメータ(プロセスキー)

    プロセスキーです。
    この項目は、必須項目です。

13.3.2.2. ファイル登録処理を実装する

例として、後処理プログラム内でファイル登録処理に必要なパラメータを作成します。
アプリケーションIDを指定して、ファイルアップロードアイテムAPIのインスタンスを作成します。
作成したファイルアップロードアイテムAPIのファイル登録処理メソッドにパラメータを指定して、実行します。
function regist(formaParam, sendParam) {
    var manager = new FormaFileUploadItemManager(formaParam.applicationId);

    // パラメータ(ファイル情報)の作成
    var files = [];
    var fileObj = {};
    fileObj.uploadItemId = 'attach_fileupload_item1';
    fileObj.filePath = 'pdftest.pdf';
    files.push(fileObj);

    // 登録処理の実行
    var result = manager.registerFileTemp(files, formaParam.insertId, formaParam.processKey);
}

13.3.2.3. 戻り値

プロパティ詳細
error
(Boolean)
エラーフラグ
処理中にエラーが発生した場合はtrue、
ない場合はfalseを設定します。
errorMessage
(String)
エラーメッセージ

13.3.3. ファイル削除処理の実装

注意

アプリケーションデータの登録、更新、削除などデータの操作が完了した時点で、ファイル削除が確定します。
データ操作完了までは、一時保存の状態です。

13.3.3.1. パラメータ

ファイル削除処理を実行するには、ユーザデータID、アイテム識別ID、ファイルID、およびプロセスキーの4つのパラメータが必要です。
  • パラメータ(ユーザデータID)

    作成したアプリケーションデータを一意に識別できるID情報です。
    この項目は、必須項目です。

  • パラメータ(アイテム識別ID)

    アップロードしたファイルを画面アイテムと関連付けるためのIDです。
    この項目は、必須項目です。

  • パラメータ(ファイルID)

    登録したファイルを一意に識別できるID情報です。
    この項目は、必須項目です。

  • パラメータ(プロセスキー)

    プロセスキーです。
    この項目は、必須項目です。

13.3.3.2. ファイル削除処理を実装する

例として、後処理プログラム内でファイル削除処理に必要なパラメータを作成します。
アプリケーションIDを指定して、ファイルアップロードアイテムAPIのインスタンスを作成します。
作成したファイルアップロードアイテムAPIのファイル削除処理メソッドにパラメータを指定して、実行します。
function regist(formaParam, sendParam) {
    var manager = new FormaFileUploadItemManager(formaParam.applicationId);
    var result = manager.deleteFile(formaParam.insertId, "attach_fileupload_item1", "fileId", formaParam.processKey);
}

注意

ファイルIDは、ファイル情報取得処理の実装から取得することが可能です。

13.3.3.3. 戻り値

プロパティ詳細
error
(Boolean)
エラーフラグ
処理中にエラーが発生した場合はtrue、
ない場合はfalseを設定します。
errorMessage
(String)
エラーメッセージ

13.3.4. ファイル情報取得処理の実装

13.3.4.1. パラメータ

ファイル情報取得処理を実行するには、ユーザデータIDが必要です。
プロセスキーを指定した場合、登録済みのファイル情報とセッションに保存されている一時保存状態のファイル情報を取得できます。
プロセスキーを指定していない場合、登録済みのファイル情報以外は取得できません。
  • パラメータ(ユーザデータID)

    作成したアプリケーションデータを一意に識別できるID情報です。
    この項目は、必須項目です。

  • パラメータ(プロセスキー)

    プロセスキーです。

13.3.4.2. ファイル情報取得処理を実装する

例として、後処理プログラム内でファイル情報取得処理に必要なパラメータを作成します。
アプリケーションIDを指定して、ファイルアップロードアイテムAPIのインスタンスを作成します。
作成したファイルアップロードアイテムAPIのフファイル情報取得処理メソッドにパラメータを指定して、実行します。
function regist(formaParam, sendParam) {
    var manager = new FormaFileUploadItemManager(formaParam.applicationId);
    var result = manager.getFilesInfo(formaParam.insertId, formaParam.processKey);
}

13.3.4.3. 戻り値

ファイル情報オブジェクト が、戻り値として返却されます。
以下の情報が取得できます。
ファイルの実体を取得する場合は、ファイル取得処理の実装を利用してください。
プロパティ詳細
error
(Boolean)
エラーフラグ
処理中にエラーが発生した場合はtrue、ない場合はfalseを設定します。
errorMessage
(String)
エラーメッセージ
data
(Object)
フィールド識別ID
(String)
ファイル情報リスト(Array)
file_id
(String)
ファイルID
file_name
(String)
ファイル名
notes
(String)
備考
record_date
(Date)
最終更新日
record_user_cd
(String)
更新ユーザコード
create_date
(Date)
作成日
create_user_cd
(String)
登録ユーザコード
status
(String)
ステータス

13.3.5. ファイル取得処理の実装

13.3.5.1. パラメータ

ファイル取得処理を実行するには、ユーザデータID、ファイルIDの2つのパラメータが必要です。
プロセスキーを指定した場合、登録済みのファイル情報とセッションに保存されている一時保存状態のファイル情報を取得できます。
プロセスキーを指定していない場合は、登録済みのファイル情報以外は取得できません。
  • パラメータ(ユーザデータID)

    作成したアプリケーションデータを一意に識別できるID情報です。
    この項目は、必須項目です。

  • パラメータ(ファイルID)

    登録したファイルを一意に識別できるID情報です。
    この項目は、必須項目です。

  • パラメータ(プロセスキー)

    プロセスキーです。

13.3.5.2. ファイル情報取得処理を実装する

例として、後処理プログラム内でファイル情報取得処理に必要なパラメータを作成します。
アプリケーションIDを指定して、ファイルアップロードアイテムAPIのインスタンスを作成します。
作成したファイルアップロードアイテムAPIのフファイル情報取得処理メソッドにパラメータを指定して、実行します。
function regist(formaParam, sendParam) {
    var manager = new FormaFileUploadItemManager(formaParam.applicationId);
    var  result = manager.getFile(formaParam.insertId, 'fileId', formaParam.processKey);
}

注意

ファイルIDは、ファイル情報取得処理の実装から取得することが可能です。

注意

プロセスキーは「 前処理 」、「 後処理 」、「 入力チェックプログラム 」のパラメータからのみ
取得することが可能です。

13.3.5.3. 戻り値

ファイル情報オブジェクト が、戻り値として返却されます。以下の情報が取得できます。
プロパティ詳細
error
(Boolean)
エラーフラグ
処理中にエラーが発生した場合はtrue、
ない場合はfalseを設定します。
errorMessage
(String)
エラーメッセージ
data
(Object)
data
(InputStream)
ファイルデータ
file_id
(String)
ファイルID
file_name
(String)
ファイル名
notes
(String)
備考
record_date
(Date)
最終更新日
record_user_cd
(String)
更新ユーザコード
create_date
(Date)
作成日
create_user_cd
(String)
登録ユーザコード
status
(String)
ステータス