Advanced Dashboard Templates

Purpose

The CGR Platform enables users to control their own dashboards, providing an extra level of customisation. Dashboards are built using available fields from each module and can include visual elements such as charts, cards, tiles and tables [these are called widgets]. These widgets can be newly created or reused from Dashboard Manager.

Each dashboard is based on a template, which consists of one or more widgets. Dashboard Templates enable users to assemble one or more widgets into a layout that forms a customisable dashboard/report. This allows users to determine how they see and present their data. 

When created via the Dashboard Templates (available only to System Administrators), additional advanced features become available:

• Assigning view or edit permissions for different teams, users, or roles
• Applying report themes for consistent export formatting
• Setting the dashboard’s position in the overall display order
• Managing a global view of all dashboard templates across the system

Important Notes

• There will be some templates that will not let you to delete them, this means they are in use or are created by the CGR Admin (the option will be greyed out). 
• You must have your widgets created prior to creating a dashboard from the Dashboard Template, if not create your widgets from Admin > Dashboard Manager 
• For the user to see the relevant data in the dashboard, they must have the ‘read’ access to the modules and the relevant projects/registers or business units. 

Step-by-Step Guide to Creating a Dashboard Template

1. Navigate to Admin > Dashboard Templates.
   
   
2. Create a New Template: Click the Add button to open the 'New Dashboard Template' form. You can create from scratch (Form) Or import from existing JSON file (Import tab). 
   1. Creating a New Dashboard Template through the Form section. Fill in the following fields:
      • Title*: Enter a name for the dashboard.
      • Title Translations (optional): It is used to support multilingual dashboard titles.
      • Description (optional): You can add internal notes or dashboard context. Click Save to proceed.
        
        
   2. To Import an existing Dashboard Template through the Import section from Staging server to the Production server or vice versa:
      • Export the dashboard template from the server you want to export it from (e.g. Staging or Production server)
        
        
        
        
      • Once it is exported, Copy the entire JSON code (Ctrl A/Command A and Ctrl C/Command C)
        
        
        
        
      • Now Navigate to the server you want to import the exported Dashboard template and go to Admin Dashboard Templates and Click on 'Add' button
        
      • Click on Import tab and paste the copied JSON code (Ctrl P/Command P)
        
        
      • Now click ‘Save’.
        
        

3. Once the dashboard template is saved either from 'Form' or the 'Import' tab, additional configuration sections will become available for further customisation.

4. Click Save to complete the 'Dashboard Template' configuration.

5. Further, from the list of existing templates, you have the options to:

• Move the template you created up to modify the display order
• Export the Dashboard (to use it another server – Staging/Production) instead of having to create the whole dashboard template or widgets all over again. 
• Clone (copy) the template, useful to reuse the same set of widgets 
• Delete the template
• Disable the template (preserves the dashboard template but hides it from displaying in the dashboard view)

Step-by-Step Guide: Creating a Report Theme

Report Themes: Report Themes are applied when dashboards or individual widgets are exported as PDF documents using the Export option (visible via the export icon on a dashboard or widget). These themes allow you to customise the appearance of exported reports by defining layout styles, cover pages, logos, fonts, and colour schemes.

• Exporting from Dashboard view

• Exporting from Widget view 

1. Navigate to Admin > Report Themes.

2. Click on 'Add' option to create a new report theme. Now, fill in the following fields to configure your report theme (optional). 

• Report Theme Title: Enter a name for your report theme.
• Apply To: Specify whether the theme applies to a specific location, project, type, or module (e.g. Risk, Incident, etc). If left blank, then by default it can be applied to any dashboard template

• Cover Page: This section allows you to customise the appearance of the exported dashboard’s cover page, including the logo, title style, and overall visual design.
  Note: If you would like to add additional background images or logo, navigate to Admin > Custom Images.

• Header/Footer: Define what content appears in headers and footers across all exported pages. 

3. Click Save to complete the 'Report Themes' configuration. 

Step by Step Guide to add a Custom Background or Logo Image

If you wish to create a custom image for the cover background or logo, follow these steps:

1. Navigate to Admin > Custom Images.
2. Click the Add button to upload a new image
   
   
   
   
3. Fill in the following fields.
   • Title: Enter a name for your image 
   • File: Upload the image file (e.g., PNG or JPG). 
   • Reference (optional): This is used to associate the image with a specific purpose or usage type. If left blank, it remains available for manual selection.
   • Enabled: Select Yes to activate the image so it appears in selection lists (e.g., in Cover Page Background or Logo drop downs).
     
     
     
     
4. Once saved, the image will appear in the Cover Page Background or Logo selection list where applicable in the Report Themes configuration.