「環境変数」パネルについて

ご使用のプロジェクトの環境変数を作成したり管理したりするには「環境変数」パネルを使用します。パネルを表示するには、「環境変数」を選択します。

「環境変数」パネルに表示される環境変数のリスト

「環境変数」パネルでは、環境変数をクリックして、その変数を表示したり編集したりすることもできます。

「詳細」タブ

環境変数のプロパティー

次の環境変数のプロパティーを指定します。

名前
環境変数の名前。
アクセス
この環境変数を使用できるユーザーのアクセス・グループ。

変数のプロパティー

「環境変数」パネルで、変数パネルに表示する変数を選択します。変数パネルを使用して、以下のプロパティーを指定します。

名前
変数名には、 英数字 (a-z、A-Z、0-9) と下線文字 ( _ ) のみを使用できます。最大長は 255 バイトです。
  • 1 バイト文字セットの場合: 255 文字
  • 2 バイト文字セットの場合: 127 文字
変数値には、以下の特性があります。
  • 長さ: 値は任意の長さ (オペレーティング・システムで制限がある場合はその制限値まで) にできます。
  • 特殊文字: %、$、[、]、{、}、¥、 "、および ' の各文字には、事前構文解析 (OS 評価前) 用と オペレーティング・システムでの評価用の特殊な意味があります。これらの文字は使用しないでください。これらを受け渡すには円記号 (¥) でエスケープします。ステップにおける変数の解釈を参照してください。

    値が単一引用符で囲まれている場合、変数名は解釈されるのではなく、リテラルとして渡されます。 例えば、MyEnv='$env' という変数の代入では、変数 $env の値ではなく、ストリング $envMyEnv に代入されます。

  • 値の中の変数: 変数が変数値内にある場合、その変数を使用するステップの実行時にその変数が解釈されます。
  • プルダウン値: プルダウン変数に項目を指定するには、プルダウン・リスト に変数タイプを設定し、変数を保存してから、編集します。「プルダウン・オプション」タブをクリックして、プルダウンに項目を追加します。変数のプルダウンの作成を参照してください。
  • 値としてのドット・コマンド: ドット・コマンドの中には、環境変数の値として使用できるものがあります。 そのような場合、システムはドット・コマンドを他の値で置き換えます。変数でのドット・コマンドの使用を参照してください。
  • 復帰: 変数では、復帰は保管されません。 次の例のように、1 つの変数に複数行の値を割り当てできます。 ファイル text.txt の内容は変数 test に割り当てられています。
    .bset env "test = `type text.txt`"
    ファイル内では行は連結されます。 例えば、ファイルの内容が以下であったとします。
    A first line
    And a second line
    この変数の値は以下になります。
    A first lineAnd a second line
タイプ
変数には、次のいずれかのタイプが割り当てられます。
  • 標準 - デフォルトです。変数に値とアクションを割り当てることができます。
  • 組み込み - 変数値は別の環境変数を指し、その変数を組み込みます。環境変数内のすべての変数が組み込まれます。
    注:組み込み」変数タイプは、これまでのリリースで提供されていた .include 機能に代わるものです。
  • プルダウン・リスト - 変数には値セットが含まれ、ユーザーはこの中から選択できます。プルダウン・リスト変数が作成されたら、 それを選択し、「プルダウン・オプション」タブをクリックして、値を追加できます。
アクション

次のいずれかになります。

  • 設定: デフォルト・オプションです。指定された値が、 変数に割り当てられます。変数が存在しない場合は作成されます。
  • 設定 (未設定の場合): このアクションでは、 変数にまだ値がない場合にのみ、値を変数に割り当てます。 変数についてを参照してください。
  • 付加: 変数の現行値に値が付加されます。 値の間には、OS 固有のパス区切り文字が追加されます。
    • Windows: セミコロン (;)
    • UNIX または Linux: コロン (:)
  • 前に付加: 現行値の前に値が挿入されます。 値の間には、OS 固有のパス区切り文字が追加されます。
    • Windows: セミコロン (;)
    • UNIX または Linux: コロン (:)
  • クリア: 値は空ストリングに設定されます。 「値」プロパティーに値が含まれる場合には、使用されません。
  • 削除 / 設定解除: 現在適用されている環境変数から変数が削除されます。 「値」プロパティーに値が含まれる場合には、使用されません。
  • 非表示の割り当て: 値はデータベースにおいて暗号化され、 ログやユーザー・インターフェースでは「*****」のように表示されます。 このオプションは、機密情報を保管する場合に使用します。

    「非表示の割り当て」変数は、デフォルトでは編集できないように保護されています。 「非表示タグの編集」権限が設定されていない場合は、値を編集できません。 ただし、この権限が設定されていれば、値を削除したり再作成したりできます。 「非表示タグの編集」権限が設定されている場合は、値を編集して入力すれば、その値を使用できるようになります。 この動作ではタイプが「設定」に変更されるため、「非表示の割り当て」変数の値を表示できなくなります。

    環境変数の「アクション」値が「非表示の割り当て」である場合、変数の「タイプ」値および「アクション」値は変更できません。 環境変数の「アクション」値が「非表示の割り当て」でない場合、「アクション」を「非表示の割り当て」に変更することはできません。

    「非表示の割り当て」環境変数は、7.1.x エージェントでは機能しません。 「非表示の割り当て」環境変数を使用したい場合は、ご使用のエージェントを対応するバージョンに更新してください。 例えば、コンソール・バージョンが 8.0.0.1 である場合は、エージェント・バージョンを 8.0.0.1 に更新します。

    注: 値を長くすれば、その値はよりセキュアになります。
    注: 以前の「非表示の割り当て」変数がある場合は、Build Forge® ユーザー・インターフェースの「環境変数」ページで、その変数を編集して保存し直し、暗号化できます。 また、bfassignhiddenmigration ユーティリティーを使用すれば、バッチ・モードで暗号化を行うこともできます。 Build Forge 8.0 インストール済み環境では、「非表示の割り当て」値は変更されません。 Build Forge 7.x リリースからの古い「非表示の割り当て」変数値を保存し直したりアップグレードしたりしなかった 場合は、新しい「非表示の割り当て」機能を使用できません。 この動作は、7.x リリースで Perl エンジンを使用する場合と同じですが、 「非表示の割り当て」値は新規 Java™ エンジン・ステップ・ログで平文として表されます。 古い「非表示の割り当て」値を保存し直したり、bfassignhiddenmigration ユーティリティーを使用して、すべての「非表示の割り当て」値を 暗号化したりすることをお勧めします。 bfassignhiddenmigration ユーティリティーについて詳しくは、bfassignhiddenmigration リファレンストピックを 参照してください。
    注: ステップに含まれる変数の 1 つが「非表示の割り当て」 に設定されると、 そのステップに含まれる他のすべての変数がデフォルトで「非表示の割り当て」に設定されます。
    注: 例えば、マルチバイト文字システム (MBCS) 文字 (中国語、日本語、または韓国語) を持つ 「非表示の割り当て」変数を Build Forge 7.x で設定した場合、非表示マイグレーション・ユーティリティーは自動的にはアップグレードを行いません。 セキュリティーを強化するために、この変数を ASCII 文字で置き換えることをお勧めします。 これを行わないと、動作が Build Forge 7.x の場合と同じになるため、新規「非表示の割り当て」変数は使用できません。
プロジェクト動作
ジョブを手動で開始したときの変数の使用方法を定義します。このプロパティーは、 プロジェクトに割り当てられている環境変数内で使用される変数にのみ有効です。 このプロパティーは、ジョブの実行中には変数に影響を与えません。値は、次のいずれかにできます。
  • 通常: プロジェクトへの割り当て時に、 変数は通常どおり動作します。
  • 必須: 変数に値が存在する必要があります。 このプロパティーを持つ変数は、「開始」パネルで強調表示されます。変数定義に定義されている値で問題ありません。 値を定義しないと、ジョブをクイック・スタートすることも、開始することもできません。

    「必須」変数の含まれたジョブが、ユーザーではなくスケジューラーによって開始された場合、それらの変数は、現在値がある場合には変更されず、値がない場合にはブランクになります。

  • 読み取り専用: 値を変更することはできません。
  • 表示の抑制: 変数は「ジョブの開始」パネルに表示されません。 しかし、変数は存在していて、ステップで使用することができます。
  • 変更が必要: 変数値を変更する必要があります。 このプロパティーを持つ最上位の変数は、「開始」パネルで強調表示されます。新規の値を入力しなければ、ジョブをクイック・スタートすることも、開始することもできません。
    注: 「変更が必要」変数を含むジョブが、ユーザーではなくスケジューラーによって開始された場合、それらの変数値は変更されません。また、「変更が必要」変数を含むジョブがクラス・プロパティーによって開始された場合も、それらの変数値は変更されません。クラス・プロパティーには、「削除時に開始」、「設定時に開始」、「終了時に開始」などがあります。

「スナップショット」タブ

環境変数のスナップショットは、環境変数のインスタンスです。「スナップショット」タブには、スナップショットの名前が表示されます。スナップショット名やスナップショットに関するコメントを表示または変更する場合は、このタブを使用します。


フィードバック