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

Creating a New Admin Setting

Admin Settings are system properties that have different values, and you can use them for different purposes. You must configure admin settings to meet the business objectives of your implementation along with Custom Settings.

The APTS_RLPInstanceSettings custom setting in Salesforce is used to define environment-specific URLs required for integrating with Conga services on Conga Advantage Platform. This configuration ensures that Salesforce connects to the correct endpoints based on the deployment region such as North America (NA), Australia (AU), or the European Union (EU). Refer to the Region Specific Admin Entry Valuestopic for detailed admin setting values.

Following are the required values to enter in the admin setting.

Field

Description

SPAClientId

A single-page application ID. Enter the SPAClientId that you generated after configuring the UI to API configuration.

UserId (optional)

Enter the user ID that is created on the Conga Platform. To view the user ID on the Conga Platform, log in to Conga Platform as administrator, then go to Admin Console > Users > Click on the desired username.

InstanceURL

Conga organization instance URL. Use any of the following URLs per your Conga instance:

For production instance:

For Preview instance:

UIInstanceURL

Conga Organization UI instance URL. Use any of the following URLs per your Conga instance:

For production instance:

  • NA, EU, and AU regions: https://<instanceURL>/ecpqui

For preview instance:

  • NA, EU, and AU regions: https://<instanceURL>/ecpqui

UpsertQuotesEndpointURL

The upsert quotes URL.

For production instance:

  • NA, EU, and AU regions: https://<instanceURL>/api/quote/v1/quotes/upsert-quote

For preview instance:

  • NA, EU, and AU regions: https://<instanceURL>/api/quote/v1/quotes/upsert-quote
MyApprovalsPageURL For production instance:
  • NA, EU, and AU regions: https://<instanceURL>/approvals/my-approvals/

For preview instance:

  • NA, EU, and AU regions: https://<instanceURL>/approvals/my-approvals/
Note:

Hide Conga OneShell Navigation in Approvals UI

You can hide the Conga OneShell top page header and global navigation in the Approvals for Advantage Platform UI when accessing it from the Conga CPQ on Salesforce.

To do this, add the query string parameter hideNav=true to the Approvals endpoint URL in the ATPS_RLPInstanceSettings admin setting.

Example:"MyApprovalsPageURL": "https://<domain name>/approvals/my-approvals/?hideNav=true"

ApprovalCenterPageURL

For production instance:

  • NA, EU, and AU regions: https://<instanceURL>/approvals/my-approvals/approval-center

For preview instance:

  • NA, EU, and AU regions: https://<instanceURL>/approvals/my-approvals/approval-center

Add the query parameter hideNav=true to the endpoint URL to open the Approval Center without navigation headers. For example: https://<domain name>/approvals/approval-center?hideNav=true

LoginURL

Your Conga Platform login URL.

  • For Production instance:
    • NA: https://login-rls.congacloud.com
    • EU: https://login.congacloud.eu
    • AU: https://login.congacloud.au
  • For preview instance:
    • NA: https://login-rlspreview.congacloud.com/
    • EU: https://login-preview.congacloud.eu
    • AU: https://login-preview.congacloud.au

CollaborationRequestURL

Production:

NA, EU, and AU regions: https://<instanceURL>/api/cart/v1/carts/collaboration-request

Preview:

NA, EU, and AU regions: https://<instanceURL>/api/cart/v1/carts/collaboration-request

Forward-SyncURL

Production:

NA, EU, and AU regions: https://<instanceURL>/api/datasync/v1/forward-sync

Preview:

NA, EU, and AU regions: https://<instanceURL>/api/datasync/v1/forward-sync

AcceptQuoteEndpointURL

Enter this URL to create custom accept quote button in the Salesforce to accept the quote in the Conga Advantage Platform.

Production:

NA, EU, and AU regions: https://<instanceURL>/api/datasync/v1/forward-sync

Preview:

NA, EU, and AU regions: https://<instanceURL>/api/datasync/v1/forward-sync

ActivateOrderEndpointURL

Production:

NA, EU, and AU regions: https://<instanceURL>/api/order/v1/orders/{order-id}/activate

Preview:

NA, EU, and AU regions: https://<instanceURL>/api/order/v1/orders/{order-id}/activate

Enter the following endpoints only when you use X-Author for Excel, Conga Sign, and Composer applications along with CPQ. These endpoints are specific to the connected environment. Reach out to the Conga CloudOps team for the endpoints.

CoreappsProduction:

NA: https://coreapps-rlsprod.congacloud.com

EU: https://coreapps.congacloud.eu

AU: https://coreapps.congacloud.au

Preview:

NA: https://coreapps-rlspreview.congacloud.com

EU: https://coreapps-preview.congacloud.eu

AU: https://coreapps-preview.congacloud.au

XAEndpoint

Production:

NA: https://xauthor-prod-rls10.congacloud.com

EU: https://xauthor.congacloud.eu

AU: https://xauthor.congacloud.au

Preview

NA: https://xauthor-prod-rls10.congacloud.com

EU: https://xauthor-preview.congacloud.eu

AU: https://xauthor-preview.congacloud.au

SignEndpoint

Production:

NA: https://coreapas-rls10.congacloud.com

EU: https://coreapps.congacloud.eu

AU: https://coreapps.congacloud.au

Preview

NA: https://coreapps-rlspreview.congacloud.com

EU: https://coreapps-preview.congacloud.eu

AU: https://coreapps-preview.congacloud.au

ComposerEndpoint

Production:

NA: https://coreapps-rls10.congacloud.com

EU: https://coreapps.congacloud.eu

AU: https://coreapps.congacloud.au

Preview

NA: https://coreapps-rlspreview.congacloud.com

EU: https://coreapps-preview.congacloud.eu

AU: https://coreapps-preview.congacloud.au

To use the Okta SSO for logging into the Salesforce, you must add the following along with previous values. The login URL and following admin key values are privided by the admin who configures the auth. provider. Admin must Admin must whitelist (Salesforce trusted urls, Salesforce trusted redirect urls) the auth provider url (Okta) and conga login url (https://login-rlsqa.congacloud.io)
AuthorizeEndpointURLAuthorization end point url of the tenant. For example, https://login-rlsqa.congacloud.io/api/v1/auth/External/Login/Challenge
IDPSchemeSamI2P
IDPEntityIDEnter the authentication provider name. This is provided by the admin who setup the auth. provider.http://www.okta.com/exklse92w4HEZEhmn5d7
UIDEnter the Platform user Id.

Configuring a New Admin Entry

  1. Click the App Launcher icon (), enter Admin, and select Admin.
  2. Click New.
  3. Enter the following details:

    Field

    Value

    Name

    APTS_RLPInstanceSettings

    Value

    Leave this field blank.

    Code

    Enter the code. Values in the below example code are sample values, these values varies from the region and instance you connected to.

    {
      "LoginURL": "https://login-rls.congacloud.com",
      "SPAClientId": "<b88b62c9-42db-XXXX-XXXX-561df285a2aa",
      "InstanceURL": "https://prod-rls10.congacloud.com",
      "UIInstanceURL": "https://<instanceURL>/ecpqui",
      "UpsertQuotesEndpointURL": "https://<instanceURL>/api/quote/v1/quotes/upsert-quote",
      "AcceptQuoteEndpointURL": "https://<instanceURL>/api/quote/v1/quotes/{quote-id}/accept",
      "ActivateOrderEndpointURL": "https://<instanceURL>/api/order/v1/orders/{order-id}/activate",
      "DataURL": "https://<instanceURL>/api/data/v1/objects/",
      "QuoteURL": "https://<instanceURL>/cpq/quotes/{quote-id}/",
      "CollaborationRequestURL": "https://<instanceURL>/api/cart/v1/carts/collaboration-request",
      "XAEndpoint": "https://xauthor-rls10.congacloud.com",
      "SignEndpoint": "https://coreapas-rls10.congacloud.com",
      "ComposerEndpoint": "https://coreapps-rls10.congacloud.com",
      "MyApprovalsPageURL": "https://<instanceURL>/approvals/my-approvals/?hideNav=true",
      "Forward-SyncURL": "htpps://<instanceURL>/api/datasync/v1/forward-sync"
    }
    
  4. Click Save. Your new admin setting is saved and added.

Create a new Auth. Provider

Admin Settings in CPQ

The following content provides information about various admin settings available in CPQ along with their values and purposes.

APTS_RLPInstanceSettings

Name

Enter APTS_RLPInstanceSettings.

Value

Leave this field blank.

Code

Enter the code. Below is an example of a code whose values are specific to the connected/preview environment.

{
"SPAClientId": "rls-qa-spa",
"InstanceURL": "https://rls-qa.congacloud.io",
"UIInstanceURL": "https://rls-qa.congacloud.io/ecpqui",
"UpsertQuotesEndpointURL": "https://rls-qa.congacloud.io/api/quote/v1/quotes/upsert-quote",
"AcceptQuoteEndpointURL" : "https://rls-qa.congacloud.io/api/quote/v1/quotes/{quote-id}/accept",
"ActivateOrderEndpointURL":"https://rls-qa.congacloud.io/api/order/v1/orders/{order-id}/activate",
"LoginURL": "https://login-rlsqa.congacloud.io",
"XAEndpoint": "https://xauthor-qa.congacloud.io",
"SignEndpoint": "https://coreapps-rlsqa.congacloud.io",
"ComposerEndpoint":"https://coreapps-rlsqa.congacloud.io",
"DataURL":"https://rls-qa.congacloud.io/api/data/v1/objects/",
"UserId":"58d19905-4191-4f3d-97e5-1e7106b9d73b",
"OrganizationId": "e9f1e432-9080-45f9-ab68-c33d36ce982c",
"OrganizationFId": "v2integration-e9f1e432-9080-45f9-ab68-c33d36ce982c",
"QuoteURL" : "https://rls-qa.congacloud.io/cpq/quotes/{quote-id}/"
}

APTS_RLPAutoSyncRenewalQuote

Name

Enter APTS_RLPAutoSyncRenewalQuote .

Value

Enter True or False.

Code

Leave this field blank.

Region Specific Admin Entry Values

Region Specific URL Configuration

This document describes configuration of region-specific URLs for the APTS_RLPInstanceSettings Admin setting across North America (NA), Australia (AU), and European Union (EU).

Use the following values to configure the APTS_RLPInstanceSettings for the production environment.
Admin Setting EntryDescription
SPAClientId

A single-page application ID. Enter the SPAClientId that you generated after configuring the UI to API configuration.

URLsURL for NA regionURL for AU regionURL for EU region
InstanceURLhttps://prod-rls10.congacloud.comhttps://rls.congacloud.auhttps://rls.congacloud.eu
UIInstanceURLhttps://<instanceURL>/ecpquihttps://<instanceURL>/ecpquihttps://<instanceURL>/ecpqui
UpsertQuotesEndpointURLhttps://<instanceURL>/api/quote/vi/quotes/upsert-quotehttps://<instanceURL>/api/quote/vi/quotes/upsert-quotehttps://<instanceURL>/api/quote/vi/quotes/upsert-quote
AcceptQuoteEndpointURLhttps://<instanceURL>/api/quote/v1/quotes/{quote-id}/accepthttps://<instanceURL>/api/quote/v1/quotes/{quote-id}/accepthttps://<instanceURL>/api/quote/v1/quotes/{quote-id}/accept
ActivateOrderEndpointURLhttps://<instanceURL>/api/order/v1/orders/{order-id}/activatehttps://<instanceURL>/api/order/v1/orders/{order-id}/activatehttps://<instanceURL>/api/order/v1/orders/{order-id}/activate
DataURLhttps://<instanceURL>/api/data/v1/objects/https://<instanceURL>/api/data/v1/objects/https://<instanceURL>/api/data/v1/objects/
QuoteURLhttps://<instanceURL>/cpq/quotes/{quote-id}/https://<instanceURL>/cpq/quotes/{quote-id}/https://<instanceURL>/cpq/quotes/{quote-id}/
CollaborationRequestURLhttps://<instanceURL>/api/cart/v1/carts/collaboration-requesthttps://<instanceURL>/api/cart/v1/carts/collaboration-requesthttps://<instanceURL>/api/cart/v1/carts/collaboration-request
LoginURLhttps://login-rls.congacloud.comhttps://login.congacloud.auhttps://login.congacloud.eu
Coreappshttps://coreapps-rlsprod.congacloud.comhttps://coreapps.congacloud.auhttps://coreapps.congacloud.eu
XAEndpointhttps://xauthor-prod-rls10.congacloud.comhttps://xauthor.congacloud.auhttps://xauthor.congacloud.eu
SignEndpointhttps://coreapas-rls10.congacloud.comhttps://coreapps.congacloud.auhttps://coreapps.congacloud.eu
ComposerEndpointhttps://coreapps-rls10.congacloud.comhttps://coreapps.congacloud.auhttps://coreapps.congacloud.eu
MyApprovalsPageURLhttps://<instanceURL>/approvals/my-approvals/?hideNav=truehttps://<instanceURL>/approvals/my-approvals/?hideNav=truehttps://<instanceURL>/approvals/my-approvals/?hideNav=true
Forward-SyncURLhttps://<instanceURL>/api/datasync/v1/forward-synchtpps://<instanceURL>/api/datasync/v1/forward-synchtpps://<instanceURL>/api/datasync/v1/forward-sync

Use the following values to configure the APTS_RLPInstanceSettings for the Preview environment.
Admin Setting EntriesDescription
SPAClientId

A single-page application ID. Enter the SPAClientId that you generated after configuring the UI to API configuration.

URLsURL for NA regionURL for AU regionURL for EU region
InstanceURLhttps://preview-rls09.congacloud.comhttps://rls-preview.congacloud.auhttps://rls-preview.congacloud.eu
UIInstanceURLhttps://<instanceURL>/ecpquihttps://<instanceURL>/ecpquihttps://<instanceURL>/ecpqui
UpsertQuotesEndpointURLhttps://<instanceURL>/api/quote/vi/quotes/upsert-quotehttps://<instanceURL>/api/quote/vi/quotes/upsert-quotehttps://<instanceURL>/api/quote/vi/quotes/upsert-quote
AcceptQuoteEndpointURLhttps://<instanceURL>/api/quote/v1/quotes/{quote-id}/accepthttps://<instanceURL>/api/quote/v1/quotes/{quote-id}/accepthttps://<instanceURL>/api/quote/v1/quotes/{quote-id}/accept
ActivateOrderEndpointURLhttps://<instanceURL>/api/order/v1/orders/{order-id}/activatehttps://<instanceURL>/api/order/v1/orders/{order-id}/activatehttps://<instanceURL>/api/order/v1/orders/{order-id}/activate
DataURLhttps://<instanceURL>/api/data/v1/objects/https://<instanceURL>/api/data/v1/objects/https://<instanceURL>/api/data/v1/objects/
QuoteURLhttps://<instanceURL>/cpq/quotes/{quote-id}/https://<instanceURL>/cpq/quotes/{quote-id}/https://<instanceURL>/cpq/quotes/{quote-id}/
CollaborationRequestURLhttps://<instanceURL>/api/cart/v1/carts/collaboration-requesthttps://<instanceURL>/api/cart/v1/carts/collaboration-requesthttps://<instanceURL>/api/cart/v1/carts/collaboration-request
LoginURLhttps://login-rlspreview.congacloud.comhttps://login-preview.congacloud.auhttps://login-preview.congacloud.eu
Coreappshttps://coreapps-rlspreview.congacloud.comhttps://coreapps-preview.congacloud.auhttps://coreapps-preview.congacloud.eu
XAEndpointhttps://xauthor-preview-rls09.congacloud.comhttps://xauthor-preview.congacloud.au https://xauthor-preview.congacloud.eu
SignEndpointhttps://coreapps-rlspreview.congacloud.comhttps://coreapps-preview.congacloud.auhttps://coreapps-preview.congacloud.eu
ComposerEndpointhttps://coreapps-rlspreview.congacloud.comhttps://coreapps-preview.congacloud.auhttps://coreapps-preview.congacloud.eu
MyApprovalsPageURLhttps://<instanceURL>/approvals/my-approvals/?hideNav=truehttps://<instanceURL>/approvals/my-approvals/?hideNav=truehttps://<instanceURL>/approvals/my-approvals/?hideNav=true
Forward-SyncURLhtpps://<instanceURL>/api/datasync/v1/forward-synchtpps://<instanceURL>/api/datasync/v1/forward-synchtpps://<instanceURL>/api/datasync/v1/forward-sync