ダウンロードジョブ

最終更新日: 2020年3月14日
R8 | R9

定義方法

ダウンロード処理を画面上から手動で行うこととは別に、時間指定ジョブとして実行することができます。

ダウンロードするファイルは「本番運用サーバ」からアクセスできるパスに用意してください。

「画面 > ダウンロード > ダウンロードジョブ」にて、「ダウンロードジョブを作成する」を有効にします。あわせて「説明文」にこのジョブの説明を記述します。

図1 ジョブを用意する

ワンポイント

ダウンロードファイルの形式は「ダウンロード設定 > ダウンロードファイルのタイプ」で指定した方法になります。図1では "CSV" となっているため、CSV ファイル形式で出力されます。ここで "Excel(xls)" を選択すると、ダウンロードジョブも Excel ファイル形式で出力されます。

ジョブの登録

jobadminアカウントを用意する

「サポート > 管理者ガイド(R8) > 準備：ジョブ実行アカウントを利用可能にする」の手順に従って、jobadmin アカウントを用意してください。

注意

jobadmin アカウントは、対象モデルを操作できる権限（プリンシパル）を与えるようにしてください。権限がない場合、アップロード更新ジョブは失敗します。

ダウンロードジョブを設定する

Wagbyのジョブを初めて扱う場合は"サポート > 管理者ガイド(R8) > ジョブ管理"をお読みください。ここでは、ジョブの具体的な使い方を説明します。

  1. 管理者権限をもったアカウントでログオンします。
  2. メニューから「ジョブ管理」「ジョブスケジュール検索」画面を開きます。
  3. 「登録画面へ」ボタンを押下し、ジョブスケジュールの新規登録処理を行います。
  4. ジョブ名から「Download + モデルID + Job」を選択します。その下の説明欄に、Designerで入力した説明文が表示されます。
  5. ジョブパラメータに、実行したいコマンドを記述します。[後述]
  6. スケジュールを指定します。
  7. 「有効」フラグをチェックします。
  8. このジョブを実行する管理者のアカウントおよびパスワードを入力します。先ほど用意した jobadmin を使うとよいです。
  9. ジョブスケジュールを登録します。指定した時間になると、コマンドが実行されます。
図2 ダウンロードジョブを作成する
図3 ダウンロードジョブパラメータを設定する

注意

図2で対象モデルのジョブの選択肢が表示されない場合は、ビルド後に jfcjob モデルのデータインポートを行なっていない可能性があります。初期リポジトリ data_init 内にある jfcjob フォルダに、追加したジョブに関する xml ファイルが追加されていますので、ご確認ください。

指定できるジョブパラメータ

このジョブに関する制御はすべてジョブパラメータとして指定します。

パラメータ名 説明 記述例
outputfilename 保存するファイル名。保存先は本番運用サーバ。
指定がない場合は wagbyapp\tempフォルダに、download_xxx.csvというファイル名で出力される。（xxxはランダムな文字列。）		 C:\Downloads\YOURFILE.csv
/home/wagby/YOURFILE.csv
outputdir 保存先フォルダ名。outputfilenameが指定されていない場合に用いる。指定されたフォルダ名に保存する。ファイル名はoutputfilenametypeの指定に準じる。 C:\Downloads
/home/wagby
csv_encoding csv,tsv形式の場合の文字エンコーディングを指定する。未指定の場合は標準の動作となる。 utf-8
outputmode モデルに繰り返し項目や繰り返しコンテナがある場合、これを含めるかどうかを指定できる。
[参考: 繰り返し項目・繰り返しコンテナ項目の扱いに関するルール] 		All - すべて
Main - 繰り返しコンテナを含まないすべて
Modelitem_[項目名] - 繰り返し項目または、繰り返しコンテナのみ
fileext ダウンロードファイルのタイプに"実行時指定"を設定した場合に指定する。 csv
tsv
xls
xlsx
outputfilenametype ファイル名種別。未指定、temp、filename、extを指定できる。
未指定、tempの場合は一時ファイル名として、download_[ランダムな文字列].csvとなる。必ず一意になる。現状のダウンロードジョブと同様。tsvやxlsなどcsvでない形式を選択しても、拡張子は.csvとなる。
filenameの場合はDesignerで設定されたファイル名で保存する。拡張子も指定した形式に対応して設定される。
extの場合は拡張子はfilenameと同様に指定した形式に対応して設定されるが、拡張子を除くファイル名はtempと同様に必ず一意になるファイル名が設定される。		 temp
filename
ext
sort_key 8.3.1 項目名を指定する。指定順に昇順で並べる。":DESC" を付与すると降順となる。コンマ(,)区切りで複数指定できる。 pkey:DESC
targetitems 8.3.1 項目名を指定する。指定した項目を、指定した順番で出力する。コンマ(,)区切りで複数指定できる。 pkey,item1,item5,item3
locale 8.3.1 ロケールを指定する。出力されるヘッダ行はロケールによって適切な値となる。未指定の場合は標準ロケール(日本語環境の場合は"ja")となる。 en

ジョブの実行を停止する

ジョブを一時的に無効にすることができます。

  1. 管理者権限をもったアカウントでログオンします。
  2. メニューから「ジョブ」「ジョブスケジュール検索」画面を開きます。
  3. 該当する「ジョブスケジュール」を検索し、更新画面を開きます。
  4. 「有効」フラグについているチェックをはずし、保存します。
    図4 ジョブを無効にする

実行結果をメールで送信する

ジョブの実行結果をメールで送信することができます。

多重実行の抑制

ジョブの多重実行を行うことはできません。

あるジョブを 1 分毎に起動させるようにした場合、1 分後にこのジョブの実行が終了していなければ、新しいジョブは実行されません。

すぐに実行する

時間指定ではなく、このジョブを今すぐ実行することもできます。 "ジョブの即時実行"をお読みください。

仕様・制約

  • outputfilenameに指定するファイル名に対応したフォルダが存在しない場合、エラーとなります。
  • outputfilenameに指定するファイル名に日時や項目値を含めるというようなことはできません。固定ファイル名となります。
  • outputfilenameに指定したファイルがすでに存在する場合は、上書きされます。
  • ダウンロード時の検索条件を指定することはできません。全件ダウンロードされます。