Download PDF
Download page Configuring APTS_ComplyConfig.
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.
Configuring clone, amend, and renew specifications indicate which custom objects need to be cloned as part of the agreement clone, amend, and renew operation. You can create specifications according to your requirement. Following are the sample specifications:
- Clone: APTS_ComplyConfig_Clone
- Amend: APTS_ComplyConfig_Amend
- Renew: APTS_ComplyConfig_Renew
If all the specifications are deleted or no specifications are configured, then all the field values are cloned when you clone, amend or renew an agreement. When the default APTS_ComplyConfig specification is configured and separate clone, amend, or renew specifications are not available, the default specification will apply when you clone, amend, and renew an agreement.
You can add Document Version Detail, Document Version, Note, and Attachment in the clone spec 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 Version | Document Version Detail | Note | Attachment/Files | Documents copied to the cloned, amended, and renewed agreement (new agreement) |
---|---|---|---|---|
True | True | True/False | True/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. Conga recommends using this configuration. |
False | False | True/False | True/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. |
True | False | True/False | True/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. Conga does not recommend this configuration. |
- Click () and click Admin.
- From the Recent Admin relation list, select APTS_ComplyConfig. Optionally, if the property is not listed on the page, click Go and then select APTS_ComplyConfig.
Click Edit and between the<ComplyConfig><AgreementSpec><CloneSpec> </CloneSpec></AgreementSpec></ComplyConfig>tags, enter the new<ClearFields>tags and then enter the API name for each agreement field that you want to clear.
<ClearFields> <ClearField> <Name>Apttus__Company_Signed_By__c</Name> </ClearField> <ClearField> <Name>Apttus__Company_Signed_Date__c</Name> </ClearField> </ClearFields>
CODEThe above code snippet example, the Company Signed By and Company Signed Date fields are be cleared from the Agreement record when you clone any agreement
You can add various items that can be configured in the XML.
<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>
CODE- Add all the required fields and click Save.
A full list of fields to be cleared is included in APTS_Config.
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>
- Navigate to Admin Home page. This displays the Admin tab with a list of all out-of-the-box Admin entries.
- 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.
- Specify XML in the Value.
- Enter the sort specification in the Code field.
- Click Save.
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:
- Navigate to Admin Home page.
- Click New. This displays Admin Edit page.
- Enter the following details:
- Name: APTS_ComplyConfig_<Action>_<RecordType>
Sample value: APTS_ComplyConfig_Renew_MSA
Ensure that you create a single clone specification for each record type. - Value: XML
- Code: Enter clone specification
- Name: APTS_ComplyConfig_<Action>_<RecordType>
- Click Save.