System information

i.LON SmartServer 2.0 Programmer’s Reference
10-1
10 Calendar
You can use the Calendar application to define the exceptions that you will reference when creating the
date-based schedules for your Schedulers. Each exception you create represents a date, or a group of
dates. When you reference an exception in a Scheduler, you will be able to assign the dates for that
exception a unique schedule. This may be useful when creating a Scheduler that requires different
schedules for holidays than regular weekdays, or during different seasons of the year.
This chapter describes how to create exceptions with the Calendar application. Chapter 9,
Scheduler,
describes how to create a Scheduler and reference the exceptions you create.
You can create one-time exceptions, exceptions that occur over a specific range of dates, or recurring
exceptions that occur over a range of dates in a specific pattern such as every weekday or every fourth
Sunday of every month. The SmartServer supports one active Calendar, with no limit on the number
of exceptions scheduled in the Calendar.
When a Scheduler references an exception point, the Calendar application supplies the dates an
exception point references to the Node Object using the nvoEcDateEvent data point. The Scheduler
then reads this exception list from the local Node Object. The information contained in the exception
list includes when the exception is valid, and when the exception will recur.
Whenever an exception is modified with the functions described in this chapter, all exceptions in the
Calendar are recalculated and copied to the nvoEcDateEvent data point as a series of updates. By
default, the nvoEcDateEvent data point of the Calendar and the nviDateEvent data point of the Node
Object are internally bound, so that no network traffic is generated. Thus, the update from the
Calendar is passed to the local Node Object, and all the Schedulers will read the updated exception list
from the local Node Object.
In this fashion, each Scheduler will always have up-to-date definitions of the exceptions it references.
To force all exceptions to be recalculated and copied to the nvoEcDateEvent data point, you may
update the nviEcDateResync data point (which will be internally bound to the nvoDateResync data
point of the Node Object if no external binding is created) with a value of “100.0 1” and then return it
back to “0.0 0”.
10.1 Overview of the Calendar XML File
The #8000010128000000[4].UFPTcalendar.xml file stores the configuration of the Calendars that you
have added to the SmartServer. You can create multiple Calendars with an unlimited number of
exceptions per SmartServer. However, the SmartServer supports only 1 active Calendar at a time.
The following represents a sample #8000010128000000[4].UFPTcalendar.xml file for a SmartServer
with a Calendar that has an exception group named Holiday that recurs annually with exception
schedules defined for Christmas and the Fourth of July.
<Item xsi:type="UFPTcalendar_Cfg" >
<UCPTname>Net/LON/iLON App/Calendar</UCPTname>
<UCPTannotation>#8000010128000000[4].UFPTcalendar;xsi:type=“LON_Fb_Cfg”</UCPTannotation>
<UCPThidden>0</UCPThidden>
<UCPTlastUpdate>2008-03-05T11:43:29.440-08:00</UCPTlastUpdate>
<UCPTuri>#8000010128000000[4].UFPTcalendar_Cfg.htm</UCPTuri>
<DataPoint dpType="nviDateResync" discrim="dir_in" >
<UCPTname>Net/LON/iLON App/Calendar/nviEcDateResync</UCPTname>
</DataPoint>
<DataPoint dpType="nvoDateEvent" discrim="dir_out" >
<UCPTname>Net/LON/iLON App/Calendar/nvoEcDateEvent</UCPTname>
</DataPoint>
<ScheduleEffectivePeriod>
<StartDate>2000-01-01</StartDate>
<EndDate>2037-12-31</EndDate>
</ScheduleEffectivePeriod>
<Exception>
<UCPTindex>4</UCPTindex>
<UCPTexceptionName>Holiday</UCPTexceptionName>