Embedding RMsis Information in Confluence using Macros

Owned by Sanjay Sahani
Last updated: Nov 09, 2012

RMsis provides the following categories of macros for embedding information in confluence :

  • Single Macro : Using this macro, a single requirement can be imported from RMsis into Confluence.
  • List Macro : Using this macro, a group of entities (e.g requirements, test cases, releases, test runs) can be imported from RMsis into Confluence.

Following table summarizes list of macros supported by RMsis :- 

S.No.Macro NameDescription
1RMsis RequirementEmbeds details of a requirement in confluence.
2RMsis Planned Requirement ListEmbeds list of planned requirements; based on filter selection in confluence.
3RMsis Unplanned Requirement ListEmbeds list of unplanned requirements; based on filter selection in confluence.
4RMsis Release ListEmbeds list of releases; based on filter selection in confluence.
5RMsis Test Case ListEmbeds list of test cases; based on filter selection in confluence.
6RMsis Test Run ListEmbeds list of test runs; based on filter selection in confluence.
7RMsis Traceability ListEmbeds traceability table; based on filter selection in confluence.
8RMsis Reverse Traceability ListEmbeds reverse traceability table; based on filter selection in confluence.

Using Single Macro 

In order to use any single macro (planned OR unplanned requirement) process is similar. The example below, demonstrate embedding a single planned requirement into confluence.

  • Open a page in Confluence in edit mode
  • Click on "Insert" menu and select "Other Macros" from document menu (OR press key board short cut "Ctrl+Shift+A").
  • Search for "RMsis" in search bar and select "RMsis Requirement".

  • Click on "RMsis Requirement" macro
    1. Specify requirement ID in "Requirement Key" field.
    2. Specify version of requirement to be displayed in "Requirement Version" field. 
    3. Select "Requirement Display Type" as "Full" OR "Brief".
      1. "Full" option will show all attributes of requirements
      2. "Brief" option will display requirement ID and summary.
    4. Select "Content Type" as "Static" OR "Dynamic".
      1. "Static" option will display contents and will not change even if contents are changed in RMsis.
      2. "Dynamic" option will update the contents in confluence page as soon as they are changed in RMsis.
    5. Click on "Insert" button to insert macro.

Using List Macro

In order to use RMsis list macro, user needs to define a Named Public Filter in RMsis , as described here :  http://docs.optimizory.com/display/preview/Named+Filters).

The example below, demonstrates embedding of planned requirements in confluence using RMsis Planned Requirement List macro.

  • Open a page in Confluence in edit mode
  • Click on "Insert" menu and select "Other Macros" from document menu (OR press key board short cut "Ctrl+Shift+A").

  • Search for "RMsis" in search bar

  • Select "RMsis Planned Requirement List" macro.
    1. Specify JIRA project key in "Project Key" field.
    2. Specify name of filter from RMsis "Planned Requirement Named Filter" in "Filter Name" field.
    3. Click on Refresh.
    4. The table corresponding to Filter will be displayed.
    5. List the comma separated name of columns to be displayed in "List of Columns to Display" field. These column names can be picked up from the "Table Preview".
    6. Select "Content Type" as "Static" OR "Dynamic".
      1. "Static" option will embed current contents and will not change even if contents are changed in RMsis.
      2. However "Dynamic" option will update the contents in confluence page as soon as they are changed in RMsis.

    7. Click on "Insert" button to insert macro.