intra-mart Accel Kaiden! レポート操作ガイド 第5版 2019-08-01

5.4. 指定可能なジョブパラメータ

5.4.1. エクスポートジョブで指定可能なパラメータ

エクスポートジョブでは、次のパラメータが指定可能です。
キー 設定 省略時
lock_wait ロック待ち時間 任意 10(秒)
conductor ジョブの各処理間で実行されるコンダクター 任意  
file_path エクスポートファイルのパス 任意
kaiden/generic/report/
{REPORT_ID}/export.csv
file_mode エクスポート時の既存ファイル操作モード 任意 1
archive_path エクスポートファイルのアーカイブ先パス 任意
kaiden/generic/report/
{REPORT_ID}/export_{YMDHMSN}.csv
character エクスポートファイルの文字コード 任意 UTF-8
delimiter エクスポートファイルの区切り文字 任意 , (カンマ)
enclosing エクスポートファイルの囲み文字 任意 ” (ダブルクォーテーション)
header_row エクスポートファイルのヘッダー出力有無 任意 false(出力しない)
reportId レポートID 必須  
queryId クエリーID 必須  

5.4.1.1. ロック待ち時間(lock_wait)

ロックキー「%ジョブID%_%レポートID%」でアプリケーションがロックされていた場合の待ち時間(秒)を設定します。
キー lock_wait
設定 任意
設定値(省略時) 数値 (10)

5.4.1.2. コンダクター(conductor)

ジョブの各処理間で実行されるコンダクターのコンポーネント名を設定します。
本パラメータは、カンマ区切りで複数指定可能です。
キー conductor
設定 任意
設定値(省略時) 文字列 (未指定)

コラム

AbstractGenericJobConductorを継承したクラスのコンポーネント名を指定してください。

5.4.1.3. エクスポートファイルパス(file_path)

エクスポートファイルのファイルパスをを設定します。
ファイルパスは、パブリックストレージからのパスを指定してください。
キー file_path
設定 任意
設定値(省略時) 文字列 (kaiden/generic/report/{REPORT_ID}/export.csv)

コラム

「{REPORT_ID}」などの置換文字列の詳細は「ファイルパスの置換文字列」を参照してください。

5.4.1.4. エクスポート時の既存ファイル操作モード(file_mode)

エクスポート時の既存ファイル操作モードを設定します。
キー file_mode
設定 任意
設定値(省略時) 1~3 (1)

設定可能なエクスポート時の既存ファイル操作モードと処理概要
モード 処理概要
1 既存ファイルを操作しない(追記)
2 既存ファイルを削除し、エクスポート
3 既存ファイルをアーカイブ(移動)し、エクスポート

5.4.1.5. エクスポートファイルのアーカイブ先パス(archive_path)

ファイル操作モードでアーカイブを指定した場合のエクスポートファイルのアーカイブ先パスをを設定します。
アーカイブ先ファイルパスは、パブリックストレージからのパスを指定してください。
キー archive_path
設定 任意
設定値(省略時) 文字列 (kaiden/generic/report/{REPORT_ID}/export_{YMDHMSN}.csv)

コラム

「{REPORT_ID}」などの置換文字列の詳細は「ファイルパスの置換文字列」を参照してください。

5.4.1.6. エクスポートファイルの文字コード(character)

エクスポートファイルの文字コードを設定します。
キー character
設定 任意
設定値(省略時) UTF-8, SHIFT-JIS (UTF-8)

5.4.1.7. エクスポートファイルの区切り文字(delimiter)

エクスポートファイルの区切り文字を設定します。
キー delimiter
設定 任意
設定値(省略時) ,[カンマ], \t [タブ] (,)

5.4.1.8. エクスポートファイルの囲み文字(enclosing)

エクスポートファイルの囲み文字を設定します。
キー enclosing
設定 任意
設定値(省略時) none,”[ダブルクォーテーション] (”)

5.4.1.9. エクスポートファイルのヘッダー出力有無(header_row)

エクスポートファイルの読込開始行数を設定します。
キー header_row
設定 任意
設定値(省略時) true, false (false)

5.4.1.10. レポートID(reportId)

エクスポートを行うレポートのレポートIDを設定します。

キー reportId
設定 必須
設定値(省略時) 文字列

5.4.1.11. クエリーID(queryId)

エクスポートを行うレポートのクエリーIDを設定します。
キー queryId
設定 必須
設定値(省略時) 文字列

5.4.2. パラメータの優先度

指定したパラメータの優先度は次の通りです。
  1. ジョブ(ネット)パラメータ
  2. ReportBuilderの設定値
  3. 初期値(省略時の値)

5.4.3. ファイルパスの置換文字列

各ファイルパスには次の置換文字列が使用可能です。
いずれも置換内容にあたる値が設定されていない場合は置換処理を行いません。
置換文字列 置換内容
{YMD} 「yyyyMMdd」形式のジョブ実行日時
{YMDHMSN} 「yyyyMMddHHmmssSSS」形式のジョブ実行日時
{JOB_NET_ID} ジョブネットID
{JOB_NET_NAME} ジョブネット名
{JOB_ID} ジョブID
{JOB_NAME} ジョブ名
{REPORT_ID} レポートID
{QUERY_ID} クエリーID