Salesforce Contracts

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Salesforce Contracts
Salesforce Contracts Standard Objects
Apex Reference
Salesforce Contracts Resources
Salesforce Contracts Metadata API Types
ClauseCatgConfiguration
ContractType
ESignatureConfig
ESignatureEnvelopeConfig
ExternalDocStorageConfig
PDF

ClauseCatgConfiguration

Represents the configuration about the library category that can be used by a user in their 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 Metadata metadata type and inherits 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

ClauseManagementAddOn license is required.

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 currently impact the behavior of the metadata type.
masterLabel
Field Type
string
Description
Required.
A user-friendly name for ClauseCatgConfiguration, which is defined when the ClauseCatgConfiguration is created.
usageType
Field Type
ClmCategoryUsageType (enumeration of type string)
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. 

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

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>DisclosureCategory</members>
		<members>ContractClauseCategory</members>
		<name>ClauseCatgConfiguration</name>
	</types>
	<version>57.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.