Difference between revisions of "Documentation/Scheduling/Manage Batch Schedules"

Latest revision as of 23:39, 6 October 2020

Documentation :: Scheduling :: Managing Batch Schedules

Batch Schedules provide a means of grouping collections of scripts to run in a pre-defined order at a daily, weekly or monthly frequency. For more information on Batch Schedules, see Batch Schedules and Jobs .

Creating A Batch Schedule

From the menu, select Schedules > Batch Schedules > Manage Batch Schedules.

Click .

The Create Batch Schedule window should now be shown.
- Schedule Name: A name to describe what your Batch Schedule will be doing. This name will be used to refer to the schedule in order screens in ScriptRunner.
- Description: Space to provide a longer description of what this Batch Schedule is used for.
- Day Of Week: The day of the week the Batch Schedule will run.
- Day Of Month: The day of the month the Batch Schedule will run. Enter 0 for every day.
- Enabled: Tick to allow Batch Schedule Jobs linked to this Batch Schedule being created and run. Unticking will prevent Batch Schedule Jobs being created. Those that have already been created as instances however will still be able to run.

Click .

The new Batch Schedule will now be saved. You can now add Batch Schedule Jobs to it.

Editing Batch Schedules

From the menu, select Schedules > Batch Schedules > Manage Batch Schedules.

Click against the Batch Schedule you wish to update. Use and to scroll through pages of groups if needed.

The Create Batch Schedule window should now be shown.
- Schedule Name: A name to describe what your Batch Schedule will be doing. This name will be used to refer to the schedule in order screens in ScriptRunner.
- Description: Space to provide a longer description of what this Batch Schedule is used for.
- Day Of Week: The day of the week the Batch Schedule will run.
- Day Of Month: The day of the month the Batch Schedule will run. Enter 0 for every day.
- Enabled: Tick to allow Batch Schedule Jobs linked to this Batch Schedule being created and run. Unticking will prevent Batch Schedule Jobs being created. Those that have already been created as instances however will still be able to run.

Click .

Changes to the Batch Schedule will be now saved. Any Batch Instances already created from this schedule will not be modified, changes will only apply to future created Batch Instances from this schedule.

Removing Script Groups

From the menu, select Schedules > Batch Schedules > Manage Batch Schedules.

Click against the Batch Schedule you wish to remove. Use and to scroll through pages of groups if needed.

Click on the confirmation prompt.

.

The Batch Schedule will now be removed. All Batch Schedule Jobs linked to this Batch Schedule will also be removed at the same time. Any Batch Instances created from this Batch Schedule though will remain and continue to run if there are outstanding jobs.

@@ Line 12: / Line 12: @@
 * Click [[File:newButton.png]].
-* The Create Batch Schedule window should now be shown.<br /><br />[[ File: createBatchSchedule.png ]]<br />
+* The Create Batch Schedule window should now be shown.<br /><br />[[ File: createBatchSchedule.png ]]<br /><br />
 ** '''Schedule Name''': A name to describe what your Batch Schedule will be doing. This name will be used to refer to the schedule in order screens in ScriptRunner.
 ** '''Description''': Space to provide a longer description of what this Batch Schedule is used for.
@@ Line 21: / Line 21: @@
 * Click [[File:saveButton.png|100px]].
-* The new Batch Schedule will now be saved. You can now add [[ Documentation/Scheduling/Batch Schedule Jobs | Managing Batch Schedule Jobs ]] to it.
+* The new Batch Schedule will now be saved. You can now add [[ Documentation/Scheduling/Managing Batch Schedule Jobs | Batch Schedule Jobs ]] to it.
+'''Editing Batch Schedules'''
+* From the menu, select Schedules > Batch Schedules > Manage Batch Schedules.
+* Click [[File:editButton.png]] against the Batch Schedule you wish to update. Use [[ File: previous.png ]] and [[ File: next.png ]] to scroll through pages of groups if needed.
+* The Create Batch Schedule window should now be shown.<br /><br />[[ File: editBatchSchedule.png ]]<br /><br />
+** '''Schedule Name''': A name to describe what your Batch Schedule will be doing. This name will be used to refer to the schedule in order screens in ScriptRunner.
+** '''Description''': Space to provide a longer description of what this Batch Schedule is used for.
+** '''Day Of Week''': The day of the week the Batch Schedule will run.
+** '''Day Of Month''': The day of the month the Batch Schedule will run. Enter 0 for every day.
+** '''Enabled''': Tick to allow Batch Schedule Jobs linked to this Batch Schedule being created and run. Unticking will prevent Batch Schedule Jobs being created. Those that have already been created as instances however will still be able to run.
+* Click [[File:saveButton.png|100px]].
+* Changes to the Batch Schedule will be now saved. Any Batch Instances already created from this schedule will not be modified, changes will only apply to future created Batch Instances from this schedule.
+'''Removing Script Groups'''
+* From the menu, select Schedules > Batch Schedules > Manage Batch Schedules.
+* Click [[File:removeButton.png]] against the Batch Schedule you wish to remove. Use [[ File: previous.png ]] and [[ File: next.png ]] to scroll through pages of groups if needed.
+* Click [[File:removeConfirmButton.png|100px]] on the confirmation prompt.<br /><br />[[File: removeBatchSchedule.png]].
+* The Batch Schedule will now be removed. All Batch Schedule Jobs linked to this Batch Schedule will also be removed at the same time. Any Batch Instances created from this Batch Schedule though will remain and continue to run if there are outstanding jobs.