Best practices: ReqIF round-trip between DOORS Next Generation and DOORS 9.

Before you begin

About this document

This document describes the best practices to exchange requirements from DOORS Next to DOORS 9 and from DOORS 9 to DOORS Next. The steps described in that document will help you to minimize issues when exchanging requirement between DOORS Next and DOORS 9

DOORS Next and DOORS 9 are different

DOORS Next and DOORS 9 are 2 different tools and exchange data between some 2 tools via ReqIF can be challenging. The main differences are:

• The Type System

DOORS Next Type System is defined at the component/project area level while DOORS 9 Type System is defined at the module level. Also, in DOORS Next, it is possible to have multiple Artifact Type while in DOORS 9 only 2 are available (module and object).

• The data merge in ReqIF round-trip

When importing a new ReqIF package in DOORS Next, if you select all the attributes, then all the data will be over-written to match the data in the ReqIF package. That means you need to know what attributes data you need to import. When importing and merging a new ReqIF package in DOORS 9, only the locked data will be merged and updated. Data that is not locked will remain unchanged. DOORS Next only allows locks on attributes so that the option we will use.

• System attributes

System attributes are already mapped with a pre-defined URI in DOORS Next and DOORS 9. However, the scope of a few system attributes differs and so those system attributes MUST not be used in a ReqIF package between DOORS Next and DOORS 9. For example, the System attribute “Description” have different scope in DOORS Next and DOORS 9. In DOORS 9, it is only a module level attribute while in DOORS Next it is not. To avoid this problem, we will only include only the necessary attributes in the ReqIF package by using views.

• Heading and Requirement

In DOORS Next, an artifact can contain either heading, or requirement text. However, in DOORS 9, it possible to have “heading” and “Requirement” text in the same object (bad practice) by putting data in the attributes “Object Heading” and “Object Text”. That kind of data must be avoided for ReqIF exchange.

Agreement on the Data structure and the Data to exchange

You MUST agree with your supplier what set of attributes is needed so you only export what is really needed. This will have numerous benefits:

• This will limit the size of the ReqIF packages so it will improve performance when importing/exporting data
• This will limit scope for type system distortion.
• This will avoid the issue with the System Attribute “Description”: if you export the full module that attribute will be included and if you have data in it, this will result in data loss in DOORS 9 as the scope of this attribute is different (module only).

Also, you MUST agree with your supplier what set of attributes they must edit. The other ones will be locked for editing in DOORS 9.

Overview of the steps

• First, we need to pick a feature to limit duplication of attribute or types when importing a ReqIF package. In DOORS 9, you can only use RDF URI mapping. In DOORS next, you can either use RDF URI Mapping or Mapping context.
• Create views for the ReqIF definition in the module(s) you want to export
• Create the ReqIF definition and lock the attributes your supplier should not be editing.
• Export the ReqIF definition
• Import the ReqIF package in the other RM tool.
• Edit the data you can/ are supposed to.
• Export the ReqIF definition and import it back in the original RM tool.

Limitation

When doing a ReqIF round-trip from DOORS 9 to DOORS Next, be aware that Doors 9 pictures objects are not exported in ReqIF packages so they won’t be visible in DOORS Next after importing the ReqIF packages. Use OLE object instead.
When working with in locks in DOORS 9, the data structure of enumerated attributes must not change. For example, if you have an enumerated attribute named “Severity” with 3 possible values (low, medium, high), then you cannot change its name nor add or remove a value. If you do so, the merge won’t work (for the modified/new values), and the data won’t be updated properly in DOORS 9.

Round-trip from DOORS Next -> DOORS 9 -> DOORS Next

Step 1: create a Mapping Context

Once the data structure is decided, create a Mapping context (optional). This feature will limit the proliferation/duplication of artifact and data types in the project areas and components in which the ReqIF packages are imported.
To do that, go the “Manage Component Properties” (or “Manage Project Properties” if your DOORS Next project is not CM-enabled) and select Mapping Context. Click on “New context”, give it a name and a description.
image:DNGD9_step01.png

Step 2: create a specific view for ReqIF

In the module(s) you want to export, create a view with only the needed discussed attributes:
image:DNGD9_step02.png
Important: If there are multiple Artifact Types in your module, make sure that all the artifact types have the attributes listed in the view because DOORS 9 does not have the concept of Artifact types, and once imported in DOORS 9, it will allow to set values in attributes that do not belong to the artifact type. Doing that might cause issues when importing it back to DOORS Next (missing data, modification of Artifact Types, etc..)

Step 3: create the ReqIF definition

To do that, go the “Manage Component Properties” and select ReqIF. Click on “New Definition”.
Give it a name and a description.
Then add your modules by selecting the view created on step 2:
image:DNGD9_step03a.png
Finally, use the DOORS 9 settings to lock all the attributes except the ones that will be edited by your supplier:
In this example, the attributes listed in the view are the following:

• Primary Text -> need to be locked
• Priority -> need to be locked
• Status -> need to be locked
• Supplier_comment
• Supplier_Status

In ReqIF package, the system attributes “Artifact Format” is always exported so this will have to be locked too.
In this example, the module has a module attribute named “Product owner” so this will need to be locked too.
In summary, the attributes that need to be locked are the following (see screenshot)
image:DNGD9_step03b.png

Step 4: export the ReqIF package

In the drop-down list, select “Export with context” (if you have created a mapping context).
image:DNGD9_step04a.png
Then select your mapping context.
image:DNGD9_step04b.png
The ReqIF file will be created, once done, click download:
image:DNGD9_step04c.png

Step 5: Import in DOORS 9

In DOORS 9, select a project, then go to File-> Import ReqIF Package…
image:DNGD9_step05a.png
Select the ReqIF file you exported from DOORS Next, then in the dialog give a name to the ReqIF definition that will be created in DOORS 9 and click Import
image:DNGD9_step05b.png
At the end of the import, you might get an information message. It happened when they are multiple Artifact Types in a module but if you have followed the recommendation so far, there will be no issue.
image:DNGD9_step05c.png

Step 6: Editing data in DOORS 9

You can see that even by logging in DOORS 9 with the super-user Administrator, only the 2 attributes we set are available for editing. The rest is locked in read-only mode.
image:DNGD9_step06.png
Let’s edit the data, add some values in attributes Supplier_comment and Supplier_Status.

Step 7: exporting the data from DOORS 9

After editing the data in DOORS 9, you must export the ReqIF definition to get a new ReqIF package to import in DOORS Next.
Go to the DOORS 9 project Properties and in the ReqIF tab, select the ReqIF definition and then click on export.
Select a path for the ReqIF file and click Ok
image:DNGD9_step07a.png
When the export is completed, you will see that dialog box:
image:DNGD9_step07b.png

Step 8: Import the DOORS 9 ReqIF package in DOORS Next

Go to “Artifacts”, then click on “Create” and select “Import Artifact…”
image:DNGD9_step08a.png
Select “Import requirements from a ReqIF file”
image:DNGD9_step08b.png
In the next dialog, pick the DOORS 9 ReqIF package and click Upload. If the upload is successful, you will see that screen. Click on Next.
image:DNGD9_step08c.png
In the Import dialog, apply your Mapping Context (if you have defined one)
image:DNGD9_step08d.png
After clicking Next, the import starts…
image:DNGD9_step08e.png
The module data in DOORS Next has been updated:
image:DNGD9_step08f.png
Let’s add a new requirement in DOORS Next and send a new ReqIF package to the supplier. (Re-do Step 4 to export a new ReqIF package)

Step 9: Merging data in DOORS 9

When importing a new ReqIF package from the same ReqIF definition, you will have to specify a temporary folder to store the new data:
image:DNGD9_step09a.png
To merge, the new package with the existing one, go to the Project Properties, in the ReqIF Definition Tab. Select the ReqIF definition and click “Imports”:
image:DNGD9_step09b.png
Click on Merge, if there is a required merge status.
Once done, the dialog box shows that it is completed:
image:DNGD9_step09c.png
Check the data in the main folder, the new requirement should be present.
image:DNGD9_step09d.png

Round-trip from DOORS 9 -> DOORS Next -> DOORS 9

Step 1: mapping the attributes

To avoid having duplicated attributes in DOORS Next, it is recommended to map the attributes with RDF URI. If attributes already exist in DOORS Next, map the attributes with the same RDF URI.
DOORS 9 mapping feature documentation
In your module, select the attributes you want to map with RDF URIs:
image:D9DNG_step01a.png
Click the “Suggest” button to map all the attributes with RDF URIs then in the “General” tab click the “Publish” button.
image:D9DNG_step01b.png

Step 2: create the views for the export

The best practice in DOORS 9 to export data to ReqIF is to create a view with all the attributes you want to share with your supplier.
Then you also need to create a view to lock the attributes you want your supplier to edit.
View with all the attributes I want to export to my supplier:
image:D9DNG_step02a.png
View to lock the attributes in DOORS 9. Those attributes will be edited by the supplier in DOORS Next:
image:D9DNG_step02b.png

Step 3: create the ReqIF definition

In the Project properties, go the “ReqIF Definitions” tab and click “New”. Give it a Name and a Description, then click ok.
image:D9DNG_step03a.png
In the next Dialog, select your module, then select “lock attributes”, select the 2 views you created and click “Add or update module”. Repeat the operation if you have other modules.
image:D9DNG_step03b.png
Once the ReqIF definition is created, export the ReqIF package:
image:D9DNG_step03c.png

Step 4: import the ReqIF package in DOORS Next

Go to “Artifacts”, then Create -> import artifacts…
image:D9DNG_step04a.png
Select Import requirements from a ReqIF file
image:D9DNG_step04b.png
Upload the ReqIF file:
image:D9DNG_step04c.png
Select a folder where to import the data. Then you can also select the attributes to import, by default, all the attributes will be imported.
image:D9DNG_step04d.png
Click “Finish” to start importing the data.
image:D9DNG_step04e.png

Step 5: edit the data imported in DOORS Next

Edit only the 2 attributes specified:
image:D9DNG_step05a.png
It is possible to edit the other attributes BUT as there are ReqIF locks in DOORS 9 only for the 2 attributes specified, the other ones won’t be merged in DOORS 9.
In DOORS 9, ReqIF locks present only for the 2 attributes specified:
image:D9DNG_step05b.png

Step 6: export the ReqIF package in DOORS Next

Go the “Manage Component Properties” and select ReqIF. Select the ReqIF definition and export it:
image:D9DNG_step06a.png
Click on Download:
image:D9DNG_step06b.png

Step 7: Import and merge the changes in DOORS 9

When importing a new ReqIF package from the same ReqIF definition, you will have to specify a temporary folder to store the new data:
image:D9DNG_step07a.png
To merge, the new package with the existing one, go to the Project Properties, in the ReqIF Definition Tab. Select the ReqIF definition and click “Imports”:
image:D9DNG_step07b.png
Click on Merge, if there is a required merge status.
Once done, the dialog box shows that it is completed:
image:D9DNG_step07c.png
Check the data in the main folder, the edited data in DOORS Next should have been merged:
image:D9DNG_step07d.png
You can see that the ReqIF locks have been removed.
They will be in place again after exporting a new ReqIF package.

Appendices

DXL script to convert DOORS 9 Object Picture in OLE object

Here is a sample script to do that:

/*begin*/
Module m = current
Object obj
string nPath = "C:/temp/"
for obj in m do {
bool isPicture = obj."Picture"
if(isPicture)
{
string ErrMess
string nFile = nPath "picture_obj_" identifier(obj) ".png"
ErrMess = exportPicture(obj,nFile ,formatPNG)
if(ErrMess == "")
{
deletePicture obj
oleInsert(obj,obj."Object Text",nFile ,false)
}
}
}
/*end*/