Page History

Table of Contents

Overview

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 viewableaccessible. Viewing 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 a 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.

...

...

•  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 the from same set as 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 the from same set as 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 is granted has access to Report Generator, when logged into the website, the Report Generator function can be accessed appears in the Dashboard menu. 

...

1. In the CMS, navigate to Settings → Feature Management → System.
   
   
   
2. Toggle on ON Scheduled Reporting and click Configure.
   
   

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

4. The Enable Report Generator toggle is is the global ON/OFF setting for the feature. You have the option to:
   Toggle ON Global for all users Users to have access to Report Generator, and set overrides for selected Roles, e.g., B2C customers, so the feature is not visible on their Dashboard.
   Leave it OFF if you only want certain roles to access Report Generator.
   If you are allowing only certain roles to access Report Generator, Role overrides need to be set.    Global and set access overrides for selected Roles.
   
   

5. To add an override,

   click

       
   
   

   1. 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 Enable Report Subscription to allow all Users to schedule report updates to be emailed to themselves and/or other selected 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 switched off but its use requires Report Generator to be enabled. 
    
7. To save your settings, click Save or Save & Exit. 

2. Generate a report

...

Step-by-step guide for Users

Generate a report

If you have access to the Report Generator, it will appear as a menu item in your Dashboard. 

You can only view and generate (run) reports they you have been granted access to based on Role. Before generating a report, you will be able to . Such reports are available through the Run Reports menu in CMS or the Report Generator as a Dashboard item on your website.change how the report displays (order of sort and group fields), add notes, and change the report name, if you wish. A generated report has a unique ID number and is saved with a new name. It is viewable only by the User who generated it. If the Subscription functionality is available for you and the original report is set to Subscribable, your generated report will be available in the Report Subscription screen.    

To generate a report:

1. Log in to your website and click Dashboard.
   
   
2.  On your Dashboard, scroll down to the 'My Pages' section and click Report Generator.
   
   
   
   
3. By default, the Reports list displays all active reports you have access to. (Active reports are those marked as current by Admin.) Find the report you wish to generate. You can search by name or scroll down the list. If you want to find an inactive report or view all reports in the system, tick the 'Show Inactive Reports' checkbox and click the Search button.
   
   
   
4. For the selected report you want, click the Edit Selection Report Criteria button. The Report Selection Criteria section is displayed.
   
   
   
5. In Report Name, edit the name so it is more meaningful for your purposes . Note - a generated report can only be edited and managed by the user who generated it. and easy to identify. Otherwise, the original name will default.
   
   
6. The Search section contains the report's fields. Note - The availability of 'Search', 'Group By' and 'Sort By' fields for customisation will be different for each report, depending on how it each report has been designed. If options are available, select order preferences as you requirefor how you want the report's data to display.
   
   
7. To generate the report, click the Generate button. The report will be downloaded to your computer as a CSV file unless the PDF option has been set up for your websitethe report. 
   
   
8. Open the file to view it. 
   
   
9. (optional) If this functionality is available to you and the original report, once the report is generated, the Subscribe button appears. If This allows you want to schedule for the generated report updates to be updated and emailed to you and/or other users recipients on a daily, weekly or monthly basis. To add a subscription, click Subscribe.  See You will be taken to the Subscription screen. See Report Subscription help for details. 
     
   
   
10. If you did not select to subscribe (Step 9), click Close when you have finished with the 'Report Generator' facility.
    
    
    

...