Jaspersoft - Scheduling a Report

Issue/Question

  • How do I schedule reports in Jaspersoft?
  • How do I see my scheduled reports?
  • What options are available when scheduling a Jaspersoft Report?

Environment

  • Oregon State University
  • Jaspersoft

Resolution

Note: You cannot schedule ad hoc views in Jaspersoft. You can only schedule reports. To check if your query is a report check its type in your respository.

To schedule a report:

  1. Schedule a report by right-clicking on it in the Repository and choosing "Schedule".

  1. Click the "Create Schedule" button.

  1. Work your way through each tab - Schedule, Parameters, Output Options, and Notifications. Details on each are below
  2. Click "Save"
  3. Name the schedule (remember to include your username in the description)
  4. Click "Save"

Create Schedule Tabs

Schedule Tab

In the schedule tab:

1. You can schedule a report to run once on a specific day and time, such as while you are on vacation.

2. You can choose a simple recurrence schedule. This example would run once every 2 weeks until the end of the fiscal year.

 

3. You can choose a recurrence schedule based on specific calendar days. This example would run the report on the 15th of the month after every quarter ends.

Parameters Tab

In the Parameters tab you can set the parameters the report will run with on its schedue.

​​​​

Output Options Tab

On the "Output Options" tab, specify the name of the file that will be created containing the output from the report and give it a good description, including your username.

1. Specify the output format(s). PDF, CSV, or XLSX are useful formats.

Note: You may not want to choose "Excel" because that refers to the Excel 2003 XLS format, which doesn't support as many rows as the modern XLSX format for Excel workbooks. XLS format maxes out around 50,000 rows while XLSX usually maxes out around 1 million rows.

2. Under "File Handling", unless you need to keep every run of the report, choose "Overwrite Files".

  • If you do need to keep multiple copies of the report output, you may want to check "Sequential File Names by Timestamp" so that each report name has a specific run date and time.

3. Under "Output Destination", if you will only email the output as an attachment (a higher security risk), and never send a link to the output or want to open the output file from within Jaspersoft, you can uncheck "Output To Repository".

  • If you leave it checked, specify the output destination directory where you want the file saved.

Notifications Tab

On the "Notifications" tab, if you want any emails sent when the report is run, then specify who should receive it and how it should be sent.

1. Best practice is to only send the report to OSU email addresses. You can send the report to someone without Jaspersoft access, or someone in another Jaspersoft org, by sending it as an attachment or as HTML.

Note: Please consider the security risks, depending on what data is being sent. People should avoid clicking on links in emails unless they are expected, so please make sure that the recipient is expecting the email. The email will come from iar.ref@oregonstate.edu with the subject you defined at set up.​

View Schedules and Output

After creating a schedule, you return to the Scheduled Jobs window to view your scheduled reports. Here you can create an additional schedule if you need the same report run for different parameters. You can also:

  • Uncheck "Enabled" to disable the schedule, click the pencil to edit it, or click the trash can to delete it.
  • View the output from the last time the report ran if "Output to Repository" was checked. It will have a type of "Content Resource".

Assistance

For assistance, contact the UIT Data Team

Print Article