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.

Use Case: Automate Test Case for CLM Flow

This use case automates the end to end flow for Contract Lifecycle Management (CLM), which is Account creation, Agreement creation, Contract creation, and then Cleanup.

Actor: Test Author User or QA Engineer

Objective: To automate a complete CLM flow in Test Author by creating reusable test resources and stitching them together into a test case that can be executed for validation and regression.

Scope: Test Author - Environment setup, Test Step creation, Test Case creation

Prerequisites:
  • User is logged into Test Author.
  • Necessary API templates exist (or are available for creation).
Post conditions:
  • A test case representing the CLM flow is created and saved.
  • Environment, test steps, and test case are configured and ready for execution.
CLM flow consists of
  1. Create Account
  2. Create Agreement
  3. Create Contract
  4. Delete Agreement
  5. Delete Account
Step 1: Create an Environment
  1. From the Test Author home page, navigate to Environment.
  2. Click Create Environment.
  3. Provide the required environment details such as Base URL, Client ID, Client Secret, Authentication tokens, etc.
  4. Save the environment.

The environment is required for executing API calls in test steps and test cases.

Step 2: Create or use existing API templates
  1. Navigate to API templates.
  2. Either use existing Conga API templates or create new templates for:
    • Account creation
    • Agreement creation
    • Contract creation
    • Agreement deletion
    • Account deletion

Templates define the request structure, method, headers, and parameters for each API operation.

Step 3: Create Test Steps
  1. Navigate to Test Step
  2. Create a test step for each action:
    • Create Account - Configure API template, map response to AccountID.
    • Create Agreement - Use AccountID from the previous step.
    • Create Contract - Use AgreementID from previous step, configure form-data payload if file upload is needed.
    • Delete Agreement - Use AgreementID.
    • Delete Account - User AccountID.
  3. Save each test step.
Step 4: Create a Test Case
  1. Click Test Case in the right pane, or go to Design > Test Case in the left pane.

  2. Click Create Test Case and enter the following details:
    • Enter ''CLM End-to-End Flow" in the Name field.
    • The Description and Category fields are optional.
  3. Click Add Test Steps and complete the following:
    • Select a service from the drop-down list.
    • Select a feature from the drop-down list and click Show Templates.
    • Select a previously created test step from teh list.
    • Repeat the above for all CML steps, that is from create account to delete account.
    • Ensure each step is Active.
  4. In the test case configuration panel, select the Environment created in Step 1.

    This ensures all test steps are execute against the correct endpoints and credentials.

  5. For each test step, configure the following:
    • Extract Variables: Map fields from API responses to variables (e.g. AccountID, AgreementID) for use in subsequent steps.
    • Use Variables: Pass extracted variables as inputs to subsequent test steps.
    • Add validations: For example: API response status codes (e.g., 200 OK), expected field values in the response, and success/failure messages.
  6. Add fluent waits for asynchronous operations (e.g., wait until Contract creation is complete before proceeding).

  7. Add descriptive notes for each test step for clarity and maintainability.

  8. Review configuration for sequence, variables, assertions, and environment, and save the test case.

    Active/Enabled flags plus configured variables, assertions, and fluent waits ensure precise execution and validation of the CLM flow.

The test case is ready for execution individually or as part of a test suite.