Versions Compared

Old Version 30

changes.mady.by.user Documenter

Saved on

compared with

New Version Current

changes.mady.by.user Documenter

Saved on

Key

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

Overview

...

hiddentrue

The Report Generator feature permits

...

Report Generator permits 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 can be enabled for Report Subscription. This feature allows the User 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 the report and make a report active 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:   
    - 'Is Active': set to 'Yes' (allows the report to be active and can be generated) 
    - 'Available to Subscribe': set to 'Yes' (allows the Subscription feature for the report - optional)
    - 'Report Description': description for the report  
    - 'PDF Output Template': prepared PDF for generated reports (optional - if used, the template must have been created; if not used, the report is a CSV file)   
    - '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.   

 Section needs rewrite 

To enable Report Generator:

...

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

Note
titleCAUTION

The Enable Report Generator toggle is is the global ON/OFF setting for the feature. Unless you want 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

  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.

     

...

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.

...

certain Website Users to generate copies of reports they have access to. Report access is set by Role or a custom report group.


You can only view and generate reports you have been granted access to. Before generating a report, you'll be able to change how the report displays (order of sort and group fields), add notes, and change the report name.


Generated Report Features

A generated report:

  • does not edit the source report
  • has its own unique Id
  • is saved with a new file name
  • is only accessible by the user who generated the report
  • can be used with the Report Subscription feature (if source report was set as subscribable). See: Report Subscription.    



Excerpt
hiddentrue

The Report Generator feature permits Users based on Role to re-run (generate) reports they have access to. 

User Guide

Generate a report

If your Role(s) has access to the Report Generator, it will appear as a menu item in your Dashboard. 

Expand
titleSee Report Generator menu item in Dashboard

Image Added




Panel

On this page:

Table of Contents




To access Report Generator:

  1. Log in to your website and click Dashboard.

  2.  On your Dashboard, scroll down to the 'My Pages' section and click Report Generator.

    Image Modified

  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

...

  1. , tick the 'Show Inactive Reports' checkbox and click the Search button.
    Image Modified

  2. For the report you selected

...

  1. , click the Edit Selection Report Criteria button. The Report Selection Criteria section is displayed.
    Image Modified

  2. In Report Name, you can edit the name so it is more meaningful

...

  1. or easier to identify. Otherwise, the name of the original report will default.


  2. In Report Format, the dropdown list will allow you to select a pdf file download option instead of the default csv if this has been set by Admin. 

  3. The Search section contains the report's fields. Note - The availability of 'Search', 'Group By' and 'Sort By' fields for customisation will be different

...

  1. , depending on how

...

  1. each report has been designed. If options are available, select

...

  1. order preferences to determine how the generated report's data will be displayed.

  2. To generate the report, click the Generate button. The report will be downloaded to your computer

...

  1. . 

  2. Open the file to view it. 

  3. (optional) If this functionality is available to you and the original report, once the report is generated, the Subscribe button

...

  1. will be displayed. This allows you want to schedule a subscription task for

...

  1. the generated report.
    Image Added
    To add a subscription, click Subscribe. You will be taken to the Subscription screen. See Report Subscription help for details. 
    Image Modified   

  2. If you did not select to subscribe (Step 9), click Close when you have finished with the 'Report Generator' facility.

...



Additional Information

Multiexcerpt
hiddentrue
MultiExcerptNameAdditional Info
--


Minimum Version Requirements


Multiexcerpt
MultiExcerptNameMinimum Version Requirements

4.23


Prerequisites


Multiexcerpt
MultiExcerptNamePre reqs



Self Configurable


Multiexcerpt
MultiExcerptNameSelf Configurable

No


Business Function


Multiexcerpt
MultiExcerptNameBusiness Function

Reporting


BPD Only?


Multiexcerpt
MultiExcerptNameBPD Only

Yes


B2B/B2C/Both


Multiexcerpt
MultiExcerptNameB2B/B2C/Both

Both


Third Party Costs


Multiexcerpt
MultiExcerptNameThird Party Costs

n/a


Related Resources

Content by Label
showLabelsfalse
showSpacefalse
excludeCurrenttrue
cqllabel = "reporting"