用語

Catalyst Event Listenersの詳細を読む前に、Catalystのコンテキストで以下の用語を理解してください:

• イベントリスナー: イベントリスナーは、コンポーネントイベントリスナー、カスタム、またはZohoイベントリスナーのいずれかであり、イベント関数またはCircuitの実行をトリガーできます。他のタイプの関数の実行をトリガーすることはできず、イベント関数は他の方法で呼び出すことはできません。イベントリスナーに複数のルールを関連付けることができ、各ルールは複数のイベント関数または任意のターゲットCircuitをトリガーできます。

  Catalystでイベントリスナーが作成されると、一意のEvent Listener IDが自動的に作成されます。このIDとイベントリスナーの名前は、イベントバスの詳細の一部としてターゲット関数またはCircuitに渡されます。各プロジェクトには最大5つのイベントリスナーを含めることができます: カスタム4つとコンポーネントイベントリスナー1つです。

• ルール: ルールは、コンポーネントまたはカスタムイベントリスナーをトリガーする特定のアクションを定義します。

  • コンポーネントイベントリスナー: ルールは、特定のコンポーネントのインスタンスと、それらで発生する一連のアクションに関連付けられます。
  • カスタムイベントリスナー: 各ルールは、イベントリスナーの個々のインスタンスとして機能し、一意のルール識別子によって識別されます。
  • Zohoイベントリスナー: ルールは、関連するZohoサービスで発生する特定のイベントに関連付けられます。
    
    これについては次のセクションで詳しく説明します。
    
    ルールは、受信イベントを関連付けられたイベント関数またはターゲットCircuitの実行と照合し、処理のためにデータをルーティングします。イベントリスナーのルールを作成すると、一意のRule IDが自動的に作成されます。

• イベント:

  • コンポーネントイベントリスナー: コンポーネントで発生する特定のアクションがイベントとみなされます。たとえば、Data Store内のテーブルの更新やアプリケーションへのユーザーのサインアップなどです。コンポーネントイベントの完全なリストは次のセクションに記載されています。
  • カスタムイベントリスナー: アプリケーションのエンドユーザーによってイベントリスナーのURLが呼び出されたときに、イベントが発生したとみなされます。
  • Zohoイベントリスナー: Zoho CRMなどの外部Zohoサービスで発生する特定のアクション。たとえば、特定のルールに関連付けられたCRMアカウントでのリードの作成、受注の更新、キャンペーンの承認、またはメールの送信などです。

• キューイベント: イベントリスナールールが設定されたイベントが発生すると、関連付けられたルールがトリガーされます。その後、イベントは処理のためにキューに入れられます。作成した各イベントリスナーには個別のキューがあります。Catalystは処理中に関連付けられたターゲット関数またはCircuitを実行のために呼び出し、イベントデータを渡します。関数またはCircuitの実行が完了した後、または実行に失敗した場合、イベントはキューから削除されます。
  
  

  たとえば、Data Storeのテーブル挿入イベントでルールを設定した場合、コンポーネントイベントリスナーはそのテーブルでの挿入アクションをリッスンします。そのアクションが発生すると、関連付けられたルールがトリガーされ、イベントが処理のためにキューに入れられます。カスタムイベントリスナーの場合、イベントリスナーのURLが呼び出されると、ルールが関連付けられた関数をトリガーし、それらの実行が完了するまでイベントはキューに入れられます。イベントがキューに入り処理されている際の詳細情報は、コンソールのキューイベントセクションから確認できます。

• 処理済みイベント: コンポーネントまたはカスタムイベントリスナールールの関連付けられたターゲット関数またはCircuitが正常に実行された後、処理済みイベントとみなされます。コンソールの処理済みイベントセクションには、実行された各ルールのイベントトラフィックと実行履歴に関する詳細情報が含まれています。

• 失敗イベント: コンポーネントまたはカスタムイベントリスナールールの関連付けられたターゲット関数またはCircuitの実行が失敗した場合、またはルールが何らかの理由でターゲット関数またはCircuitの呼び出しに失敗した場合、失敗イベントとみなされます。