Configuring the Scheduler¶

The scheduler runs reports in the background according to a user-defined schedule (also called a job). You can configure the following aspects of the scheduler:

• Configuring the Scheduler Misfire Policy

• Configuring Scheduler Failure Notifications

• Restricting File System Output

• Removing Report Scheduling Interval Options

• Adding a Holiday Exclusion Calendar

• Changing the Default Output Folder

• Configuring the Scheduler for Dashboards

• Configuring the Scheduler to Fetch Attributes

• Configuring Job Persistence for Immediate Execution Schedule

Configuring the Scheduler Misfire Policy¶

A scheduler misfire occurs when the scheduler cannot run a report at the designated time, for example because JasperReports Server is offline, its database is offline, or the number of threads is limited. In this case, you can configure the behavior of the scheduler to retry the report or skip the scheduled run.

You can set a different misfire policy for each kind of job schedule: single job, repeating job, and calendar job. Misfire policies are defined in the Quartz Scheduler documentation and other online resources:

https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/tutorial-lesson-05.html

https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/tutorial-lesson-06.html

https://nurkiewicz.com/2012/04/quartz-scheduler-misfire-instructions.html

When importing scheduled jobs, all calendar jobs with misfired triggers are re-executed. This results in unwanted and unplanned executions. This can be overcome by changing the Misfire policy on the server. But, that will impact all other jobs along with the calendar trigger.

To avoid changing the misfire policy globally for all jobs with trigger, two new properties calenderTrigger.resetStartTimeOnImport and simpleTrigger.resetStartTimeOnImport are added in the js.quartz.properties file. The new properties skip firing calendar jobs right after import, and job is executed at the next trigger (calendar or simple) time.

Configuring Scheduler Failure Notifications¶

By default, if a scheduled report runs but causes an error, the scheduler sends an email to the schedule owner and to all JasperReports Server administrators in the same organization. This is in addition to any failure notification addresses specified on the Notifications tab of the scheduler wizard. To receive these scheduler failure alerts, administrators must have valid email addresses defined in their user accounts.

You can also configure the scheduler to send failure notifications to different users based on roles, or turn off failure notifications.

Restricting File System Output¶

The scheduler outputs reports through several channels. Most reports are emailed, but reports can also be written to FTP folders. You can also configure the scheduler to write reports to the server's local file system. This option is disabled by default for security reasons.

Removing Report Scheduling Interval Options¶

Users can schedule reports to run at regular intervals. The default interval can be expressed in weeks, days, hours or minutes. To prevent users from scheduling frequent reports, you can limit the intervals to days or hours by editing the following configuration file:

To remove a temporal interval, enclose the corresponding bean in comment characters. For example, to prevent users from scheduling reports at minute intervals, comment out the bean containing the INTERVAL_MINUTE field:

<!--
<bean class="com.jaspersoft.jasperserver.war.dto.ByteEnum">
    <property name="code">
        <util:constant static-field="com.jaspersoft.jasperserver.api.engine.scheduling.
            domain.ReportJobSimpleTrigger.INTERVAL_MINUTE"/>
    </property>
    <property name="labelMessage">
        <value>job.interval.unit.minute.label</value>
    </property>
</bean>
-->

Adding a Holiday Exclusion Calendar¶

The scheduler supports exclusion calendars to specify days or times when no report should be run, even if scheduled. For example, you might not want a report to run on a bank holiday when the financial data would be meaningless.

The scheduler maintains a list of named calendars, and the user interface allows the schedule creator to select a calendar whose dates will be excluded from the schedule.

Currently, the only method to define a holiday calendar is through the REST API. You can use any browser plug-in that acts as a REST client and can send PUT requests to JasperReports Server. Using such a plug-in, compose and send the following REST request (header and body) to your server:

PUT http://<host>:<port>/jasperserver[-pro]/rest_v2/jobs/calendars/2014FrenchHolidays
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportJobCalendar>
    <calendarType>holiday</calendarType>
    <description>2014 French Holidays</description>
    <excludeDays>
        <excludeDay>2014-01-01</excludeDay>
        <excludeDay>2014-04-18</excludeDay>
        <excludeDay>2014-04-21</excludeDay>
        <excludeDay>2014-05-01</excludeDay>
        <excludeDay>2014-05-08</excludeDay>
        <excludeDay>2014-05-29</excludeDay>
        <excludeDay>2014-06-09</excludeDay>
        <excludeDay>2014-07-14</excludeDay>
        <excludeDay>2014-08-15</excludeDay>
        <excludeDay>2014-11-01</excludeDay>
        <excludeDay>2014-11-11</excludeDay>
        <excludeDay>2014-12-24</excludeDay>
        <excludeDay>2014-12-25</excludeDay>
    </excludeDays>
    <timeZone>GMT+01:00</timeZone>
</reportJobCalendar>

For example, using the Poster plug-in for Firefox, you can submit this request as shown in the following figure. The figure also shows the successful reply from the server.

Figure 2 Creating a Holiday Calendar with REST Web Services

Then you should see your new calendar in the list of calendars in the Schedule tab.

Figure 3 Selecting a Custom Holiday Calendar in the Scheduler

The REST API supports other types of calendars, however, the user interface lists only calendars of type holiday. Using the REST API, you can create and manage any number of calendars and update any schedule to use them. For more information, see the JasperReports Server REST API Reference.

Changing the Default Output Folder¶

By default, the scheduler will save the output of scheduled reports to the directory in which the report resides and scheduled dashboard exports to the /public/Samples/Dashboards folder. You can change this default location to another folder in the repository by editing the applicationContext-report-scheduling.xml configuration file on the server.

To enable file data sources in the UI

1. Open the file <js-install>/WEB-INF/applicationContext-report-scheduling.xml for editing.
2. Locate the element <util:map id="reportJobDefaults">.
3. Update <entry key="scheduler.job.repositoryDestination.folderURI" value="/job_output" /> and replace "/job_output" with the URI for the new default folder in the repository.
4. Restart the server or redeploy the JasperReports Server web app. The new default folder appears on the Output Options tab when you try to schedule a report or dashboard.

Configuring the Scheduler for Dashboards¶

You can configure the following property to enable the scheduler and headless browser to load the dashboard on the server side and export it.

Configuring the Scheduler to Fetch Attributes for Graph API¶

You can configure the following property to enable the scheduler to fetch attributes for Graph API.

If properties are configured for tenant or hierarchical, the system creates beans (JavaMailSender and GraphServiceClient) with tenant-specific or hierarchical-specific attributes, respectively. Else, it creates beans using the default properties configured in the js.quartz.properties file.

Setting Properties in the jasperserver_config.properties File¶

You can set the following properties while composing emails:

Configuring the Scheduler to Fetch Attributes for SendGrid API¶

You can configure the following property to enable the scheduler to fetch attributes for SendGrid API.

If properties are configured per tenant level, then SendGrid API key must be defined in the profile attribute of the users belonging to that specific tenant.

Configuring the Scheduler Dashboard¶

To display execution metrics and logs in the Scheduler Dashboard, configure the following properties: