ReqSuite® Requirements Manager (RM)
Template Definition

The template definition aims at the creation of typesetting and table templates, which are ultimately mapped for the textual description of content elements in the course of the actual data collection process. To do this, select an existing content type in the corresponding list of the “Categories” view and click on the “Template” tab button. If the option “Textual description template required” is not activated for this category, it is not possible to create a description template. If this is not the case, you can create a description template in the form of a table or in plain text for this category, depending on how the elements of the content type are ultimately to be described.

  • Tabular template: To define a description template in tabular form, click on the tab “Tabular template”. The two-column table template currently defined for this category is loaded, whereupon the following functions are available to you for its adaptation:
    • Add a table row: Select any attribute in the left attribute list and drag and drop it to the desired position as the row of the table template. The attribute name is now included in the left cell and its value in the right cell as text elements of the new table row.
    • Rearrange a table row: Select the respective row in the table template and click on “Move up” or “Move down” in the table header depending on whether you want to sort the row one position up or down.
    • Delete a table row: Select the respective row in the table template and click on “Delete row” in the table header. A query dialog opens in which you can confirm the deletion process by clicking on “Delete” or end the process without effect by clicking on “Cancel”.
    • Deleting the template: In the case of large table templates with an excessive number of rows and complex entries, the entire contents of the table can be removed from the system at once by clicking the “Delete all contents of template” button.
Figure 1. Description template of a category

Note: Never use the same variable twice within a template and think of spaces between variables and static text modules, otherwise everything will be lined up during document generation. Furthermore, you can avoid having two variables follow each other directly without inserting a unique static text in between. Variables with a predefined response area (enumerations) are an exception.

  • Adding a text element: When adding a text element to the template, a basic distinction must be made between dynamically generated attribute values and static description and fill texts.
    • Attribute value: Select the respective attribute in the left attribute list and drag and drop it to the desired position in the right cell of an existing row of the table template before or after a text element or, if the row does not contain a text element, into the middle of the table row. This means that the attribute value is included as a text element in the right cell of the table line and dynamically filled with concrete values at runtime.
    • Fill text: Select the respective text element in the right cell of an existing line of the table template where you want to insert a static text element and click on “Insert before” or “Insert after”.
  • Formatting a text element: Select the respective text element in the left or right cell of the relevant line of the table template and click on “Bold B” or “Italic I” depending on how you want to format the text element.
  • Editing a text element: Double-click the respective text element in the right or left cell of the relevant line of the table template. An editing dialog opens in which you can adjust the text element value. Inserted attribute values are excluded from editing.
  • Rearranging a text element: Select the relevant text element in the right cell of the relevant row of the table template and drag it to the required position within the same cell of the table template.
  • Deleting a text element: Select the respective text element in the right cell of the relevant row of the table template and click on “Delete text element” in the table header. A query dialog opens in which you can confirm the deletion process by clicking on “Delete” or terminate the process without effect by clicking on “Cancel”. It is not possible to delete a text element in the left cell of a table row.
Figure 2. Category description template

Note: The specification documents and templates stored in the course of model refinement and template definition including document definition should support you in the data collection process within the scope of concrete project work. For this purpose, you can call them up in the plug-in using the Process Guide at any given point via hyperlinks within work instructions or alternatively at any time via the menu bar item “Manuals and checklists”.

  • Textual template: To define a description template in purely textual form, click the “Textual template” tab button. The sentence template currently defined for this category is loaded, whereupon all the functions mentioned in a tabular template with regard to text elements in the right cell of a table row are available for selection with the exception of all row operations such as adding, deleting and rearranging a row to adapt the sentence template.

Note: When editing description templates, make sure that the corresponding message “Template saved” is displayed in the WebApp to ensure that your changes have been applied correctly.