Scheduling Reports

The Scheduling tab allows the report definition to be scheduled for execution.

Scheduling Tab
Figure: Scheduling Tab

Note that the reporting daemon must be running to facilitate report execution. It runs periodically to check the next recurrence date for a Report Definition. Once the next recurrence date arrives, it executes the report and distributes it via the specified delivery method. Please refer to chapter Managing Daemons for details on starting daemons.

To schedule your report definition for execution, select Schedule this Report Template to be executed with one or more Recurrences.

Make sure you have saved your report definition, otherwise the recurrence does not become effective.


Figure: Enable Scheduling of your Report Definition Execution

Now you can set properties for your scheduling.

Setting Parameter Mappings

All date and date/time parameters appear in the Map Report Execution Time to field. You may select one or more of these parameters to map the report execution time to.

Parameter Mapping
Figure: Parameter Mapping

Setting Recurrence Intervals

There are different pattern you can select to set the recurrence interval:

Setting the Range of Recurrence

In the Range of Recurrence section, set the start date and optionally no end date, a specific end date or to end after a specific number of occurrences.

Range of Recurrence
Figure: Setting the Range of Recurrence

Setting Report Delivery Options

You can set the following delivery options:

Report Delivery Options
Figure: Setting delivery options

Delivering via E-Mail

The subject of the E-mail is of the pattern report_instance_name_YYYYMMDD_hhmmss. The report instance is attached to the E-mail with this name pattern as HTML file created with a default report template as described in section Email Report Template.

Note
E-mails are not encrypted. The option to deliver via E-mail should not be used for reports containing personally identifiable information!

See the following example E-mail:

Report Mail
Figure: Received Mail with Report in attachment

Email Report Template

The report email attachment uses a reportTemplate.html file as template. It is contained in the stardust-reporting-rt.jar file residing in the lib folder of your installed org.eclipse.stardust.ide.wst.facet.portal plugin.

You can use a custom reporting template instead of the default by adding a new reporting template to a templates folder in the Document Repository view of the Administration perspective or by replacing the default template in the above mentioned jar in the plugin directly.

Delivering via E-Mail to me

In case E-Mail to me is selected, an E-mail is sent to the E-mail address of the logged-in user, which is retrieved from the user profile.

Delivering via E-Mail to

In case E-Mail to is selected, an E-mail is sent to the address(es) entered in the entry box. Multiple addresses can be separated by semicolon or comma.

Viewing the next Execution Time

For convenience the Scheduling tab displays the next execution based on previous settings for a Scheduled Report Template.


Figure: Viewing the next execution time