Page History

Step-by-step guide

1. Enable report for Report Generation and Subscription

When creating or editing the original report in Report Design:

1. Go to the Report Settings section.
   
   
2. Report Group: Report Group code this report belongs to for the purpose of Report Generator. This can be a Role or any meaningful word that makes sense for the reports assigned to it.  
   
   
3. Is Active: 'Yes' flags the report as in current use. NOTE - 'inactive' reports in a Report Group can still be found and used in Report Generator. TIP - To make an inactive report inaccessible to a Report Group, remove it from a Role or Report Group that cannot access Report Generator.   
   
   
4. Available to Subscribe: (optional) 'Yes' enables Report Subscription. This lets users add subscribers to their generated reports.
   
   
5. Report Description: meaningful description of the report (e.g., use, purpose and content). This is displayed on the Report Generator screen to give users a summary of the report.
    
6. PDF Output Template: (optional) Name of prepared PDF template for the generated reports. The template must have been created and available for use. If this field is left blank, generated reports will be CSV files.
    
7. Email Subject: Subject heading for email sent with attached report (if Subscription is enabled).

2. Enable and configure Scheduled Reporting settings

Report Generator with or without Report Subscription can be enabled for all users (not recommended) or restricted to specific Roles with the Override feature.  When a user is given general access to either sub-feature, it will appear on their Dashboard menu. 

To enable Report Generator:

1. In the CMS, go to Settings → Settings → Feature Management → System.
   
   
   
2. Click Configure.
   
   
3. Enable Report Generator toggle:
   1. Leave it OFF (set global to disabled for users) and use Overrides to set for selected Roles. NOTE - Toggling ON will allow all users access by default.
      
   2. Click Overrides.
   3. Click the Add An Override button.
   4. In Role, select the role you want to add. 
   5. To switch on the Override, toggle on Override Value. 
   6. Click Confirm. 
   7. To add any other Role Override required, perform steps b-e.
   8. Once you have exited the Overrides screen, in the main screen, click Save or Save & Exit.
      
      

4. (Optional - only if Subscription is to be used on your site) Enable Report Subscription toggle:
   
   
   

   Info

   The Report Subscription sub-feature can only be used with Report Generator.  For a generated report to be subscribable, the original report must have been flagged as subscribable in Report Design.    When configuring Report Subscriptions, decide:      which group(s) of Users (all or by Role) have access to Report Subscription. Permissions for Roles should be coordinated with those in Report Generator.

   
   

   1. Leave toggle OFF so Subsciption is not enabled for all users.

   2. Click Overrides to make it available for selected Roles. 

   3. Click the Add An Override button.
   4. In Role, select the role you want to add.
   5. To switch on the Override, toggle on Override Value.
   6. Click Confirm.
   7. To add any other Role Override required, perform steps b-e.
   8. Once you have exited the Overrides screen, in the main screen, click Save or Save & Exit.

   9. 
      If a User has access to Report Subscription, when logged into the website, the Report Subscription item appears in the Dashboard menu.

      
      

      
      

5. In Report Generator and Subscription Groups, configure the report groups that will be available in the Report Generator. One or more report groups can be entered, each one separated by a comma or semi-colon.
   
   IMPORTANT - report groups added in the main field are globally available to all users who can access the Report Generator (except where prevented by any Role Overrides). If you do not want global access to report groups, you can either (i) leave this field blank and use the Override feature to add Report Groups by Role or (ii) enter Report Group(s) to this field and add Role Overrides to those roles cannot access these reports.      
    

   Expand
   title Maintain Report Groups by Role
   Click the Overrides button. To add a role override, click Add Override Setting.   In the Role dropdown, select the role.  What you enter in Override Value depends on the global setting. Remember that a Role Override will override the global settings for this Role. If the global field has no report groups, you can add the Report Group(s) you want only this Role to access. If the global field has report groups and a Role Override is added, the Role can access any values entered here. But if a Report Group added for the role is the same as one entered for global access, users with this Role will be prevented from accessing this Report Group.     If you need to add more Role Overrides, click Add Override Setting again and perform (a)-(d) for each role. Once you have finished, click Confirm. To save the overrides, click Save or Save & Exit.

   
   
   

6. To save your settings, click Save or Save & Exit. 

2. Configure Report Generator widget options (optional)

The Report Generator widget allows you to customise labels and text displayed in headings and fields in the Report Generator screen on your website. To access the widget,

1. In the CMS, go to Content → Pages & Templates and find the Report Generator Template. 
   
   
2. Click Edit for the Report Generator widget.
   
   
   
3. Edit the fields as you required. See Report Generator Widget help for more details.

3. Configure Report Subscription widget options (optional)

The Report Subscription widget allows you to customise labels and text displayed in headings and fields in the Report Subscription screen on your website. To access the widget,

1. In the CMS, go to Content → Pages & Templates and find the Report Subscription Template. 
   
   
2. Click Edit for the Report Subscription widget.
   
   
   
3. Edit the fields as you required. See Report Subscription Widget help for more details.

Related Resources