ReqSuite® Requirements Manager (RM)
MS Word Templates

For the purpose of an appealing visualization of project information, ReqSuite® RM provides powerful mechanisms to export the content from its database to MS Word cocuments. For this purpose, one or more MS Word documents acting as templates can be attached to a certain project template.

A MS Word document being such a template is a normal .docx-file whose apperarance can be completly designed according to the corporate design and required chapter structure. On certain places in this document, variables of ReqSuite® RM’s word generation syntax have to be included that are dynamically replaces with by project contents during document generation.

The definition of the MS Word document template is done in the following steps.

Defining the Content Structure

In this initial step, the overall structure of the document is defined. For this purpose a normal word file is created in MS Word and filled with static content such as the desired chapter structure, the cover page, page numbers, logos, introductory remarks, etc.

Defining the Layout and Visual Appearance

In this second step, the visual appeareance of the contents to be displayed in documents based on this MS Word template has to be defined. This works by using the inbuilt styling functionality of MS Word for paragraphs and tables. In particular the following styles must be modified or created.

Heading styles for chapters and sub chapters

The default headings of the MS Word document can be used or specific headers such as ReqSuiteHeading1, ReqSuiteHeading2, … can be created from scratch. However, the names of these headings must not contain umlauts (e.g. no “Ü”) as this is not understood by the generation engine.

Default paragraph style

This default style “Standard” being part of the MS Word document needs to be adapted to the desired format as it will be applied for every text generated by ReqSuite® RM (even text in table cells).

Table styles

In order to display tables generated by ReqSuite® RM, two table styles have to be created from scratch in the given MS Word document.

  • “ReqSuiteTableTemplate” for 2-column tables in which the first column shall contain the labels and the second the actual data
  • “ReqSuiteDynamicTableTemplate” for n-column tables in which the first row shall contain labels and the other rows the actual content
Caption style

For displaying figure captions automatically generated by ReqSuite® RM, a caption called “ReqSuiteCaption” must be defined in the MS Word document.

Defining the Representation of Individual Content Elements

For exporting project content from the ReqSuite® RM database, variables (so-called “markers” or “tags”) must be included at the appropriate places in the MS word document (see Figure 1). While ReqSuite provides a number of predefined tags such as ###HISTORY## or ###VERSION##, most tags are custom and based on the categories and attributes defined in the associated project template.

Figure 1: Example of a MS Word document template with ReqSuite® tags

In particular, the content of the different defined categories can be exported as individual descriptions according to the defined input form (using the ###…:INSTANCES### tag), tables (using the ###…:TABLE### tag) and lists (using the ###…:LIST### tag). Furthermore, there are tags to export attached images (using ###…:INSTANCEMODELS### tag), related elements (using ###…:INSTANCES WITH RELATED …###) and those for filtering, grouping, and sorting.

Examples

Imagine that a project template contains three categories called “Components”, “Requirements” and “Test Cases” with attributes, images, relationships and workflows. Among many other things (see the table at the bottom of this page), the following exemplary ways of representing the elements of these categories in a generated MS Word document are possible.

###REQUIREMENT:INSTANCES###Export of all requirements of the project according to the defined input form for the category “Requirements”
###REQUIREMENT:TABLE WITH ID, NAME, DESCRIPTION###Export of a table including all requirements of the project with their IDs, names and descriptions
###COMPONENT:INSTANCES ON Heading1 WITH RELATED REQUIREMENTS:TABLE ID, NAME, DESCRIPTION###Export of all components of the project (each in an own chapter on level 1) according to the defined input form for the category “Component” followed by a table of all requirements related to the corresponding component with their IDs, names and descriptions
###REQUIREMENT:INSTANCES [STATUS=accepted] WITH INSTANCESMODELS WITH RELATED TEST CASES###Export of all requirements of the project whose status is accepted according to the defined input form for the category “Requirements” with their images (if attached) and the related test cases according to the defined input form for the category “TEST CASES”
List of Tags

The following table shows all document tags that can be used in the MS Word templates for automatically generating documents from ReqSuite® RM.

ReqSuite Document MarkupContent Pasted Into Document
###PROJECT NAME###Name of the project.
###AUTHOR###First and last name of the person who triggered the document generation.
###TEAMMEMBERS###All persons with first and last names assigned to the project as users in any role.
###PROJECTLEADERS###All persons with first and last name assigned to the project in the “ProjectAdmin” role.
###VERSION###Baseline number of the project on which the document was generated.
###VERSION CHANGES###Changes of the current baseline to previous baselines.
###HISTORY###Table with history information about the different baselines of the project.
###CURRENT DATE (+<DAYS>)###Today’s date (or future date, which is anticipated in days after a certain period in days from today’s date).
###STATISTICS###Project statistics.
###OPEN ISSUES###List of all open clarification points.
###ALL COMMENTS ([<FILTER_ATTRIBUTE>{=|<>|<|>|<=|>=} <FILTER_VALUE>])###List of all comments across all elements (restricted according to the given filter attribute and filter value referring to the elements that include comments).
###ATTACHMENTS ([<FILTER_ATTRIBUTE>{=|<>|<|>|<=|>=} <FILTER_VALUE>])###List of all attachments across all elements (restricted according to the given filter attribute and filter value referring to the elements that include attachments).
###CONTENT PROBLEMS (WITH <ATTRIBUTE>)###Result of the quality checker results (including value of the attribute of the corresponding content elements).
###CONFIGURATION HANDBOOK (ON <FORMAT_TEMPLATE>)###Generates a manual of the project configuration on which the project is based (in a section according to the specified format template (e.g., Heading1)).
###<TYPE>:DOCUMENT###When generating documents based on a template including this marker, a ZIP file is exported containing one Word export for every element of the content type.
###DOCUMENT CHANGES###Changes of a particular document generated with the ###<TYPE>:DOCUMENT### marker to its previous version.
###DOCUMENT VERSION###Version of a particular document generated with the ###<TYPE>:DOCUMENT### marker.
###ENABLE INTERNAL LINKS###References from one element description according to the marker “<TYPE>:INSTANCES” to another element description are exported as clickable hyperlinks in the document.
###<TYPE>:OVERVIEWMODEL###Graphical overview notation of all content elements of the content type.
###<TYPE>:DEFINITION###Stored definition of the content type.
###<TYPE>:INSTANCEMODELS (ON <FORMAT_TEMPLATE> (INCLUDE ID))###Detailed visualizations of all content elements of the content type (with headings for each content element according to the format template (including “ID”)).
###TRACEABILITYMATRIX WITH <TYPE_1>, <TYPE_2>###Traceability matrix showing the relationships in pairs between all content elements of both content types.
###<TYPE>:<ATTRIBUTE>(:{SUM | AVG | MIN | MAX}) ([{<FILTER_ATTRIBUTE>{=|<>|<|>|<=|>=} <FILTER_VALUE> | ID=*}])###Attribute value of the first content element found (and/or sum / average / minimum / maximum attribute values (if number and/or date) of all content elements) of the content type (restricted according to the filter attribute and filter value, or to the ID of the content element to be exported with ###<TYPE>:DOCUMENT###).
###<TYPE>:INSTANCES(+) (HIDETEMPLATE) (WITH INSTANCEMODELS) (WITH RELATED {HIERARCHY | CHILDREN}) ([{(DIRECT) <FILTER_ATTRIBUTE> {=|<>|<|>|<=|>=} <FILTER_VALUE> | ID=*}]) (ON <FORMAT_TEMPLATE> (INCLUDE ID)) (WITH (ALL) RELATED <RELATED_TYPE_1>{(:TABLE (WITH <ATTRIBUTE_1>, …)), (WITH INSTANCEMODELS)}([(DIRECT) <FILTER_ATTRIBUTE> {=|<>|<|>|<=|>=} <FILTER_VALUE>]), … (,ATTACHMENTS) (,COMMENTS))###Detailed descriptions of all content elements of the content type according to the defined structure (with workflow status and element version) (without output of the description template) (with detailed visualizations according to the defined notation) (with {all hierarchically, transitively linked elements | only with linked elements of the same type}) (with restriction of value selection for output calculation according to filter attribute and filter value) (with headline for each content element according to the format template (including “ID”)) (with associated content type(s) according to naming (each as table of respective content elements with all attributes / only with “ID” and “Description” / only with “ID”, “Name” and “Description” or named attribute(s) (with associated attachments and comments))
###<TYPE >:LIST (WITH <ATTRIBUTE_1>, …) ([(DIRECT) <FILTER_ATTRIBUTE> {=|<>|<|>|<=|>=} <FILTER_VALUE>])###Dash list of all content elements of the specified content type with “ID” and “Name” attributes (or enumerated attribute(s)) (with value selection restriction for calculating the output according to filter attribute and filter value).
###<TYPE>:TABLE WITH <ATTRIBUTE_1>(|<DESIGNATION>), … (,RESPONSIBLE_USER) (,LAST_EDITOR) (,TEMPLATE) (,RELATED_COMMENTS) (,RELATED_ATTACHMENTS) (,INSTANCEMODELS) (,LAST_CHANGE) (,DEADLINE) (,CREATION_DATE) ([(DIRECT) <FILTER_ATTRIBUTE> {=|<>|<|>|<=|>=} <FILTER_VALUE>]) (({DIRECT|ALL}) <TYPE2> (([<TYPE2>.<FILTER_ATTRIBUTE> {=|<>|<|>|<=|>=} <FILTER_VALUE>]))###Table of all content elements of the specified content type with named attribute(s) (and alternative identifier(s) in the table header) (, with naming of the responsible user) (, with naming of the last editor) (, with detailed description) (, with related comments) (, with related attachments) (, with instance models) (, with date of last change (, with deadline date) (, with date of creation) (, with restricted value selection for output calculation according to filter attribute and filter value) (, with direct or all related elements of another content type) (restricted according to the filter attribute and filter value, or to the ID of the content element in the project or in the database).

Legend for table:
<…> Variable value
(…) Optional value
{…|…} Alternative values
[…] Regular brackets as part of filters

For more hands-on details on the document definition features of ReqSuite, please take a look at the following tutorial video: