使用できるプロパティーは、コンテキストによって異なります。例えば、コンポーネント・プロセスでは、現行コンポーネントのコンポーネント・プロパティーにアクセスできます。アプリケーション・プロセスでは、アプリケーション・プロパティーおよび環境プロパティーにアクセスできますが、コンポーネント・プロパティーにはアクセスできません。以下の表は、各タイプのプロパティーを使用できるプロセスを示しています。
プロセスで使用できるプロパティーを参照するには、そのプロセスを実行します。プロセスが終了したら、プロセス要求の「プロパティー」タブに移動します。このタブには、プロセスで使用できるプロパティーがすべてリストされます。
| プロパティー・タイプ | プロパティーにアクセスできるプロセス | 構文例 |
|---|---|---|
| 汎用プロセス・プロパティー | 汎用プロセス | ${p:ProcessProp1} |
| アプリケーション・プロセス・プロパティー | アプリケーション・プロセスおよびコンポーネント・プロセス | ${p:ProcessProp1} |
| コンポーネント・プロセス・プロパティー | コンポーネント・プロセス | ${p:componentProcess/ProcessProp1} |
| コンポーネント・バージョンのプロパティー | デプロイメントおよび運用 (バージョン付き) などのバージョンを含む、コンポーネント・プロセス・タイプ | ${p:version/VersionProp1} |
| リソース・プロパティー | すべてのプロセス | ${p:resource/ResourceProp1} |
| 環境プロパティー | コンポーネント・プロセスおよびアプリケーション・プロセス | ${p:environment/EnvProp1} |
| アプリケーション・プロパティー | アプリケーション・プロセスおよびコンポーネント・プロセス | ${p:application/AppProp1} |
| システム・プロパティー | すべてのプロセス | ${p:system/SystemProp1} |
| 要求プロパティー | すべてのプロセス |
|
| コンテキスト | 説明 |
|---|---|
| 環境 | コンポーネントまたは環境の「プロパティー」タブにあります。 参照先: ${p:environment/propertyName} どちらのバージョンも同じ構文を使用します。コンポーネント環境で設定された値は、環境プロパティーで直接設定された同名の値をオーバーライドします。コンポーネント環境プロパティーは、プロパティーを集約し、タイプやデフォルト値を追跡するなどの場合に便利です。環境プロパティーは、プロパティーと値のペアのリストを随時提供します。 |
| リソース | 環境内で同じ値を持つプロパティーをすべて選択します。 |
| リソースの役割 | リソース内で同じ値を持つプロパティーをすべて選択します。 |
| アプリケーション | アプリケーションの「プロパティー」タブ () にあります。 参照先: ${p:application/propertyName}。 |
| コンポーネント | システム内で同じ値を持つプロパティーをすべて選択します。 |
| プロセス | アプリケーションの「プロパティー」タブ () にあります。 参照先: ${p:application/propertyName}。 プロセス・ステップは、プロセス内の他のステップにより既に設定されているプロパティー、コンポーネント・プロセスを開始したアプリケーションが設定したプロパティー、ターゲット環境およびリソース上のプロパティーにアクセスできます。ステップ・プロパティー値は、コンポーネント・プロセスが終了すると使用できなくなります。 参照先: ${p:propertyName}。 |
| システム | システム (グローバル) プロパティーは、「設定」タブ () にあります。 参照先: ${p:system/propertyName}。 |
| プロパティー | 説明 |
|---|---|
| version.name | そのバージョンを他のバージョンと区別するためにユーザーが定義する名前。バージョン名は、新しいバージョンをインポートする際に入力されます。 |
| version.id | バージョンに割り当てられた番号。バージョン ID は、新しいバージョンを CodeStation にインポートする際に作成されます。 |
| component.name | そのコンポーネントを他のコンポーネントと区別するためにユーザーが定義する名前。コンポーネント名は、新しいコンポーネントを作成する際に入力されます。 |
| component.id | そのコンポーネントを他のコンポーネントと区別するために IBM® UrbanCode Deploy が割り当てる固有の番号。コンポーネント ID は、コンポーネントを IBM UrbanCode Deploy で作成する際に作成されます。 |
| resource.name | そのリソースを他のリソースと区別するためにユーザーが定義する名前。リソース名は、リソースを編集する際、または新しいリソースを作成する際に入力されます。 |
| resource.id | リソースに与えられる固有の番号。リソース ID は、新しいリソースを作成する際に割り当てられます。 |
| application.name | そのアプリケーションを他のアプリケーションと区別するためにユーザーが定義する名前。アプリケーション名は、アプリケーションを編集する際、または新しいアプリケーションを作成する際に入力されます。 |
| application.id | アプリケーションに与えられる固有の番号。アプリケーション ID は、新しいアプリケーションを IBM UrbanCode Deploy で作成する際に割り当てられます。 |
| environment.name | その環境を他の環境と区別するためにユーザーが定義する名前。環境名は、環境を編集する際、または新しい環境を作成する際に入力されます。 |
| environment.id | 環境に与えられる固有の番号。環境 ID は、新しい環境を作成する際に割り当てられます。 |
| agent.id | そのエージェントを、同様の名前を持つ他のエージェントと区別するために、IBM UrbanCode Deploy が与える固有の番号。エージェント ID は、エージェントをシステムにインストールする際に割り当てられます。 |
| agent.name | そのエージェントを他のエージェントと区別するためにユーザーが定義する名前。エージェントの名前は、そのエージェントの conf/agent/installed.properties ファイルを編集してからエージェントを再始動することで入力できます。 |
| stepname、propertyname | ステップにはいずれも、exitCode、status、lines of interest (LOI: 後処理スクリプトがステップの出力ログで検索する項目) の各プロパティーが存在します。 コンポーネントの「ログ」ペイン () を使用してこれらのプロパティーを表示し、ステップの出力ログを調べることができます。 インベントリーおよびバージョンの状況は status プロパティーで定義されますが、これらはアプリケーションの承認ゲートで使用できます (環境ゲートを参照)。その他のプロパティーは、後処理スクリプトで使用できます。プラグインの作成を参照してください。 後処理スクリプトを使用して、同じプロセス内の他のステップで使用可能な出力プロパティーを設定できます。これによって複雑なワークフローが可能になります。以前のステップ出力プロパティーは次のように参照します。 ${p:stepName/propName} 例えば、後処理スクリプトから環境プロパティーを設定するには、そのステップの出力プロパティーを後処理スクリプト内で設定します。その後、その出力プロパティーを使用する Set Environment Property ステップを使用します。 |
| property_name | コンポーネントまたはアプリケーション・プロセス・プロパティー。プロセスの「プロパティー」タブで定義されます。値はプロセスの実行者によって与えられます。 |
| component/property_name | コンポーネントのカスタム・プロパティー。コンポーネントの「プロパティー」タブで設定されます。 |
| environment/property_name | 環境プロパティー。コンポーネントまたは環境の「プロパティー」タブで定義されます。使用する構文はどちらも同じですが、後者は特定のコンポーネントとは関連付けられていません。値は関連付けられている環境またはコンポーネントで提供されます。コンポーネント環境で設定された値は、環境プロパティーで直接設定された同名の値をオーバーライドします。 |
| resource/property_name | リソース・プロパティー。これらのプロパティーには、組み込みのエージェント・プロパティーと、任意のカスタム・プロパティーが含まれる場合があります。リソースには、これらのプロパティーのそれぞれについてタブが用意されています。 |
| resource/role_name/property_name | リソースの役割プロパティー。これらのプロパティーは「リソースの役割」で定義され、値は、リソースに役割を追加する際に設定されます。 |
| application/property_name | アプリケーションのカスタム・プロパティー。これらのプロパティーは、アプリケーションの「プロパティー」タブで設定されます。 |
| system/property_name | グローバル・システム・プロパティー。これらのプロパティーは、「設定」エリアの「システム・プロパティー」タブで設定されます。 |
以下はすべて、一連の名前と値のペアをコンマで区切ったものです。オブジェクトの各プロパティーもこれに含まれます。これはトークンの交換の際に便利です。
| プロパティー | 説明 |
|---|---|
| component/allProperties | コンポーネント内で同じ値を持つプロパティーをすべて選択します。 |
| environment/allProperties | 環境内で同じ値を持つプロパティーをすべて選択します。 |
| resource/allProperties | リソース内で同じ値を持つプロパティーをすべて選択します。 |
| system/allProperties | システム内で同じ値を持つプロパティーをすべて選択します。 |