Working with Events › Schedule a Report

Schedule a Report

You can schedule reports using Events to save the output on the server for viewing later. When defining a Report Event, you can specify a list of users to notify by email when the report execution is complete. You can also grant permission to a list of users to view the report output.

Follow these steps:

1. Open the Services perspective.

   A list of server connections is displayed in the Services view.

2. Right-click Events under your server connection, and click Open from the pop-up menu.

   The Events view opens.

3. Right-click in the listing, and select New Report Event from the pop-up menu.

   The Properties tab of the New Report view opens.

4. Complete the following required fields:

   Event prefix

   Defines a prefix for the Event.

   Limits: Up to 32 characters

   Note: To set a default prefix, from the main menu click Window, Preferences, Desktop Client, Services Perspective, Event, and enter the default prefix in the Prefix field.

   Event name

   Defines the name of the Event.

   Limits: Up to 128 characters

   Note: The prefix and descriptive name uniquely identify the Event on the system where it resides.

   Priority

   Specifies the Event priority as an integer from 1 (lowest priority) through 10 (highest priority). When multiple Events are eligible for execution at the same time, the server triggers the Events in descending priority order.

   Default: 5

   Note: To set a default Event priority, from the main menu click Window, Preferences, Desktop Client, Services Perspective, Event, and enter the default priority in the Priority field.

   Report

   Specifies the name of the report to run when the Event triggers. The drop-down list displays the reports defined on the server.

5. (Optional) Specify the following additional information:

   Execution user

   (Optional) Specifies the execution user for the Report Event. The execution user can always view and delete the output of a report.

   Default: Name of the user defining the Event

   Note: The execution user requires the REPORTX and REPORT_DESIGN permissions to execute the report triggered by the Event.

   Inherit trigger user

   Overrides the execution user for Events triggered manually. If this option is set, the execution user is set to the user that manually triggered the Event.

   Note: To apply this option to all the Events you define, from the main menu click Window, Preferences, Desktop Client, Services Perspective, Event, and select the Inherit trigger user check box.

   Specify Calendars

   Specifies up to two calendars that are used to schedule the Event.

   Default: SYSTEM calendar

   Note: If your Event uses any terms in a calendar other than the SYSTEM calendar, specify those calendars in this section. You can set default calendars by selecting Window, Preferences, Desktop Client, Services Perspective, Event from the main menu.

6. (Optional) Select the Schedule tab to schedule the report.

   The Schedule tab opens.

7. Click Add Schedule, and type your scheduling criteria in the When field.

   Note: If you are unfamiliar with the scheduling terms, you can build and test your schedule criteria by clicking the ellipses (…).

8. (Optional) Select the Parameters tab to specify parameters for the report.

   The Parameters tab opens.

   Note: The parameters that you see depend on the report you selected in the Report field in the Properties tab.

9. Specify the parameter information as required.

   Notes about date parameters:

   • When specifying date parameters for scheduled reports, use relative dates, not absolute dates. When the report runs, the server evaluates the date parameters relative to the report execution time. For example, you can schedule the Failed Jobs report weekly to report on the jobs that failed during the previous week using the following relative dates:
     • From Date Time—1st day of this week starting today less 1 week
     • To Date Time—last day of this week starting today less 1 week
   • To help specify relative date parameters, you can click the button to the right of the date parameter field to build and test your schedule criteria using the Define Report Date Parameter dialog. The Define Report Date Parameter dialog is similar to the other scheduling dialogs that you use to simulate or schedule Events. For example, the following selections specify the first day of the previous week (1st day of this week starting today less 1 week):
     • Occurrences—1st
     • Type of Day—day
     • Period type—previous 1
     • Period—week

     You can test the generated statement by clicking Test. The Test results text box displays only one result.

10. (Optional) Select the Result Options tab to specify options for the report.

    The Result Options tab opens.

11. (Optional) Grant permission to a list of users to view the report output as follows:
    1. Click Add in the Users allowed to read the report section.

       A row is added to the table.

    2. Specify the name of the user in the Name field.
    3. (Optional) Add additional users as required.
12. (Optional) Specify a list of email addresses to notify when the report execution is complete as follows:
    1. Click Add in the E-mail addresses to be notified section.

       A row is added to the table.

    2. Specify the email address in the Name field.
    3. (Optional) Add additional email addresses as required.
    4. (Optional) Select the Attach report check box to attach the report results in PDF format to the email notifications.
13. Click Save at the top right corner of the New Report view.

    The server triggers the Event and runs the report at the scheduled dates and times.

More information:

Predefined Reports