対象プランオプション機能
以下の方法でワークフロー環境から実行結果とエラーメッセージを確認することが可能です。表示されたエラーの内容をチェックして、必要に応じて対応を進めましょう。このページでは、実行結果やエラーメッセージの確認方法と、解決までの流れの一例をご紹介します☺️
1. 実行結果を確認する
実行しているレシピにて実行結果を確認することができます。
①該当レシピを選択し、[Jobs]タブを選択します。
②レシピの実行結果や履歴を確認することができます。Jobの履歴は以下のように表示されます。また、画面右上の [Inactive] セクションには、Successful jobs / Failed jobs の件数が表示されます。
- 正常に終了(Successful jobs):黒字で表示されます
- エラー(Failed jobs):赤字で表示されます
<attention>Jobの実行履歴の確認は過去30日までです。31日以上前のJobの詳細は確認できません。</attention>
2. エラーメッセージを確認する
実行しているレシピ内で、エラーが発生した際、以下の手順でエラー内容を確認することができます。
① 該当レシピを選択し、[Jobs]タブを選択します。ワークフローの実行結果やその履歴を確認することができます。エラーが発生した場合は、赤字で表示されます。
② Jobが失敗しているレコードを選択します。[Error]のタブをクリックすると、Job失敗の詳細エラーを確認することができます。
3. エラー発生時に通知する
実行中のレシピ内で、[Jobs]がエラーになった際、エラー内容を任意の宛先に通知することができます。あらかじめ設定しておくことで、都度ログインすることなく、エラー発生を早期に検知できます。
本ページでは以下2パターンをご紹介します。初めて設定される場合は、まずは❶の方法をご利用ください💡
Workatoに標準で備わっている機能を利用するため、簡単にエラー通知を設定できます。
| パターン | 必須/任意 | 特徴 |
| ❶ ワークフローの機能でエラーを通知する | 必須 | - 標準で備わっている機能を利用して、簡単に設定可能 - メールで通知 |
| ❷ エラー通知用のレシピを設定する | 任意 | -レシピの作成が必要 - Slackなど任意のツールへ柔軟に通知可能 |
<attention>仕様上、❶のエラー通知先(Recipients)の項目が空欄では保存できないため、初期値として弊社のメールアドレスが入力されていますが、弊社側でエラーを検知・対応するための設定ではありません。❷を利用する場合も、必ず貴社のご担当者様のアドレスへ書き換えてください。</attention>
❶ ワークフローの機能でエラーを通知する
① 左メニューより、[Workspace admin]をクリックします。
② [Settings] > [Debug and logs] > [Error alerts]をクリックしてください。[Recipients]に通知先のメールアドレスを設定し、[Save]をクリックしてください。
*複数のメールはカンマ( , )区切りで入力してください。
❷ エラー通知用のレシピを設定する
レシピを作成する
① [Create]をクリックする
② [Name]に任意の名称を設定し、[Location]に任意のフォルダを指定します。[Manage other recipes] を選択して、[Start building]をクリックします。
③ [Job failed] を選択します。
④ 以下を設定して、[Connect]をクリックし、アカウントの認証を行います。
| 項目名 | 設定内容 |
| Connection name | 任意の名称を設定してください。 |
| Location | 接続情報を保存したい任意のフォルダを指定してください。 |
| Whose account are you managing? | 監視対象として[My account]を選択してください。 接続に使用したユーザーアカウントがアクセス権限を持っているプロジェクト(フォルダ)内で発生したエラーが、監視対象となります。 |
⑤ 監視するレシピを設定します。以下のいずれかを設定します。
| Recipes to monitor | 設定する値 | ||
| ❶ | アクセス権がある全プロジェクト(フォルダ)内のエラーを監視する場合 | All | |
| ❷ | 監視対象レシピをIDで絞りたい場合 | Selected |
Recipe IDsには、監視したいレシピのIDを設定します。複数のレシピを監視したい場合は、カンマ区切りで設定してください。 レシピIDの取得方法は、Recipe IDsをご確認ください。 |
| ❸ | 監視対象レシピにタグをつけ、タグで絞り込みたい場合 | Tags | タグ名を選択します。 |
<tips>監視対象レシピにタグを付与する方法
❸の場合は、事前に監視対象レシピにタグを付与する必要があります。対象レシピの右上、三点リーダーをクリックし、[Apply tags]を選択します。[+]をクリックしてタグを新規作成するか、既存のタグを選択してください。
</tips>
次に、通知するアプリを選択します。ここでは一例としてSlackにWorkbotを利用して通知する方法をご説明します。
Slackに通知する
<tips>通知を行うには、事前にSlackとWorkatoの認証設定が必要です。
詳しくは、【事前準備】WorkatoとSlackを連携するための認証設定と準備をご確認ください。
以下ではSlackのbotを利用した通知方法をご紹介していますが、Slackの個人アカウントを利用して通知することも可能です。</tips>
① 【事前準備】WorkatoとSlackを連携するための認証設定と準備にて追加したステップ、[Post message as Slack Workbot]をクリックします。
② [Channel]を設定します。トリガーが発火した際に、どのSlackチャネルにメッセージ投稿するか設定します。通知させたいSlackチャネルを選択してください。
③ [Add block to message]をクリックし、通知形式として[Section with text]を指定します。
④ 通知内容を設定します。
| 通知内容:例 | 設定する値 | ||||||||||||||||
| ❶ | 特定のユーザーグループ(チーム名)や個人に対してメンションを送る |
|
|||||||||||||||
| ❷ | エラーメッセージを通知 | [Job failed]の中のデータピル[Error message]を挿入します。 | |||||||||||||||
| ❸ | エラーが発生したレシピのURLを通知 |
https://app.jp.workato.com/recipes/ 上記URLの中にデータピルを埋め込むことで、エラーが起きた特定のジョブへ直接ジャンプできるようになります。データピルを挿入する際に余計なスペースが入らないように注意してください。 |
⑤ 上記で設定した内容を[Save]したあと[Start recipe]をクリックし、レシピをアクティブにします。
これでレシピの設定は完了です🎊
4. 参考:エラー解決までの道筋例
例: 必要なIDが存在しない
以下のエラー場合は以下の2点を見ることで、9行目のLookup tableの箇所で、一致する項目が見つからないというエラーを吐き出していることがわかります。
[Error]:Unable to find an entry matching search parameters
[Error source]:Lookup tables by Workato
つまり、ユーザー情報をどのHubSpotのリストに格納するかシステムが見つけられていない状態という仮説が考えられます。そのため、Lookup tableの設定内容を確認し、ユーザー情報の格納先の設定内容を確認してください。
① [Tool ]>[Lookup tables]から、エラーが発生している該当Lookup tableを選択してください。ここではHubSpotのキャンペーンリストでエラーが発生しているので、以下を選択します。
② 今回発生しているユーザー情報の格納先の該当Eventkey もしくは 該当List IDが存在していないことが考えられます。存在しない場合は、ユーザー情報の格納先を追加しましょう。[Add entry]からEventkeyとList IDを設定してください。
③ 上記で格納先のEventKeyとList IDを設定したあと、エラーが発生しているレシピのJobのページに戻ります。[Repeat this job]をクリックし、Jobを再実行しましょう。
再実行後は Jobが[Successful]になります。
もし引き続き Jobが失敗する場合は、また別の要因が起因してエラーを引き起こしています。
冒頭で説明したエラー内容を元に、エラー発生原因を1つずつ修正していきましょう。
5. EventHubへの登録連携エラー
ワークフローを利用してEventHubに登録連携する際に何かしらのエラーが発生した場合、RESTに準拠したHTTP StatusCodeと共にエラーメッセージを返却します。主なエラーコードを記載いたします。
| statusCode | message(例) | 原因 |
| 400(Bad Request) | email address is already registered | email(など重複が許可されない項目)が重複している |
| 400(Bad Request) | email must contain only ASCII characters | email(などASCIIコード以外の文字が許可されない項目)にASCIIコード以外の文字が含まれている |
| 400(Bad Request) | lastName should not be empty | 必須項目(lastNameなど)が指定されていない |
| 400(Bad Request) | customFields.0.value must be a string or string array | スキーマーが違う(ここではcustomFieldsのobjectに対してvalueを指定する際に不正なデータ型を指定している) |
|
400(Bad Request) |
customField 123 cannot be registered for participant users | 項目の取得「対象ユーザー」が一致していない、あるいは登録時に登録フォームで収集するを指定していない |
|
400(Bad Request) |
customField 123 do not have customFieldOptionId or value properties | カスタム項目でcustomFieldOptionId/valueのいずれも指定しない |
| 400(Bad Request) |
customField must contain either customFieldOptionId or value property | カスタム項目でcustomFieldOptionId/value両方とも指定した |
| 400(Bad Request) | customFieldId 12 not found | カスタム項目で指定したidが存在しない(一致しない) |
|
400(Bad Request) |
customFieldValue apple not found | カスタム項目で指定したvalueが存在しない(一致しない) |
| 400(Bad Request) | customFieldOptionId 1234 not found | カスタム項目で指定したcustomFieldOptionIdが存在しない(一致しない) |
| 400(Bad Request) | Required customFields missing | 必須となっているカスタム項目がリクエストに含まれていない |
| 400(Bad Request) | Ticket cost must be free and status on sale or private to register a user | - イベントの閉鎖日時を過ぎている - チケット・フォームの登録期限や上限数を超えている - ステータスが準備中になっている - 有料チケットになっている |
| 400(Bad Request) | Ticket not found | 指定したチケットが存在しない もしくは指定したeventKeyにチケットが紐づいてない |
| 403(Forbidden) | Event not found | 契約に紐づいていないeventKeyが指定された もしくは存在しないeventKeyが指定された |
| 401(Unauthorized) | X-API-KEY is required | X-API-KEYが指定されてない |
| 404(Not Found) | User not found | 指定したユーザーが存在しない |
6. その他のよくあるエラーと解決方法
ワークフローで組んだレシピのよくあるエラーケースは以下の通りです。レシピの設定・内容を確認しつつ、以下の解決策をご参照ください。
Webhookの設定ができず、WebhookのURLも取得できない
「Http failure response for https://app.jp.workato.com/connections/rest_webhook_subscribe: 422 OK」Webhook名に不正な値が入力されていることが原因です。Webhookの「Event Name」を半角英文字に変更して、再度設定してください。
レシピは連携先の項目を参照できず、Jobが失敗するエラー
例:「Salesforce custom field 'xxxxx__c' is not present or unavailable to user」連携先システム側で項目が変更され、その情報がワークフロー側に反映されていないことが原因です。最新情報を反映させるために、レシピを編集して、右上のRefreshボタンをクリックしてください。必要に応じて、項目マッピングを再度ご確認ください。
連携システムのAuthorization ErrorでJobが失敗するエラー
連携しているシステム(Marketo、Salesforce、Hubspotなど)から発生したエラーです。連携アプリの認証情報が無効になっている可能性があるため、アプリを一度Disconnectしてから、再度Connectし直してください。
連携システムの接続が解除されている
Connection lost
「Connections may become invalid due to modified credentials or insufficient permissions.
Check that you have the necessary permissions and that your connection credentials are valid.」連携システムのアカウント権限が変更された、または不足していることが原因のエラーです。連携システムのアカウント権限を確認の上、接続し直してください。
Slackの通知が飛ばない
「ワークフロー:ユーザーの行動アクションを担当営業のメンションをつけてSlack通知する」の内容通りに設定しても通知が届かない場合、担当者通知用のリストに設定されているMember IDが正しくない可能性が考えられます。Member IDは、Slackのユーザープロフィールから取得できますので、設定を再度ご確認ください。(例:UA4TMO424)
参照しているキャンペーンIDが誤っている(Salesforce連携エラー)
「INVALID_CROSS_REFERENCE_KEY」などのエラーは、レシピの[Lookup table]で参照しているSalesforceのキャンペーンID(CampaignID)が誤っている場合に発生します。[Lookup table]に正しいSalesforceキャンペーンIDが設定されているかご確認ください。(参考:ワークフロー:作成済みのイベントとSalesforceのキャンペーンを連携させる)