1 creating an exception – Echelon i.LON SmartServer 2.0 User Manual

Page 155

Advertising
background image

i.LON SmartServer 2.0 Programmer’s Reference

10-5

Property Description

<Exception>

You can specify the dates that the Event Calendar applies to
by creating exceptions. The exceptions that have been
created for an Event Calendar are signified by a series of
<Exception> elements. Each <Exception> element contains
a group of <Schedule> child elements, each of which
defines an exception date.

The ability to create multiple <Schedule> elements allows
you to create groups of exceptions that can be applied to a
schedule together. For example, you may want to create a
group of exceptions to apply to the first floor of a building,
and another group of exceptions to apply to the second
floor. In this case, you could specify two <Exception>
elements, one for each floor.

For a description of how to configure the properties you
must define within each <Exception> element, see the next
section, Creating an Exception.

10.3.2.1 Creating an Exception

The exception points for a Calendar are defined by a series of <Exception> elements.

<Exception>
<UCPTindex>4</UCPTindex>
<UCPTexceptionName>Holiday</UCPTexceptionName>
<UCPTaliasName>Holiday</UCPTaliasName>
<UCPTtemporary>0</UCPTtemporary>
<Schedule></Schedule>
<UCPTmaxClient>1</UCPTmaxClient>
<Client>
<UCPTname>Net/LON/iLON

App/Scheduler[10]</UCPTname>

<UCPTservicePath/>
</Client>
</Exception>

The following table lists and describes the properties that must be defined within each <Exception>
element.

Property Description

<UCPTindex>

The index number assigned to the exception.

<UCPTexceptionName>

The name of the exception that you will use to reference it. This
can be a maximum of 27 characters long.

<UCPTaliasName>

The name of the exception. There is no limit on the number and
type of characters in this property.

<UCPTtemporary>

Either 0 or 1. If 0, this exception will be repeated annually. If 1,
this will be a temporary exception. In this case, it will be
removed from the Calendar, and any Schedulers referencing the
exception, after the first time it is referenced.

Advertising