本ページは、ワークフロー機能を初めてご利用になる方に向けたスターターガイド📗です。迷わず進められるよう、ワークフローの全体的なご利用の流れをご紹介します。
操作していく中で分からないことがありましたら、お気軽にチャットサポートへお問合せください💪
<tips> 本機能は有償のオプション機能です。ご利用を希望する場合は、担当のカスタマーサクセス または 画面右下にある吹き出しマークからカスタマーサポートへお問い合わせください。</tips>
1. 概要
EventHubでは利用頻度や自動化ニーズの高いワークフローを「テンプレートレシピ」としてご用意しております。テンプレートレシピは、貴社環境にインストールし、必要に応じて設定やカスタマイズを行うことができます。またEventHubのWebhookを活用し、独自の連携も簡単に構築することも可能です。詳細は、ワークフローとはをご覧ください。
<attention>EventHubを介さない形でのデータ連携はご遠慮いただいております。
当該利用が確認された場合には、連携アプリの利用を制限させていただく場合もございます。</attention>
ご利用環境が整いましたら、担当のカスタマーサクセスからご連絡いたします。下記を参考にご利用を開始しましょう🎊
2. ワークフローの利用権限をメンバーに付与する
ワークフローをご利用いただくためには、メンバー管理機能でワークフローの利用権限を各メンバーに付与いただく必要があります。
<attention>権限を付与するには、管理画面への管理者権限が必要です。詳細は、メンバー管理をご覧ください。</attention>
① [設定] > [メンバー管理]より、ワークフローの利用権限を付与したいメンバーをクリックします。
② ドロワーが開いたら、アクセス権[ワークフロー]をクリックしてください。
<tips> [ワークフロー]が表示されない場合は、担当のカスタマーサクセスサクセス または 画面右下にある吹き出しマークからカスタマーサポートへお問い合わせください。</tips>
③ [付与済みアクセス権]という表示になれば、アクセス付与は完了です。
権限が付与されたメンバーは管理画面にアクセスした際に[設定]＞[ワークフロー]メニューが表示されます。[利用する]を選択すると、貴社のワークフロー環境へログインすることができます🎉
3. プロジェクトとフォルダを作成する
Workato内では「プロジェクト（Project）」と「フォルダ（Folder）」を作成することができます。
複数チーム・グループで運用したり、複数種類のレシピを操作する際には、必要な整理となります。今後の拡張も踏まえ、プロジェクト・フォルダを設計いただくことをお勧めします。
| 参考 | プロジェクトを使用するためのベストプラクティス（出展：workato） |
プロジェクト（Project）とは？「プロジェクト」は、レシピ・コネクション・環境変数などをグループ単位で整理・管理するための仕組みです。部門やユースケースごとに分けて運用することで、管理しやすくなります。
特徴：
- チームやイベントなどのユースケースごとにレシピを分類可能
- プロジェクト単位でユーザーのアクセス権を制御可能
- 例：Aチームは「プロジェクトA」のみ閲覧・操作が可能
フォルダ（Folder）とは？「フォルダ」は、プロジェクト内でレシピを整理するための入れ物です。ユースケースや処理内容別にレシピを分類することで、プロジェクト内の視認性と保守性が向上します。
特徴：
- レシピを整理・分類するための機能
- 権限管理はフォルダ単位ではなくプロジェクト単位で行う
- 例：Salesforce/Marketo/HubSpot/通知系 など用途ごとにフォルダ分け
3.1 プロジェクトを作成する
ワークフローにログインしたら、まずはプロジェクトを作成しましょう💡
① ワークフローにログイン後、左サイドバー[Project]から[Create project]をクリックします。
② 任意の名称をつけて、[Create project]をクリックします。
これでプロジェクトの作成は完了です🎉
3.2 フォルダを作成する
プロジェクトを作成できたら、レシピを格納するためのフォルダを作成しましょう💡
① 左サイドバー[Project]からフォルダを作成したいプロジェクトをクリックし、[Create folder]をクリックします。
② [Folder name]に任意の名称を設定して、[Create folder]をクリックします。
これでプロジェクト配下にフォルダを作成できました🎉
4. エラー通知先を設定する
実行中のレシピ内で、[Jobs]がエラーになった際、エラー内容を任意の宛先に通知することができます。あらかじめ設定しておくことで、都度ログインすることなく、エラー発生を早期に検知できます。
| パターン | 設定必須/任意 | |
| 参考 | ❶ ワークフローの機能でエラーを通知する | 必須 |
| ❷ エラー通知用のレシピを設定する | 任意 |
<attention>仕様上、❶のエラー通知先（Recipients）の項目が空欄では保存できないため、初期値として弊社のメールアドレスが入力されています。 弊社側でエラーを検知・対応するための設定ではありませんので、必ず貴社のご担当者様のアドレスへ書き換えてください。</attention>
5. テンプレートレシピをインポートする
弊社が提供するテンプレートレシピを利用するには、貴社環境にレシピをインポートしてください。ご提供しているレシピの一覧は、テンプレートレシピ一覧をご覧ください。
5.1 テンプレートレシピをダウンロードする
① ご利用したいテンプレートレシピのZipファイルを、テンプレートレシピからお手元にダウンロードしてください。
② パスワードを入れて解凍したフォルダを再度Zip化します。
<attention>・テンプレートレシピのzipファイルにはパスワードがかかっています。パスワードは、担当のCSまたはカスタマーサポートまでお問い合わせください。
・レシピをインポートするためには、パスワードを入力して解凍後、再度Zip化をする必要があります。再度Zip化する際はパスワードの設定はしないでください。</attention>
5.2テンプレートレシピをインポートする
再度Zip化したレシピを貴社環境で利用できるようインポートしていきましょう。
① ワークフローにログイン後、左サイドバーから[Tools]＞[Recipe lifecycle management]をクリックします。
② [Import]タブを選択し、[Import]もしくは[Import package to a new folder]をクリックします。
初めてインポートする場合
過去インポートしたことがある場合
③ [Target folder]を選択して、インポートしたいフォルダを選択します。
<tips>チームや複数のプロジェクトを運用している場合は、フォルダを選択してインポートすることをおすすめします。プロジェクトやフォルダを作成していない場合は、本画面よりプロジェクトを作成することも可能です。詳細は、プロジェクトとフォルダを作成するをご覧ください。
</tips>
④ テンプレートレシピをダウンロードするにてダウンロードしたZipファイルを、こちらの画面からインポートして[Next]をクリックしてください。
⑤ [Next]をクリックします。レシピが貴社環境にインポートされたことを確認し、[Finish]をクリックします。
⑥ レシピが貴社環境にインポートされたことを確認し、[Finish]をクリックします。
これで設定は完了です🎉
貴社の環境でレシピの利用を開始することができます。
<attention>
インポート時に下記のエラーが発生する場合がございます。こちらは過去にインポート済みのコネクションと同じ設定が今回インポートするパッケージに含まれる際に発生いたします。
・今回インポートするファイルから削除してから再度インポートする
・既に作成済みのコネクションを削除する
のいずれかにてご対応をお願いいたします。解消しない場合はサポートまでお問い合わせください。
</attention>
6 . レシピを設定する
レシピごとに設定マニュアルをご用意しております。マニュアルを参考に、ご利用環境や用途に合うように設定を変更してください。
7 . レシピを実行する
レシピの修正が終わったら、[Start recipe]からレシピを実行しましょう。なお、[Start recipe]を押す前に、EventHub側でWebhookの設定が完了しているかをご確認ください。テンプレートレシピは、EventHubのWebhookをトリガーにして動き出します。必ず設定を済ませた上でWebhookを発火（=EventHubでアクション実行）させてください。
<attention>[Start recipe]が押されていない場合、Webhookの発火条件が満たされても、レシピは停止状態となっており、Webhookからのデータは受け取ることができません。停止している間のデータを後から遡って処理することもできませんので、ご了承ください。</attention>
8. 実行結果を確認する
レシピ実行後は、各レシピ内にて実行結果をご確認いただけます。
ジョブ実行時にエラーが発生している場合は、画面上にその内容が表示されます。エラー内容に応じて、レシピの修正を行ってください。また、エラーが発生したジョブのみを個別に再実行することも可能です。
レシピを修正しジョブを再実行した後は、連携先システムでも処理が正しく行われているかを必ずご確認ください。想定通りに連携されていることが確認できましたら、設定は完了です😊
設定お疲れさまでした!!🎉
これでワークフローを利用するための準備が整いました。