PathAssistant

Represents Path records.

Note the following when working with PathAssistant:

• Only one path can be created per record type for each object, including Master record type.
• Rich text guidance information cannot be retrieved or deployed from or to translation workbench.
• The preference does not need to be on to retrieve or deploy PathAssistant.

This type extends Metadata and inherits its fields.

PathAssistant components have the suffix .pathAssistant and are stored in the pathAssistants folder.

Introduced in API version 34.0.

• Type: boolean
• Required: Yes
• Description: Indicates whether the path is active (true) or not (false).

• Type: string
• Required: Yes
• Description: Required. The entity name. This is hard coded for Opportunity, Lead, and Quote. For a custom object, this field must be specified and should be the name of the custom object. This field is not updateable.

• Type: string
• Required: Yes
• Description: Required. The field name. This is hard coded for StageName and Status. For a custom object, this field must be specified and should be the name of the picklist field that determines the steps in the path. This field is not updateable.

• Type: string
• Required: Yes
• Description: Required. The label of the path.

• Type: PathAssistantStep[]
• Required: No
• Description: List of all the steps that have been configured with fields and guidance information. Note that a missing step in the .xml file means it has not been configured, not that it doesn’t exist.

• Type: string
• Required: Yes
• Description: Required. The name of the record type associated with the path. This field is not updateable.

Represents the steps or stages in a Path.

• Type: string[]
• Required: No
• Description: All the fields in entityName that will display in this step.

• Type: string
• Required: No
• Description: The guidance information displayed in this step.

• Type: string
• Required: Yes
• Description: Required. The picklist value associated with the step.

The following is an example of a PathAssistant component.

1<?xml version="1.0" encoding="UTF-8"?>
2<PathAssistant xmlns="http://soap.sforce.com/2006/04/metadata">
3    <active>true</active>
4    <entityName>Opportunity</entityName>
5    <fieldName>StageName</fieldName>
6    <masterLabel>Test Path</masterLabel>
7    <pathAssistantSteps>
8        <fieldNames>Amount</fieldNames>
9        <fieldNames>CloseDate</fieldNames>
10        <info>Some Text</info>
11        <picklistValueName>Id. Decision Makers</picklistValueName>
12    </pathAssistantSteps>
13    <pathAssistantSteps>
14        <fieldNames>Amount</fieldNames>
15        <fieldNames>CloseDate</fieldNames>
16        <info>Some Text</info>
17        <picklistValueName>Proposal/Price Quote</picklistValueName>
18    </pathAssistantSteps>
19    <recordTypeName>Test_Record_Type</recordTypeName>
20</PathAssistant>

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>Opportunity.Test_Busines_Process</members>
5        <name>BusinessProcess</name>
6    </types>
7    <types>
8        <members>Opportunity.StageName</members>
9        <members>Lead.LeadSource</members>
10        <members>Opportunity.Type</members>
11        <name>CustomField</name>
12    </types>
13    <types>
14        <members>Test_Path</members>
15        <name>PathAssistant</name>
16    </types>
17    <types>
18        <members>Opportunity.Test_Record_Type</members>
19        <name>RecordType</name>
20    </types>
21    <types>
22        <members>PathAssistant</members>
23        <name>Settings</name>
24    </types>
25    <version>68.0</version>
26</Package>

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.