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

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

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

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

「詳細」タブ

環境変数のプロパティー

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

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

変数のプロパティー

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

名前
変数名には、 英数字 (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: コロン (:)
  • クリア: 値は空ストリングに設定されます。 「値」プロパティーに値が含まれる場合には、使用されません。
  • 削除 / 設定解除: 現在適用されている環境変数から変数が削除されます。 「値」プロパティーに値が含まれる場合には、使用されません。
  • 非表示の割り当て: システムは変数を割り当てますが、 ログで値を非表示にし、「*****」として表示します。プロジェクトを実行するユーザーには変数値が見えないようにする場合にこのオプションを使用します。
    重要: 非表示の変数に機密情報を格納する場合には注意が必要です。 データベースを検査したり、API クライアントを使用したりすることによって、非表示の変数の値を読み取ることが可能です。これらは、パスワードのような機密情報とは異なり、安全性が高いわけではありません。

    「非表示の割り当て」変数は、デフォルトでは編集できないように保護されています。 「非表示タグの編集」アクセス権のないユーザーはこれらの値を編集できません。 ただし、これらのユーザーは、該当するアクセス権があれば、値を削除および再作成することができます。 「非表示タグの編集」アクセス権のあるユーザーはこれらの値を直接編集できますが、使用する値を再入力することが必要です。 この動作はタイプを「設定」に変更するため、ユーザーは「非表示の割り当て」変数の値を表示できなくなります。

    注: あるステップの変数が「非表示の割り当て」に設定されている場合、 そのステップのすべての変数が、「非表示の割り当て」に設定されているように処理されます。
    注: 「非表示の割り当て」に設定された変数が適用されるのはプロジェクトのみです。「非表示の割り当て」に設定された変数がアダプターに渡されると、 非表示設定は解除されます。

    システムは通常、コマンド行の変数の構文を、 ご使用のオペレーティング・システムに適した形式に変更します (Windows® の場合は %VAR%、 Linux® と UNIX® システムの場合は $VAR)。これは、非表示の変数の場合には実行されません。 変数はサーバーに直接渡され、サーバーのオペレーティング・システム環境が変数を解釈します。

    したがって、これらのオペレーティング・システムで解析可能な変数名は使用しないでください。 例:
    • $name: この変数を「非表示の割り当て」に設定すると、UNIX または Linux システムで解釈する際、オペレーティング・システムは Build Forge 環境ではなく、自身の環境内で変数を解決しようとします。
    • %address%: この変数を「非表示の割り当て」に設定すると、Windows システムで解釈する際、オペレーティング・システムは Build Forge 環境ではなく、自身の環境内で変数を解決しようとします。
プロジェクト動作
ジョブを手動で開始したときの変数の使用方法を定義します。このプロパティーは、 プロジェクトに割り当てられている環境変数内で使用される変数にのみ有効です。 このプロパティーは、ジョブの実行中には変数に影響を与えません。値は、次のいずれかにできます。
  • 通常: プロジェクトへの割り当て時に、 変数は通常どおり動作します。
  • 必須: 変数に値が存在する必要があります。 このプロパティーを持つ変数は、「開始」パネルで強調表示されます。変数定義に定義されている値で問題ありません。 値を定義しないと、ジョブをクイック・スタートすることも、開始することもできません。

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

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

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

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


フィードバック