ハンドブック シミュレータを使用する

ハンドブック シミュレータを使用すると、時間と労力を削減してハンドブックを開発できます。

ハンドブック シミュレータには、次のような主な機能があります。

• 本番前環境で作業することで、本番環境のデータに影響を与えることなくアクションをテストし、結果を確認できます（特にプレイブックが無効になっている場合）。
• 個々のプレイブックのステップまたはブロックのテストを容易にし、ワークフローが想定どおりに動作することを確認します。
• プレイブック内の考えられるすべての条件分岐をテストし、包括的なカバレッジと予測可能な動作を確認します。

ハンドブックでハンドブック シミュレータを使用する

既存のハンドブックを使用する場合でも、新しいハンドブックを作成する場合でも、ハンドブックを使用するときは、必ずハンドブック シミュレータをオンにすることから始めます。有効になっていることを示す緑色のインジケーターが上部に表示されます。

有効なハンドブックでハンドブック シミュレータを使用すると、そのハンドブックをトリガーするすべての受信アラートに影響します。これは、シミュレートされたデータを含むハンドブックを保存すると、そのデータが本番環境のライブケースに適用され、実際の環境の結果に影響する可能性があるためです。

1. ケース アラートにポインタを合わせ、more_vert [アラート オプション] をクリックして、[アラートをテストケースとして取り込む] を選択します。この操作により、シミュレートされたプレイブックを実行するためのテストケースが作成されます。テストケース内で変更されたエンティティは、通常のケースのエンティティに影響しません。
2. [Playbooks] ページの下部にポインタを合わせ、テストケースを選択します。選択したテストケースが、実行するハンドブックと一致していることを確認します。確認するには、[エンティティ] をクリックし、ハンドブックがそのテストケース内のエンティティを処理できることを確認します。
3. [実行] をクリックします。シミュレータはステップを処理し、定義されたアクションを実行して、結果を提供します。

各ステップのシミュレータの結果を解釈する

[実行] をクリックすると、コンソールの最初の行がライブ プレイブックのように表示されます。シミュレートされた各ステップには、通常、[ケースデータ]、[結果を表示]、[結果を固定]（または [結果を挿入]）などのオプションが表示されます。手動ステップでは、パラメータを入力し、レスポンスを提供して、ステップを実行するためのボタンが表示されます。

ケース データ

[ケースデータ] アイコンをクリックすると、現在の操作の実行が完了した後の特定のステージにおけるケースの情報が表示されるダイアログが開きます。このダイアログは、現在のステップの結果で動的に更新されます。アクションによってケースにエンリッチメントが追加された場合は、ここに反映されます。ステップの実行後のケースの状態が表示されるため、シミュレーション コンソールの各ステップでデータが異なります。さまざまなステップでケースデータを検査すると、プレイブックの実行中にケースに適用された変更を把握できます。ダイアログ内の複数のタブには、追加の詳細情報が表示されます。

View Results

[結果を表示] オプションを選択すると、現在のステップの特定のアクションの結果が表示されます。表示される情報はケースの概要やケースウォールに似ており、エンリッチメントの詳細も含まれています。

アクセスできる情報は次のとおりです。

• メインタブには、出力メッセージ、テーブル、リンク、添付ファイルが表示されます。
• [技術的な詳細] タブには、アクションの結果と JSON の結果（存在する場合）が表示されます。

他のオプションと同様に、データをクリックして詳細な検査を行うことができます。[結果を表示] ページで、[JSON 結果を設定] をクリックすることもできます。この機能を使用すると、現在のアクションの JSON サンプルを置き換えることができます。この JSON サンプルは、統合開発環境（IDE）から直接変更できます。また、式ビルダー内でこのサンプルを基に、JSON 結果から特定のデータを抽出することもできます。

結果を固定

[結果を固定] オプションは、ステップが正常に実行された場合に使用できます。これは、アクションの結果を固定として扱うことができる非常に便利な機能です。

検索結果を固定すると、次のようなメリットがあります。

• サードパーティ サービスの結果を待つ必要がなくなります。
• これらのサービスに対するクエリの数を減らし、認証情報を保持します。

基本的には、プレイブックを再実行すると、結果が固定されているステップは「スキップ」されます。コードは再実行されず、固定された結果がそのまま使用されます。独自のモックデータを挿入して、この結果を変更することもできます。[結果を固定] を有効にすると、アクションがシミュレート モードになり、通常、ステップの視覚的な表現が青色の背景から灰色の背景に変わり、そのステップでシミュレート モードが有効になっていることが明確に示されます。

結果を挿入

ステップが失敗した場合、[結果を挿入] オプションが使用可能になります。この機能を使用すると、シミュレーション データを手動で挿入できます。この特定の手順を次回実行すると、手動で指定したデータが結果として返されます。

このオプションをクリックすると、アクションで自動的にシミュレート モードが有効になります。ステップの視覚的な表現が青色の背景から灰色に変わり、シミュレート モードが有効になっていることが明確に示されます。シミュレート モードの場合、すべてのステップで [スクリプトの結果] フィールドが必要です。

モックデータを挿入する

モックデータを挿入する際には、いくつかのユースケースを考慮する必要があります。

• プレイブックをその場で作成してテストする: ステップを実行し、結果を表示して、プレイブックの次のステップでそのデータをどのように使用できるかをすぐに把握できます。
• 実行が成功した後の時間を節約する: ステップの結果を固定することがあります。これにより、後続のテストでサードパーティ API に対してステップが繰り返し実行されるのを防ぎ、時間を節約できます。
• さまざまなシナリオのテスト: ステップの結果を変更して、さまざまな条件でプレイブックをテストできます。さまざまなシミュレーション データを設定することで、前の結果に依存する後続の条件とアクションに影響を与えることができます。たとえば、プレイブックに 2 つ以上のパスに分岐する条件がある場合、シミュレーション データを使用して、プレイブックが特定のブランチを「強制的に」実行するようにテストできます。

シミュレーション データを挿入する

プレイブックにシミュレーション（モック）データを挿入するには、主に 2 つの方法があります。プレイブックのステップ構成ダイアログを使用する方法と、シミュレータの実行後に [結果を固定]（または [結果を挿入]）を使用する方法です。

Playbook のステップ構成ダイアログを使用する

1. ハンドブック内のステップ構成ダイアログをクリックします。
2. [シミュレート モード] を切り替えて有効にします。アクションの視覚的な表現が灰色に変わり、シミュレート モードになっていることを示します。
3. [アクションの結果] セクションで、シミュレーション（モック）データを挿入できます。以下に例を示します。
• スクリプトの結果: スクリプトベースのアクションのモック結果を提供します。
• JSON 結果: JSON データを入力します。JSON コードから特定のデータを抽出することもできます。[Load Sample] をクリックして、サンプル出力を読み込むこともできます。これにより、アクションの想定される JSON の結果が読み込まれます。これは、次のような場合に特に便利です。
• シミュレーションがまだ実行されておらず、出力が空です。
• シミュレーションに失敗し、結果が表示されません。
• 既存の結果（以前の固定または挿入による）をサンプルでオーバーライドする。
• 拡充: 以前のシミュレーション実行の拡充を使用するか、独自のカスタム拡充キーを作成できます。

シミュレータの実行後に結果を使用する

結果を固定

ステップが正常に実行された場合は、そのアクションの横にある [結果を固定] をクリックします。次の処理は、この後に行われます。

• ステップは自動的に [シミュレート] モードで開きます。
.
• 最後に正常に実行されたシミュレーションの結果がステップに固定されます。これらの結果を使用することも、編集することもできます。
• JSON エディタを使用して JSON 結果を編集するか、[サンプルを読み込む] をクリックしてオーバーライドできます。
• 以前のシミュレーション実行のエンリッチメントを使用するか、カスタム エンリッチメント キーを作成できます。

結果を挿入

ステップが失敗した場合は、そのアクションの横にある [結果を挿入] をクリックします。次の処理は、この後に行われます。

1. このデータは、ステップが実行されるたびに返されるようになります。

ハンドブック シミュレータをオフにする

ハンドブック シミュレータをオフにすると、下部のコンソールが非表示になり、シミュレート モードのステップは通常の「ライブ」モードに戻ります。ただし、ハンドブック ブロックは例外です。ブロックのシミュレーション モードを閉じるには、ブロック シミュレータをオフにする必要があります。挿入されたシミュレーション（モック）データは、次回シミュレータをオンにしたときに使用できるように保存されます。

ハンドブックのブロックを操作する

ハンドブック シミュレータを使用して、新しいハンドブック ブロックを構築してテストすることもできます。ブロックがシミュレーション モードの場合、このブロックを使用しているすべての親ハンドブックも、ブロックのモックデータを使用します。