test-suite
2024.10
true
UiPath logo, featuring letters U and I in white
Test Suite User Guide
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Nov 11, 2024

Requirements

It is very common to use specialized requirements management tools to manage requirements like user stories, epics, or other artifacts. Test Manager supports the synchronization of requirements from external tools as well as the creation of requirements from within Test Manager. In a Test Manager project, there can be requirements that are synced from external tools as well as requirements that were created in Test Manager.

Creating requirements

To create requirements in a Test Manager project:

  1. In the Test Design menu, navigate to the Requirements page.


  2. Click Create Requirement. The Create Requirement window is displayed.
  3. Fill in the fields accordingly:
    • Name - The name for your requirement.
    • Description - (Optional) Add any description to the requirement. In order to add formatted text, use Markdown syntax.
    • Optionally, add any number object labels.
  4. Click Create. Your new requirement is displayed in the Requirements page.
    Tip: Upload documents

Synchronizing Requirements from External Tools

In order to keep requirements from external ALM tools in sync with requirements from Test Manager, configure a connection first. Refer to About ALM Tool Connectors to learn how to configure a project to be synchronized with an external ALM tool.

Once a connection is configured properly, any requirement which is created in the external tool is also created in Test Manager. The name and description of those requirements are also kept in sync when changed in the external tool. In Test Manager, these attributes are read-only.

Note: After a connection to an external ALM system has been configured, no initial synchronization of existing artifacts is performed. This should avoid creating huge amounts of data in Test Manager without any prediction on how long this would take. However, whenever an object in the external tool is updated, it will be created in Test Manager in case it does not exist.

Cloning requirements

You can only clone one requirement at a time.
  1. Select More Options docs image for the requirement that you want to duplicate and then Clone.
    The Clone panel appears.
  2. Select the information that you want to clone:
    1. Test case assignments
    2. Documents
    3. Labels

      Custom field definitions, and custom field values are also cloned if they exist.

  3. Select Confirm to clone the requirement.
    The Requirement will be cloned in the background message appears.


A clone of the requirement is created, with a different Id.

Exporting requirements

You can export your requirements, separately from your testing project, to import them back into a different project. The requirements export process is similar to the overall project export process. Visit Export project to check how exporting projects works.

Note: If a requirement is linked to a test case, the relationship is maintained in the exported file. When you import the requirement into a different project, the association is restored.

Remember that the export doesn't include custom field definitions.

Follow these steps to export requirements:

  1. Open your project and navigate to Requirements.
  2. Depending on how many requirements you want to export, execute one of the following steps:
    • To export a single requirement, select More Options for the specific requirement and then select Export.
    • To export multiple requirements, select all the requirements you want to export, and then select Export.
  3. When the export is ready, you will receive a Project export completed notification. Select the notification to download the TMH file containing the exported requirements.

You can then import the downloaded TMH file into a different project to re-create all exported objects. Visit Import project to learn how to perform the import process.

Jira Requirements

Synchronizing Objects from Jira to Test Manager

Test Manager comes with a Jira connector pre-installed. On your Jira instance, the UiPath® Test Manager for Jira apps needs to be installed from the Atlassian marketplace. See Connecting a Jira Project to learn how to configure Jira and Test Manager to enable synchronization.

Objects are synchronized from Jira to Test Manager under the following circumstances:

  • An object is created in Jira and Jira is configured to synchronize this type of object.
  • An object is updated in Jira and Jira is configured to synchronize this type of object.

    Note:

    If an object is updated in Jira which does not exist in Test Manager, a new requirement will be created in Test Manager.

    If an object is deleted in Jira, the synchronized object in the Test Manager will remain. Test Manager never propagates deletions across systems.

Enforcing Synchronization

For a particular object, synchronization can be enforced immediately. This can be helpful under the following circumstances:

  • Objects are out-of-sync for any reason - for example, Test Manager was not available while the Jira object was updated.
  • A new Jira connection has been set up in Test Manager and objects which already existed in Jira need to be synced.

To enforce synchronization of an object:

  1. Open the object in Jira.
  2. Click Push to Test Manager from the More menu. Synchronization is invoked immediately.

    Note: Please note that Test Manager does not perform a sync-all operation after a Jira connection has been set up.

Applying filters and views

You can apply filters and store them in views for your test objects. Depending on the scope of a view (personal or public), you can persist the view containing the filters for a user or for all users within the project.

The available filters that you can apply are similar to the ones that appear in the Columns type of that section, consisting of:
  • Properties native to a test object (such as Labels, Updated by, Source, and others)
  • Custom labels

Follow these steps to customize your filters and view:

  1. Go to the desired test object section (i.e. Requirements) and select Filters.
  2. Select Add filter to choose the filters that you want to apply.

    When you select the filter, also select the value that you want it to have.

  3. Select Apply to include the filters in your view.


  4. To save these filters as a view, select Views, and then Save view.
  5. In the Save view window, choose to create a New view or Update an existing view with the filters.

    Decide whether to keep the new view private or set it to Public for other users to access.

  6. Select Save to confirm changes.
  7. To apply a view that you created, select Views, and then Open views.
    1. Choose a personal view (My views) or a Public view.

      You can also change the visibility of your created views between private and public, according to your needs.

    2. Select the desired view and select Open to apply.


Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.