...
Feature Description
Schedules enable the automated execution of scripts at designated times, offering various options such as hourly, daily, weekly, monthly, or yearly
...
intervals. Custom repeat intervals can also be specified, allowing users to set specific time frames for Action execution. For instance, schedules can be
...
configured to run
...
every
...
few hours
...
on Tuesdays and Thursdays
...
on the last Wednesday of every month
You can also enable and disable schedules at runtime using the schedule.setEnable script function.
To open the Scheduler window, click Tools > Scheduler Editor…. > click the + icon to begin creating a schedule.
...
After adding a new schedule, users will be presented with a default menu, as shown below.
...
...
Item
...
Description
...
Schedule Title
...
Assign a title for the schedule
...
Start Date
...
Allows the user to assign a date for scheduler activities to start. Clicking the calendar icon will bring up a calendar menu that allows the user to navigate between months and years before selecting a date, as shown below.
...
...
Start Time
...
Allows the user to assign a time for scheduler activities to start. Users can specify a 24 HR time, or an AM/PM start time using the drop down menu to the the right of the entry field.
...
Repeat Every
...
Allows the user to assign a time interval for the scheduled activity to be repeated. Users can select from 5 different options in the drop down menu, as shown below.
...
For a selection of hours, days, or years, the Date Type field will not allow entries. Users can use the text box in the Repeat Every field to further specify the time interval.
For Example, with a selection of hours, users can enter a numerical value. For an entry of 3, the scheduler will execute the selected Action every 3 hours.
For a selection of Weeks, the day of the week checkboxes in the Date Type field will allow user entries. Users can also enter a numerical value in the Repeat Every field to adjust the time interval further.
For a selection of Months, the drop down menu in the Date Type field will allow user entries. Users can also enter a numerical value in the Repeat Every field to adjust the time interval further.
...
Date Type
...
This option is tied to the Repeat Every option. If the user selects the hours or days options in the Repeat Every field, this category will be greyed out for the user and will not allow entries.
For a selection of weeks, the day of the week checkboxes in the Date Type field will allow user entries. Users can assign the days of the week they would like the scheduled program to be executed on using this option.
For a selection of months, the drop down menu in the Date Type field will allow user entries. Users can assign the days of the week they would like the scheduled program to be executed on using this option.
...
Action
...
, on particular weekdays, or before the end of each month. This feature facilitates the seamless automation of essential tasks through script and command execution.
Designer Functionalities
Schedule Editor
To open the Schedule Editor, click Tools > Schedule Editor or the Open Schedule Editor… icon in the Toolbar. The window will allow users to set schedules for when they want the action to run. Users can select the Start Date, Start Time, how often it repeats, and the Date Type that will run. Users can also set the action to run when the schedule activates. They can run a command or script whenever the Schedule criteria are met.
Runtime Functionalities
Schedule Enable/Disable
The user can enable or disable schedules at run time if the user requires a script to be disabled or re-enabled during run time.
Users can set a script by using the schedule.setEnable(Schedule) function, they can then set which schedule to disable or re-enable during run time. Users can also use schedule.isEnabled(Schedule) to check if a schedule is enabled or disabled during runtime.
