Skip to main content
Feedback

Salesforce Platform Events operation

The Salesforce Platform Events operation defines how to interact with your Salesforce account instance.

The operation represents a specific action (Listen and Send) to be performed against a specific Salesforce record type or object (Account, Opportunity, Contact, etc.). Create a separate operation component for each action/object combination that is required for your integration. Not all actions are available for every object.

The Salesforce Platform Events operation supports the following actions:

  • Listen — Used to retrieve messages from a queue or topic asynchronously in real-time.

    • Listen operations are only available on the Start step in a process.
    • You can view the status of listener processes that are deployed to a basic runtime, runtime cluster, or runtime cloud by going to the Listeners panel in Manage > Runtime Management.
    • On the Listeners panel, you can pause, resume, and restart listeners.
    • Listen processes can run in low latency mode. For more information, see the Low latency processes topic.
    • Listen operations honor the basic runtime proxy settings for Proxy Host, Proxy Port, Proxy User ID, Encrypted Proxy Password, and Non Proxy Hosts from the container.properties file and not the atom.vmoptions file. For more information, see the linked Properties panel topic.
    • The Listen manager can use the Persisted Connector Cache to save and retrieve the replayID on send and receive actions when the Enable Persisted Connector Cache (com.boomi.container.connector.persistence.enabled) container property is enabled in the Advanced Properties section of the container properties. If the container owner is filtering out a specific set of connectorType values to use connector property persistence on runtime, then ensure that this connector is included. This allows the SFPE connector to persist the replayID and start over from the point before the stop when pausing or stopping the listener if it is done within the retainment window. If the persisted replayID is invalid, the fail over is to the initial replayID mentioned in the connection.
    note

    Test mode does not support real-time triggering and, therefore, cannot be used with listener processes.

  • Send — Used to send messages (JSON structured document) to a queue or topic. Send operations are available on the Start step in a process.

When you choose the setting to return application error responses, the application error includes the response from the service (if available). You can troubleshoot errors on the Process Reporting page.

Singleton mode

The Salesforce Platform Events connector runs in singleton mode by default and listeners will only submit executions from a single node of a runtime cluster or cloud.

To learn more about setting container properties, see the topic Setting or viewing basic runtime, runtime cluster, Cloud, or Account properties.

Change Data Capture Events

Listen operations provide the flexibility when browsing (Import Wizard) to choose which streaming event type (Platform Events or Change Data Capture Events) the connector works with. After selection, the Object Type displays all available channels for the selected streaming event type and you choose the specific channel the Listen operation subscribes to. The operation can listen for exclusive changes to Account objects, Asset objects, etc. that have been selected for Change Data Capture in Salesforce. To learn how to select objects for Change Data Capture in Salesforce, see the Select Objects for Change Notifications in the User Interface topic in the Change Data Capture Developer Guide.

Change Data Capture supports receiving near-real-time change events to a Salesforce record type or object by subscribing to Change Data Capture channels. By subscribing, the connector can update data in an external system rather than having to perform exports and imports of data. Capturing changes in this way ensures that the data in your external system is updated in real time and stays fresh.

Listening for all objects

All ChangeEvents is a special channel that may be subscribed to, allowing the Listen operation to listen for all Salesforce objects that have been selected for Change Data Capture.

Listening for custom objects

The connector can listen to specific channels for Salesforce custom objects unique to your organization. The number of channels appearing for subscription depends on the number of custom objects defined:

  • If no custom objects are defined, no channel appears for subscription.
  • If only one custom object is defined, that specific channel appears for subscription.
  • If more than one custom object is defined, that specific number of channels appears for subscription.

Required permissions for Change Events

To subscribe, listen, and receive Change Events on a channel, the subscriber must have the appropriate Change Event permissions. To learn more, see the Salesforce Change Data Capture Developer Guide.

Options tab

Click Import Operation, then use the Import wizard to select the object with which you want to integrate.

note

When browsing objects, only Platform Events objects (event messages or notifications) are available.

The following table describes the fields for each action type:

Tracking Direction - Select the document tracking direction for the operation, either Input Documents or Output Documents. This setting enables you to choose which document appears in Process Reporting. Start steps always track output documents regardless of your selection.

note

If the tracking direction is read-only, the feature to change the direction is either unavailable or the developer set the configuration to read-only. The default value you see shows you which document appears in Process Reporting.

Request Profile - Select or add an XML profile component that represents the structure sent by the connector.

Response Profile - Select or add an XML profile component that represents the structure received by the connector.

Return Application Error Responses - This setting controls whether an application error prevents an operation from completing:

  • If you clear the setting, the process stops and reports the error on the Process Reporting page.
  • If you select the setting, processing continues and passes the error response to the next component processed as the connection output.
note

Return Application Error Responses is unavailable for Listen operations.

Archiving tab

See the topic Connector operation’s Archiving tab for more information.

Tracking tab

See the topic Connector operation’s Tracking tab for more information.

Caching tab

See the topic Connector operation’s Caching tab for more information.

On this Page