Setting Up Conga Keys

Setup Conga Keys in your Salesforce org.

You must have Conga Composer version 8.186 (Quandary) or greater to use Conga Keys. The Conga Keys setup steps below are only required for Salesforce orgs with upgraded instances of Conga Composer. Salesforce orgs with new installations of Conga Composer do not need to complete any of the setup steps below.

To setup Conga Keys:

1. Add the Key field to the Conga Template, Conga Email Template, and Conga Query object Page Layouts.
   1. Navigate to Salesforce Setup.
   2. Select Object Manager under the Object and Fields section.
      • In Salesforce Classic, select Objects under the Create section.
   3. Click Conga Template.
   4. Click Page Layouts.
   5. Click Conga Template Layout.
   6. Select and drag the Key field onto the Information section of the Page Layout below.
   7. Click Save.
   8. Repeat steps c - g for the Conga Email Template and Conga Query objects.
2. Add the Enable Key Generation field to the Composer Setting Custom Metadata Type.
   1. Navigate to Salesforce Setup.
   2. Type in Custom Metadata in the Quick Find search box and click Custom Metadata Types.
   3. Click Composer Setting.
   4. Click the Expand Quick Access Menu arrow to expand the menu.
      ck2
   5. Click Edit Layout.
      
   6. Drag and Drop the Enable Key Generation field onto the Information section of the Page Layout below.

   7. Click Save.

      

      The Enable Key Generation checkbox field is checked by default.
3. Conduct record updates to existing Conga Template, Conga Email Template, and Conga Query records. Making edits to existing records automatically populates the Key field with a unique external Id. Use one of the following methods to trigger updates on existing Conga Template, Conga Email Template, and Conga Query records.
   • Edit any field on an existing record and save the changes. For example, double-click the Name field on a Conga Template to edit the field value and then click Save. No actual content editing of the field value is required. The save function triggers the Key field to automatically populate with a unique external Id. Repeat this step for each Conga Template, Conga Email Template, and Conga Query record you wish to use Conga Keys with.
   • Use and execute a SOQL Query in the Developer Console to make a mass edit on all Conga Template, Conga Email Template, and Conga Query records. No actual content edits to field values are made with this method, although it triggers the save function on each record and causes each record's Key field to automatically populate with an external Id.
4. Update Conga Solution records.

   • Click the Update Button button on each Conga Solution record. This automatically updates each parameter value that references a Conga Template, Conga Email Template, and Conga Query record Id to use the new Key field's external Id instead. Each record Id is replaced with an external Id.

     

     You must complete Step 3 prior to this step in order to populate the Key field for each Conga Template, Conga Email Template, and Conga Query record.
   • If you are not using the Solution Manager and created solutions manually in Salesforce Setup, manually swap each Conga Template, Conga Email Template, and Conga Query record Id referenced as a parameter value with the new corresponding external Id on the Key field.

After completing the setup for Conga Keys, all new Conga Template, Conga Email Template, and Conga Query records will auto-populate in external Ids in the Key field.