Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

LightningOnboardingConfig

Represents the feedback provided when users switch from Lightning Experience to Salesforce Classic. Admins can customize the question, how frequently the form appears, and where the feedback is stored in Chatter from the Adoption Assistance page in Lightning Experience Setup. This type extends the Metadata metadata type and inherits its fullName field.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

File Suffix and Directory Location

LightningOnboardingConfig components have the suffix .lightningOnboardingConfig and are stored in the LightningOnboardingConfigs folder.

Version

LightningOnboardingConfig components are available in API version 49.0 and later.

Special Access Rules

See Switch to Salesforce Classic Feedback Form in Salesforce Help for details.

Fields

Field Name	Field Type	Description
collaborationGroup	string	Required. The ID of the Chatter Group where the user feedback is posted.
customQuestion	string	Text of the custom question added by the admin. Maximum of 1,000 characters.
feedbackFormDaysFrequency	int	Required. The number of days between showing the feedback form when a user switches between Lightning Experience and Salesforce Classic. A value of `0` indicates that the form is shown for every switch. Maximum of 30.
isCustom	boolean	Required. Indicates if a feedback form includes a custom question ( `true`) or not (`false`).
masterLabel	string	Required. The label of the in-app guidance. Maximum of 80 characters.
promptDelayTime	int	Required. Indicates the amount of time, in seconds, to delay between instances of all in-app content, both custom content created by org and standard content created by Salesforce. Minimum of 0 hours and 0 minutes. Maximum of 99 hours and 59 minutes.
sendFeedbackToSalesforce	boolean	Required. Indicates if the user feedback can be shared with Salesforce (`true`) or not (`false`). Even if the feedback isn’t shared with Salesforce, the feedback is shared in the Chatter Group chosen when customizing the feedback form. The default is `false`.

Declarative Metadata Sample Definition

The following is an example of a LightningOnboardingConfig component.

1<?xml version="1.0" encoding="UTF-8"?>
2<LightningOnboardingConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3    <collaborationGroup>{Org ID}</collaborationGroup>
4    <customQuestion>Please take a minute to tell us why you’re switching.</customQuestion>
5    <feedbackFormDaysFrequency>0</feedbackFormDaysFrequency>
6    <isCustom>true</isCustom>
7    <masterLabel>Feedback Form</masterLabel>
8    <promptDelayTime>3600</promptDelayTime>
9    <sendFeedbackToSalesforce>true</sendFeedbackToSalesforce>
10</LightningOnboardingConfig>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide