ReqIF_Import_Tutorial - Helmut-Ortmann/EnterpriseArchitect_hoReverse GitHub Wiki

ReqIF Import Tutorial

It took me a while to get things working. Here you find some ideas to get the import from your beloved Requirement Tool to work.

If you have experiences or advice, don't hesitate to contact me. You may also validate the ReqIF.

See:

Quick Import

  • Configure Settings.json as specified in Import Specification
  • Create Folders:
  • Open EA ReqIF Tutorial ReqIfTutorial.eapx with EA
  • hoReverse Add-in: Do, Import ReqIF, 01: My ReqIF Import specification, see picture
  • Results:
    • updated EA Model (ReqIfTutorial.eap)
    • c:/Temp/ReqIF/Store/01/.. The files which are part of the requirements
    • See the original made with DOORS ReqIF_Import.reqifz

GUID

You need to insert the EA Package GUID (e.g. {3EF72685-0CE0-469f-B82B-4267E494FAE4}) of the Specification/Module into the Import/Export -Specification (ExportModule1, ModuleA, ModuleB respectively). You get the Package GUID by:

EA Projekt-Browser, Select Package, Right Click, Copy / Paste, Copy Node GUID to Clipboard

Change Settings

See: - Settings Import, Roundtrip, Export

hoRverse, File, Settings, ReqIF,....

You may need to configure the extension *.json to your favorite editor.

or Edit

c:/users/<user>/AppData/Roaming/ho/hoReverse/Settings.json

Result

See in EA:

  • Project Browser
    • Packages
      • 2 ReqIF Modules/Specifications with Requirements
  • Properties of Requirements
    • Name
    • Notes
    • Linked Documents
    • Tagged Values
  • Generated Tagged Value Types for enums (single value or multiple values)

EA

Tagged Value Types

For Enums you need to define Tagged Value Types:

  • Ribbon: Configure, UML Types
  • Tagged Value Types

Approach

The general approach is to import from your beloved Requirement Tool and see how hoReverse converts it into EA and its

  • Tagged Values
  • TaggedValue types for enums
  • Linked Documents
  • Notes
  • Names

Procedure:

  • DOORS: Export ReqIF (format: *.reqifz, zipped ReqIF with embedded files/images)
  • ReqIF Studio: Import ReqIF to check the ReqIF export
  • EA: Create Package for Module
  • EA: Get GUID from creating Package of DOORS Module
  • EA: Add Import specification to settings.json and update GUID
  • EA: Import
  • EA: Make your EA requirements according to the imported
  • EA: Add Export specification to settings.json and update GUID
  • EA: Export
  • DOORS: Import

Import Specification

See: Settings Import, Roundtrip, Export

The example you find in 'Resource/':

Add or edit c:/users//<user>/AppData/Roaming/ho/hoReverse/settings.json an entry behind:

"Importer":
  [
    {
          "Name"            :  "1. My ReqIF Import specification",
          "Description"     :  "My Tutorial ReqIF Import specification",
          "ListNo"          :  "1", 
          "InputFile"       :  "c:/Temp/ReqIF/Doors_Import.reqifz" ,
          "PackageGuidList" :  ["{3EF72685-0CE0-469f-B82B-4267E494FAE4}","{A6D555F6-7812-40bf-8150-EFD71F6A3121}"],
          "ObjectType"      :  "Requirement",
          "Stereotype"      :  "",
          "StereotypeDependency": "satisfy",
          "ImportType"      :  "DoorsReqIF",
          "StatusNew"       :  "Proposed",
          "RtfNameList"     :  ["ReqIF.Text"],
          "AttrNameList"    :  ["ReqIF.ForeignID", "ReqIF.Chaptername", "ReqIF.Text"],
          "AttrNotes"       :  "ReqIF.Text",
          "AliasList"       :  ["ReqIF.ForeignID"],
          "EmbeddedFileStorageDictionary" : "c:/Temp/ReqIF/Store/1/"
    }

Export Specification

See: - Settings Import, Roundtrip, Export

The example you find in 'Resource/':

Add or edit settings.json an entry behind:

"Importer":
  [
    {
          "Name"            :  "02: My ReqIF Export specification",
          "Description"     :  "My Tutorial ReqIF Export specification",
          "ListNo"          :  "2",
          "ExportFile"      :  "c:/Temp/ReqIF/export.reqifz" ,
          "PackageGuidList" :  ["{B408F6F3-A1F9-47f7-8AD4-CBE2284627D1}"],
          "ObjectType"      :  "Requirement",
          "Stereotype"      :  "",
          "StereotypeDependency": "satisfy",
          "ImportType"      :  "DoorsReqIF",
          "StatusNew"       :  "Proposed",
          "EmbeddedFileStorageDictionary" : "c:/Temp/ReqIF/Store/02/"
    }

Helpers

Useful to improve:

References

Naming conventiona

  • .reqif for a single ReqIF XML file
  • .reqifz for a ZIP achieve containing ReqIF files and additional files

Glossary

  • Attribute (ReqIF) With Attributes a Requirement may contain additional information stored in the Attributes. In EA this are Tagged Values.
  • EA Tagged Values are a UML/SysML compliant method to provide additional properties to UML/SysML elements and connectors. Here we use it to define arbitrary ReqIF Attributes to exchange with other tools.
  • GUID Universally unique identifier used by EA to uniquely identify an object
  • MCDF Microsoft Compound Document Format (used by DOORS embedded files)
  • Package The Package which contains the requirements. In terms of ReqIF its the Specification or in DOORS the Module.
  • ReqIF Requirements Interchange Format
  • ReqIF Roundtrip, often called ReqIF Workflow. The Standard how to exchange ReqIF requirements between two partners
  • ReqIF Standard of the OMG to exchange requirements between different tools, see OMG Specification
  • ReqIF Workflow: ReqIF workflow specifies how to exchange requirements between tools. Often called Roundtrip
  • ReqIF Tool: A tool that imports/exports ReqIF compliant XML documents
  • Requirements authoring tool: A tool to create and modifying requirements
  • Specification In ReqIF the container which contains the requirements. In DOORS it's named 'Module'.
  • SPICE Process Reference Model to assess process maturity.
  • Tagged Values UML/EA measure to add values to a classifier/requirement. For enumerations EA needs Tagged Value Types (Enum or Checklist).
  • Traceability

www.hoModeler.de hoTools, hoReverse, ScriptDotNet, ReqIF

⚠️ **GitHub.com Fallback** ⚠️