DisclosureDefinitionVersion | Metadata API Developer Guide

Parent Type

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

File Suffix and Directory Location

DisclosureDefinitionVersion components have the suffix .disclosureDefinitionVersion and are stored in the disclosureDefinitionVersions folder.

Version

DisclosureDefinitionVersion components are available in API version 57.0 and later.

Special Access Rules

The DisclosureAndComplianceHubAddOn and OmniStudioDesignerAddon licenses are required to access this object along with user access for the Disclosure Compliance Hub and OmniStudio Admin permission set licenses.

Fields

Field Name	Description
authoringMode	Field Type AuthoringMode (enumeration of type string) Description Specifies the authoring mode used to launch the disclosure authoring experience. Possible values are: `Microsoft 365 Word` `Omniscript and Microsoft 365 Word` `Omniscript Form`
description	Field Type string Description The description about the disclosure definition version.
disclosureDefCurrVer	Field Type string Description For internal use only.
disclosureDefinition	Field Type string Description Required. The API name of the disclosure definition associated with this version.
documentTemplateGlobalKey	Field Type string Description The document template global key associated with the DOCX template for the disclosure definition version.
isActive	Field Type boolean Description Indicates whether the disclosure definition version is an active version (`true`) or not (`false`). The default value is `false`.
isCurrentVersion	Field Type boolean Description Indicates whether this is the current version of the disclosure definition specified in the disclosureDefinition field (`true`) or not (`false`). The default value is `false`.
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 DisclosureDefinitionVersion, which is defined when the DisclosureDefinitionVersion is created.
omniScriptCnfgApiName	Description The API name of the Omniscript configuration that's associated with the disclosure definition version. This field is required only when authoringModeisn’t `Microsoft 365 Word`.
omniScriptConfiguration	Field Type string Description The ID of the Omniscript configuration record. The value of this field is automatically populated using the API name of the OmniScript configuration specified in the omniScriptCnfgApiName field. Note
versionNumber	Field Type string Description Required. The version of the disclosure definition published by the author.

Declarative Metadata Sample Definition

The following is an example of a DisclosureDefinitionVersion component.

1<?xml version="1.0" encoding="UTF-8"?>
2<DisclosureDefinitionVersion xmlns="http://soap.sforce.com/2006/04/metadata">
3    <description>This is GRI Disclosure Definition Version</description>
4    <versionNumber>disclosure definition version number</versionNumber>
5    <isActive>false</isActive>
6    <disclosureDefinition>df10</disclosureDefinition>
7    <omniScriptConfiguration>omni script configuration</omniScriptConfiguration>
8    <omniScriptCnfgApiName>omni script config api name</omniScriptCnfgApiName>
9    <isCurrentVersion>true</isCurrentVersion>
10    <disclosureDefCurrVer>df10.Id</disclosureDefCurrVer>
11    <documentTemplateGlobalKey>document template global key</documentTemplateGlobalKey>
12    <authoringMode>OmniScriptForm</authoringMode>
13    <masterLabel>GRI</masterLabel>
14    <isProtected>false</isProtected>
15</DisclosureDefinitionVersion>

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>DisclosureDefinitionVersion</name>
8	</types>
9	<types>
10		<members>df10</members>
11		<name>DisclosureDefinition</name>
12	</types>
13	<types>
14		<members>dt10</members>
15		<name>DisclosureType</name>
16	</types>
17	<version>60.0</version>
18</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.