Double-clicking any weekly schedule in Workbench produces its Scheduler view (Figure 314).
There are four tabs: Weekly Schedule, Special Events, Properties, and Summary, as described ahead.
Buttons Refresh and Save apply to all tabs in the Scheduler view (not just the one displayed).
Use this tab in the Weekly Scheduler view to enter regular schedule events, that is “normal schedule events” that repeat from week to week, based on the day of the week and the time of day. By default, any existing events appear as colored blocks, while unscheduled (default output) time appears in white.
In AX-3.8, events in BooleanSchedules and EnumSchedules have specified (and different) colors for each different state value, versus the default “greenish” color seen for all schedule events in AX-3.7 and prior releases. For details see, Event colors in weekly schedules (AX-3.8).
Use is mostly straightforward, to add a new event simply click in a day at the approximate event start time, and drag down to define the start and finish time (Figure 315). The event remains selected (by default, dark blue) when you release the mouse button.
If an EnumSchedule, you should define its range facet from the Scheduler’s Properties tab before adding events. See Facets for more details.
As needed, click again and drag on the event’s top or bottom to change its start or finish time (in broad increments).
Additional details about the Weekly Schedule tab are as follows:
With any event selected, “fine tune” its start and finish time using the controls, selecting the hours portion or minutes portion (Figure 316). Or, click and type values in directly.
For any event, start time is inclusive, and the event extends to (but is exclusive of) the end time. In other words, there is no output “blip” between adjacent events, even if across days. For example, if a Monday event ends at midnight, then a Tuesday event starts at midnight, the schedule output is continuous (providing both events have the same Output value).
For any event, you can select the “null” checkbox (the schedule’s calculated value is null for that event). However, you typically select or type a value instead, as follows:
-
If a Boolean or EnumSchedule select the event value in the output field, see Figure 317, left.
If an EnumSchedule, first specify its facets (on Properties tab) before entering values. This allows selection of possible values.
-
If a NumericSchedule or StringSchedule, you type the value in the output field, then press Enter to register it in the event block, as shown in Figure 317, right.
Right-click in the weekly schedule area for an event menu. If you have any event selected, this menu provides the most commands, as shown in Figure 318.
Event menu options are straightforward, and may include the following:
-
Delete Event — Deletes the selected event.
-
Paste Day — Appears only if copy day option was used first. Copies all events into selected day.
-
All Day Event — Makes currently selected (or last entered) event extend to entire day.
-
Apply M-F — Copies all events in the selected day to Mon, Tue, Wed, Thu, and Fri (and overwrites any existing events on those days).
-
Copy Day — Copies all events in the selected day, to use with paste day option.
-
Clear Day — Clears all events in the selected day.
-
Clear Week — Clears all events in the entire weekly schedule.
Use this Weekly Scheduler view tab to enter all exceptions to the schedule’s weekly schedule, broadly called “special events.” For general information, see Schedule special events.
As shown in Figure 319, existing special events (if any) are listed in the table by name and summary. When you select a special event, its day(s) of occurrence are highlighted in the monthly calendars at the top of the view, and its associated event actions are displayed in the right-side column.
Additional details about the Special Events tab are as follows:
Click the button to add a new special event. An Add dialog appears, as shown in Figure 320.
Dialog options are described as follows:
-
Name — Your descriptive name for special event, perhaps “Christmas_Break” or “Half_Day.” The default value is simply “Event.” You can change this later, if needed.
-
Type — Determines selection criteria for day or days, with the following choices:
-
Date — (default) By various combinations of weekday, numerical date, month or month combinations, and year.
-
Date Range — By start and end range, using for each a combination of day, month, year.
-
Week and Day — By combination of day of week, week in month, month.
-
Custom — By various combinations of day, month, weekdays, and year.
-
Reference — By reference to a specific CalendarSchedule component in the station.
-
For details on most Type selections, see Calendar day selections. If you select type Reference, a second Add dialog appears, as shown in Figure 321. It lists all CalendarSchedules (Calendars) available in the station, by slot path. Select any one for the day(s) portion of this special event.
After you have a name and type selected (and defined as needed), click to add it to this schedule’s special events. It remains selected for further editing, except for type.
A newly-created special event has no events defined. With the special event selected, click in the right-side events column and enter events as necessary. Start, finish, and output controls work the same as in the Weekly Schedule tab. See Event time “tuning” and Output value for details.
You can also right-click in the column for an event menu, as shown in Figure 322. This is useful to add an all-day event or set the entire day to the schedule’s default value.
You must specify events for any special event to occur. Where nothing is scheduled, the special event relinquishes control
back to any lower-priority schedule events, and finally “intermingles” with the weekly schedule. To completely override the
weekly schedule, configure a special event for the entire day.
All special events take priority over regular weekly events. Among special events, you define relative priorities by the order of listing in the Special Events table, as follows:
-
Highest priority is at top of list. Events in this special event, when active, always occur.
-
Lowest priority is at bottom of list. Events occur only if not overlapped by other special events active during the same period.
Change a special event’s priority by selecting it and using the priority arrow buttons (Figure 323).
Right-click in the special events table for a menu. If you have any special event selected, this menu provides the most commands, as shown in Figure 324.
Special event menu options are straightforward, and may include the following:
-
Add — Add a new special event (same as using button).
-
Edit — Edit day(s) selection criteria (but not changing special event type). Same as button.
-
Rename — Rename selected special event (same as using button).
-
Priority (up) — Move special event up in priority list (same as using button).
-
Priority (down) — Move special event down in priority list (same as using button).
-
Delete — Removes selected special event from the schedule component.
When you delete a special event, a confirmation dialog appears as shown in Figure 325.
Click to delete the special event, or to keep it.
When you first access the Special Events tab, the current day is highlighted in the left-most calendar month at the top of the view. As needed, click on and , or and to traverse the calendar ahead or back in time.
When you select a special event in the table, if it occurs in any currently displayed month, its associated day or days are highlighted as shown in Figure 326.
A special event must have at least one defined event action to be highlighted in a calendar.
Return to the current calendar month and day by clicking the button.
As shown in Figure 327, this tab in Weekly Scheduler view is where you can specify the schedule’s:
Another configuration property is also available, but only on the property sheet of a weekly schedule. See Scan Limit.
By default, a weekly schedule added from the schedule palette is always effective. Whenever a schedule component is not effective, its output (Out slot) goes to its default output value, regardless of its weekly schedule or any special events.
In most cases, you leave weekly schedules as always effective. However, if you have an application for a schedule effective only at certain times, use the “start” through “end” range fields to limit the effective period. When you Save the changes, only effective days in the calendar months are shown highlighted green.
Whenever a schedule event (special or weekly) is not defined, the schedule component’s output (“Out” slot) is this value. The white area in listed events indicates where the default value is used and displays the current default value, as shown in Figure 328. The default output value is also used whenever the schedule is not effective.
Note that “null” is an available choice—depending on control logic, this may be a valid choice.
As copied from the schedule palette, the default “Default Output” varies by schedule type, as follows:
-
BooleanSchedule — false
-
EnumSchedule — null
-
NumericSchedule — null
-
StringSchedule — null
The schedule component’s facets determine how its output value is formatted for display. For example, instead of “true” and “false” for a BooleanSchedule, you may need “On” and “Off” instead. Assigned facets appear in scheduler views when adding events, displaying summary data, and so on. For complete details, see About point facets.
Facets are especially important for EnumSchedules. You need to define “range” facets before you add weekly schedule events (in order to pick an event’s enumerated value). Range facets should match those
used in any controlled (output-linked) EnumWritables. For related details, see Facets importance for Enum points.In the case of StringSchedules (as for all string-type components) facets have no application.
Figure 329 shows output selections for an EnumSchedule with its range facet defined as “lonworks:LonOccupancyEnum,” one of the available frozen facets.
Configured events shown in Figure 329 above reflect a few “default colors” available for EnumSchedules in AX-3.8. In AX-3.7 and earlier releases, configured schedule
events all appear as “greenish” blocks. For related details, see Event colors in weekly schedules (AX-3.8).
By default, facets for schedule components as copied from the schedule palette are as follows:
-
BooleanSchedule — trueText: true, falseText: false
-
EnumSchedule — range: <not defined>
-
NumericSchedule — units: (null), precision: 1
-
StringSchedule — (not applicable)
This property is either true (default) or false.
-
If true, “one-time” special events that have occurred (and will not be effective again) are automatically deleted. When a special event is deleted, a message is sent to the schedule log, and that special event no longer appears in the Special Events tab.
-
If false, “one-time” special events are retained, even though they will not occur again.
(On a weekly schedules’s property sheet, but not on the Properties tab in Weekly Scheduler view.) Specifies a limit on how far ahead the schedule searches to find the next event output change, where the default is 90 days, and range is from 1 day (minimum) up. This can prevent excessive CPU usage. If changed, a value less than the default is typically recommended—for example, 14 days.
The summary tab in the Weekly Scheduler view shows a summary listing of all scheduled events for any one selected day in a weekly schedule (Figure 330). Events may be from the normal weekly schedule, special events, or a combination of both. Unlike with other tabbed views, this one is read-only.
In the top calendar month area:
-
Days with schedule events are shown highlighted green.
-
Days without schedule events (only default output) are shown in white.
As needed, click on and , or and to traverse the calendar ahead or back in time.
-
Click any day to see its events.
-
Click (at top) to see the current day’s events.
The table lists each event’s start timestamp, the schedule’s output value, and the event source. See Out Source slot for how event source information appears.