UserEngagementSettings | Metadata API Developer Guide

File Suffix and Directory Location

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

Version

Prompt components are available in API version 47.0 and later.

Special Access Rules

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

Fields

Field Name	Field Type	Description
canGovCloudUseAdoptionApps	boolean	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. Available through API version 61.0. Removed in API version 62.0. Instead, use the canUseAdoptionApps field.
canUseAdoptionApps	boolean	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. Available in API version 62.0 and later.
doesScheduledSwitcherRunDaily	boolean	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.
enableCustomHelpGlobalSection	boolean	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.
enableHelpMenuShowFeedback	boolean	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.
enableHelpMenuShowHelp	boolean	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.
enableHelpMenuShowNewUser	boolean	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.
enableHelpMenuShowSearch	boolean	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.
enableHelpMenuShowSfdcContent	boolean	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.
enableHelpMenuShowShortcut	boolean	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.
enableHelpMenuShowSupport	boolean	Indicates whether the Get Support 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.
enableHelpMenuShowTrailhead	boolean	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.
enableIBILOptOutDashboards	boolean	Indicates whether the It’s Better in Lightning prompt about Dashboards is hidden from users (`true`) or not (`false`). The default is `true`. Deprecated in API version 51.0 and later.
enableIBILOptOutEvents	boolean	Indicates whether the It’s Better in Lightning prompt about Events/Calendar is hidden from users (`true`) or not (`false`). The default is `true`. Deprecated in API version 51.0 and later.
enableIBILOptOutReports	boolean	Indicates whether the It’s Better in Lightning prompt about Reports is hidden from users (`true`) or not (`false`). The default is `true`. Deprecated in API version 51.0 and later.
enableIBILOptOutTasks	boolean	Indicates whether the It’s Better in Lightning prompt about Tasks is hidden from users (`true`) or not (`false`). The default is `true`. Deprecated in API version 51.0 and later.
enableLexToClassicFeedbackEnable	boolean	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.
enableOrchestrationInSandbox	boolean	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.
enableOrgUserAssistEnabled	boolean	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.
enableScheduledSwitcher	boolean	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.
enableSfdcProductFeedbackSurvey	boolean	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.
enableShowSalesforceUserAssist	boolean	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.
isCrucNotificationDisabled	boolean	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`.
isLEXWelcomeMatDisabled	boolean	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.
isMeetTheAssistantDisabledInClassic	boolean	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`.
isMeetTheAssistantDisabledInLightning	boolean	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`.
optimizerAppEnabled	boolean	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.
suggestedForYou	boolean	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.

Declarative Metadata Sample Definition

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   <enableHelpMenuShowFeedback>true</enableHelpMenuShowFeedback>
7   <enableHelpMenuShowHelp>true</enableHelpMenuShowHelp>
8   <enableHelpMenuShowNewUser>true</enableHelpMenuShowNewUser>
9   <enableHelpMenuShowSearch>true</enableHelpMenuShowSearch>
10   <enableHelpMenuShowSfdcContent>true</enableHelpMenuShowSfdcContent>
11   <enableHelpMenuShowShortcut>true</enableHelpMenuShowShortcut>
12   <enableHelpMenuShowSupport>true</enableHelpMenuShowSupport>
13   <enableHelpMenuShowTrailhead>true</enableHelpMenuShowTrailhead>
14   <enableIBILOptOutDashboards>true</enableIBILOptOutDashboards>
15   <enableIBILOptOutEvents>true</enableIBILOptOutEvents>
16   <enableIBILOptOutReports>true</enableIBILOptOutReports>
17   <enableIBILOptOutTasks>true</enableIBILOptOutTasks>
18   <enableLexToClassicFeedbackEnable>true</enableLexToClassicFeedbackEnable>
19   <enableOrgUserAssistEnabled>true</enableOrgUserAssistEnabled>
20   <enableScheduledSwitcher>true</enableScheduledSwitcher>
21   <enableSfdcProductFeedbackSurvey>true</enableSfdcProductFeedbackSurvey>
22   <enableOrchestrationInSandbox>true</enableOrchestrationInSandbox>
23   <enableShowSalesforceUserAssist>true</enableShowSalesforceUserAssist>
24   <isCrucNotificationDisabled>false</isCrucNotificationDisabled>
25   <isLEXWelcomeMatDisabled>false</isLEXWelcomeMatDisabled>
26   <isMeetTheAssistantDisabledInClassic>false</isMeetTheAssistantDisabledInClassic>
27   <isMeetTheAssistantDisabledInLightning>false</isMeetTheAssistantDisabledInLightning>
28   <optimizerAppEnabled>true</optimizerAppEnabled>
29</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>

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. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.