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.

Managing the Extract Variable Panel

For a selected test step, you can use this panel to select the variable whose value you want to extract and use in the next test step. The variable can be a JSON value or a file. When the variable type is FILE, you must associate the file with a service, which is then saved in File Store under the selected service. The file is appended with a unique random number to ensure there are no duplicate files. You can search for the file in File Store using the variable name. To delete the downloaded file in File Store, use the delete Conga API template in the test case.

In the extracted variable table use the ellipses to edit, delete, or view the details. For Static type, if you are not extracting a substring, then the detailed view is not shown, instead an error message is displayed.

When the extraction variable is a string, you can extract a substring from it. You must provide the "Start After" value, however "End Before" is not required.

For example, if the extracted string is "ef5b7ed6-12b2-43b2-90ba-cb35753f989e" but you want the substring to be "-12b2-43b2-90ba-". Enter ef5b7ed6 in Start After and cb35753f989e in End Before.

Similarly you can provide data in Start After and leave End Before blank if the substring required is "-12b2-43b2-90ba-cb35753f989e".

  1. Click on the gear icon () in the Extract Variable column for a test step.
  2. Click Fetch Response Body to fetch the response body and to enable the gear icon next to the Json Path, Final Extraction Key and Key fields.
  3. Enter a variable name.
  4. Select a type, Static or RelativeJSON, from the Type drop-down.
  5. For Static type, click on the gear icon next to Json Path field. Hover and click the plus () icon to extract the JSON values. Or you can manually enter the JSON path. Go to step 13.
  6. For RelativeJSON type, toggle the Is Final Key Extraction Required if Final Extraction Key value is to be extracted.
  7. In the Final Extraction Key, click the gear icon, hover and click the plus icon to extract the JSON value, or enter the value manually.
  8. Enter the path name manually or click the gear icon (not mandatory), then hover and click the plus icon in the Response Body to use Jsonpath for the path name.
  9. Enter the key manually or click the gear icon, then hover and click the plus icon in the Response Body to use Jsonpath in the key.
  10. Select Extraction Variable source from the drop-down in the Source field.
  11. Enter a value or select the value from drop-down list based on Source selected.
  12. Click the plus icon to add another row. You can add multiple rows to traverse the nested JSON and retrieve the Final Extraction Key.
  13. Toggle Do you want to manipulate Extracted Value? if you want to extract a substring from the response.
  14. The default selection in Method field is substring.
  15. Enter the Start After string and the End Before string.
  16. Click Add to add the extraction variables and click Save when done.
  17. Complete above steps for each test step.
  18. Click Save.