# レシピのテスト
Workato の統合レシピテスト環境では、レシピを開始する前にテストできます。そのため、自動化の動作とデータ処理に問題のないことがあらかじめ保証され、後から大変な思いをすることもなくなります。
このガイドでは、次の項目について説明します。
# 基本情報
# テストジョブとは
テストジョブとは、Workato のレシピテスト環境または テストモード で実行するジョブです。テストジョブを実行すると、Workato はトリガーアプリケーションからの新しいトリガーデータを使用して、レシピ内でスキップされていないステップをテストします。
# テストモードとは
テストモードは単一のトリガーイベントを取得し、レシピ内でスキップされていないアクションをすべて実行します。完了したテストジョブはレシピのジョブレポートに記録されるので、その詳細を確認できます。
テストモードでは長いアクションを実行できません
長いアクションでは、そのアクションが完了しているかどうかを専用の Worker で定期的に確認する必要がありますが、この機能はテストモードでは利用できません。長いアクションを含むレシピをテストすると、 処理中 のステータスでジョブが停止する可能性があります。
この長いアクションのリストがレシピに含まれている場合は、代わりに [Start Recipe] を使用してください。
テストジョブの実行
# テストジョブの実行に使用されるトリガーデータ
テストジョブの実行に使用されるトリガーイベントは、トリガータイプによって異なります。
ポーリングトリガー : 接続されたアプリを定期的に確認することによって新しいイベントをチェックします。テストジョブの実行に使用されるトリガーイベントは、トリガーの開始/終了の日付によって異なります。
Salesforce オブジェクトトリガーに定義された開始日
上の例では、 2020年7月14日00:00:00以降に作成または更新 された Salesforce アカウントを取得するように、レシピが設定されています。トリガーイベントが見つかった場合、最も古いイベント ( 開始/終了 日に最も近いイベント) が最初に処理されます。後続のテストでは、日付順に次のトリガーイベントが処理されます。
リアルタイムトリガー : イベントを発生と同時に受信します。Workato は、トリガーが受信した最初のイベントを使用してテストジョブを実行します。たとえば、Webhook を使用する場合は、レシピトリガーに通知を送信するイベントをソースアプリケーションで作成する必要があります。
レシピファンクションのトリガー : このトリガーでは、トリガーイベントデータを指定します。たとえば、トリガーの入力値として
user_id
値が必要な場合は、サンプルのuser_id
値を指定してテストジョブを実行する必要があります。詳細については、「手動によるトリガーのテスト」を参照してください。
# テストモードを使用する最善の方法
以下に、レシピを作成するときの推奨事項を示します。
本番アカウントの代わりにサンドボックスを使用する。 ベストプラクティスとして、レシピのテストには本番アカウントではなくサンドボックスを使用してください。これにより、本番データ、場合によってはミッションクリティカルなデータに変更を加えずに、リアルなデータを使用できます。
レシピを段階的に作成し、テストする。 レシピは段階的に作成し、論理的な間隔でテストします。レシピの小さな断片を作成してテストすることで、レシピフローの一貫性が確保され、データピルが正しくマッピングされます。また、デバッグも容易になります。
ステップのスキップによってレシピを段階的に作成
ステップのスキップ 機能により、レシピ実行時にステップを無視できます。これはレシピを作成する際、その一部だけをテストしたい場合に役立ちます。
ステップのスキップの使用方法の詳細については、こちらを参照してください。
あらゆる状況に備えてレシピを作成し、テストする。 レシピには、条件付きロジックに基づいて複数のパスを含めることができます。テストによって、レシピ内のすべての条件が存在し、問題がないことを確認できます。
マッピングされたデータをすべてテストする。 データが正しく処理されるよう、すべてのデータフィールドとマッピングを確実にテストしてください。
たとえば、
Account Name
、Account Description
、Account Phone
のデータを Salesforce から Zendesk に移動するとします。テスト中に、以下のことを確認します。
- Salesforce で、対象のフィールドに有効なデータが設定されている
- Zendesk で、入力フィールドに正しい値が設定されている
- 必要な場合、異常値または欠損値の理由が分かる
# テストジョブを確認する方法
テストモードでテストジョブを確認する場合は、ジョブ結果のセクションにある ジョブ時間 のドロップダウンをクリックします。表示されるメニューから、[See all test jobs] をクリックします。
過去のテストジョブをすべて確認
ジョブレポートのテーブルで個々のジョブをクリックして開きます。ジョブを開いた後は、各ステップの詳細を確認したり、ジョブを再実行したりできます。
# テストジョブの再実行は可能か
はい。再実行されるジョブは元のジョブのトリガーデータを再使用しますが、最新のレシピバージョンで実行されます。
テストモードでジョブを再実行する場合は、ジョブ結果のセクションにある [ジョブを再実行] をクリックします。
強調表示された [ジョブを再実行] ボタン (テストモード)
ジョブが再実行されると、ジョブ結果のセクションにある ジョブ時間 の横に、再実行されたジョブで構成される2つ目のドロップダウンが表示されます。
[Repeated job] メニューと再実行の履歴
このドロップダウンで個々のジョブをクリックして開きます。ジョブを開いた後は、各ステップの詳細を確認したり、ジョブを再実行したりできます。
# 制限事項
レシピでテストモードを使用するときは、以下の点に注意してください。
すべてのトリガータイプがサポートされているわけではありません。 以下のトリガータイプはテストモードで使用できません。
- 特定の時間に実行するコネクタートリガー ( Salesforce の SOQL を使用する定期的なレコード検索 トリガーなど)
- Workbot コマンド
一部のトリガータイプでは、手動によるテスト設定が必要です。 レシピファンクションのトリガーでは、テストを実行するためのテストデータを提供する必要があります。詳細については、「手動によるトリガーのテスト」を参照してください。
レシピがテストまたは開始された後に、一部のトリガー設定は変更できません。 たとえば、トリガーに 開始/終了 日が必要な場合は、レシピがテストまたは開始された後にその日付を変更することはできません。
# テストジョブの実行
レシピテストの準備
テストジョブの実行には以下が必要です。
- 完全に設定されたトリガー
- 有効なデータマッピング
- 有効なコネクション
[Test] をクリックすると、レシピがこれらの要件を満たしているか Workato がチェックします。問題がある場合は、対処を促すメッセージが表示されます。
Workato では、以下の2つの方法でテストジョブを開始できます。
# トリガーのテスト
Workato アカウントで、レシピを 編集 モードで開きます。
レシピエディターで、[Test] をクリックします。
[Test] をクリックすると、Workato が以下を実行します。
- 必須項目が入力されているかどうかの確認
- データマッピングの検証 (該当する場合)
- コネクションの検証 (該当する場合)
データチェックに合格すると、Workato はテストジョブを開始します。ジョブが完了すると、テスト結果が表示されます。
# 手動によるトリガーのテスト
コネクターの選択に適用可能
このセクションはレシピファンクションに適用されます。
Workato アカウントで、レシピファンクションを 編集 モードで開きます。
レシピエディターで、[Test] をクリックします。[Add trigger data] ウィンドウが表示されます。
このウィンドウでは、Workato によるテストジョブの呼び出しに使用するデータを指定します。データを指定する方法は2つあります。
Form fields ビュー
トリガーの入力で各項目を設定したフォームが、 Form fields ビュー に表示されます。このビューを使用するには、 [Change view] > [Form fields view] をクリックします。
トリガーの入力項目に値を入力します。 注 : 入力できるのは、プレーンテキストと静的リストだけです。
手動によるトリガーを設定する Form fields ビュー
Raw JSON
Raw JSON ビュー は、トリガーの入力項目を含む有効な JSON オブジェクトを受け付けます。このビューを使用するには、 [Change view] > [Raw JSON view] をクリックします。
parameters
オブジェクトのフィールドである、トリガーの入力項目に値を入力します。
Raw JSON ビューの手動トリガー設定
入力項目 (parameters
) に加え、JSON ビューには context
オブジェクトが含まれます。context
オブジェクトには、呼び出し元のレシピ ID とジョブ ID のサンプル出力 (0
) が事前入力されていますが、上書きできます。
注 : このウィンドウのデータは、現在のレシピページを更新したり、別のレシピページに移動したりすると失われます。
入力が完了したら [Test recipe] をクリックします。
手動によるトリガーテストのデータを送信すると、Workato が以下を実行します。
- 必須項目が入力されているかどうかの確認
- JSON 構文の検証 (JSON 指定時)
データチェックに合格すると、Workato はテストジョブを開始します。ジョブが完了すると、テスト結果が表示されます。
# テスト結果の利用
テストジョブが完了すると、テスト結果が表示されます。テストジョブの結果は以下のいずれかになります。
# 成功したジョブ
成功したジョブには、レシピパス、入力、および出力が含まれます。
成功したテストジョブの表示
# 失敗したジョブ
失敗したジョブには、レシピパス、入力、出力、デバッグ情報が含まれます。
さらに、Workato ではエラーが発生したステップが強調表示されます。問題に関するステップビューの詳細をクリックします (エラーの説明を含む)。
失敗したジョブの表示
ジョブの再実行または新しいテストの実行前に、 ビルドモード でエラーを修正します。
# ジョブが見つからない
テストジョブでトリガーイベントが見つからない場合は、キャンセルするまでテストジョブの実行が継続されることがあります。
トリガーイベントが見つからないときは、以下を推奨します。
トリガーの設定を確認する。 一部のトリガーでは、レコードの取得を開始する日付を指定できます。この項目が正しく設定されていることを確認します。
Salesforce オブジェクトトリガーに定義された開始日
トリガーアプリ内でレコードを作成または更新し、再度テストを実行する。 トリガーが正しく設定されている場合は、レシピがトリガーイベントを取得します。
上の例では、 2020年7月14日00:00:00以降に作成または更新 された Salesforce アカウントを取得するように、レシピが設定されています。ここで Salesforce アカウントを作成または更新すると、テストジョブがイベントを検出するはずです。
レシピのコピーを作成し、以前の日付に遡ってトリガーを設定する。 このアプローチにより、トリガーイベントが利用可能であると分かっている別の日付で、テストを試すことができます。
たとえば、Salesforce アカウントが 2020年5月31日 に作成されたことが分かっている場合は、コピーしたレシピのトリガー日を この日付よりも前 に設定します。この結果、レシピのテストにトリガーイベントを確実に1つ以上利用できます。
# テストジョブのキャンセル
進行中のテストジョブをキャンセルするには、[Stop test] ボタン (右上隅) または [Cancel job] ボタンをクリックします。
テストジョブのキャンセル
Last updated: 2023/8/31 1:07:14