PathAssistant | Metadata API Developer’s Guide

Note the following when working with PathAssistant:

Only one sales path can be created per record type, 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.

File Suffix and Directory Location

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

Version

PathAssistant components are available in API version 34.0 and later.

Fields

Field Name	Field Type	Description
active	boolean	Indicates whether the sales path is active (`true`) or not (`false`).
entityName	string	Required. The entity name. This is hard coded for Opportunity. This field is not updateable.
fieldName	string	Required. The field name. This is hard coded for StageName. This field is not updateable.
masterLabel	string	Required. The master label of the sales path.
pathAssistantSteps	PathAssistantStep[]	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.
recordTypeName	string	Required. The name of the record type associated with the sales path. This field is not updateable.

PathAssistantStep

Represents the steps or stages in Sales Path.

Field Name	Field Type	Description
fieldNames	string	All the fields in entityName that will display in this step.
info	string	The guidance information displayed in this step.
picklistValueName	string	Required. The stage picklist value associated with the step.

Declarative Metadata Sample Definition

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>35.0</version>
26</Package>