PathAssistantSettings

Represents the Path preference setting.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.

This type extends Metadata and inherits its fields.

PathAssistantSettings components have the suffix .settings and are stored in the settings folder.

Introduced in API version 34.0.

• Type: boolean

• Required: No

• Introduced: API version 47.0

• Description: Keeps a user’s path expanded to show guidance and key fields on all their records. A user’s path stays expanded until the user collapses it. To use this preference, Path must be enabled.

  Default value is false for all editions. When set to false, the user’s path is collapsed when the page loads.

• Type: boolean
• Required: No
• Introduced: API version 35.0
• Description: Determines whether the preference is enabled for Path. Default value is true for Enterprise Edition and false for other editions.

• Type: boolean

• Required: No

• Description: Determines whether the preference is enabled for Path in Opportunity or not.

  Available in API version 34.0 and earlier.

The following is an example of a PathAssistantSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<PathAssistantSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <pathAssistantEnabled>true</pathAssistantEnabled>
4    <canOverrideAutoPathCollapseWithUserPref>true</canOverrideAutoPathCollapseWithUserPref>
5</PathAssistantSettings>

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>PathAssistant</members>
5        <name>Settings</name>
6    </types>
7    <version>API</version>
8</Package

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.