User Guide for the Cisco Unified Intelligence Center Reporting Application, Release 9.1(1)
Scheduler
Downloads: This chapterpdf (PDF - 1.22MB) The complete bookPDF (PDF - 6.53MB) | The complete bookePub (ePub - 2.09MB) | Feedback

Scheduler

Scheduler

You can automate the generation of reports on a regular and recurring basis by setting up a schedule.

You can configure scheduled reports in the following ways:
  • To run at predetermined times
  • To be automatically sent to email recipients
  • To be added to the dashboard
  • To be saved to remote location

Scheduling lets you run large dataset reports once to be sent to, and viewed by, many users.

Click the Scheduler drawer in the left panel to open the Schedule List. Only users with Report Designer and System Configuration Administrator roles can access the Scheduler drawer.

  • System Configuration Administrators can perform all scheduler function on any reports. They can read, edit and run any scheduled report and can create a schedule for any report.
  • Report designers can create a schedule only for those reports that they created or for which they have Execute permissions.

Note


  • Edit means being able to select the scheduled report on the Schedule List and Edit, Delete, Enable, or Disable it. Execute means being able to select the scheduled report on the Schedule List and perform the Run Now operation.
  • Configure Email Settings! Scheduled reports can be sent by email only if the email server has been configured in the Administration Console. The administrator does this in Cluster Configuration > Reporting Configuration > Report Scheduler Email Settings.
  • All actions on the Scheduler interface are based on User Role and on the user's object Permissions for schedules.

See also Troubleshooting Report Schedules.

Schedule List

This page opens when you click the Scheduler drawer.

System Configuration Administrators can create, review, and manage report schedules.

Report Designers can create, review, and manage report schedules that they own. Report Designers can also create schedules from the Available Reports page by right-clicking a report and selecting Schedule.

Table 1 Rows on This Page

Field

Description

Scheduled Name

The name of the scheduled report.

Schedule Execution

The field displays the last run and the last Status of the scheduled report.
Note   
  • Last Run specifies the date and time that the schedule report ran for the last time.
  • Last Status specifies the status of the last schedule report that ran.

Destination

The field specifies the destination type and the result of the corresponding destination type.

Type—specifies the mode through which the result is sent.

The mode through which the result is sent can be through any one of the following:
  • Email
  • Remote location
  • Dashboard
Note   

If the Scheduled report is sent through email then the type field displays Email. If the Scheduled report is saved in a remote location then the type field displays Remote Location. If the Scheduled report is not sent through an email or saved to a remote location then the type field displays Dashboard. (However the other types also can be added to the dashboard.)

Result—specifies the status of the destination type.

Note   

If email is sent successfully or the scheduled report is saved to a remote location, there is a tick mark in this field. If email is not sent successfully or the scheduled report is not saved to a remote location, there is a cross mark in this field. If the scheduled report is saved to the dashboard, this field is empty as it is the same status as scheduler Last Status.

Next Scheduled Run

The date and time for the next time this schedule runs.

Scheduled By

The user who created this schedule.

Frequency

The frequency for this schedule (Daily, Monthly...)

Actions From This Page

  • Filter/Clear—Type one or more characters and click Filter to narrow down the list. Click Clear to remove the filter.
  • Create—Opens the Report Schedule Create/Edit page with blank fields for defining a new schedule.
  • Edit—Enabled when a row is selected, opens the Report Schedule Create/Edit page where you can modify a schedule.
  • Delete—Enabled when a row is selected, prompts for a confirmation and then deletes the schedule. If the schedule is deleted, you see an error if you try to open it. You can, however, retrieve the data by running the report with the same date and time range represented in the deleted scheduled report.
  • Enable—Enables the schedule.
  • Disable—Disables the schedule.
  • Run Now—Executes the scheduled report immediately. Does not affect the next scheduled job.
  • Refresh—Updates the schedule list page to reflect any changes.
  • Help—Opens online help.
  • X—Closes the page.

Scheduler Create/Edit Page

Use this page to create or to edit a schedule for emailing a report or displaying it on a dashboard, and saving a CSV file to a remote location.

Table 2 Rows on This Page

Field

Description

General Settings

Schedule Name

Enter a name that identifies the Scheduled Report (for example, Sales Team End of Week Report).

Report

From the drop-down menu, navigate to and select the report you want to schedule.

Set Filter

You cannot schedule a report that does not have a filter

Leave the check box blank to use the default filter.

Check the box to enable the Set filtering criteria link. This opens either the Basic Filters Tab or the Basic Filter Tab for Anonymous Block/Stored Procedure, depending on the type of query in the Report Definition.

Duration

To set the timeframe for this scheduled report:

  1. Use the calendar icon to select a Start Date.
  2. Check No End Date, or use the calendar icon to select an End Date.

Recurrence Pattern

Specify how frequently you want this scheduled report to run. Choose from:

  • Once—Opens a field where you select the time of day for the single occurrence.
  • Daily—Opens a field where you select a number for recurrence of days; for example, every four days.
  • Weekly—Opens fields where you select the recurrence of weeks (for example, every two weeks) and the days of the week you want the scheduled report to be run.
  • Monthly—Opens fields where you select a specific day of the month or the frequency during the month (for example, every second Wednesday) and the recurrence of months (for example, every three months) that you want the scheduled report to run. One option for Monthly, in the Day field, is Last. This accounts for a range of months that might have different last days (31, 28, 30).

Daily Frequency

Specify how often you want the report to run on the day (days) you have scheduled.

  • Occurs once at: the time of day
Note    The maximum frequency with which you can schedule a report is once every five minutes.

Email

Click the Email tab to send the file through an email.

  • Email Distribution—Click Add to display a popup where you can enter an email address. Click OK to add that address to the Email Distribution field. Repeat to add multiple email addresses.
    Note   

    Email page validation occurs when the email ID is entered in the 'email distribution' field. No validation is performed if there is no email ID entered in the 'email distribution' field.

    Select an email address and click Delete to remove that address from the distribution.
  • Email View—From the drop-down menu, select the name of the view that you want to email.
  • Email Subject—Enter text for the subject line.
  • File Type—Select the type of file to be sent through mail from the drop-down list.
    Choose from:
    • INLINE HTML—Sends the email message in inline HTML format. The historical report has an upper limit of 8,000 rows. The realtime report has an upper limit of 3,000 rows.
    • PDF—Send the email message with a PDF file attachment. Based on the page orientation selected, that is either Landscape or Portrait, the PDF of the report is generated (Landscape is selected by default). Only 1000 rows are supported for a PDF file attachment. If the scheduled report exceeds 1000 rows, the PDF is not generated and an email message is sent stating that the number of rows exceeded the PDF generation limit.
      Note   
      • The generated PDF always uses standard font size (10px for Landscape orientation and 8px for Portrait orientation) and it bypasses the font size set in grid view editor to keep the PDF printer friendly. The user can zoom in and zoom out to view the PDF.
      • The PDF output retains only those rows which fit within the page for the selected orientation. Rows that do not fit within the page are truncated.
      • The generated PDF does not support multibyte characters.
    • XLS—Sends the email message with a Microsoft Excel file attachment. The historical report has an upper limit of 8,000 rows. The realtime report has an upper limit of 3,000 rows.
      Note   

      Only http images are supported for threshold images in the scheduled report for both PDF and XLS file attachments.

Note   

Email settings must be configured in the Administration application (Cluster Configuration > Reporting Configuration > Report Scheduler Email Settings tab).

Save To Remote Location Information

Save to Remote Location

Click on Save to Remote Location to save the file in a remote location

  • Protocol—Select SFTP protocol from the drop-down menu to establish a secured connection to the remote location.
    Note   

    Save to remote location validation occurs when the protocol is selected from the protocol drop-down list. No validation is performed if no protocol is selected.

  • Host—Enter the IP address of the remote location.
  • Port—Enter the port number (default value is 22).
  • User name—Enter the user name of the host.
  • Password—Enter the password of the host.
  • Directory Path—Enter the directory location on the host where the .csv file must be saved.

Note


The Scheduler uses the time zone of the user who creates the schedule. The time zone of the user is set for each user on the User List Page.

Note


Every time you edit a scheduled report and click Save, Scheduler runs and sends the scheduled report by email to all the recipients that are configured in the Email Distribution field.


Actions on This Page

  • Save—saves your new entry or changes to the fields and sends the scheduled report by email to all the recipients that are configured in the Email Distribution field.
  • Cancel—cancels your changes and closes the page.
  • Refresh—refreshes the fields to the previously saved values.
  • Help—opens online help.
  • X—closes the page.

Time Zone Considerations for Scheduled Reports

The system considers all the time-specific data in the scheduled report filter as local to the time zone of the last user. The system converts this time to data source time zone when the filter query is formed.

The system considers the time-specific data that the scheduler fetches from the data source as local to data source time zone. The system then converts this time to the time zone of the last user before preparing the date and time in the scheduled report.

However, if the user or data source does not have a time zone set, then it uses the Unified Intelligence Center server time zone. For more information see Reports and Time Zones.

Daylight Savings Time and Scheduled Reports

Daylight Savings Time affects the scheduled reports in the following ways:
  1. Reports that are scheduled to run daily during a particular time of the day are skipped for the day when the clock advances (for example, due to daylight saving). For example, for a report scheduled to run at 10:30 p.m. daily, if the clock advances by 1 hour then the report that is scheduled to run at 10:30 p.m. will be skipped for that day.
  2. Reports scheduled to run only once, are updated with a new schedule time with some offset if it falls in the period that advances. For example, if the clock advances by one hour for a report scheduled to run once at 10:30 p.m., then the schedule report run time updates to 11:30 p.m.