Reports

The reports section allows existing report templates to be edited, or new templates created.

To access the report templates, select Reports followed by Templates from the top menu bar.

The reports dashboard is then displayed, with three tabs.

Reports

Create Report

A new report can be created by selecting the Add Report icon.

The following fields can now be entered:

• Name - the report name
• Description - a short description of the report
• Duplicate Existing - selecting a report from this dropdown allows a duplicate to be created.
• Applies To - allows the report to be applied to Options or Business Cases.

Once this information has been added, click Save to generate the blank report template.

To add a new item to the report, click on the + icon.

To add the item, click on the item name.

Once an item has been added, the module controls will appear.

• To add a comment, select the add comment flag. This launches a new modal for comments to be added (or deleted).
• To edit the module, select the edit icon. This allows the module content to be edited.
• The settings icon only displays on some items (i.e. Sections, Graphs, Images). Selecting this allows the section settings to be edited.
• To remove the section, select the delete icon. A confirmation box will display to confirm the deletion.

Delete Report

info

If there are user-generated reports using the template, the template cannot be deleted.

To delete a report template, select the Delete Template icon from the row.

A confirmation box will be displayed confirming you wish to delete the report.

To proceed with the deletion, click Delete. To cancel, click Cancel.

Edit Report

Report names and descriptions can be edited by selecting the Edit Report icon for the row.

Enter a new name or description for the report, then select Save. To discard these changes, select Cancel.

View Report

Existing report templates can be viewed by selecting the View Report icon for the row.

Archive Report

Reports can be archived by selecting the Archive Report icon for the row.

A confirmation box will be displayed confirming you wish to archive the report.

To proceed with archiving, click OK. To cancel, click Cancel.

References

References are a list of sources that have been cited within a report. The full list can be accessed via the References tab.

Create Reference

To add a new reference, select the Add Reference Icon.

A Cite Key is required, along with Entry Type. Once an Entry Type has been selected, further information will be displayed to complete the reference.

To save the reference, click Save. To discard the reference, click Cancel.

Delete Reference

To delete a reference, select the Delete icon from the row. A confirmation box will be displayed confirming you wish to delete the reference.

To proceed with the deletion, click Delete. To cancel, click Cancel.

Edit Reference

Existing references can be edited by selecting the Edit Reference icon for that row.

Once all changes have been made, select Save to update the reference or Cancel to discard changes.

View Reference

The full reference information can be viewed by selecting the View Reference icon. This will open a modal with the full reference information.

Glossary

The glossary is a list of terms or acronyms used in reports. The full list can be accessed via the Glossary tab.

Create Glossary Term

To create a new glossary term, select the Add New Term icon.

The Term / Acronym can now be entered along with its definition. If the new item is an acronym, a new field will be displayed to enter the full name.

To save the new glossary term, select Save. To discard the glossary term, click cancel.

Delete Glossary Term

To delete a glossary term, select the Delete icon from the row. A confirmation box will be displayed confirming you wish to delete the term. .

To proceed with the deletion, click Delete. To cancel, click Cancel.

Edit Glossary Term

To edit a glossary term, select the Edit Glossary Term icon from the row. Once all changes have been made, select Save to update the term or Cancel to discard changes.

View Glossary Term

The full glossary term information can be viewed by selecting the View Reference icon. This will open a modal with the full term information.