Edit ReqIF requirement files

ReqEdit Online Documentation

Edit ReqIF requirement files

7 min read
last updated: 08/24/2021

ReqEdit presentation video

Why to edit ReqIF files?

Requirement Interchange Format is the de facto standard for lossless requirement data exchange for any industry.

ReqIF simplifies the workflow of requirements exchange between suppliers and vendors in all industries. Mainly driven by the automotive industry.

ReqEdit was built from the ground up to aid the participants of the supply-chain to quickly use ReqIF files without the need for complex ALM/PLM software solutions. This is becoming ever more important with the digital transformation in more and more industries.

ReqIF based interchange offers seamless integration of supply chains in all industries making collaboration more standardized and efficient.

ReqEdit is the easiest tool for ReqIF editing. Creating, comparing and merging requirements and specification documents with powerfull add-ons.

Large companies rely on lossless data exchange

ReqIF format simplifies and streamlines the data exchange of requirements between companies or departments and also on the management level. ReqEdit has multiple licensing models to support corporate environments and use cases.

Medium or small size companies needs cost effective solutions to participate in the supply-chain

ReqEdit is available as a standalone application. No other dependency is required. Cost effective solution for processing ReqIF requirement files.

ReqIf file structure

ReqEdit follows ReqIF standard on all levels. It will display contents of ReqIF files from structural to attribute definitions.

ReqIF format

Attribute Types
atomic data types: boolean, date, enumeration, int, float, string, xhtml

Attributes
uses the basic attribute type definitions with optional restrictions: min, max, length, can be defined for objects and specifications also

Object types
collection of attribute types that are grouped together

Objects
uses a specific object type and has values for each attribute

Values
value objects for attributes of objects or specifications

Specification Types
a collection of object types and specification attributes

Specifications
uses a single specification type

Hierarchy
requirement object structure inside a specification

Relations
links between the objects

Edit ReqIF files

ReqEdit supports simple ReqIF files .reqif and ReqIF Archives .reqifz. Use File > Open or CTRL+O to open any supported ReqIF file. In case of compatible files ReqEdit will try to import the file.

Create ReqIF files

Create new a new ReqIF file .reqif or an archive with attachments as .reqifz

ReqIF (.reqif)

No attachments

CTRL+N

ReqIF Archive (.reqifz)

Can have attachments

CTRL+SHIFT+N

A template list will popup will ask for a specific template to use for the new file. For more information on templates, please read the Templates section.

New Archive

ReqIF Archive supports attaching external images or files to any requirement. Creating a new archive will show a window asking for a filename.

Objects

Double click on any cell to edit the contents.

Edit any object in the content area by double clicking on the cell. An inline editor will appear for XHTML attributes or corresponding checkboxes or date pickers or single inputs for other data types.

To close the inline editing, click away on any other cell.

XHTML content editing is a powerful feature, text formatting is possible from the quick action icons or the right click context menu.

ReqEdit in inline editing mode, editing main column ReqIF.Text attribute

Single valued enumeration will show a dropdown selector

Multivalued enumeration attributes are displayed as a list of checkboxes

Dates will show datepicker

String types editing as simple text

Boolean values editing as checkboxes

Integer and float types will only store numerical values

Inserting objects

New objects can be created on the same level or as children to the current object. A new generic object will be displayed as an empty line or with default values.

Spec Objects in ReqEdit are threated the same in a single document. Spec Object types currently cannot be edited and are created automatically.

Add new object as child will create a new row in the table, below the selected line. It is a child in the tree hierarchy. A new empty line will appear. In case it is editted it will look like this:

ReqEdit displaying context menu, highlighted are the insert object menu items and the top quick action icons

Deleting objects

ReqEdit uses soft-deletions, delete will not remove objects from the ReqIF file.

Delete the selected object by selecting the row and pressing DEL or by right click menu or by the quick action icons.

ReqEdit displaying context menu, highlighted are the delete menu items

This function will place the removed object into a deleted state.

ReqEdit displaying deleted objects with red status indicator, highlighted is the show deleted objects icon in the top bar

Restoring deleted objects

A deleted object can be restored by selecting it and clicking on the „Restore deleted objects” button from the toolbar or by right clicking the object and selecting the Restore menu item.

Purge deleted objects

Removing objects with all attachments from a ReqIF file, can be done using PURGE. Can be found on delete toolbars and right click menus.

Once purged, objects cannot be recovered. Auto-backup feature will have 10 snapshots for recovery.

There are two methods for cleaning up deleted objects, by purging a single deleted object or purge all the deleted objects in the entire specification document.

Copy and move objects

Object can be created also by cut-copy-pasting already existing ones. Pasting can be done before / after or as a child object of another object. Right click the desired location and paste the copied object.

If a copied object contains links, on paste, a notification will ask what to do with the existing links.

If the object has child elements, these will also be copied or moved.

ReqEdit copy-paste menu items

Copy paste in the Navigator

In the object navigator copy paste works in the same way.

ReqEdit allows copy pasting in the navigator by right clicking the tree menu items

Use drag and drop to move objects

Object can be created by CTRL+Drag and release at the desired location

Editing Hierarchy

The hierarchy of objects can be changed by using the promote and demote functions. Can be found in the quick action icons, and in all right click context menus.

Promoting

Will move the object one level up in the hierarchy.

Demoting

Move the object one level down as children in the hierarchy

If you promote or demote an object which has child objects, all the hierarchy of the object will be affected by the operation, promoting or demoting all the child objects along with the parent object.

Main column

Is a combined cell displaying the most important ReqIF attributes: ReqIF.ChapterName, ReqIF.Name, ReqIF.Text

In this cell, the main fields of the document can be edited at once. These fields are XHTML type attributes.

Double click the main column of an object will display an inline XHML editor with 3 tabs. One tab for each attribute.

ReqEdit displaying the inline editor of the main column where ReqIF.Text is selected, highlighted are the editing context menu and toolbar

Columns

Mass update attributes

Update multiple rows with a specific attribute value.

The mass update function is designed to be used together with the filtering. This way, a set of objects can be selected according to specific criteria and updated at the same time.

The mass update function is not available for the main column

ReqEdit displaying the mass update menu item by right clicking the column header
Mass update popup window showing options

Default values

Each attribute can have a default value defined in the “Document settings” section by selecting an attribute and accessing the “Attribute editor”.

If a cell has a different value, the default value can be set back for each attribute of a row by right-clicking the corresponding cell in the grid and selecting the “Set default value” menu item.

Attachments

ReqIF Archive .reqifz files supports having attachments for objects.

Only XHTML attributes can have attachments inside .reqifz files

Image attachments:

png, bmp, jpg, gif, ico, wmf,

File attachments:

any file type is supported

pdf, doc, docx, xls, xlsx …

Open attachments

Double-click on the icon. The attached file will be opened by the installed applications on the machine.

Inserting attachments

To add an attachment simply right click the XHTML inline editor area and select Insert image or Insert file

ReqEdit displaying context menu, highlighted is the insert image and file menu item
ReqEdit displaying attachment previews of an object, contains file icons and preview images

Tables

XHTML attributes by definition can have also tables. All tables are rendered inside cells.

ReqEdit displaying tables inside XHTML attributes

Editing XHTML table structure can be done by the inline editor right click menu.

Saving ReqIF files

If your file is a multi-document file, saving one of the documents will also save the changes made in the other documents of the ReqIF file.

NOTE: Changes on linked documents (e.g. Images or Word, Excel) are not detected. Make a content change to trigger update and enable saving.

Save as

Save the currently edited file as a new filename. Contents will be identical to the original one.

Closing files

ReqEdit can close only saved files. If there are any unsaved changes, a notification will display and ask to save files before closing.

Use CLOSE ALL to clean up the editor.