Salesforce Events (Beta) Prerequisites¶

Introduction¶

This page describes the prerequisites of the Salesforce Events (Beta) connector.

To use the Salesforce Events (Beta) connector, these prerequisites must be met:

• A 10.61 or later agent is required.

  • To use listening activities (Subscribe Event, Subscribe Insert CDC Event, Subscribe Update CDC Event, or Subscribe Delete CDC Event), a single Private Agent is required. The agent must be the only agent in the Private Agent Group.

    The Private Agent must have listening services enabled as described in Enable Listening Services on the Agent below. This is a manual step in configuration and is not enabled by default.

  • To use the Publish Event activity, a Cloud Agent Group or Private Agent Group may be used.

• A connected app must exist in the Salesforce instance and be configured as described on this page:

  • Configure a Salesforce Connected App
  • Obtain the Consumer Key and Consumer Secret
  • Select the Entities That Generate Events

Enable Listening Services on the Agent¶

Listening services are disabled by default and must be enabled manually following these steps:

1. On the 10.61 or later Private Agent, open jitterbit-agent-config.properties in a text editor.

   This file is located in <JITTERBIT_HOME>/Resources/, where <JITTERBIT_HOME> is replaced with the Private Agent root directory.

2. Add this line to the file to enable the listener framework:

   agent.sdk_framework.listener.enabled=true
   

3. Restart the agent.

Configure a Salesforce Connected App¶

A Salesforce connected app must be be configured as described below.

To create a new custom app in the Salesforce instance, follow these steps using the Salesforce Lightning UI:

1. Navigate to Platform Tools > Apps > App Manager.

2. Click New Connected App in the top right:

   

3. Set up a connected app with a configuration similar to that shown below. Certain fields that are important for use with the Salesforce Events (Beta) connector are identified and described below.

   

   • In Basic Information, provide a Connected App Name that does not contain any spaces, such as JitterbitHarmonySalesforceEventsApp. The API Name field will become autopopulated.
   • In API (Enable OAuth Settings), select Enable OAuth Settings. Additional fields become available to configure:
     • Callback URL: Enter https://jitterbit.com/callback/oauth/connector.
     • Selected OAuth Scopes: Add Full access (full) to the Selected OAuth Scopes.

4. Click Save and follow the prompt to continue. The Manage Connected Apps screen displays, where you can obtain the consumer key and consumer secret.

Obtain the Consumer Key and Consumer Secret¶

To obtain the consumer key and consumer secret in an existing app, follow these steps using the Salesforce Lightning UI:

1. Go to Manage Connected Apps for the existing app.

2. In API (Enable OAuth Settings), click Manage Consumer Details:

   

3. The Consumer Key and Consumer Secret are displayed. Retain these for use in configuring the Salesforce Events (Beta) connection.

   

Select the Entities That Generate Events¶

To configure events to be generated, follow these steps using the Salesforce Lightning UI:

1. Go to Setup. This can be accessed from the gear icon in the top right:

   

2. Navigate to Platform Tools > Integrations > Change Data Capture.

3. On the Change Data Capture screen, select the entities (objects) for which you want events to be generated and add them to Selected Entities.

   

   Important

   When using the Salesforce Events (Beta) connector, if you try to enable events associated with an object that has not been selected here, a permissions error will be returned.