メッセージの永続性

イベントバス

API バージョン 37.0 以降では、イベントはイベントバスに公開されます。登録者は、イベントバスのチャネルからイベント (一時的に保存されている過去のイベントを含む) を取得します。イベントバスは、イベント公開者とイベント登録者を分離します。

イベントの再実行プロセス

各イベントメッセージに、ReplayId 項目に含まれる不透明 ID が割り当てられます。ReplayId 項目値は、イベントが登録者に配信されるときにシステムによって入力され、イベントストリーム内のイベントの位置を参照します。連続するイベントに対して再生 ID の値に連番が振られるという保証はありません。登録者は再実行 ID の値を保存し、再登録時にその値を使用して、保持ウィンドウ内のイベントを取得できます。たとえば、登録者は、接続に失敗した後、欠落したイベントを取得できます。ただし、登録者は、保存した再実行 ID に基づいて新しい再実行 ID を計算し、システム内の他のイベントを参照することはできません。

プラットフォームイベントメッセージを一意に識別するには、ReplayId 項目ではなく、EventUuid システム項目を使用します。ReplayId 項目は、Salesforce のメンテナンス活動 (組織の移行など) が行われると、一意でなくなる可能性があります。EventUuid 項目の値は常に一意です。

次の例は、replayId 項目を含むイベントメッセージの内容を示しています。例の replayId 項目には数字が含まれていますが、それらは不明確な項目です。これらの値が、常に数値を含むと仮定しないことをお勧めします。replayId の値はバイト型で保存するのが最良の方法です。

CometD クライアントに配信されるときに、プラットフォームイベントメッセージに再実行 ID が含まれます。次の JSON メッセージは Low_Ink__e プラットフォームイベントのイベントオブジェクトの replayId 項目を示します。

1{
2  "data": {
3    "schema": "dffQ2QLzDNHqwB8_sHMxdA", 
4    "payload": {
5      "CreatedDate": "2023-04-09T18:31:40.517Z", 
6      "CreatedById": "005D0000001cSZs", 
7      "Printer_Model__c": "XZO-5", 
8      "Serial_Number__c": "12345", 
9      "Ink_Percentage__c": 0.2
10    }, 
11    "event": {
12      "EventUuid": "2ec0e371-1395-457f-9275-be1b527a72f7",
13      "replayId": 2112
14    }
15  }, 
16  "channel": "/event/Low_Ink__e"
17}

次の JSON メッセージは変更データキャプチャイベントのイベントオブジェクトの replayId 項目を示します。

1{
2  "data": {
3    "schema": "IeRuaY6cbI_HsV8Rv1Mc5g", 
4    "payload": {
5      "ChangeEventHeader": {
6        "entityName": "Account", 
7        "recordIds": [
8          "<record_ID>"
9        ], 
10        "changeType": "CREATE", 
11        "changeOrigin": "com.salesforce.core", 
12        "transactionKey": "001b7375-0086-250e-e6ca-b99bc3a8b69f", 
13        "sequenceNumber": 1, 
14        "isTransactionEnd": true, 
15        "commitTimestamp": 1501010206653, 
16        "commitNumber": 92847272780, 
17        "commitUser": "<User_ID>"
18      }, 
19      "Name": "Acme", 
20      "Description": "Everyone is talking about the cloud. But what does it mean?", 
21      "OwnerId": "<Owner_ID>", 
22      "CreatedDate": "2017-07-25T19:16:44Z", 
23      "CreatedById": "<User_ID>", 
24      "LastModifiedDate": "2017-07-25T19:16:44Z", 
25      "LastModifiedById": "<User_ID>"
26    }, 
27    "event": {
28      "replayId": 6421
29    }
30  }, 
31  "channel": "/data/ChangeEvents"
32}

イベントの再実行

登録者は、保管期間内や特定のイベント後のすべてのイベントなど、受信するイベントを選択できます。デフォルトでは、登録後に送信された新規イベントのみを受信します。イベントは保管期間を過ぎると破棄されます。

次の概要図は、イベントコンシューマーがさまざまな再実行オプションを使用してイベントのストリームを読み取る方法を示しています。

イベントを再実行するには、ストリーミング API エンドポイントを使用します。

1https://MyDomainName.my.salesforce.com/cometd/60.0/

1// Register streaming extension
2var replayExtension = new cometdReplayExtension();
3replayExtension.setChannel(<Streaming Channel to Subscribe to>);
4replayExtension.setReplay(<Event Replay Option>);
5cometd.registerExtension('myReplayExtensionName', replayExtension);

拡張に対して setReplay() 関数をコールすると、その後で登録者が受信するイベントは setReplay() に渡された再実行値パラメーターに依存します。

40 秒以内に接続されなかったかネットワーク障害が発生したためにクライアントがタイムアウトすると、クライアントは新しいハンドシェイク要求と再接続を試みます。再実行拡張は最後の受信メッセージの再実行 ID を保存し、再登録するときにその ID を使用します。そのため、クライアントはタイムアウト後に送信されたメッセージのみを受信し、タイムアウト前に送信された重複メッセージは受信しません。

コードサンプル

Java のサンプル

CometD 拡張を使用する Java クライアントのサンプルについては、「例: Java クライアントを使用したイベントの登録と再実行 (EMP コネクタ)」を参照してください。

Lightning コンポーネントのサンプル

empApi コンポーネントを使用するサンプルについては、「例: Lightning コンポーネントを使用した登録とイベントの再実行」を参照してください。

Visualforce のサンプル

Visualforce と CometD 拡張を JavaScript で使用する例およびコードのウォークスルーについては、「例: Visualforce ページを使用した登録とイベントの再実行」を参照してください。