UserEngagementSettings

Represents the metadata associated with various feature settings around Lightning Experience transition and adoption, user engagement and adoption assistance, and adoption apps.

This type extends Metadata and inherits its fields.

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

Prompt components are available in API version 47.0 and later.

See related Salesforce Help for each feature for permission and edition requirements.

• Type: boolean
• Required: No
• Introduced: API version 62.0
• Description: Indicates whether an org can access Lightning Experience transition tools (true) or not (false). Examples of these tools are Salesforce Optimizer, Lightning Experience Transition Assistant, and the Lightning Experience Readiness Report. The default is false. This field applies only to orgs with the External Application Settings page in Setup. Otherwise, this field has no effect.

• Type: boolean
• Required: No
• Description: Indicates where users are automatically switched from Salesforce Classic to Lightning Experience every day (true) or weekly (false). If false, then users are switched weekly. The default is false. See Encourage Users to Stay in Lightning Experience in Salesforce Help.

• Type: boolean
• Required: No
• Description: Indicates whether a custom section has been added to the Lightning Experience Help Menu (true) or not (false). The default is false. See Define Custom Help for the Lightning Experience Help Menu in Salesforce Help for more information.

• Type: boolean
• Required: No
• Description: Indicates whether the Give Feedback to Salesforce link in the Lightning Experience Help Menu is visible to users (true) or not (false). The default is true. Even if false, admins always see all links in the Help Menu. See Define Custom Help for the Lightning Experience Help Menu in Salesforce Help for more information.

• Type: boolean

• Required: No

• Description: Indicates whether the Help For This Page section in the Lightning Experience Help Menu is visible to users (true) or not (false). The default is true. Even if false, admins always see all links in the Help Menu. See Define Custom Help for the Lightning Experience Help Menu in Salesforce Help for more information.

  Available in API version 64.0 and earlier.

• Type: boolean

• Required: No

• Description: Indicates whether the Getting Started section in the Lightning Experience Help Menu is visible to users (true) or not (false). The default is true. Even if false, admins always see all links in the Help Menu. See Define Custom Help for the Lightning Experience Help Menu in Salesforce Help for more information.

  Available in API version 64.0 and earlier.

• Type: boolean

• Required: No

• Description: Indicates whether the Search Documentation link in the Lightning Experience Help Menu is visible to users (true) or not (false). The default is true. Even if false, admins always see all links in the Help Menu. See Define Custom Help for the Lightning Experience Help Menu in Salesforce Help for more information.

  Available in API version 64.0 and earlier.

• Type: boolean
• Required: No
• Description: Indicates whether any Salesforce-created help resources in Lightning Experience Help Menu are visible to users (true) or not (false). The default is true. Even if false, admins always see all links in the Help Menu. See Define Custom Help for the Lightning Experience Help Menu in Salesforce Help for more information.

• Type: boolean
• Required: No
• Description: Indicates whether the View Keyboard Shortcuts link in the Lightning Experience Help Menu is visible to users (true) or not (false). The default is true. Even if false, admins always see all links in the Help Menu. See Define Custom Help for the Lightning Experience Help Menu in Salesforce Help for more information.

• Type: boolean
• Required: No
• Description: Indicates whether the Go to Salesforce Help link in the Lightning Experience Help Menu is visible to users (true) or not (false). The default is true. Even if false, admins always see all links in the Help Menu. See Define Custom Help for the Lightning Experience Help Menu in Salesforce Help for more information.

• Type: boolean
• Required: No
• Description: Indicates whether the Go to Trailhead link in the Lightning Experience Help Menu is visible to users (true) or not (false). The default is true. Even if false, admins always see all links in the Help Menu. See Define Custom Help for the Lightning Experience Help Menu in Salesforce Help for more information.

• Type: boolean
• Required: No
• Version: Deprecated in API version 51.0 and later.
• Description: Indicates whether the It’s Better in Lightning prompt about Dashboards is hidden from users (true) or not (false). The default is true.

• Type: boolean
• Required: No
• Version: Deprecated in API version 51.0 and later.
• Description: Indicates whether the It’s Better in Lightning prompt about Events/Calendar is hidden from users (true) or not (false). The default is true.

• Type: boolean
• Required: No
• Version: Deprecated in API version 51.0 and later.
• Description: Indicates whether the It’s Better in Lightning prompt about Reports is hidden from users (true) or not (false). The default is true.

• Type: boolean
• Required: No
• Version: Deprecated in API version 51.0 and later.
• Description: Indicates whether the It’s Better in Lightning prompt about Tasks is hidden from users (true) or not (false). The default is true.

• Type: boolean
• Required: No
• Description: Indicates whether the Switch to Salesforce Classic Feedback Form is shown to users (true) or not (false). The default is false. See Switch to Salesforce Classic Feedback Form in Salesforce Help for more information.

• Type: boolean
• Required: No
• Description: Indicates whether adoption assistance and other in-app guidance is shown to users in sandbox orgs (true) or not (false). The default is false. See Define Prompts in Lightning Experience in Salesforce Help for more information.

• Type: boolean
• Required: No
• Description: Indicates whether all custom in-app guidance created by an org is shown to users (true) or not (false). Doesn’t affect active status. The default is true. See Define Prompts in Lightning Experience in Salesforce Help for more information.

• Type: boolean
• Required: No
• Description: Indicates whether users are automatically switched from Salesforce Classic to Lightning Experience (true) or not (false). The default is true. See Encourage Users to Stay in Lightning Experience in Salesforce Help.

• Type: boolean
• Required: No
• Description: Indicates whether the Salesforce Product Feedback Form is shown to users (true) or not (false). The default is true. See Salesforce Product Feedback Form in Salesforce Help for more information.

• Type: boolean
• Required: No
• Description: Indicates whether all standard in-app guidance created by Salesforce is shown to users (true) or not (false). Doesn’t affect active status. The default is true. See Define Prompts in Lightning Experience in Salesforce Help for more information.

• Type: boolean
• Required: No

• Type: boolean
• Required: No
• Description: Indicates whether all notifications about the Winter ’20 Turn on Lightning Experience critical update are hidden from admins (true) or not (false). The default is false.

• Type: boolean
• Required: No

• Type: boolean
• Required: No
• Description: Indicates whether the Lightning Experience welcome mat is hidden from users the first time they log into the user interface (true) or not (false). The default is false. See Lightning Experience Welcome Mat in Salesforce Help for more information.

• Type: boolean
• Required: No
• Description: Indicates whether all notifications about the Lightning Experience Transition Assistant are hidden from admins in Salesforce Classic (true) or not (false). The default is false.

• Type: boolean
• Required: No
• Description: Indicates whether all notifications about the Lightning Experience Transition Assistant are hidden from admins in Lightning Experience (true) or not (false). The default is false.

• Type: boolean
• Required: No

• Type: boolean
• Required: No
• Description: Indicates whether Salesforce Optimizer is turned on in the org (true) or not (false). The default is false. See Improve Your Implementation with Salesforce Optimizer in Salesforce Help.

• Type: boolean
• Required: No
• Description: Indicates whether Suggested For You is turned on in the org (true) or not (false). The default is true. See Suggested For You in Salesforce Help.

The following is an example of a UserEngagementSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<UserEngagementSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3   <canUseAdoptionApps>false</canUseAdoptionApps>
4   <doesScheduledSwitcherRunDaily>true</doesScheduledSwitcherRunDaily>
5   <enableCustomHelpGlobalSection>true</enableCustomHelpGlobalSection>
6   <enableHelpMenuShowSfdcContent>true</enableHelpMenuShowSfdcContent>
7   <enableHelpMenuShowShortcut>true</enableHelpMenuShowShortcut>
8   <enableHelpMenuShowSupport>true</enableHelpMenuShowSupport>
9   <enableHelpMenuShowTrailhead>true</enableHelpMenuShowTrailhead>
10   <enableIBILOptOutDashboards>true</enableIBILOptOutDashboards>
11   <enableIBILOptOutEvents>true</enableIBILOptOutEvents>
12   <enableIBILOptOutReports>true</enableIBILOptOutReports>
13   <enableIBILOptOutTasks>true</enableIBILOptOutTasks>
14   <enableLexToClassicFeedbackEnable>true</enableLexToClassicFeedbackEnable>
15   <enableOrgUserAssistEnabled>true</enableOrgUserAssistEnabled>
16   <enableScheduledSwitcher>true</enableScheduledSwitcher>
17   <enableSfdcProductFeedbackSurvey>true</enableSfdcProductFeedbackSurvey>
18   <enableOrchestrationInSandbox>true</enableOrchestrationInSandbox>
19   <enableShowSalesforceUserAssist>true</enableShowSalesforceUserAssist>
20   <isCrucNotificationDisabled>false</isCrucNotificationDisabled>
21   <isLEXWelcomeMatDisabled>false</isLEXWelcomeMatDisabled>
22   <isMeetTheAssistantDisabledInClassic>false</isMeetTheAssistantDisabledInClassic>
23   <isMeetTheAssistantDisabledInLightning>false</isMeetTheAssistantDisabledInLightning>
24   <optimizerAppEnabled>true</optimizerAppEnabled>
25</UserEngagementSettings>

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>UserEngagement</members>
5      <name>Settings</name>
6   </types>
7   <version>47.0</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.