Salesforce Plugin Real Time Configuration¶
The following provides instructions for configuring the Salesforce Real Time Plugin.
Supported Versions¶
The Salesforce plugin uses the Salesforce API v52.0 and is compatible with both Salesforce Classic and Salesforce Lightning. Real time schedules are supported for discovered schemas and custom schemas that do not contain a Salesforce Relationship Query.
Salesforce Plugin Configuration within Aunsight Golden Record¶
The Salesforce plugin requires the user to create a Salesforce Push Topic within Salesforce and enter the name of the created push topic in the plugin configuration.
-
On the Configure Connection, click Connect to Oauth.
-
In the prompt, enter your Salesforce username and password and click Login.
-
Once logged into Salesforce, click Done and proceed through the remaining connection steps.
-
At the Schedule step of the Golden Record setup, select Real Time from the Schedule drop down and then click Configure.
-
Complete the fields in the Real Time slide out, populating the Channel Name from Salesforce and Batch Window.
Note
If you do not know your channel name, below are instructions to create a push topic channel or find an existing push topic channel.
Creating a Push Topic¶
-
Log into Salesforce and navigate to the Developer Console from the gear in the upper right corner.
-
From the Developer Console, select Execute Anonymous Window under the Debug menu. Ctrl + E is the keyboard shortcut.
-
Enter your version of the sample code into the Enter Apex Code window.
PushTopic pushTopic = new PushTopic(); pushtopic.Name = '<YourChannelName>'; pushtopic.Query = '<YourQuery>'; pushTopic.ApiVersion = 52.0; insert pushTopic;
The query entered will define what data is defined in real time. These pages may be helpful: Supported PushTopic Queries and Unsupported PushTopic Queries.
Note
Save your pushTopic.Name value for use as your Channel Name for real time read schedule configuration.
Finding Existing Push Topics¶
-
Log into Salesforce and navigate to the Developer Console from the gear in the upper right corner.
-
Enter the following query inside the Query Editor tab at the bottom of the Developer Console, and click Execute.
SELECT Id, Name, Query FROM PushTopic
Note
The value in Name will be your Channel Name for real time read schedule configuration.