Report Subscription Details

Report subscriptions allow you to pre-schedule specific reports and provide the results to multiple users. Subscriptions can be created for printable reports and published ad hoc reports.

This topic provides a reference to the fields and settings available when configuring report subscriptions.

For more information on report subscriptions, see Report Tools Overview.

Subscription Overview Section

Select a Report
Choose from a drop-down list of reports available for subscriptions. All printable reports can be used with report subscriptions, as well as all published ad hoc reports.
Description
Allows you to enter a description of the report's purpose, content, or both.

The remaining fields in this section appear only if you are editing an existing subscription.

Active
Displays the status of the subscription. This value should always be Active.
Event Type
Displays the type of event that applies to the subscription. This value should always be TimedSubscription.
Created by
Displays the name of the user who created the subscription.
Date Created
Displays the date and time the subscription was first saved.
Modified by
Displays the name of the user who last saved the subscription, even if no changes were made. If the subscription has never been modified, displays the name of the user who created the subscription.
Date Modified
Displays the date and time the subscription was last saved, even if no changes were made.
Last Executed
Displays the date and time the subscription was last executed.
Path
Displays the relative UNC path for the report used in this subscription.
Execution Status
Displays information related to the last time the subscription ran. If a subscription did not run successfully, this field provides information to help troubleshoot the issue. If the subscription has not yet been executed, the field displays New Subscription.

Report Delivery Options Section

Delivered by
Choose either E-Mail or Windows File Share from the drop-down list. The default value is E-Mail. The fields in this section are different depending on the option you choose.
To
Allows you to enter email address(es) for primary recipient(s). Use a semi-colon to separate addresses. This field appears only when you select E-Mail for the Delivered by field.
Cc
Allows you to enter email address(es) for secondary recipient(s). Use a semi-colon to separate addresses. This field appears only when you select E-Mail for the Delivered by field.
Bcc
Allows you to enter email address(es) for secondary recipient(s). Use a semi-colon to separate addresses. This field appears only when you select E-Mail for the Delivered by field.
Reply-To
Allows you to enter an email address to which recipients should respond if they have questions. This field appears only when you select E-Mail for the Delivered by field and is required.
Subject
Allows you to customize the subject line for the email. The default value is @ReportName was executed at @ExecutionTime. This field appears only when you select E-Mail for the Delivered by field.
Include Report
Allows you to select the checkbox to include the report as an email attachment. The default value is selected. This field appears only when you select E-Mail for the Delivered by field.
Render Format
Allows you to specify the format for the delivered report. Select one of the following values from the drop-down list: CSV (Comma Delimited, Acrobat (PDF) file, MHTML (Web Archive), Excel, TIFF file, Word, or XML file with report data.
Priority
Allows you to specify a priority for email delivery of the report subscription. Choose one of the following from the drop-down list: Low, Normal, or High. This field appears only when you select E-Mail for the Delivered by field.
Comment
Allows you to enter text that displays in the body of the email. This field appears only when you select E-Mail for the Delivered by field.
File Name
Allows you to enter a name for the saved report file. This name does not have to be the same as the name of the report. This field appears only when you select Windows File Share for the Delivered by field, and is required.
Add a file extension when the file is created
Specifies whether Uptivity should append the correct file extension to the file name based on the Render Format. The default value is selected. This field appears only when you select Windows File Share for the Delivered by field.
Path
Allows you to enter the complete UNC path for the location where the report will be saved. This field appears only when you select Windows File Share for the Delivered by field, and is required.
Render Format
Allows you to specify the format for the delivered report. Select one of the following values from the drop-down list: CSV (Comma Delimited, Acrobat (PDF) file, MHTML (Web Archive), Excel, TIFF file, Word, or XML file with report data.
Username
Allows you to enter the username as part of the credentials used to access the file share where the report is saved. This field appears only when you select Windows File Share for the Delivered by field, and is required.
Password
Allows you to enter the password as part of the credentials used to access the file share where the report is saved. This field appears only when you select Windows File Share for the Delivered by field, and is required.
Overwrite options
Allows you to specify how Uptivity should handle the report if earlier versions exist. Select from the following options: Overwrite an existing file with a newer version, Do not overwrite the file is a previous version exists, or Increment file names as newer version are added. This field appears only when you select Windows File Share for the Delivered by field, and is required.

Schedule Processing Options Section

You can from two options for processing the report subscription: On a shared Schedule or When the scheduled report run is complete. The default value is When the scheduled report run is complete. If you select On a shared Schedule, you can select from a drop-down list of available shared schedules (see Shared Schedules). The following sub-sections do not apply.

If you select Hour under Schedule Details, you must configure these fields:

Run the schedule every
Allows you to specify, in hours and minutes, how frequently the report should be run.
Start time
Allows you to specify a start time for the schedule by entering numeric values for HH:MM and then selecting either A.M. or P.M.

If you select Day under Schedule Details, you must configure these fields:

Repeat after this number of days
Allows you to specify how frequently the report should be run. For example, enter 1 to run the report every day, 2 to run it every other day, and so forth.
Start time
Allows you to specify a start time for the schedule by entering numeric values for HH:MM and then selecting either A.M. or P.M.

If you select Week under Schedule Details, you must configure these fields:

Repeat after this number of weeks
Allows you to specify how frequently the report should be run. For example, enter 1 to run the report every week, 2 to run it every other week, and so forth.
On day(s)
Allows you to specify the day(s) of the week on which the report should be run. For example, if you want to run a report only on weekdays, you can set up a weekly schedule and select multiples values (that is, Monday through Friday) for this field.
Start time
Allows you to specify a start time for the schedule by entering numeric values for HH:MM and then selecting either A.M. or P.M.

If you select Month under Schedule Details, you must configure these fields:

Months
Allows you to specify how frequently the report should be run. Select the checkbox for each month in which you want the report subscription to be fulfilled.
On week of Month
Allows you to specify the week of the month during which the report should be run. Select one of the following from the drop-down list: 1st, 2nd, 3rd, 4th, or Last.
On day of week
Works with the previous setting and allows you to specify the day of the week on which the report should be run. Select one of the following: Sun, Mon, Tue, Wed, Thu, Fri, or Sat.
On calendar day(s)
Allows you to select one or more calendar days, instead of a day of the week, on which the report should be run. Enter one or more numeric values separated by commas. You can also enter a range (for example, 3-5).
Start time
Allows you to specify a start time for the schedule by entering numeric values for HH:MM and then selecting either A.M. or P.M.

If you select Once under Schedule Details, the report subscription will run only one time and you must configure this field:

Start time
Allows you to specify a start time for the schedule by entering numeric values for HH:MM and then selecting either A.M. or P.M.
Begin running this schedule on
Allows you to use a date selector to specify when the report subscription should run for the first time. This field is required.
Stop this schedule on
If you select the checkbox, you can use a date selector to specify when the report subscription should end. If you leave the checkbox cleared, the report subscription will continue to run until it is either manually deleted or edited to contain a value in this field.

Report Parameters Section

The options in this section vary depending on the report associated with the subscription. By default, all report parameters are set to the values you would see if you looked at the report itself. However, you can change the values for purposes of the report subscription by clearing the Use Default checkbox and entering new values.

For more information, see the topic for the specific report in your subscription.

Related Tasks