ClauseCatgConfiguration

Represents the configuration about the clause category that can be used to categorize your disclosure and compliance reports from standardized disclosure templates in a response document.

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

ClauseCatgConfiguration components have the suffix .clauseCatgConfiguration and are stored in the clauseCatgConfigurations folder.

Version

ClauseCatgConfiguration components are available in API version 57.0 and later.

Special Access Rules

The ClauseManagementAddOn license is required to access this object along with user access for the Clause Designer User permission set license.

Fields

Field Name	Description
description	Field Type string Description The description about the clause category configuration.
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 ClauseCatgConfiguration, which is defined when the ClauseCatgConfiguration is created.
usageType	Field Type ClmCategoryUsageType Description Required. The usage type of the clause category configuration. Possible values are: `ContractClauseCategory` `DisclosureCategory`

Declarative Metadata Sample Definition

The following is an example of a ClauseCatgConfiguration component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ClauseCatgConfiguration
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<description>This is to add description for Contract Clause Category.</description>
5	<usageType>ContractClauseCategory</usageType>
6	<isProtected>false</isProtected>
7	<masterLabel>Contract Clause Cat</masterLabel>
8</ClauseCatgConfiguration>

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		<name>ClauseCatgConfiguration</name>
7	</types>
8	<version>57.0</version>
9</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