Agent PushReportSubscriptions

From Pro 9 Wiki
Jump to navigation Jump to search

Manage Subscriptions for Scheduled Reports

In this view you get an overview of all subscriptions, history, and schedules of a specific report.

The subscriptions tab is where you can create new subscriptions or edit the existing ones. You have the possibility to filter user defined subscriptions, i.e. the subscriptions that the end users themselves manage directly in each report selection page.

Normally you set up a schedule for the subscription, defining when and how often the report is to be generated. It's also possible to run the subscription manually.


Subscriptions tab display:

Name Shows the name of the subscription.
Delivery method Shows delivering method for the subscription.
Last started Shows date and time when the subscription last started.
Last started by Shows the username of who last started the subscription. Is "schedule" shown the subscription was last started by one of the schedules.
Created by Shows the username of the creator.
Duration Displays how long it took to generate all reports and send all e-mails.
Next start time Shows the next start time from subscription schedules.
Enabled Shows if the subscription is active, see below on how to - disable/enable a subscription.
Run Icon Run.png shows if the subscription is ready to run and Icon Cancel.png shows if the subscription is already running.


If you want to stop a subscription, there are different ways to do it depending on what you want to achieve. If it's temporary, you can either disable the subscription totally or disable one or more of the subscription schedules. If it's permanent, you can delete the whole subscription.

To stop a running subscription, click Icon Cancel.png.


Note: Subscriptions marked in red are updated with new or removed settings, to activate the subscription again open subscription and press save.


How to - Show Scheduled Report Subscriptions

  1. Click the role Application Maintenance
  2. Click Push email settings > Scheduled reports
    • A list of all scheduled reports is shown
  3. Click on the report you want to show/edit subscriptions for


How to - Add a New Subscription

  1. Click add Icon Add.png
  2. Select which main group the scheduled report should belong to
    • The setting belongs to main group defines who can see this scheduled report both what main groups the user have directly and what main groups the billing groups the user have rights on belongs to
  3. Define a name for the subscription
  4. Enter a description, i.e. a more detailed information of what the subscription is used for, who it is for etc.
  5. In the delivery method menu, select how the report should be accessed
    • Email - an email is sent to defined receivers notifying them of that there is a new report, or with the report as an attachment (depending on the include report setting)
    • Windows file share - the report is stored on the server
  6. Check the send to selected persons box to select receivers by report selection person, parameters for email to, cc, bcc will be removed
    • Only available on report personal communication cost
  7. Check the active box to activate the subscription
    • Note: If the active box is unchecked you are still able to send the scheduled report manually
  8. Check the advanced box to use a stored procedure to define any of the parameters:
    1. Select the correct stored procedure in the menu
      • Which stored procedures are shown is defined by database settings
    2. Check the corresponding box
      • Only check the box for the parameters that you want the stored procedures to define, the rest can be defined manually
    3. Select the column you want to use in the menu
  9. If you want to set all or some of the subscription settings manually:
    • The subscription settings are different depending on whether you have selected email or Windows file share, continue with the corresponding section below


How to - Set Up an Email Subscription

  1. Enter the email address to the receiver in the to field
    • If there are more than one receiver, enter the addresses separated by semicolons
  2. If you want to send a copy of the email to another receiver, enter that email address in the cc field
    • If there are more than one receiver, enter the addresses separated by semicolons
  3. If you want to send a copy of the email to a receiver that you don't want to be shown to the other receivers, enter that email address in the bcc field
    • If there are more than one receiver, enter the addresses separated by semicolons
  4. Enter a subject for the email
  5. Enter a message text to be shown in the email
  6. In the include report menu, select if the report should be included in the email
    • Yes - the report is included in the email as an attachment
    • No - the receiver is notified that there is a new report by an email which contains a link to where the report can be accessed
  7. Select the report format; PDF or Excel
  8. The file name for the generated report will be the default file name, if not using the stored procedure to set the file name
  9. Define the path where the report is to be placed, temporarily if emailing the reports or permanently if the report is not included in the email
  10. Define the report selection according to the information for that specific report
  11. Click save
  12. If you want these emails to be sent out regularly, click the tab schedules to set up a schedule


How to - Set Up a Windows File Share Subscription

  1. Select the report format; PDF or Excel
  2. Define the file name for the generated report
  3. Define the path where the report is to be placed when using the file share function, make sure the file path is shared on the server with the correct user
  4. Define the report selection according to the information for that specific report
  5. Click save
  6. If you want this report to be generated regularly, click the tab schedules to set up a schedule


How to - Edit an Existing Subscription

  1. Click on the name of the subscription you want to edit
    • The Edit subscription view is displayed
  2. Edit the necessary properties
    • For details on the settings, see the add a new subscription section above
  3. Click save


How to - Disable/Enable a Subscription

  1. Click on the name of the subscription you want to disable/enable
  2. Change the enabled setting for the subscription
    • To enable - ensure that the box is checked
    • To disable - ensure that the box is not checked
  3. Click save


How to - Delete a Subscription

  1. Check the box for each subscription you want to delete
  2. Click the icon Icon Links.png to open the action menu in the toolbar above the table, and select delete
    • The subscription is immediately deleted


How to - Run a Subscription Manually

  1. Click run Icon Run.png for the subscription you want to run instantly (the report will be generated and sent out by email or placed on the server according to the subscription settings)
    • Click cancel Icon Cancel.png if you like to cancel your scheduled report
    Note: To cancel a scheduled report is only possible in the first part of the process and the icon Icon Alarm Status Not OK.png is shown when the subscription has been cancelled


How to - Create or Edit the Schedules of the Subscriptions

  1. To edit the schedules of how often the report is to be generated, click the schedules tab


How to - Check Subscription History

  1. To check the subscription history, click the History tab


How to - Send E-mail to Subscription Recipients

  1. Check the box for each subscription you want to send a message to, based on subscription recipients
    • All recipients from the subscription will receive the email
  2. Click the icon Icon Links.png to open the action menu in the toolbar above the table, and select send e-mail to recipients
    • The view send e-mail to recipient opens
  3. Enter a subject and a message or load from subscription
  4. Click send


How to - Check Send E-mail to Subscription Recipients History

  1. To check the history for Send E-mail to Subscription Recipients, click the History tab


Note: History about Send E-mail to Subscription Recipients is only updated in the e-mail section on the History tab