Catalystコンポーネントイベントリスナー

はじめに

すべてのCatalystプロジェクトには、プロジェクト作成時に作成される1つのコンポーネントイベントリスナーが含まれています。前のセクションで説明したように、コンポーネントイベントリスナーとカスタムイベントリスナーの動作と機能は異なります。

Catalystコンポーネントイベントリスナーは、Catalystコンポーネントをターゲット関数またはCircuitにリンクし、呼び出し時にコンポーネントデータを関数またはCircuitに渡すために使用されます。

以下の表は、Catalystコンポーネントのリストと、コンポーネントイベントリスナーに関連付けることができるイベント発生を説明しています:

たとえば、コンポーネントイベントリスナーのルールがFile Store内の3つのフォルダー（Folder1、Folder2、Folder3）のファイルアップロードイベントに関連付けられているとします。ターゲット関数は_Function1_と_Function2_です。これは、これらの3つのフォルダーのいずれかにファイルがアップロードされるたびに、_Function1_と_Function2_の両方が実行されることを意味します。

フォルダーID、ファイル名、3つのフォルダーすべてのイベント時刻などのイベントデータは、事前定義されたパターンで_Function1_と_Function2_の両方に渡されます。データはイベントリスナーからターゲット関数またはCircuitに常にJSON形式で渡され、このデータはCircuitまたは関数内で処理して必要なアクションを実行できます。

ルールを作成すると、コンソールにサンプルデータパターンが表示されます。これは、イベント発生時に関数に渡されるデータのサンプル構造を示しています。データパターンは、ルールが関連付けられているコンポーネントとアクションに基づいて異なります。これは、異なるイベントには異なるデータが含まれるためです。

たとえば、ルールがAuthenticationのサインアップイベントに関連付けられている場合、イベントデータは以下のパターンになります:

{
    "project_details": {
        "id": 57*************,
        "project_name": "Eventbus"
    },
    "event_bus_details": {
        "name": "Default",
        "id": 57*************
    },
    "data": {
        "platform_type": null,
        "user_details": {
            "email_id": "emma@zylker.com",
            "role_details": {
                "role_name": "App User",
                "role_id": 57*************
            },
            "zaaid": 1002347509,
            "created_time": "Sep 10, 2019 11:47 PM",
            "invited_time": "Sep 10, 2019 11:47 PM",
            "modified_time": "Sep 10, 2019 11:47 PM",
            "user_id": 57*************,
            "is_confirmed": true,
            "last_name": "",
            "first_name": "Amelia Burrows",
            "zuid": 1002342431,
            "status": "ACTIVE"
        },
        "org_id": 1002347509,
        "zaid": 1002345135,
        "redirect_url": null
    },
    "current_project": {
        "id": 57*************,
        "project_name": "Eventbus"
    },
    "action": "SignUp",
    "source": "UserManagement",
    "event_time": 1568139437092
}

ルールは、プロジェクトの詳細やイベントに関するその他のメタデータとともに、ユーザーとサインアップデータを渡します。ターゲット関数をコーディングしたり、Circuitを設定して、必要に応じてイベントデータを処理できます。

それでは、Catalystコンソールでイベントリスナーを操作しましょう。

コンポーネントイベントリスナーでルールを作成する

コンソールのCloud Scaleセクションにある_Triggers_セクションから_Event Listeners_コンポーネントにアクセスできます。Catalystコンポーネントイベントリスナーはデフォルトで既に存在しています。

コンポーネントイベントリスナーでルールを作成するには:

1. CatalystコンソールのCloud Scaleセクションにある_Triggers_の下のEvent Listenersに移動します。
   
   Event Listenersページには、Catalystコンポーネントイベントのタイルが表示され、その日の処理済み、失敗、キューイベントの統計が表示されます。
2. イベントリスナーのタイルのViewをクリックして開きます。
   
   
3. Create Ruleをクリックします。
   
   
4. ルールの名前と説明を入力します。
   
   
5. ドロップダウンリストからルールに関連付けるコンポーネントを選択します。コンポーネントを選択すると、ポップアップにターゲット関数またはCircuitに渡されるデータのサンプル構造が表示されます。前述のように、このデータパターンは選択するコンポーネントごとに異なります。
   
   選択したコンポーネントに基づいて、追加情報の入力が必要になる場合があります。たとえば、「Data Store」を選択した場合、ルールに関連付ける1つ以上のテーブルを選択できます。
6. ルールに関連付けるコンポーネントで発生するアクションを選択します。前述のように、これらのアクションもコンポーネントに基づいて異なります。
   
   

7. Target PointとしてFunctionまたはCircuitを選択します:

   • Functionsをトリガーする場合:
     イベント発生時に呼び出すターゲット関数を選択します。1つ以上の関数を選択できます。
     
     

   • Circuitsをトリガーする場合:
     ドロップダウンリストからターゲットCircuitを選択します。1つ以上のCircuitを選択できます。
     
     

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

ルールが作成されました。コンポーネントイベントリスナーのセクションから、すべてのルールとその詳細の一覧を確認できます。

一覧からルール名をクリックすると、ルールの詳細とサンプルデータパターンが表示されます。

これらのセクションの詳細については、処理済みイベントおよびキューイベントのページを参照してください。

Catalystコンポーネントリスナーのアラート設定

前述のように、イベントリスナーで障害、コード例外、またはプロセスタイムアウトが発生した場合に、自動メールアラートを送信するよう設定できます。これらのアラートは、Application Alertsコンポーネントに移動することなく、Event Listenersセクションで直接設定できます。

1. アラートを設定するには、イベントリスナーの詳細セクションで**+ Configure**ボタンをクリックします。

2. アラートを設定した後、Confirmをクリックして有効にします。

3. アラートステータスの横にある省略記号アイコンをクリックし、Removeをクリックしてアラートを削除することもできます。