You are here:
Create a Custom Provider Search Data Processing Engine Definition
Transform provider search data based on your business requirements by cloning the standard Provider Search Data Processing Engine (DPE) definition and then editing the cloned version. Your custom DPE definition can sync data to Care Provider Searchable Field records or to custom searchable object records.
Required Editions
Available in: Lightning Experience Available in: Enterprise and Unlimited Editions with Health Cloud or Life Sciences Cloud |
| User Permissions Needed | |
|---|---|
| To administer Health Cloud: | Health Cloud Foundation permission set |
| To use Data Processing Engine: | Data Pipelines Base User permission |
| To enable Data Pipelines: | Customize application |
| To edit a custom Data Processing Engine definition for Provider Search: | Healthcare Provider Search Fields Access permission set |
| To run a Data Processing Engine definition: | Customize Application AND Modify All Data AND Data Pipelines Base User |
Important We recommend you edit and test your custom DPE definition in a sandbox
environment. The definition is complex and involves many dependencies between the different data
source nodes. Make sure it works as expected before activating it in a production
environment.
- Confirm that Data Pipeline is enabled in your org. From Setup, in the Quick Find box, enter Data Pipeline, and then select Getting Started under Data Pipeline.
-
If you want your custom DPE definition to sync data to custom searchable object records,
configure your custom searchable object.
You reference this object in your custom DPE definition.
-
Clone the standard Provider Search DPE definition.
- From Setup, in the Quick Find box, enter Provider Search, and then select Provider Search Settings.
- Click the Custom Data Processing Engine Definition tab.
-
Click Generate DPE Definition.
Generating the definition can take a few minutes.
- In the Quick Find box, enter Data Process, and then select Data Processing Engine.
-
Click the cloned version of the DPE definition. It’s named ProviderSearch_Custom_<org
ID>_<timestamp>.
The node canvas in the Data Processing Engine Builder provides a visual representation of the definition’s nodes, so you can see how the nodes are related to one another. Each node type has a different color, and the icons indicate what the definition contains. Use buttons to zoom in or out or fit the layout to the screen. To view the nodes contained in the definition, click Nodes and Variables.
-
To edit the DPE definition, deactivate it. To configure a node or highlight its path, click
the node to open the menu.
If you change the configuration of a node, follow the paths the node takes and make related updates in other nodes.
Note We recommend you assign only the Automated Process user (autoproc) on the Upsert Searchable Records writeback node. As the Automated Process user creates the CareProviderSearchableField records, assigning a different user may break the DPE run for those records. Additionally, don't assign any user on the Upsert Sync Logs writeback node as you can't give users access to Provider Search Sync Logs. -
If you use a custom DPE definition to sync data to Care Provider Searchable Field records,
disable the Standard Provider Search Data Sync.
- From Setup, in the Quick Find box, enter Provider Search, and then select Provider Search Settings.
-
Disable
Standard Provider Search Data Sync.
Disabling this setting prevents the standard DPE definition from syncing data to the same records as your custom DPE definition.
Note If you use a custom DPE definition to sync data to custom searchable object records, and you also use Intelligent Appointment Management, you must enable the Standard Provider Search Data Sync. Intelligent Appointment Management relies on Care Provider Searchable Field records and doesn’t support custom searchable object records. Keep in mind that in this configuration, search results in Provider Search and Intelligent Appointment Management don’t necessarily match because different DPE definitions sync data to different searchable object records.
-
Enable the transaction observer.
- From Provider Search Settings in Setup, click the Custom Data Processing Engine Definition tab.
-
Enable
DPE Transaction Observer.
The transaction observer monitors updates to data referenced by the standard Provider Search DPE definition. With this preference turned on, the custom DPE sync job can identify which records to create or update based on changes to standard Provider Search fields.
-
In the Data Processing Engine Builder, run the DPE definition.
- Activate your DPE definition.
- Click Run Definition and then follow the steps in the flow.
- To confirm your choice, click Next.
-
For the OwnerIDToSet input variable, enter the user ID for the owner of searchable object
records.
Then click Next.
We recommend assigning an admin user as the record owner. Make sure that the user you select has a Create and Edit access for the Care Provider Searchable Field object or your custom searchable object. By default, the Autoproc User owns the Care Provider Searchable Field records.
- Click Run Definition.
- Confirm that the definition synced data to searchable object records.
- To continue editing the definition, deactivate it. Then edit the definition, activate it, and run it again.
- Create a scheduled flow that runs your definition. For details, see Run a Data Processing Engine Definition in Flows.
See Also
Did this article solve your issue?
Let us know so we can improve!

