Shopify Flow でワークフローをテストする

ワークフローを有効にする前に、テストを実行できます。これにより、ワークフローを有効にして自動で実行させる前に、ワークフローのロジックを検証し、変数やパラメーターが正しいことを確認できます。ワークフローのテストでは、通知の送信、注文や商品の更新、ライブストアのデータへの変更などのアクションは行われません。Shopify Flow では、いつでもワークフローをテストできます。

すべてのテストはトリガーイベントのデータから開始されます。実際のストアデータを使用するか、シミュレーションのストアデータを使用するかに応じて、Shopify Flow でトリガーイベントのデータを取得するには以下の 3 つの方法があります。

  • イベントの記録: このオプションは、ワークフローのトリガーとなるストアで自然に発生するライブイベントを監視するテストモードを有効にします。このモードでは、新しいブラウザタブを開き、手動でライブアクションを実行して、実際のデータを含むテストイベントを生成することもできます。たとえば、注文が作成されたときのトリガーをテストするためにご自身で実際の注文を作成します。
  • イベントの作成: このオプションを使用すると、ストアに実際の変更を加えることなく、ワークフローのトリガーとなるストアの実際のデータを使用してシミュレーションイベントを手動で作成できます。たとえば、管理画面から既存の注文を選択し、すでに作成された注文であっても、その実際のデータを注文が作成されたときのトリガーのテストイベントとして使用できます。
  • イベントの生成: テストイベントを手動で作成するのと同様に、このオプションでは Sidekick にシミュレーションのテストイベントを生成させます。たとえば、Sidekick はストア内の既存の注文データを使用して注文が作成されたときのワークフローをテストするための 2 つのテストイベント (条件を満たす場合と満たさない場合) を生成できます。その後、テストの好みに応じてそれらのテストイベントを使用、編集、または削除できます。

Shopify Flowでワークフローをテストする際の考慮事項

ワークフローをテストする前に、以下の考慮事項を確認してください。

  • テストモードのワークフローでは、実際のストアデータを使用してLiquid変数を返し、ワークフローのロジックを決定しますが、アクションを実行したりストアを変更したりすることはありません。意図しない変更を防ぐために、テスト実行はワークフローロジックで変更を試みる最初のアクションで停止します。
  • ワークフローは作成中のどの段階でもテストできます。現在のバージョンをテストするためにワークフローが完了している必要はありませんが、ワークフローのすべてのステップが有効である必要があります。不完全なステップや正しく設定されていないステップは、テストで使用できません。
  • ワークフローの最近の実行リストには、テストワークフローの実行は含まれません。
  • [HTTPリクエストを送信] のような、外部サービスに接続するワークフローのアクションでは、テスト中に設定のプレビューが表示されますが、実際のデータではなく、返されたデータ値として [このアクションをシミュレーションできません] というメッセージが表示されます。

Shopify Flow で実際に記録されたイベントを使用してワークフローをテストする

イベントを記録する際、ワークフローは設定したトリガーに基づいて実際のストアデータを使用し、テストイベントのリストを作成します。トリガーイベントによっては、テストイベントを生成するために手動でアクションを実行する必要がある場合があります。たとえば、コレクションが作成されたときのイベントをテストする場合、ワークフローがテスト用のイベントを記録できるように、管理画面で手動でコレクションを作成する必要があります。

手順:

  1. 管理画面から、[アプリ] > Flow に移動します。

  2. [ワークフロー] セクションで、テストするワークフローをクリックします。

  3. [編集] をクリックして、ワークフローエディタを開きます。

  4. ワークフローのトリガーで、ワークフローをテストをクリックします。

  5. ワークフローをテストダイアログで、+ イベントを追加 > イベントを記録をクリックして、ワークフローのテストモードを有効にします。

  6. 任意:利用可能なテストイベントが自然に生成されない場合は、新しいブラウザータブを開き、トリガーがテストワークフローを開始する原因となるイベントを手動で作成します。

  7. テストイベントのダイアログでは、トリガーされたすべてのテストイベントがイベントの記録リストに表示されます。テストワークフローを実行するテストイベントを選択します。

  8. ワークフローでは特定の条件とアクションがハイライトされ、選択したトリガーイベントに基づいてワークフローが使用するロジックのパスが視覚的に表示されます。以下のアクションを実行できます。

    • テストイベントのデータに基づいて該当する出力をプレビューするには、ワークフローの条件またはアクションステップをクリックし、プレビュータブをクリックします。これは、変数が正しいデータを表示しているかを確認するのに便利な方法です。
    • 別のテストイベントを選択するには、イベントの記録リストから新しいテストイベントを選択します。
    • ワークフローのテスト結果を更新するには、ワークフロートリガーの やり直しアイコン テストを再開をクリックします。
    • テストイベントを保存するには、ハートアイコン をクリックし、保存をクリックします。テストイベントを保存した後、必要に応じてテストデータを変更できます。
  9. オプション: リスニングモードを終了するには、記録を停止をクリックします。記録を開始をクリックすると、ライブテストイベントのリスニングを再開できます。

Shopify Flow でシミュレーションイベントを作成してワークフローをテストする

手動または Sidekick を使用してシミュレーションイベントを作成する場合、設定したトリガーに基づいてイベントデータを提供し、テストイベントのリストを作成します。これらのシミュレーションイベントでは、ストアに実際に存在する商品やコレクション情報などの実際のストアデータが使用されますが、ストアに実際の変更が加えられることはありません。その後、ワークフローでそのシミュレーションイベントを使用して、ワークフローのテストを実行させることができます。

イベントの作成時に選択するデータは、ワークフローを開始するトリガーのタイプによって異なります。たとえば、注文が作成されたときのトリガーで開始されるワークフローでは、テストイベントとして使用する既存の注文のみを選択する必要があります。しかし、会社の連絡先に許可が割り当てられたときのトリガーでは、テストイベントを作成するために会社のロケーション、その会社の連絡先、および許可のレベルを選択する必要があります。

テストイベントを作成するためのデータをご自身で選択したくない場合は、Sidekick がテストイベントのセットを生成できます。

手順:

イベントデータを手動で作成する
  1. 管理画面から、[アプリ] > Flow に移動します。

  2. [ワークフロー] セクションで、テストするワークフローをクリックします。

  3. [編集] をクリックして、ワークフローエディタを開きます。

  4. ワークフローのトリガーで、ワークフローをテストをクリックします。

  5. ワークフローをテストダイアログで、+ イベントを追加 > イベントを作成をクリックします。

  6. イベントを作成ダイアログで、テストイベントの情報を追加します。

    1. トリガーの必須フィールドに基づいて、テストイベントとして使用するストアデータを選択します。
    2. オプション: イベント名フィールドで、テストイベントに簡潔でわかりやすい名前を付けます。
    3. 保存をクリックします。
  7. ワークフローでは特定の条件とアクションがハイライトされ、新しいテストイベントに基づいてワークフローが使用するロジックのパスが視覚的に表示されます。以下のアクションを実行できます。

    • テストイベントのデータに基づいて該当する出力をプレビューするには、ワークフローの条件またはアクションステップをクリックし、プレビュータブをクリックします。これは、変数が正しいデータを表示しているかを確認するのに便利な方法です。
    • 別のテストイベントを選択するには、保存されたイベントまたはイベント履歴リストから新しいテストイベントを選択します。
    • ワークフローのテスト結果を更新するには、ワークフロートリガーの やり直しアイコン テストを再開をクリックします。
Sidekick でイベントデータを生成する
  1. 管理画面から、[アプリ] > Flow に移動します。

  2. [ワークフロー] セクションで、テストするワークフローをクリックします。

  3. [編集] をクリックして、ワークフローエディタを開きます。

  4. ワークフローのトリガーで、ワークフローをテストをクリックします。

  5. ワークフローをテストダイアログで、イベントを生成をクリックします。

  6. 保存されたイベントリストで、テストワークフローを実行する 2 つの新しいテストイベントのいずれかを選択します。

  7. ワークフローでは特定の条件とアクションがハイライトされ、選択したテストイベントに基づいてワークフローが使用するロジックのパスが視覚的に表示されます。以下のアクションを実行できます。

    • テストイベントのデータに基づいて該当する出力をプレビューするには、ワークフローの条件またはアクションステップをクリックし、プレビュータブをクリックします。これは、変数が正しいデータを表示しているかを確認するのに便利な方法です。
    • 別のテストイベントを選択するには、保存されたイベントまたはイベント履歴リストから新しいテストイベントを選択します。
    • ワークフローのテスト結果を更新するには、ワークフロートリガーの やり直しアイコン テストを再開をクリックします。

Shopify Flow で保存されたテストイベントを編集する

ワークフローの保存されたテストイベントのコンテンツはいつでも編集できます。また、保存されたテストイベントを完全に削除することもできます。

手順:

  1. 管理画面から、[アプリ] > Flow に移動します。

  2. [ワークフロー] セクションで、テストするワークフローをクリックします。

  3. [編集] をクリックして、ワークフローエディタを開きます。

  4. ワークフローのトリガーで、ワークフローをテストをクリックします。

  5. 保存されたイベントリストで、編集するテストイベントにカーソルを合わせ、 > 編集をクリックします。

  6. テストイベント内のフィールドのコンテンツを更新します。新しいデータを選択する前に、X をクリックしてデータを削除する必要がある場合があります。

  7. 保存をクリックします。

  8. オプション: 保存されたテストイベントを削除するには、削除するテストイベントにカーソルを合わせ、 > 削除をクリックします。

ワークフローのテストを確認する

Shopify Flowでワークフローをテストする際は、テストトリガーイベントに基づいてワークフローが期待どおりに動作することを確認するために、以下の情報を確認してください。

  • ワークフロー全体のロジックは期待どおりですか?たとえば、テストイベントの条件がtrueの場合、ワークフローは条件が満たされた場合のロジックパスに従っていますか?
  • ワークフローは、すべての条件とアクションで正しい変数を使用していますか?たとえば、注文のフルフィルメント数を返すorder.fulfillmentsCount.count変数ではなく、フルフィルメントのすべての項目数量の合計を返すfulfillments_item.totalQuantity変数を確認するようにワークフローに依頼した可能性があります。
  • ワークフローは、すべての条件と変数で正しい演算子を使用していますか?
    • AND/ORロジックを確認します。たとえば、複数の要素を持つ条件の場合、条件は両方の要素がtrueであること (AANDB) をチェックしていますか、それともいずれか一方 (AORB) をチェックしていますか?
    • 該当する場合、None of/At least one of/All ofロジックを確認します。
    • 該当する場合、Equal toNot equal toDoes not existExistsGreater thanLess thanIs at least one ofロジックなど、変数の演算子が正しいことを確認します。
  • ワークフローの条件とアクションは正しい順序で実行されていますか?たとえば、ワークフローが結果に基づいて次の条件に進むのではなく、複数の異なる条件を同時にチェックするように設定されている可能性があります。

テストワークフローが予期せず動作する場合は、Shopify Flowのワークフローにおけるエラーのトラブルシューティングに関する情報を確認してください。