Helps_SV_V11_1 _ WORD FILES _ ENUSV_WebScheduler

WebScheduler Overview2The WebScheduler and BACnet FAQ3The WebScheduler and Supervisors Native Scheduler FAQ5Requirements for the Supervisor6WebScheduler Configuration File Overview7Web Portal Configuration - Web.config8Native Scheduler Driver Configuration - ScheduleData.Drivers.CronDat.dll.config9BACnet Driver Configuration - ScheduleData.Drivers.BacNet.dll.config10Schedules Configuration - Schedules.dat11Schedule Access Rights Configuration - SchedulesAccess.dat13Starting the WebScheduler14Login Page15Overview Page16Calendar Page18Calendar Page (Multiple Schedules)20Standard Week Page21Special Days Behavior Page22Schedule Control Main Display Features23Editing a Schedule Using the Schedule Control24Effective Period Page29Special Days Page31Other Pages34Concurrent Access Management35Integrating the Web Scheduler in a Mimic37Understanding the WebSchedulers Time-out Behavior39Using SCADA Basic to Update the Supervisors Internal Scheduler40Log Files41WebScheduler OverviewThe WebScheduler is a Web Browser based application for managing the weekly schedules that you find in typical supervisory applications such as BMS. It is designed to manage schedules from multiple sources and present them in a uniform manner no matter what equipment is used in the physical implementation. This version of the WebScheduler supports the Supervisors native Scheduler plus the schedules found in BACnet devices (Schedule and calendar objects). However the WebScheduler has been designed so that other schedule types (for example those found in LONworks) can be added in the future as required.The WebScheduler is a management tool allowing the User to visualize and edit schedules. It does not run schedules itself. The WebScheduler manages the Supervisors native Scheduler by directly manipulating the scheduler configuration file cron.dat. The WebScheduler can only configure the Schedulers existing schedules - it cannot create new ones. It must be used in conjunction with a SCADA Basic script used to register changes for either a single station or multi-station (networked) application. The WebScheduler manages BACnet Schedule and Calendar objects via the Supervisors BACnet communication driver. The WebScheduler does not communicate directly over BACnet itself.The WebScheduler and BACnet FAQThe WebScheduler is designed as a generic tool presenting a consistent interface independent of the underlying schedule technology. However there are some different operational features depending on what schedule technology you are using. This topic describes those for BACnet.BACnet B-OWS requirementsThe WebSchedulers capability integrates all functionality required to fulfill SCHED-VM-A BIBB (which in turn is part of the B-OWS specification). As a consequence the WebScheduler can be used in the Supervisors projects which are required to match B-OWS requirements. Projects that do not require Schedules do not need to use the WebScheduler.BACnet Schedule ObjectThe BACnet Schedule Object is a complex list of date, time and value pairs that can be used by a BACnet Device to schedule operations. The Weekly Schedule property of this object is used to control the Present Value property based on the 7 days of the week. Each day of the week has a corresponding schedule containing values and times that are used for that day. The Weekly Schedule property can be overridden by the Exception Schedule property which can be configured to define alternative behaviors for dates, date ranges and date patterns configured either directly in the exception or in an referenced calendar object.BACnet Calendar ObjectThe BACnet Calendar Object is a list of dates used to generate an exception in one or more Schedule Objects.WebScheduler Standard WeekThe WebScheduler Standard Week page is used to manage the behavior of a schedule for each of the seven days of a week. For BACNet, the Standard Week corresponds to the WeeklySchedule property of an instance of the Schedule object.WebScheduler Special DaysThe Special Days page is used to manage BACnet Calendar Objects. WebScheduler CalendarThe Calendar page is used to manage an entire schedule including the Standard Week, Exceptions, Special Days and Effective Period (as applicable). For BACnet, the WebSchedulers Calendar corresponds to a complete Schedule including the Standard Week, Exceptions, Special Days and Effective PeriodWebScheduler Effective PeriodThe WebScheduler Effective Period page is used to manage the Effective Period property of an instance of a BACnet Schedule Object. Understanding the behavior caused by the BACNet NULL statusThe empty background of the Scheduler Control represents the schedules default output value. If this value is NULL the output value of the schedule is undefined. The same applies to exception periods - on days with exception behavior (ie. other than the standard week) the empty space means that the output of the exception is NULL or undefined. This means that, unintentionally, standard week behavior can be reactivated. In general it is preferential to never set the default output value of a schedule to NULL or undefined, instead using the Effective Period to limit a schedules effect.Example You have schedule with the schedule default = NULL. The Standard Week is configured with each day as follows. 9:00 = 1 16:00 = NULL You have one exception period on 14/11/2014 configured as follows. 8:00 = 1 o 14:00 = NULL As the exception period remains undefined after 14:00 (NULL), w hat you see in the WebScheduler HMI is the following. 8:00 = 1 14:00 = 1 16:00 = NULL If you remove the interval from 8:00-14:00 on 14/11 the exception is modified in the following manner as one small interval remains in the WebScheduler HMI. 14:00 = 1 16:00 = NULL Consequently after reload you have the following behavior on 14/11: 9:00 = 1 (from the Standard Week) 14:00 = 1 (from the updated exception) 16:00 = NULL (from the updated exception)The WebScheduler and Supervisors Native Scheduler FAQThe WebScheduler is designed as a generic tool presenting a consistent interface independent of the underlying schedule technology. However there are some different operational features depending on what schedule technology you are using. This topic describes those for the Supervisors Native Scheduler.Supervisor Internal SchedulesThe WebScheduler can only manage Supervisor Internal Schedules that are configured to use the Timetable agenda type. The other agenda types (Once, Monthly, Weekly, Daily and Hourly) cannot be managed by the WebScheduler.A Timetable has a Standard Week with one or more pairs of start and end times for each of the seven days, plus Exception Periods of one or more days where the start and end time pairs are different (or even non-existent). In the Supervisor, the start and end times can be used to run a program, run a recipe, toggle a bit or set a bit to 0 or 1, but the WebScheduler can only be used for those schedules that run a recipe or set a bit to 0 or 1.The WebScheduler cannot be used for Internal Schedules that toggle (invert) a bit, or run a program.WebScheduler Standard WeekThe WebScheduler Standard Week page is used to manage the behavior of a schedule for each of the seven days of a week. For the Supervisors Native Scheduler, the WebSchedulers Standard Week corresponds to a Schedules Standard Week.WebScheduler Special DaysThere is no equivalent for the Supervisors Internal Scheduler.WebScheduler CalendarThe WebScheduler Calendar page is used to manage an entire schedule including the Standard Week, Exceptions, Special Days and Effective Period (as applicable). For the Supervisors Native Scheduler, the WebSchedulers Calendar corresponds to a complete schedule including the Standard Week and any Exception Periods. Modifying the schedule using the calendar will generate Exceptions Periods for the schedule.WebScheduler Effective PeriodThere is no equivalent for the Supervisors Internal Scheduler.Requirements for the Supervisor The WebScheduler must be installed as part of the Supervisors installation. Show picture At least one User must be configured in the normal manner in the Supervisor. The User must have the Authority to access property set in the WebVue tab of the corresponding profile. Schedules must be created in the Supervisor before the WebScheduler can have access. (Although the WebScheduler can be used to edit schedules it cannot create them.) The BACnet device, to which the BACnet Schedule and Calendar objects are subordinate, must be configured in the Supervisor before the WebScheduler can have access. WebScheduler Configuration File OverviewThe majority of the configuration of 11.1 of the WebScheduler is made by editing a number of text based configuration files. It is anticipated that the configuration will be added to the Application Explorer in a later version. A user must not be logged into the WebScheduler whilst changes are being made to these files. Some of the files have an XML structure but they can all be edited with a simple text editor such as Notepad.BINWebServerExtensionsWebAppsWebSchedulerWeb.configSettings specific to the appearance of the WebScheduler web portal. For example first day of the week.BINWebServerExtensionsWebServicesToolkitScheduleDataCONFIGSchedulesAccess.datAllocation of WebScheduler rights to the Supervisors Users.BINWebServerExtensionsWebServicesToolkitScheduleDataBINSchedules.datConfiguration of the BACnet Schedule and Calendar objects, and the Associated Labels used to represent enumerated values.BINWebServerExtensionsWebServicesToolkitScheduleDataBINScheduleData.Drivers.CronDat.dll.configConfiguration required to use the Supervisors native Scheduler particularly the project path.BINWebServerExtensionsWebServicesToolkitScheduleDataBINScheduleData.Drivers.BacNet.dll.configConfiguration of the BACnet driver.Where is the path used for the Supervisors installation.Web Portal Configuration - Web.configThe general appearance of the WebScheduler web portal is configured using the file Web.config. The file has an xml structure but can be edited with a simple text editor.The user configurable setting are all found in the section.PropertyRangeDefaultDescriptionCompanyNameReserved setting.ProductNameReserved setting.WelcomeTitleConfigurable message displayed on the login screen.WelcomeTextConfigurable message displayed on the login screen.NeedHelpTextConfigurable message displayed on the login screen.Login TextConfigurable message displayed on the login screen.FirstDayOfWeekMonday | Tuesday | Wednesday | Thursday | Friday | Saturday |SundayMondayThe day designated as the first of the week.BusinessBeginsHour0 240Start time for highlighting business time on the schedule control.BusinessEndsHour0 2424End time for highlighting business time on the schedule control.CalendarWeekRuleFirstDay | FirstFourDayWeek | FirstFullWeek FirstDayDefines the calendar week rule used to number the week of the year.ColorizeScheduleDefaultTrueFalseFalseDefines whether or not the default value of the schedule shall be represented by an interval.Native Scheduler Driver Configuration - ScheduleData.Drivers.CronDat.dll.configThe configuration file for the WebSchedulers native Scheduler driver. The file has an xml structure but can be edited with a simple text editor.The following settings are user configurable.PropertyDefaultDescriptionProjectPathDirectoryPath to the folder of the Supervisors project that contains the working copy of the CRON.DAT file.(CTEMP)Level Separator_ (underscore)The character or character chain used to define the hierarchy levels of the schedules. Optional settingsThe following are optional and only used if they are not already defined in the Supervisors project configuration. They define the associated labels for the Native Schedulers states and appear, for example, in the Mode List of the Add Interval dialog.PropertyTwoStateModeName_0TwoStateModeName_1MultiStateModeName_0MultiStateModeName_1MultiStateModeName_2MultiStateModeName_3BACnet Driver Configuration - ScheduleData.Drivers.BacNet.dll.configThe configuration file for the WebSchedulers BACnet driver. The file has an xml structure but can be edited with a simple text editor.The following settings are user configurable.PropertyDefaultDescriptionLevel Separator_ (underscore)The character or character chain used to define the hierarchy levels of the schedules. Schedules Configuration - Schedules.datThe Schedules.dat file is used to identify, and provide information about, the BACnet schedule and calendar objects that are to be managed by the WebScheduler. The Schedules.dat file is plain text and can be edited with a text editor such as Notepad. Schedule definitionEach BACnet Schedule object is identified by a single line with the following format.BACSCHED,PropertyDescriptionExampleNameThe name of the schedule as will be displayed in the WebScheduler. The name does not need to correspond to the name property of the actual schedule object. The name can contain a character or characters used as a hierarchical separator. See below.BACnet_HeatingDescription Lang1The description of the schedule as will be displayed in the WebScheduler (Configuration 1).Heating scheduleDescription Lang2The description of the schedule as will be displayed in the WebScheduler (Configuration 2).Calendrier de chauffageModeReference to the Associated Labels that define the operational mode of the device.HeatingNetwork IDThe name of the BACnet network as configured in the Supervisor.Network01Device AliasThe name of the BACnet device as configured in the Supervisor.Schedule_PLCInstance IDThe numeric instance of the scheduler object within the device.0Calendar definitionEach BACnet Calendar object is identified by a single line with the following format.BACCAL,PropertyDescriptionExampleNameThe name of the calendar as will be displayed in the WebScheduler. The name does not need to correspond to the name property of the actual schedule object. Public holidaysDescription Lang1The description of the calendar as will be displayed in the WebScheduler (Configuration 1).Public holidaysDescription Lang2The description of the calendar as will be displayed in the WebScheduler (Configuration 2).Jour friNetwork IDThe name of the BACnet network as configured in the Supervisor.Network01Device AliasThe name of the BACnet device as configured in the Supervisor.Schedule_PLCInstance IDThe numeric instance of the calendar object within the device.0Associated label definitionThe Associated Labels are used to define the range of possible values for the output (Present_Value) property of the Schedule object. The output types that are required to fulfill the BACnet standard BIBB SCHED-VM-A are Real, Enumerated and Unsigned-32. It is not possible to set a numeric output value directly from the WebScheduler HMI. The user in only able to choose from a list of predefined numeric output states as defined in the schedules.dat file. This predefined output values are linked 1:1 to an associated label.If the Schedule_Default property is configured as NULL, the list of possible output states (aka the list of associated labels) will be the number of associated labels defined for the schedule, plus one. The NULL output cannot be labeled.The definition of an Associated Label comprises of one line (key ASSOCLABELS) containing its identity and a further one or more lines (key ASSOCLABEL), each line defining a permitted value.ASSOCLABELS,PropertyDescriptionExampleNameThe name of the Associated Label. Used in the scheduled definition. HeatingDescription Lang1The description of the associated label (Configuration 1).HeatingDescription Lang2The description of the associated label (Configuration 2).ChauffageASSOCLABEL,PropertyDescriptionExampleRef to nameThe name of the associated label to which the permitted value applies.HeatingValuePermitted numeric value.5Text Lang1The description of the value will be displayed in the WebScheduler (Configuration 1).FrostProtectionText Lang2The description of the value will be displayed in the WebScheduler (Configuration 2).ProtectionAntigelColor codeThe color code for the interval bar while set to this value. Coded as a three byte number, one byte for each of the three primary colors (RGB). Example 255 = blue.255Schedule Access Rights Configuration - SchedulesAccess.datThe SchedulesAccess.dat file is used to configure the access permission of each WebScheduler user to each of the configured schedules. The file is of CSV (comma separated value) format with three columns.ColumnUseDescription1User NameUser name. The wildcards * and ? can be used to match several use names.2Schedule NameSchedule name. The wildcards * and ? can be used to match several schedule names.3Access LevelNone = 0 CalendarRead = 1CalendarWrite = 16 StandardWeekRead = 256 StandardWeekWr