---
schema_version: "1"
id: 64683dd9a51d0dc99a27c8194f511b67227991581afe732bf3d851c357d4b7bb
title: DisclosureDefinitionVersion
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_disclosuredefinitionversion.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_disclosuredefinitionversion.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 4362ac3ce0618827d006a28cc52eeb7e90c0485a2fa6532a927f5d57046fb33d
description: Represents the version information about the disclosure definition.
---
# DisclosureDefinitionVersion

Represents the version information about the disclosure definition.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") 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

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d1081385e101">Field Name</th>

              <th class="featureTableHeader  " id="d1081385e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">authoring​Mode</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: AuthoringMode (enumeration of type string)</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Specifies the authoring mode used to launch the disclosure authoring experience.</p>

                <p class="p">Possible values are:</p>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Microsoft 365
                      Word</samp></li>

                  <li class="li"><samp class="codeph nolang">Omniscript and
                      Microsoft 365 Word</samp></li>

                  <li class="li"><samp class="codeph nolang">Omniscript
                      Form</samp></li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: The description about the disclosure definition
                  version.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">disclosureDef​CurrVer</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: For internal use only.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">disclosureDefinition</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">The API name of the disclosure
                  definition associated with this version.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">documentTemplate​GlobalKey</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: The document template global key associated with the
                  DOCX template for the disclosure definition
                  version.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">isActive</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: Indicates whether the disclosure definition version is
                  an active version (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">isCurrentVersion</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: Indicates whether this is the current version of the
                  disclosure definition specified in the
                  <span class="keyword parmname">disclosureDefinition</span> field
                  (<samp class="codeph nolang">true</samp>) or not
                  (<samp class="codeph nolang">false</samp>).
                </p>

                <p class="p">The default value is <samp class="codeph nolang">false</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">isProtected</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: boolean</p>

                <p class="p"><strong class="ph b">Description</strong>: An auto-generated value that doesn’t impact the behavior
                  of the metadata type. The default is <samp class="codeph nolang">false</samp>.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">A user-friendly name for
                  DisclosureDefinitionVersion, which is defined when the
                  DisclosureDefinitionVersion is created.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">omniScriptCnfgApiName</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>: The API name of the Omniscript configuration that's associated with the disclosure
                  definition version. This field is required only when
                  <span class="keyword parmname">authoringMode</span>isn’t <samp class="codeph nolang">Microsoft 365
                    Word</samp>.
                </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">omniScriptConfiguration</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">The ID of the Omniscript configuration record.</p>

                <p class="p"><strong class="ph b">Note</strong>: The value of this field is
                  automatically populated using the API name of the
                  OmniScript configuration specified in the
                  <span class="keyword parmname">omniScriptCnfgApiName</span>
                  field.
                </p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d1081385e101" data-title="Field Name"><span class="keyword parmname">versionNumber</span></td>

              <td class="entry" headers="d1081385e104" data-title="Description">
                <p class="p"><strong class="ph b">Field Type</strong>: string</p>

                <p class="p"><strong class="ph b">Description</strong>:</p>

                <p class="p">Required.</p>

                <p class="p">The version of the disclosure definition
                  published by the author.</p>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a DisclosureDefinitionVersion component.

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

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">
	<fullName\>Pkg</fullName\>
	<types\>
		<members\>GRI</members\>
		<name\>DisclosureDefinitionVersion</name\>
	</types\>
	<types\>
		<members\>df10</members\>
		<name\>DisclosureDefinition</name\>
	</types\>
	<types\>
		<members\>dt10</members\>
		<name\>DisclosureType</name\>
	</types\>
	<version\>60.0</version\>
</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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").