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.

Creating Environment

To get started with Test Author, you must first create an environment record with details of the environment where you want to point and test your APIs.
  1. On the Test Author home page, do one of the following:
    • Click Environment in the right pane. Click Create Environment.
    • Go to Design > Environment in the left pane. Click Create Environment.
  2. In the Create Environment panel, enter the below information. Note that the fields with an asterisk are mandatory.

    Field

    Description

    *Environment Name

    Enter a unique name for the environment.

    Description

    Enter a description of the environment.

    Active

    Toggle to switch on or off. An environment must be in an Active or On state to generate the access token and to run API templates, test steps, test cases, or test suites.

    Organization ID

    Enter the organization ID.

    Organization Fid

    Enter the organization's friendly ID.

    Organization Name

    Enter the name of the organization.

    *Authentication Endpoint

    Enter the authentication endpoint. Only HTTPS and authorized Conga Cloud domain paths are accepted.

    *Application Base URL

    Enter the application base URL. Only HTTPS and authorized Conga Cloud domain URLs are accepted.

    Add More Base URL (Optional)

    Select from the following to add an additional base URL. Add these URLs if you intend to use APIs of the following Conga products.
    • CoreApps Base URL: For Sign and Composer
    • XAuthor Base URL: For XAuthor
    • CCI Base URL: For Conga Contract Intelligence

    Test User Information

    Enter the key and value (user record ID). At least one key and ID are mandatory. You can enter additional keys as required.

    Environment Variables

    Add environment variables that store values and can be used as test data for APIs. To create such variables, enter the following values for each variable:
    • Name
    • Value Type: Select from String, Number, Boolean, JSON, and null.
    • Value
    • Function: Use this to append dynamic values to the variable at runtime. Following are the options for values when you select String or Number:
      • none
      • StringEpochToDate
      • generateRandomNumber
      • generateRandomNumberOfLength
      • getCurrentDate
      • getFormattedCurrentDate
      • generateUUID
      • useEmptyString
      • getFutureDate
      • getFormattedFutureDate
    Note:

    When you select getFutureDate or getFormattedFutureDate then you must enter a value in the Value field.

    generateRandomNumber appends 13 random digits generated to the value. Whereas when you select generateRandomNumberOfLength you can decide the number of random digits between 1 and 13 to be generated. The default value is 5.

    For non-Conga API, enter a name, select the Value Type as String, and enter the URL in the Value field.

    To add multiple variables click the plus icon. Use the eraser icon to clear the data in the row and the trash bin icon to delete the row.

  3. Click Save.