Configure admin entries along with Comply System Properties

 To create admin entries

  1. Click the + icon; then click Admin. All the out-of-the-box admin entries are displayed on the Admin home page. 

  2. To create a new Admin entry, click New.
  3. Enter a name, value, and code for the new admin entry and click Save

Admin Entries in CLM

The following sections document admin entries available in CLM, and their values and purposes.

APTS_AccountHierarchyFields

The APTS_AccountHierarchyFields property allows you to add up to four fields that must be displayed on an account's agreement hierarchy. If no value is provided, the Account Name, Account Number, and Account Owner fields are displayed. For more information, see Viewing Agreement Hierarchy of an Account.

Name

APTS_AccountHierarchyFields

Value

<Field API Name>:<User defined field label>

Sample ValueAccountNumber:Account Number,OwnerId:Account Owner,Owner.Name:Owner Name,AccountSource:Account Source

CodeN/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. 

NameAPTS_ActivateDocumentsSelectAll
Value

True

CodeN/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.

NameAPTS_ActivateDocumentsSelectable
Value

True

CodeN/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

True

CodeN/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 the property, the Agreement Number and Status Category fields are displayed. For more information, see Viewing Agreement Hierarchy.

NameAPTS_AgreementHierarchyFields
Value

<Field API Name>:<User defined field label>

Sample Value: Apttus__Contract_End_Date__c:End Date,Apttus__Activated_Date__c,Apttus__Agreement_Number__c:Agreement Number

CodeN/A

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 for users to upload documents with the increased size limit. If this property is not configured, the value is 5 MB.

Name

APTS_AgreementDocumentActivateMaxFileSize

Value

<storage size in MB>

Sample value: 25

CodeN/A

APTS_AgreementStatusOnClauseApproval

This property allows you to define the status and status category of an agreement to be updated after all clauses are approved, canceled, or rejected in the agreement. 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.

NameAPTS_AgreementStatusOnClauseApproval
Value

Value: <Status Category>|<Status>

Sample value: In Signature|Ready for Signature

CodeN/A

APTS_AppendVersionNumberToMergedDocs

When the value of the APTS_AppendVersionNumberToMergedDocs admin entry is true and document versioning properties are enabled, the name of the merged documents will be suffixed with a version number. For more information, see Merging Documents in Salesforce Lightning.

Name

APTS_AppendVersionNumberToMergedDocs

ValueTrue
CodeN/A

APTS_AsyncCloneAmendRenew

You can use this admin entry when agreements have a large number of documents. When the value of the APTS_AsyncCloneAmendRenew admin entry is true, agreement cloning, amendment, or renewal happens in the background. The user receives an email notification when the cloning, amendment, or renewal is complete. By default, the admin entry is set to false. For more information, see Managing Agreement Lifecycle Post-Activation.

Name

APTS_AsyncCloneAmendRenew

ValueTrue
CodeN/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 template's Notes and Attachment section. Whenever the agreement document generation exceeds 60 seconds, users get a timeout message (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 

ValueTrue
CodeN/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.

NameAPTS_AsyncMergeEmail
ValueTrue
CodeN/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 is automatically enabled for content search. For more information, see Routing Documents to Content Libraries and Activating an Agreement.

NameAPTS_AutoContentSearchable
ValueTrue
CodeN/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 agreement's status category. 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

<Status Category> 

Sample value: Amended

CodeNA

APTS_ComplyConfig

The APTS_ComplyConfig property allows you to configure the custom objects that must be cloned as part of the agreement's clone, amend, and renew operation. 

NameAPTS_ComplyConfig
ValueXML
CodeEnter 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 for Contracts as "Final-to be signed" with the "Create PDF attachment" option selected. 
NameAPTS_ComplyConfig
ValueXML
CodeEnter the configuration in the Code field. For more information, see PDF Security for Agreement Documents.

APTS_ContentRecordTypeName

The APTS_ContentRecordTypeName property indicates the content type to associate the published documents with. If the property is not specified, no content type is used. For more information, see Routing Documents to Content Libraries.

NameAPTS_ContentRecordTypeName
Value

<content type name>

Sample value: Agreements

CodeN/A

APTS_ContentRepositoryType

The APTS_ContentRepositoryType property defines which content repository shall be used for routing documents. The supported content setting uses content repository settings to route documents. The default setting, document, 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 larger-than-40 MB documents, set the value to content or chatter. For more information, see Activating an Agreement.

NameAPTS_ContentRepositoryType
Value

<content repository type>

Default value: document

Supported values: content, chatter

CodeN/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.

NameAPTS_CustomLinksforActionPanel
ValueN/A
Code

<API name of button>

Sample codePreview_Custom__c,Generate_Supporting_Document_Custom__c,Generate_Custom__c,Generate_Supporting_Document_Custom__c,Generate_Custom__c,


APTS_CycleTimeReportingEnabled

When the APTS_CycleTimeReportingEnabled property is enabled, the system tracks the time spent between two statuses or status categories. You must create an entry for the specified status changes under the Cycle Time Group tab. For more information, see Cycle Time Reporting.

NameAPTS_CycleTimeReportingEnabled
ValueTrue
CodeN/A

APTS_DefaultContentWorkspaceName

The APTS_DefaultContentWorkspaceName property indicates the default content workspace for publishing documents selected by the user during agreement activation. The user activating the agreement must be a member of the default content workspace. For more information, see Using Agreement Rules to Route Content.

NameAPTS_DefaultContentWorkspaceName
Value<default workspace name>
CodeN/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. This specifies the name of a contact to send emails to if no contact is 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 are not resolved to their values. For more information, see Sending an Agreement Document for Parallel Review.

NameAPTS_DefaultEmailContactName
Value<Name of the contact>
CodeN/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.

NameAPTS_DefaultEmailTemplateFolder
Value<email template folder name>
CodeN/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.

NameAPTS_DefaultHeaderFooterOptionForMerge
Value
  • Retain Header and Footer
  • Custom Header and Footer
CodeN/A

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.

NameAPTS_DEFAULT_PACKAGE
Value<CLM or CFS>
CodeN/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 no naming conventions are 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.

Create only one naming convention per record type.

NameAPTS_DocumentNamingConvention_<RecordType label name>
Sample nameAPTS_DocumentNamingConvention_NDA
Value<naming convention>
CodeN/A

APTS_DocumentSearchBasicFilters

The APTS_DocumentSearchBasicFilters property allows you to add fields that must be displayed in the Basic Filters section of the Document Search page. If the property is not defined, the 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, are displayed along with the Account and Record Type fields. The Account and Record Type fields are displayed irrespective of the property. For more information, see Searching Agreement Documents.

NameAPTS_DocumentSearchBasicFilters
ValueN/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 the property to all;<recordtype>;<recordtype>;<recordtype>, all takes precedence over the record types. This admin entry overrides the RetrieveAsCombinedDocument system property in DocuSign. For more information, see Retrieving DocuSign Certificate of Completion.

Name

APTS_DocuSignRetrieveAsCombinedRecordType

Value

Semicolon-separated record type names or all

Sample value: NDA;sla;MSA

CodeN/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.

NameAPTS_DoNotPrefixCurrency
ValueTrue
CodeN/A

APTS_DownloadableLinkExpiration

If no value is added, the downloadable link is considered viable for seven days, after which the downloadable link becomes inaccessible. For more information, see Emailing Multiple Agreement Documents.

NameAPTS_DownloadableLinkExpiration
Value<number of days to expire the downloadable link>
CodeN/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 fields within this read-only clause remain as smart/read-only as per the field property 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. If this property is not set, the read-only clauses will follow same behavior as a False value.

Name

APTS_EditableSmartCCInReadonlyClause

ValueTrue, False
CodeN/A

APTS_EndOffice365ReviewEmailServiceAddress

This property, along with the ApttusEndReviewByEmailO365 email service, enables users to end a Microsoft 365 review via email. For more information, see Configuring Email Service for Ending an Office 365 Review by Email

Name

APTS_EndOffice365ReviewEmailServiceAddress

Value<The email address provided while configuring the ApttusEndReviewByEmailO365 email service>
CodeN/A

APTS_EmailTemplateForReview

The APTS_EmailTemplateForReview property names the email template for the 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.

NameAPTS_EmailTemplateForReview
Value<template name or template unique name>
CodeN/A

APTS_EmailTemplateForReviewSignatures

The APTS_EmailTemplateForReviewSignatures property names the email template to use for the 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.

NameAPTS_EmailTemplateForReviewSignatures
Value<email template name or email template unique name>
CodeN/A

APTS_EmailTemplateForSignatures

The APTS_EmailTemplateForSignatures property names the email template for the Send for Signatures action. For more information, see Configuring Email Templates in Lightning.

This property can only specify values for email templates with the "Available for Use" flag set to true.

NameAPTS_EmailTemplateForSignatures
Value<email template name or email template unique name>
CodeN/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 (for example, more than one million) contacts. For more details, see Sending an Agreement Document for Review and Finalizing an Agreement.

NameAPTS_EnableCustomEmailAddressLookup
ValueTrue
CodeN/A

APTS_EnableLightningCommunity

When the APTS_EnableLightningCommunity admin entry is set to true, all users in an org are considered Lightning Community users and taken to the Agreement Detail page after clicking 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 Classic Community users and taken to Classic Community after clicking New Agreement on an opportunity.

NameAPTS_EnableLightningCommunity
ValueTrue
CodeN/A

APTS_EnableTermExceptionsInAuthor

The APTS_EnableTermExceptionsInAuthor property associates the Agreement Term Exception related list to the agreement record after you associate your term exception with the clause and the clause is inserted into your agreement template. For more information, see Configuring Agreement Term Exception.

NameAPTS_EnableTermExceptionsInAuthor
ValueTrue
CodeN/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.

NameAPTS_EnableValidationForEmailWithoutUserContact
ValueTrue
CodeN/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. 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.

NameAPTS_HighlightFieldsUsingControlPanel
ValueTrue
CodeN/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. 

NameAPTS_IncludePrimaryContact
ValueTrue
Code

N/A

APTS_InEffectViewMetadataFields

The APTS_InEffectViewMetadataFields property allows you to add fields to be displayed on the Agreement Details In Effect section of the In-Effect View page. 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.

NameAPTS_InEffectViewMetadataFields
ValueN/A
Code

<Field API Name>,<Field API Name>

Sample code: Apttus__Contract_End_Date__c,Apttus__Term_Months__c,Apttus__Total_Contract_Value__c

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.

NameAPTS_IsRequiredToVerifyApttusMetadata
ValueTrue
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. 

NameAPTS_ExcludedNamespaces
ValueN/A
Code

Code: comma-separated objects

Sample Code: Apttus__OCCAccessMode__c, Apttus__IDE

APTS_KeepSectionBreaks

When you set the APTS_KeepSectionBreaks admin entry to false, page breaks are not added between merged documents.

NameAPTS_KeepSectionBreaks
ValueFalse
CodeN/A

APTS_LargeDocSObjects

By default, CPQ and CLM consider Proposal Line Item and Agreement Line Item as large objects for document generation. If 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. 

NameAPTS_LargeDocSObjects
ValueN/A
Code

<Object_API_name=<Batch Size>>

Sample code

Apttus_QPConfig__ProposalLocation__c=5
QTC_Proposal_Related_Line_Item_c=1000

APTS_MergeCallTimeOut

Whenever 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.

NameAPTS_MergeCallTimeOut
ValueTrue
CodeN/A

APTS_MS_EnableNameSort

The APTS_MS_EnableNameSort property enables you to specify whether a related list shall be sorted by the name field in the generated agreement document. When enabled, the related lists is printed in the agreement’s merge documents in the order of the related list's name field. 

NameAPTS_MS_EnableNameSort
ValueTrue
CodeN/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 newline. This property only applies to templates in a multi-currency org. 

NameAPTS_NoISOCurrencyFieldObjects
ValueXML
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 newline. 

NameAPTS_NoNameFieldObjects
ValueXML
Code<Object API name>

APTS_Password

The APTS_Password property enables you to create a password to protect Microsoft Word agreements generated by the application. It also allows the application to password-protect generated Microsoft Word documents. 

NameAPTS_Password
Value<password>
CodeN/A

APTS_ProfilePermissions

The APTS_ProfilePermissions property defines custom permissions for user profiles.

NameAPTS_ProfilePermissions
ValueJSON
CodeYou must define the access details in this field. For more information, see Assigning Custom Permissions to User Profiles.

APTS_Protection

The APTS_Protection property specifies whether protection for Microsoft Word agreements generated by the application shall be on or off. This allows the application to specify protection for generated MS Word documents. You must configure this property before configuring the Agreement Protection tab. 

NameAPTS_Protection
Value
  • 1: Turn document protection on.
  • 0: Turn document protection off.
CodeN/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. 

NameAPTS_RecordTypeUpdateOnAmend
Value

Semicolon-separated record type names or all

Sample Value: NDA;SLA;msa

CodeN/A

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_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 retains the imported document's name. For more information, see Sending an Agreement Document for Parallel Review.

NameAPTS_RetainFileNameForParallelReviewMergedDocument
ValueTrue
CodeN/A

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.

NameAPTS_SkipEmailTemplateSelection
ValueTrue
CodeN/A

APTS_SkipFileSplitWhileSavingFile

If you are upgrading CLM to Spring '21 or a later version and must migrate larger-than-10 MB attachments to files, set this property to true. 

Caution

After migration, set this property to false.

NameAPTS_SkipFileSplitWhileSavingFile
ValueTrue
CodeN/A

APTS_SkipContentSearchForActivation

Prerequisite: The Enable File comply system property is enabled. 

When this value is set to True, the Enable Content Search step is skipped during activation. To use the APTS_SkipContentSearchForActivation property, the value of APTS_AutoContentSearchable must be False. For more information, see Activating an Agreement.

NameAPTS_SkipContentSearchForActivation
ValueFalse
CodeN/A

APTS_SkipRemoveDraftDocumentOnActivation

Prerequisite: The Enable File comply system property is enabled.

When this value is True, the Remove Draft Document step is skipped during activation. To use the APTS_SkipRemoveDraftDocumentOnActivation property, the value of APTS_AutoContentSearchable must be False. For more information, see Activating an Agreement.

NameAPTS_SkipRemoveDraftDocumentOnActivation
ValueFalse
CodeN/A

APTS_SuppressAutoReviewEmails

When the value of the property is true, you are 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.

NameAPTS_SuppressAutoReviewEmails
ValueTrue
CodeN/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 previewing, generating, or regenerating documents, or generating supporting documents. The help text is displayed above the Template Selection section. For more information, see Generating an Agreement.

NameAPTS_TemplateSelectionGuidance
ValueN/A
CodeSample code: Please select an appropriate template.

APTS_TranslatePickValuesInDocs

When you set the APTS_TranslatePickValuesInDocs admin entry to True, the field value is added in the generated document. If a conditional segment is set, the condition takes both API and values. You can use either 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 is added to the generated document by default.

NameAPTS_TranslatePickValuesInDocs
ValueTrue
CodeN/A

APTS_UIPageConfig

The APTS_UIPageConfig property indicates the Visualforce page to publish to. The integration module provides the Visualforce page Apttus_Content__PublishContent.

NameAPTS_UIPageConfig
ValueXML
Code

Sample Code:

<UIPageConfig>
<UIAction name="publish_document">
<CustomPage> <Name>Apttus__PublishDocument</Name>
</CustomPage>
</UIAction><UIAction name="publish_content">
<CustomPage>
<Name>Apttus_Content__PublishContent</Name>
</CustomPage>
</UIAction>
<UIAction name="publish_chatter">
<CustomPage> <Name>Apttus__PublishChatter</Name>
</CustomPage>
<UIAction name="review_offlinedocument">
<CustomPage> <Name>Apttus__ReviewOfflineDocumentLightning</Name>
</CustomPage>
</UIAction>
</UIPageConfig>

APTS_UseWizardServer

Apttus merge web service endpoint. For more information, see Contract Wizard in Classic.

NameAPTS_UseWizardServer
ValueTrue
CodeN/A

APTS_UseWorkflow

The APTS_UseWorkflow property disables 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 are redundant or are taken care of by a different workflow process. In such cases, the default behavior of the system must be modified to ensure those tasks are not created. For more information, see Managing Workflow.

NameAPTS_UseWorkflow
ValueTrue
CodeN/A

APTS_WizardPersistHiddenValue

When you set APTS_WizardPersistHiddenValue to True and 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.

NameAPTS_WizardPersistHiddenValue
ValueFalse
CodeN/A

APTS_XAAddInLoadType

The APTS_XAAddInLoadType property defines 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 the Windows and Mac operating systems. 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 cannot install the X-Author for Contracts 2.0 add-in using Centralized Deployment in Office 365, 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. 

NameAPTS_XAAddInLoadType
Value

Default value: centralized

Supported values: centralized, sideloading, appsource

CodeN/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.

NameAPTS_RLPInstanceSettings
ValueN/A
Code

Sample code:

{
   "fwd_sync_url" :"https://xxx.congacloud.io",
   "organization-id":"5ba45b1e-2264-4063-be5f-xxxxxxxxxxx",
   "organization-fid":"datatenant-clmst1-5ba86b1e-2268-4062-be9f-xxxxxxxxx",
   "user-id":"9743f384-c18c-4455-bfaa-xxxxxxxxxx"
   }

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

ValueTrue
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

ValueN/A
Code

Sample code:

Account, Opportunity, Apttus__Template__c

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:

  1. Go to Setup > Object Manager.
  2. Select an object that you need to configure.
  3. Click Triggers > New.
  4. In the Apex Trigger window, select the Is Active checkbox.
  5. 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

ValueN/A
Code

Sample code:

Account, Opportunity, Apttus__Template__c