Metadata API Developer Guide
jNote: 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.
DocumentChecklistSettings
This type extends the Metadata metadata type and inherits its fullName field.
In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for more details.
File Suffix and Directory Location
DocumentChecklistSettings components are stored in the DocumentChecklist.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
DocumentChecklistSettings components are available in API versions 55.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| dciCustomSharing | boolean | Indicates whether the custom sharing rule for document checklist items is enabled for your org (true) or not (false). The default value is false. |
| deleteDCIWithFiles | boolean | Indicates whether deletion of document checklist items is enabled for your org (true) or not (false). The default value is false. |
Declarative Metadata Sample Definition
The following is an example of a DocumentChecklistSettings.settings component.
1<?xml version="1.0" encoding="UTF-8"?>
2<DocumentChecklistSettings
3 xmlns="http://soap.sforce.com/2006/04/metadata">
4 <dciCustomSharing>true</dciCustomSharing>
5 <deleteDCIWithFiles>true</deleteDCIWithFiles>
6</DocumentChecklistSettings>Example Package Manifest
The following is an example package.xml that references the previous definition.
1<?xml version="1.0" encoding="UTF-8"?>
2<Package
3 xmlns="http://soap.sforce.com/2006/04/metadata">
4 <types>
5 <members>DocumentChecklist</members>
6 <name>Settings</name>
7 </types>
8 <version>55.0</version>
9</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.