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

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.

Field

Description

SPAClientId

A single-page application ID. Enter the SPAClientId that you generated after configuring the .

OrganizationId (optional)

Enter the Salesforce Organization ID that you captured after tenant onboarding. To view the organization ID, see the "To capture Conga Organization Display Name and Organization ID" section in Tenant Onboarding.

OrganizationFId (optional)

Your Salesforce organization's friendly ID. Friendly ID is formatted as <Conga org display name-org Id>. For more information, see the "To capture Conga Organization Display Name and Organization ID" section in Tenant Onboarding.

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:

UIInstanceURL

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

UpsertQuotesEndpointURL

The upsert quotes URL.

MyApprovalsPageURL
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"

LoginURL

Your Conga Platform login URL.

CollaborationRequestURL

prod-rls10.congacloud.com/api/cart/v1/carts/collaboration-request

Forward-SyncURL

https://prod-rls10.congacloud.com/api/datasync/v1/forward-sync

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.

XAEndpoint

For production: https://xauthor-prod-rls10.congacloud.com

For preview environment:

For staging environment: https://xauthor-stg.congacloud.io

SignEndpoint

https://coreapps-rlspreview.congacloud.com

ComposerEndpoint

https://coreapps-rlspreview.congacloud.com

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. Below is an example of a code whose values are specific to the connected/preview environment.

    {
    "SPAClientId": "technicalpublicationteam-spa",
    "OrganizationId": "c7552ce4-a380-45b0-9c8a-022d2eafa7df",
    "OrganizationFId": "auert00000004wfoai-c7552ce4-a380-45b0-9c8a-022d2eafa7df",
    "UserId": "769d5e44-ef45-cb0d-dd3c-1f046feded1c",
    "InstanceURL": "https://preview-rls09.congacloud.com",
    "UIInstanceURL": "https://preview-rls09.congacloud.com/ecpqui",
    "UpsertQuotesEndpointURL": "https://preview-rls09.congacloud.com/api/quote/v1/quotes/upsert-quote",
    "LoginURL": "https://login-rlspreview.congacloud.com",
    "XAEndpoint": "https://xauthor-stg.congacloud.io",
    "SignEndpoint": "https://coreapps-rlspreview.congacloud.com",
    "ComposerEndpoint": "https://coreapps-rlspreview.congacloud.com"
    }
  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.