beautypg.com

3 using the read function on a scheduler, Using the read function on a scheduler -12, Using the read function on a scheduler – Echelon i.LON SmartServer 2.0 User Manual

Page 143

background image

i.LON SmartServer 2.0 Programmer’s Reference

9-12

9.3.3

Using the Read Function on a Scheduler

You can use the Read function to retrieve the events scheduled in any Scheduler that you have added
to the SmartServer. You can filter events using an xSelect statement and specifying one or more
Scheduler items. You can use the following filters in an xSelect statement when using the Read
function on a Scheduler:

UCPTlastUpdate

When an event occurs. You can compare the specified start and stop
times using equal, less (or equal), great (or equal). UCPTstop is set
to time of last shown event. You need to check whether UCPTstop
differs from UCPTlastUpdate to make the next request start from the
UCPTstop time.

UCPTeventFilter

This property may have one of following values:

EF_NUL: Show all events. This is the same as not specifying

and UCPTeventFilter.

EF_DAY: Show only first event scheduled for each day.
EF_SCHEDULE: Show only one event for each scheduler.

position()

Position of the event in previously selected list. You can use this
filter to limit the number of events in a result. You can compare the
number of events to be returned using equal, less (or equal), or great
(or equal). You can request a maximum of 2,500 events; however,
more than 2,500 events may be returned.

Note: The last instance of an event before the specified start date is
always returned (if it exists), and it is not counted by the position()
constraint.

You can include one item of type UFPTscheduler_Calendar_Request_Data, which causes a Read
function on a Calendar item. This information is used to calculate date-based events. You can also
include an item of type UFPTscheduler_RealTimeClock_Request_Data, which defines start point for
relative times for each day. By default, all relative times are calculated from 0:00:00. If calendar
and/or real time clock data is specified, the data in the response is bound to given start and stop dates.

Request



//Item[@xsi:type="UFPTscheduler_Data"]

[UCPTlastUpdate>=

"2008-03-01T00:00:00.000"

and

UCPTlastUpdate<=

"2008-04-01T00:00:00.000"]

[UCPTeventFilter="EF_NUL"]

[position()<500]

Net/LON/iLON

App/Calendar


Net/LON/iLON App/Real Time Clock

Net/LON/iLON

App/Scheduler[0]__TEMP_OBJECT


Response



0