Mark requirement fields

After placing your data as paragraphs or as tables, you must mark your requirement fields. To mark a requirement field, highlight the text and click the appropriate button on the ALM Requirements toolbar. An icon is added next to the marked text line. A bookmark is inserted into the document to allow the add-in to identify the marked text when it is exported to ALM.

When marking requirement fields, consider the following:

  • For each requirement, the requirement name must be provided. You can also export the requirement type, review status, author, priority, description, and rich text. In addition, if you export the requirement type, you can export data for user-defined fields available for the type.

  • If a requirement with the same name exists in the requirements tree, the fields of the requirement are changed to contain the new values. If your document contains two requirements on the same hierarchical level with the same name, only the second requirement is created.

  • If the review status is not provided, the default value is Not Reviewed.

  • The data for each field should be on the same line as the icon that marks it. The only exceptions are the Description field, memo user-defined fields, and rich text.

    • Data for the Description field can extend to additional lines and can include returns and indents.

    • Data for memo user-defined fields can extend to additional lines but only the first line is exported to ALM.

    • Rich text data can include any content that you can include in a regular Word document. When rich text data are exported to ALM, the rich text data are added as an attachment to the requirement. The attachment is named Legacy_Rich_Content.doc.

      Note: With every additional export of this requirement to ALM, the Legacy_Rich_Content.doc file is overwritten.

  • Data intended for ALM fields that have selection lists must match the entries in those selection lists exactly. For example, the Priority field can only accept one of the following entries: 5-Urgent, 4-Very High, 3-High, 2-Medium, or 1-Low.

  • You cannot export data for user-defined fields that do not exist in the ALM project, or which are not available for the requirement type.

To mark the requirement fields:

  1. Open a Word document containing requirement text.

  2. You can use the Structure Checker to ensure that you do not insert bookmarks that invalidate the structure. For example, the Structure Checker makes sure that you do not add more than one name to a requirement, or close a requirement before you have opened it. To switch the Structure Checker on or off, in the ALM Requirements toolbar, click the Turn On Structure Checker button or Turn Off Structure Checker button.

  3. Highlight a text line or a table cell in your document, and click the appropriate button in the ALM Requirements toolbar:

    Field Toolbar Button Icon
    requirement name
    review status of the requirement
    author of the requirement
    priority of the requirement
    Description of the requirement
  4. To assign a requirement to a type, add and highlight a new text line in the data for the requirement, or add a new table column and highlight the cell in the new column corresponding to the requirement. In the ALM Requirements toolbar, in the Type box, select a requirement type. Click the Type button to add the requirement type to the document. The requirement type is added and is indicated by the Requirement Type icon .

  5. To assign a value to a user-defined field, highlight the text line or table cell in your document containing the value. In the ALM Requirements toolbar, in the Field box, select a user-defined field. Click the Field button to mark the value with the User Defined Field icon .

  6. To add rich text to be exported to ALM, highlight the rich text and click the Open Rich Text button. The Open Rich Text icon is added to indicate the beginning of the rich text.

    Place the cursor at the end of the rich text you want to add and click the Close Rich Text button. The Close Rich Text icon is added to indicate the end of the rich text.

  7. Repeat for all requirement data. Any text in the document that is not marked is ignored.

  8. Click the Close Requirement button to close each requirement with the Close Requirement icon . The location of this mark depends on whether the requirements are on the same hierarchical level or on different hierarchical levels.

    For more information, see Example: requirements on the same hierarchical level or Example: requirements on different hierarchical levels.

  9. To unmark one or more fields, use the undo buttons or remove the mark manually. For more information, see Delete formatting from Word document.

  10. When all requirement fields have been marked, export the requirements to ALM. For more information, see Export data to ALM.

Back to top