Requirements Traceability

DAI's Requirements Traceability feature enables you to import your application requirements, which are typically managed in external systems, into DAI and connect them directly to test cases and results. This integration helps you to ensure that each requirement is thoroughly tested and properly accounted for, providing clear traceability between a requirement and its corresponding test cases and results. You can also generate a requirement coverage report based on your successful tests and view it in DAI.

Licensing the Requirements Traceability Feature

You must purchase a license specifically for the Requirements Traceability feature in order to use it. To obtain this license, please contact our Customer Support.

When you receive the license from Customer Support, navigate to System > Licenses and enter it as described in Adding licenses on the DAI License page.

Importing Requirements

Before you can assign requirements to a specific test case's steps, you must import the requirements to a requirement group within DAI.

To import requirements, follow these steps:

1. Log in to Eggplant DAI.
2. Go to Controller > Requirements. The Requirements page opens showing a list of existing requirement IDs in a specific requirement group.
3. Click Import requirements. This action opens the Import requirements page where you can begin the process of importing your requirements.

4. Select a file to import. You can either click the Browse files button to search for the file or drag and drop it directly from your computer folders.

   note

   • The supported file types for import are xlsx and csv. Ensure the file is formatted correctly before uploading to avoid data mapping issues.

   • The file can contain a maximum of 10,000 rows, 10 MB in size, and only plain text (alphanumeric characters and these special characters: underscore (_), period (.), dash (-), and comma (,)) for the requirement ID fields.

   • Only upload one file at a time.

5. Select the requirement ID and Description columns.

At this step, you need to select a column for requirement ID and requirement description. To do this, hover over the respective column in the preview and click the Select button.

After you select both the requirement ID and Description columns, click the Next button to proceed to the next step.

6. Assign the imported requirements to a group. There are two options available: Select an existing group or Create a new group.

   Important

   Importing requirements into an existing group replaces the current requirements in the group, which may update or delete them. This deletion also permanently removes traceability to associated tests.

7. After you select the requirement group, click the Import requirements button in the bottom right corner of the page to import the requirements.

If you chose to import your requirements into an existing group, you will be prompted to confirm your selection because of the possibility of overwriting the existing requirements as described above.

Import Requirement Status

DAI assigns one of three statuses to imported requirements: Success, Imported with warning message, or Failure. A description of each status follows:

• Success: Your requirements imported successfully.

• Imported with warning message: Your requirements imported successfully, but some rows with invalid entries were filtered, and you see a warning message notifying you about it.

  

• Failure: Your requirements import failed. You see an error message (like the "Missing requirement descriptions" message shown below), your requirements are not imported, and you are returned to step 3 in the import process. You may need to make adjustments to the requirements file that you previously imported in step 1 before re-importing.

  

Requirements Table

After you import the requirements, you can view them in the Controller > Requirements page. This page provides a clear and organized view of all the requirements in the system, as well as the associated test cases and steps at a glance.

If you find a mistake in the imported requirements, you can always correct it by re-importing the requirements.

Important

Make sure you are not changing the requirement ID or you will lose all the test case steps assigned to the respective requirement.

The Last Updated date, located in the upper-right corner of the table, is the date the requirements were last imported. This date is based on the requirements import, not the assignment of requirements nor the test result status.

Assigning Requirements

Next, you can assign the requirements to the suitable test cases and steps according to your design. Simply, click the expanding button at the end of the row, click Open test case page, and continue from there.

After you assign your requirements, you can see the following information about each one in a tabular view:

• Requirement ID: Unique identifier for each requirement.
• Description: A detailed explanation of the requirement.
• Assigned to test cases: A dynamic column displaying the test cases associated with each requirement.
• Requirement status: The current status of the requirement (for example, Untested, Unsuccessful, Verified, or Unassigned).

note

You can click the Assigned to test cases chip to see a page with details about the corresponding test cases. If there are too many test cases to display, you see an overflow number (for example, +3). Click the number to view all the assigned test cases.

Important

Be careful when you unassign a requirement. Even when you reassign the requirement to the same test case step, the test status resets to Untested, and you will need to rerun the test after the reassignment.

Expanding the Requirement to Show the Assigned Test Cases

You can see the test cases assigned to a requirement by clicking the expansion button at the end of the row.

note

The test case steps are grouped by their test case name.

• Test cases: The name of the test case to which the step belongs.
• Steps: The step index number and the name of the step for a model-based test case. If the test is a script-based test, then you see the script path here instead.
• Last run status: The latest run status of the test case step (for example, Untested, Error, and so on).
• Last executed: The latest date and time the step executed. Note that this last executed date and time is for the test case step, not the test case itself. Hence, you may see a slightly different Start Time on the Test Result page.

note

You can click the Test cases to go to the corresponding test case page.

note

You can go to the detailed test result page by clicking on the Result button at the end of the row if the data is available.

Requirement Status

DAI assigns one of the following statuses to requirements based on the Last run status of all the associated test cases as follows:

• Verified: Shown only if all associated test cases have a status of Passed.
• Unsuccessful: Shown when there is any associated test status that is other than Passed.
• Untested: Shown if all associated test cases are "Untested".
• Unassigned: Shown when there are no test cases assigned to the requirement, or when the associated model or suite is deleted.

Filtering

When loaded, the page shows all the requirements of the first requirement group. You can always filter the list by:

• Search by ID: a search field where you can enter the exact ID of a requirement you want to see.
• Requirement status The status of requirements (for example, Untested, Unsuccessful, Verified, or Unassigned).
• Requirement group: you can filter or change the requirement group using the selection at the top of the table. If the group selection list is lengthy, and it is difficult to find a group, you can simply search for it by typing its name in the search bar.

Migrating from The Version 7.4 and Below

Important

Please be aware that after upgrading DAI and setting up all the requirements, the associated test case step statuses are Untested. This is true even though the existing assigned test result has a Passed status. You need to run the respective test case to update the status on this page.