Set up Real-Time Updates

The Folio Docs package uses Change Data Capture (CDC) in a few different places.

What ships out of the box

Out of the box, there is a default Change Data Capture subscription enabled on the Folio Junction object: the object that connects Documents to any record and Tag.

This enables new Documents to appear in the Document Editor sidebar in real time. For example, if you’re looking at a Document under an Account and someone else creates a new Document under that same Account while you’re viewing it, the new Document will automatically show up in the sidebar without you having to refresh your page.

Admins do not need to do anything to configure this. The Change Data Capture subscription on the Folio Junction object ships enabled with the package and works automatically.

Enable CDC on Linkable Objects

Recommended but optional: enable Change Data Capture for any Linkable Objects that have Live Fields configured. Doing so enables:

  1. Real-time updates into Document field references when data is changed on a linked record. As soon as the value changes on the source Salesforce record, any Live Field chips referencing it in open Documents will update immediately, and the user will see a toast message appear notifying them that the change took place.
  2. Auto-sharing of Documents with a new owner when ownership of a linked record changes. This is default supported for Account, Contact, Case, and Opportunity, but Change Data Capture must be turned on for these objects in order for it to work. Any other objects are not default supported, but the same behavior can be built into a Flow using the Share Document invocable Apex action (see Automate with Invocable Apex).

How to enable Change Data Capture

  1. Go to Setup and search for Change Data Capture in the Quick Find box.
  2. In the Available Entities column on the left, select the objects you want to enable CDC on.
  3. Click the arrow to move them over to the Selected Entities column on the right.
  4. Save.

Best practice: Enable Change Data Capture for all of your Linkable Objects configured on the Folio Admin page.

Edition support

Important: Change Data Capture is not available in all Salesforce editions. Refer to Salesforce’s official documentation for support of Change Data Capture on different editions before enabling it.

Related: Configure the Admin Panel · Configure Advanced Settings · Automate with Invocable Apex

Continue reading
Configure Advanced Settings