Scheduler

Manual for the Scheduler object on runtime pages.

Updated 5 min read
On this page (10 sections)
  1. Functional explanation
  2. Runtime operations
  3. Dialog
  4. Object name
  5. Settings
  6. Theme
  7. Position / Size
  8. Access Control
  9. Visibility
  10. Notes

Functional explanation

The Scheduler shows the schedules of the project on a page so that operators can see what is planned and, with the right permissions, change it. It is the operator counterpart of the Schedules configuration page: the same schedules, presented as a list, a week or a month.

Only schedules whose Operator access (Schedules configuration page) is View or Edit appear. Hidden schedules stay invisible on every page. The Schedule group setting pins the object to one group of schedules (the Schedule group field on the Schedules page), so one page can hold the schedules of Line 1 and another page those of Line 2; the Asset setting is an optional second filter.

An operator never composes actions. The designer defines named Action presets on the object, for example Start blower; the operator chooses a preset in the dialog and the schedule executes the actions of that preset.

Runtime operations

The following actions are available to operators from the Scheduler at runtime. Add, Edit, Enabled and Delete require the Schedule Edit Right on one of the user's groups and a schedule whose Operator access is Edit; other schedules open in a read-only dialog.

ActionDescription
ListTable with Enabled, Name, When (the rule in words), Next run, Last run and the Edit and Delete buttons. The filter shows all, enabled or disabled schedules.
WeekSeven day columns with a bar from start to end time for every planned occurrence. A dashed bar is a schedule without end time or a disabled schedule. Special days of the lists in use are hatched. Click a bar to open the schedule.
MonthCalendar grid with one chip per planned start. Click a chip to open the schedule, click an empty day to add a schedule on that date.
Add scheduleOpens the dialog with Name, Description, Start time, End time, First day, Repeat, Exceptions, What happens and Enabled. The Next runs line at the bottom previews the first planned starts while editing.
EnabledSwitch in the list that enables or disables the schedule directly.
DeleteRemoves the schedule after confirmation.

Dialog

Repeat offers Once, Daily, Weekly, Monthly and Specific dates with the same rule editor as the Schedules configuration page. Skip special days selects a special day list, Skip these dates lists individual dates. When the administrator configured a skip condition on the schedule, the dialog says so; the operator cannot change it.

What happens lists the Action presets of the object. A schedule whose actions were set by an administrator and match no preset shows Set by administrator; the operator can still change its timing.

An end time at or before the start time means the next day, so 22:00 to 06:00 is an overnight window. In compliance mode, saving, enabling, disabling or deleting a schedule can require an electronic signature (action key Schedule.Edit).

Object name

Set the object name shown in the scheduler decorator context.

SettingDescriptionExampleUnits
Object NameName used to identify the Scheduler object.LineSchedulerText

Settings

Configure which schedules the object shows and what operators may do.

SettingDescriptionExampleUnits
Schedule groupPins the object to one schedule group: only schedules with this Schedule group are listed and a schedule added from the object gets it. Empty shows every group. Replaceable in group symbols.Line 1Text
AssetOptional second filter: only schedules with this Asset are listed and a schedule added from the object gets this Asset. Empty applies no asset filter. Replaceable in group symbols.Line 1Text
ViewsThe views offered in the toolbar: List, Week, Month. At least one.List, Week, MonthSelection
Default viewThe view opened first.ListList, Week, Month
Allow addShows the Add schedule button for operators with the Schedule Edit Right.trueBoolean
Allow deleteShows the Delete button for schedules the operator may edit.trueBoolean
Refresh (s)Interval at which the object reloads the schedules and their next run.5Seconds
Action presetsNamed action lists the operator chooses from under What happens. Each preset has a Name, the actions at start time (Start) and the actions at end time (End), edited with the Edit Actions dialog. Press + Preset to add one.Start blowerList

Theme

Configure the colors of the object and its dialogs.

SettingDescriptionExampleUnits
Outer BackgroundBackground color of the object.#F0F1F3Color
Frame BackgroundBackground color of the list, week and month panels and the dialogs.#F0F1F3Color
Input Background ColorBackground color of the input fields and drop-downs in the schedule dialogs. Left at its default it follows the Viewer Row Alternate Color of the active theme, so the fields stand out from the panel.#FFFFFFColor
TextText color.#545454Color
BorderBorder color of panels, tables and inputs.#DBDBDBColor
Button BackgroundBackground color of the buttons.#9C9C9CColor
Button TextText color of the buttons.#FFFFFFColor
Selected BackgroundBackground color of week bars, month chips and active buttons.#D0D0D0Color

Colors follow the theme. A color that is left at its default follows the Viewer colors of the active theme (the Viewer Background Color, Viewer Font Color, Viewer Row Hover Color, Viewer Row Alternate Color and Viewer Line Color parameters, resolved for the Dark or Light theme of the client), so the object switches with the theme like the Alarm Viewer and the Navigator. A color chosen in the decorator keeps that value on every theme; a Color Library name can be used to give it a value per theme.

Position / Size

Configure the position and size of the Scheduler object. The reference size is 900 by 420 pixels.

SettingDescriptionExampleUnits
HeightHeight of the object.420px
WidthWidth of the object.900px
TopDistance from the top of the page.100px
LeftDistance from the left of the page.100px

Access Control

Configure access control for the Scheduler object.

SettingDescriptionExampleUnits
Access Control EnableEnables access control evaluation for the object.trueBoolean
Access ControlExpression controlling who can use or see the object.SYSTEM.UserGroups == "Operators"Expression

Visibility

Configure the runtime visibility and blinking behavior for the Scheduler object.

SettingDescriptionExampleUnits
VisibilityExpression controlling whether the object is visible at runtime.PLC1.Line1_RunningExpression
BlinkExpression or boolean controlling blinking.PLC1.AlarmActiveBoolean or expression

Notes

The Operator access of a schedule is set on the Schedules configuration page. Every schedule is Hidden until an administrator opens it up, so placing the object on a page shows nothing until at least one schedule is set to View or Edit.

Skip lists are defined on the Special Days configuration page. The Week and Month views show the special days of every list the listed schedules use.

The same operator actions are available over the runtime API (POST API/Schedule/List, Preview, Occurrences, Save, Enable, Delete) and the MCP runtime tools, with the same rights and the same visibility rules.

Something missing or wrong in this article? Contact us