Confluence macros: displaying rmCloud requirements on a page

Confluence macros: displaying rmCloud requirements on a page

rmCloud Connector adds two macros to Confluence Cloud that display rmCloud requirements directly on a page. It is a companion to rmCloud for Jira rather than a standalone product: rmCloud must be installed on the same site, and the macros only display requirements that already exist in your rmCloud projects.

Both macros render the same table — ID, Name and Description — where the ID is the requirement's prefix followed by its display ID, for example R-14.

Linked rmCloud Requirements

Use this when the page is about a set of requirements and you want that relationship recorded in rmCloud as well as shown in Confluence.

To add it: edit the page, insert the Linked rmCloud Requirements macro, choose the requirements in the macro editor, then publish the page.

How it works:

  • The selection is stored in rmCloud against the Confluence page, not inside the page itself. The macro body stays empty.

  • The link is two-way. The same association is visible from rmCloud in Jira, and it can be created from either side — link the page from rmCloud and the macro picks it up.

  • Every page view re-reads the current list from rmCloud, so the table always reflects the live set of linked requirements.

  • Because the link is keyed to the Confluence page itself, copying a page does not copy its links. The copy starts with an empty table.

  • There is no limit on how many requirements can be linked to a page.

Insert rmCloud Requirements

Use this when you want to quote a specific list of requirements on a page without recording any relationship in rmCloud.

To add it: edit the page, insert the Insert rmCloud Requirements macro, choose the requirements, then publish the page.

How it works:

  • The chosen requirement IDs are stored as a parameter on the macro in the page itself.

  • Nothing is recorded in rmCloud. The requirements have no knowledge of the page.

  • Copying the page copies the macro and its list along with it.

  • A single macro holds up to 20 requirements. Add a second macro if you need more.

  • The table is still rendered from live data, so edits made in rmCloud show up here. A requirement deleted in rmCloud simply drops out of the table.

Choosing between them

  • Do you want this page to show up as linked content in rmCloud? Use Linked rmCloud Requirements.

  • Do you want a fixed list that travels with the page when it is copied? Use Insert rmCloud Requirements.

What the app can access

rmCloud Connector holds read-only access to Confluence. It reads page and space information so that rmCloud can list your Confluence content; it never writes to Confluence. All requirement data comes from rmCloud itself.

If you only want rmCloud to look at particular spaces, set Confluence spaces to filter on the rmCloud Configuration screen in Jira.

Troubleshooting

  • The table is empty. No requirements have been linked or selected yet, or rmCloud for Jira is not installed and licensed

  • A requirement disappeared from an Insert macro. It was deleted in rmCloud. Edit the macro and choose a replacement.

  • A copied page shows no requirements. Expected for the Linked macro — links belong to the original page. Re-link them on the copy, or use the Insert macro instead.