付録B.2 アイテム実行時の環境変数の使用方法
CPAでは,ジョブ内のアイテム実行時に,ジョブの情報を環境変数で参照することができます。ここでは,アイテム実行時の環境変数の使用方法について説明します。
- 〈この項の構成〉
(1) アイテム実行時の環境変数
CPAのジョブ内で実行する[コマンド実行]や[コマンド実行(画面表示)]などのアイテムから実行するコマンドでは,次の表に示す環境変数を使用できます。
項番 |
環境変数名 |
設定される値 |
---|---|---|
1 |
CPAJDS |
ジョブ名 ジョブ登録時の「ジョブ名」に指定した値。 |
2 |
CPAJCS |
ジョブ実行ID 実行予定を生成した際にCPAが割り振る,36文字の半角英数字(16進数値)の文字列。他のジョブのジョブ実行IDや,過去の実行結果のジョブ実行IDとも重複しないIDです。 (例)e66bf2f5-b920-4faf-b1f0-a56418af4682 |
環境変数(CPAJDS,CPAJCS)は,CPAから実行するコマンド内で参照できます。例えば,実行するコマンドがバッチファイルの場合は,バッチファイル内で環境変数を指定します。
また,実行するコマンドに指定するパラメーターに定義して使用することができます。環境変数(CPAJDS,CPAJCS)を定義できる設定項目を次の表に示します。
項番 |
種別 |
アイテム名 |
定義できる設定項目 |
---|---|---|---|
1 |
アクション |
コマンド実行 |
パラメーター |
2 |
コマンド実行(リスト実行) |
パラメーター |
|
3 |
コマンド実行(リカバリー実行) |
|
|
4 |
コマンド実行(画面表示) |
パラメーター |
|
5 |
メール送信 |
− |
|
6 |
Windowsログオン |
− |
|
7 |
イベントモニター |
ファイル監視 |
− |
8 |
メール受信監視 |
− |
|
9 |
任意のイベント監視 |
パラメーター |
|
10 |
Windowsイベント監視 |
− |
|
11 |
実行条件 |
ファイルイベント監視 |
− |
12 |
メール受信イベント監視 |
− |
|
13 |
任意のイベント監視 |
パラメーター |
|
14 |
JP1AJS3からの連携監視 |
− |
|
15 |
Windowsイベント監視 |
− |
- (凡例)
-
−:定義できる設定項目はありません。
(2) 使用例
アクションフロー内のアクションが出力した結果を一時ファイルに出力し,後続のアクションで一時ファイルの内容を参照します。
この時,アクションフロー内で使用する一時ファイルが,同じアクションフローを使用する複数のジョブ間で競合しないように,環境変数(CPAJDS,CPAJCS)を利用して,ジョブごとにユニークなファイル名になるようにします。
- コマンド実行(画面表示)
-
- 実行コマンド
cmd
- パラメーター
/c sample1.bat >c:\temp\%CPAJDS%_%CPAJCS%.txt
- sample1.batの内容
@echo off echo %DATE% %TIME% echo CPAJDS:%CPAJDS% echo CPAJCS:%CPAJCS% cpasleep 10
- コマンド実行
-
- 実行コマンド
cmd
- パラメーター
/c sample2.bat c:\temp\%CPAJDS%_%CPAJCS%.txt
- sample2.batの内容
@echo off echo %DATE% %TIME% echo FILE:%1 echo ---------- type %1 echo ----------
このアクションフローを,ジョブ名をsampleAとして実行した実行例は,次のようになります。
-
最初のアクション「コマンド実行(画面表示)」で,次のファイルが作成されます。
- 実行したジョブ
-
ジョブ名:sampleA
ジョブ実行ID:cabc71f3-d402-4869-a651-1084fe7b7ae5
- 作成されるファイル名
-
c:\temp\sampleA_cabc71f3-d402-4869-a651-1084fe7b7ae5.txt
- 解説
-
変数%CPAJDS%の部分がジョブ名のsampleAになり,変数%CPAJCS%の部分がジョブ実行IDのcabc71f3-d402-4869-a651-1084fe7b7ae5に置き換わります。
-
次のアクション「コマンド実行」の出力結果は,最初のアクションで作成されたファイルの内容が表示されます。なお,出力結果は,CPAのジョブ登録画面の[状態確認]ダイアログボックス−[実行結果確認]ダイアログボックスで確認できます。
<出力結果>
2020/09/25 15:19:46.03 FILE:c:\temp\sampleA_cabc71f3-d402-4869-a651-1084fe7b7ae5.txt ---------- 2020/09/25 15:19:35.59 CPAJDS:sampleA CPAJCS:cabc71f3-d402-4869-a651-1084fe7b7ae5 ----------