# ジョブステップで利用可能な環境変数

ジョブフローの実行中は、各ジョブステップで環境変数が生成されます。

コマンドラインパラメータやシェルスクリプト内でこれらの環境変数を使用すると、実行中のジョブフローについての情報（配信ホスト名や抽出ファイル名など）を取得することができます。

環境変数は、以下の2種類に分類されます。

- ジョブフロー全体で利用できる環境変数

  ジョブフロー全体で一意の名前を持つ環境変数です。

  生成された後は、どのジョブステップから参照しても同じ情報を保持しています。

- 各ジョブステップ内で利用できる環境変数

  ジョブステップを実行するたびに再利用される環境変数です。

  実行中のジョブステップの情報を保持しています。

ジョブステップステータス画面の「環境変数」には、当該ジョブステップから参照可能な環境変数の名前と値が一覧表示されます。

【注意】 | 生成された環境変数は、当該ジョブフロー内でのみ使用できます。

## 環境変数を指定可能な項目

環境変数は、実行系・ユーザジョブと実行系・DataMagicの各ジョブステップで利用可能です。

環境変数を指定できる項目は以下のテキストボックスです。

実行系・ユーザジョブの場合

［ユーザジョブ指定］

実行系・DataMagicの場合

［コマンドライン］

［パラメータファイル］

［上記以外のパラメータ指定］

【注意】 |
• | DataMagicで使用する環境設定ファイルやパラメータファイルの項目に環境変数を指定することはできません。
• | 環境変数の後に英数字または“_”を指定する場合は、$ に続く環境変数名を{ } で囲んでください。
| 例）環境変数「$JF_MESSAGE0」が“/home/smpl/”に設定されている場合

項目設定 | 置換結果
--- | ---
${JF_MESSAGE0}data | /home/smpl/data
$JF_MESSAGE0data | 空文字列（“$JF_MESSAGE0data”という環境変数と認識されるため）

## 環境変数一覧

以下に環境変数の一覧を掲載します。

<表>ジョブフロー全体で利用できる環境変数

環境変数名 | 設定される値
--- | ---
$JF_JOBFLOWID | ジョブフローID
$JF_SDATE | ジョブフローの開始日（YYYYMMDD形式） 開始条件が1つでも満たされた日付です。
$JF_STIME | ジョブフローの開始時刻（HHMMSS形式） 開始条件が1つでも満たされた時刻です。
$JF_[ジョブステップID]_SDATE | ジョブステップIDで指定されたジョブステップの開始日（YYYYMMDD形式）
$JF_[ジョブステップID]_STIME | ジョブステップIDで指定されたジョブステップの開始時刻（HHMMSS形式）
$JF_[ジョブステップID]_EDATE | ジョブステップIDで指定されたジョブステップの終了日（YYYYMMDD形式）
$JF_[ジョブステップID]_ETIME | ジョブステップIDで指定されたジョブステップの終了時刻（HHMMSS形式）
$JF_[ジョブステップID]_ENDCODE | ジョブステップIDで指定されたジョブステップの完了コード ユーザ指定の完了コードです。
$JF_[ジョブステップID_蓄積識別名]_SELECTFILENM | ジョブステップIDで指定された実行系・蓄積ファイル抽出で、蓄積識別名で指定された蓄積データから抽出されたデータが格納されるファイル名
$JF_[ジョブステップID_蓄積識別名]_[HULFT環境変数名] *1 | ジョブステップIDで指定された蓄積待ちで、蓄積識別名で指定された蓄積を行った転送の配信側クライアントで設定されたHULFTの環境変数 蓄積待ちアイコンが存在する場合のみ、以降のジョブステップで使用可能です。
$JF_MESSAGE0 | イベント通知ユーティリティの-msg0で指定されたメッセージ
$JF_MESSAGE1 | イベント通知ユーティリティの-msg1で指定されたメッセージ
$JF_MESSAGE2 | イベント通知ユーティリティの-msg2で指定されたメッセージ
$JF_MESSAGE3 | イベント通知ユーティリティの-msg3で指定されたメッセージ
$JF_MESSAGE4 | イベント通知ユーティリティの-msg4で指定されたメッセージ
$JF_MESSAGE5 | イベント通知ユーティリティの-msg5で指定されたメッセージ

*1： | 詳細は、ジョブフローで利用可能なHULFT環境変数を参照してください。

<表>各ジョブステップ内で利用できる環境変数

環境変数名 | 設定される値
--- | ---
$JS_JOBSTEPID | 自ジョブステップのジョブステップID
$JS_SDATE | 自ジョブステップの開始日（YYYYMMDD形式） 自ジョブステップに到達した日付です。
$JS_STIME | 自ジョブステップの開始時刻（HHMMSS） 自ジョブステップ（アイコン）に到達した時刻です。
$JS_BF_JOBSTEPID | 一つ前に実行したジョブステップ（アイコン）のジョブステップID
$JS_BF_ENDCODE | 一つ前に実行したジョブステップ（アイコン）の完了コード

## ジョブステップと環境変数の関係

各環境変数がどのジョブステップで生成されるか、どのジョブステップで利用できるかを以下の表に示します。

環境変数 | ジョブステップ種別
--- | ---
開始系 | 実行系 | トリガ系 | 終了系
ス ケ ジ ュ ｌ ラ | 蓄 積 待 ち | フ ァ イ ル 待 ち | ユ ｌ テ ィ リ テ ィ 待 ち | ユ ｌ ザ ジ ョ ブ | D a t a M a g i c | 蓄 積 フ ァ イ ル 抽 出 | 蓄 積 フ ァ イ ル 置 換 え | 蓄 積 フ ァ イ ル 送 出 | 蓄 積 フ ァ イ ル 削 除 | 蓄 積 待 ち | フ ァ イ ル 待 ち | 終 了
$JF_JOBFLOWID *1 | △ | △ | △ | △ | ○ | ○ | △ | △ | △ | △ | △ | △ | ―
$JF_SDATE *1 | △ | △ | △ | △ | ○ | ○ | △ | △ | △ | △ | △ | △ | ―
$JF_STIME *1 | △ | △ | △ | △ | ○ | ○ | △ | △ | △ | △ | △ | △ | ―
$JF_[ジョブステップID]_SDATE | △ | △ | △ | △ | ○ | ○ | △ | △ | △ | △ | △ | △ | ―
$JF_[ジョブステップID]_STIME | △ | △ | △ | △ | ○ | ○ | △ | △ | △ | △ | △ | △ | ―
$JF_[ジョブステップID]_EDATE | △ | △ | △ | △ | △ | △ | △ | △ | △ | △ | △ | △ | ―
$JF_[ジョブステップID]_ETIME | △ | △ | △ | △ | △ | △ | △ | △ | △ | △ | △ | △ | ―
$JF_[ジョブステップID]_ENDCODE | △ | △ | △ | △ | △ | △ | △ | △ | △ | △ | △ | △ | ―
$JF_[ジョブステップID_蓄積識別名]_SELECTFILENM | ― | ― | ― | ― | ― | ― | △ | ― | ― | ― | ― | ― | ―
$JF_[ジョブステップID_蓄積識別名]_[HULFT環境変数名] | ― | △ | ― | ― | ― | ― | ― | ― | ― | ― | △ | ― | ―
$JS_JOBSTEPID | ― | ― | ― | ― | ○ | ○ | ― | ― | ― | ― | ― | ― | ―
$JS_SDATE | ― | ― | ― | ― | ○ | ○ | ― | ― | ― | ― | ― | ― | ―
$JS_STIME | ― | ― | ― | ― | ○ | ○ | ― | ― | ― | ― | ― | ― | ―
$JS_BF_JOBSTEPID *2 | ― | ― | ― | ― | ○ | ○ | ― | ― | ― | ― | ― | ― | ―
$JS_BF_ENDCODE *2 | ― | ― | ― | ― | ○ | ○ | ― | ― | ― | ― | ― | ― | ―
$JF_MESSAGE0～5 | ― | ― | ― | ― | ◇ | ◇ | ― | ― | ― | ― | ― | ― | ―

*1： | 定義実行、即時起動、リランのいずれかによってジョブフローが起動される際、一番目に実行されるジョブステップでのみ生成されます。
*2： | リラン時に一番目に実行されるジョブステップでは生成されません。

【凡例】

○ | ジョブステップ実行時に環境変数が生成され、当該ジョブステップ内の処理で環境変数を利用できます。
△ | ジョブステップ実行時に環境変数は生成されますが、当該ジョブステップ内の処理で環境変数を利用することはできません。
◇ | ジョブステップ実行時に環境変数は生成されませんが、当該ジョブステップ内の処理で環境変数を利用できます。
― | ジョブステップ実行時に環境変数は生成されず、当該ジョブステップ内の処理で環境変数を利用することもできません。