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

Salesforce Managed Package Configuration to Platform Preview

The Composer family of packages use out-of-the-box configured Salesforce managed packages. The following instructions are for modifying the existing managed packages to use backend services from non-Production environments. In following the steps outlined, your Composer for Salesforce users are able to test upcoming releases on the Conga Platform Preview environment, prior to their release to production environments.

Connected App & Canvas Configuration

Create a new Connected App corresponding to the Preview environment.

  1. In Salesforce Lightning Experience, search External Client Apps in the Quick Find box.
  2. Select External Client App Settings. Turn on Allow creation of connected apps.
  3. Click New Connected App.
  4. Fill out the Connected App with the following settings:
    1. Connected App Name: Conga Composer Preview. The API name will autofill as Conga_Composer_Preview.
      Note: The API name field must exactly match with the Connected App Name field from the Environment Configuration. Connected App Name and API Name are both case sensitive.
    2. Contact Email: Your contact email associated with your Org.
    3. Enable Oauth Settings: True
    4. Callback URL: https://{hostname}/c8/oauthProxy.aspx
    5. Selected OAuth Scopes:
      1. Access custom permissions (custom_permissions)
      2. Access the identity URL service (id, profile, email, address, phone)
      3. Access unique user identifiers (openid)
      4. Manage user data via APIs (api)
      5. Manage user data via Web browsers (web)
      6. Perform requests at any time (refresh_token, offline_access)
    6. Require Secret for Web Server Flow: True
    7. Canvas: True
    8. Canvas App URL: https://{hostname}/c8/oauthProxy.aspx
    9. Access Method: Signed Request (POST)
    10. Locations: Layouts and Mobile Cards, Lightning Component, Publisher, Visualforce Page.
    11. Hide Publisher Header: True
    12. Hide Publisher Share Button: True.
  5. Click Save.
    Below is an example of a Connected App for the NA_Preview region:


  6. Once the Connected App is saved, click Edit.
  7. Change the Permitted Users drop-down to "All users may self authorize."
  8. Change the IP Relaxation drop-down to "Relax IP restrictions."

Remote Site Settings

To use the Lightning Component, add the Remote Site corresponding to the back-end services.

  1. Open the Remote Site Settings page in Setup.
  2. Click New Remote Site.
  3. Fill out the form with the following values:

    Remote Site Name: CongaComposer8_Preview

    Remote Site URL: https://rlspreview-composer.congacloud.com

  4. Click Save.

Custom Metadata Configuration

Managed packages use the production backend for their environment. Below are the steps to create a different environment. Creating a new Region/Environment is a one-time step per region per environment, while selecting a different region can be done as many times as needed.

Create a new Region/Environment

For Composer, ensure the Connected App Names are aligned with the Hostname. For example,

Hostname: rlspreview-composer.congacloud.com

Connected App Name: Conga_Composer_RlsPreview

  1. In Setup, open Custom Metadata Types.
  2. Click Manage Records for the Connected App Setting.
  3. Click New and enter the following values:
    Preview Composer (NA)
    LabelNA Preview
    Conga App Setting NameNA_Preview
    Connected App NameConga_Composer_Preview
    Hostnamepreview-composer.congamerge.com
    Connected App Name (Platform)Conga_Composer_Preview_Platform
    Hostname (Platform)rlspreview-composer.congacloud.com
    Connected App Name SF1Conga_Composer_SF1_Preview
    Preview Composer (EU)
    LabelEU Preview
    Conga App Setting NameEU_Preview
    Connected App NameConga_Composer_Eupreview
    Hostnameeu-preview-composer.congamerge.com
    Connected App Name (Platform)Conga_Composer_Eupreview_Platform
    Hostname (Platform)rlspreview-composer.congacloud.eu
    Connected App Name SF1Conga_Composer_SF1_Eupreview
    Preview Composer (AP)
    LabelAP Preview
    Conga App Setting NameAP_Preview
    Connected App NameConga_Composer_Appreview
    Hostnameap-preview-composer.congamerge.com
    Connected App Name (Platform)Conga_Composer_Appreview_Platform
    Hostname (Platform)rlspreview-composer.congacloud.au
    Connected App Name SF1Conga_Composer_SF1_Appreview
  4. Click Save.

Create a new Region for Trigger

To display the correct environment on the Trigger Dashboard:

Create Trigger Regions
  1. Navigate to Setup > Custom Metadata Types > Conga Trigger Region > Manage Conga Trigger Regions. Click New.

    1. Input the appropriate region name:
      RegionHostname - Trigger
      North America (NA)preview-workflow.congamerge.com
      Europe (EU)eu-preview-workflow.congamerge.com
      Asia Pacific (AP)ap-appreview-workflow.congamerge.com
  2. Navigate to Setup > Custom Metadata Types > Conga Trigger Settings > Manage Conga Trigger Settings. Click Edit, and then select the new region you've created for the Conga Trigger Region field.

  3. Navigate to Setup > Outbound Messages and update the endpoint URL to the correct preview hostname, as listed in the table above. Example:

    https://preview-workflow.congamerge.com/OBMListener.ashx

Create a new Region for Batch

Steps to configure the preview region for Batch:

  1. Navigate to Setup > Custom Metadata Types > Conga Batch Region > Manage Conga Batch Regions. Click New.

    1. Input the appropriate Batch region:
      RegionHostname - Batch
      North America (NA)preview-conductor.congamerge.com
      Europe (EU)eu-preview-conductor.congamerge.com
      Asia Pacific (AP)ap-preview-conductor.congamerge.com
  2. Go to Setup > Custom Metadata Types > Conga Batch Settings > Manage Conga Batch Settings. Click Edit, then select the newly created region for the Conga Batch Region field.

  3. On the Batch record, use the standard Launch and Schedule buttons to run the Preview environment. Do not use the Launch C8 or Schedule C8.

    1. Launch/Schedule buttons respect your Custom Metadata Type configurations.

    2. Launch C8/Schedule C8 buttons cannot point to Preview at this time.

Select Preview Region/Environment

  1. In Setup, open Custom Metadata Types.
  2. Click Manage Records for Composer Setting.
  3. Click Edit.
  4. Click the search icon to open a popup. Click Clear Search Results to see a full list of regions and environments.
  5. Select NA Preview and click Save.