Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
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.
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.
<?xml version="1.0" encoding="UTF-8"?>
<LightningOnboardingConfig xmlns="http://soap.sforce.com/2006/04/metadata">
<collaborationGroup>{Org ID}</collaborationGroup>
<customQuestion>Please take a minute to tell us why you’re switching.</customQuestion>
<feedbackFormDaysFrequency>0</feedbackFormDaysFrequency>
<isCustom>true</isCustom>
<masterLabel>Feedback Form</masterLabel>
<promptDelayTime>3600</promptDelayTime>
<sendFeedbackToSalesforce>true</sendFeedbackToSalesforce>
</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.