トリガー変数のリファレンス

システムは、以下の変数名を監視します。ステップの環境変数が、 これらの変数のうちの 1 つを (具体的に指定して、 あるいはプロジェクトまたはサーバーから継承して) 含む場合に、アクションが実行されます。

変数

内容

_CI_BUILD_DELETE

任意の値にこの変数を設定して、ジョブ実行後のビルドおよび 関連のビルド・データを削除する。(その他のプロジェクト・ビルドが実行されない場合、 タグ変数は、ビルドの削除の前に、その初期値にリセットされます。)

_CI_BUILD_KEEP

任意の値にこの変数を設定して、ジョブ実行後のビルドおよび関連のビルド・データを保持する。例えば、ジョブがアダプター・リンクを含み、そのアダプター・ステップが失敗した場合、その他のプロジェクト・ステップは実行されません。ジョブのビルド・レコードのコピーを、デバッグなどのため、保持してください。

CLEARCASE_VIEW

指定された ClearCase ビューを開始する。この変数で指定されるビューが存在しており、この変数を使用するステップが「絶対」に設定されている必要があります。Microsoft Windows が稼働しているシステムでは、bfagent.conf 内のエージェントの cc_suppress_server_root 構成オプションで、この変数を使用する必要があります。

_CLEARCASE_VIEWS

コマンドを実行する前に開始する ClearCase ビューのリストを指定する。 ビューのコンマ区切りのリストに値を設定します (「View1,View2,View3」など)。

_CLEARCASE_VOBS

コマンドを実行する前にマウントする ClearCase VOB のリストを指定する。 VOB のコンマ区切りのリストに値を設定します (「¥Vob1,¥Vob2,¥Vob3」など)。

_CONTEXT_LOG_RANGE

この変数を使用して、ログ出力を、フィルターの突き合わせが行われた周辺の行に限定する。 これは正整数の値をとり、この変数によってシステムは、 各フィルター・ストリングでヒットした行の周辺にある行 (その範囲のサイズはこの変数の値に 等しい) 以外のログ出力を省略します。例えば、 変数に 5 を設定した場合、ログは、フィルターの突き合わせが行われた行と、その行の前後にある各 5 行のみを表示します。

_ERROR_THRESHOLD

エラー (定義した「失敗の設定」フィルターでキャッチされたもの) の最大許容数を設定する。 この変数を使用すると、個々のステップまたはプロジェクトに対して、失敗およびメッセージのしきい値を設定することができます。

次のいずれかの形式を使用します。

  • 値 5 または F5 は、5 個を超えるエラーが発生した場合にそのジョブが失敗となることを示します。
  • 値 N7 は、7 個を超えるエラーが発生した場合に、システムによりジョブの注釈にメッセージが追加されることを示します。 そのメッセージとは、このしきい値に達したことを示すものです。

ステップでこの変数を使用すると、システムは、個々のステップのエラーをカウントします。 以下の追加フォームを使用できます。

  • W9 のような値は、9 つのエラーの後、フィルターでキャッチされるその後のエラーとは無関係に、ステップは警告状態となることを意味します。
  • C8 のような値は、8 つのエラーの後、ステップは失敗状況に設定されますが、任意の「失敗のクリア」フィルターで失敗をクリアできます。

注: この変数でカウントされたエラーは、 「失敗の設定」アクション付きのフィルターに一致するストリングとして定義され、プロジェクトのステップに割り当てられます。 フィルターによって失敗として識別された各ストリングは、ステップ合計に対する 1 つのエラー、およびプロジェクトの合計に対する 1 つのエラーとしてカウントされます。

_EXITCODE_MAP

システムが、ステップ成功の指標として受け入れる必要がある (コンマ、スペース、セミコロン、またはコロンで区切られた) 番号のリストを指定する。 デフォルトでは、0 の終了コードは成功を示します。この変数が指定されると、この変数にリストされた値はすべて、成功を意味します。

_InterfaceLoggingLevel

アダプター・ステップの実行時に、Build Forge がログに記録するログ・データの数を制御する。_InterfaceLoggingLevel という名前で、環境変数を (アダプター環境変数に) 作成します。 それに、0 から 8 の範囲にある整数値を割り当てます。ロギング・レベルは包括的で、例えば、レベル 2 は、レベル 1 および 0 の情報を含みます。
  • 0: 実行行およびサーバー接続エラー、またはキャンセル通知。他はなし。
  • 1: 構文解析済みのコマンド (サーバーに送信されるコマンド)
  • 2: 構文解析済みでないコマンド (ローカル変数が設定される前のコマンド)
  • 3: ビルドおよび環境変数の SET 行
  • 4: 一時および内部変数 SET 行
  • 5: 環境変数の評価、E メール・グループの追加、BOM テキスト・ロギングの行
  • 6: ブロックおよびサブブロックの開始/終了行
  • 7: (デフォルトのロギング・レベル) 一致パターンに対するチェックが行われるエージェント出力、およびパターンに一致した行
  • 8: すべてのエージェント出力

_LOG

Build Forge エージェントのロー出力が含まれるログ・ファイルを作成するパス名を指定します。

注: このログには、 _LOG_TIMESTAMP がともに指定されていない限り、タイム・スタンプが含まれません。 このファイル内のログ・データは通常、エージェント・コード、ログ・バケット、およびメッセージのようにフォーマット設定されています。

この変数を使用して、ジョブ・ログのコピーをサーバーに保存します。 ファイルが存在している場合、システムはそのファイルに追加します。

_LOG_TIMESTAMP

_LOG からの出力の各行の先頭にタイム・スタンプを付加する。 この変数の値は、.date および .gmdate 環境変数コマンドにより使用される strftime 構文と同じ書式制御ストリングである必要があります。

注: _LOG とともに指定する必要があります。

_MAP

この変数の使用法に関する考察については 、Windows ドライブのマッピングを参照してください。

_NO_PREPARSE_COMMAND

通常、システムは、コマンドをエージェントに送信する前に、環境変数の値を解決しようとする。_NO_PREPARSE_COMMAND 変数が (任意の値によって) 定義されると、システムは、変数を解決せずにそれをエージェントに送信します。 この変数を使用すると、オペレーティング・システム・シェルで変数を操作できるようにします。

_PRISM_DIR_POSTCMD

IDE のプラグインで使用される。プロジェクト・ステップが実行された後でディレクトリーに対して実行される、コマンドを指定します。テスト・プロジェクト用の特殊変数を参照してください。

_PRISM_DIR_PRECMD

IDE のプラグインで使用される。ディレクトリーがプロジェクト・ステップ用のサーバーにコピーされる前にそのディレクトリーに対して実行される、コマンドを指定します。テスト・プロジェクト用の特殊変数を参照してください。

_PRISM_FILE_POSTCMD

IDE のプラグインで使用される。プロジェクト・ステップが実行された後でファイルに対して実行される、コマンドを指定します。テスト・プロジェクト用の特殊変数を参照してください。

_PRISM_FILE_PRECMD

IDE のプラグインで使用される。ファイルがプロジェクト・ステップ用のサーバーにコピーされる前にそのファイルに対して実行される、コマンドを指定します。テスト・プロジェクト用の特殊変数を参照してください。

_SUPPRESS_ENV_OUTPUT

システムがログに環境変数メッセージを出力しないように指定する。デフォルトではこの変数は設定されておらず、ステップ・コマンドの実行前に、環境変数のすべての変数値が出力されます。値は、ステップ・ログに ENV 項目として表示されます。変数に設定できる値は 次のとおりです。
  • ALWAYS: ENV メッセージを常に省略します
  • その他の任意の値: ENV メッセージを省略します。ただし、コマンドが失敗した場合は、 コマンド・メッセージの後に ENV メッセージが出力されます。この情報は、コマンド実行障害をデバッグする際に役立つことがあります。

_SUPPRESS_AGENT_LOG_OUTPUT

1 に設定すると、エージェントはログ・データをエンジンに送信できません。 _SUPPRESS_LOG_OUTPUT と比較してください。 こちらの場合、ログ・データはエージェントから送信されますが、エンジンによって除去されます。

注: この変数を使用した場合、フィルターの突き合わせは実行されません。

_SUPPRESS_LOG_OUTPUT

1 に設定すると、エージェントから受け取ったログ出力の大半がエンジンによって除去されます。 一部のコンソール・ログ・メッセージは残ります。 「フィルタリングする突き合わせ」が示されます。

_TIMEOUT

プロジェクトにある 1 つまたはすべてのステップのタイムアウト・プロパティーを指定変更する値。

_TRAP

現在のステップが失敗した場合に実行されるストリング。このストリングには、実行可能ファイルまたはコマンドの名前を設定できます。 注: コマンドの出力はコンソールには戻されません。これは、ステップが失敗すると、コンソールとエージェントの間の接続が閉じるためです。_TRAP を介して発行されたコマンドからの出力を保持したい場合は、後で取得できるように、コマンドを使って、その出力をファイルに書き出します。

_USE_BFCREDS

これが 1 に設定されると、システムは、サーバーに付与された サーバー権限に保管された資格情報ではなく、ユーザーの ログイン資格情報を使用して、サーバーにログインする。 システムは、プロジェクトを開始して、そのプロジェクトでコマンドを実行したユーザーの、管理コンソールのログイン資格情報を使用します。この変数を単一ステップに対して、またはプロジェクト全体に対して設定することができます。
注: LDAP/アクティブ・ディレクトリー認証を使用している場合、_USE_BFCREDS 関数を機能させるためには「ユーザー認証のローカル保管」システム設定を Yes (デフォルト値) に設定する必要があります。この設定が「はい」の場合、システムは、ユーザー認証情報を暗号化された形式でキャッシュに入れます。これにより、_USE_BFCREDS で使用するためにユーザー認証情報にアクセスできるようになります。
ヒント: Windows の場合、変数 _USE_BFCREDS_DOMAIN の設定も検討してください。

_USE_BFCREDS_DOMAIN (Windows のみ)

1 に設定すると、システムは、_USE_BFCREDS がサーバーへのログインに使用するログイン資格情報のほかに、ユーザーの ドメインを使用します。

_XSTREAM_PROTOCOL type

エージェント間の直接ファイル転送を有効にします。
重要: いくつかのオペレーティング・システム上のエージェントでは、直接ファイル転送のサポートが制限されているか、または直接ファイル転送がサポートされていません。 エージェント間の直接ファイル転送を構成するを 参照してください。

エンジン、送信側エージェント、および受信側エージェントのすべてで、直接ファイル転送がサポートされていることが必要です。 いずれかでサポートされていないと、_XSTREAM_PROTOCOL は警告なしで無視され、通常のファイル転送方式が使用されます。

受信側エージェントは、送信側エージェント・ホストで TCP 接続を作成可能であることが必要です。 接続が存在する場合は、ファイアウォールが接続を許可するように構成されていなければなりません。

プロトコル・タイプ によって、データのエンコード方式が決まります。 以下のタイプがあります。

AES-CBC
強力な暗号アルゴリズムがデータのエンコードに使用されます。 エージェントはどちらも、OpenSSL でコンパイルされ、エンジンとの通信に SSL を使用する必要があります。 暗号鍵はエンジンから得られます。
PRNG
疑似乱数生成プログラムがファイル内容の隠蔽に使用されます。
PLAIN
ファイルはエンコードなしでそのまま転送されます。

フィードバック