Importing requirement files

To link test cases or test harnesses to the requirements in HCL DevOps Test Embedded (Test Embedded), you must first import requirements that come from other tools to be able to link.

Before you begin

Test Embedded supports the following requirement file formats:
  • ReqIF format (see https://en.wikipedia.org/wiki/Requirements_Interchange_Format). The extension is .reqif.
  • ReqIFz format: A zip file is required and it must contain at least one ReqIF file. The extension is .reqifz.
  • CSV format: In the CSV file, the first row must contain the column names and the next rows must contain the data. The CVS file must contain the following columns:
    • Id: Identifier of the requirements. This column is mandatory.
    • Parent: Id of the parent requirement. This column is optional (if this column is not present, all requirements are set at the top level)
    • Name: Name of the requirement. This column is optional.
    • Description: Description of the requirement. This column is optional.
    • Other columns can be added.

Procedure

To import a requirement file, follow these steps:
  1. Open the project settings.
  2. Select Requirements in the left panel.
  3. In the right panel, click on the value of the settings Requirement files. The default value is “no file selected”.
    The Select Requirement files dialog box opens with the list of requirement files that are already selected.
  4. Click the appropriate choices to add a requirement file:
    • Click Add to add a requirement file from the workspace.
    • Click Add (External) to add a requirement file from any location on the disk.
    • Click Remove to delete the selected requirement file.
    • Click OK to close the dialog box.

    When the requirement files are selected, you can still select some attributes of the requirements so that they are added to the traceability matrix report.

    To add, remove or re-organize the list of attributes, proceed as follows:
    • In the right panel, click on the value of the settings Attributes.

      The Requirement attributes to display dialog box opens with the list of attributes that are already selected.

    • Click the choices as required:
      • Click Add to add an attribute.

        Then, you can modify the name of the attribute that is displayed in the left panel of the dialog box by clicking the Name column and in the ReqIF Attribute to select the attribute.

        You can also click on the cell Use as ID to specify that the attribute must be used as the ID instead of the default ID. yes appear in this cell. If another attribute is previously selected as the default ID, it is deselected. Be sure that every requirement in the requirement file has a non-empty value for this attribute.

      • Click Remove to delete the selected attribute.
      • Click Up to move up the selected attribute in the list.
      • Click Down to move down the selected attribute in the list.
      • Click Save & Close to validate and close the dialog box.
  5. Enter the appropriate choices in the following optional settings:
    • Report Template: This setting is used to change the template of the report. By default, the template is reqreport.template and it is saved in the lib/reports folder.
    • All attributes: This setting is used to generate all the attributes in the JSON file.
    • Non-terminal requirements covered by children: If you set this setting to Yes', a non-terminal requirement can be covered if all its children are covered. If you set it set to No, it must be covered at least by one test case.

What to do next

After you import requirement files into your project, you can link test cases or test harnesses to the requirements in your project. See Linking tests to requirements.