Difference between revisions of "Documentation/Scheduling/Timed Scheduled Scripts"

Revision as of 23:34, 1 October 2020

Documentation :: Scheduling :: Time Scheduled Scripts

ScriptRunner provides the ability to schedule scripts to run at specific times. This is not intended to provide a replacement for tools such as cron, but can be useful when you want to capture the output of the script within ScriptRunner, or have ScriptRunner alert when the job fails. This can be extended further with Batch Schedules that allow scripts dynamically chained together.

Creating A Scheduled Script

From the menu, select Schedules > Time Scheduled Scripts.

Click .

The Create Time Scheduled Script window should now be shown.
- Description: A descriptive name that will be used to reference the job in other areas of ScriptRunner, including alerts.
- Script: Select the script you wish to schedule. Only scripts applicable to your user group will be shown.
- Start Time / End Time: (Optional) These define the time period in which the schedule will be triggered. Outside of the time window defined by these, the Time Scheduled Script will be not started. This can be useful for when wanting to schedule scripts to run only for a limited period of time, and then automatically stop.
- Script Host: Select the host the scheduled script should trigger on. See the Selecting a Script Host section below regarding some considerations that need to be given here.
- Run Time: The time the script should trigger in format HH:MM.
- Day Of Week: Select the day of week the script should trigger on.
- Day Of Month: Enter the day of the month the script should trigger on, or 0 for every day.
- Enabled: Tick this to allow the Time Scheduled Script to trigger and planned, or untick to prevent it running.

Click .

The Time Scheduled Script should now be saved and picked up to run a the given schedule.

Selecting A Script Host

As scripts can be set to run on specific hosts, setting the Script Host value on a Time Scheduled Script doesn't mean it will run on that host, only that it will be triggered on that host.

@@ Line 10: / Line 10: @@
 * Click [[File:newButton.png]].
+* The Create Time Scheduled Script window should now be shown.<br />[[File: createTimeScheduledScript.png]]
+** '''Description''': A descriptive name that will be used to reference the job in other areas of ScriptRunner, including alerts.
+** '''Script''': Select the script you wish to schedule. Only scripts applicable to your user group will be shown.
+** '''Start Time / End Time''': (Optional) These define the time period in which the schedule will be triggered. Outside of the time window defined by these, the Time Scheduled Script will be not started. This can be useful for when wanting to schedule scripts to run only for a limited period of time, and then automatically stop.
+** '''Script Host''': Select the host the scheduled script should trigger on. See the Selecting a Script Host section below regarding some considerations that need to be given here.
+** '''Run Time''': The time the script should trigger in format HH:MM.
+** '''Day Of Week''': Select the day of week the script should trigger on.
+** '''Day Of Month''': Enter the day of the month the script should trigger on, or 0 for every day.
+** '''Enabled''': Tick this to allow the Time Scheduled Script to trigger and planned, or untick to prevent it running.
+* Click [[File:saveButton.png|100px]].
+* The Time Scheduled Script should now be saved and picked up to run a the given schedule.
+'''Selecting A Script Host'''
+As scripts can be set to run on specific hosts, setting the Script Host value on a Time Scheduled Script doesn't mean it will run on that host, only that it will be triggered on that host.