After following the steps to configure your Salesforce integration, you can then configure the Perspectium application to share data out of your Salesforce Org.
Shares
The Shares tab contains the different options to share data out of your Salesforce org:
Dynamic Share
A dynamic share allows for real-time sharing of Salesforce records as they are created, updated, and/or deleted. In other words, dynamic shares are caused by some triggering event (such as when cases are created, updated, or deleted). The data is shared to a subscriber, which can be the DataSync Agent, or any number of the other applications that Perspectium can integrate with.
When selecting the Dynamic Share option you are presented with the following options:
Create New Dynamic Share so you can create a new dynamic share to share out records real time for a selected table (SObject).
View Dynamic Shares to see the dynamic shares you previously created and so you can update and delete them.
When creating or editing a dynamic share, do the following to ensure the dynamic share is set up correctly:
- Click Save to first save the dynamic share configuration. After you save, the dynamic share show a preview of the Apex trigger that will be created to capture real time changes.
- Click Save Trigger to save the Apex trigger. Repeat these steps anytime you make changes to the dynamic share.
If you prefer, you can modify the trigger directly by doing the following:
Since Apex triggers are considered code that requires test coverage, you will need to have a test class for your Apex trigger to deploy it into production. See the following for an example Apex trigger test class.
Bulk Share
A bulk share is a job that sends out bulk records from your Salesforce org as a pre-filtered range of data, at a point in time all at once. The data is shared to a subscriber, which can be the DataSync Agent, or any number of the other applications that Perspectium can integrate with.
When selecting the Bulk Share option you are presented with the following options:
Create New Bulk Share to create a new bulk share to share out records at a point in time for a selected table (SObject).
View Bulk Shares allows you to see the bulk shares you previously created and so you can re-execute them.
When creating a bulk share, you can Save the bulk share to save the bulk share or click Execute Now to save and execute the bulk share. Once a bulk has been executed, the bulk share's configurations cannot be changed but it can be executed again by clicking the Execute Now option again.
Some notable features for bulk shares:
Preview - The Preview button will allow you to get a preview of how records the bulk share will share out when executed.
Clone - To create a copy of this bulk share. This is useful if you have a current bulk share that's been executed and you want to use it with changes to some of the configurations without having to create a brand new bulk share and reconfigure from scratch.
Enable Confirmation - To have the DataSync Agent validate that it has received all the records shared out as part of this bulk share execution. The bulk share will send out compare messages that the Agent will use to validate records were received. If the Agent finds that a record is missing (by verifying the record exists when querying for it by the record's Id), it will send back a reshare message telling the Perspectium application in Salesforce to reshare those records. The application will create a new reshare bulk share (named Reshare <Bulk Share Name> Datetime i.e. Reshare AccountShare 2024-02-07 19:29:03) to share out the missing records and another compare message so the Agent can confirm its receive these records. This will repeat until the Agent has confirmed the records are all received.
Share Updates Since Then - To share records only since the last time this bulk share was executed. After the first run (in which all records will be shared based on any filter conditions you enter), the bulk share will then only share any records that were updated since the last time the bulk share executed (using the bulk share's Started time as the last time it executed). This is useful if you set up the bulk share in a scheduled bulk share to share out only changes on a scheduled basis.
Scheduled Bulk Share
Schedule one or more bulk shares to run at a scheduled interval you choose. After creating a bulk share, you can add the created bulk configuration as a child record to be run under the schedule specified within your scheduled bulk configuration.
When selecting the Scheduled Bulk Share option you are presented with the following options:
Create New Scheduled Bulk Share to create a new scheduled bulk share and select which bulk shares to be run and at what intervals.
View Scheduled Bulk Shares allows you to see the scheduled bulk shares you previously created and modify their configurations
When creating a new scheduled bulk share (or modifying a current one), you can do the following:
- Select a date and time in the Scheduled Date Time field for when to start bulk sharing records, and the Days and Hours to repeat the process in the Repeat Interval field.
- In the Available Bulk Shares, select which bulk shares you want to schedule.
- Check the Active box to activate the scheduled bulk share.
- Click Save to save your changes.