Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Show Page Sections

download

Overriding Base Clone Specifications

Configuring clone specification indicates which custom objects need to be cloned as part of the agreement clone operation.

Use the clone specifications to override the base configuration for cloning the agreement. The base clone specifications are defined in the APTS_ComplyConfig admin entry.

The APTS_ComplyConfig XML admin property is used to override base clone specifications for agreements. The base clone specification and the custom clone specification are merged in to a single clone specification to determine the objects to clone.



Overriding Clone Behavior of Custom Objects

By default, all custom objects related to an agreement are automatically cloned. If one or more custom objects are to be excluded, it can be accomplished by creating a custom clone specification listing the custom objects in the excludes element.

By default only the base objects listed in the includes element are cloned. If one or more base objects are to be included, it can be accomplished by creating a custom clone specification and listing the base objects in the includes element. If one or more base objects are to excluded, they can be listed in the excludes element, provided the base clone specification allows the override (or, the isOverridable property is set to true).

Configure Clone Specifications Based on Record Types

You can configure separate clone specifications for each record type. If there are no clone specifications configured for a record type the default setting (APTS_ComplyConfig) is selected during clone operation.

Clearing Cloned Agreement Field Values

You can configure the clone feature to automatically clear certain field values for the cloned agreement.When you clone an agreement and go to the Agreement Edit page, any fields that have been configured to be cleared will have their values removed. This eliminates the need to have to go through the edit page clearing values before you save the agreement. Clearing field values applies to all your agreements, regardless of their agreement type.

Tip: This property can be used when you renew an agreement and want to control the fields which should be excluded during the cloning process.

You must add code to APTS_ComplyConfig to indicate which fields you want to clear after cloning an agreement.

Configuring APTS_ComplyConfig

The APTS_ComplyConfig admin entry allows you to set up Clone Specification and Sort Specification.

  • Clone Specification: Allows you to configure the specifications for cloning, amending, or renewing an agreement record.
  • Sort Specification: Allows you to configure the specifications to arrange records in a specified order when generating an agreement document.

To configure APTS_ComplyConfig

The <CloneSpec> element in APTS_ComplyConfig XML code allows you to specify the custom objects that should be included as part of the agreement while cloning, renewing, and amending an agreement. You can also configure different specifications for each operation by creating separate admin entries with the following names:
  • Clone:APTS_ComplyConfig_Clone
  • Amend: APTS_ComplyConfig_Amend
  • Renew: APTS_ComplyConfig_Renew

If you have configured operation-specific APTS_ComplyConfig admin entries, they take precedence over the default APTS_ComplyConfig admin entry. If none of the admin entries are configured, all the field values are included in the new agreement when you clone, amend, or renew an agreement.

To configure clone specification, you need to insert the CloneSpec> element in ComplyConfig>AgreementSpec element in the XML code of the admin entry. Within this element, you can insert the following elements:
  • Includes element includes one or more ChildObject elements. Each ChildObject element represents an object to be inserted in the new agreement generated after cloning, renewing, and amending an agreement, identified by Name element
  • ClearFields element to specify the fields to be cleared from the new agreement generated after cloning, renewing, and amending an agreement
You can add Document Version Detail, Document Version, Note, and Attachment in the clone specification to copy documents to the cloned, amended, or renewed agreement (new agreement). The following table lists the various scenarios and their outcome when you use clone spec to clone, amend, or renew an agreement.
Document VersionDocument Version DetailNoteAttachment/FilesDocuments Copied to the cloned, amended, and renewed agreement(new agreement
TrueTrueTrue/FalseTrue/False
All the document details and documents from the document version are copied from Document Version and Document Version Detail to the new agreement.By default, Note and Attachment/Files are copied to the new agreement. If excluded, documents are not copied to the new agreement.
Note: Conga recommends using this configuration.
FalseFalseTrue/FalseTrue/False

No documents are copied from Document Version and Document Version Detail to the new agreement.

By default, Note and Attachment/Files are copied to the new agreement. If excluded, documents are not copied to the new agreement.

TrueFalseTrue/FalseTrue/False

Only the document details from the document version (the first level of the document version) are copied to the new agreement.

By default, Note and Attachment/Files are copied to the new agreement. If excluded, documents are not copied to the new agreement.No documents are copied from Document Version and Document Version Detail to the new agreement.
Note: Conga does not recommend this configuration.
  1. Click the App Launcher icon (.
  2. Search and select Admin.
  3. Search and open the APTS_ComplyConfig admin entry and click Edit. If the admin entry is not available, click New.
  4. Enter the Name.
    Sample value: APTS_ComplyConfig_Renew
  5. Specify XML in the Value field.
  6. Enter the clone specification in the Code field.


    The below code snippet is a sample of clone specifications:

    <ClearFields> <ComplyConfig> <AgreementSpec> <CloneSpec> <Includes> <ChildObject> <Name>Apttus__APTS_Agreement__c</Name> <IsOverridable>true</IsOverridable> </ChildObject> <ChildObject> <Name>Apttus__DocumentVersion__c</Name> <IsOverridable>true</IsOverridable> </ChildObject> <ChildObject> <Name>Apttus__DocumentVersionDetail__c</Name> <IsOverridable>true</IsOverridable> </ChildObject> <ChildObject> <Name>Apttus__AgreementLineItem__c</Name> <IsOverridable>true</IsOverridable> </ChildObject> <ChildObject> <Name>Note</Name> <IsOverridable>true</IsOverridable> </ChildObject> <ChildObject> <Name>Attachment</Name> <IsOverridable>true</IsOverridable> </ChildObject> </Includes> <ClearFields> <ClearField> <Name>Apttus__Special_Terms__c</Name> </ClearField> </ClearFields> </CloneSpec> </AgreementSpec> </ComplyConfig>
  7. Click Save.

To configure sort specification

The <SortSpec> element in APTS_ComplyConfig XML code allows you to configure the specifications to arrange records in a specified order while generating an agreement document.

To configure sort specification, you need to insert the <SortSpec> element between <ComplyConfig> <AgreementSpec> and <AgreementSpec> <ComplyConfig> elements in the XML code of the admin entry. Within this element, you can insert the following elements:
  • <SortObjects> element with one or more <SortObject > elements
  • <SortObject> element to specify the object to be sorted, identified by the <Name> element. For example, APTS_Agreement_Appendix_C
  • <SortFields> element with one or more <SortField> elements>
  • <SortField> element to specify fields for sorting, identified by the <Name> element. For example, Name.
  • <SortOrder> element to specify the sorting order. For example, ascending or descending
The code snippet below shows how to insert tags to sort the agreement line item based on the Name field of the APTS_Agreement_Appendix__c object when the users clone, renew, or amend an agreement. <ComplyConfig> <AgreementSpec> <ChildObject> <Name>Apttus__AgreementLineItem__c</Name> </ChildObject> <SortSpec> <SortObjects> <SortObject> <Name>APTS_Agreement_Appendix__c</Name> <SortFields> <SortField> <Name>Name</Name> </SortField> </SortFields> </SortObject> </SortObjects> </SortSpec> </AgreementSpec> </ComplyConfig>
To configure sort specification
  1. Navigate to Admin Home page. This displays the Admin tab with a list of all out-of-the-box Admin entries.
  2. Search and open the APTS_ComplyConfig admin entry and click Edit. If the admin entry is not available, click New and enter the Name as APTS_ComplyConfig.
  3. Specify XML in Value.
  4. Enter the sort specification in the Code field.
  5. Click Save field.

Configuring Clone Specifications Based on Record Types

You can configure separate clone specifications for each record type.

To configure clone specifications based on record types

  1. Navigate to Admin Home page.
  2. Click New. This displays Admin Edit page.
  3. Enter the following details:
    1. Name: APTS_ComplyConfig_<Action>_<RecordType>Sample value: APTS_ComplyConfig_Renew_MSAEnsure that you create a single clone specification for each record type.
    2. Value: XML
    3. Code: Enter clone specification
  4. Click Save.