Open ReqIF requirement files
4 min read
last updated: 03/25/2022
ReqEdit is used to display contents of ReqIF requirement exchange files including attachments and images in ReqIF Arhive files. ReqIF requirement objects and hierarchy structure is displayed but internal UUIDS, attribute types, specification attributes, object attributes and relations all can be also viewed.
For experienced users the XML Editor add-on can display the source code of the ReqIF file.
If you become a .zip file including ReqIF and attachements, open the zip file in the ReqEdit without extracting it.
On the main menu select File > Open or press CTRL + O and then select the ReqIF file.
Supported ReqIF file extensions: .xml .rif .reqif .zip .reqifz
All containing specification documents are displayed as tabs in the tab bar.
Compatible ReqIF files
If the file is not a standard ReqIF file but ReqEdit can import it a popup will notify the user. Import wizard will be started and after a couple steps the file will be opened.
Multi ReqIF Archives
If the opened document is an archive format .reqifz or .zip and contains multiple ReqIF files a popup notification will let the user select the files to open
In case of any ReqIF errors, ReqEdit will try to identify the errors and using XML Editor Add-on, the errors can be corrected.
ReqIf file structure
ReqEdit follows ReqIF standard on all levels. It will display contents of ReqIF files from structural to attribute definitions.
atomic data types: boolean, date, enumeration, int, float, string, xhtml
uses the basic attribute type definitions with optional restrictions: min, max, length, can be defined for objects and specifications also
collection of attribute types that are grouped together
uses a specific object type and has values for each attribute
value objects for attributes of objects or specifications
a collection of object types and specification attributes
uses a single specification type
requirement object structure inside a specification
links between the objects
ReqIF requirements are grouped into specification documents, these are displayed in the tab bar. Each opened ReqIF file will have its own random color to indicate that the files are together.
Each specification document has its own object structure which is shown in the navigator tab.
The navigator can be used to quickly jump to a specific section in the specification document.
Automatically generated for each ReqIF.ChapterName which are used as headlines, depth is determined by child objects
Each row in the main content area is an object that has a Main Content and additional attributes. Objects are displayed as follows
First column of the grid is a frozen column, which means that the user will always see the column, even if the document will be scrolled horizontally.
Displays the following states:
- unchanged – marked with white color
- edited – marked with light green
- edited and saved – marked with light blue
- links – marked with link icon
- internal links
- external links
- URI / OSLC
- Inward / Outward
- red – soft deleted (can be recovered)
Double-click on the icon. The attached file will be opened by the installed applications on the machine.
Object attributes are displayed as columns inside the data grid. The default column layout starts with Main Column then the rest of the object attributes defined in the specification.
By default all attributes are displayed in the specification as texts
Displays the the main ReqIF attributes: ReqIF.ChapterName, ReqIF.Name, ReqIF.Text as a single cell where
ReqIF.ChapterName – is displayed as Headline and will be auto numbered, displayed in the navigator
ReqIF.Name – displayed in the content area as text
ReqIF.Text – displayed in the content area as text
The main column rendering can be customized in the Settings > Document menu
All columns can be set hidden / visible by right clicking on the column name row.
Attributes used in the current specification document can be displayed by opening Setting > Document and selecting the Attributes tab.
Filtering and Sorting
Temporary use filtering or sorting. These settings are not saved.
Columns can be sorted ascending or descending by right clicking the column headers.
Filters can be constructed by the toolbar icon, then later edited or deleted.