プラットフォームイベントの登録

• プラットフォームイベントメッセージの登録方法を説明する。
• プラットフォーム上と外部アプリケーション内のイベントに登録する。
• Apex テストメソッドでプラットフォームイベントをテストする。
• CometD を介してプラットフォームイベントに登録する。

メモ

このバッジのハンズオン Challenge は日本語、スペイン語 (LATAM)、ポルトガル語 (ブラジル) に対応しています。Playground の言語を変更するには、こちらの指示に従ってください。日本語等、翻訳された言語と英語に差異がある可能性があります。英語以外の言語での指示に従って Challenge に合格できなかった場合は、[言語] と [地域] をそれぞれ [English]、[アメリカ合衆国] に切り替えてからもう一度お試しください。

翻訳版 Trailhead を活用する方法の詳細は、自分の言語の Trailhead バッジを参照してください。

// Trigger for listening to Cloud_News events.
trigger CloudNewsTrigger on Cloud_News__e (after insert) {
    // List to hold all cases to be created.
    List<Case> cases = new List<Case>();
    // Get queue Id for case owner
    Group queue = [SELECT Id FROM Group WHERE Name='Regional Dispatch' AND Type='Queue'];
    // Iterate through each notification.
    for (Cloud_News__e event : Trigger.New) {
        if (event.Urgent__c == true) {
            // Create Case to dispatch new team.
            Case cs = new Case();
            cs.Priority = 'High';
            cs.Subject = 'News team dispatch to ' +
                event.Location__c;
            cs.OwnerId = queue.Id;
            cases.add(cs);
        }
   }
    // Insert all cases corresponding to events received.
    insert cases;
}

デバッグログの設定

標準またはカスタムオブジェクトのトリガーとは異なり、プラットフォームイベントのトリガーは、イベントを公開した Apex トランザクションと同じトランザクションでは実行されません。トリガーは、システムユーザーである自動化プロセスエンティティの下の独自プロセスで実行されます。そのため、トリガー実行に対応するデバッグログは自動化プロセスエンティティによって作成され、開発者コンソールでは使用できません。プラットフォームイベントトリガーログを収集するには、[設定] で追跡フラグエントリを自動化プロセスエンティティに追加します。

1. [設定] から、[クイック検索] ボックスに「デバッグログ」と入力し、[デバッグログ] をクリックします。
2. [New (新規)] をクリックします。
3. [追跡対象エンティティ種別] で、[自動化プロセス] を選択します。
4. 収集するログの開始時刻と有効期限を選択します。
5. [デバッグレベル] に「*」と入力し、[検索] をクリックします。
6. 事前定義されたデバッグレベル (SFDC_DevConsole など) を選択するか、[New (新規)] をクリックして独自のデバッグレベルを作成します。
7. [Save (保存)] をクリックします。

Apex テストのデバッグログは例外です。同じテスト実行ログにイベントトリガーのログが含まれます。

プラットフォームイベントトリガーに関する留意点

イベント定義ページの登録関連リスト

[設定] のプラットフォームイベント定義詳細ページでは、すべてのイベントトリガーの状態を表示できます。[登録] の下で、有効なトリガーのそれぞれが、実行情報および状態と一緒にリストされます。情報には、最終公開イベントや最終処理イベントの再実行 ID が含まれます。状態は、トリガーが実行中であるか、復旧できないエラーや不十分な権限により登録から切断されているかを示します。トリガーの最大試行回数に達した場合にのみ、エラー状態になります。次のスクリーンショットは、Cloud News イベント詳細ページの [登録] 関連リストを示します。

• [登録] 関連リストには、イベントに登録しているフローとプロセスも表示されます。
• [登録] 関連リストには、CometD、Pub/Sub API、empApi Lightning コンポーネントを使用する登録者は含まれません。他の種別の登録者については、この単元で後ほど説明します。
• 大規模プラットフォームイベントの場合、[最終公開 ID] の値は使用できず、常に「利用できません」と表示されます。

イベントの Apex トリガーの登録者の管理

一時停止した登録を停止した場所 (イベントバスで使用可能な最も古いイベントメッセージ) から再開できます。エラーの原因となったイベントメッセージや、不要となったメッセージをバイパスしたい場合は、登録を最新のイベントメッセージから再開できます。

トリガー登録を管理するには、[登録] 関連リストで、Apex トリガーの横にある [管理] をクリックします。

• 実行中の登録を一時停止するには、[Suspend (サスペンド)] をクリックします。
  
  
• 一時停止した登録をイベントバスで使用可能な最も古いイベントメッセージから再開するには、[再開] をクリックします。
• 一時停止した登録を最新のイベントメッセージから再開するには、[Resume from Tip (最新から再開)] をクリックします。
  
  

トリガーを保存すると、トリガー登録が自動的に再開されます。詳細は、『プラットフォームイベント開発者ガイド』の「プラットフォームイベントの詳細ページでのイベントの登録者の表示」を参照してください。

// Create test events
Test.startTest();
// Publish events
Test.stopTest();
// Perform validation here

@isTest
public class PlatformEventTest {
    @isTest static void test1() {
        // Create test event instance
        Cloud_News__e newsEvent = new Cloud_News__e(
            Location__c='Mountain City',
            Urgent__c=true,
            News_Content__c='Test message.');
        Test.startTest();
        // Call method to publish events
        Database.SaveResult sr = EventBus.publish(newsEvent);
        Test.stopTest();
        // Perform validation here
        // Verify that the publish was successful
        System.assertEquals(true, sr.isSuccess());
        // Check that the case that the trigger created is present.
        List<Case> cases = [SELECT Id FROM Case];
        // Validate that this case was found.
        // There is only one test case in test context.
        System.assertEquals(1, cases.size());
    }
}

Lightning Web コンポーネントでの登録

Lightning Web コンポーネントの empApi メソッドを使用するには、次に示すように lightning/empApi モジュールからこのメソッドをインポートします。

import { subscribe, unsubscribe, onError, setDebugFlag, isEmpEnabled }
    from 'lightning/empApi';

次に、インポートしたメソッドを JavaScript コードでコールします。

lightning/empApi モジュールの使用例と詳細なリファレンスについては、Lightning コンポーネントライブラリの lightning-emp-api に関するドキュメントを参照してください。

Aura コンポーネントでの登録

<lightning:empApi aura:id="empApi"/>

/event/<EventName>__e

/event/Cloud_News__e

// Connect to the CometD endpoint
    cometd.configure({
               url: 'https://<Salesforce_URL>/cometd/48.0/',
               requestHeaders: { Authorization: 'OAuth <Session_ID>'}
    });

Pub/Sub API を使用したプラットフォームイベント通知への登録

Pub/Sub API では 1 つのインターフェースでプラットフォームイベントの公開とプラットフォームイベントへの登録を実行できます。Pub/Sub API は gRPC API と HTTP/2 に基づいてバイナリイベントメッセージを Apache Avro 形式で効率的に公開、配信します。gRPC はオープンソースのリモートプロシージャーコール (RPC) フレームワークで、gRPC を使用することでデバイス、モバイルアプリケーション、ブラウザーをバックエンドサービスに接続できます。詳細は、gRPC のドキュメントを参照してください。Apache Avro はデータ逐次化システムです。詳細は Apache Avro を参照してください。

Pub/Sub API はプルサブスクリプションモデルを使用しており、クライアントが処理容量に基づいてサーバーからいくつかのイベントを要求します。プッシュベースのサブスクリプションではクライアントがサーバーからプッシュされた新しいイベントの受信を待ちますが、プルサブスクリプションではクライアントが積極的にサーバーからのイベントを要求します。このイベントフローコントロールでは、イベントの公開が急増した場合にクライアントが処理できないほどのイベントを受信することがありません。

Pub/Sub API には次のような利点があります。

• 1 つの API でイベントの公開、登録、イベントスキーマの取得を実行できる。
• 公開操作によって、中間のキューへの追加の結果ではなく、最終的な公開の結果が得られる。
• フローコントロールで、クライアントのイベント処理速度に基づいて subscribe コールでいくつのイベントを受信するかを指定できる。
• HTTP/2 による圧縮を使用したリアルタイムで高パフォーマンスなデータストリーミングを実現できる。
• クライアントでは gRPC API で提供される 11 種類のプログラミング言語 (Python、Java、Node、C++ など) がサポートされる。サポートされるすべての言語については https://grpc.io/docs/languages/ を参照してください。

CometD クライアントと同じように、イベントチャネルまたはカスタムチャネルを指定することでプラットフォームイベントに登録できます。

CometD クライアントでの JSON 形式のプラットフォームイベントメッセージ

配信されたプラットフォームイベントのメッセージは、次の Cloud News イベントの例のようになります。

{
  "data": {
    "schema": "_2DBiqh-utQNAjUH78FdbQ",
    "payload": {
      "CreatedDate": "2017-04-27T16:50:40Z",
      "CreatedById": "005D0000001cSZs",
      "Location__c": "San Francisco",
      "Urgent__c": true,
      "News_Content__c": "Large highway is closed due to asteroid collision."
    },
    "event": {
      "replayId": 2
    }
  },
  "channel": "/event/Cloud_News__e"
}

イベントメッセージのスキーマ項目には、プラットフォームイベントスキーマの ID が含まれます (この例では "schema":"_2DBiqh-utQNAjUH78FdbQ")。スキーマはバージョン管理されています。スキーマが変更されるとスキーマ ID も変更されます。

イベントのスキーマが変更されたかどうかを判別するには、REST API でスキーマを取得します。スキーマ ID を使用して、REST API リソース /vXX.X/event/eventSchema/Schema_ID に対して GET 要求を実行します。または、エンドポイント /vXX.X/sobjects/Platform_Event_Name__e/eventSchema にイベント名を指定して、イベントスキーマを取得することもできます。詳細は、『REST API 開発者ガイド』を参照してください。

Salesforce Platform と外部アプリケーションでのプラットフォームイベントの使用方法を確認しました。可能性は無限です! プラットフォームイベントは、ビジネストランザクションの処理や予防的なカスタマーサービスの取り組みなど、さまざまなアプリケーションやインテグレーションで使用できます。プラットフォームイベントでは、イベントベースのプログラミングモデルを採用して、イベントベースのソフトウェアアーキテクチャの利点を実現できます。