ActionableListDefinition (Beta) | Industries Common Resources Developer Guide

This feature is a Beta Service. Customer may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms.

Note

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

Field Name	Description
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 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 actionable list. This field is a relationship field.
datasetName	Field Type string Description Name of the dataset that is associated with the actionable list.
isActive	Field Type boolean Description Indicates whether the actionable list definition is active or not. 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. Specifies the object for which the actionable list is created.

ActionableListDatasetColumn

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

Table 1. Fields
Field Name	Description
dataDomain	Field Type DatasetColumnDataType Description The data domain that is mapped to the data type of the dataset column. Possible values are: `Dates` `Dimensions` `Measures`
isDefault	Field Type boolean Description Indicates whether the dataset column is added to the actionable list by default or not. The default value is `false`.
objectName	Field Type string Description The name of the object that's associated with the dataset column.
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

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.

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	</actionableListDatasetColumns>
15	<actionableListMemberStatuses>
16		<iconName>NewMember1</iconName>
17		<status>Active</status>
18	</actionableListMemberStatuses>
19	<isActive>true</isActive>
20	<masterLabel>NewMember2</masterLabel>
21	<objectName>Account</objectName>
22	<isProtected>true</isProtected>
23	<batchCalcJobDefinition>Test1</batchCalcJobDefinition>
24	<datasetName>AccountDef</datasetName>
25</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>57.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.