ステップについて
ステップは、プロジェクトのコンポーネントです。プロジェクトをジョブとして実行すると、各ステップが順番に実行されます。 ステップには、1 つ以上のコマンドが含まれ、 その動作に影響を及ぼすステップ・プロパティーがあります。
「ステップ」パネルについて
「詳細」タブ
ステップ・プロパティーでは、ステップの実行方法、その出力の処理方法、およびステップ完了時に実行すべき操作を指定します。 ステップでは、 別のプロジェクトまたはライブラリーを実行することもできます。
ステップ・プロパティーを表示するには、プロジェクト内のステップを選択します。 「詳細」タブはデフォルトで表示されます。 ここにステップ・プロパティーが表示されます。
ステップ・プロパティーが明示的に設定されていない場合、その値はプロジェクトから継承されます。 ステップに設定されたステップ・プロパティーによって、継承された値がオーバーライドされます。
- 名前
- ステップの名前。 システムおよびログ内でステップのラベルとして使用されます。
- アクティブ
- ステップを実行するかどうかを指定します。 デフォルトでは、ステップは有効です。 ステップを実行しないようにするには、「無効」を選択します。 無効なステップは、ジョブで実行することはできません。
- ディレクトリー
- ステップ・コマンドが実行される場所を設定します。 システムは、ジョブごとに固有のディレクトリーを自動的に作成します。 「ディレクトリー」フィールドにより、ジョブ中にプロジェクトが構成したディレクトリーでコマンドを実行することが容易になります。 (Build Forge は、「ディレクトリー」フィールドに示されるディレクトリーを構成しません。)
- パス
- 「ディレクトリー」を絶対パスにするか、相対パスにするかを指定します。
- 相対: ステップ・コマンドは、サーバー、プロジェクト、ジョブおよびステップ・ディレクトリーを一緒に追加することで検出されるパスで実行されます。
- 絶対: ステップ・コマンドは、サーバーおよびステップ・ディレクトリーを一緒に追加することで検出されるパスで実行されます。このオプションを使用すれば、プロジェクト・ディレクトリー構造にないディレクトリーにアクセスすることができます。 例えば、サーバー上の常設アプリケーションを起動する場合に使用できます。
- ステップ・タイプ
- ステップの実行方法を決定します。 このプロパティーは、「コマンド」の内容および「インライン」で指定されたプロジェクト (ある場合) に影響します。
- 正規: ステップは一度実行されます。
- 条件付き: ステップは、「条件」プロパティーの式が true と評価された場合、一度実行されます。 「条件付き」を選択すると、「条件」、「Else インライン」および「Else コマンド」の各プロパティーが表示されます。 「条件」プロパティーで false と評価された場合は、コマンドとインラインは実行されません。 代わりに、Else コマンドと Else インラインが実行されます (指定されている場合)。
- While ループ: ステップを複数回実行できます。 「条件」プロパティーの式が false になるまで、または反復最大数に達するまで実行されます。 「While ループ」を選択すると、「条件」と「最大反復」の各プロパティーが表示されます。
セレクターは「While ループ」の各反復で評価され、反復に使用するサーバーが決定されます。
- インライン
- 現在のプロジェクトで、インラインで実行するプロジェクトまたはライブラリーを指定します。 プロジェクトまたはライブラリーのステップは、現在のプロジェクトの環境変数と大部分のプロパティーを使用して実行されます。 ただしシステムは、インラインのステップのデフォルトのセレクターとして、そのインライン・プロジェクトのセレクターを使用します。 これは、指定したプロジェクトのステップが 現行ステップの後にコピーされたように動作します。
- アクセス
- アクセス・グループを選択して、ステップの使用が許可されるユーザーを定義します。
このプロパティーを使用して、プロジェクト内にある特定ステップへのアクセスを制限できます。
あるステップに関するアクセス・グループのメンバーでないユーザーが、そのステップを含むプロジェクトを開始した場合、ステップはスキップされます。
「プロジェクト・デフォルト」を選択すると、 ステップはプロジェクトのアクセス・プロパティーを継承します。
- ステップ・プロバイダー
- ステップ・コマンド実行の実装環境。 デフォルトのステップ・プロバイダーは MJC ステップ・プロバイダーです。 このプロバイダーは、エンドポイント・エージェント・マシンでコマンド・テキストを実行するという、期待どおりのレガシー動作を提供します。
- 最大反復
- 「ステップ・タイプ」が「While ループ」の場合にのみ表示されます。 ループ内でステップを反復して実行可能な最大数を指定します。システム指定のデフォルト値は 100 です。 正常に完了 (成功) したステップはステップ・ログに表示されます。 最大反復値に達した場合はステップが失敗するように設定するには、「最大に達した場合ステップを失敗する」を使用します。
ジョブの実行中、読み取り専用の BF_ITERATION という変数には、正しく入力された反復数が格納されます。 ジョブを停止してから再始動した場合は、BF_ITERATION に格納された反復から再開されます。
- 最大に達した場合ステップを失敗する
- 「はい」に設定すると、「最大反復」値に達した場合に「While ループ」ステップが失敗します。 「いいえ」に設定すると、ステップは成功します。
- Else インライン
- 「ステップ・タイプ」が「条件付き」の場合にのみ表示されます。 指定した条件が false の場合はインラインで実行するようにプロジェクトを指定します。 デフォルト値は「いいえ」です。
- コマンド
-
1 つ以上のコマンドです。コマンドは、オペレーティング・システム・コマンド、ドット・コマンド、またはそれらを組み合わせたものにすることができます。 ステップの実行方法を参照してください。
- 条件
- ステップ・タイプに「条件付き」または「While ループ」を選択した場合にのみ表示されます。
- 条件付き: コマンドは、条件が true と評価された場合に実行されます。
- While ループ: コマンドは、条件が true と評価されている限り、複数回実行できます。 上限は「最大反復」を使用して設定できます。
条件として、選択したサーバー・リソースで実行される関数またはコマンドを指定することができます。
- 関数 を使用する場合には、「条件」フィールドの最初に指定する必要があります。 これは、Build Forge エンジンによって評価されます。 サーバー・リソースには送信されません。関数のリスト、および使用方法についての説明は、 条件関数を参照してください。
- コマンド は、選択したサーバーで実行されます。ここで使用するコマンドはすべて、 エージェントのシェル環境で有効である必要があります。実行時の戻りコードによって、条件の合格と不合格を判別します。
プロジェクトの Build Forge 変数は、条件式に使用できます。 変数の表現方法および評価方法について詳しくは、ステップにおける変数の解釈を参照してください。
- Else コマンド
- ステップ・タイプに「条件付き」を選択した場合にのみ表示されます。 条件が false と評価された場合に実行するコマンドを指定します。
- 環境変数
-
コマンドを実行する前に適用する環境変数を指定します。 この環境変数の値によって、サーバー環境変数、プロジェクト環境変数、およびステップ環境変数から継承されたすべての値がオーバーライドされます。
- セレクター
- このステップのサーバーを選択する際に使用するセレクターを指定します。 「デフォルト」のままにすると、ステップはプロジェクトのセレクターが決定したサーバーで実行されます。
- ブロードキャスト
- チェック・マークを付けた場合、現行のセレクター (指定した場合はステップ・セレクター。それ以外の場合はプロジェクト・セレクター) に適合するすべてのサーバーでステップが実行されます。 実行時にシステムは、ブロードキャスト・ステップを、サーバーごとに 1 つずつ一連のステップと置き換え、ブロードキャスト・ステップの「スレッド」プロパティーに応じて、連続的または同時にそれらを実行します。
再始動時のブロードキャスト・ステップ動作: ブロードキャスト・ステップが再始動されたとき、ブロードキャストは行われません。 その設定は、ステップの新規の開始にのみ適用されます。 再始動時に、エンジンによってステップ用の単一サーバーがランダムに選出されます。
- タイムアウト (分単位)
- 現行コマンドが出力を生成するまでシステムが待機する時間を分単位で指定します (デフォルト値は 5 分です)。 値 0 を指定すると、ステップがエージェントに正しく接続されている場合にはそのステップはタイムアウトになりません。タイムアウト値に達すると、システムでのステップは失敗します。 ステップを「障害時に続行 (Continue on Fail)」に設定しない限り、プロジェクトも失敗します。
- 結果
- 結果プロパティーは、ステップの成功または失敗をシステムがどのように判断するかを決定します。 終了コードのデフォルト値を使用して、コマンド・シェルによって戻される終了コードに基づいて、成功を判別します。 コマンド出力を確認する「ログ・フィルター」を選択することもできます。 選択する場合は、まず「ログ・フィルター」を作成する必要があります。
- 失敗動作
- ステップが失敗した場合にジョブを停止するか継続するかを指定します。 デフォルトでは、システムはジョブを停止します。
- スレッド
- 「はい」に設定した場合、このステップは他のステップと並行して実行されます。 このプロパティーを「はい」に設定して、このステップのスレッド化 (その他のステップと同時にステップを実行) を許可します。 プロパティーを「いいえ」に設定すると、スレッド化されません。 プロパティーを「結合」に設定すると、スレッド化ステップのブロックは分離されます。 ステップの最初のセットが完了してからでないと、「結合」ステップに続く、スレッド化ステップの次のセットを開始できません。
- 成功通知
- ステップが成功した場合に通知されるアクセス・グループを指定します。
- 成功チェーン
- 現行のステップが成功した場合に起動するプロジェクトを指定します。 (「警告」状況のステップは成功とみなされ、成功チェーンを起動します)。
- 成功待機
- チェック・マークを付けた場合、成功チェーン・プロジェクトが完了するまで、システムは現行プロジェクトを中断します。 このステップ (またはそのプロジェクト) を取り消した場合は、チェーン・プロジェクトも取り消されます。 これにチェック・マークを付けないと、チェーン・プロジェクトが非同期的に開始され、現在のプロジェクトは次のステップに進みます。
- 失敗通知
- ステップが失敗した場合に通知されるアクセス・グループを指定します。
- 失敗チェーン
- 現在のステップが失敗すると起動するプロジェクトを指定します。(障害時に続行するように設定されたステップは失敗とみなされ、そのステップに割り当てられたすべての失敗チェーンを起動します。)
- 失敗待機
- チェック・マークを付けた場合、失敗チェーン・プロジェクトが完了するまで、システムは現行プロジェクトを中断します。 このステップ (またはそのプロジェクト) を取り消した場合は、チェーン・プロジェクトも取り消されます。
「メモ」タブ
「メモ」タブには、ステップについて作成されたメモのタイム・スタンプ付きリストが含まれます。 メモは手動で作成します。 ステップ自体に対する編集内容は自動的に記録されません。 タブには、メモの現行数 (例えば、メモ (2)) が表示されます。
- 「メモ」タブをクリックします。
- テキスト・フィールドに新規メモを書き込みます。
- 「作成」をクリックします。
- 「メモ」タブをクリックします。
- 編集するメモの隣にある「編集」アイコン
をクリックします。 編集を行います。
- 「作成」をクリックします。
- 「メモ」タブをクリックします。
- 「ごみ箱」アイコン
をクリックします。 メモを削除してよいかどうかを確認するプロンプトが表示されます。
- 「OK」をクリックします。