Create an Actionable List Definition
Create an actionable list definition by using Data Processing Engine that helps you transform data available in your Salesforce org and write back the transformation results as a new dataset.
Required Editions
| Available in: Lightning Experience |
| Available in: Clouds that have Industry Sales Excellence and Query for Datapipelines User licenses |
| User Permissions Needed | |
|---|---|
| To create actionable list definitions: | Actionable Segmentation permission set AND Data Pipelines Base User permission set AND View Setup and Configuration permission |
You can create an actionable list definition by creating a Data Processing Engine definition from scratch or by using a predefined Data Processing Engine definition.
Create a List Definition by Creating a Data Processing Engine Definition
When you create an actionable list definition, Data Processing Engine is launched so you can define cross-object join criteria to transform the data to the format you want. After you save, activate, and run the Data Processing Engine definition, a dataset is created. The newly created dataset is associated with the actionable list definition.
- From Setup, in the Quick Find box, enter Actionable Segmentation, and then select Actionable Segmentation Settings.
- Click New Data Processing Engine Definition.
-
Enter a name for the list definition.
Note Enter a name that contains alphanumeric characters and begins with a letter. -
Select an object for which you want to create the list definition.
Note Review the list of objects that you can use to create an actionable list definition in Actionable Segmentation Objects. - Click Next.
-
Click Launch Data Processing Engine Definition.
Important The Data Processing Engine page opens, and you can view the list definition name that you entered. You can also view the data source node that was created for the object that you specified when creating the list definition. For example, if you selected the Account object when creating the list definition, the data source node is created with the name Account_DS. ID and Name fields of this primary object are preselected and are mandatory. You can’t delete the data source node created for the primary object. - Create data source nodes for all the objects that are required to create the list definition. For example, to include Lead and Opportunity objects in the list definition, create two data source nodes, one for each of these objects.
-
Create joins, filters, and any other required nodes.
Important When creating an aggregated field by using the node of type Group and Aggregate, ensure that you group the aggregated field using the object Id field of the object that’s used to create the list definition. - Create input variables if necessary.
-
Create a writeback object.
Important- When creating writeback objects, ensure that you select the Target Type Save as dataset in Analytics, and select the folder name as ActionableSegmentation.
- In the Field mapping section, ensure that you map all the required fields that you want to include when creating actionable lists.
- In the Field mapping section, you can’t map a field if it’s derived from one or more encrypted fields or if it’s derived from multiple fields (for example, Total Balance = Current Balance + Saving Balance).
Important In the Field mapping section, you can’t map a field if it’s derived from multiple fields. For example, Total Balance = Current Balance + Saving Balance. - Save the definition.
-
Activate the definition.
Note- Validate the definition to make sure that it’s correct and can be run. Any errors in the definition are highlighted when you activate a definition. Warnings are also provided. Warnings help you identify issues to fix or ignore.
- You can’t update the data processing engine definition without deactivating the associated actionable list definition. Before reactivating any actionable list definition, ensure that you run the associated data processing engine definition to reflect the latest changes.
- Run the definition.
- To view the actionable list definition and the associated dataset name and status, from Setup, in the Quick Find box, enter Actionable Segmentation Settings, and then select Actionable Segmentation Settings.
Create a List Definition by Using a Predefined Data Processing Engine Definition
Use Data Processing Engine definitions that have been previously created to ensure their availability when you plan to create actionable list definitions. Predefined Data Processing Engine definitions help you to create actionable list definitions quickly and easily.
- From Setup, in the Quick Find box, enter Actionable Segmentation, and then select Actionable Segmentation Settings.
- Click Use Existing Data Processing Engine Definition.
-
Enter a name for the list definition.
Note Enter a name that contains only alphanumeric characters and begins with a letter. -
Select an object for which you want to create the list definition.
Note Review the list of objects that you can use to create an actionable list definition in Actionable Segmentation Objects. -
Search for select a Data Processing Engine definition. Only the Data Processing Engine
definitions meeting these criteria are listed:
- The object that you selected in the previous step must match with one of the data source node objects of the Data Processing Engine definition that you plan to select here.
- The process type must be Actionable List and the runtime platform must be CRM Analytics.
Note Learn how to create Data Processing Engine definitions that are compatible to create an Actionable List Definition in Create Data Processing Engine Definitions for Actionable List Definitions. - Save the actionable list definition.
- To view the actionable list definition and the associated dataset name and status, from Setup, in the Quick Find box, enter Actionable Segmentation Settings, and then select Actionable Segmentation Settings.
Create Data Processing Engine Definitions for Actionable List Definitions
Create Data Processing Engine definitions that can be used to create actionable list definitions. Create, activate, and run Data Processing Engine definitions so that the datasets associated with these definitions are available for you to create new actionable list definitions.
- From Setup, in the Quick Find box, enter Data Processing Engine, and then click Data Processing Engine.
- Click New.
- Enter the name and API name for the Data Processing Engine definition.
- Specify the process type as Actionable List.
- If you want to reuse this Data Processing Engine definition, save it as a template.
- Click Next.
- Click CRM Analytics as the runtime platform.
- Click Done.
- Create data source nodes for all the objects that are required to create the list definition. For example, if you want to include Lead and Opportunity objects in the list definition, then create 2 data source nodes for each of these objects.
-
Create joins, filters, and any other required nodes.
Important When creating an aggregated field by using the node of type Group and Aggregate, ensure that you group the aggregated field using the object Id field of the object that you plan to use to create the actionable list definition. - Create input variables if necessary.
-
Create a writeback object.
Important- When creating writeback objects, ensure that you select the Target Type Save as dataset in Analytics, and select the folder name as ActionableSegmentation.
- In the Field mapping section, ensure that you map all the required fields that you want to include when creating actionable lists.
- In the Field mapping section, you can’t map a field if it’s derived from one or more encrypted fields or if it’s derived from multiple fields (for example, Total Balance = Current Balance + Saving Balance).
- Save the definition.
-
Activate the definition.
Note- Validate the definition to make sure that it’s correct and can be run. Any errors in the definition are highlighted when you activate a definition. Warnings are also provided. Warnings help you identify issues that you can choose to fix or ignore.
- You can’t update the data processing engine definition without deactivating the associated actionable list definition. Before reactivating any actionable list definition, ensure that you run the associated data processing engine definition to reflect the latest changes.
- Run the definition.
- To view the newly created Data Processing Engine definition, from Setup, in the Quick Find box, enter Data Processing Engine, and then click Data Processing Engine.

