Performing a ReqIF import

Note:  ReqIF import only supports requirements and requirement documents. Other item types, such as test cases, are not supported.

You can import requirements and documents from Requirements Interchange Format (ReqIF) to add them as new requirements and documents in Helix ALM. This helps your organization work with requirements from other systems while continuing to use Helix ALM for requirements management, traceability, and compliance efforts.

To import, you need a ReqIF file and an understanding of how the data in the ReqIF file needs to map to Helix ALM. Helix ALM guides you through each step of the import.

Tip:  Before importing, review Preparing for a ReqIF import for important information that will help you import data successfully.

1. Click Administration.

The Admin Home page opens.

2. Click ReqIF Import.

The ReqIF Import dialog box opens.

1.On the Choose File page, click Browse to select the ReqIF file to import or drag and drop the file in the box. The file must be .reqif, .reqifz, .xml, or .zip format.

To clear the selected file, click next to the filename.

2. Click Next.

The file is uploaded and analyzed.

  • If Helix ALM does not recognize any data in the ReqIF file based on mapping files uploaded for previous imports, the Upload Mapping File page is displayed. Continue with Upload a new mapping file.
  • If Helix recognizes data in the ReqIF file based on mapping files uploaded for previous imports, the Choose Mapping File page is displayed. Continue with Choose an existing mapping file.

To perform the import, Helix ALM requires a mapping file, which defines how ReqIF data is mapped when imported to Helix ALM. Helix ALM can generate a mapping file for you as a starting point. You can then modify the file to make changes or add other mappings.

If you previously imported a ReqIF file with similar data, you can you can download a copy of the previous mappings and modify them to use them for the current import.

Creating a new mapping file

If you do not have a mapping file, you can generate one, modify it to map ReqIF types to Helix ALM types and then upload the modified file.

1.On the Upload Mapping File page, click Generate New File in the Download File to Modify area.

The mapping file (.yaml) is generated and downloaded. The filename is <ReqIF_Filename>_mapping.yaml.

2. Modify the file with the correct mappings. Click View Field Codes to see a list of valid fields you can use for mapping. See Generating and editing ReqIF import mapping files.

3. Click Browse in the Mapping file area and select the mapping file to upload. The file must be .yaml or .json format. To clear the selected file, click next to the filename.

4. Click Next.

The file is uploaded to Helix ALM and analyzed. The ReqIF Import Validation Report opens. Continue with Review the validation report, make mapping file changes, and start the import.

Downloading mappings from a previous import

If a previous import has at least one type with the same identifier as the ReqIF file you are importing, you can download a copy of the previous mappings and modify them to use them for the current import. This can be a good starting point for creating a new mapping file if the previously imported file and current file are similar.

1.Click Download Copy of Existing File in the Download File to Modify area.

The Download Copy of Existing Mappings dialog box opens. The following information is displayed:

  • Mapping Description — Description from the mapping file.
  • Matching Types — Percentage of matching types between the mapping file used for a previous import and the ReqIF file you are importing, divided by the total number of types in the ReqIF file. Mouse over the percentage for details. This information can help you decide if the mappings are a good fit for the current import.
  • Last Used On — Date and time the mappings were last used for import.

2. Select the mappings to download.

3. Click Download or click next to mappings to download.

The mapping file (.yaml) is generated and downloaded. The filename is the same as the name of the file when it was originally uploaded.

4. Click Close to close the Download Copy of Existing Mappings dialog box.

5. Modify the file with the correct mappings. Click View Field Codes to see a list of valid fields you can use for mapping. See Generating and editing ReqIF import mapping files.

6. Click Browse in the Mapping file area and select the mapping file to upload. The file must be .yaml or .json format. To clear the selected file, click next to the filename.

7. Click Next.

The file is uploaded to Helix ALM and analyzed. The ReqIF Import Validation Report opens. Continue with Review the validation report, make mapping file changes, and start the import.

If Helix ALM recognizes mappings from a previous import when analyzing the selected ReqIF file, you can choose to use a new mapping file or use the mappings from a previous import.

1.On the Choose Mapping file page, select the mappings to use.

  • Select Use a new mapping file to upload a new mapping file to use for the import.
  • Select Use the mappings from a previous import to use the mappings uploaded for a previous import of a similar file.

2. Click Next.

If a previous import has at least one type with the same identifier as the ReqIF file you are importing, you can use the same mappings for the current import.

1.On the Use Existing Mappings for Import page, review the available mappings to see if there is a good match for the current import. The following information is displayed:

  • Mapping Description — Description from the mapping file.
  • Matching Types — Percentage of matching types between the mapping file used for a previous import and the ReqIF file you are importing, divided by the total number of types in the ReqIF file. Mouse over the percentage for details. This information can help you decide if the mappings are a good fit for the current import.
  • Last Used On — Date and time the mappings were last used for import.

2. Select the mappings to use for the import.

Note:  To delete a mapping, select it and click Delete or click next to it. Click Delete to confirm the deletion. If you delete all mappings in the list, click Cancel to restart the import or click Back to upload a mapping file.

3. Click Next.

The validation report gives you a preview of the import, including mappings between the ReqIF file and Helix ALM that will be used during the import and messages to help with troubleshooting any problems.

Tip:  You will likely need to modify the mapping file multiple times to get acceptable results in the validation report before you import.

1.Review the report. See Reviewing ReqIF import validation reports.

Note:  Click Open in browser to open the report in your default browser.

2. Make any changes to the mapping file.

3. Click Back to upload the modified mapping file. Click to clear the existing file and then click Browse to select and upload the file again. See Upload a new mapping file.

4. Click Import.

You may be prompted to enter an electronic signature and change reason. See Entering electronic signatures.

The import starts. The import status is displayed. When the import is complete, the ReqIF Import Results Report opens.

Note:  You can click Cancel to stop the import, but any data already added to Helix ALM before you cancel is not deleted.

When the import is complete, the import results provide information about the number of items imported from the ReqIF file and any warnings or errors that occurred during the report.

1.Review the results. See Reviewing ReqIF import results.

Note:  Click Open in browser to open the report in your default browser.

2. Click Finish.

3. Review the new items added to Helix ALM during the import.