Versions Compared

Old Version 28

changes.mady.by.user Documenter

Saved on

compared with

New Version 29

changes.mady.by.user Documenter

Saved on

Key

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


Overview


Excerpt

Report Generator lets nominated users customise and re-run generate reports sorting and grouping fields of reports they have access to. If a report is also enabled for Report Subscription, the generated report can be scheduled for update reruns and emailed to select recipients on a daily, weekly or monthly basis.

...

Info
titleReport design notes
  • The Report Generator and Report Subscription features must first be enabled for your website by Commerce Vision. 
  • Report design is an Admin level function. Therefore, the Admin User selects the search by, grouping and sorting features of a report, whether it can be subscribed to, and have access to the Report Generator Widget, where they can edit field names and text displayed in the Report Generator screen.  
  • In Report Settings (on the Report Design page), the following fields are relevant:
    - '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

A User can only generate and subscribe to a report if they belong to the report user group nominated for the report when it was designed.

1. Enable Scheduled Reporting

Scheduled Reporting can be enabled by administrators. It can be active globally or only to specific roles or users. To enable this feature:

...

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:

  1. In the CMS, navigate to Settings → Feature Management → System.
    Image Added

  2. Toggle on Scheduled Reporting and click Configure.

  3. In the 'Scheduled Reporting Features Settings' screen,

    if running reports will be active for all users, toggle on

    go to the Enable Report Generator

    . This will turn on the Report Generator feature for all users. If this feature is to be active only for certain roles or users, use overrides to limit access.

    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 Added

    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.

         



  4. (Optional) Toggle on Enable Report Subscription to allow users to schedule report updates to be emailed to themselves and/or other selected users. (See Subscribe to a reportReport.) Note - This option can be disabled but its use requires Report Generator to be active. 
     

  5. Once '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. 

...