Skip to Content

Salesforce Events Connector

Summary

The Harmony Salesforce Events Connector establishes access to Salesforce Platform Events and Salesforce Change Data Capture (CDC) Events in a Salesforce instance.

The Salesforce Events connector provides an interface for creating a Salesforce Events connection, the foundation used for generating instances of Salesforce Events activities. These activities, once configured, interact with Salesforce Events through the connection.

The Salesforce Events connector is accessed from the design component palette's Connections tab (see Design Component Palette).

Connector Overview

This connector is used to first configure a Salesforce Events connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific Salesforce Events connection and its activities are referred to as a Salesforce Events endpoint:

Salesforce Events activity types

  • Subscribe Event: Receives a platform event or a CDC event from Salesforce and is intended to be used as a source in an operation.

  • Subscribe Insert CDC Event: Receives an insert CDC event from Salesforce and is intended to be used as a source in an operation.

  • Publish Event: Publishes a platform event in Salesforce and is intended to be used as a target in an operation.

  • Subscribe Update CDC Event: Receives an update CDC event from Salesforce and is intended to be used as a source in an operation.

  • Subscribe Delete CDC Event: Receives a delete CDC event from Salesforce and is intended to be used as a source in an operation.

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and Supported API Versions

Prerequisites for using the Salesforce Events connector are described in Salesforce Events Prerequisites.

The Salesforce Events connector uses the Salesforce REST API version specified in the Salesforce Events connection. Refer to the API documentation for information on the schema nodes and fields.

Troubleshooting

If you experience issues with the Salesforce Events connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

  4. If using Private Agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.platformevents" level="DEBUG"/>
    
  5. If using Private Agents, you can check the agent logs for more information.

Common issues with listening activities (Subscribe Event, Subscribe Insert CDC Event, Subscribe Update CDC Event, or Subscribe Delete CDC Event) are described below.

Issue Cause Workaround
Events cannot be enabled or disabled. The Private Agent has recently been installed or restarted. Open the connection configuration and test the connection to force the connector to be downloaded to the agent.
Events cannot be enabled.

The Salesforce connection credentials may be locked or incorrect.

In this case, the following error details will be returned: Unable to login; INVALID_LOGIN: Invalid username, password, security token; or user locked out.

Confirm the connection configuration is correct.
Events cannot be enabled. The maximum number of clients (subscribers) allowed by the Salesforce instance has been reached. None.
Units of measurement are not returned in the response. Measurement symbols such as $ and % are not returned due to the design of the Salesforce API. None.
Null values are returned in the response. For CDC activities, unmodified fields are returned as null in the response due to the design of the Salesfoce API. None.