システム変数のリファレンス
変数では、システム定義変数を使用することができます。
システムは、ジョブの各ステップで以下の変数の値を自動的に設定します。 これらの変数は読み取り専用です。 ジョブに対してのそれらの値は、ステップ・ログの ENV 行にリストされています。 最初の 4 つはプロジェクト・レベルの通知です。 その他のすべての BF_ 変数は、ステップ・レベルで使用されます。
プロジェクト・レベルの変数 | 値 |
---|---|
BF_D | 日付。 タグで使用できます。フォーマットは、「タグ: 日付書式」システム設定で決定されます。 |
BF_J | 通算で表す年の日。 タグで使用できます。 |
BF_T | 時間。タグで使用できます。フォーマットは、Tag: Time Format システム設定で決定されます。 |
BF_W | 曜日。0 (日曜) から 6 (土曜) までの数値で表されます。 |
ステップ・レベルの変数 | 値 |
---|---|
BF_D | 日付。 タグで使用できます。フォーマットは、「タグ: 日付書式」システム設定で決定されます。 |
BF_J | 通算で表す年の日。 タグで使用できます。 |
BF_T | 時間。タグで使用できます。フォーマットは、Tag: Time Format システム設定で決定されます。 |
BF_W | 曜日。0 (日曜) から 6 (土曜) までの数値で表されます。 |
BF_AGENT_PLATFORM | エージェントを実行中のオペレーティング・システム・プラットフォームを識別するストリング。 |
BF_AGENT_VERSION | 現行サーバーのエージェントのバージョン番号。 |
B | デフォルトのタグ変数。1 から始まり、ジョブごとに増分します。 BF_TAG で表されるタグの中で使用できます。 |
BF_BID | 同一プロジェクトのジョブに対する固有のジョブ ID 番号。 |
BF_CALLER_ | 呼び出し側プロジェクトから、チェーニングされたプロジェクトに渡される変数に適用される接頭部。 |
BF_CLASS | プロジェクトの Build Forge クラス。 |
BF_ENGINE | エンジンを一意的に識別するストリング。 この値は、インストール・ディレクトリーに格納されているファイル engine.id にも保管されます。 例: D8531015-6C07-1014-8CA0-BD58317220B3。 |
BF_HOST | 論理サーバーのホスト名 (TCP/IP ホスト名)。 (この変数はサーバー環境変数の 一部です。) |
BF_ITERATION | While ループ内のステップが正常に開始された回数。 これは、ステップの条件の評価結果が TRUE である場合に増分されます。 ジョブの再開時には、再開すべき反復として、この変数の値が使用されます。 |
BF_ITERATION_MAX | While ループを実行可能な最大回数。 これはステップのプロパティーで設定されます。 |
BF_ITERATION_MAX_REACHED | デフォルトでは作成または設定されません。 While ループの反復回数が BF_ITERATION_MAX に達すると、この変数に While ループ・ステップのステップ固有の ID (BF_SSID) が付加 されます。 1 つのプロジェクト内の複数の While ループ・ステップがその BF_ITERATION_MAX に達した場合、この変数には、複数の値 (その最大反復回数に達したステップごとに 1 つずつ) が含まれます。 |
BF_LASTGOODRUN | 同一プロジェクトの最終引き渡しジョブの日付。引き渡しジョブが存在しない場合は最終ジョブの日付。 |
BF_LASTGOODTAG | 最後の引き渡しジョブ (または、同一プロジェクトの保管済み引き渡しジョブがない場合は、最後のジョブ) のタグ。 |
BF_LASTGOODUNIX | BF_LASTGOODRUN と同じ。 ただし、日付は UNIX® フォーマットで表します。 |
BF_LASTRUN | 現行ジョブの前回の実行日付。 |
BF_LASTTAG | 同一プロジェクトの前回のジョブのタグ・ストリング。 |
BF_LASTUNIX | BF_LASTRUN と同じ。 ただし、日付は UNIX フォーマットで表します。 |
BF_ONFAIL | ステップの停止/継続フラグ。 |
BF_PID | プロジェクト ID 番号。 |
BF_PROJECTNAME | このジョブのプロジェクトの名前。 |
BF_PROJECTNAME_PHYS | プロジェクト・ディレクトリーを作成するときに使用されるプロジェクト名。 システムは、プロジェクト・ディレクトリーを作成するため、「無効な相対ディレクトリー文字」システム設定で指定された文字を下線文字に変更します。 例えば、設定値にスペースが含まれる場合、「My Project」という名前のプロジェクトは、「My_Project」という名前のプロジェクト・ディレクトリーを受け取ります。 |
BF_ROOT | ジョブのプロパティーから取得された、ジョブの基本作業ディレクトリー。 BF_STEP_ROOT も参照してください。 |
BF_SERVER | 現行ジョブを実行しているサーバーの名前 (この変数はサーバー環境変数の 一部です)。 |
BF_SERVER_ROOT | サーバーのプロパティー内で論理サーバーに割り当てられたパス (この変数はサーバー環境変数の 一部です)。 |
BF_SID | ビルド内のステップ結果のシーケンス番号。 |
BF_SPID | 現行ジョブが別のジョブによって呼び出された場合、その呼び出し側プロジェクトの ID が含まれています。 呼び出されていない場合、この値は BF_PID と同じです。 |
BF_STEPNAME | ステップ名。 ステップのプロパティーで設定されます。 |
BF_STEP_ROOT | ステップのプロパティーから取得された、ステップの基本作業ディレクトリー。 BF_ROOT も参照してください。 |
BF_SSID | ステップ ID。プロジェクトの現行ステップに対する固有 ID です。 |
BF_TAG | ジョブのタグ。 タグ定義には、変数を含めることができます。 この変数には、ジョブの開始時にそれらの変数を解釈した結果として得られた値が含まれています。 |
BF_TAG_PHYS | BF_TAG 値内のすべてのスペースを下線で置き換えた、ジョブのタグ。 ステップで「絶対」オプションが選択されている場合、BF_TAG_PHYS は BF_TAG と同じになります。 |
BF_USER | ジョブ所有者のユーザー名。 |