Risk Reporting User Guide
SoftComply Risk Manager for Confluence is an extension of the SoftComply Risk Manager on Jira Cloud to visualize and report risks in Confluence.
With this app you are able to create and customize Risk Reports in Confluence. You can now add the Risk Matrices view and the Risk Table view to your Confluence pages.
This is a free Confluence app – try it out yourself!
1. Quick Start Guide
First, install the SoftComply Risk Manager app (from hereon, Risk Manager) from the Atlassian Marketplace to your Jira instance. This step may require Jira administration permission.
After the successful installation, open the “Risk Manager” drop-down menu and create a new risk management project from the top navigation bar.
Next, install the SoftComply Risk Manager app for Confluence app from the Atlassian Marketplace to your Confluence instance. This step requires Confluence admin permission.
Success! You are now ready to visualise risks on your Confluence pages.
2. How to Visualise Risk Matrices in Confluence
In the Risk Matrix macro you can select the Risk Project, Matrix type (Initial, Residual or both) and additional risk parameters to be displayed in the macro.
Follow these steps to display the Risk Matrices in Confluence:
First, go to the the edit mode of a Confluence page and add the Risk Matrix macro by typing “/risk matrix report” and then press enter.
Next, go to the edit mode of the Risk Matrix macro and select a risk project from the “select project” dropdown list.
Next, select the matrix type to display in the macro from the “Select Which Matrix to Show” dropdown list. You can select between Initial Risk Matrix, Residual Risk Matrix or both to be displayed.
To display the total count of the initial and the residual risks in the macro, please choose it from the “Show Counts in Matrix Cells” radio box.
To display the Jira Issue Keys of the initial and residual risks in the macro, please choose it from the “Show Issue Keys in Matrix Cells” radio box.
To display additional risk class information in the macro, please choose the details of your choice from the “Show Risk Class Colours, Names and Descriptions” radio box.
To display the information about the risk classification parameters in the macro, please choose the details from the “Show Classifiers Names and Descriptions” radio box.
To apply a sub-query filter, enter the JQL in the “JQL Sub Filter” field. For example, project = “DEMO1” <AND JQL Sub Filter> ORDER BY created DESC. Note: Do not type “AND” in the filter box before you start typing your JQL sub-filter.
Publish the page and wait for the macro to load for the Risk Matrix to be displayed on your Confluence page. You can add additional information on the page now to create a compliant Risk Management Plan or Report with the Risk Matrix configuration and risk count already displayed.
3. How to Visualise Risk Table in Confluence
In the Risk Table macro you can select the Risk Project and the number of risks to be displayed in the macro.
Follow these steps to display the Risk Table in Confluence:
First, go to the edit mode of a Confluence page and add the Risk Table macro simply by typing “/risk table report” and then press enter.
Next, go to the edit mode of the Risk Table Macro and select a risk project from the “select project” dropdown list that you would like to display in the macro.
You can also enter the number of risks to be displayed in the risk table by specifying a number in the “Page Size” input box.
To apply a sub-query filter, enter the JQL in the “JQL Sub Filter” field. For example, project = “DEMO1” <AND JQL Sub Filter> ORDER BY created DESC. Note: Do not type “AND” in the filter box before you start typing your JQL sub-filter.
Publish the page and wait for the table to load. You can add additional information on the page now to create a compliant Risk Management Report with the Risk Table with the risks already displayed.
3.1. How to Sort Risk Table in Confluence
First, make sure that the Risk Table sorting in Jira (in the SoftComply Risk Manager app) is user-based, i.e. you have enabled the user-based sorting of risks for the Risk Table in the Project Setting page.
Once the setting has been enabled in Jira, you will be able to sort the risk table in Confluence macro by hovering over the column you wish to sort risks by and then clicking on the column header to sort them.
