---
schema_version: "1"
id: f2d0079a2a3a3df5dc8bf27cb486129c99e66a9966f1ad89070272d4a3bd0745
title: ActionableListDefinition
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/life_sciences_dev_guide/lsc_meta_actionablelistdefinition.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/lsc_meta_actionablelistdefinition.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: aa6aaf6c287834617d76537f9305a796c3ceeb40519403b5e4cc347909d374e7
description: Represents the data source definition details associated with an actionable list.
---
# ActionableListDefinition

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

![Important](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/images/icon_note_important.png)

#### Important

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.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) 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](#ActionableListDatasetColumn)\[\]
- **Description**: The object that stores columns in a dataset associated with an actionable list.

### actionableListMemberStatuses

- **Field Type**: [ActionableListMemberStatus](#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.

<?xml version="1.0" encoding="UTF-8"?>
<ActionableListDefinition
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<actionableListDatasetColumns\>
		<isDefault\>true</isDefault\>
		<sourceFieldName\>NewColumn1</sourceFieldName\>
	</actionableListDatasetColumns\>
	<actionableListDatasetColumns\>
		<sourceColumnApiName\>ApiName</sourceColumnApiName\>
		<dataDomain\>Dimensions</dataDomain\>
		<isDefault\>false</isDefault\>
		<sourceFieldName\>NewColumn2</sourceFieldName\>
		<objectName\>Account</objectName\>
		<displayOrder\>1</displayOrder\>
		<dataType\>Text</dataType\>
	</actionableListDatasetColumns\>
	<actionableListMemberStatuses\>
		<iconName\>NewMember1</iconName\>
		<status\>Active</status\>
	</actionableListMemberStatuses\>
	<isActive\>true</isActive\>
	<masterLabel\>NewMember2</masterLabel\>
	<objectName\>Account</objectName\>
	<isProtected\>true</isProtected\>
	<batchCalcJobDefinition\>Test1</batchCalcJobDefinition\>
	<datasetName\>AccountDef</datasetName\>
</ActionableListDefinition\>

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

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types\>
      <members\>\*</members\>
      <name\>ActionableListDefinition</name\>
   </types\>
   <version\>68.0</version\>
</Package\>

## Wildcard Support in the Manifest File

### 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).