Description

New feature: Provide a DNG ReqIF Export option "Compatiblity Export Option for RM Tools without support for artefacts outside modules" that does the following:

• DNG shall only export artefacts that are part of exported modules

• If an artefact B is not directly in a module, but is embedded in another artefact A that is part of the module:

  • Do not export Artefact B (because it is not in a module)

  • Export the Content of artefact B that would be visible in Artefact A (Primary Text, Heading, Files) as part of the Primary text of Artefact A

• Apply recursively (e.g. if another Artefact C is embedded in Artefact B which is embedded in Artefact A; with A being part of the exported module)

DNG shall also make this DNG option available via the DNG OSLC API. The corresponding DNG OSLC API shall be public and documented.

Motivation / Reason

Background:

• The ReqIF Standard and DNG allow artefacts / SPEC-OBJECTS that are not part of a module / SPECIFICATION

• Several Requirements Management Tools (like DOORS Classic) do not support artefacts / objects that are not part of a module

• If we export artefacts that are not part of a module - but are embedded into other artefacts that are part of a module and thus visible for us in DNG - to ReqIF and another party imports this ReqIF into an RM Tool that does not support artefacts outside modules, the information in the artefacts outside the modules will not be imported / lost

• Thus, it would increase compatibility with other RM Tools to have a "Compatiblity Export Option" that exports to ReqIF in such a way that we a)do not export any artefacts outside module but b)"rescue" all relevant information (i.e. information we can see in DNG from the embedded artefacts i.e. Primary Text, Heading, Files) from embedded artefacts and put them into the artefact that is part of the module

• The goal is that we can export ReqIFs that are more compatible with RM Tools such as DOORS Classic, so that no important information is lost

Examples:

• Artefact A is part of the exported module

• Artefact B is embedded in Artefact A

• Artefact B is not (directly) part of the exported module

• Artefact C is embedded in Artefact B (Artefact C only appears in some examples)

Example 1:

• Artefact A (Primary Text: "This is some text.")

  • Artefact B (Primary Text: "This is some additional text.")

• ReqIF: Contains only Artefact A with merged content of A and B (Primary Text: "This is some text. This is some additional text.")

Example 2:

• Artefact A (Primary Text: "This is some text.")

  • Artefact B (Primary Text: picture_1.jpg)

• ReqIF: Contains only Artefact A with merged content of A and B (Primary Text: "This is some text." <object = picture_1.jpg>)

Example 3:

• Artefact A (Primary Text / Heading: "This is some heading.")

  • Artefact B (Primary Text / Heading: "This is some additional heading.")

• ReqIF: Contains only Artefact A with merged content of A and B (Primary Text: "This is some heading. This is some additional heading.")

Example 4:

• Artefact A (Primary Text: "This is some text.")

  • Artefact B (Primary Text: picture_1.jpg)

    • Artefact C (File: myDoc.pdf)

• ReqIF: Contains only Artefact A with merged content of A and B and C (Primary Text: "This is some text." <object = picture_1.jpg> <object = myDoc.pdf>)

ReqIF Ranking

14

Idea History

This idea has been copied from the following RFE:

https://jazz.net/jazz03/web/projects/Requirements%20Management#action=com.ibm.team.workitem.viewWorkItem&id=138098

Creation date of original RFE:

Oct 8, 2020