DocumentChecklistSettings

Represents an org’s DocumentChecklistItem settings. 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.

<?xml version="1.0" encoding="UTF-8"?>
<DocumentChecklistSettings
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<dciCustomSharing>true</dciCustomSharing>
	<deleteDCIWithFiles>true</deleteDCIWithFiles>
</DocumentChecklistSettings>

Example Package Manifest

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package
	xmlns="http://soap.sforce.com/2006/04/metadata">
	<types>
		<members>DocumentChecklist</members>
		<name>Settings</name>
	</types>
	<version>55.0</version>
</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.