Coupling NI Requirements Gateway with Microsoft Word

Publish Date: Aug 14, 2013 | 0 Ratings | 0.00 out of 5 | Print | Submit your review

Overview


 


Coupling Series Home


Microsoft Excel


Note: This document applies to NI Requirements Gateway versions 1.1 and earlier. For information on newer Requirements Gateway versions, refer to the Coupling External Applications with NI Requirements Gateway topic in the NI Requirements Gateway help.

Due to its widespread adoption as the de facto standard in word processing, Microsoft Word is a common choice for requirements specification and coverage in engineering projects. This document details the ease of integrating Microsoft Word documents into your NI Requirements Gateway projects.

Table of Contents

  1. Microsoft Word Types
  2. Specifying Requirements in Microsoft Word
  3. Specifying Coverage in Microsoft Word
  4. Additional Resources

1. Microsoft Word Types

NI Requirements Gateway includes three Word-compatible types, each designed to be used in different scenarios.

Word Type

The Word type captures traceability information from a single Word (.doc) file. This type does not support Word 2007 (.docx) files, but you can use Word 2007 in compatibility mode to open Word 2003 or earlier (.doc) files. Use the WordX type for Word 2007 files.

 WordX Type

The WordX type captures traceability information from a single Word 2007 (.docx) file.  This type exists in NI Requirements Gateway 1.1 and later.

 MultiWord Type

The MultiWord type captures traceability information from multiple Word (.doc) files in a single parent directory. The MultiWord type analyzes all the Word files located in any subdirectories of the parent directory.  The views in the main window display the parent directory, any subdirectories, and all Word files and their elements.

Back to Top

2. Specifying Requirements in Microsoft Word

Coupling NI Requirements Gateway with Microsoft Word is made significantly easier by capitalizing upon the functionality of Microsoft Word styles

Sections in a specifying document written in Microsoft Word can be designated using styles entitled Heading 1, Heading 2, and Heading 3.  When designating requirements in a specification document, any text that you associate with a Microsoft Word style entitled Requirement_ID will be interpreted by NI Requirements Gateway.  The Requirement_ID style is not a default Microsoft Word style, but you can use Word’s Styles Window, as show in Figure 1, to manage, inspect, and preview styles.

Figure 1 - Microsoft Word styles make it easy to designate requirements IDs, Text, and Coverages

As long as the style is designated Requirement_ID, NI Requirements Gateway will interpret the text as the ID of a requirement.  Though National Instruments does recommend an example default syntax for requirements specification, documents that specify requirements in Microsoft Word and capitalize upon Word styles can use any font, size, color, and syntax for requirements to suit their applications needs, as the attributes of the text don’t affect the recognition of requirements.  If requirements specified include both requirement IDs and labels, users should simply separate the requirement ID and label with a colon ( : ). 

Within the text of the requirement, you can optionally specify priority and allocation attributes to designate the severity of the requirement and the engineer to whom the requirement has been delegated using the text Priority: and Allocated to: respectively.

Similarly, detailed text describing requirements can be specified using a style called Requirement_Text style.

Figure 2 - Example requirements specified in Microsoft Word

Figure 3 - NI Requirements Gateway parses the above requirements and displays them in the Management View

As with all types in NI Requirements Gateway, advanced users can customize the Word and WordX types to read different syntactical requirements ID specifications.

Back to Top

3. Specifying Coverage in Microsoft Word

References contained in Microsoft Word covering documents should use syntax to define coverage of requirements.  The default syntax for specification of coverage in Microsoft Word is as follows, where reqid is the requirement ID of the requirement being covered:

[Covers: reqid]

If you have a particular covering document that implements multiple requirements, you can specify a comma-separated list of requirements covered.  For example:

[Covers: REQ001, REQ003, REQ007]

To simplify the coverage specification process, NI Requirements Gateway gives users the ability to copy requirements for coverage using Microsoft Word.  When you select Copy For » Word Coverage  from the right-click context menu, NI Requirements Gateway places the appropriate coverage string for the requirement ID in the system clipboard so that the user can simply paste the coverage into Microsoft Word and doesn’t need to worry about syntactical mistakes.

Figure 4 - NI Requirements Gateway can automatically generate the appropriate coverage string for Microsoft Word covering documents

As with all types in NI Requirements Gateway, advanced users can customize the Word and WordX types to read different syntactical requirements coverage specifications.

Back to Top

4. Additional Resources

NI Requirements Gateway

Download Free Evaluation Software

 

 

Back to Top

Bookmark & Share


Ratings

Rate this document

Answered Your Question?
Yes No

Submit