schedule-CalendarSchedule

This component provides a calendar for scheduling holidays or other schedule overrides. CalendarSchedule is available in the schedule palette.
Figure 13.   CalendarSchedule properties
Image

To view these properties, right-click the CalendarSchedule component in the station and click Views > AX Property Sheet.

In addition to the standard properties (Status, and Fault Cause), these properties configure calendar schedules.

Property Value Description
Default output true or false Sets up default output for the component.

In scheduling, the schedule's output value whenever an event (either weekly or special event) is not active. It is also used whenever the component is not effective.

For a weekly schedule, set Default Output on the Properties tab in the Scheduler view. Available values must be pre-defined in the component’sFacets property.

Cleanup Expired Events true (default) or false Automatically deletes (true) calendar events of type Date and Date Range that have already occurred and cannot occur again (as configured). This is recorded in the schedule log, and you no longer see them in the view.

false retains all calendar events even if they cannot occur again (as configured).

Scan Limit 90 days (default) Specifies a limit on how far ahead the component searches to find the next event output change. This can prevent excessive CPU usage. Format is: ddd hh mm ss, and range is from 1 day (minimum) up. If changed, a value less than the default is typically recommended--for example, 14 days.
Facets trueText (default), falseText Configure true and false text for schedules.

Configuring facets is critical in an EnumSchedule, and optional in a BooleanSchedule or NumericSchedule. Facets do not apply if a StringSchedule.

Facets contain additional data applied to input and output values.

  • trueText is the text to display when output is true
  • falseText is the text to display when output is false.

For example, you might want to set the facet trueText to display “ON” and the facet falseText to display “OFF.”

"Units of measurement" is also a type of facet.

View facets on the Slot Sheet and edit them from a component Property sheet by clicking the >> icon to display the Config Facets window.
Last Modified read-only Reports the timestamp of last configuration change.
Out Source read-only Provides a string source description of the current output, as one of the four options shown left. For example, Week: monday or Special Event: Christmas Break
Out false {ok} (default) Reports the output value of schedule component. Output is true during any configured calendar day(s), otherwise it is false

Determined by the following, in highest-to-lowest priority:

Any non-null value at its In slot (if linked). This value is immediately passed to its output. Otherwise (if null), processing continues.

If the schedule is not effective, the output goes to the default output value. If the schedule is effective, the output goes to the (highest priority) active special event (if any).

The active weekly schedule event (if any).

The default output value.

In (defaults to null) Provides a string source description of the current input, such as a linked schedule. If the in property is linked and its value is non-null, then this value overrides the scheduled output.
Next Time (defaults to null) Displays the time of next scheduled output change for the component. If more than a year away, this value is null. Displays in Baja AbsTime format, for example: 03-Feb-05 5:00 PM.

Typical application is for informational display. If needed. slots can be linked into control logic. For example TimeDifference and CurrentTime objects (kitControl, Timer) provide AbsTime slots too.

Next Value read-only Reports the next scheduled output value, at Next Time. Value is meaningless if Next Time is null.