DisclosureDefinition

Represents information that defines a disclosure type, such as details of the publisher or vendor who created or implemented the report.

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

Parent Type

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

File Suffix and Directory Location

DisclosureDefinition components have the suffix .disclosureDefinition and are stored in the disclosureDefinitions folder.

Version

DisclosureDefinition components are available in API version 57.0 and later.

Special Access Rules

The DisclosureAndComplianceHubAddOn license is required to access this object along with user access for the Disclosure Compliance Hub permission set license.

Fields

Field Name	Description
description	Field Type string Description The description about the disclosure definition.
disclosureType	Field Type string Description Required. The API name of the disclosure type associated with this definition.
isProtected	Field Type boolean Description An auto-generated value that doesn’t impact the behavior of the metadata type. The default is `false`.
masterLabel	Field Type string Description Required. A user-friendly name for DisclosureDefinition, which is defined when the DisclosureDefinition is created.

Declarative Metadata Sample Definition

The following is an example of a DisclosureDefinition component.

1<?xml version="1.0" encoding="UTF-8"?>
2<DisclosureDefinition
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<description>This is GRI Disclosure Definition</description>
5	<disclosureType>disclstype10</disclosureType>
6	<isProtected>false</isProtected>
7	<masterLabel>GRI</masterLabel>
8</DisclosureDefinition>

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	<fullName>Pkg</fullName>
5	<types>
6		<members>GRI</members>
7		<name>DisclosureDefinition</name>
8	</types>
9	<types>
10		<members>dt12</members>
11		<name>DisclosureType</name>
12	</types>
13	<version>57.0</version>
14</Package>

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