state

string

Possible values are: normal, suspended, deleted

Default: normal

The current value output by this schedule. Can be null or any other valid value, but the value must be acceptable to all targets.

error

string

(Optional) error is not present by default. It can be omitted, set to null, or set to a string that reports the most recently encountered error.

Schedule errors use the sev error category identifier, when one is provided. 

Diagnostics that include an identifier have the format: message [ category # number ]
For example:  Invalid time: “28:72:00” [sev#2].

desc

String

(Optional) Empty unless a description is provided.

(Optional)  Defines how all date and time references within this object are interpreted. 

Possible values: 

• utc - selects the UTC timezone
• local - selects local wall time, including daylight saving time, where and when applicable.
• standard - selects selects local standard time, not including daylight saving time.

Default: local

prio

Integer

(Required)  Defines the priority to be used with the value output by this schedule.

Possible values are 1 to 16.

(Optional)  Defines the schedule’s output value, if no exception or weekly schedule applies. This default value will be output at the configured prio just like a scheduled value. The default can be null, which lets the schedule relinquish its priority level when no scheduled event, weekly or otherwise, is active.

Default: null.

Default: False.

(Optional)  Controls whether the schedule is enabled.  effective defines an absolute date, a range of two dates, or a combination of week and day, including repeating options.

The schedule object is enabled when the current date matches the specified effective date. The schedule object is ineffective otherwise. The scheduler ignores an ineffective schedule object. When an effective schedule becomes ineffective, the scheduler recalculates all effective schedules that might affect some or all of the same targets. The effective date cannot reference another item such as a calendar object.  

A schedule can be rendered ineffective with the effective property.  For example, a schedule can be suspended by changing effective to a single day in the future. This has the same effect as suspending the schedule with suspend, which can be used to suspend a schedule without loss of its definitions in the effective property.

Possible values are: null and date.  (See Dates in Schedules and Calendars for a description.)

Default: null  (results in an always-enabled schedule)

(Optional)  Defines a weekly schedule (see Weekly Schedule for more information).  A weekly schedule is only inspected when no exception takes precedence.  At least one weekly schedule or exception schedule is required for a meaningful schedule. A schedule that has neither weekly nor exception schedules always outputs its default value.  

Possible values are: null and <weekly schedule>. 

(Optional) Defines an exception schedule (see Exception Schedule for more information).  Exception schedules take precedence over weekly schedules. At least one weekly schedule or exception schedule is required for a meaningful schedule. A schedule that has neither weekly nor exception schedules always outputs its default value.

Possible values are: null and <exception schedule>. 

For example, a datapoint with a full topic path of glp/0/SID/rq/dev/lon/123/if/Lamp/0/nviValue is referenced as ~/dev/lon/123/if/Lamp/0/nviValue .

dp is required but the list can be empty.  The schedule output changes according to the schedule, but no target is updated if the datapoint list is empty.

Possible values are: null and <datapoint reference>.

(Optional)  Takes a number greater than zero, specifying a delay in seconds, that is enforced when updating a list of target datapoints after updating each individual target. 

Default: 0  (no enforced delay between updating the individual targets)