---
schema_version: "1"
id: 752b6a2cf8317337b9b2b2610f29452803674bc64f4c8f8c62c50e689768219e
title: PathAssistantSettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_pathassistantsettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_pathassistantsettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 20eccf853e5bac2bc29c2e8bdf369394cc1a8830c240493f92dcb2386c360a64
description: Represents the Path preference setting. This type extends the Metadata metadata type and inherits its fullName field.
---
# PathAssistantSettings

Represents the Path preference setting. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

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

## Version

PathAssistantSettings components are available in API version 34.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d736334e99">Field Name</th>

              <th class="featureTableHeader  " id="d736334e102">Field Type</th>

              <th class="featureTableHeader  " id="d736334e105">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d736334e99" data-title="Field Name"><span class="keyword parmname">canOverrideAutoPathCollapseWithUserPref</span></td>

              <td class="entry" headers="d736334e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d736334e105" data-title="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.
                <p class="p">Default value is <samp class="codeph nolang">false</samp>
                  for all editions. When set to <samp class="codeph nolang">false</samp>, the user’s path is collapsed when the page
                  loads. </p>
                <p class="p">Available in API version 47.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d736334e99" data-title="Field Name"><span class="keyword parmname">pathAssistantEnabled</span></td>

              <td class="entry" headers="d736334e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d736334e105" data-title="Description">Determines whether the preference is enabled for Path. Default
                value is <samp class="codeph nolang">true</samp> for Enterprise
                Edition and <samp class="codeph nolang">false</samp> for other
                editions. Available in API version 35.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d736334e99" data-title="Field Name"><span class="keyword parmname">pathAssistantForOpportunityEnabled</span></td>

              <td class="entry" headers="d736334e102" data-title="Field Type">boolean</td>

              <td class="entry" headers="d736334e105" data-title="Description">Determines whether the preference is enabled for Path in
                Opportunity or not. <p class="p">Available in API version 34.0 and
                  earlier.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d736334e99" data-title="Field Name"></td>

              <td class="entry" headers="d736334e102" data-title="Field Type"></td>

              <td class="entry" headers="d736334e105" data-title="Description"></td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a PathAssistantSettings component.

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

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>PathAssistant</members\>
        <name\>Settings</name\>
    </types\>
    <version\>API</version\>
</Package

## Wildcard Support in the Manifest File

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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).