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

Debugging Test Cases

Opening a test case for debug

In order to debug a test case, proceed as follows:

How-To:

  • [In the menu toolbar]
    • Click on the step “Debug”
  • [In the explorer]
    • Open the test case by clicking on its description
      • The test case opens up for inspection

Debugging all CPE after the execution of an action

Whenever, during configuration, an unexpected behavior arrives, it can sometimes be tough to find out “what happened”. The step “Debug” will allow you to trace the messages logged on the server, but more importantly, it will log all CPE which have been loaded at a certain time.

In order to debug a single action, proceed as follows

How-To:

  • [In the test case]
    • Select the line corresponding to the action to be inspected
  • [In the test case]
    • Click once on the “status” icon
      • The “status” icon changes from “inactive” to “breakpoint”
      • Simultaneously, the “view Session Information” checkbox has been ticked automatically
  • [In the test case]
    • (Optionally) Tick the “Log information” checkbox if you want to log messages coming from the server
  • [In the menu toolbar]
    • Execute the “Inspect Test Case” function
      • The previously recorded configuration now runs in the background (without user interface or interaction) by executing the test case actions one at a time.
      • The configuration stops running when reaching the breakpoint
  • [In the menu toolbar]
    • Execute the “Inspect Action” function
      • The configuration will now run a single action (the one corresponding to the breakpoint)
      • The “view Session Information” link becomes active
      • The “view Log Information” link becomes active (if requested)
      • The status becomes either “breakpoint completed” or “breakpoint failed” depending on the outcome of the action
  • [In the test case]
    • In order to browse all loaded CPE along with their value and/or domain, click on the "view Session Information" link
      • The test case table is replaced by a CPE inspector which allows you to search CPE and see if these (1) are empty or (2) have a domain or (3) have a value.
Tip: To filter on CPE, either type precisely the complete expression or enter only parts of the expression with a ‘’ character to perform a “like” search. For instance, filtering on Configurable Products in any workspace could done with the following search string: */CP/

When running an inspection, the status icon can be different, depending on the state:

ICONMEANING
Action not executed (yet)
Action not executed, with breakpoint positioned on it.
Action executed correctly (without errors/failures)
Action executed with errors/failures
Action correctly executed, with breakpoint positioned on it
ICONMEANING
Action executed with errors/failures, with breakpoint positioned on it
Action currently being executed

In order to use the CPE inspector, proceed as follows:

How-To:

  • [In the CPE inspector]
    • In the “CPE” column heading, enter a CPE or a part of a CPE
      • The CPE inspector is now filtered
  • [In the CPE inspector] Inspect the domains & values:
    • If a value is available, it will be shown
    • If no value is available, the cell is empty
      • If a domain is available (regardless of whether there is a value), the cell will be blue. In this case, a simple click on the cell will show the domain.
  • [In the menu toolbar]
    • (Optionally) Execute the “back to inspection” function to return to the test case

Inspecting the CPE differences between actions

To inspect the differences between 2 or more actions, proceed as follows:

How-To:

  • [In the test case]
    • Look up both lines corresponding to the actions to be inspected
  • [In the test case]
    • For each line, click once on the “status” icon  The “status” icon changes from “inactive” to “breakpoint”
      • Simultaneously, the “view Session Information” checkbox has been ticked automatically
  • [In the test case]
    • (Optionally) For each line, tick the “Log information” checkbox if you want to log messages coming from the server
  • [In the menu toolbar]
    • Execute the “Inspect Test Case” function
    • The previously recorded configuration now runs in the background (without user interface or interaction) by executing the test case actions one at a time.
    • The configuration stops running when reaching the first breakpoint
  • [In the menu toolbar]
    • Execute the “Inspect Test Case” function again
    • The configuration will now run all actions until the next breakpoint)
    • The “view Session Information” link becomes active for the first breakpoint
    • The “view Log Information” link becomes active (if requested) for the first breakpoint
    • The status of the first breakpoint becomes either “breakpoint completed” or “breakpoint failed” depending on the outcome of the action (alternatively, execute the “Continue Inspection” function until the next breakpoint has been reached)
  • [In the menu toolbar]
    • Execute the “Continue Inspection” function
    • The configuration will now run the action corresponding to the second breakpoint
    • The “view Session Information” link becomes active for the second breakpoint
    • The “view Log Information” link becomes active (if requested) for the second breakpoint
    • The status of the second breakpoint becomes either "breakpoint completed" or "breakpoint failed" depending on the outcome of the action
    • [In the test case]
      • In order to see the messages issued by the server, click on the "view Log Information" link
        • A popup shows the server messages
    • [In the test case]In order to browse all CPE for both sessions,
      • Select each line marked by a breakpoint
      • [In the menu toolbar] Execute the "Add to compare" function
      • [In the menu toolbar] Execute the "Compare Now" function
        • The test case table is replaced by a CPE inspector which shows all CPE in both sessions.

In order to use the CPE inspector to show the differences, proceed as follows:

How-To:

  • [In the CPE inspector]
    • In the “CPE” column heading, enter a CPE or a part of a CPE
      • The CPE inspector is now filtered
  • [In the menu toolbar]

    Execute the “Show only Differences” function

    • The CPE inspector is now filtered and only shows CPE which:
      • Exist in one session but not in the other
      • Have a different domain/value between 2 sessions
  • [In the CPE inspector] Inspect the domains & values:
    • If a value is available, it will be shown
    • If no value is available, the cell is empty
    • If a domain is available (regardless of whether there is a value), the cell will be blue. In this case, a simple click on the cell will show the domain.
  • [In the menu toolbar]

    (Optionally) Execute the “Back to Inspection” function to return to the test case

Using the CPE inspector to add assertions

The CPE inspector is a very practical tool to add assertions to the test case, because the CPE are already available along with the right value(s)/domain. Once the CPE inspector is open, proceed as follows to add an assertion to the test case:

How-To:

  • [In the CPE inspector]
    • Select the line corresponding to the CPE/domain/value which you would like to verify during test run
  • [In the menu toolbar]
    • Execute the “Add as Value Assertion” function in order to verify a specific value during test run, or
    • Execute the “Add as Domain Assertion” function in order to verify a specific domain during test run
  • [In the menu toolbar]
    • Execute the “Back to Inspection” function in order to return to the test case
      • The assertion has been added right below the line which has been inspected.