--- schema_version: "1" id: db8aedc55eea006662304578002293da4cee936f2f1df4c7523376bdb0cb3278 title: ActionableListDefinition collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_actionablelistdefinition.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_actionablelistdefinition.htm source_site: developer.salesforce.com content_type: documentation content_hash: 95181bb2890f50ba563b0fdfade90dc91a958e404425db4d2c96d382ee22230c 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.api_meta.meta/api_meta/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 | Field Name | Description | | --- | --- | | 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. | | actionableListType | Field Type static enum Description Specifies the type of actionable list. Available in API version 68.0 and later. | | isactive | Field Type boolean Description Indicates whether the actionable list definition is active (yes) or not (no). Available in API version 68.0 and later. | | 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. | | description | Field Type text Description The description of the actionable list definition. Available in API version 68.0 and later. | | 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). The default value is false. | | masterLabel | Field Type string Description Required. The master label of the actionable list definition. | | objectName | Field Type string Description Required. The object for which the actionable list is created. Possible values are organized by the API version in which they were introduced. Values are available in all versions after introduction unless noted otherwise. Possible values are: API version 60.0 and later: PersonLifeEvent API version 60.0 and later with Insurance Managed Package: - Claim - InsurancePolicy - Quote API version 59.0 and later with Health Cloud: - CareFacilityBed - CareRequest - CareRequestItem - CareServiceVisit - CareServiceVisitPlan - ClinicalServiceRequest API version 59.0 and later with Loyalty Cloud: - LoyaltyProgramMember API version 59.0 and later: - Case API version 58.0 and later with Automotive Cloud: - Vehicle API version 58.0 and later: - Asset - Lead - Opportunity API version 57.0 and later: - Account - Contact | | sourceObjectFieldName | Field Type text Description The name of the source object field associated with the actionable list definition. Available in API version 68.0 and later. | | sourceObjectName | Field Type text Description The source object name for which the actionable list is created. Available in API version 68.0 and later. | ## ActionableListDatasetColumn Represents the information about the columns in a dataset associated with an actionable list. Table 1. Fields | Field Name | Description | | --- | --- | | actionableListDefinition | Field Type master/detail Description The actionable list definition that's associated with the column. Available in API version 68.0 and later. | | 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 are: - 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 are: - 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). The default value is 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. | | isSourceObjectField | Field Type boolean Description Indicates whether the dataset column belongs to source data model object or not. Available in API version 68.0 and later. | | objectName | Field Type string Description The name of the object that's associated with the dataset column. Possible values are: API version 60.0 and later: PersonLifeEvent API version 60.0 and later with Insurance Managed Package: - Claim - InsurancePolicy - Quote API version 59.0 and later with Health Cloud: - CareFacilityBed - CareRequest - CareRequestItem - CareServiceVisit - CareServiceVisitPlan - ClinicalServiceRequest API version 59.0 and later with Loyalty Cloud: - LoyaltyProgramMember API version 59.0 and later: - Case API version 58.0 and later with Automotive Cloud: - Vehicle API version 58.0 and later: - Asset - Lead - Opportunity API version 57.0 and later: - Account - Contact | | sourceColumnApiName | Field Type string Description The API name of the column in the source dataset. Available in API version 68.0 and later. | | sourceFieldName | Field Type string Description The name of the field in the object for which the actionable list dataset is created. | ## ActionableListMemberStatus Represents the status and the corresponding status icon details of an individual actionable list member. Table 2. Fields | Field Name | Description | | --- | --- | | 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. true NewColumn1 ApiName Dimensions false NewColumn2 Account 1 Text NewMember1 Active true NewMember2 Account true Test1 AccountDef The following is an example package.xml that references the previous definition. \* ActionableListDefinition 68.0 ## 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).