You are here:
Configuring a Platform Event Data Source (Managed Package)
For the managed package runtime, configure a Platform Event data source to enable apps to communicate inside and outside of Salesforce.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
Platform Events are part of Salesforce’s enterprise messaging platform. A Platform Event combines PushTopic and Streaming Channel. Instead of working with an sObject, Platform Events work with custom objects. See Platform Event Data Source (Managed Package).
To configure a Platform Event data source:
- In the Cards Designer, in the Layout or Cards pane, from the Data Source picklist, select Streaming API.
-
From the Type picklist, select Platform
Event.
- In the Channel field, enter the URL of the Platform Event that you created.
-
From the Operation picklist, select
Replace or Append.
-
Select Replace to overwrite the Card with new data.
-
Select Append to add new data to the Card.
From the Get All Messages picklist, select True or False.
-
Select True to get all data from the last 24 hours.
-
Select False to get the latest data update.
-
-
(Optional). Enter values for these properties:
-
To drill down to a specific dataset, in the Result JSON Path field, enter a path. For example, enter records.results, which drills down to the
resultsarray and passes the array to the card or card layout. -
To sort data by a specific data field, enter the field name in the Order By input field.
-
To reverse the order of the data returned, select True from the Reverse Order picklist.
-
Set a Timeout value in milliseconds.
The timeout value controls the time that the framework waits for the designated data source to return a response. Timeouts improve handling user interactions with long running processes. Setting an appropriate timeout value allows the application and users to react accordingly to long wait times.
-
Set an Interval value in milliseconds.
The card component's data source refreshes continuously at the given interval and checks for changes in data source records. If changes are found, the layout or card component reloads. Setting an interval enables recursive updates of records.
-
-
To preview a card using real data, add a test variable in the Test Data
Source Settings fields. See Testing Data Source Settings (Managed Package).
ImportantAfter configuring a Streaming API data source for an LWC card, you cannot preview the card in the Card Designer's Preview pane. To view the LWC card, you must deploy it, and then add the LWC card to a Lightning or Community page. For more information on deploying an LWC card, see Creating an LWC Card Layout (Managed Package). For more information on adding an LWC card to a page, see Adding an LWC Card to a Lightning or Community Page (Managed Package).
