You are here:
Vlocity CLM Custom Settings
There are two types of custom settings—those you set for the entire org and those you set at the Contract Type level. This table summarizes the Vlocity CLM Custom Settings.
When you set Contract Type custom settings, CLM applies them only when you generate documents from the Contract Details page. CLM does not apply these settings when you generate documents with Omniscripts or Apex code.
Name | Default | Purpose | Level |
|---|---|---|---|
AppendZeroToEmbeddedSectionAutoNumber |
No |
Appends a .0 to the end of a generated auto number for section with child sections. |
Contract Type |
Auto Generate Doc Template |
The active template name for the object |
Org |
|
AutoGenerateDoc FileType |
Word |
Specifies the format or formats to attach to the contract document when the contract is automatically created from a quote, opportunity, or order. Possible values are:
|
Contract Type |
AutoGenerateDocOn ContractCreation |
Yes |
Indicates if a document template is automatically associated with the contract document when a contract is created. |
Contract Type |
Contract Document Access Control |
Edit Document |
Sets access to contract documents. Possible values are:
|
Org |
ContractDocumentAttachOption |
Word |
Specifies the format or formats to attach to the contract document when the contract is created. Possible values are:
|
Contract Type |
ContractDocumentDownloadOption |
Word |
Specifies the format or formats available to download from the contract. This option is available only for DOCX templates and PPTX templates as well as Web templates created from batch files. This is unavailable for Web templates not created from batch files. Possible values are:
|
Contract Type |
ContractEnvelopesLastPollDate |
None |
The date when Vlocity CLM received the DocuSign envelope status |
Org |
ContractSignature DeclinedStatus |
Signature Declined |
Set the contract document to this status if the signer declines to sign the contract. |
Contract Type |
ContractSignatureVoidedStatus |
Draft |
Set the contract document to this status if a DocuSign envelope is voided. |
Contract Type |
ContractSignatureExpiredStatus |
In Approval Process |
Set the contract document to this status if a DocuSign envelope expires. |
Contract Type |
ContractSigned Status |
Signed |
Set the contract to this status after the contract has been signed. |
Contract Type |
CheckDocEmbeddingInDOCXTemplate |
No |
When set to Yes, this validates the embedded fonts for Microsoft Word DOCX document templates in the Template Designer and gives an error message if fonts in the document template are not embedded. This means the PDF file of the document might not display the expected fonts, and you must embed the fonts in your Microsoft Word DOCX template. |
Org |
CreateNewVersionOnContractUpdate |
Yes |
Automatically create a new contract version whenever the contract is updated. If this setting doesn't'
exist or is Yes, create a new contract version when Update
Contract is clicked or the If this setting exists and it is No,
don't create a new contract version when Update Contract
is clicked or the |
Contract Type |
DeepCopy AttachmentFor ContractDocument |
No |
When creating a new version of a contract document, specifies whether to keep the previous version’s attachments. Possible values are:
|
Contract Type |
DefaultTemplate Name |
Vlo-Telecome Agreement (MAIN) |
If this is Yes, the DefaultGetContractTemplateNameImpl implementation gets this template. |
Contract Type |
DocGenerationMechanism |
VlocityClientSide |
Sets the source of document generation. Possible values are:
|
Org |
DocuSignAccount Brand |
n/a |
DocuSign allows brands to be attached to accounts, from which Vlocity CLM can derive logos and other branding information to include in the email messages sent to the signatories. |
Contract Type |
DocuSign Callout Configuration Setup |
n/a |
Increases the read time out for DocuSign call outs. Enter a value greater than 10,000. The Salesforce default callout limit is 10,000 ms. The maximum allowed setting is 120,000 ms. |
Org |
DocuSignEvnelopeObjectLimits |
3 MB |
Specifies synchronization file size limit |
Org |
DocuSignExpireAfter |
5 |
Specifies the amount of time between the contract being sent to DocuSign and when it expires if nothing is done. |
Contract Type |
DocuSignExpire Enabled |
Yes |
Specifies whether the contract expires after being sent to DocuSign. |
Contract Type |
DocuSignExpireWarn |
1 |
Specifies the amount of time before the user is warned if the contract is going to expire. |
Contract Type |
DocuSignReminderDelay |
2 |
Specifies the time after which reminders will be sent. |
Contract Type |
DocuSignReminder Enabled |
Yes |
Specifies whether the reminder is enabled. |
Contract Type |
DocuSignReminder Frequency |
1 |
Specifies how frequently the reminder is sent. |
Contract Type |
DocuSignUse AccountDefault Notification |
No |
Specifies the settings for sending an envelope for a signature using DocuSign. |
Contract Type |
IsServerSideDocGenEnabled |
false |
Specifies whether server-side document generation is enabled. |
Contract Type |
Last DocuSign Envelope Status |
Picklist with:
|
Status of document being sent to DocuSign for eSignature. |
Contract Type |
Notify Doc Template Version Change To Statuses |
Draft |
When a new version of a document template is available, child contract documents display notifications if the contract document is in this status. |
Org |
PdfGenerationSource |
VlocityClientSide (new installation) Salesforce (upgrades) |
Specifies conversion mechanism that converts documents to PDF. For details, see Understanding PDF Conversion in CLM. Possible values are:
|
Org |
PdfViewer |
VlocityClientSideViewer |
Specifies mechanism to preview documents.
|
Contract Type |
TermCategoryName |
SalesTermCategory |
This optional setting groups together your sales terms. You must manually add it if you want to use it. |
Org |
TrackContract Redlines |
No |
Enables change tracking. |
Org |
Word Docx Template Name |
DocxGen Template |
The name of the static resource that contains the Microsoft Word template used to generate Microsoft Word documents |
Contract Type |
- Configuring Contract Management Custom Settings
Use custom settings to create and manage data at the organization, profile, and user-levels. - Access to Contract Documents
The Contract Document Access Control custom setting indicates a user’s access to contract sections and contract redlining (redlining is a feature that is supported only for internal use at your company). You can set the Contract Document Access Control custom setting at the org, profile, or user levels. - Configure Access to Contract Documents for Org
The Contract Document Access Control custom setting indicates a user’s access to contract sections and contract redlining (redlining is a feature that is supported only for internal use at your company). You can configure the Contract Document Access Control custom setting for the entire org using this procedure. - Configure Access to Contract Documents for Profile
The Contract Document Access Control custom setting indicates a user’s access to contract sections and contract redlining (redlining is a feature that is supported only for internal use at your company). You can configure the Contract Document Access Control custom setting for profiles using this procedure. - Generating a Contract Document Automatically
You can set up Vlocity CLM to automatically generate a contract document when it creates a contract. - Configuring the PDF Document Template Custom Setting
The PDF Document Template custom setting controls the active template name for an object. This document provides Vlocity CLM with a template when a contract is created. You can create a PDF Document Template setting for any object from which you make contracts. - Attaching a Document to a Contract Document
The contents of an attached contract document must always be synchronized with the checked in, online version. Every document version must have a system-generated document attached to it. When an online contract document is finalized—checked in, generated, or imported—Vlocity CLM automatically generates a document in Microsoft Word, PDF, or both and attaches it to the latest contract version. - Enabling or Disabling Contract Redlining at the Document Template Level
You can enable or disable internal redlining for each document template. In the Document Template Designer, select Track Redlines. - Enabling or Disabling Contract Redlining at the Org Level
To enable contract redlining, the Contract Management Configuration custom setting, TrackContractRedlines must have the Setup Value Yes. If this custom setting is No, contract redlining is disabled for the entire org. - Editing the Default Microsoft Word Template
Using Vlocity CLM, you can generate contracts in Microsoft Word format. The Microsoft Word contract document can include headers and footers, repeating logos, and page numbering. - Creating a New Microsoft Word Template
You can use your own Microsoft Word template to include header and footer information, logos, and watermarks, and to change the default fonts and formatting. - Creating a New Contract Record Page Layout
The Contract page layout must contain these two Visualforce pages: ContractActionBar displays the action buttons at the top of the contract and ContractDocumentNewDisplay displays the contract document management component. The default Contract record detail page includes these sections actions, contract documents, contract line items, approval history, replacement contract, sub contract, amendment contracts, contract document envelopes. - Enabling the Contract Record Type for Profiles
You can enable contract record types for profiles. - Setting a Default Contract Record Type
You can set a default contract record type for a profile. When a user with that profile creates a new contract, the contract is based on the default record type. - Understanding PDF Conversion in CLM
Starting with Summer '19, CLM converts generated files to .pdf format using conversion options based on the type of template. CLM uses the PDFGenerationSource custom setting to control what conversion option to use. Based on what you select and the template type you're using, this affects the availability of the documents that you can download and attach after generating documents. - Adding the ContractSignatureVoidedStatus and ContractSignatureExpiredStatus Contract Type Settings
When an envelope is created in DocuSign, if there is no customer action, the envelope may expire or become voided. If this happens, the ContractSignatureVoidedStatus and ContractSignatureExpiredStatus settings on the Contract Type determine what happens to the contract.
