User Guide
QM Metadata Macro (SOP) for Confluence - How to
The QM Metadata Macro (SOP) allows teams to enhance critical data field visibility on confluence pages. The metadata macro configuration allows to show or hide metadata as needed to fulfill necessary quality levels, e.g.:
SOP Documents
Technical Documents
QM Handbooks
Product Documentations
all types of Documentations where you need document metadata visible on top or also around content
You can configure multiple metadata macros on a page and position them in different areas with individual configuration to show metadata aligned to you page content where you need it. A metadata macro can display just one metadata or a individual set of metadata as you like to use.
Overview
The metadata macro provides currently the following metadata fields:
Role | Field Type | Meaning |
|---|---|---|
Title | Confluence Metadata | Shows the page title which is also linked to the page if the page is exported the PDF show the title as a link. |
Created | Confluence Metadata | Displays the date and time the page was created |
Last Update | Confluence Metadata | Displays the date and time the page was last edited |
Time Since Last Edit (in days) | Confluence Metadata | Displays the the time in days since the last edit of the page until today |
Current Version | Confluence Metadata | Displays the latest current version number of the page based on the confluence page history |
Author | Confluence Metadata | Displays the creator of the page |
Last Editor | Confluence Metadata | Displays the last editor of the page |
Contributors | Confluence Metadata | Displays the number of unique editors of this page from the creation up until today |
Attachments | Confluence Metadata | Displays the number of attachments on this page also as linked item, so by click you will be navigated to the attachment list of the page |
Owner | Manual Metadata Field | Displays the Content Owner based on confluence users which you can set up in the space settings |
Reviewer | Manual Metadata Field | Displays the Content Reviewer based on confluence users which you can set up in the space settings |
Scope of Application | Manual Metadata Field | Displays the the scope of application based on a set of values you can set up in the space settings |
Status | Manual Metadata Field | Displays the status options based on a set of values you can set up in the space settings |
Metadata Macro Configuration Options
The metadata macro in the page editor can be found in the macro browser with the title “metadata macro”. By selecting the macro it will display information of your page:
Click on the metadata macro and click on the edit icon:
The macro edit view will show up:
Configure Individual Fields
In this configuration view you can configure:
Manual Fields → Select the value(s) for the manual fields “Scope of Applications”, “Status”, “Owner” and “Reviewer” depending on the space setting configurations see https://kencha-software.atlassian.net/wiki/spaces/MM/pages/1228898305
Configure Visibility
In this configuration view you can configure the metadata macro behaviour on the specific page:
Visibility → configure for this specific metadata macro which fields should be visible or hidden
Position → the position of each field in the metadata macro for individual structures
Display Mode → Select if you want to display the information as a list “vertical” or as a table like a control line “horizontal”
See some examples for the Display Mode types:
Vertical Option
Horizontal Option
Individual Field Change Logs
This change log overview provide auditable and traceable coverage for all changes made in the metadata macro of the page. Each macro inherits it’s own change log to ensure governance for change documentation.
Using the Metadata Macro Setting in the Page Editor
You can configure the with of the macro to define how the look and feel on the page should be. If you are in the page edit mode and select the metadata macro a small pop up of confluence will show on the macro:
By selecting the configuration in the center you can define the width type of the macro on the page:
E.g. selecting “go full width” could be used to display the page metadata as a control line in a SOP document.
Exporting Confluence Pages
Our app fully integrates in the native Confluence Page Export functionality which is available in the three dot menu on each page. We support the PDF Export version of Confluence. We do not explicitly support the Word Export option!
This ensures alignment of pages you send as PDF to clients or service providers to ensure data quality and traceability. It can also be used for audit purposes.