How to schedule an SQL report

This document will outline how to schedule a report to run at a set time and date and have the results sent as an email. 

Defining the schedule

To schedule a report, go to Reports > Guided Reports > Use saved and identify the report to be scheduled.

For more information about how to find a report, please check our Help Centre or contact Interleaf Technology directly.

Go to the far right of the row the report is on and hit the arrow button to get a list of options. Click on Schedule.

This will take you to a new page with a form of information to fill out, which will determine when and where you want the report results to be sent.

Time:

Define the time the report results should be sent out. This feature uses the 24 hour clock to the format of the time added in this field should reflect that i.e: 15:00 for 3 pm.

Date:

On what date should the report be run and the results sent out. There is a calendar option to select the specific day.

Report:

This works to confirm the report being set to run, but also give the option of changing the report without having to go back to the saved reports table. 

Output format:

This can be Text, CSV or HTML.

Email:

This is the address the results of the report will be mailed to so it must be accurate and active.

Once these fields are filled out and saved a line will appear below the Task scheduler with details of the job.

After the report has run and the results have been sent, the line will disappear. 

Receiving the results

Once the report runs, the results will be sent to the email address specified in the Task scheduler.

Important points

In order for a report to be schedulable it must not require any additional input once you hit run. For example, if a report required a specific branch to be selected it would not work with the report scheduler because it would be waiting for the branch to be defined, which requires manual intervention.

As with manually running reports if a report is scheduled that is very large there is the possibility that the site will slow down when it is triggered to run, and care should be taken with the size of reports being run. 

Version History
Version	Date	Detail	Author
1.0	14/01/2019	Document Created	Holly Cooper
2.0	26/05/2020	Transferred to Zoho	Daphne Hoolahan
2.1	16/02/2021	Adding TOC and clarifying language	Holly Cooper
2.2	02/01/25	Updating for newer version of Koha	Holly Cooper
Retention Policy
Permanent		X

• Related Articles

• How to Find and Run a SQL Report

  What are reports for? Reports are used to find and present data about the information on the system in a structured manner. Reports use SQL to ask questions of the Koha database. How to find reports on your system Go to the Reports module on the Koha ...

• Overview of some SQL Report Functions

  Overview of SQL Report Functions This FAQ is an example of a simple report describing the “anatomy” of the SQL code used.  Details about the different functions are outlined in the table below the report.  Some functions are mandatory to use in order ...

• SQL Report Request Form

                    To allow the support desk help you create SQL reports, please use please use the following form when requesting a SQL report. A downloadable form is available as an attachment at the bottom of this page. Log a ticket on the support ...

• How to Report on Star Ratings

  If star rating are enabled on the OPAC, staff members may wish to view details about how the feature is being used. This document will provide a basic SQL report which can be used to identify star ratings on the site. Step 1 - Navigate to the report ...

• Scooter - Start of Term Instructions

  Scooter 2 Start of Term Document This document is intended to be a set of guidelines for starting a new school year with Scooter. Included in it are answers to some commonly asked questions and links to resources to help you get started, or return to ...