Versions Compared

Key

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

Table of Contents
maxLevel3
minLevel2

Overview

Excerpt
hiddentrue

...

Report Subscriptions provide Users who have access to the Report Generator with the additional function of setting a scheduling task for their generated

...

reports

...


Report Subscription is an optional feature that can be enabled for Report Generator. If Admin has set the original report as subscribable and you have been granted Subscribe permissions (based on Role), you can set a scheduled reporting task for your generated report to be automatically  updated and emailed to yourself or other nominated recipients on a daily, weekly or monthly basis

...

during the subscription period.  Note that recipients are added by email

...

and are therefore not

...

Info
  • The Report Subscription feature is only available if Report Generator is in use. See The Report Generator 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.   

Step-by-step guide for Admin

When configuring Report Subscriptions, you decide the following:

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

Report Subscription can be enabled globally (for all Users) or restricted to specific Roles using the Override feature.  If a User has access to Report Subscription, when logged into the website, the Report Subscription item appears in the Dashboard menu. 

Expand
titleSee Report Subscription on Dashboard menu

Image Removed

To enable Report Subscription:

...

In the 'Scheduled Reporting Features Settings' screen, go to the Enable Report Subscription toggle.
Image Removed

...

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,

...

Step-by-step guide for Users

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

restricted to those within your company. 


Panel

On this page:

Table of Contents



Step-by-step

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.

Create a new report subscription 

  1. Login to your website and click Dashboard.

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

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

    Info

    You can only subscribe to generated reports 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 panel for the report is displayed. Any current subscriptions will be displayed. 
    Image Modified

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

  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 address. 

  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 lets you pause/continue a subscription. It is ticked by default when a subscription is created. If you do not want the subscription to run after creating it, untick Active. You can tick it any time after the subscription has been created.   

  10. To save the subscription, click Add. If the subscription is active, recipients will be sent an email with the report attached 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. Check that you receive an email with the report. The Subject line displays the text Admin entered for 'Email Subject' when the report was created.   

    Image Modified

    If you do not receive the email:

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

Manage Report Subscriptions


View/edit a current subscription

To display the details of an existing subscription, 

  1. Find the report and click Subscribe. Details of any current subscriptions and when an email was last sent are displayed.
    Image Modified

  2. (i) To remove the subscription from the system, click Delete.
    (ii) To edit the details of the subscription, change any information in the fields and click Update. If you have changed any information and do not want to save it, click Cancel Subscriptions to revert to existing details and close the 'Manage Subscriptions' panel.
    (iii) To pause the scheduled emailing of the report, untick the 'Active' checkbox and click Update.

View Subscription Log of sent events

To view the log of a report's subscription send activity, click the Audit button.
Image Modified

The log provides details of each email sent event. Note - In 'Status', 'Successful' refers to a successful email sending event by the system.    

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. 

Delete a report

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

To delete a report,

  1. Click the Delete Report button. 

  2. Confirm you want to delete the report in the popup message. Click Yes to complete the deletion or No to cancel it.  

**UPDATE**

Nick naming a subscribed report.  (Available from versions 4:40 upwards)

From Version 4:40+ you can add a nickname to the report you have subscribed to.  This will allow you to name the report to your liking without affecting any other user who has subscribed to the same report.  Follow the below steps to add a nick name to a subscribed report.

  1. Login to your website and click Dashboard.

  2. On your 'Dashboard', scroll down to the 'My Pages' section and click Report Subscription
    Image Added
  3. In the 'Report Subscription' list, you can scroll down the list of reports available or search for it. Note - Tick 'Show Inactive Reports' and click Search to display inactive reports as well.    
    Image Added
  4. Find the report you want to add a nickname to and click on the edit icon                                                           Image Added
  5. After clicking on the icon, a field will open up, allowing you to type in a nickname for the report.  Enter in a nickname for the report.  Click on 'Save Nickname' to save the changes, or click on 'Cancel' to cancel any changes.  Image Added
  6. After clicking on 'Save Nickname' the nick name will be saved against the report.  


Image Added



Note:  The nickname is only visible to your logon.  No other users will see this nickname.  The nickname will not appear on the email that is sent to you.  


Additional Information

Multiexcerpt
hiddentrue
MultiExcerptNameAdditional Info
--


Minimum Version Requirements


Multiexcerpt
MultiExcerptNameMinimum Version Requirements

4.23

4.40 for Naming your reports.


Prerequisites


Multiexcerpt
MultiExcerptNamePre reqs

A report must be enabled for subscription.


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

...

Multiexcerpt
MultiExcerptNameBallpark Hours From CV (in addition to any self config required)

Contact Commerce Vision

...

MultiExcerptNameBallpark Hours From CV (if opting for CV to complete self config component)

...

Contact Commerce Vision

...


Third Party Costs


Multiexcerpt
MultiExcerptNameThird Party Costs

n/a

...


...

 Reporting



Related

...

Resources

Content by Label
showLabelsfalse
showSpacefalse
excludeCurrenttrue
cqllabel = "reporting"