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.

CollectionsDashboardSettings

Represents an org’s settings to add the Collections Dashboard application to an org.

Parent Type and Manifest Access

This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

CollectionsDashboardSettings values are stored in the CollectionsDashboard.settings file in the settings folder. The .settings files are different from other named components, because there’s only one settings file for each settings component.

Version

CollectionsDashboardSettings components are available in API version 56.0 and later.

Fields

Field Name	Description
enableCollectionsDashboard	Field Type boolean Description Indicates whether to add the Collections Dashboard application to an org (`true`) or not (`false`). The default value is `false`.

Declarative Metadata Sample Definition

Thisexample shows a sample CollectionsDashboardSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<CollectionsDashboardSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableCollectionsDashboard>true</enableCollectionsDashboard>
4</CollectionsDashboardSettings>

Theis example shows a sample 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>CollectionsDashboard</members>
5        <name>Settings</name>
6    </types>
7    <version>67.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.

Metadata API Developer Guide