Versions Compared

Key

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

...

Info
  • The Report Subscription feature is only available if Report Generator is in use. See Generate Reports for more details.
  • For a generated report to be subscribable, the original report on which it is based must have been flagged as subscribable in Report Design.   

{0} generated on [1] for [2} frpm CVReport


Step-by-step guide for Admin

...

  •  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.) 

...

1. Enable and configure Report Subscription

(Note - The Report Subscription feature may have been enabled and configured when Report Generator was set up.)  

...

Warning
titleTest your settings

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


2. Configure Report Subscription widget options (optional)

The Report Subscription widget allows you to customise labels and text displayed in headings and fields in the Report Subscription screen on your website. To access the widget,

  1. In the CMS, go to ContentPages & Templates and find the Report Subscription Template

  2. Click Edit for the Report Subscription widget.
    Image Added

  3. Edit the fields as you required. See Report Subscription Widget help for more details.

Step-by-step guide for Users

If you have access to Report Subscription, you can add subscriptions for your generated reports. 

Note
If you arrived at the Report Subscription page by clicking 'Subscribe' from the Report Generator screen, then the report you are subscribing to is the only one displayed.

...

  1. Login to your website and click Dashboard.

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


  3. In the 'Report Subscription' list, you can scroll down the list of reports you can subscribe to find a report available or search for it. Note - Tick 'Show Inactive Reports' and click Search to display inactive reports as well  

    Info

    You can only subscribe to generated reports that are active and based on original reports that have been enabled for subscription. If the list is empty, there are no reports you can subscribe to. (See your website Administrator for assistance.)



  4. Click Subscribe for the report. The Manage Subscriptions screen panel for the report is displayed. Any current subscriptions will be displayed. 


  5. To create a new subscription, click the New Subscription button.


  6. In Recipient Email Address, enter one or more recipient email addresses for this subscription. If there are more than one recipient, use a semi-colon ';' to separate each email addressesaddress

  7. In the Start Date and End Date fields, enter the beginning and end dates for the subscription period.

  8. In Frequency, select how often an updated report will be run and emailed: 'Daily', 'Weekly' or 'Monthly'.
     
  9. The Active checkbox tells you if the subscription schedule is currently runninglets you pause/continue a subscription. It is ticked by default when a subscription is created. If you do not want the subscription schedule to run at this timeafter creating it, untick it Active. You can always tick it later onany time after the subscription has been created.   

  10. Click Add to To save the subscription. Recipients will receive emails , click Add. If the subscription is active, recipients will be sent an email with the report attached as specified by based on the start date/end date and frequency.

    Tip
    titleTest report subscription email

    You can test that your report subscription has been set up correctly by entering your email address as 'Recipient Email Address' and setting the date to today and time to a few minutes into the future. An Check that you receive an email with the report will be sent in accordance with the schedule. The Subject line displays the text Admin entered for 'Email Subject' by the Admin user when the report was created.   

    If you do not receive the email:

    • check your Junk Email folder
    • check you have entered your email address correctly


...

The log provides details of each email sent event. Note - In 'Status', 'Successful' refers to a successful email sending event by the system. It does not directly indicate receipt of the email by the recipient. e.g., if the email address entered has a typo.       

View a report

In case you want to view a report for any reason, e.g., check it is the right one to subscribe to, click the View button next to the report. The system will automatically download the report to your device. (For report creation and generation, see the relevant help pages.) 

Delete a report

You can delete a report you generated through Report Generator. Only reports that have no current subscriptions can be deleted. 

...