Zoho Event Listeners

はじめに

Zoho Event Listenersは、Catalystの外部、つまり他のZoho製品やサービスで発生するイベントをリッスンします。これらのEvent Listenersは、Zohoサービス内の特定の設定されたアクションをリッスンし、コンポーネントおよびカスタムEvent Listenersと同様に、イベント発生時に関連するターゲットFunctionsまたはCircuitsをトリガーします。

Catalystは現在、以下のZohoサービスとの連携をサポートしています:

• Zoho CRM

以下の表は、Zoho Event Listenerに関連付けることができる、サポートされているZohoサービスでのイベント発生の一覧を示しています:

覚えておくべき重要なポイント:

• Zoho CRMにアカウントを持っている必要があります。

• これらのサービスでは、Standard、Professional、または無料プランなど、任意のティアまたはエディションのアカウントを使用できます。

• すべてのZohoサービスとの連携は、連携設定から管理できます。Event Listenersコンポーネントから、サポートされているZohoサービスのアカウントをZoho Event Listenerに関連付けるために追加すると、その特定のアカウントとの連携が作成され、Integrations設定に表示されます。

• 1つのZoho Event Listenerバスは特定のサービスに関連付ける必要はありません。Zoho Event Listenerを作成し、その中に複数のルールを設定でき、それぞれをサポートされている任意のZohoサービスで発生するさまざまなイベントに関連付けることができます。

• Zoho Event Listener内の1つのルールは、Zohoサービス内の特定のイベント発生にのみ関連付けることができます。たとえば、同じEvent Listener内で、あるルールをPurchase Order Updatedイベントに、別のルールをZoho CRMのLeads Createdイベントに関連付けることができます。

• 以前に別のルールが既に作成されている同じサービス、アカウント、イベント、および詳細フィルターに対してルールを作成することはできません。つまり、Catalystでは同じ設定に対する重複ルールの作成は許可されていません。ただし、異なる詳細フィルターを追加することで、既に設定されているイベントに対してルールを作成できます。

Zoho Event Listenerの動作を例で理解しましょう:

Zoho CRMアカウントの特定のorgでInvoices Createdイベントに対するZoho Event Listenerルールを関連付けたとします。このルールのターゲットFunctionsとしてFunction1とFunction2を設定します。関連付けられたCRM orgで請求書が作成されるたびに、Catalystはイベントをキャプチャし、Zoho Event Listenerに設定されたルールをトリガーします。そのルールはターゲットFunctionsであるFunction1とFunction2の実行を呼び出します。

他のEvent Listenerタイプと同様に、発生したイベントのイベントデータは、事前定義されたJSON形式でターゲットFunctionsまたはCircuitsに渡されます。このデータは、ターゲットFunctionまたはCircuitで処理され、必要なアクションが実行されます。データはZohoサービスとそこで発生するイベントに基づいて異なります。

たとえば、ルールがZoho CRMのVendors Approvedイベントに関連付けられている場合、そのサンプルイベントデータは以下のようになります:

{
    "project_details": {
        "id": 57*************,
        "project_name": "Eventbus"
    },
    "event_bus_details": {
        "name": "ThirdPartyBus",
        "id": 57*************
    },
    "data": {
        "subscriber": {
            "org_id": "15709179",
            "name": "ZohoCRM",
            "id": "111118000000000995"
        },
        "data": [
            {
                "Created_Time": "2022-09-22T07:25:15+00:00",
                "Last_Activity_Time": null,
                "Secondary_Email": null,
                "Owner": {
                    "name": "Owner Name",
                    "id": "25490*****"
                },
                "Modified_Time": "2022-09-22T07:25:15+00:00",
                "Designation": null,
                "Company": "leadcompany",
                "Name": "leadLastname",
                "City": null,
                "Modified_By": {
                    "name": "UserName",
                    "id": "25490*****"
                },
                "Last_Enriched_Time": null,
                "Description": null,
                "id": "2549000000109002",
                "Modified_Time": "2022-09-22T07:25:16+00:00",
                "Fax": null,
                "Created_Time": "2022-09-22T07:25:16+00:00",
                "Full_Name": "MyLead",
                "Created_By": {
                    "name": "UserName",
                    "id": "25490****"
                 },
                "id": "1728819000000440052",
                "Last_Name": "leadLastname",
                "Email": null
            }
        ],
        "publisher": {
            "org_id": "15709004",
            "name": "ZohoCRM",
            "id": "111118000000002003"
        },
        "signal_info": {
            "subscription_id": "111118000000047572",
            "publisher_module_api_name": "Contacts",
            "generic_api_name": "Crm_New_Contacts",
            "api_name": "Crm_New_Contacts",
            "org_id": "15709005",
            "id": "111118000000003114",
            "module_name": "ZSignalsCustom3",
            "additional_params": null
        }
    },
    "current_project": {
        "id": 57*************,
        "project_name": "Eventbus"
    },
    "action": "ZohoEvents Produce",
    "source_entity_id": 570000000003015,
    "source": "ZohoEvents",
    "event_time": 1568192053790
}

渡されるイベントデータには、CRM org、承認されたベンダー、ベンダーを承認したCRMユーザーのメタデータ、Vendorモジュールの詳細、プロジェクトの詳細などに関するデータが含まれます。

それでは、CatalystコンソールからZoho Event Listenersを操作してみましょう。

Zoho Event Listenerの作成

以下の方法でZoho Event Listenerを作成できます:

1. Catalystコンソールの_Amplify_内のEvent ListenersセクションからCreate Event Listenerをクリックします。
   
   

2. Event Listenerの名前と説明を入力します。タイプとしてZoho Eventsを選択します。
   
   

3. Createをクリックします。

Zoho Event Listenerが作成され、Event ListenersページにIDと、コンポーネントEvent Listenerと同じパフォーマンス統計とともに表示されます。

Event Listenerの詳細を表示し、ルールを作成するには、タイルのViewをクリックします。

Zoho Event Listenerでのルールの作成

以下の方法でZoho Event Listenerにルールを作成できます:

1. Zoho Event ListenerのページからCreate Ruleをクリックします。
   
   

2. ポップアップウィンドウから、Event Listenerを作成するサポートされているZohoサービスを選択します。Nextをクリックします。
   
   

3. ルールに関連付けるサービス内のアカウントを選択する必要があります。Event Listenersまたは連携設定を通じて以前に連携済みのアカウントがここに一覧表示されます。サービスに対して既に一覧表示されているアカウントを選択できます。
   
   

下部のAdd new accountをクリックして、サービス内の新しいアカウントを連携することもできます。これにより、サービスで既に作成されているアカウントを追加できる権限ページにリダイレクトされます。Acceptをクリックして、Catalystにリクエストされた権限を付与します。

Catalystコンソールのルール作成ポップアップに切り替えて、新しく連携したアカウントを選択できます。Nextをクリックします。

4. ルールの詳細を設定できます。ルールの名前と説明を入力します。
   
   

5. 関連するサービスのイベントを選択してルールを設定します。ルールに対して選択できるイベントは1つのみです。各サービスで利用可能なイベントの一覧については、前のセクションを参照してください。
   
   

6. _Advanced Filters_の+アイコンをクリックして、ルール実行時の詳細フィルターをオプションで追加することもできます。これらのフィルターは、選択したサービスとイベントに基づいて異なります。

たとえば、_Purchase Orders Created_イベントの場合、以下の画像のように、_Shipping Country_をIndiaにする、または_Shipping Code_を空にしないなどの特定のパラメータを指定できます。その後、ルールは購入注文の_Shipping Country_がIndiaで、_Shipping Code_が空でない場合にのみ、そのイベントに対して実行されます。

ルール実行時に実行する1つ以上のターゲットFunctionsまたはCircuitsを選択します。

7. Createをクリックします。

Zoho Event Listenerにルールが作成されます。Event Listenerのページにその詳細とともに一覧表示されます。ルールのソースには、関連付けられているサービスが表示されます。

ルールの名前をクリックすると、その詳細とデータパターンを表示できます。

本番環境のアカウント設定

Catalystでは、プロジェクトを本番環境にデプロイする前またはデプロイ時に、すべての既存のZoho Event Listenerルールについて、サポートされているZohoサービスの本番環境用アカウントを設定する必要があります。

本番環境から直接_Event Listeners_コンポーネントでルールを設定または編集して本番アカウントに関連付けることはできません。ただし、以下のいずれかの場合に表示されるポップアップを通じてこれを実現できます:

• プロジェクトを初めて本番環境にデプロイする場合、コンソールの右上隅にある環境ドロップダウンをクリックして本番環境に切り替えると、Catalystは自動的にポップアップを表示します。

• 初回以降にプロジェクトを本番環境にデプロイする場合、このポップアップは、本番アカウントにまだ関連付けられていないルールの_Diff Generation_ステップの後に表示されます。これには、前回の本番デプロイ後に作成されたルールも含まれます。

ポップアップでは、以下の手順を実行する必要があります:

1. テキストボックスをクリックして、Zoho Event Listenerの各既存ルールに対して関連するサービスのアカウントを選択します。
   
   

2. 一覧から同期済みアカウントを選択するか、新しいアカウントを追加します。一覧表示されるアカウントには、そのサービスの_Integration_設定の_Production_セクションで追加されたアカウントが含まれます。
   
   

下部のAdd new accountをクリックして新しいアカウントを追加することもできます。手順は前のセクションで説明したものと同じです。

3. このポップアップですべての既存のZoho Event Listenerルールのアカウントを設定した後、Confirmをクリックします。
   
   

プロジェクトを初めてデプロイしていたか、または後続のデプロイであったかに応じて、プロセスの次のステップがそれに応じて続行されます。

Zoho Event Listenerのルールの編集

Zoho Event Listenerのルールを編集し、名前、説明、詳細フィルター、またはターゲットポイントおよび関連するイベントFunctionsやCircuitsを変更できます。

Zoho Event Listenerのルールを編集するには:

1. Event Listenerのページからルールの省略記号アイコンをクリックし、Editをクリックします。
   
   

2. 必要な変更を行い、Updateをクリックします。
   
   

Zoho Event Listenerのルールの無効化

Zoho Event Listenerのルールを一時的に無効化する必要がある場合、ルールを無効化できます。これにより、Event Listenerはそのルールに関連付けられたイベントのリッスンを停止し、イベント発生時に関連するFunctionsやCircuitsは呼び出されません。

Zoho Event Listenerのルールを無効化するには:

1. Event Listenerのページからルールの省略記号アイコンをクリックし、Disableをクリックします。
   
   

2. 確認ポップアップでYes, Proceedをクリックします。
   
   

ルールが無効化されます。省略記号アイコンをクリックし、Enableをクリックすることで再度有効化できます。

Zoho Event Listenerのルールの削除

Zoho Event Listenerのルールを削除するには:

1. Event Listenerのページからルールの省略記号アイコンをクリックし、Deleteをクリックします。
   
   

2. 確認ポップアップウィンドウでYes, Proceedをクリックします。
   
   

Zoho Event Listenerの編集

以下の方法でZoho Event Listenerの名前を変更したり、説明を編集したりできます:

1. Zoho Event Listenerのページ上部の省略記号メニューをクリックし、Editをクリックします。
   
   

2. Event Listenerの詳細を更新し、Saveをクリックします。
   
   

Zoho Event Listenerの削除

Zoho Event Listenerを完全に削除するには:

1. Zoho Event Listenerのページ上部の省略記号メニューをクリックし、Deleteをクリックします。
   
   

2. 確認ポップアップでYes, Proceedをクリックします。