Importing artifacts from ReqIF files to a requirements project

You can import the data in a ReqIF (Requirements Interchange Format) file from your file system to a requirements project.

Before you begin

Before you import a ReqIF (.reqif or .reqifz) file, make sure that the file that you are importing is encoded in UTF-8.

To import a ReqIF file, you must have the Import ReqIF permission.

About this task

When you import a ReqIF file (.reqif or .reqifz), you use a wizard in which you can select the ReqIF file to upload and import. After you upload the file, you can either import the ReqIF data or close the wizard and import the ReqIF data at another time. After the import process is complete, a report is displayed that shows a list of the imported data. You can go to imported artifacts in the project by using the links that are generated in the report.

Important: The first time that you import, types, and artifacts are created. If you import the same data later, all of the data except for the view column information is updated. During an import, only system-defined attributes and types are merged. Artifact types, attributes, data types, and folders that were not already imported from a ReqIF file are created in the project that you are importing to. For example, the file that you are importing and the project that you are importing to might both contain a Priority attribute. In that case, an attribute that is named Priority 2 is created during the import.
You can import several types of data from a ReqIF file, including these types:
  • Textual artifacts
  • Graphical artifacts
  • Diagram artifacts
  • Attribute definitions
  • Data types
  • Folders and folder hierarchy
  • Links
  • Link types
  • Modules
  • Artifact types
  • Collections
  • View column information, which can be imported in the first import only
The following types of data cannot be imported:
  • Tags
  • View filtering information
  • Comments
  • Reviews
  • Audit history

You can import ReqIF files in XML format or compressed file format. If a ReqIF file references external attachment files or embedded OLE files, which occur in some exports from Rational® DOORS®, the ReqIF file and referenced external files must be in one compressed file to ensure that the correct associations are created in the requirements project. When you import a ReqIF file that contains embedded OLE objects from Rational DOORS, the OLE objects are created as file resources in the requirements project.

When you import a ReqIF package, existing artifact types are updated and the attributes are retained: they are not removed. For example, if you have an existing artifact Artifact Type A, with attributes A and B, and you import a package that contains Artifact Type A, with attributes A and C, the updated artifact is Artifact Type A, with attributes A, B, and C.

If the package includes only portions of a module, when the package is imported, new artifacts are added to the existing module structure. Artifacts that are not included in the package, but are in the existing module structure, are never deleted.

Child artifacts are moved to new parents as described in the imported package, as long as the previous parent is also included in the package. If the previous parent is not included in the package, the child artifact will not be moved. The following example shows how a child artifact can move during the import process:

Table 1. Example of how the structure of artifacts can change during the import process
Existing package Package being imported Resulting structure (moved artifact in boldface)
Parent artifact 1
  • Child artifact A
Parent artifact 2
  • Child artifact B
Parent artifact 3
  • Child artifact C
Parent artifact 1
  • Child artifact A
  • Child artifact B
  • Child artifact C

Parent artifact 2

Parent artifact 1
  • Child artifact A
  • Child artifact B

Parent artifact 2

Parent artifact 3
  • Child artifact C
If you import a ReqIF package that has only one link endpoint, and you later import another ReqIF package that has the other endpoint, the link is created between the two endpoints. Incremental links are supported for the following imports:
  • Artifact to artifact
  • Artifact to module
  • Artifact to collection
  • Module to module
  • Module to collection
  • Collection to collection

For more information about the ReqIF format specification, see Requirements Interchange Format.

Procedure

  1. Open a requirements project.
  2. On the Artifacts page, click Create and click Import Artifact.
  3. In the Import wizard, select Import requirements from a ReqIF file and click Next.
  4. Navigate to the file to import and click Import.
  5. After the file is fully uploaded, complete one of the following steps:
    • To continue the import, click Next and follow the prompts in the wizard.
      Important: When you select the folder or module to place the new artifacts in, that folder or module is used only for artifacts that do not have a defined folder or module hierarchy. If a ReqIF file was exported with the Include Folders option selected, that folder hierarchy is used starting from the root folder, regardless of the folder that you specify. This also applies to ReqIF files exported by Rational DOORS as these always include the folder structure.
    • To close the Import wizard and continue the import later, click Close.
  6. To continue importing a previously uploaded ReqIF file, start the Import wizard and click Import requirements from a ReqIF file in this project.

What to do next

After you finish importing the ReqIF file, click Show Report to see a list of the data that was imported. The report includes the name, ReqIF ID, and URI of the data, and other information. You can access the report at any time from the project properties ReqIF page.

video icon Watch videos

CLM playlist
Jazz.net channel
User Education channel

learn icon Learn more

CLM learning circle
Agile learning circle
Learning circles

ask icon Ask questions

Jazz.net forum
developerWorks forums

support icon Get support

Support Portal
Deployment wiki
Support blog