This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Flow

Overview

A test flow is a sequence of scenarios that verifies the functionality or correctness of your business system. The Flow module allows you to manage all your test flows in a project. This includes defining Scenarios, choosing or creating the steps and assertions for each scenario, and modifying or running test flows.

View

In the upper left corner, select your project from the Select Project dropdown list and version from the Version dropdown list. Only the flows associated with the selected project and version are displayed on the left pane.

Edit a test flow

To view or modify the details of a flow, select the flow from the left pane that lists all flows associated with the selected project. You can change any detail by directly editing the corresponding field. Ensure to click Update after making your modifications.

Filter

The filter feature allows you to filter the list of test flows by providing a keyword or the full name of the flow. Only the flows that match the provided keyword or name will be displayed in the view.

Additionally, you can refine your search by clicking the icon. A Scenario filter is available, allowing you to select a scenario currently used in the flows within the selected project.

Create a test flow

To create a new test flow, follow these steps:

  1. Select the Project and the Version on the upper left dropdown lists. If there are existing test flows in the selected project and version, they will be displayed on the left pane.

  2. Click the plus icon.

  3. Enter a valid test flow title, replacing Untitled Test Flow.

  4. Click on the Untitled Scenario, which is automatically added when creating a new flow.

  5. Add your first scenario by selecting an existing scenario within your project in the Create/Select Scenario field in the Scenario Details section. You can also Create a new scenario.

    Note that if you are using an existing scenario, the steps, sources, targets, and assertions configured in that scenario for other flows will be included.

  6. Click Apply Scenario on the popup window.

  1. Verify that all the associated steps for the selected and applied scenario are displayed. You can also Create a step in the flow module.

  2. Optional. Add a source and target parameters to the steps.

  1. Optional. Select the assertion type you wish to add to the selected step.

  1. Optional. Search for the assertion you wish to add to the selected step.

  2. Optional. Click Apply Assertion on the popup window.

  3. Optional. Verify that the added assertion is displayed in the step details section.

  4. Click Save.

Modify a test flow

You can also modify the configuration of test flows that have already been added to a test suite.

You can change the execution order of test flows by using the drag-and-drop functionality.

You can also modify the the dataset associated with a test flow or configure multiple datasets for it even after it has been added to the test suite. For more information, see Edit a dataset.

Similarly, if you need to run the test flow in a different environment you can also modify the environment. For more information, see Modify a step in the Flow module

Run a test flow

To run the test flow, click the Run button to view the Run Setup Form. Configure the required parameters, then click the Run button.

A new browser tab displaying the Run Details page will open. For more information, see Results.

Import a test flow

The Flow module enables you to import existing flows by clicking the down arrow in the left menu and select Import.

Drag or browse the file to be imported. The only supported file type is .ta_export.

Export a test flow

To export a flow, hover over the flow you want to export. An icon will appear. Click on this icon and select Export.

A list of all items to be exported is displayed.

After confirming the list, TA begins the export process.

Once complete, the file is automatically downloaded to your machine.

Delete a test flow

To delete a flow, hover over the flow you want to remove. An icon will appear. Click on this icon and select Delete.

The flow will be deleted from the version, but the scenarios, steps, and assertions used in it will not be deleted.

1 - Scenarios

Overview

A scenario is a high-level description of what you are testing. It consists of Steps that break down the scenario further, and Assertions that serve as validation criteria. A scenario can only be considered a success if it meets the validation criteria. Otherwise, it will be tagged as failed.

Create a new scenario

To create a new scenario, follow these steps:

  1. Add a new scenario node.

  2. Enter a valid name of the new scenario in the Create/Select Scenario field.

  3. Optional. Add a description for your scenario.

To add steps and assertions to your scenario, see Create a Test Flow.

Rename a scenario

To rename a scenario, follow these steps:

  1. Select the scenario node.
  2. Enter a new name.
  3. Select Rename to <new name>.
  4. Click Rename on the popup window.

The scenario with a new name is displayed.

Clone a scenario

To clone a scenario, follow these steps:

  1. Select the scenario node.
  2. Enter a new name.
  3. Select Clone to <new name>.
  4. Click the Clone button.

The cloned scenario replaces the older scenario.

Delete a scenario

To delete a scenario, hover over the scenario you want to remove. An icon will appear. Click on this icon and select Delete.

A confirmation popup window will be displayed. Click the Remove node button.

Scenario usage

In the scenario usage tab, all the flows using the selected scenario node are displayed.

When the hyperlink is clicked, a new tab will open displaying the selected flow.

2 - Steps

Overview

The Flow modules allow you to use the steps defined in the Step module or add a new step to the project within the module.

Create a step in the Flow module

To create a new step in the Flow module, follow these steps:

  1. Click the scenario where you wish to create a step.

  2. Select the step type.

  1. Enter a valid values in the Create / Select Step, Step Description (optional), and Timeout fields.
  1. Add the necessary details by clicking the Details button. For more information, see:
  1. Optional. Enter valid values in the Source and Target fields. For more information, see Step sources and Step targets. You can also add new steps following the newly-created one.
  1. Click Save.

You can link steps to pass parameters to each other. However, you can only link steps that are part of the same scenario.

Step sources

The following are the possible sources for a step:

Source Description
Current step request payload Uses the value of a JSON node from the current request payload as a source for the selected step.
Current and previous step response payloads Uses the value of a JSON node from the previous and current response payload as a source for the selected step.
Previous variables Uses the value of a test flow variable defined in the step prior to the selected step.

Step targets

The following are the possible targets for a step:\

Target Description
Request body Uses the value of a JSON node from the current request payload as a target for the selected step.
Query params Assigns the value of the source to a query parameter defined within the selected step.
Path params Assigns the value of the source to a path parameter defined within the selected step.
New variable

Creates a new test flow variable as the target for the selected step.

The created variable can be used in succeeding steps or validations of the current step as a source.
Previous variables Uses a test flow variable defined prior to the selected step or scenario as a target.

Modify a step in the Flow module

To modify a step in the Flow module, follow these steps:

  1. Click the step type link on the upper-right corner of the step node.

  2. Click the edit icon.

  1. Make the necessary changes in the Edit Step window.

Rename a step

To rename a step, follow these steps:

  1. Select the step node.
  2. Enter a new name.
  3. Select Rename to <new name>.
  4. Click Rename on the popup window.

The step with a new name is displayed.

Clone a step

To clone a step, follow these steps:

  1. Select the step node.
  2. Enter a new name.
  3. Select Clone to <new name>.
  4. Click the Clone button.

The cloned step replaces the older step.

Delete a step

To delete a step, click the step type link on the upper right corner of the step box. More otions are displayed, click the Remove Step icon.

A confirmation popup window will be displayed. Click the Remove node button.

Steps usage

In the step usage tab, all the flows using the selected step node are displayed.

When the hyperlink is clicked, a new tab will open displaying the selected flow.

3 - Assertion

Overview

The Flow modules allow you to use the assertions defined in the Assertion module or add a new step to the project within the module.

Create an assertion in the Flow module

To create a new assertion in the Flow module, follow these steps:

  1. Select the assertion type you wish to add.
  1. Enter a valid name of the new assertion in the Create/Select Assertion field. You can also add a description to the Assertion Description (optional) field.

  1. Click the Details button.

  2. Add valid values to the necessary assertion parameters. For more information, see

- [Create a File assertion](../assertion.md#create-a-file-assertion) 
- [Create a File to File assertion](../assertion.md#create-a-file-to-file-assertion)-->

<figure><img class="lightbox-trigger" src="








/ta/3.x.x

/images/flow_assertion-create-4.png" alt=""><figcaption></figcaption></figure>

  1. Click the Save button.

  2. Verify that the newly created assertion is listed under the associated step.

Disable an assertion in the Flow module

In the Flow module, you can disable an assertion for a specific scenario, preventing it from executing during flow execution.

To disable an assertion, follow these steps:

  1. Click the more options icon beside the assertion you wish to disable.
  1. Click Disable for this test flow.

The disabled assertion will also be automatically be disabled in the associated dataset.

To enable it back, follow these steps:

  1. Click the more options icon beside the assertion you wish to enable.
  1. Click Enable for this flow.

The enabled assertion will also be automatically enabled in the associated dataset.

4 - Sync to TestRail

Overview

This page provides the steps to sync test flows and test runs with TestRail. IF you want to learn how to configure your TestRail account for integration, see Settings. If you want to learn how to integrate your TestRail account with your project, see Integrations.

Sync test flows

Synchronize test flows to TestRail to link test cases and results across platforms.

  1. Select a test flow.

  2. Click the Sync to test flow button in the top-right corner of the page.


  1. Click Sync.

After a successful sync, a confirmation message will be displayed.

Sync test runs

Synchronize test runs to TestRail enables real-time tracking of test progress and outcomes.

  1. Click the Run button to view the Run Setup Form.
  1. Click the Sync Run To TestRail toggle.

You can also sync the run to TestRail in the following modules by repeating the steps above.

5 - Issue Tracking

Overview

Before linking an issue, ensure that you have enabled the JIRA integration in the Settings module and have configured JIRA in the Project Integrations.

You have the option to create a new issue or link a flow to an existing one.

Create a new issue

  1. Click the Issue Tracking icon.

  2. Click the Link Issue button.

  3. Enter valid values in the JIRA fields displayed. Some fields are automatically filled with a default value that can be modified.

  4. Click Create Issue. A confirmation message will be displayed.

A JIRA ticket summary with hyperlink to the JIRA project is now displayed when the Issue Tracking icon is clicked.

If you go the integrated JIRA project, a new JIRA ticket is created.

Synchronize test runs to TestRail enables real-time tracking of test progress and outcomes.

  1. Click the Issue Tracking icon.
  1. Click the Link Issue button.

  1. Click the toggle button to the Existing Issue.

  2. Select how you want to search for an existing issue.

  1. In the Search Issue field, enter a number if you selected By Issue Number and a keyword if you selected By Issue Title. A dropdown listing all tickets matching your search is displayed.
  1. Click the Link Issue button.

A JIRA ticket summary with hyperlink to the JIRA project is now displayed when the Issue Tracking icon is clicked.