Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
ActionPlanTemplate
Represents the instance of an action plan template.This type extends the Metadata metadata type and inherits its
fullName field.
File Suffix and Directory Location
ActionPlanTemplate components have the suffix .apt and are stored in the actionPlanTemplates folder.
Version
Action Plan Template components are available in API version 47.0 and later.
Special Access Rules
To create or access action plan templates, you must have the Customize Application permission and the IndustriesActionPlans license.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| actionPlanTemplateItem | ActionPlanTemplateItem | The instance of an item on an action plan template version. |
| description | string | The description of the action plan template. |
| name | string | Required. The name of the action plan template. |
| targetEntityType | string | Required. The parent object this action plan template relates to. Supported parent objects are Account, BusinessMilestone, Campaign, Case, Claim, Contact, Contract, InsurancePolicy, InsurancePolicyCoverage, Lead, Opportunity, PersonLifeEvent, and Visit and custom objects with activities enabled. |
| uniqueName | string | Required. The unique identifier for this action plan template record. |
ActionPlanTemplateItem
Represents the instance of an item on an action plan template version.
| Field Name | Field Type | Description |
|---|---|---|
| actionPlanTemplateItemValue | actionPlanTemplateItemValue | The value associated with the action plan template item. |
| displayOrder | int | The order in which this item is displayed within the action plan template version. |
| isRequired | boolean | Indicates whether the task created from this template item is required. |
| itemEntityType | string | Required. The name of the field on the action plan template item that this value is for. Available in API version 48.0 and later. |
| name | string | Required. The name of the action plan template item. |
| uniqueName | string | Required. The unique identifier for this action plan template item record. |
ActionPlanTemplateItemValue
Represents the value associated with an action plan template item.
| Field Name | Field Type | Description |
|---|---|---|
| itemEntityType | string | Required. The name of the field on the action plan template item that this value is for. Available in API version 48.0 and later. |
| name | string | Required. The name of the action plan template item value. |
| valueFormula | string | The formula for this action plan template item. |
| valueLiteral | string | The value for this action plan template item. |
Declarative Metadata Sample Definition
The following is an example of an ActionPlanTemplate component.
<?xml version="1.0" encoding="UTF-8"?>
<ActionPlanTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
<actionPlanTemplateItem>
<actionPlanTemplateItemValue>
<itemEntityType>Task</itemEntityType>
<name>Subject</name>
<valueLiteral>Task 1</valueLiteral>
</actionPlanTemplateItemValue>
<actionPlanTemplateItemValue>
<itemEntityType>Task</itemEntityType>
<name>Priority</name>
<valueLiteral>Normal</valueLiteral>
</actionPlanTemplateItemValue>
<actionPlanTemplateItemValue>
<itemEntityType>Task</itemEntityType>
<name>ActivityDate</name>
<valueFormula>StartDate + 1</valueFormula>
</actionPlanTemplateItemValue>
<isRequired>true</isRequired>
<itemEntityType>Task</itemEntityType>
<name>Task 1</name>
<uniqueName>Task_1_f1beaba5_1ae1_11ea_93ad_5bc214d4daaf</uniqueName>
</actionPlanTemplateItem>
<description>This is a sample template for packaging</description>
<name>Action Plan Template 1</name>
<targetEntityType>Account</targetEntityType>
<uniqueName>Action_Plan_Template_1_da365953_1ae1_11ea_93ad_89a1c3d51bae</uniqueName>
</ActionPlanTemplate>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.