Versions Compared

Old Version 33

changes.mady.by.user Amritesh Singh

Saved on

compared with

New Version 34

changes.mady.by.user Kalpana Malladi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

...

The Salesforce Subscriber Snap is a Read-type Snap that provides the functionality to subscribe to Salesforce Platform and CDC events for a given standard and custom Salesforce object. 

Note

Refer the Salesforce Platform Event Allocations and Subscribe to change events documents before configuring this Snap.

Supported Salesforce Events

...

Limitations and Known Issues

  • For a Salesforce (Platform Events) Subscriber Snap, retry attempts are not logged, and currently retries are attempted only for authentication errors.

  • Salesforce imposes a limit on the number of subscriptions. See Change Data Capture Allocations for details.

  • Supports only Platform and CDC events.

...

From 4.30 release, the Snap stops and reports the error immediately when it encounters the daily limit exceeded error. Earlier, the Snap reported an error and stopped only at the next resubscribe attempt when it encountered the daily limit exceeded error.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input

Document

  • Min:0

  • Max:1

  • JSON Parser

  • Mapper

This Snap at the most can have only one input document that contains data to be listened on a Salesforce object.

Output

Document

  • Min:1

  • Max:1

  • JSON Formatter

  • Mapper

A document with Map data that contain the individual records subscribed on the given Salesforce object and/or original fields.

Snap Settings

Field

Field Type

Description

Label*


Default Value: Salesforce Subscriber
Example: Salesforce Subscriber

String

Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipelinepipeline.

Service Version*


Default value: Salesforce Subscriber 44.0 
Example:  Salesforce SubscriberService Version* 44.0

String/Expression

Specify the version number of the Salesforce service that you want to connect to.

Info

Salesforce platform event is supported in version 44.0 or later.

Events*


Default value: 44.0 Value: N/A
Example: 44.0Events*

  • Printer_Event__e

  • AccountChangeEvent

String/Expression

The Specify the Salesforce Platform Event or CDC Event. This is a suggestible field that lists the Platform Events and CDC events available to you.  

Example:

  • Printer_Event__e

  • AccountChangeEvent

Default value: None

Replay ID*Replay ID*


Default Value: -2
Example: 20

Integer/Expression

Specify the position of an event in the event stream. The Snap supports the following IDs:

  • -2: Receives events from the earliest event position in the stream.

  • -1: Receives events from the latest event position in the stream.

  • A specific positive value ID: Receives events after the specified positive ID value.

If you stop a Pipeline execution, the Replay ID is lost and the Snap restarts from the position you input here.

Note

The Snap automatically sets the Replay ID value to -2 when:

  • the specified Replay ID is invalid or outside the retention window.

  • the CreatedDate of the most recent event received by Snap is outside the 72-hour retention window.

Message Count*


Default Value: -21
Example: 20Message Count* 2

Integer/Expression

Specify the number of messages required to read and complete the Pipeline execution.

Note

If the value is set to -1, the Snap waits indefinitely and reads messages whenever available until you manually stop the Pipeline pipeline execution.

Pass Through


Default Value: -1
Example: 2

Pass Through

  Selected

Checkbox

Select this checkbox to pass the input document the output view under the key 'original'.

If you deselect this checkbox, the input document will not be passed and there is no "original" key in the output document.

Default Value:  Selected

Advanced Properties

Use this fieldset to configure Http Long Polling.

Properties


Default Value: N/A
Example: maxNetworkDelay, maxMessageSize

String

Enter Specify the property or select from the suggestion list.

Values

Default Value: N/A
Example: maxNetworkDelay, maxMessageSize

Values

50000

String

Enter Specify the value for the property.

Snap Execution


Default Value: N/A Validate & Execute
Example:  50000

Snap Execution

Execute only

Dropdown list

Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read

...

Note

The field labels for this Snap are updated to title case. If you have existing pipelines that include the field names in the error pipelines, you must update those pipelines to use the new field names.

Troubleshooting

Error

Reason

Resolution

403::Handshake denied; 401::Request requires authentication

Client is not authorized to access the server due to either a domain mismatch or authentication failure.

Configure the Enhanced Domain in the Instance URL property to ensure authentication for successful access to the server.

...

Process Platform Events in Salesforce

This example Pipeline demonstrates how the Salesforce Subscriber Snap processes platform events. The following Salesforce Subscriber Snap shows how the Snap is configured and how the Salesforce object's records are read.

...

You can see that the Replay ID is -2. So the Snaps reads messages from the beginning. And the Snap reads only 3 messages as the Message count is set to 3.The Snap processes the events and the output preview is as follows:

...

Download this Pipeline.

Downloads

...