Runbook のビルドとテスト

重要

このバージョンの Orchestrator はサポート終了に達しました。 Orchestrator 2022 にアップグレードすることをお勧めします。

Runbook Designerは、Runbook の作成、管理、実行に使用するツールです。 Runbook を実行し、 オーケストレーション コンソールでその状態を表示することもできます。

Runbook を構築するには、アクティビティをワークスペースにドラッグします。 アクティビティは Runbook の構成要素です。 一般に、個々の活動は次の 3 つの操作を実行します。

  • パブリッシュされたデータにアクセスする

  • 何らかの操作を実行する

  • 新しいデータを公開する

アクティビティの種類の詳細については、「Runbook アクティビティの 制御」を参照してください。

Runbook Designer のペイン

Runbook Designer のインターフェイスは、次の 4 つのペインに整理されています。

ペイン 説明
接続 Orchestrator システム内のワークフローを整理し、フォルダーに対するアクセス許可を編集できるフォルダー構造。 また、Runbook サーバーグローバル設定へのアクセスも提供します。
Runbook Designer workspace (Runbook Designer ワークスペース) Orchestrator Runbook を作成するワークスペース。 [Connections] ペインのフォルダー選択内の Runbook は、ワークスペースの上部にタブとして表示されます。 Runbook でタブを選択すると、Runbook Designer ワークスペースに表示されます。
アクティビティ Runbook で使用できるすべての活動 (標準活動または統合パックから使用できる活動) が含まれます。 [ アクティビティ ] ウィンドウから [デザイン] ワークスペースにアクティビティをドラッグし、それらをリンクして Runbook を形成します。
Log 現在の Runbook の活動と履歴を示すログ。 詳細については、「 Orchestrator ログ」を参照してください。

アクティビティ名とカテゴリ名によるアクティビティの並べ替え

Orchestrator を使用すると、アクティビティをアクティビティ名またはカテゴリ名でアルファベット順に並べ替えることができます。 既定では、活動はカテゴリ別 ([Runbook の制御]、[メール]、[ファイルの管理]、[監視]、[通知]、[スケジュール]、[システム]、[テキスト ファイルの管理]、[ツール] など) に並べ替えられます。

活動名とカテゴリ名で活動を並べ替えるには、次の手順に従います。

アクティビティ名でアクティビティをアルファベット順に並べ替える

  • [活動] ペインでカテゴリ名を右クリックし、 [すべての活動] を選択します。

    活動が、活動名でアルファベット順に並べ替えられます。

カテゴリ名でアクティビティをアルファベット順に並べ替える

  • [活動] ペインでカテゴリ名を右クリックし、 [Default] (既定値) を選択します。

    活動が、カテゴリ名でアルファベット順に並べ替えられます。

アイコンの変更

各アクティビティ アイコンの既定のサイズを小から大に変更するには、アクティビティ名を右クリックし、[ 小] または [ ] を選択します。

Designerで Runbook を開始する

Designerで Runbook を開始するには、次の手順に従います。

  1. [Connections] ウィンドウで、[Runbook] フォルダーを選択して、使用可能な Runbook を表示します。

  2. [デザイン] ワークスペースで、Runbook タブを選択します。

  3. Runbook が [チェックアウト済み] の場合は、[チェックイン] ボタンを選択します。

  4. [デザイン] ワークスペースで、[Runbook] タブを右クリックし、[ 実行] を選択します。

  5. [ Runbook の開始 ] ダイアログで、[ 使用可能な Runbook サーバー ] ボックスに移動し、該当するサーバーを選択します。

  6. [矢印] ボタンを選択して、サーバー名が [ 選択した Runbook サーバー] ボックスに表示されるようにします。

  7. [スタート] を選択します。

Runbook Designerからジョブを停止する

Runbook Designerからジョブを停止するには、次の手順に従います。

  1. [ Runbook の監視 ] タブを選択します。

  2. ツール バーの [停止] を選択 します

Runbook のテスト

Runbook をビルドした後は、運用環境で実行する前にテストできます。 テストするには、Runbook Designerで開始する Runbook Tester を使用します。 Runbook Tester を使用すると、Runbook を実行して、各アクティビティの発行済みデータを表示できます。 Runbook 全体を実行したり、各活動を一度に 1 つずつステップ実行したり、特定の活動にブレークポイントを設定したりできます。

重要

Runbook Tester は、ワークフロー内の各活動を実行します。 ステップは、シミュレート、つまり仮想化された環境で実行されるわけではありません。 Runbook で参照されるすべての接続はライブであり、完全に機能します。 そのため、接続されたシステム内のデータを変更または破棄するアクティビティでは、そのデータが変更または破棄されます。 たとえば、クエリ データベース アクティビティを使用して DROP TABLE ImportantTable を実行すると、実際には Microsoft SQL Server のインスタンスから ImportantTable が削除されます。

重要

Runbook の開始に使用されるアカウントを正常に実行させるには、そのローカル コンピューターのアクセス許可が必要となることに注意してください。 このアクセス許可の要件は、Runbook Tester で Runbook をテストする際にも適用されます。 Runbook を正常にテストするには、管理者として Runbook Designerを開始します。 関連付けにより、Runbook Tester は 管理者として 実行され、より高いレベルのセキュリティ トークンを使用します。

Runbook をテストする

Runbook をテストするには、次の手順に従います。

  1. Runbook Designerで Runbook を開き、メニュー バーで [Runbook Tester] を選択します。

  2. プロンプトが表示されたら、[はい] を選択して Runbook をチェックします。

  3. Runbook を停止せずに最初から最後まで実行するには、[ ブレークポイントまで実行] を選択します。

    一度に 1 つのアクティビティをステップ実行する場合は、[ステップ] を選択 します

  4. [ログ] ペインを表示して、各アクティビティの完了状態を確認します。 アクティビティの詳細と発行済みデータを表示するには、アクティビティを選択し、[ 詳細の表示] を選択します。

ブレークポイントの設定

ブレークポイントを設定するには、次の手順に従います。

  1. ブレークポイントを設定するアクティビティを選択します。

  2. [ ブレークポイントの切り替え] を選択します

  3. [ ブレークポイントに実行] を選択します

    ブレークポイントまでの各活動が実行されます。 Runbook は、ブレークポイントを設定した活動アクティビティを実行する前に一時停止します。

  4. Runbook の最後まで進むには、もう一度 [ ブレークポイントに実行 ] を選択するか、一度に 1 つのアクティビティをステップ実行するには、[ステップ] を選択 します

次の手順

  • サンプル Runbook のビルドとテストの詳細な手順については、「サンプル Runbook の 作成とテスト」を参照してください。
  • Runbook の設計に関するガイダンスとベスト プラクティスについては、「Runbook の 設計」を参照してください。