Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt
hiddentrue

The Report Generator feature permits Role-defined groups of users to re-run (generate) certain reports themselves. 

Report Generator permits Role-defined groups of users to re-run (generate) certain reports themselves.  During the report design stage, a report can be assigned a Report Group and made active for Report Generator. When configuring Report Generator, Admin selects the Report Groups that can be accessed via the Report Generator. All active reports in selected Report Groups will be accessible. Access restrictions can be set so that only nominated Roles can access particular Report Group reports. Before a User generates a report, they can change the order of sorting and grouping fields, add notes, and change the report name, if they wish. A generated report does not change the original report. It has a unique ID number and is saved with a new file name. It is also only available to the User who generated it.             

As an additional option, Report Subscription can be enabled for Report Generator. This feature allows Admin to flag the original report as subscribable. This will allow Users to set up a scheduled reporting task so that their generated report can automatically be updated and emailed to themselves and any nominated recipients on a daily, weekly or monthly basis.

  

Info
titleReport design notes
  • Report design is an Admin level function. During this process, Admin can assign a Report Group for the report, make it active and available for Subscription. (See Create a Report for more help.)  
  • In Report Settings (on the Report Design page), the following fields are relevant:
    - Report Group: name of the report group this report belongs to for the purpose of Report Generator   
    - Is Active: 'Yes' allows the report to be flagged as in current use. Note - 'inactive' reports in a Report Group set for Report Generator can still be found and generated by the User. If an inactive report should not be accessible, re-assign it to a Report Group not available for Report Generator.   
    - Available to Subscribe: (optional) 'Yes' allows the report to use the Subscription feature 
    - Report Description: meaningful description of the report (e.g., use, purpose and content) displayed in the Report Generator screen to provide Users with helpful information about the report   
    - PDF Output Template: (optional) name of prepared PDF template for this generated report. If used, the template must have been created and available for use; if left blank, the default CSV file is used.    
    - Email Subject: Subject heading for email sent with attached report (if Subscription is enabled)

Step-by-step guide for Admin

During the Report Design stage, a report is assigned a Report Group. When configuring Report Generator, you decide the following:

  •  which group(s) of Users (all or by Role) have access to Report Generator.
  •  which group(s) of Users (all or by Role) have access to Report Subscription. (Note - This additional functionality can be disabled but if used, permissions for Roles should be coordinated with those in Report Generator.)
  •  which Report Groups are accessible by which group(s) of Users (all or by Role). (Note - Permissions for Roles should be coordinated with those in Report Generator.) 

Enable and configure Report Generator settings

Report Generator can be enabled globally (for all Users) or restricted to specific Roles using the Override feature.  If a User has access to Report Generator, when logged into the website, the Report Generator function appears in the Dashboard menu. 

Expand
titleSee Report Generator in Dashboard

Image Removed

To enable Report Generator:

...

In the 'Scheduled Reporting Features Settings' screen, go to the Enable Report Generator toggle.
Image Removed

...

Warning
titleTest your settings

Since reports may contain confidential data, it is strongly suggested that Report Generator configurations are tested in Stage before sending it to 'Live'. 

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,

...

Step-by-step guide for Users

...