ActionableListDefinition

Represents the data source definition details associated with an actionable list.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

ActionableListDefinition components have the suffix .actionableListDefinition and are stored in the actionableListDefinitions folder.

Version

ActionableListDefinition components are available in API version 57.0 and later.

Fields

actionableListDatasetColumns

Field Type: ActionableListDatasetColumn[]
Description: The object that stores columns in a dataset associated with an actionable list.

actionableListMemberStatuses

Field Type: ActionableListMemberStatus[]
Description: The object that stores the status and the corresponding status icon details of an individual actionable list member.

batchCalcJobDefinition

Field Type: string
Description: The batch calculation job definition that’s associated with the creation of an actionable list. This field is a relationship field.

datasetName

Field Type: string
Description: The name of the dataset that is associated with the actionable list.

edgeMart

Field Type: string
Description: The edgemart dataset that’s associated with the actionable list. Available in API version 58.0 and later.

isActive

Field Type: boolean
Description: Indicates whether the actionable list definition is active (true) or not (false).
Default value: false

masterLabel

Field Type: string
Description: Required. The master label of the actionable list definition.

objectName

Field Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort
Description: Required. The object for which the actionable list is created.
Default value: LifeScience
Possible values:
- Account
- Asset
- CareRequest
- CareRequestItem
- Case
- Claim
- ClinicalServiceRequest
- Contact
- HealthcareFacility
- InsurancePolicy
- Lead
- MemberPlan
- Opportunity
- PersonLifeEvent

type

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The type of the actionable list that can be built using the actionable list definition.
Possible values:
- RetailStoreList
- HealthcareProviderList

ActionableListDatasetColumn Fields

Represents the information about the columns in a dataset associated with an actionable list.

dataDomain

Field Type: DatasetColumnDataType (enumeration of type string)
Description: The data domain that is mapped to the data type of the dataset column.
Possible values:
- Dates
- Dimensions
- Measures

dataType

Field Type: DatatableDataType (enumeration of type string)
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The data type of the dataset column in the actionable list. Available in API version 58.0 and later.
Possible values:
- Boolean
- Currency
- Date
- DateTime
- Email
- Location
- Number
- Percent
- Phone
- Text
- Url

displayOrder

Field Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The order in which the actionable list dataset columns are displayed. Available in API version 58.0 and later.

isDefault

Field Type: boolean
Description: Indicates whether the dataset column is added to the actionable list by default (true) or not (false).
Default value: false

isGroupedByListDefObj

Field Type: boolean
Description: Indicates whether the dataset column is grouped by the object defined in the actionable list definition (true) or not (false). Available in API version 59.0 and later.

IsTypeAheadSearchEnabled

Field Type: boolean
Description: Indicates whether the type-ahead search for filters is enabled (true) or not (false). Available in API version 60.0 and later.

objectName

Field Type: string
Description: The name of the object that’s associated with the dataset column.
Possible values:
- Account
- Asset
- CareRequest
- CareRequestItem
- Case
- Claim
- ClinicalServiceRequest
- Contact
- HealthcareFacility
- InsurancePolicy
- Lead
- MemberPlan
- Opportunity
- PersonLifeEvent

sourceColumnApiName

Field Type: string
Description: The API name of the column in the source dataset.

sourceFieldName

Field Type: string
Description: The name of the field in the object for which the actionable list dataset is created.

ActionableListMemberStatus Fields

Represents the status and the corresponding status icon details of an individual actionable list member.

iconName

Field Type: string
Description: The name of the icon that’s mapped to the status.

status

Field Type: string
Description: The status of the actionable list member.

Declarative Metadata Sample Definition

The following is an example of a ActionableListDefinition component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ActionableListDefinition
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<actionableListDatasetColumns>
5		<isDefault>true</isDefault>
6		<sourceFieldName>NewColumn1</sourceFieldName>
7	</actionableListDatasetColumns>
8	<actionableListDatasetColumns>
9		<sourceColumnApiName>ApiName</sourceColumnApiName>
10		<dataDomain>Dimensions</dataDomain>
11		<isDefault>false</isDefault>
12		<sourceFieldName>NewColumn2</sourceFieldName>
13		<objectName>Account</objectName>
14		<displayOrder>1</displayOrder>
15		<dataType>Text</dataType>
16	</actionableListDatasetColumns>
17	<actionableListMemberStatuses>
18		<iconName>NewMember1</iconName>
19		<status>Active</status>
20	</actionableListMemberStatuses>
21	<isActive>true</isActive>
22	<masterLabel>NewMember2</masterLabel>
23	<objectName>Account</objectName>
24	<isProtected>true</isProtected>
25	<batchCalcJobDefinition>Test1</batchCalcJobDefinition>
26	<datasetName>AccountDef</datasetName>
27</ActionableListDefinition>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3   <types>
4      <members>*</members>
5      <name>ActionableListDefinition</name>
6   </types>
7   <version>68.0</version>
8</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.