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 (by Role) to re-run (generate) certain reports themselves. 

Report Generator permits Role-defined groups of users (by Role) 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 viewable. Viewing restrictions can be set so that only nominated Roles can access particular Report Group reports.           

As an additional option, generated reports Report Subscription can be enabled for Report SubscriptionGenerator. This feature allows the User Admin to flag a 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 to for the report and , make a report it active and available for Report Generator and 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': set to 'Yes' ( allows the report to be active and can be generated) flagged as in use 
    - 'Available to Subscribe': set to (optional) 'Yes' ( allows the Subscription feature for the report - optional)report to use the Subscription feature 
    - 'Report Description': description for the report  
    - '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 generated reports (optional - if this generated report. If used, the template must have been created and available for use; if not usedleft blank, the report is a default CSV file )is used.     
    - 'Email Subject': Subject heading for email sent with attached report (if Subscription is enabled)


Step-by-step guide

...

1. Enable and configure Report Generator settings

(This step is an admin role function so the settings will not be displayed to other roles.)

Report Generator can be enabled for globally (for all users) or restricted to specific roles using the Override feature.   

...

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 - Roles should be the from same set as those in Report Generator.)
  •  which Report Groups are accessible by which group(s) of Users (all or by Role). (Note - Roles should be the from same set as those in Report Generator.) 

1. 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 is granted access to Report Generator, when logged into the website, the Report Generator function can be accessed in the Dashboard menu. 

Expand
titleSee Report Generator in Dashboard

Image Added

To enable Report Generator:

  1. In the CMS, navigate to SettingsFeature ManagementSystem.


  2. Toggle on Scheduled Reporting and click Configure.

  3. titleCAUTION

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

    Note

    Image Added

  4. The Enable Report Generator toggle is is the global ON/OFF setting for the feature.

    Unless you want


    Toggle ON for all users to

    be able to access all reports that can be generated, DO NOT toggle this on. Instead, leave it disabled and add Roles as overrides. Only users assigned these Roles will be able to access the Report Generator function.
    Image Removed

    have access to Report Generator.
    Leave it OFF if you only want certain roles to access Report Generator.

  5. If you are allowing only certain roles to access Report Generator, Role overrides need to be set.   

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


  6. (Optional) Toggle on ON Enable Report Subscription to allow users all Users to schedule report updates to be emailed to themselves and/or other selected usersselected recipients. Leave OFF and set overrides for this functionality to be available only for selected Roles. (See Subscribe to Report.) Note - This option can be disabled switched off but its use requires Report Generator to be activeenabled
     Once
  7. 'Enable Report Generator' is enabled, the Run Reports menu item is available in the Reporting menu globally or for the set of CMS Roles and/or Users. Run Reports provides users with system and user reports to which they have been granted access. 
    Image RemovedTo save your settings, click Save or Save & Exit

2. Generate a report

Users can only generate (run) reports they have access to. Such reports are available through the Run Reports menu in CMS or the Report Generator as a Dashboard item on your website.

...