On this Page
| Table of Contents | ||||
|---|---|---|---|---|
|
Overview
The Salesforce Publisher Snap is a Write-type Snap that publishes Salesforce Platform Event records to a given event custom Salesforce object. Salesforce Platform Events are part of Salesforce’s enterprise messaging platform and help deliver secure and scalable custom notifications within Salesforce or from external sources.
In Bulk API mode, the Snap publishes multiple platform event records in batches.
In REST API mode, the Snap publishes only one platform event record per each request, for each input document.
| Info |
|---|
Refer the Salesforce Platform Event Allocations document before configuring this Snap. |
Supported Salesforce Events
- Platform events: User-defined read/write events. These events end with "_e".
Input and Output
Expected input: A stream of documents whose data schema is the same as the schema that is defined in the selected Platform Event custom SObject. Each document contains one Salesforce Platform Event record. The Snap supports the input schema suggest functionality that shows the input schema in the Target path of the Mapper Snap if the Mapper Snap is connected to the input view.
Expected output: A stream of documents that contain the success field for the event record that is published, and the original field for the corresponding input record.
Expected upstream Snaps: Any Snap with a document output view. For example, JSON Parser, Mapper.
Expected downstream Snaps: Any Snap with a document input view. For example, JSON Formatter, Mapper.
Prerequisites
None.
Configuring Accounts
This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Salesforce Account for information on setting up this type of account.
Configuring Views
Input
This Snap has exactly one input view.
Limitations and Known Issues
- In Salesforce 44.0, when an input document contains extra fields which are not part of the list of fields defined in a given Platform Event object, the error handling of Salesforce.com in REST API and Bulk API is different. REST API throws the error: "No such column ...". However, Bulk API ignores all extra fields and successfully publishes records as long as the mandatory fields are present.
- This Snap performs batch processing, that is, a batch of input documents are processed for each HTTP request sent to Salesforce. Values of all the expression-enabled fields must remain constant during the Snap execution or validation. Hence, all expression fields can support Pipeline parameters only when they are expression-enabled. The input data parameters are not supported for expression fields, for example, $serviceVersion.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Snap Input and Output
| Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
| Input | Document | Min: 1 Max: 1 |
| A stream of documents whose data schema is the same as the schema that is defined in the selected Platform Event custom SFObject. Each document contains one Salesforce Platform Event record. The Snap supports the input schema suggest functionality that shows the input schema in the Target path of the Mapper Snap if the Mapper Snap is connected to the input view. |
| Output | Document | Min: 0 Max: 1 |
| A stream of documents that contain the success field for the event record that is published, and the original field for the corresponding input record. |
Snap Settings
| Field | Field Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| Label* | 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 Pipeline. Default Value: Salesforce Publisher | ||||||
| Service Version* | String | Specify the version number of the Salesforce service that you want to connect to.
Default Value: 44.0 | ||||||
| Events* | String | Specify the name of the Salesforce platform event custom object. All Salesforce platform event object names end with The supported Salesforce Events are:
Default Value: None | ||||||
| Salesforce API | Dropdown list | Select the Salesforce API mode. The available options are:
Default Value: REST API | ||||||
| Batch size | Integer | Specify the batch size in records.
Default Value: 200 | ||||||
| Batch timeout | Integer | Specify the batch timeout in seconds. The Snap sends a batch write request to SDFC when the number of input documents in the buffer reaches the given Batch size. However, sometimes, input documents may not arrive for a long time. In such cases, a Batch timeout value helps send a batch write request in a specified time interval even if the number of input documents in the buffer is less than the buffer size. If you set Batch timeout to 0, the Snap waits until the number of input documents in the buffer reaches the Batch size. Default Value: None | ||||||
| Number of retries | Integer | Specify the maximum number of retry attempts in case of a network failure. Default value: 1
| ||||||
| Retry interval (seconds) | Integer | Specify the minimum number of seconds for which the Snap must wait before attempting recovery from a network failure. Default Value: 1 | ||||||
| Pass through | Checkbox | Select this checkbox to pass the input document through to the output view under the key Default Value: Selected | ||||||
Snap Execution | Dropdown list |
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Example
This Pipeline demonstrates how the Salesforce Publisher Snap processes three different input documents. The first document is a valid record. The second document has one required field that is missing. The third document contains an extra field that is not a part of the field that is defined in the Event object.
Download this Pipeline.
| Expand | ||
|---|---|---|
| ||
The JSON Generator Snap is used to provide the input document. The input document contains different values for a printer. The input data preview is as follows:
We use the Salesforce Publisher Snap to publish the values. The following image displays the Snap configuration in REST API mode:
All the expression properties in the Snap use Pipeline parameters. The following image displays the Pipeline parameters that are used in this example:
After you validate the Pipeline, you can see that the first document is successfully published in both the modes. The second input document produces an error document in the error view in both REST and Bulk API modes. The third document produces an error document in the error view in REST API, but is successfully published in Bulk API. Following is the output preview in the Bulk API mode:
Following is the output preview of the error document in Bulk API mode:
Following is the output preview in the REST API mode:
Following is the output preview of the error document in the REST API mode:
|
Downloads
| Attachments | ||
|---|---|---|
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|