Download PDF
Download page Admin Entries.
Admin Entries
You must configure admin entries along with Comply System Properties.
To create admin entries
- Click the App Launcher icon (
).
- Search and select Admin. This displays the Admin tab with a list of all out-of-the-box Admin entries.
- To create a new Admin entry, click New.
Enter the name, value, and code and click Save. Your new Admin entry is saved and added.
Admin Entries in CLM
The following content provides information about various admin entries available in CLM along with their values and purposes.
APTS_AccountHierarchyFields
The APTS_AccountHierarchyFields property allows you to add up to four fields to display on an account's agreement hierarchy. If no value is provided for the property, the Account Name, Account Number, and Account Owner fields are displayed. For more information, see Viewing Account's Agreement Hierarchy.
Name | APTS_AccountHierarchyFields |
---|---|
Value | <Field API Name>:<User defined field label> Sample Value: |
Code | N/A |
APTS_ActivateDocumentsSelectAll
When the APTS_ActivateDocumentsSelectAll property is set to true, all documents on the Activate Agreement page are selected. When the APTS_ActivateDocumentsSelectAll property is set to false, all documents on the Activate Agreement page are unselected.
Name | APTS_ActivateDocumentsSelectAll |
---|---|
Value |
|
Code | N/A |
APTS_ActivateDocumentsSelectable
When the APTS_ActivateDocumentsSelectable property is set to true, users can select or unselect documents on the Activate Agreement page. When the APTS_ActivateDocumentsSelectable property is set to false, users cannot select and unselect documents on the Activate Agreement page.
Name | APTS_ActivateDocumentsSelectable |
---|---|
Value |
|
Code | N/A |
APTS_ActivateDocumentsPublishAll
When the APTS_ActivateDocumentsPublishAll property is set to true, all documents are selected for publishing but users can turn the Publish toggle on or off. When the APTS_ActivateDocumentsPublishAll property is set to false, all documents are unselected for publishing but users can turn the Publish toggle on or off.
Name | APTS_ActivateDocumentsPublishAll |
---|---|
Value |
|
Code | N/A |
APTS_AgreementHierarchyFields
The APTS_AgreementHierarchyFields property allows you to add up to four fields that must be displayed on the Agreement Hierarchy page. If no value is provided for APTS_AgreementHierarchyFields property, the Agreement Number and Status Category fields are displayed. For more information, see Viewing Agreement Hierarchy.
Name | APTS_AgreementHierarchyFields |
---|---|
Value |
Sample Value: Apttus__Contract_End_Date__c:End Date,Apttus__Activated_Date__c,Apttus__Agreement_Number__c:Agreement Number |
Code | N/A |
APTS_AgreementName_Default
This admin entry allows you to define a naming convention for the agreement generated on amending, cloning, or renewing an agreement.
If you set its value to true, the system appends the action name and an incremented value starting from the number specified in the Code for this entry, to the base agreement name and assigns it to the new agreement.
For example, if you specify 1 as the Code, after each amendment, the agreement name is updated to HP_MSA_Amended 1, HP_MSA_Amended 2, .....Similarly, after each renewal, the agreement name is updated to HP_MSA_Renewed 1, HP_MSA_Renewed 2,...
If you leave the Code as blank, the system starts the numbering from 1.
Name | APTS_AgreementName_Default |
---|---|
Value |
|
Code | N/A |
You can override the default naming convention for an action by configuring an action-specific admin entry. For more information, see APTS_AgreementName_Amend, APTS_AgreementName_Clone, APTS_AgreementName_Renew.
If the APTS_AgreementName_Default admin entry is set to false and the action-specific admin entry is also not configured, the system appends the action name to the agreement name as many times as the action is performed. For example, after each amendment, the agreement name is updated to HP_MSA_Amended, HP_MSA_Amended Amended, HP_MSA_Amended Amended Amended,...
APTS_AgreementName_Amend
This admin entry allows you to override the default naming convention for agreements generated on amending an agreement.
By default, the system appends the action name and an incremented value starting from 1 to the base agreement name and assigns it to the new agreement. You can set the numbering value to be started from a desired number. For example, to start the numbering from 2 instead of the default 1, you need to specify 2 in the Code of this admin entry.
Name | APTS_AgreementName_Amend |
---|---|
Value |
|
Code | 2 |
If you set this admin entry to false, the system modifies the agreement name as per the default behavior i.e. APTS_AgreementName_Default admin entry.
If you set both, APTS_AgreementName_Amend and APTS_AgreementName_Default to false, the system appends the action name to the agreement name as many times as the action is performed. For example, after each amendment, the agreement name is updated to HP_MSA_Amended, HP_MSA_Amended Amended, HP_MSA_Amended Amended Amended,...
APTS_AgreementName_Clone
This admin entry allows you to override the default naming convention for agreements generated on cloning an agreement.
By default, the system appends the action name and an incremented value starting from 1 to the base agreement name and assigns it to the new agreement. You can set the numbering value to be started from a desired number. For example, to start the numbering from 2 instead of the default 1, you need to specify 2 in the Code of this admin entry.
Name | APTS_AgreementName_Clone |
---|---|
Value |
|
Code | 2 |
If you set this admin entry to false, the system modifies the agreement name as per the default behavior i.e. APTS_AgreementName_Default admin entry.
If you set both, APTS_AgreementName_Clone and APTS_AgreementName_Default to false, the system appends the action name to the agreement name as many times as the action is performed. For example, after each cloning, the agreement name is updated to HP_MSA_Cloned, HP_MSA_Cloned Cloned, HP_MSA_Cloned Cloned Cloned,...
APTS_AgreementName_Renew
This admin entry allows you to override the default naming convention for agreements generated on renewing an agreement.
By default, the system appends the action name and an incremented value starting from 1 to the base agreement name and assigns it to the new agreement. You can set the numbering value to be started from a desired number. For example, to start the numbering from 2 instead of the default 1, you need to specify 2 in the Code of this admin entry.
Name | APTS_AgreementName_Renew |
---|---|
Value |
|
Code | 2 |
If you set this admin entry to false, the system modifies the agreement name as per the default behavior i.e. APTS_AgreementName_Default admin entry.
If you set both, APTS_AgreementName_Renew and APTS_AgreementName_Default to false, the system appends the action name to the agreement as many times as the action is performed. For example, after each renewal, the agreement is updated to HP_MSA_Renewed, HP_MSA_Renewed Renewed, HP_MSA_Renewed Renewed Renewed,...
APTS_AgreementDocumentActivateMaxFileSize
This property allows you to increase document storage size based on the Salesforce size limit. If the Salesforce storage limit for your org is increased to 25 MB or more, you must update this property to allow users to upload documents with the increased size limit. If this property is not configured, the value is 5 MB.
Name | APTS_AgreementDocumentActivateMaxFileSize |
---|---|
Value |
Sample value: |
Code | N/A |
APTS_AgreementStatusOnClauseApproval
This property allows you to define the status and status category of an agreement to be updated after all clauses in the agreement are approved, canceled, or rejected. When this property is not configured, the status and status category of an agreement are not updated after all clauses in the agreement are approved, canceled, or rejected .
Name | APTS_AgreementStatusOnClauseApproval |
---|---|
Value | Value: Sample value: |
Code | N/A |
APTS_AppendVersionNumberToMergedDocs
When the value of the APTS_AppendVersionNumberToMergedDocs admin entry is true and the Document Versioning Properties are enabled, a version number is appended to merged documents' names.. For more information, see Merging Documents in Salesforce Lightning.
Name | APTS_AppendVersionNumberToMergedDocs |
---|---|
Value | True |
Code | N/A |
APTS_AsyncCloneAmendRenew
You can use this admin entry when you want to clone, amend or renew agreements with many documents. By default, the admin entry is set to false.
When the APTS_AsyncCloneAmendRenew admin entry is set to true, the cloning, amendment, or renewal process of an agreement happens asynchronously in the background. This allows the user to continue working on other agreements without interruption. After the cloning, amendment, or renewal process is complete, the user receives an email notification.
When you amend, clone, or renew an activated agreement record, with documents present in the Agreement Documents-related list, the process occurs in synchronous mode. When you amend, clone, or renew an agreement record that is not activated, with documents present in the Document Versions-related list, the process occurs in asynchronous mode.
The asynchronous cloning, amendment, or renewal process only copies the files and attachments of the Agreement and Document Version Detail records in the background. If the documents (are present in either Agreement Documents or Executed Documents, then the files are copied synchronously and not asynchronously.
For more information on cloning, amending, or renewing an agreement, see Managing Agreement Lifecycle Post-Activation.
Name | APTS_AsyncCloneAmendRenew |
---|---|
Value | True |
Code | N/A |
APTS_AsyncMergeCall
Publishing a template takes the text from any referenced clauses and enters it inline as part of the template text. This functionality allows the clause template changes to be reflected in the agreement template and creates a newly published version document in the Notes and Attachment section of the Template. Whenever the agreement document generation exceeds 60 seconds, users get a timeout message and this is not an error message. To make sure the status changes during this scenario, add these Admin entries. For more information, see Document Generation Features List.
Name | APTS_AsyncMergeCall |
---|---|
Value | True |
Code | N/A |
APTS_AsyncMergeEmail
When the APTS_AsyncMergeEmail property is set to true, you will receive an email notification after the signed document is uploaded in an agreement. For more information, see Document Generation Features List.
Name | APTS_AsyncMergeEmail |
---|---|
Value | True |
Code | N/A |
APTS_AutoContentSearchable
The APTS_AutoContentSearchable property automatically enables Content Search on an activated agreement. By setting the flag to true, the system skips the prompt to select attachments for content search. The attachment already selected as part of the activation process will be automatically enabled for content search. For more information, see Routing Documents to Content Libraries and Activating an Agreement.
Name | APTS_AutoContentSearchable |
---|---|
Value | True |
Code | N/A |
APTS_CCIImportAgreementStatusCategory
The APTS_CCIImportAgreementStatusCategory property allows you to configure the visibility of the Intelligent Document Import button on the Agreement Detail page based on the Status Category of the agreement. When the property is not configured and the Status Category of the agreement is Request, In Authoring, In filing, or In Signatures, the Intelligent Document Import button is visible.
Name | APTS_CCIImportAgreementStatusCategory |
---|---|
Value |
Sample value: |
Code | NA |
APTS_ComplyConfig
The APTS_ComplyConfig property allows you to configure the custom objects that need to be cloned as part of the agreement clone, amend, and renew operation.
Name | APTS_ComplyConfig |
---|---|
Value | XML |
Code | You need to provide the configuration in the Code field. For more information, see Configuring APTS_ComplyConfig. |
The APTS_ComplyConfig property along with Enable PDF Security (comply system property) allows you to control restrictions for agreement documents:
- Generated in PDF format.
- Checked-in from X-Author Contracts as Final-to be signed with Create PDF attachment option selected.
Name | APTS_ComplyConfig |
---|---|
Value | XML |
Code | You need to provide the configuration in the Code field. For more information, see PDF Security for Agreement Documents. |
APTS_ContentRecordTypeName
The APTS_ContentRecordTypeName property is used to indicate the content type to associate the published documents with. If The property is not specified, no content type will be used. For more information, see Routing Documents to Content Libraries.
Name | APTS_ContentRecordTypeName |
---|---|
Value |
Sample value: |
Code | N/A |
APTS_ContentRepositoryType
The APTS_ContentRepositoryType property allows you to define which content repository must be used for routing documents. The supported setting "content" to use content repository settings for routing documents. The default setting is "document," which routes all activated documents to an Apttus folder. Changing this setting tells the system to use content repository settings for routing documents. For more information, see Routing Documents to Content Libraries.
To activate documents that exceed the file size of 40MB, you must set the value to content or chatter. For more information, see Activating an Agreement.
Name | APTS_ContentRepositoryType |
---|---|
Value |
Default value: Supported values: |
Code | N/A |
APTS_CustomLinksforActionPanel
The APTS_CustomLinksforActionPanel property enables you to add and customize the action panel. For more information, see Enabling and Customizing the Action Panel.
Name | APTS_CustomLinksforActionPanel |
---|---|
Value | N/A |
Code |
Sample code: |
APTS_CycleTimeReportingEnabled
The APTS_CycleTimeReportingEnabled property allows to track the time spent in between two statuses or status Categories. Entry for the specified status changes under Cycle Time Group tab must be created. For more information, see Cycle Time Reporting.
Name | APTS_CycleTimeReportingEnabled |
---|---|
Value | True |
Code | N/A |
APTS_DefaultContentWorkspaceName
The APTS_DefaultContentWorkspaceName property is used to indicate the default content workspace to publish the documents selected by the user during the agreement activation process. The user activating the agreement must be a member of the default content workspace. For more information, see Using Agreement Rules to Route Content.
Name | APTS_DefaultContentWorkspaceName |
---|---|
Value | <default workspace name> |
Code | N/A |
APTS_DefaultEmailContactName
The APTS_DefaultEmailContactName property allows you to specify the name of the default contact to resolve merge fields in an email template. To specify the name of a contact to send emails to, if a contact is not defined for the agreement. If The property is not defined and the agreement does not have a primary contact, the merge fields in the email would not be resolved to their values. For more information, see Sending an Agreement Document for Parallel Review.
Name | APTS_DefaultEmailContactName |
---|---|
Value | <Name of the contact> |
Code | N/A |
APTS_DefaultEmailTemplateFolder
The APTS_DefaultEmailTemplateFolder property allows you to add the name of the default email template folder. For more information, see Sending an Agreement Document for Parallel Review.
Name | APTS_DefaultEmailTemplateFolder |
---|---|
Value | <email template folder name> |
Code | N/A |
APTS_DefaultHeaderFooterOptionForMerge
The APTS_DefaultHeaderFooterOptionForMerge property allows you to set the Retain Header and Footer or Custom Header and Footer checkbox selected by default on the Merge Documents page. For more information, see Merging Documents in Salesforce Lightning.
Name | APTS_DefaultHeaderFooterOptionForMerge |
---|---|
Value | Retain Header and Footer or Custom Header and Footer |
Code | N/A |
APTS_DefaultSendersforReview_SendToOffice365Review
This admin entry allows you to configure a list of internal and external reviewers for mixed document review. You need to specify users, public groups, or profiles in the admin entry Code. When a user sends a document for Microsoft 365 review, the recipients specified in this property are displayed in the To field by default.
Name | APTS_DefaultSendersforReview_SendToOffice365Review |
---|---|
Value | N/A |
Code | { |
APTS_DefaultSendersforReview_SendToOffice365InternalReview
This admin entry allows you to configure a list of internal reviewers for document review. You need to specify users, public groups, or profiles in the admin entry Code. When a user sends a document for Microsoft 365 internal review, the recipients specified in this admin entry are displayed in the To field by default.
Note
Review emails are sent only to the internal users and email addresses specified in the admin entry Code. External users and email addresses are ignored for internal review.
Name | APTS_DefaultSendersforReview_SendToOffice365InternalReview |
---|---|
Value | N/A |
Code | { } |
APTS_DefaultSendersforReview_SendToOffice365ExternalReview
This admin entry allows you to configure a list of external reviewers for document review. You need to specify users, public groups, or profiles in the admin entry Code. When a user sends a document for Microsoft 365 external review, the recipients specified in this admin entry are displayed in the To field by default.
Note
Review emails are sent only to the external users and email addresses specified in the admin entry Code.
Name | APTS_DefaultSendersforReview_SendToOffice365ExternalReview |
---|---|
Value | N/A |
Code | { } |
APTS_DefaultSendersforReview_SendToOtherPartyForReview
This admin entry you to configure a list of reviewers for simple or parallel document review. You need to specify users, public groups, or profiles in the admin entry Code. When a user sends a document for simple or parallel review, the recipients specified in this admin entry are displayed in the To field by default.
Name | APTS_DefaultSendersforReview_SendToOtherPartyForReview |
---|---|
Value | N/A |
Code | { } |
APTS_DefaultSendersforReview_SendToOtherPartyForSignatures
Note
This admin entry applies to wet signatures only.
This admin entry allows you to configure a list of signatories to a contract document. You must specify users, public groups, or profiles in the admin entry code. When a user sends for a contract document for wet signature, the recipients specified in this admin entry are displayed in the To field by default.
Name | APTS_DefaultSendersforReview_SendToOtherPartyForSignatures |
---|---|
Value | N/A |
Code |
|
APTS_DEFAULT_PACKAGE
The APTS_DEFAULT_PACKAGE property allows you to connect X-Author for Contracts to both Conga CLM (Contracts for Salesforce) and Conga CLM packages when they are installed in the same org. For more information, see Installing Production X-Author for Contracts.
Name | APTS_DEFAULT_PACKAGE |
---|---|
Value | <CLM or CFS> |
Code | N/A |
APTS_DocumentNamingConvention_<RecordType label name>
The APTS_DocumentNamingConvention_<RecordType label name> property allows you to define a specific naming convention for the generated files based on the record types. If there are no naming conventions defined for the record types in the Admin Entry, the Document Naming Convention defined in Comply System Properties is used as the naming convention for the generated files. For more information, see Contract Document Versioning.
Ensure that you create only one naming convention per record type.
Name | APTS_DocumentNamingConvention_<RecordType label name> Sample name: APTS_DocumentNamingConvention_NDA |
---|---|
Value | <naming convention> |
Code | N/A |
APTS_DocumentSearchBasicFilters
The APTS_DocumentSearchBasicFilters property allows you to add fields that must be displayed on the Document Search page in the Basic Filters section. If The property is not defined, Agreement Number, Agreement Name, Owner ID, Status, Status Category, Agreement Start Date, Agreement End Date, Account, and Record Type fields are displayed. If The property is defined, the defined fields along with Account and Record Type fields are displayed. The Account and Record Type fields are displayed irrespective of the property. For more information, see Searching Agreement Documents.
Name | APTS_DocumentSearchBasicFilters |
---|---|
Value | N/A |
Code | <Field API Name>,<Field API Name> Sample Code: Apttus__Contract_End_Date__c,Apttus__Activated_Date__c,Apttus__Agreement_Number__c |
APTS_DocuSignRetrieveAsCombinedRecordType
The APTS_DocuSignRetrieveAsCombinedRecordType property enables you to combine the documents, based on the record type, when you send for signatures using DocuSign. If you set to the property to "all;<recordtype>;<recordtype>;<recordtype>", all takes precedence over the record types. This admin entry overrides the system property RetrieveAsCombinedDocument in DocuSign. For more information, see Retrieving DocuSign Certificate of Completion.
Name | APTS_DocuSignRetrieveAsCombinedRecordType |
---|---|
Value |
Sample value: |
Code | N/A |
APTS_DoNotCopyOpportunityToAdobeAgreement
Deprecated. For information on the new custom setting, see Configuring Conga-Adobe Custom Settings.
APTS_DoNotPrefixCurrency
In the multicurrency enabled orgs, the APTS_DoNotPrefixCurrency property allows you to not prefix currency symbols before the currency-related fields in the generated documents based on the Enable Formatting value in X-Author for Contracts. For more information, see Defining Template Locale.
Name | APTS_DoNotPrefixCurrency |
---|---|
Value | True |
Code | N/A |
APTS_DownloadableLinkExpiration
If no value is added, the viable days of the downloadable link are considered as 7 days and after 7 days the downloadable link will be inaccessible. For more information, see Emailing Multiple Agreement Documents.
Name | APTS_DownloadableLinkExpiration |
---|---|
Value | <number of days to expire the downloadable link> |
Code | N/A |
APTS_EditableSmartCCInReadonlyClause
The APTS_EditableSmartCCInReadonlyClause property allows you to enable the ability to edit Smart fields inside a read-only clause. If the value is set to True, then users can insert a clause in template and mark it as read-only. After document generation, the smart fields within this read-only clause remain as smart and editable and are included in reconciliation and UFC.
If the value is set to False, then users can insert a clause in template and mark it as read-only. After document generation the fields within this read-only clause are treated as merge fields and are not included in reconciliation and UFC. There will be no impact on clauses with clause behavior - delete read-only.
If this property is not set, the read-only clauses will follow same behavior as a False value.
Name | APTS_EditableSmartCCInReadonlyClause |
---|---|
Value | True, False |
Code | N/A |
APTS_EndOffice365ReviewEmailServiceAddress
This property along with the ApttusEndReviewByEmailO365 email service allows users to end an Office 365 review via email. For more information, see Configuring Email Service for Ending an Office 365 Review by Email.
Name | APTS_EndOffice365ReviewEmailServiceAddress |
---|---|
Value | <enter the email address provided while configuring the ApttusEndReviewByEmailO365 email service> |
Code | N/A |
APTS_EmailTemplateForReview
The APTS_EmailTemplateForReview property allows you to add the name of the email template for Send for Review action. For more information, see Configuring Email Templates in Lightning.
The property can only specify values for email templates with the "Available for Use" flag set to true.
Name | APTS_EmailTemplateForReview |
---|---|
Value | <template name or template unique name> |
Code | N/A |
APTS_EmailTemplateForReviewSignatures
The APTS_EmailTemplateForReviewSignatures property allows you to add the name of the email template to use for Send for Review and Send for Signatures actions. The property is only used if APTS_EmailTemplateForReview and APTS_EmailTemplateForSignatures are not specified. For more information, see Configuring Email Templates in Lightning.
The property can only specify values for email templates with the "Available for Use" flag set to true.
Name | APTS_EmailTemplateForReviewSignatures |
---|---|
Value | <email template name or email template unique name> |
Code | N/A |
APTS_EmailTemplateForSignatures
The APTS_EmailTemplateForSignatures property allows you to add the name of the email template for Send for Signatures action. For more information, see For more information, see Configuring Email Templates in Lightning.
The property can only specify values for Email Templates with the "Available for Use" flag set to true.
Name | APTS_EmailTemplateForSignatures |
---|---|
Value | <email template name or email template unique name> |
Code | N/A |
APTS_EnableCustomEmailAddressLookup
The APTS_EnableCustomEmailAddressLookup property enables you to launch the custom Email Address Lookup pop-up for the Send for Review and Send for Signature functionalities. On this page, you can quickly search and select contacts for the Additional To, Cc, and Bcc fields, if there is a large number of contacts (for example, more than one million). For more details, see Sending an Agreement Document for Review and Finalizing an Agreement.
Name | APTS_EnableCustomEmailAddressLookup |
---|---|
Value | True |
Code | N/A |
APTS_EnableLightningCommunity
When the APTS_EnableLightningCommunity admin entry is set to true, all users in an org are considered as Lightning Community users and are navigated to the Agreement Detail page after a user clicks New Agreement on an Opportunity.
When the admin entry is set to false, is not added, or has an invalid value, all users in an org are considered as Classic Community users and are navigated to Classic Community after a user clicks New Agreement on an Opportunity.
Name | APTS_EnableLightningCommunity |
---|---|
Value | True |
Code | N/A |
APTS_EnableTermExceptionsInAuthor
The APTS_EnableTermExceptionsInAuthor property associates the Agreement Term Exception related list to the Agreement record after you have associated your Term Exception with the clause and the clause is inserted in your agreement template. For more information, see Configuring Agreement Term Exception.
Name | APTS_EnableTermExceptionsInAuthor |
---|---|
Value | True |
Code | N/A |
APTS_EnableValidationForEmailWithoutUserContact
Setting the APTS_EnableValidationForEmailWithoutUserContact property to true displays an error message while sending a document for signatures or review when the email IDs or contacts specified in the To or Additional To fields are invalid. For more information, see Sending an Agreement Document for Parallel Review.
Name | APTS_EnableValidationForEmailWithoutUserContact |
---|---|
Value | True |
Code | N/A |
APTS_GenerateSupportingDocumentName
This admin entry allows you to define a naming convention for the documents generated under the "Generate Supporting Documents" section for agreements. This admin entry supersedes the Document Naming Convention property defined in Comply system properties. If a naming conventions is not defined in this admin entry, the Document Naming Convention property defined in the comply system properties is used.
The attributes permitted when formulating a document naming convention are:
- %checkintype%
- %action%
- %templatename%
- %user%
- %timestamp%
- %version%
Note
Any variable prefixed by (:) represents a field on the Agreement object.
Name | APTS_GenerateSupportingDocumentName |
---|---|
Value | <naming convention> |
Code | N/A |
APTS_HighlightFieldsUsingControlPanel
The APTS_HighlightFieldsUsingControlPanel allows you to view the Highlight Fields options under the work tab in X-Author for Contracts. When the APTS_HighlightFieldsUsingControlPanel is set to true the Highlight Fields option is visible under the X-Author for Contracts work tab for users, and when set to false, the menu is hidden for users. If the APTS_HighlightFieldsUsingControlPanel admin entry is not added, then by default, the value is set to true. For more information, see Highlighting Smart and Read-Only Fields.
Name | APTS_HighlightFieldsUsingControlPanel |
---|---|
Value | True |
Code | N/A |
APTS_IncludePrimaryContact
This property adds the primary contact from the agreement to the email's To field when you send for review or signatures.
Name | APTS_IncludePrimaryContact |
---|---|
Value | True |
Code | N/A |
APTS_InEffectViewMetadataFields
The APTS_InEffectViewMetadataFields property allows you to add fields that must be displayed on the In-Effect View page in the Agreement Details In Effect section. If The property is not defined, Agreement Name, Agreement Start Date, Agreement End Date, Term (Months), and Total Agreement Value fields are displayed. If the property is defined, only the defined fields are displayed, but not the default fields. For more information, see Accessing In-Effect View.
Name | APTS_InEffectViewMetadataFields |
---|---|
Value | N/A |
Code | <Field API Name>,<Field API Name>
|
APTS_IsRequiredToVerifyApttusMetadata
When you configure this admin entry and check-out an agreement document in X-Author Contracts, you can restore the metadata of a corrupted agreement document. For more information, see Restoring Document Metadata.
Name | APTS_IsRequiredToVerifyApttusMetadata |
---|---|
Value | True |
Code | N/A |
APTS_ExcludedNamespaces
This admin entry allows you to add a comma-separated list of namespaces to exclude objects from the wizard dropdown.
If you have configured this admin entry multiple times, then the latest configured admin entry is considered to exclude objects from the wizard dropdown. If this admin entry is not configured, the value provided in the Excluded Namespaces comply system property will be considered to exclude objects from the wizard dropdown.
Name | APTS_ExcludedNamespaces |
---|---|
Value | N/A |
Code | Code: comma-separated objects
|
APTS_KeepSectionBreaks
When you set the APTS_KeepSectionBreaks admin entry to false, page breaks are not added between merged documents.
Name | APTS_KeepSectionBreaks |
---|---|
Value | False |
Code | N/A |
APTS_LargeDocSObjects
By default, CPQ and CLM consider Proposal Line Item and Agreement Line Item as Large Objects for document generation. In case you used any other object in a template, you must use the APTS_LargeDocSObjects property to define such objects as Large objects. You can specify multiple objects as Large Objects and also provide a batch size for each of these objects.
Name | APTS_LargeDocSObjects |
---|---|
Value | N/A |
Code | <Object_API_name=<Batch Size>> Sample code:
|
APTS_MergeCallTimeOut
Whenever the agreement document generation exceeds 60 seconds, the timeout message is displayed. This is NOT an error message. To make sure the status changes during this scenario, add these Admin entries. For more information, see Objects Supporting Document Generation.
Name | APTS_MergeCallTimeOut |
---|---|
Value | True |
Code | N/A |
APTS_MS_EnableNameSort
The APTS_MS_EnableNameSort property allows you to specify whether the related list should be sorted by the name field in the generated agreement document. When enabled the related lists will be printed in the agreement’s merge documents in the order of the name field of the related list.
Name | APTS_MS_EnableNameSort |
---|---|
Value | True |
Code | N/A |
APTS_NoISOCurrencyFieldObjects
Use the APTS_NoISOCurrencyFieldObjects property to add support for custom object generation for objects that do not have a CurrencyIsoCode field (e.g., "EventRelation," "Task," "TaskRelation"). Separate Object names using a comma or new line. The property is only applicable to templates in multi-currency org.
Name | APTS_NoISOCurrencyFieldObjects |
---|---|
Value | XML |
Code | <Object API name> |
APTS_NoNameFieldObjects
Use the APTS_NoNameFieldObjects property to add support for custom object generation for Objects that do not have a Name field. (e.g., "EventRelation," "Task," "TaskRelation") Separate Object names using a comma or new line.
Name | APTS_NoNameFieldObjects |
---|---|
Value | XML |
Code | <Object API name> |
APTS_Password
The APTS_Password property allows you to create a password for protecting Microsoft Word agreements that are generated by the application. It also allows the application to password protect generated Microsoft Word documents.
Name | APTS_Password |
---|---|
Value | <password> |
Code | N/A |
APTS_ProfilePermissions
The APTS_ProfilePermissions property allows you to define custom permissions for user profiles.
Name | APTS_ProfilePermissions |
---|---|
Value | JSON |
Code | You need to define the access details in this field. For more information, see Assigning Master Profile and Custom Profile Permissions to User Profiles. |
APTS_Protection
The APTS_Protection property allows you to specify whether protection for Microsoft Word agreements that are generated by the application should be on or off. Allows the application to specify protection for generated MS-Word documents. The property must be configured before configuring the Agreement Protection tab.
Name | APTS_Protection |
---|---|
Value | Enter 1 to turn document protection on or 0 to turn it off |
Code | N/A |
APTS_RecordTypeUpdateOnAmend
The APTS_RecordTypeUpdateOnAmend property enables you to update record type while amending an agreement. If you set to the property to "all;<recordtype>;<recordtype>;<recordtype>", all takes precedence over the record types.
Name | APTS_RecordTypeUpdateOnAmend |
---|---|
Value |
Sample Value: |
Code | N/A |
APTS_RestrictDocumentFileFormat
You can ensure that the users import offline documents only of a specific file formats. APTS_RestrictDocumentFileFormat admin entry specifies restricted file formats.. Specify a comma-separated list in case of multiple file formats. If no value is provided for the property, users can import documents in any file format.
Name | APTS_RestrictDocumentFileFormat |
---|---|
Value | True |
Code | comma-separated values Sample Code: .jpeg,.png,.xlsx |
APTS_RestrictEmailToCurrentUserOnActivate
If the APTS_RestrictEmailToCurrentUserOnActivate property is set to true, the current user does not receive the agreement activation email notification. For more information, see Activating an Agreement.
APTS_RetainCommentsInTemplate
When APTS_RetainCommentsInTemplate is set to true, the comments added in the original X-Author for Contracts template are displayed in the generated document.
Name | APTS_RetainCommentsInTemplate |
---|---|
Value | True |
Code | N/A |
APTS_RetainFileNameForParallelReviewMergedDocument
When you end a parallel review of an imported document, the reviewed document is merged with the latest reviewed document. If the APTS_RetainFileNameForParallelReviewMergedDocument property is set to true, the merged document will retain the name of the imported document. For more information, see Sending an Agreement Document for Parallel Review.
Name | APTS_RetainFileNameForParallelReviewMergedDocument |
---|---|
Value | True |
Code | N/A |
APTS_RLPInstanceSettings
This property allows you to configure the org details of the Conga Platform to sync data from Salesforce to Conga platform for CLM.
Name | APTS_RLPInstanceSettings |
---|---|
Value | N/A |
Code | Sample code:
Note Enter the region-specific fwd_sync_url. For example, NA: https://rls-preview.congacloud.io |
APTS_SkipEmailTemplateSelection
The APTS_SkipEmailTemplateSelection property allows you to indicate whether the email template selection step should be skipped. For more information, see Generating an Agreement.
Name | APTS_SkipEmailTemplateSelection |
---|---|
Value | True |
Code | N/A |
APTS_SkipFileSplitWhileSavingFile
When you are upgrading CLM to Spring '21 or a later version and need to migrate Attachments that are greater than 10 MB in size to Files, you must set this property to true.
Post-migration, this property must be set to false.
Name | APTS_SkipFileSplitWhileSavingFile |
---|---|
Value | True |
Code | N/A |
APTS_SkipContentSearchForActivation
Prerequisite: The Enable File comply system property must be enabled.
When the value is true, the Enable Content Search step is skipped during activation. To use the APTS_SkipContentSearchForActivation property, the value of the APTS_AutoContentSearchable must be False. For more information, see Activating an Agreement.
Name | APTS_SkipContentSearchForActivation |
---|---|
Value | False |
Code | N/A |
APTS_SkipRemoveDraftDocumentOnActivation
Prerequisite: The Enable File comply system property must be enabled.
When the value is true, the remove draft document step is skipped during activation. To use the APTS_SkipRemoveDraftDocumentOnActivation property, the value of the APTS_AutoContentSearchable must be False. For more information, see Activating an Agreement.
Name | APTS_SkipRemoveDraftDocumentOnActivation |
---|---|
Value | False |
Code | N/A |
APTS_StatusCategoriesToExcludeForDocuSign
This property allows you to specify agreement status categories that should not be changed to In Signatures after the agreement document is sent for DocuSign eSignature. Specify multiple status categories separated by comma.
If an agreement has any of the status categories specified in this property, the status remains unchanged after the document is sent for DocuSign eSignature.
Name | APTS_StatusCategoriesToExcludeForDocuSign |
---|---|
Value | Expired, Terminated, Amended, Cancelled, Renewed, In Effect |
Code | N/A |
APTS_StatusCategoriesToIncludeForDocuSign
This property allows you to specify agreement status categories that should be changed to In Signatures after the agreement document is sent for for DocuSign eSignature. Specify multiple status categories separated by comma.
If an agreement has any of the status categories specified in this property, the status is changed to In Signatures after the document is sent for DocuSign eSignature.
Name | APTS_StatusCategoriesToIncludeForDocuSign |
---|---|
Value | Request, In Authoring, In Filing |
Code | N/A |
Values set in this property overrides the values set in APTS_StatusCategoriesToIncludeForDocuSign property.
For example, if Expired status category is specified APTS_StatusCategoriesToExcludeForDocuSign as well APTS_StatusCategoriesToExcludeForDocuSign property, then the status category of the agreement having current status category Expired, will be changed to In Signatures.
APTS_StatusCategoriesToExclude
This admin entry allows you to add a comma-separated list of status categories that should be blocked for a child agreement when the parent agreement is expired or terminated. By default, the system blocks updating the status of the child agreement if it is Terminated, Expired, or Cancelled. To block any other status categories, add them to this admin entry, and the system does not change the status category and status of the child agreement (Amended or Renewed) when a parent agreement is expired or terminated.
Name | APTS_StatusCategoriesToExclude |
---|---|
Value | N/A |
Code | In Signatures, Terminated |
APTS_StatusCategoriesToInclude
This admin entry allows you to add a comma-separated list of status categories that should be updated for a child agreement when the parent agreement is expired or terminated. By default, the system blocks updating the status of the child agreement if it is Terminated, Expired, or Cancelled. To update the status category in the child agreement, add them in this admin entry, and the system updates the status category and status of the child agreement (Amended or Renewed) when a parent agreement is expired or terminated.
Name | APTS_StatusCategoriesToInclude |
---|---|
Value | N/A |
Code | Cancelled, Request |
APTS_SuppressAutoReviewEmails
When the value of the property is true, you will be unsubscribed from parallel review emails (review completion, review error, and review cycle completion). This property is not applicable for review cancellation and ending review from CLM as the emails are sent from the user's domain.
Name | APTS_SuppressAutoReviewEmails |
---|---|
Value | True |
Code | N/A |
APTS_TemplateSelectionGuidance
The APTS_TemplateSelectionGuidance property allows you to add help text in the Template Selection page to guide users to select appropriate templates when users preview documents, generate documents, regenerate documents, and generate supporting documents. The help text is displayed above the template selection section. For more information, see Generating an Agreement.
Name | APTS_TemplateSelectionGuidance |
---|---|
Value | N/A |
Code | Sample code: Please select an appropriate template. |
APTS_TranslatePickValuesInDocs
When you set the APTS_TranslatePickValuesInDocs admin entry to true, the field value gets added in the generated document. If a conditional segment is set, the condition takes both API and values. You can either use API names or Values but not both.
When an administrator sets the APTS_TranslatePickValuesInDocs admin entry to false or does not add the admin entry, the API Name gets added in the generated document by default.
Name | APTS_TranslatePickValuesInDocs |
---|---|
Value | True |
Code | N/A |
APTS_UIPageConfig
The APTS_UIPageConfig property is used to indicate the visual force page to perform the publish action. The integration module provides the Visualforce page Apttus_Content__PublishContent.
Name | APTS_UIPageConfig |
---|---|
Value | XML |
Code | Sample Code:
|
APTS_UseWizardServer
Apttus merge web service endpoint. For more information, see Contract Wizard in Classic.
Name | APTS_UseWizardServer |
---|---|
Value | True |
Code | N/A |
APTS_UseWorkflow
The APTS_UseWorkflow property disables the creation of a default set of tasks when an agreement is generated. In some cases, the default tasks created to ensure Signing, Scanning, and Attaching the scanned image to the agreement record is redundant or is taken care of by a different workflow process. In such cases, the default behavior of the system needs to be modified to ensure those tasks are not created. For more information, see Managing Workflow.
Name | APTS_UseWorkflow |
---|---|
Value | True |
Code | N/A |
APTS_WizardPersistHiddenValue
When you set APTS_WizardPersistHiddenValue to true and you run a wizard containing a field that has a combination of Set this control value and Hide this control input rules, the field value is set in the object you are creating. When you set APTS_WizardPersistHiddenValue to false and you run a wizard containing a field that has a combination of Set this control value and Hide this control input rules, the field value is not set in the object you are creating. For more information, see Configuring Step Input Rules from the Wizard Designer.
Name | APTS_WizardPersistHiddenValue |
---|---|
Value | False |
Code | N/A |
APTS_XAAddInLoadType
The APTS_XAAddInLoadType property allows you to define the installation approach to access the X-Author for Contracts 2.0 add-in. You can use any one of the following supported values:
- centralized - If you install the X-Author for Contracts 2.0 add-in using Centralized Deployment via the Office 365 admin center, set The property value to "centralized". Centralized Deployment supports both Windows operating system and Mac operating system. For more information on installing X-Author for Contracts 2.0 add-in using Centralized Deployment, see Installing Production X-Author for Contracts 2.0.
- sideloading - If you are unable to install the X-Author for Contracts 2.0 add-in using Centralized Deployment in Office 365, alternatively you can install the add-in on the Mac system using the Sideloading approach. If you install the X-Author for Contracts 2.0 add-in on a Mac system using a manifest file, set The property value to "sideloading". For more information, contact Support.
- appsource - If you access the X-Author for Contracts 2.0 add-in using Microsoft Store, set The property value to "appsource". For more information, contact Support.
If The property is not defined, the Centralized Deployment approach is used to access the X-Author for Contracts 2.0 add-in.
Name | APTS_XAAddInLoadType |
---|---|
Value | Default value: Supported values: |
Code | N/A |
Admin Entries to Sync Data between Salesforce and Conga Platform for CLM
APTS_RLPInstanceSettings
This property allows you to configure the org details of the Conga Platform to sync data from Salesforce to the Conga platform for CLM.
Name | APTS_RLPInstanceSettings |
---|---|
Value | N/A |
Code | Sample code:
Contact Conga Support to get the above values. |
APTS_Disable_DualWrite
This property allows you to disable data sync between Salesforce and Conga Platform for CLM. When you set the property value to "true" the data sync is disabled.
Name | APTS_Disable_DualWrite |
---|---|
Value | True |
Code | N/A |
APTS_Additional_DualWriteObjects
This admin entry allows you to add a comma-separated list of objects other than Apttus__APTS_Agreement__c, Attachment, and ContentDocumentLink that you need to sync to the Conga Platform for CLM.
Name | APTS_Additional_DualWriteObjects |
---|---|
Value | N/A |
Code | Sample code:
|
If you configure the APTS_Additional_DualWriteObjects property, you must create the corresponding mapping for the configured object in Conga Platform. For more information, see Creating and Managing Object Mappings.
You must also create triggers for the object. To create a trigger:
- Go to Setup > Object Manager.
- Select an object that you need to configure.
- Click Triggers > New.
- In the Apex Trigger window, select the Is Active checkbox.
Enter the following code.
trigger <ObjectName>Trigger on <ObjectName> (after insert, after update, after delete) { Conga_4SF.CongaDualWriteUtils.initiateDualWrite(); }
CODE
APTS_Additional_Document_ParentObjectsDualWrite
This admin entry allows you to add a comma-separated list of parent objects other than Apttus__APTS_Agreement__c and documentVersionDetails to sync documents from that object.
Name | APTS_Additional_Document_ParentObjectsDualWrite |
---|---|
Value | N/A |
Code | Sample code:
|