WebCTRL v5.

5
User Manual

Rev. 5/4/2012
Verify that you have the most current version of this document. Go to http://accounts.automatedlogic.com, then select Support >
Download > Documents > Manuals.

Contents
Chapter 1 What's new in v5.5 .................................................................................................. 7
What's new in the WebCTRL application .................................................................... 7
What's new in the EIKON LogicBuilder application ................................................... 11
What's new in the SiteBuilder application ................................................................... 13
What's new in the ViewBuilder application .................................................................. 15
What's newOther tools ............................................................................................. 16
Chapter 2 What is a WebCTRL system? ................................................................................ 17
A typical WebCTRL system ....................................................................................... 18
WebCTRL editions ................................................................................................... 19
WebCTRL tools ........................................................................................................ 20
Chapter 3 Getting to know the interface .................................................................................. 23
Navigating the system ................................................................................................ 24
Tree icons and hover text ............................................................................................ 25
To show/hide the navigation pane .............................................................................. 26
Zooming and resizing in the action pane ..................................................................... 26
Using right-click menus .............................................................................................. 26
To print the action pane .............................................................................................. 26
Colors and status in the WebCTRL interface ............................................................. 27
Colors and setpoints .................................................................................................. 27
Chapter 4 Running WebCTRL Server .................................................................................... 29
To run a system .......................................................................................................... 29
To set up a computer and browser to view the WebCTRL interface ............................. 29
To run without connecting to the controllers ................................................................ 31
To switch to a different system .................................................................................... 31
To send a message to logged in operators ................................................................... 32
To log off an operator.................................................................................................. 32
To shut down a system ................................................................................................ 32
Chapter 5 Working with equipment ......................................................................................... 33
Graphics pages .......................................................................................................... 35
To attach a graphic in the WebCTRL interface ............................................ 35
To edit a graphic on a WebCTRL client ....................................................... 36
To organize multiple graphics for a tree item ................................................ 37
To control equipment using an interactive zone sensor ................................. 38
Properties pages ........................................................................................................ 39
To view or edit properties ............................................................................. 39
Point types .................................................................................................. 40
Logic pages................................................................................................................ 42
To view a Logic page .................................................................................... 42
To locate a microblock, section, or label....................................................... 42
To change properties, alarms, or trends........................................................ 42
Using a Logic page to troubleshoot .............................................................. 43
Changing multiple microblock properties .................................................................... 44
To use Global Modify ................................................................................... 44
To use Global Copy ...................................................................................... 45
Downloading to controllers ......................................................................................... 46
Download Options ....................................................................................... 47
To download from the Downloads page ........................................................ 47
To download from a Properties page ............................................................ 48
If a controller fails to download .................................................................... 48

2012 Automated Logic Corporation. All rights reserved throughout the world. Automated Logic, WebCTRL, EIKON, and BACview are
registered trademarks, and EnergyReports, Environmental Index, and Eco-Screen are trademarks of Automated Logic Corporation.
BACnet is a registered trademark of ASHRAE. All other brand and product names are trademarked by their respective companies.

Checking controller status .......................................................................................... 49

Status messages ......................................................................................... 49
To resolve a mismatch ................................................................................. 51
Setpoints ................................................................................................................... 52
To change programmed setpoints ................................................................ 52
Optimal Start .............................................................................................. 52
Demand Control .......................................................................................... 55
Setpoint Optimization ................................................................................. 56
Chapter 6 Schedules............................................................................................................. 57
To view schedules ....................................................................................................... 58
Setting up schedules .................................................................................................. 58
To apply a schedule to equipment ................................................................ 58
To apply a schedule to a group of items ........................................................ 59
To edit or delete a schedule ......................................................................... 61
Effective Schedules ..................................................................................... 61
Using schedule categories .......................................................................................... 63
Creating a custom schedule category ........................................................... 63
To add a custom schedule category in the WebCTRL interface.................... 64
To view, edit, or delete a schedule category .................................................. 65
Chapter 7 Trends .................................................................................................................. 66
To collect trend data for a point .................................................................................. 66
Graphing data for multiple points ............................................................................... 68
To create a comparison trend graph ............................................................. 69
To edit a comparison trend graph ................................................................. 69
To delete a comparison trend graph ............................................................. 70
Using trend graphs ..................................................................................................... 70
To view a trend graph ................................................................................... 70
Tools for viewing trends ............................................................................... 71
To print a trend graph .................................................................................. 71
To transfer trend data to a table format ........................................................ 72
Customizing graph appearance .................................................................................. 73
To edit graph properties............................................................................... 73
To edit colors, line styles, and marker types .................................................. 74
To copy a trend graphs properties ............................................................... 76
To add, edit, or delete a trend category ........................................................ 76
Chapter 8 Alarms.................................................................................................................. 78
Viewing, acknowledging, and deleting alarms ............................................................. 79
To view alarms in the WebCTRL interface................................................... 79
To acknowledge alarms ............................................................................... 81
To delete alarms .......................................................................................... 82
To receive audible notification of alarms ...................................................... 82
Setting up alarm actions............................................................................................. 83
To assign alarm actions to alarm sources ..................................................... 83
Alarm Popup ............................................................................................... 84
Print............................................................................................................ 87
Propagate To Server .................................................................................... 88
Run External Program .................................................................................. 88
Send Alphanumeric Page ............................................................................ 89
Send E-mail ................................................................................................ 91
Send SNMP Trap ......................................................................................... 93
Write Property ............................................................................................. 95
Write to Database ....................................................................................... 96
Write to File ................................................................................................. 99
Setting up an alarm source in the WebCTRL interface ............................................. 101
To set up, edit, or disable alarm sources .................................................... 101
To simulate an alarm ................................................................................. 103
To view all instances of an alarm source ..................................................... 103

Customizing alarms .................................................................................................. 104

Alarm messages ........................................................................................ 104
Alarm categories ....................................................................................... 105
If you upgraded alarms from v2.0 or earlier ................................................ 106
Using field codes ...................................................................................................... 107
Format field codes..................................................................................... 108
Field Codes ............................................................................................... 109
Chapter 9 Time-lapse .......................................................................................................... 113
To play Time-lapse.................................................................................................... 113
To change polling interval or duration or to turn off color collection ............................ 114
Chapter 10 Reports ............................................................................................................ 115
To run a report .......................................................................................................... 117
To create an Equipment Summary report ................................................................... 118
To create an Equipment Values report ....................................................................... 119
To create an Trend Samples report ............................................................................ 121
To create a PDF, Excel spreadsheet, or CSV file.......................................................... 122
To edit or delete a custom report ............................................................................... 122
To organize custom reports ....................................................................................... 123
To use custom reports from v2.5 or earlier ................................................................. 123
Chapter 11 Operator access ................................................................................................ 125
Privilege sets ............................................................................................................ 125
Privileges .................................................................................................. 126
To add or edit a privilege set ...................................................................... 129
To delete a privilege set ............................................................................. 129
Operators and operator groups ................................................................................. 129
To add or edit an operator .......................................................................... 130
To delete an operator ................................................................................ 131
To add or edit an operator group ................................................................ 131
To delete an operator group ....................................................................... 131
To change My Settings .............................................................................................. 131
Chapter 12 Advanced security.............................................................................................. 133
Location-dependent operator access ........................................................................ 133
To switch to location-dependent access ..................................................... 133
Privileges and privilege sets ....................................................................... 134
To add a privilege set ................................................................................. 135
To assign privilege sets to an operator........................................................ 135
To delete a local privilege set assignment .................................................. 135
Restricting access in the system ................................................................ 135
Security Assignments Report ..................................................................... 136
Recording reasons for edits (21 CFR Part 11) ............................................................ 136
Advanced password policy ........................................................................................ 137
Chapter 13 Cost-saving strategies........................................................................................ 139
Advanced topics and features ................................................................................................ 140
Chapter 14 Manual commands ............................................................................................ 141
Chapter 15 Running the WebCTRL autopilot ....................................................................... 148
To set up the WebCTRL autopilot ........................................................................... 148
To run the WebCTRL autopilot ................................................................................ 149
To run autopilot with Windows Vista .......................................................................... 149
Chapter 16 Managing files on a remote WebCTRL server ..................................................... 150
Methods for using WebDAV....................................................................................... 150
To use WebDAV with Internet Explorer ....................................................................... 150
Chapter 17 Using wireless devices with a WebCTRL system.................................................. 152
Supported WebCTRL features ................................................................................ 152
To dial up a System using WAP.................................................................................. 152
To navigate the System ............................................................................................. 153
To view and edit Alarms ............................................................................................ 154
To view and edit equipment properties ...................................................................... 155

Chapter 18 Setting up a system in the WebCTRL interface ................................................... 156

Editing the GEO or NET tree ....................................................................................... 156
To import a clipping ................................................................................... 157
System Settings ....................................................................................................... 159
General tab ............................................................................................... 159
Security tab............................................................................................... 160
Communications tab ................................................................................. 162
Scheduled Tasks tab ................................................................................. 163
Daylight Saving tab ................................................................................... 164
Web Applications tab ................................................................................ 165
To set up site properties ........................................................................................... 166
To register your WebCTRL software ........................................................................ 167
To replace the license when adding features .............................................. 167
Adding links or text to the WebCTRL login page ...................................................... 168
To add links to the login page .................................................................... 169
To add text to the login page ...................................................................... 169
Chapter 19 Working with control programs in the WebCTRL interface.................................... 170
To select a different control program ......................................................................... 170
To edit a control program on a WebCTRL client ....................................................... 171
Chapter 20 Working with drivers in the WebCTRL interface................................................... 172
To change or upgrade a driver ................................................................................... 172
Chapter 21 Working with BACview files in the WebCTRL interface ...................................... 173
To select a different .bacview file .............................................................................. 173
To edit a .bacview file on a WebCTRL client ............................................................ 174
Chapter 22 Running WebCTRL Server as a Windows service ................................................. 175
To install WebCTRL Server service .......................................................................... 175
To start WebCTRL Server as a Windows service ....................................................... 176
To set up the service for network printing ................................................................... 176
To remove WebCTRL Server service ........................................................................ 177
To determine if WebCTRL Server service is installed................................................ 177
Chapter 23 Setting up a system for non-English languages ..................................................... 178
Installing a language pack ........................................................................................ 178
Preparing your workstation for non-English text ......................................................... 178
Creating control programs and translation files for a non-English system ................... 180
To enter a key term in the EIKON LogicBuilder application ....................... 180
Translation files......................................................................................... 180
To create and implement a translation file.................................................. 181
Creating graphics for a non-English system ............................................................... 182
Creating a non-English graphic in ViewBuilder ............................................ 182
Creating a graphic for a multi-language system using
WebCTRL extensions for FrontPage ................................................. 183
Creating a non-English system in SiteBuilder ............................................................ 184
To set language preferences ...................................................................... 184
To create your system ................................................................................ 184
System language ....................................................................................... 185
To set an operators language in the WebCTRL interface ......................................... 185
Editing translation files, control programs, or graphics for a non-English system ........ 185
To edit a bundled resource......................................................................... 186
Editing an EIKON for WebCTRL control program in the
EIKON LogicBuilder application ...................................................... 186
Copying translation files to another system ................................................ 186
Chapter 24 Web services ..................................................................................................... 187
Using Web services to retrieve or change data ........................................................... 187
WebCTRL privilege requirements ............................................................ 188
WebCTRL data access using SOAP .......................................................... 188

Example using Web services to set a value ................................................................ 193

Step 1: Create a spreadsheet .................................................................... 193
Step 2: Create a macro ............................................................................. 194
Step 3: Run the macro .............................................................................. 195
Example using Web services to retrieve values ........................................................... 195
Step 1: Create a spreadsheet .................................................................... 195
Step 2: Create a macro ............................................................................. 196
Step 3: Run the macro .............................................................................. 197
Example using Web services to retrieve trend data..................................................... 198
Step 1: Create a spreadsheet .................................................................... 198
Step 2: Create a macro ............................................................................. 198
Step 3: Run the macro .............................................................................. 200
Example using Web services to retrieve a WebCTRL report ...................................... 201
Step 1: Create a spreadsheet .................................................................... 201
Step 2: Create a macro ............................................................................. 201
Step 3: Run the macro .............................................................................. 202
Chapter 25 System database maintenance ........................................................................... 203
To back up a system ................................................................................................. 203
To compact and defragment ..................................................................................... 203
To minimize the database size .................................................................................. 204
Index ................................................................................................................................... 205

WebCTRL v5.5 User Manual

Chapter 1
What's new in v5.5
What's new in the WebCTRL application
Feature

Improvement

New in v5.5:
Time-lapse (page 113)

You can replay up to 24 hours of Graphics, Alarms, or Trends pages

starting on a specified date and time. Time-lapse can be a helpful
troubleshooting tool.

System Settings > Web

Applications tab (page 165)

The Web Applications tab that was added in v5 has been redesigned
to improve usability.

The More tab

If your browser is not wide enough to display all the tabs and location
text on a page, the last tab will be More. Click this tab to toggle
between the hidden tabs and the displayed tabs. You can also click a
link on the More tab to jump to any tab.

64-bit install support for

Local Access

64-bit install that was added in v5 now includes support for Local
Access.

Support for new ZS

Sensors*

New ZS Sensor control on equipment graphics

The equipment Properties page has an Rnet Points tab showing
microblocks that have Rnet enabled.

Interactive Zone Sensor

control for ZS Sensors*

The new ZS Sensor Interactive Zone Sensor on an equipment graphic

allows setpoint adjustment and override of an unoccupied state.

* ZS Sensors will be released separately.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Feature

Improvement

New in v5:
Downloading (page 46)

The downloading interface and functionality has changed as follows:

Downloading moved from the CFG tree to the NET tree. Click the
Downloads action button.

The Downloads (page 47) page was redesigned to provide more

flexibility and more feedback on the download tasks.

You can download up to 5 routers simultaneously.

The Memory download option (page 47) is now called All Content
and includes the names of source files (.equipment, .view,
.bacview, and .driver). Using this information, the new Devices
page can show file discrepancies between the database and
controller. This feature also accommodates Field Assistant.

You can see who downloaded a controller on the Controller Status

Report or on the controller's Properties page.

Improved download
performance

You can now perform a memory download to at least 5 controllers on

separate networks simultaneously and schedule downloads to at least
10 controllers on separate networks simultaneously.

Devices page (page 49)

A new management tool that allows you to:

View network/controller communication status

Resolve database/controller mismatches
View controller information such as model, address, driver, and
control program
Find Automated Logic devices on a network that are not in your
system database

Locked values (page 35)

Locked values on Graphics and Properties pages have a yellow

dashed box around them.

Improved trend collection

Trend services have been improved to allow concurrent data collection

through multiple BACnet routers.

Controller Status Report

(page 115)

This report now includes a controller's download information, and, if

the controller has the 4.x or later driver, the serial number and Local
Access port status.

Tree display options (page

25)

You can display icons in the GEO tree to denote locations where items
such as schedules or alarm actions were created or assigned. You can
also turn on hover text so that when you hold the cursor over a
system, area, or equipment icon, information about the tree item is
displayed.

Schedule Group folders

(page 59)

You can create folders and sort your groups into them to organize the
GRP tree.

WebCTRL Design Server

(page 31)

WebCTRL Server no longer has a Normal mode and Design mode.

WebCTRL Server and WebCTRL Design Server are now 2 separate
options on the Start Menu.

Email (page 91) and

Alphanumeric Page (page
89) alarm actions

You can now set the mail host's port and security in the WebCTRL
interface.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Feature

Improvement

Location Audit Log and

System Audit Log reports
(page 115)

The Audit Log report is now 2 reports, one with location-based

changes and one with system-wide changes.

Advanced Password Policy

(page 137)

The System Settings > Security tab has 2 new options:

Cannot be changed more than once every__ days

Force expiration button

System Settings > Security

tab > Permissions (page
160)

When control programs, views, and BACview files are created by an

original equipment manufacturer (OEM), they cannot be used in a
WebCTRL system without the creator's permission. However, the
creator can produce a key for a system with a different license that will
grant permission to the key's recipient.
If you receive a key, you can activate it on the System Settings >
Security tab.

System Settings > Web

Applications tab (page 165)

You can deploy a web application from your WebCTRL system.

Alarm Notification Client

(page 84)

It now has a continuous sound and silencing feature.

You can now lock a client's Settings.
Enabling support for Alarm Popup clients moved from System Settings
> Other Applications tab to the General tab.

Edit Setpoint Tuning

Parameters privilege (page
126)

The permissions granted by the Edit Setpoint Parameters privilege

were split between that privilege and the new Edit Setpoint Tuning
Parameters privilege.

Remotely change the IP

configuration of a BACnet IP
controller

You can now change the IP configuration of a device in the WebCTRL

interface.

Disabling Local Access

To limit access to your system, you can disable a controller's Local

Access port from communicating with the WebCTRL application,
Field Assistant, or Test and Balance running on a laptop. Requires the
v4.x driver.

HTTP Proxy and HTTP Tunnel

in System Settings

These options were removed. Use Field Assistant instead.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Feature

Improvement

Download Source Files

Available only with a v4.x or later driver.

If Field Assistant will be used with your WebCTRL system, it needs
each controller's .equipment, .bacview, and .driver source files, plus
any .view files marked to be included in download.

Select the new Download Source Files option on the controller's

Properties page to have the WebCTRL application download the
source files so that Field Assistant can upload them. This option
depends on the controller's available memory.

Do not select this option if you know the controller does not have
enough memory or you want faster uploads in Field Assistant. You
will need to export the files from the WebCTRL or SiteBuilder
application so that they can be imported into Field Assistant.
NOTES

10

If you select Download Source Files but the controller does not
have enough memory, the download will fail. You can then disable
this option and download again.

You can exclude a .view file from being downloaded.

System Settings > General

tab > Export All Source Files
(page 159)

From the WebCTRL or SiteBuilder application, you can export source

files to a .zip file that can be imported into Field Assistant. And, you
can export source files from Field Assistant and import them into
WebCTRL or SiteBuilder.

BACnet Discovery

This feature is now a page under the Devices button on the NET tree.
And, you can now export the BACnet information to a .discovery file
that can be opened in the new Third-Party BACnet Utility or in the
EIKON LogicBuilder application.

WAP pages

The default WAP pages generated by the WebCTRL application have

been redesigned to be more useful and easier to navigate.

Internet Explorer support

The WebCTRL application now supports IE9, but no longer supports

IE6.
NOTE If your system has legacy graphics and you are running IE9, you
may see a strange font on the Graphics pages. To correct, upgrade
your InterOp graphics in SiteBuilder. This will change the font to
Courier New.

Reset to Defaults

This menu option was removed from the right-click menu. You can use
the revert manual command instead.

64-bit operating system

The WebCTRL installation now has a 64-bit install for large systems
that can use the increased capability inherent in a 64-bit operating
system. However, the 64-bit install does not include Local Access
support. (Support for Local Access is included in v5.5.) The 32-bit
install that supports all connection types can be used on a 64-bit
operating system.
NOTE MS Access is not available on a 64-bit installation. If your
system uses an Access database and you want to upgrade to the
64-bit version of v5, you must migrate your Access database to a
different type of database before upgrading.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Feature

Improvement

HyperTerminal replaced by
PuTTY in Help

Windows operating systems after XP do not include the HyperTerminal

application. You can download the external application PuTTY to
communicate locally with controllers. Most HyperTerminal instructions
in Help have been replaced with PuTTY instructions. For
HyperTerminal instructions, see Communicating using HyperTerminal.

What's new in the EIKON LogicBuilder application

Feature

Improvement

New in v5.5:
EquipmentBuilder

EquipmentBuilder is now installed with a WebCTRL system as a

stand-alone application. The EIKON LogicBuilder File >
EquipmentBuilder menu selection opens the application.

Revised ZN rules

The zone temp input to the Setpoint microblock can come from a
label to allow for smoothing algorithms.

To indicate an alarm condition in a zone (for example, to turn the

zone coral due to an equipment failure) you may use 1 Set Color if
True microblock in addition to a Setpoint microblock. When true, the
Set Color if True microblock determines the equipment color but
does not overwrite the Setpoint microblock's color output.

Revised microblocks

BACnet Binary Value Parameter

BACnet Analog Value Parameter
BACnet Multi-State Value Parameter
BACnet Binary Value Status
BACnet Analog Value Status
BACnet Multi-State Value Status
The above microblocks have been revised to support the new ZS
Sensors, which will be in a separate release.
The BACnet Multi-State Value Parameter and BACnet Multi-State Value
Status microblocks now support 20 states, retiring the following
microblocks.

Retired microblocks

Support for new

ZS Sensors
(will be released
separately)

The new Sensor Display Order menu option lets you define the order that
microblock values will be displayed on a Sensor.
The Microblock Common Properties Editor has a new Rnet tab.
The EIKON LogicBuilder application has pre-defined Rnet tags that
identify system values. You can create custom Rnet tags if needed.

BACnet Multi-State Value Parameter (20 state)

BACnet Multi-State Value Status (20 state)

New in v5:
Microblock Common
Properties Editor

2012 Automated Logic Corporation

You can view or edit common properties for the I/O, Network, Display,
and BACnet microblocks in a control program.

11

WebCTRL v5.5 User Manual

12

Feature

Improvement

ZN microblock rules

A ZN control program can now have:

A maximum of 350 microblocks (previously 200)

Up to 2 PID microblocks in addition to the zone controller microblock

(previously 1 PID)

Integrator microblock is
non-volatile

The integrator microblock now retains its output magnitude through a

power loss, controller reset, or controller restart.

"Always upload" feature in

BACnet Analog Value
Parameter microblock

Using a combination of logic that writes critical parameters within a

control program to a BACnet Analog Value Parameter microblock and a
new property of the BACnet Analog Value Parameter microblock, you can
retain critical values through a power loss, through a controller restart,
and (if the reference name of the microblock is unchanged) through a
memory download.

BACnet PID microblock

This new microblock provides improved PID algorithm and BACnet

accessibility.
NOTE A control program with this microblock works only with v5.2 or
later WebCTRL systems and v4.x or later drivers.

20-state BACnet
Multi-state Value
Parameter and
20-state BACnet
Multi-state Value Status
microblocks

These 2 new microblocks support up to 20 states.

OCL microblock system

variable for weekday

To be consistent with the System Variable microblock, the weekday

system variable has changed to WKDAY, where Monday = 1 to Sunday =
7. The previous weekday system variable, WDAY, will continue to work in
existing control programs using Sunday = 1 to Saturday = 7.

Wildcard (*) instead of

Device ID in BACnet
addresses

Use an * in a Network Input or Total Analog microblock's address to

have the microblock automatically locate the nearest device that
contains the object specified in the address. This feature eliminates the
need for specific device addresses when retrieving values from common
objects. For example, control programs on a campus that need oa_temp
can automatically retrieve the value from the nearest device that
contains that object name.

Edit > Third Party BACnet

Addresses

You can edit the addresses that you created with the Third-Party BACnet
Utility. Or, you can convert a control program into an integration program
by changing I/O microblocks to Network or Display microblocks and
setting the microblock addresses.

Device Alias microblock

and Device Alias field in
Display microblocks

These allow the use of Network I/O and Display microblocks in the same
program, and efficient re-use of programs for multiple instances of
third-party equipment.
NOTE You must enable Use Static Bindings on the WebCTRL System
Settings > Communications tab. For more information or alternatives,
see the BACnet Integration Guide
(http://accounts.automatedlogic.com/tilib.nsf/0/16B62CAA979B5D8A
8525717200678C60/$FILE/BACnet%20Integration%20Guide.pdf).

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Feature

Improvement

Mark certain properties as You can right-click some properties in the EIKON LogicBuilder
Read-only
application and select Make Editable or Make Read-Only to determine
that property's functionality in the WebCTRL interface.
Remove all Property Page
Text

You can use this Tools menu add-on to remove property page text for all
microblocks in a control program.

Keep historical trends for

___days

You can now define this setting in the EIKON LogicBuilder application
for I/O and Log microblocks. Previously, this setting was only in the
WebCTRL interface.

Use unitary naming

You can set your control program to use unitary naming to omit __# at
the end of BACnet object names.

Immediate Triggered Write The Immediate Triggered Write property was removed from ANO2 and
BNO2 microblocks. These microblocks automatically write their value as
soon as they are enabled.

What's new in the SiteBuilder application

Feature

Improvement

New in v5.5:
Trend data in exported
clippings

You now get the option of including historical trend data in an

exported clipping.
NOTE Exporting and importing trend data can take a long time, and
the trend data can be imported only in SiteBuilder running in
non-concurrent mode.

Apache Derby database

support

SiteBuilder now includes Apache Derby as a database option. Like MS

Access, all files needed for Apache Derby are installed with your
system. Derby is a cross-platform database supported on both 32-bit
and 64-bit operating systems. It is more robust and stable than Access
and provides a support-friendly, easy installation option to transfer
system files across platforms.
v5.5 also includes a Derby compression tool (page 203) that you can
use to compact the database.

BACnet points

SiteBuilder no longer includes BACnet points when calculating

integration points.

Java VM increase

The default amount of computer memory that your WebCTRL system

is permitted to use has been increased from 512 MB to 1024 MB.
This will increase the speed of memory-intensive tasks.

Database drivers

Database drivers are now located in a new folder:

WebCTRLx.x\database-drivers. So, if using a MySQL database, move
the driver file to the new location.
Database driver file names are no longer limited to *-driver.jar.

2012 Automated Logic Corporation

13

WebCTRL v5.5 User Manual

Feature

Improvement

New in v5:
Environmental Index source
tree

The new Environmental Index source tree allows you to drag and drop
zones that use standard reference names to calculate the
Environmental Index.

Use Server's Time Zone

A site now defaults to the WebCTRL server's time zone, but you can
select a different time zone if needed.

Find feature

You can search your system database for any information that you can
access from an item's properties dialog box.

Replicate feature

The Replicate dialog boxes were redesigned.

Synchronize views

If multiple pieces of equipment use the same control program and you
change the attached view(s) for one, a Synchronize Views dialog box
appears showing all equipment using the same control program. You
can then easily select other equipment that requires the same view
change.

View Properties

When you attach a view in SiteBuilder, you can edit the view's
navigation properties that were defined in ViewBuilder.

Custom source trees

You can now create up to 20 custom source trees.

Connect strings for MySQL,

Oracle, PostgreSQL, or
SQLServer databases

The connect strings were broken into fields in SiteBuilder to simplify

setup of the databases.

Support for lighting control

When adding an LX6 controller in SiteBuilder, a Panel Properties tab

appears where you select the lighting control panel's model.

Download Source Files

Available only with a v4.x or later driver.

If Field Assistant will be used with your WebCTRL system, it needs
each controller's .equipment, .bacview, and .driver source files, plus
any .view files marked to be included in download.

Select the new Download Source Files option to have the

WebCTRL application download the source files so that Field
Assistant can upload them. This option depends on the controller's
available memory.

Do not select this option if you know the controller does not have
enough memory or you want faster uploads in Field Assistant. You
will need to export the files from the SiteBuilder or WebCTRL
application so that they can be imported into Field Assistant.
NOTES

14

You can set Download Source Files at the site level so that it is the
default for every new controller that you add. You can then change
the setting for individual controllers.

If you select this field but the controller does not have enough
memory, the download will fail. You can then disable this option on
the controller's Properties page in the WebCTRL interface and
download again.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Feature

Improvement

Export and import source

files

From the SiteBuilder or WebCTRL application, you can export source

files to a .zip file that can be imported into Field Assistant. And, you
can export source files from Field Assistant and import them into the
WebCTRL or SiteBuilder application.

SSL certificate management

SiteBuilder now has the ability to make and delete SSL certificates,
simplifying the process of certificate creation and deletion.

Apply Update

The Apply Update menu command is now beneath the Help menu
command.

What's new in the ViewBuilder application

Feature

Improvement

New in v5.5:
EquipmentBuilder

EquipmentBuilder is now installed with a WebCTRL system as a

stand-alone application. The ViewBuiilder File > EquipmentBuilder
menu selection opens the application.

WebApp Content control

You can add content from a WebCTRL add-on web application to a

WebCTRL graphic.

Show/Hide expression
using ??

To allow reuse of graphics, you can show or hide equipment-specific

objects based on the presence of a particular
microblock. For example, you can add a hot water valve image to an
AHU graphic and give it the show/hide expression
??hw_valve??. The image will appear on the graphic only if the
associated control program has a microblock called hw_valve.

Interactive Zone Sensor

control

The Interactive Thermostat is now called the Interactive Zone Sensor

control.

Support for new ZS

Sensors*

ZS Sensor is now an option for the Interactive Zone Sensor control.

* ZS Sensors will be released separately.

New in v5:

EquipmentBuilder is now installed with a WebCTRL system as a

stand-alone application. EIKON LogicBuilder's File >
EquipmentBuilder menu selection opens the stand-alone application.

Drawing tools

New tools let you draw vector lines and shapes.

Lighting graphics

The ViewBuilder library now has graphics for lighting.

2012 Automated Logic Corporation

15

WebCTRL v5.5 User Manual

What's newOther tools

Use...

To...

New in v5.5:
EquipmentBuilder

Generate the following files from a library of pre-defined

applications.

Control program (.equipment)

Graphic (.view)
BACview file (.bacview), if applicable to the equipment
Sequence of operation (.odt)
Visio schematic (.vdx)

New in v5:

16

Field Assistant

Service or start up and commission a piece of equipment or a partial

network of controllers.

Third-Party BACnet Utility

Use discovered BACnet information to choose and address

microblocks for third party BACnet integration.

Test & Balance

(Redesigned)

Calibrate airflow in VAV zone controllers, commission air terminals,

and override reheat and terminal fans.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Chapter 2
What is a WebCTRL system?
A WebCTRL system is a web-based building automation system that can be accessed from anywhere
in the world through Internet Explorer, without the need for special software on the workstation.
Through Internet Explorer, you can perform building management functions such as:

adjust setpoints and other control parameters

set and change schedules

graphically trend important building conditions

view and acknowledge alarms

run preconfigured and custom reports on energy usage, occupant overrides, tenant billing, and
much more

2012 Automated Logic Corporation

17

WebCTRL v5.5 User Manual

A typical WebCTRL system

A WebCTRL system uses a network of microprocessor-based controllers to control heating, air
conditioning, lighting, and other facility systems. A web-based server communicates with these
controllers and generates the WebCTRL interface that the user can access through Internet Explorer.
Through the interface, you can gather information, change operating properties, run reports, and
perform other building management functions on a single building, an entire campus, or a network of
facilities that stretch around the globe.
A typical WebCTRL system may include:

18

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

The WebCTRL client uses Internet Explorer to access the WebCTRL Server application as a website.
Access and security options may include:

WebCTRL editions
A WebCTRL system supports:

Unlimited simultaneous users

Multiple operating systems and databases

Built-in alarming, trending, and reporting

International languages (International English, Korean, Traditional and Simplified Chinese,

Spanish, French, German, Russian, Swedish, Thai)

Third-party integration

WAP-enabled devices

Secure server access using TLS/SSL

Optional WebCTRL packages listed below

WebCTRL 500 supports all the same features and options in systems with fewer than 500 points.
NOTE Points include all input and output points tied into the system, regardless of vendor.

2012 Automated Logic Corporation

19

WebCTRL v5.5 User Manual

Optional WebCTRL packages

Package

Capabilities

Advanced Reporting
(page 115)

Configurable report designer for making environmental reports. Available

report types:

Advanced Security (page

133)

Equipment Values
Trend Samples
Location-dependent operator access
Configurable password policies
Audit Log reports
Requirement of operator comments and operator verification prior to
accepting system changes

Advanced Alarming (page The following alarm actions:

83)
Send SNMP trap
Write property
Write to database
In addition to running an alarm action when an alarm or return-to-normal
occur, alarm actions can be set to run:

Enterprise Integration
(page 187)

After a delay period

Based on a schedule group's occupancy status
Web services (XML/SOAP) data retrieval
Add-on web applications such as EnergyReports

NOTE An optional package is enabled when you install the license (page 167) that provides the
optional package.

WebCTRL tools
A WebCTRL system includes the following tools.

Design Tools

20

Use...

To...

EIKON LogicBuilder

Create control programs and Properties pages.

ViewBuilder

Create graphics and BACview screens.

ViewBuilder for WAP

Customize pages for WAP-enabled devices.

SiteBuilder

Create and modify the system database and associate control

programs and graphics with equipment.

Third-Party BACnet Utility

Use discovered BACnet information to choose and address

microblocks for third party BACnet integration.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Use...

To...

EquipmentBuilder

Generate the following files from a library of pre-defined

applications.

2012 Automated Logic Corporation

Control program (.equipment)

Graphic (.view)
BACview file (.bacview), if applicable to the equipment
Sequence of operation (.odt)
Visio schematic (.vdx)

21

WebCTRL v5.5 User Manual

Start-up, Commissioning, and Service Tools

22

Use...

To...

Field Assistant

Service or start up and commission a piece of equipment or a

partial network of controllers.

Test & Balance

Calibrate airflow in VAV zone controllers, commission air

terminals, and override reheat and terminal fans.

Virtual BACview

Let your laptop serve as a local interface to a single piece of

equipment.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Chapter 3
Getting to know the interface

NOTES

After you log in, you will see the page defined as your starting location on the My Settings page. To
change your opening page, see To change My Settings (page 131).

Privileges control what an operator can see or do in the WebCTRL system. If you cannot see or
do something that you read about in Help, ask your System Administrator to check your privileges.

2012 Automated Logic Corporation

23

WebCTRL v5.5 User Manual

Navigating the system

NOTE Use only the WebCTRL interface to navigate; do not use the browsers navigation buttons.

To navigate to an item in the system

1
2
3

Select an item in the GEO or NET tree.

NOTE The GRP and CFG trees are used to set up your system.
Use the action buttons and their drop-down menus to navigate to specific types of information
about the selected tree item.
Use the tabs to filter the information further.
NOTE If your browser is not wide enough to display all the tabs and location text on a page, the
last tab will be More. Click this tab to toggle between the hidden tabs and the displayed tabs. You
can also click a link on the More tab to jump to any tab.

To navigate using links

Use links to jump to related pages.
On a Graphics page

24

On a Properties page

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Tree icons and hover text

The navigation tree displays an icon to the left of each item to denote the type of item. For example:
System

Area

Equipment

To select custom equipment icons in the WebCTRL interface, right-click the equipment in the GEO or
NET tree, select Configure, then select the Icon. You can also select custom icons in the EIKON
LogicBuilder application.

Optional icons
You can display the following icons to denote locations in the GEO tree where items were created or
assigned.
Schedules

Trend Graphs

Alarm Actions

Schedule Groups

Reports

Privileges

To turn on optional icons:

1 Right-click the GEO tree.
2 Select Tree Display Options.
3 Select the desired Tree Icons.
4 Click OK.

Optional hover text

If you turn on hover text, you can hold the cursor over a system, area, or equipment icon to display
information about its item. The information displayed depends on which hover text options you select.

To turn on hover text:

1 Right-click the tree.
2 Select Tree Display Options.
3 Select the desired Tree Hover Text.
4 Click OK.

2012 Automated Logic Corporation

25

WebCTRL v5.5 User Manual

To show/hide the navigation pane

Click
to toggle the navigation pane between shown or hidden. When the navigation pane is
hidden, move the cursor across the left edge of the browser to show the navigation pane.
Click and drag the right edge of the navigation pane to adjust its width.

Zooming and resizing in the action pane

Hold down Ctrl while rolling your mouse wheel to zoom in or out on the contents of the action
pane.

Right-click the action pane and select Scale to 100% to restore the contents to their original size.

If a graphic does not fit in the action pane, right-click it and select Scale to Fit to make it fit the
action pane. Select Scale to 100% to return it to its original size.

Using right-click menus

You can right-click the following items to select options:
A tree item

The action pane

A property

To print the action pane

Click
to print the contents of the action pane. Set the print orientation to Landscape in the Print
dialog box.

26

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Colors and status in the WebCTRL interface

The following colors indicate equipment status on floor plans, equipment property pages, and some
reports.
Color

Color Name

Status Code

Condition Indicated

Mustard

none

In equipment when running WebCTRL Design Server

Purple

0 or 15

In a controllernon-operational or no
communications
In equipmenta hardware or software error

Charcoal

14

In a controllera download is required or is already in

progress
In equipmenta controller has stopped

Coral

13

Control program error

NOTE If a zone controlled by a U line controller
shows coral on a floorplan, the controller may be
offline.

Red

2 or 9

Heating or cooling alarm

Orange

Maximum cooling

Dark blue

Maximum heating

Yellow

Moderate cooling

Light blue

Moderate heating

Gray

Unoccupied/inactive

White

10

Occupied/active

Light green

Free cooling

Green

In a controlleroperational or operational read only

In equipmentNo heating or cooling

Colors and setpoints

Thermographic colors indicate how much a zones actual temperature differs from its setpoints.
Five conditions may affect a zones thermographic color:
Setpoint adjust
Timed local override (TLO)
Optimal start
Demand level
Hysteresis
In the examples below, a zones heating occupied setpoint is 70 and its cooling occupied setpoint is
74.

2012 Automated Logic Corporation

27

WebCTRL v5.5 User Manual

28

If you
normally
see...

when the zone but...

temp is...

then you will

see...

green

72.5

someone adjusts the setpoints (for example, with a

setpoint adjust of two degrees, the new setpoints
would be 68 and 72)

yellow

gray

73
(unoccupied)

someone presses the Override button on a zone

sensor to use the occupied setpoints

green

gray

77
(unoccupied)

the zone is in optimal start and is ramping up to its

occupied setpoint in the few hours before occupancy

an occupied
color

yellow

75

the zones electric meter is in demand level 2 with

relaxed setpoints of 68 and 76

green

green

73.5

cooling began when the temperature rose above 74

and the temperature has not yet dropped beyond the
1 hysteresis (to 73)

yellow

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Chapter 4
Running WebCTRL Server
The WebCTRL Server application accesses and maintains the system database that is viewed and
edited from client browsers.
The application's Current Users, Connections, and Output tabs allow you to monitor the status of the
system. Output information is continually archived to WebCTRLx.x\logs\WEBSERVER.log.

To run a system
The WebCTRL Server application must be running before operators can log in from client browsers.
1 Select Start > Programs > WebCTRL x.x > WebCTRL Server.

TIP If you run the WebCTRL application as a Windows service, your computer can
automatically start the WebCTRL Server application every time the computer starts. See Running
WebCTRL Server as a Windows service (page 175).
Start the Internet browser on one or more client computers.
Verify that your browser is set up for displaying the WebCTRL interface. See To set up a computer
and browser to view the WebCTRL interface (page 29).
Type the WebCTRL server's address in the browser's Address field.

NOTE You can type http://localhost if WebCTRL Server and the browser are running on
the same computer.
Enter a Name and Password.

2
3

To set up a computer and browser to view the WebCTRL interface

NOTES

The WebCTRL Server application must be running before operators can log in from client
browsers.

To view trends, client computers need Sun's Java VM plugin. Go to the WebCTRL CFG tree >
Client Installs for a link to the Java website.

The instructions below are for Internet Explorer 8 and Windows XP. Other versions may vary
slightly.

2012 Automated Logic Corporation

29

WebCTRL v5.5 User Manual

If you are using IE9 and do not see the menu bar, right-click on the window's header, and then
select Menu bar. You can then follow the instructions below.

Browser settings

Where to change setting in IE8

Accept First-party and Third-party

cookies.*

Tools > Internet Options > Privacy tab >Advanced button

Automatically check for newer

versions of stored pages.*

Tools > Internet Options > General tab > Browsing history >
Settings button

Load ActiveX Control*

Tools > Internet Options > Security > Custom Level > ActiveX
controls (enable all of the following settings)

30

Download signed ActiveX controls > Prompt

Download unsigned ActiveX controls > Disable
Run ActiveX controls and plug-ins > Enable
Script ActiveX controls marked safe for scripting > Enable

Select Play animations in web

pages.

Tools > Internet Options > Advanced tab > Multimedia section

Do not save passwords if the

computer is used by multiple
operators.

Tools > Internet Options > Content tab > AutoComplete >
Settings button

Disable all the options on the

Explorer Bar.

View > Explorer Bars

Disable browser's pop-up blockers.

Tools > Pop-up Blocker > Turn Off Pop-Up Blocker

Disable external toolbar pop-up

blockers.

Varies

Hide the browser's toolbars.

View > Toolbars

Maximize the browser window.

F11 on your keyboard, or use the minimize/maximize button in

the top right corner of the browser window

Computer settings

Where to change setting in Windows XP

Set the monitor's screen resolution

to a minimum of 1024 x 768 with
24- or 32-bit color quality.

Start > Control Panel > Display > Settings tab

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Browser settings

Where to change setting in IE8

Disable navigation sounds.

Start > Control Panel > Sounds and Audio Devices > Sounds
tab

* The WebCTRL interface cannot function without this setting.

To run without connecting to the controllers

To verify links between graphics and to set up properties, schedules, alarms, and trends before you
connect to the network, run WebCTRL Design Server instead of WebCTRL Server. Then view the
WebCTRL interface in a browser.
NOTES

Question marks and purple thermographic color indicates correct microblock paths. Missing data
or dark yellow thermographic color indicates errors.

If the computer's Start menu does not show WebCTRL Design Server, you are using a Tools Only
installation.

To switch to a different system

Design engineers working on multiple projects can switch systems in the WebCTRL Server
application.
1 In the WebCTRL Server application, select Server > Change Active System.
2 Select a different system (it must be in the webroot folder) and mode.
3 Click Select.

2012 Automated Logic Corporation

31

WebCTRL v5.5 User Manual

To send a message to logged in operators

Notification messages are delivered immediately to WebCTRL client browsers. You can send multiple
messages, but the operator must click Ok for the first message before the next message can be
delivered. If the browser window is minimized, the message is not visible.
1 In the WebCTRL Server application, click the Current Users tab.
2
3
4

Click the Notify button

beside the user you want to send a message to. Or click Notify All
Users.
Type a Notification message.
Click OK.

NOTE You can also type notify [followed by the message] in the WebCTRL manual
command dialog box to send a message to all logged in operators.

To log off an operator

NOTE The operator will be logged off without warning.
1 In the WebCTRL interface, press Ctrl+M.
2
3
4

Type whoson in the manual command field.

Obtain the ID number of the operator you want to log off.
Press Ctrl+M.

5
6

Type logoffuser x (where x is the ID number).

Click OK.

To shut down a system

1
2
3

In the WebCTRL Server application, select Server > Shut Down.

Optional: Select a delay option, then edit the Notification message.
Click Shut Down.

NOTE You can also type shutdown in the WebCTRL manual command dialog box to shut down the
server.

32

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Chapter 5
Working with equipment
You can view and adjust equipment operation from the following pages:
Graphics pages (page 35)
You can view and adjust your essential building
controls on most Graphics pages.

2012 Automated Logic Corporation

Thermographic floor plans indicate the

temperature of zones compared to their
effective setpoints.

Equipment graphics show the current

status of mechanical equipment and often
include an adjustable setpoint control or
other editable properties.

33

WebCTRL v5.5 User Manual

Properties pages (page 39)

Each piece of equipment and each microblock
has a Properties page. You can view and adjust
more equipment properties on a Properties
page than on its corresponding Graphics page.

Logic pages (page 42)

Logic pages show the control program for a
piece of equipment. Use the sequence of
control and yellow status values on the Logic
pages for troubleshooting your mechanical
equipment.

Microblock pop-ups
To open a microblock pop-up where you can
view and change properties:

34

Click a microblock on a Logic page.

Click the bold, underlined microblock name

on a Properties page.

Right-click a value and then select Details.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Graphics pages
You can view and adjust your system from Graphics pages, which include navigation maps, floor plans,
and equipment.

Some typical controls that may appear on a graphics page are:

Button or switch to turn equipment on or off

Input field to set a property value

Drop-down list to select a state

Interactive zone sensor to override an unoccupied schedule

Setpoint graph to adjust setpoints

Trend graph to view trend information

Link to jump to another WebCTRL page or to the Internet

NOTES

Right-click a value, then select Details to view and change properties in the microblock pop-up.

Right-click a value, then select Global Modify (page 44) to view and change the property in other
control programs.

A yellow dashed box around a value indicates the value is locked.

If a graphic is larger than the action pane, right-click the graphic and select Scale to Fit to see the
whole graphic. Right-click and select Scale to 100% to return the graphic to its original size.

When using Scale to 100%, hold down Ctrl while rolling the mouse wheel to zoom in and out on a
graphic.

To attach a graphic in the WebCTRL interface

1
2

On the navigation tree, right-click the item that you want to attach a graphic to, then select
Configure.
Equipment graphic only: If the system has other control programs of this type, select which control
programs you want to change.

NOTES

If the control program is in an IP router, the second option will change the graphic for all
control programs of this type only on the IP network.

If the control program is on the network below an IP router, the second option will not change
the graphic for the router's control programs of this type.
2012 Automated Logic Corporation

35

WebCTRL v5.5 User Manual

Do one of the following:

If the graphic is...

In the Views Available list

a. Select the graphic, then click Attach.

b. Click OK.

Not in the Views Available list

a. Click Add New.

b. Browse to select the view file.
c. Click Open.
d. Click Continue.
e. Click Close.
f. Click Close again.

NOTES

Select a graphic in the Attached list to edit the graphic's:

Display NameThe name that appears in the Graphics button drop-down list
CategoryThe name of the category that multiple graphics may be sorted into in the Graphics
button drop-down list
NOTE Changes to Display Name or Category apply only in the WebCTRL interface and are
not retained if you export source files.
Reference NameThe name that is used to create links to the graphic in ViewBuilder
Included in downloadEquipment graphics only. Select to have the .view file included in an All
Content download so that it can be uploaded by Field Assistant. The graphic will have
beside it in the Attached list. Requires 4.x or later drivers.

You can click Delete Unused at the bottom of the Views section to delete all unattached graphic
files from your system.

To edit a graphic on a WebCTRL client

On a WebCTRL client, you can get a copy of a graphic from the server, edit it, then put it back on the
server.

To get the graphic

1
2
3
4
5
6
7
8

36

On the WebCTRL GEO tree, right-click the item that the graphic is attached to, then select
Configure.
At the bottom of the Views section, click Edit Existing.
Select the graphic you want to edit.
Click Save
Browse to the folder you want to put the file in.
Click Save.
Click Close.
Click Close again.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

To put the edited graphic back on the server

1
2
3
4
5
6
7

On the WebCTRL GEO tree, right-click the item that the graphic is attached to, then select
Configure.
At the bottom of the Views section, click Add New.
Browse to select the .view file.
Click Open.
Click Continue.
Click Close.
Click Close again.

To organize multiple graphics for a tree item

If a single tree item has multiple graphics and you want to change the default graphic that was defined
in SiteBuilder, display the graphic in the WebCTRL interface, then run the setdefault manual
command (page 141).
In WebCTRL, you can create categories and assign graphics to them so that the Graphics button
drop-down menu has the graphics arranged by category. This is typically done in ViewBuilder or
SiteBuilder. See "To define WebCTRL navigation" in ViewBuilder Help and "To attach graphic files" in
SiteBuilder Help.

To add or edit a Graphics category in WebCTRL

1
2
3
4
5

On the WebCTRL CFG tree, click the plus sign (+) to the left of the Categories folder, then select
Graphic.
Click Add or select a category to edit.
Type the Category Name and Reference Name.
Optional: Select a privilege so that only operators with that privilege can access graphics in the
category.
Click OK.

NOTE To delete a category, select the category, click Delete, then click OK.

To assign a graphic to a category in WebCTRL

1
2
3
4

On the WebCTRL GEO tree, right-click the item that the graphic is attached to, then select
Configure.
Under Views, select the graphic in the Attached list.
Select the category in the Category field.
Click OK.

2012 Automated Logic Corporation

37

WebCTRL v5.5 User Manual

To control equipment using an interactive zone sensor

An equipment graphic may include an interactive zone sensor that provides you with the following
control.
If the sensor is a...
ZS

RS Standard, Plus, or Pro

RS Pro-F

38

You can...

Click

Click
to override the schedule and put the zone in an occupied
state. To cancel an override, continue clicking until the display
shows 0.

See that the zone is in an occupied state when the green LED is lit.

Click the WARMER or COOLER button to adjust the setpoint.

Click the MANUAL button to override the schedule and put the
zone in an occupied state.

Click the INFO button to cycle through the following information:

to raise the setpoint or

to lower the setpoint.

Outside air temperature, if enabled in the control program

Override time remaining

Heating setpoint

Cooling setpoint

See the Occupied/Unoccupied state in the display.

Click the WARMER or COOLER button to adjust the setpoint.

Click the MANUAL button to override the schedule and put the
zone in an occupied state.

Click the INFO button to cycle through information such as:

Outside air temperature

Override time remaining

Heating setpoint

Cooling setpoint

Click the FAN button to adjust the fan speed.

Click the MODE button to perform customer-specific functions.

See the Occupied/Unoccupied state in the display.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

If the sensor is a...

You can...

LogiStat

Click

to raise the setpoint or

Click
state.

to override the schedule and put the zone in an occupied

See that the zone is in an occupied state when the red LED is lit.

to lower the setpoint.

Properties pages
Properties pages are automatically generated from control programs created in the EIKON
LogicBuilder application. Use Properties pages to:

View the status of a piece of equipment. See Colors and status in the WebCTRL interface (page
27).

View or change the equipment or microblock properties currently stored in the controller

Commission equipment

To view or edit properties

Select a piece of equipment or a microblock on the GEO or NET tree, then click Properties.
NOTE You must resolve any condition described in red text at the top of the page before a
Properties page can obtain current information from its controller.
To change a property:

Click OK.

2012 Automated Logic Corporation

39

WebCTRL v5.5 User Manual

NOTES

Right-click a value, then select Details to view and change properties in the microblock pop-up.

Right-click a value, then select Global Modify (page 44) to view and change the property in other
control programs.

A yellow dashed box around a value indicates the value is locked.

If your browser is not wide enough to display all the tabs and location text on a page, the last tab
will be More. Click this tab to toggle between the hidden tabs and the displayed tabs. You can also
click a link on the More tab to jump to any tab.

Point types
A point name on the Properties page is followed by a code that tells you the point type. The table below
describes each code.

40

Code

Point type

AI

Analog Input

ANI

Analog Network Input

ANI2

Analog Network Input 2

ANO

Analog Network Output

ANO2

Analog Network Output 2

AO

Analog Output

ASVI

BACnet Analog Sensed Value Input

AV

Analog Value

BAI

BACnet Analog Input

BALM

BACnet Alarm

BAO

BACnet Analog Output

BAV

BACnet Analog Value

BBI

BACnet Binary Input

BBO

BACnet Binary Output

BBV

BACnet Binary Value

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Code

Point type

BFM

Floating Motor

BI

Binary Input

BLSTAT

LogiStat Zone Sensor with Optional OAT Display

BMSV

BACnet Multi-State Value

BNI

Binary Network Input

BNI2

Binary Network Input 2

BNO

Binary Network Output

BNO2

Binary Network Output 2

BO

Binary Output

BPTA

Pulse to Analog Input

BPWM

Pulse-Width Output

BRS

RS Sensor

BRSF

RS Sensor Fan

BSVI

BACnet Binary Sensed Value Input

BTLO

Timed Local Override

BTRN

Trend Log

BV

Binary Value

DI

Digital Input

DO

Digital Output

EVT

BACnet Alarm

LAN AI

LAN Analog Input

LAN AO

LAN Analog Output

LAN DI

LAN Digital Input

LAN DO

LAN Digital Output

LSTAT

LogiStat Zone Sensor

POLLAVG

Average Analog Properties

POLLMAX

Maximum Analog Properties

POLLMIN

Minimum Analog Properties

POLLTOT

Total Analog Properties

PTA

Pulse to Analog Input

TLO

Timed Local Override

2012 Automated Logic Corporation

41

WebCTRL v5.5 User Manual

Logic pages
The Logic page shows the control program for a piece of equipment. The live data (yellow text) is
updated every few seconds and whenever you click the Logic button. The control program uses exact
property values for its calculations, but values are rounded to 2 decimal places when displayed on the
Logic page.
TIP Click anywhere on the Logic page, then use the Page Up, Page Down, and arrow keys to scroll
through the page.
NOTE If you find an unexpected value on a Properties page or a Logic page, you can use the Logic
page to troubleshoot.

To view a Logic page

1
2
3

Select a piece of equipment in the GEO or NET tree.

Click Logic.
Click a microblock to view its details.

To locate a microblock, section, or label

1
2

Right-click the Logic page, then select Jump To.

Do one of the following:

On the Microblock or Section tab, select an item to have it located and highlighted.

On the Label tab, select a label to display a reduced logic page outlined in yellow that shows
all instances of the label. A red box indicates an output label; a yellow box indicates an input
label. Click a red or yellow box to jump to that label in the full-size logic page.
NOTE You can also click a label on the full-size logic page to display the reduced logic page.

To change properties, alarms, or trends

1
2
3
4

Click a microblock on the equipments Logic page.

In the microblock pop-up, click the Properties, Alarms, or Trends button.
Change properties, alarms, or trends for that microblock in the same way that you would make
changes on a regular Properties (page 39), Alarms (page 101), or Trends (page 66) page.
Click OK or Apply.

NOTE Right-click a value, then select Global Modify (page 44) to view and change the property in other
control programs.

42

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Using a Logic page to troubleshoot

The WebCTRL application monitors your system and provides feedback. If you get unexpected
feedback, you can use a Logic page as a troubleshooting tool. On the Logic page, work your way
backward (right to left) through the sequence in the control program to discover what caused the
problem. See Microblock Reference to understand what each microblock in the sequence is doing.
Unexpected feedback

Possible cause

Space temperature reads

excessively high or low

The sensor has a short (or open) circuit. Verify wires are
properly connected at the sensor and controller.

A sensor is missing or configured incorrectly. Open the sensor

or input microblock from the Logic page to verify its
configuration.

Equipment displays an
unexpected color - effective
setpoints are different than the
programmed setpoints

NOTE Equipment operates using effective setpoints. Open the

Setpoint microblock from the Logic page and check the following:

Hysteresis

Demand Level

Optimal Start

Timed Local Override (TLO)

Setpoint Adjust

Gaps in trend data on trend

graph

Usually gaps result if network communication was disrupted or a

point was temporarily disabled.
If the gap is not the result of interrupted communication, send
reports more frequently. From the Logic page, open the trend
microblock that displayed the gap in data, then decrease the
notification threshold so that it is approximately 40% of the buffer
size (allocated memory size) for that microblock.

The WebCTRL application is

not receiving alarms from a
BACnet alarm microblock

Locate the microblock on the Logic page. If the color square on the
microblock is black, the alarm is disabled. To enable it:
1 Click the microblock.
2 In the microblock pop-up, click the Alarms button.
3 On the Enable/Disable tab, select Potential alarm source.

The equipment is on when I

expect it to be off, or off when I
expect it to be on

Use the Logic page to determine whether the program is sending

an unexpected signal and why, or if the problem is with the physical
equipment. For example, the On-Off-Auto (OOA) switch on the
controller for that equipment may be locked in the On (Hand)
position.

Sensor value on the Properties

page does not match the
reading from handheld sensor

Calibrate the sensor.

On the Logic page, check to see if the output point is locked on.

2012 Automated Logic Corporation

43

WebCTRL v5.5 User Manual

Changing multiple microblock properties

Two WebCTRL features, Global Modify and Global Copy, allow you to view and change multiple
microblock properties at the same time.
CAUTION Global Modify and Global Copy are convenient for making widespread changes in your
system. But, because they do not take into account the operation of individual equipment, your
changes could produce undesired results in your equipment or system operation. Use with caution
because these features do not have an Undo function.
TIP Click
to copy a microblock's reference path to the clipboard so you can paste it into
another field or application.

To use Global Modify

Use the Global Modify feature to:

View a microblocks full path, control program name, and the privileges required to change its
properties.

View or change a single property in several control programs at one time.

View errors on graphics and Properties pages.

1
2

Browse to any page that displays the property you want to view or change.
Do one of the following to access Global Modify.
Right-click the property, then select Global Modify.
Alt+click the property.
Make changes to the Control Program field, if needed.
NOTES

Use wildcards in the Control Program field to broaden the search.

For example:

vav* matches vav, vav1, vavx, vav12345

vav*z matches vavz, vav1z, vavxz, vav12345z
vav*1*2 matches vav12, vavabc1xyz2
vav?? matches vav11, vav12, vavzz, but does not match vav, vav1, vav123

4
5
6

44

* matches any control program

Click Show Advanced to view the location, value, and privileges associated with this property.

Select the tree item under which you want to search for every occurrence of that microblock in
other control programs.
Click Find All.
Select the properties in the list that you want to change.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Do one of the following:

Type a New Value to the right of each selected item (a).

Type a number in the Set All To field (b).

Type a number in the Change All By field (c).

If you typed a value in b, click Set All To.

If you typed a value in c, click Change All By.
9 Click Apply Changes.
NOTE To modify several properties in multiple control programs at the same time, use Global Copy.
8

To use Global Copy

Use Global Copy to copy any or all of the following from one control program to other equipment using
the same control program:

Embedded trend graph settings

Custom trend graphs
Custom reports
Other editable properties to other pieces of equipment using the same control program.

On the GEO or NET tree, right-click the piece of equipment that has the properties you want to
copy, then select Copy Control Program Properties.
In the Global Copy dialog box, select the items that you want to copy.
Select the area on the tree containing similar control programs that you may want to copy these
properties to, then click Search.
All instances at that level and below are listed in the expanded lower window.
Select or clear checkboxes as needed.

2
3

2012 Automated Logic Corporation

45

WebCTRL v5.5 User Manual

Do one of the following:

Select the Skip bad values checkbox to copy all values except a bad value (it cannot be copied
because you do not have the necessary privilege, the property to be copied is undefined, etc.).

Clear the checkbox to prevent any values from being copied if a bad value is found.
Click Apply Changes, then close the Global Copy dialog box.

Downloading to controllers
If you make any of the following changes, you must download the new data from the WebCTRL
application to the affected controllers.
In the WebCTRL
interface

In SiteBuilder

Change or reload a control program

Change or reload a driver
Change a schedule
NOTE A schedule change automatically downloads unless you clear its
Automatically Download Schedules checkbox (on the schedule's Configure
tab under Show Advanced).
Change a BACview file
Select or deselect a .view file's Included in download option
Add a device
Add equipment
Change or reload a control program
Set an object instance
Change or reload a driver
Assign or unassign equipment
Select or deselect a .view file's Included in download option

The WebCTRL application automatically marks the affected controllers as requiring a download. You
can download these controllers from the Downloads page (page 47) or Properties page (page 48) for
the controller, the equipment, or a microblock.
When the WebCTRL application marks a controller for download, it determines what information
needs to be downloaded based on the type of information that changed. See Download Options (page
47).
NOTES

46

A property change in the WebCTRL interface is automatically downloaded to the controller. If the
download fails, the controller is added to the Downloads page with the reason for the failure.

To see who downloaded a controller last, go to the NET tree, select the controller, then do one of
the following:

Go to Reports > Network > Controller Status, then click Run.

View Downloaded by on the Properties page.

Click Module Status on the Properties page.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Download Options
When the WebCTRL application marks a controller for download, it determines what information
needs to be downloaded based on the type of information that changed. Below are the options that
can be downloaded.
This option...

Downloads...

All Content

Only the executable portion of the driver and control programs

The names of all .equipment, .bacview, and .driver source files
The names of any .view files that are marked to be included in a
download
Parameters
Schedules
NOTE An All Content download also:
Synchronizes the controller's time to the WebCTRL server.
Overwrites trends in the controller.
Restarts the controller.

Only Schedules

All schedules that are not set for automatic download

Only Parameters

All editable properties

Only BBMDs

BBMD tables (.bdt file) that you have updated but have not yet written to the
controller

NOTES

An All Content download clears trend, history, and alarm data from the affected controllers. At the
beginning of the download process, trends that have the Trend Historian enabled are saved to the
system database.

If Field Assistant will be used with your system, you can choose to have the All Content option
download the full source files instead of only their names. In the WebCTRL NET tree, select a
controller, then enable Download Source Files on the Properties page. See Commissioning
equipment using Field Assistant.

To download from the Downloads page

The Downloads page shows any controllers that the WebCTRL application marked for download. But
if needed, you can add other controllers to the list.
To download:
1 On the NET tree, select an item to download controllers at and below that item.
2 Click Downloads.
3
4

Click
to the left of a Location to see controllers that require a download.
Optional: To add controllers to the list:
a) Click Add.
b) Select the controller(s).
NOTE Use Ctrl+click or Shift+click to select multiple controllers.
c) Select a Download Option (page 47).
d) Click Add, then click Close.

2012 Automated Logic Corporation

47

WebCTRL v5.5 User Manual

Select the controllers that you want to download.

NOTES

Use Ctrl+click, Shift+click, or the Select All checkbox to select multiple controllers.

A network's controllers download in the order shown. To change the order, select a
controller(s), then drag and drop or click Move to Top or Move to Bottom.
EXCEPTION If a controller's router requires a download, it will download first regardless of its
position on the Download page.
Click Start.

NOTES

Click Hold to stop pending

downloads. Active downloads
cannot be stopped.
Up to 5 routers can download simultaneously.
A controller is removed from the list when its download is complete.
Icons in the Tasks column indicate the following:
ActiveThe WebCTRL application is downloading to the controller.
PendingYou initiated the download, and the controller is waiting for its turn to
download.
FailedThe download failed. See If a controller fails to download (page 48).
On HoldIndicates either of the following:
The controller requires a download
download.
You clicked Hold to stop a pending

Click
in the upper left-hand corner to view a log of download activity in the current session.
Copy to Clipboard lets you copy the text to paste it into another application.
To remove an item from the download list, right-click the item, then select Remove selected tasks.

To download from a Properties page

If a controller requires a download, a red download message and a Download button appear at the top
of the Properties page for the controller, the equipment, or a microblock. Click the button to start the
download.
Downloading from the Properties page downloads All Content to the controller.

If a controller fails to download

A controller that fails to download appears on the Downloads page with this icon
1 Review the reason for the failure:

Hold your cursor over the failed task to see hover text giving the reason.

Click
in the upper left-hand corner of the page to see information on all failed downloads.
Copy to Clipboard lets you copy the text to paste it into another application.
Correct the problem that caused the failure.
Select the controller on the Downloads page, then click Start.

2
3

48

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Checking controller status

On the WebCTRL NET tree, you can select a network, router, site, or the system, and then click the
Devices button to:

View the status of controllers (page 49)

View controller information such as address, model, driver, and .view files included in download

Download or upload to resolve a mismatch (page 51)

Troubleshoot network communication

Download or upload files for Field Assistant

NOTES

Use Ctrl+click, Shift+click, or the Select All checkbox to select multiple controllers.
Click Hold to stop pending
downloads or uploads. Active downloads
or uploads
be stopped.
Icons in the Tasks column indicate the following:

cannot

ActiveThe WebCTRL application is downloading to the controller.

ActiveThe WebCTRL application is uploading from the controller.
PendingYou initiated the download, and the controller is waiting for its turn to
download.
FailedThe download failed. See If a controller fails to download (page 48).
On HoldIndicates you clicked Hold to stop a pending

download.

Click
in the upper left-hand corner to view a log of activity on the Devices page in the current
session. Copy to Clipboard lets you copy the text to paste it into another application.

Status messages
On the WebCTRL NET tree, you can select a router, network, site, or the system to view the status of
controllers. The Status column shows a description of the controller's current state. Hold your cursor
over that description to see hover text with a more detailed description.
If multiple conditions exist, WebCTRL displays the message with the highest priority.
The table below shows all possible messages. The message color indicates the following:
GreenIn process
RedAn error occurred
BlueRequires action from the user

2012 Automated Logic Corporation

49

WebCTRL v5.5 User Manual

Status column
message

Hover text message

Notes

Green messages:
Downloading

The controller is downloading,

communications may be disabled

Uploading

The controller is uploading,

communications may be disabled

Pending

This controller is waiting to be

processed.

Red messages:
Connection Error

The connection for this controller

failed to start.

Occurs if the connection is

misconfigured or failed to start.

Connection Disabled

The connection for this controller has

been disabled.

Occurs if someone stopped the

connection. This includes stopping a
connection, using the No Connect
connection, or running WebCTRL
Design Server.

Out of Service

This controller is out of service.

The controller's Out of Service

checkbox on the Properties page is
enabled.

Communications Error Cannot communicate with this

controller.
Not Uploadable

This controller is not configured for

content upload.

Download Failed

(Message depends on the cause of

the failure.)

Error

An unknown error has occurred.

Occurs if you attempt to upload a

controller with a pre-4.x driver.

Blue messages:

50

Download All Content

Please download all content to the

controller.

Controller Replaced

This controller has been replaced by

another controller of the same type in
the field.

4.x driver only

Program Mismatch

Content differences detected. Upload

all content from the controller or
download all content to the controller.

4.x driver only

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Status column
message

Hover text message

Driver Parameter
Mismatch

Driver parameter differences

detected. Upload parameters from the
controller or download parameters to
the controller.

Parameter Mismatch

Control Program parameter

differences detected. Upload
parameters from the controller or
download parameters to the
controller.

Download Parameters

To download parameters, highlight

row and select "Parameters" from the
Download Action menu and click
"Download"

Download Schedule

To download schedules, highlight row

and select "Schedules" from the
Download Action menu and click
"Download"

Notes

General messages:
This controller is ok.
Cancelled

The last operation on this controller

was cancelled

To resolve a mismatch
A mismatch occurs when a value in a controller does not match the value in the WebCTRL Server
application. Use either of the following methods to handle mismatches in your system.

Select Always upload properties from controllers to WebCTRL Server on mismatch on the System
Settings > Communications page to have the WebCTRL application upload automatically.

Clear Always upload properties from controllers to WebCTRL Server on mismatch so that you can
evaluate every mismatch to determine the correct value. When a mismatch occurs:
1. On the NET tree, select the controller's network.
2. Click Devices.
3. On the Manage tab, select a controller with a mismatch.
4. Do one of the following:
Click Upload to upload parameters from the controller to WebCTRL Server.
Click Download to download parameters from WebCTRL Server to the controller.
NOTE Click the mismatch message in the Status column to view details.

2012 Automated Logic Corporation

51

WebCTRL v5.5 User Manual

Setpoints
Use setpoints to set temperature values that control the HVAC equipment. The WebCTRL interface
shows the color green when a zone is within the desired temperature range determined by the heating
and cooling setpoints.

Programmed setpoints are set and changed by operators. See To change programmed setpoints
(page 52).

Effective setpoints reflect the impact of other system conditions on the programmed setpoints,
such as setpoint adjustments, demand reduction adjustments, and hysteresis. Effective setpoints
control the equipment.
Besides manually adjusting setpoints, you can use the following cost-saving strategies (page 139) to
adjust setpoints automatically:

Optimal Start
Demand Control
Setpoint Optimization

To change programmed setpoints

Navigate to a setpoint control in one of the following places:

The zone temperature section of a Properties page

The setpoint microblock pop-up on a Logic page

A Graphics page (Click a setpoint trend graph control to access the editable setpoint bar.)
On a programmed setpoint bar, click the segment or the gap between segments you want to
change.
Type new values in the Heating and Cooling fields.

TIP You can click and drag a segment or a gap between segments to change setpoints.
Click OK.

Optimal Start
Optimal Start gradually moves the unoccupied setpoints toward the occupied setpoints as the
occupied time approaches. The actual equation that a controller uses to calculate Optimal Start is
nonlinear. An approximation of the equation is shown below.
calculated capacity =

52

design temp OAT

x capacity at 65
design temp 65

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Refining Optimal Start saves energy in the following ways:

Removing guesswork from preheating or precooling zones

Ensuring that zones reach the ideal comfort range just as people arrive

Preventing equipment from running unnecessarily during unoccupied periods

You can adjust the Optimal Start routine in the control program's setpoint microblock.
1 In the GEO tree, select the equipment that you want to change.
2 Click Properties.
3 Adjust the following fields located below the setpoint graph.
Field

Notes

Heating Capacity
Cooling Capacity

The maximum rate (in F/hr) that the zone temperature could be changed
by heating or cooling if the outside temperature were 65F.
For example, if it takes 2 hours for a zone to warm up from 65F to 72F,
the heating capacity is 3.5F/hr
NOTE Use 5/hr as a starting point if you are unsure of actual capacities.

Heating Design Temp

Cooling Design Temp

The most extreme outside winter and summer temperatures at which the
equipment must run 100% of the time to maintain the zone temperature
at a comfortable level.
ASHRAE determines design temperatures based on the geographic
location of the building.

NOTE Setpoint microblocks with Learning Adaptive Optimal Start functionality automatically adjust the
heating and cooling capacities to optimize efficiency.

2012 Automated Logic Corporation

53

WebCTRL v5.5 User Manual

Learning Adaptive Optimal Start

If you are using the Learning Adaptive Optimal Start feature and a zone does not reach the ideal
temperature range by the time occupancy begins or reaches it too soon, then the heating or cooling
capacities of the equipment are automatically adjusted up or down for the next unoccupied period.

When the Learning Adaptive Optimal Start routine runs, adjustments are made based on the color that
is achieved when occupancy begins. Adjustment amounts are defined for thermographic colors in the
control program's setpoint microblock.
For example, the heating capacity for a zone is 5 per hour. When the zone becomes occupied, the
zone temperature is 1 below the occupied setpoint, indicating a need for additional heat. Because
the zone temperature was low by 1, the learned heating capacity will be decreased by the Less than
Heating setpoint value. If the value is 0.06, the learned heating capacity will be adjusted to 4.94 for
the next optimal start period. The setpoint adjustment will begin sooner in the next unoccupied period.
If you need to change the adjustment values in the Learning Adaptive Optimal Start routine:
1 In the GEO tree, select the equipment that you want to change.
2 Click Properties.
3 Adjust the color fields between the Zone Set Points graph and the Effective Set Points graph.
CAUTION When using Learning Adaptive Optimal Start, be sure that all equipment is properly
maintained so that your system doesnt learn to compensate for dirty filters or loose fan belts.
TIP After your system has run for at least a year, you may want to turn off learning in your control
program, and change the Heating Capacity and Cooling Capacity in your control program to match the
learned heating or cooling capacity shown on the Properties page.

54

Fields

Notes

Color fields

The amount of adjustment the system makes for the color that is
achieved at the beginning of occupancy.

Learned cooling and

heating capacity

The rate (in F/hr) that the zone temperature can change by heating or
cooling at an outside temperature of 65F.

Actual or
adjusted capacity

The actual heating or cooling capacity of the equipment at an outside

temperature of 65F.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Demand Control
Demand Control is a cost-saving strategy that saves energy while maintaining comfort in the following
ways:

Controlling energy use to avoid peak demand, ratchet, or time of use utility charges

Maintaining ventilation at relaxed setpoints rather than shutting down equipment (as with load
shedding or duty cycling)
Before you can use Demand Control effectively, you must:

Obtain details regarding past energy usage and peak demand, ratchet, and time of use charges
from your energy provider.

Understand the demand profiles of the zones you are controlling.

Demand Control can be customized at the zone level. For example, you may relax the setpoints in
some zones, like break rooms and closets, by a few degrees, but you may not want to relax setpoints in
computer rooms at all.
Setpoint microblocks that have a Demand input use a demand control strategy to conserve energy by
relaxing setpoints as the demand level rises. In the EIKON LogicBuilder application, you define the
amount that setpoints will be adjusted or relaxed based on the demand level.

To define Demand Control properties

On the GEO or NET tree, select the electric meter.
Click Properties.
Expand the Demand Level Parameters section.
Type the Start Time and End Time to define the time period that you want demand control to be in
effect for this zone.
5 Type kilowatts per hour (kW/hr) in the Level columns to define the amount of power that the
demand must exceed before the WebCTRL system calls for a higher demand level.
NOTE Levels are defined in the electric meter control program in the EIKON LogicBuilder application.
You can test the Demand Levels by locking the meter to a value.
In the example below, during Period 4, defined as 12:00 (noon) to 16:00 (4:00 p.m.), if the demand
1
2
3
4

2012 Automated Logic Corporation

55

WebCTRL v5.5 User Manual

exceeds 800 kW/hr, the WebCTRL system will use Demand Level 1 setpoints. If the demand exceeds
1000 kW/hr, the WebCTRL system will use Demand Level 2 level setpoints and so on.

Setpoint Optimization
Setpoint Optimization, also known as Trim and Respond, saves energy by calculating the setpoint of a
piece of equipment based on the number of heating or cooling requests it receives from other
equipment.
You must put a Setpoint Optimization microblock in a control program to receive Total, Average,
Minimum, or Maximum microblock outputs from linked equipment.

56

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Chapter 6
Schedules
Using schedules, your equipment can maintain one set of setpoints during occupied periods to provide
comfort, and it can maintain a different set of setpoints during unoccupied periods to reduce energy
consumption. Schedules are a WebCTRL system's most effective cost-saving strategy (page 139).
You can apply a schedule to a tree item or to a group of tree items.
When you apply a schedule to a tree item, the schedule affects
equipment at and below the area or equipment where the
schedule was added.

When you apply a schedule to a schedule group, the schedule

affects all pieces of equipment in the group.
For example, a school board meets every third Tuesday of the
month and uses the lobby, main conference room, break room,
and restrooms. You can create a schedule group to control these
different areas with a single schedule.

NOTES

When multiple schedules affect a tree item, the combined result is the Effective Schedule (page
61).

Do not include preheating or precooling time in your schedules. Optimal Start (page 52), another
cost-saving strategy, automatically calculates and controls precise preheating and precooling
routines.

If you are using hierarchical servers, when you add or change a schedule on the parent server, the
schedule is automatically downloaded to the corresponding location on the child server(s).

2012 Automated Logic Corporation

57

WebCTRL v5.5 User Manual

To view schedules
1
2
3

Select a GEO tree item.

Click Schedules, then the View tab.
Optional: Click an Effective bar to view all the schedules that contribute to the resulting schedule.
If the item has multiple schedules, the schedule closest to the Effective bar has the highest
priority. You set a schedule's priority when you create the schedule.

NOTES

You can display icons and hover text in the GEO tree that show where schedules have been
created. See Tree icons and hover text (page 25).

You can also view schedules on the following detailed, printable schedule reports. These reports
are accessible from the Schedules page Reports tab or from the Reports button drop-down menu.

This report...

allows you to...

Schedule Instances

Find every schedule with its location that is entered at and below a
selected tree item. This report can help you discover newly added and
conflicting schedules.

Effective Schedules

View all equipment that may be scheduled and the net result of all
schedules in effect for a selected date and time. See Effective
Schedules (page 61).

Setting up schedules
To apply a schedule to equipment
WebCTRL schedules are typically based on zone occupancy. See Using schedule categories (page
63) if you want to create a schedule based on conditions other than occupancy.
1 On the GEO tree, select the area or equipment you want to schedule.
2 Click Schedules, then Configure.
3 Click Add.
4 Select a Priority. A schedule's priority determines whether affected zones will use occupied or
unoccupied setpoints.

5
6

58

Select...

For...

Normal

A typical occupied period

Holiday

An unoccupied period that overrides a Normal schedule

Override

An occupied period that overrides a Holiday schedule

Select a Type. See table below.

Type a schedule name in the Description field.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Enter desired values in the fields below Description.

On the graph, change the schedule's default time segment (shown as a colored bar) by doing one
of the following:

Click the segment, then type Start and End times in the fields above the segment.

Click and drag either end of the segment or the entire segment.
9 Optional: Click Show Advanced below the schedule bar to add one or more separate segments to
the schedule.
10 Click OK.
7
8

Type

Schedule runs

Weekly

Every week on the specified days

Date

On a single, specified date

Date Range

Between 2 specified dates

Date List

On multiple, specified dates

Wildcard

According to a repeating pattern (For example, the second Tuesday of

every month)
NOTE Wildcard schedules do not work with Automated Logic legacy
equipment. The WebCTRL interface will indicate if you apply a schedule
to legacy equipment.

Continuous

Continuously between specified times on 2 separate dates

Dated Weekly

Weekly between a start date and an end date (For example, the summer
break in the school year)
NOTE To use a Dated Weekly schedule with an ExecB controller, you must
use the 1.71:032 (or later) ExecB driver.

NOTES

To have all new schedules and schedule changes in the system download automatically, click
Show Advanced under the Add button, then select Automatically Download Schedules. If you
want to manually download schedules, see Downloading system changes to controllers (page 46).

When you apply a schedule to an item in the GEO tree, the schedule affects that item and all
children of that item. If you do not want an item to be affected by schedules from a higher level,
click Show Advanced under the Add button, then select Ignore Schedules above this level.

To apply a schedule to a group of items

You must create a group, then add members (areas, equipment, or other groups) to the group before
you can apply a schedule to it.
1 On the GRP tree, select Scheduling Groups.
Optional: If you have created folders to organize your groups, select the appropriate folder. See
"To organize groups using folders" below.
2 Click Add Group.
3 Type a name for the new schedule group in the Name field.

2012 Automated Logic Corporation

59

WebCTRL v5.5 User Manual

4
5
6
7
8

Optional: Change the default Reference name. A group's reference name must be unique
throughout the system.
Click OK.
Click Go.
On the Members page, select the areas, equipment, or other groups that you want to add to the
group from the tree on the right. Use Ctrl+click, Shift+click, or both to select multiple items.
Click Add.

TIP Use the Raise and Lower buttons to reorder items in the Members list. Changing the
order is for your viewing convenience and does not affect the system.
9 Click OK.
10 Click the Schedules button, then Configure.
11 Add a schedule to the group. See To apply a schedule to equipment (page 58).
NOTE When using hierarchical servers, you can place a server link in a schedule group on the parent
server. This automatically creates a schedule group with the same name on the child server(s). This
group includes only the top-most area node of the child server. However, from the child server you can
edit the group to add other members.

To organize groups using folders

You can create folders and sort your groups into them to organize the GRP tree. For example, a large
school system that has a group for each school may want to create an Elementary School folder, a
Middle School folder, and a High School folder, and put the appropriate groups in each folder.

To create folders and add groups to them:

1 On the GRP tree, select Scheduling Groups.
2 Click Add Folder.
3 Type a name for the new folder in the Name field.

60

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

4
5
6
7

Optional: Change the default Reference name.

Click OK.
Repeat steps 14 for each folder that you want to add.
Do one of the following to add a group to a folder:

If you have already created the group, drag and drop it into the appropriate folder in the tree
on the Scheduling Groups page, then click OK.

Select the folder in the tree on the Scheduling Groups page, click Add Group, enter a Name
for it, then click OK.

NOTE You can also add a folder to a folder, or drag and drop a folder into another folder.

To edit or delete a schedule

Do one of the following:

On the GEO tree, select the tree item where the schedule was defined.

On the GRP tree, expand Scheduling Groups, then select the group you want to edit the
schedule for.
2 Click Schedules, then Configure.
3 Select the schedule you want to edit or delete.
4 Edit the fields you want to change or click Delete.
5 Click OK.
NOTE Expired dated schedules are automatically deleted from the database at 3:30 AM every day. But
expired schedules remain in the controller until the next time schedules are downloaded to the
controller. You can change the deletion time on the Scheduled Tasks tab of the System Settings (page
159) page.
1

Effective Schedules
The effective schedule that you see on the Schedules View tab can be the result of multiple
overlapping schedules.

The following schedule features can influence an item's effective schedule.

2012 Automated Logic Corporation

61

WebCTRL v5.5 User Manual

Feature

Description

Hierarchy

A schedule applied to an item on the WebCTRL tree affects that item and all of its
children. A child item's effective schedule could be the result of multiple schedules
applied at different levels above it. To change a child item's effective schedule:

Add a schedule at the child that overrides the current schedule. See the Priority
feature below.

Set the child to ignore the parent schedules. To do this, select the child item in the
tree, then go to Schedules > Configure. Select the schedule, click Show Advanced,
then select Ignore Schedules above this level. You can then add a different
schedule for the child.

Any schedule change that you make to an item affects it and all of its children.
Priority

You must assign one of the following priorities to every schedule.

Use...

For...

Normal

A typical occupied period

Holiday

An unoccupied period that overrides a Normal schedule

Override

An occupied period that overrides a Holiday time

EXAMPLE For a school, you define:

62

A Normal schedule that has it occupied every MondayFriday, 6 am5 pm

A Holiday (unoccupied) schedule for the week of Spring Break

An Override schedule on the first day of Spring Break from 9 am1 pm for the
cafeteria only where a teacher's meeting will be held.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Feature

Description

Type

You must assign one of the following types to every schedule.*

Weekly
Date
Date Range
Date List

Wildcard
Continuous
Dated Weekly

See To apply a schedule to equipment (page 58) for a description of each type.
EXAMPLE For a school, you define the following 3 schedules:

Full calendar year: Normal, Weekly, MondayFriday, 6am5pm

Summer months: Holiday, Continuous, 12am June 1st 11:59pm August 31st

Work days in summer months: Override, Dated Weekly, MondayThursday,

9am2pm

* If you do not see one of the types listed above, go to CFG > Categories > Schedule. Select
the Occupancy category, then the Priority. Under Schedule Types, select the missing type,
then click OK.

Using the Priority and Type options, you can often accomplish the effective schedule you need in
several different ways. For example, the effective schedule resulting from the 3 schedules described
above for Type could also be accomplished with the following schedules:
School year: Normal, Dated Weekly, MondayFriday, September 1stMay 31st, 6am5pm
Summer months: Normal, Dated Weekly, MondayThursday, June 1stAugust 31st, 9am2pm

Using schedule categories

Occupancy is the only default schedule category. It is a binary schedule category that allows a zone or
piece of equipment to be defined as On when a space is occupied and Off when it is unoccupied.
You can add custom schedule categories to handle other conditions if the equipments control
program includes a Time Clock microblock. For example, you can add a multi-state schedule category
to control lights: on during work hours, off at night, and dim for janitorial work.

Creating a custom schedule category

1
2
3

Create the custom schedule category in the EIKON LogicBuilder application. See "To use custom
alarm and schedule categories" in EIKON LogicBuilder Help.
In the EIKON LogicBuilder application, select the new category from the Schedule Category
droplist in a Time Clock microblock.
Create the same custom schedule category in the WebCTRL interface. The Reference Name
must be identical to the category's name in the EIKON LogicBuilder application. See "To add a
custom schedule category in the WebCTRL interface" below.

2012 Automated Logic Corporation

63

WebCTRL v5.5 User Manual

To add a custom schedule category in the WebCTRL interface

TIP Study the default Occupancy category to understand the various properties you need to set
when adding a new schedule category.
PREREQUISITES

Add the custom schedule category in the EIKON LogicBuilder application. See "To use custom
alarm and schedule categories" in EIKON LogicBuilder Help.

In the EIKON LogicBuilder application, select the new category from the Schedule Category
droplist in a Time Clock microblock.

On the WebCTRL CFG tree, click the plus sign (+) to the left of the Categories folder, then click
Schedule.
Click Add Category.
Enter values or add items for the fields in each section of the page. See table below.
NOTE The fields that you see depend on selections you made in previous sections. Category
Details fields.
Click OK.

2
3

64

Field

Notes

Reference Name

Must be unique in the database, be lowercase, and not

contain any spaces.

This name must be identical to the name of the custom

schedule category that you added in the EIKON LogicBuilder
application.

Do not use occupancy as the reference name.

Schedule Category Description

The name used in the WebCTRL interface

Allowed Type

Replace Undefined with one of the following:

Boolean: binary (on/off, true/false) condition

Multi State: list of integer-defined states. For example, 1=off,

2=on, 3=dim

Default Value

Displays what schedule value is in effect for times not specified by

the schedule. To set this value, in the Allowed Values table, select
the value that you want to use as the default, then click the Make
Default OK button.

Allowed Values

If you selected Boolean above, select True Value or False Value.

If you selected Multi State, click the Add Value button to create
each schedule state.

Allowed Value Description

The name used in the WebCTRL interface.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Field

Notes

Pattern

Type none, dark, or

/_common/lvl5/graphics/patterns/xxx.gif,
where xxx.gif is any .gif file in the
webroot\_common\lvl5\graphics\patterns folder.

Priority Description

The name used in the WebCTRL interface.

Index

Represents this prioritys relative level of importance within this

schedule category. The WebCTRL application automatically
assigns the priority index, which is zero for the first priority level.
The higher the index value, the higher the priority of the schedule
type relative to other schedules. BACnet limits the number of
priority indices to 16.

Color

Color of the schedule bar on the Schedules page.

Schedule Types

The Weekly type is available for Index 0 only.

The Allow Wildcards and Partial Day options affect all selected
schedule types.

Default Schedule

The default schedule used when this category is selected. Create

the schedule by adding segments for each state until every hour
in the 24-hour schedule is covered by a segment.
EXCEPTION If you selected Partial Day in the Schedule Types
field, you do not have to add segments for the entire 24-hour
period.

To view, edit, or delete a schedule category

1
2
3
4

On the CFG tree, click the plus sign (+) to the left of the Categories folder, then click Schedule.
In the Schedule Categories table, select the category you want to edit or delete.
Edit the fields in the Category Details section or click Delete.
Click OK.

2012 Automated Logic Corporation

65

WebCTRL v5.5 User Manual

Chapter 7
Trends
The WebCTRL application can read and store equipment status values over time and then display
this information in a graph to help you monitor the equipments operation.
You can collect trend data for any BACnet input or output point in the WebCTRL system. The
controller reads values for a point at intervals that you define and then stores that data in the
controller.
Because a controller has limited memory for storing trend data, you can set up historical trending to
archive the trend data from the controller to the WebCTRL database. A trend graph can display data
from both the controller and the database.

To collect trend data for a point

PREREQUISITE Assign an input or output number to the point in the EIKON LogicBuilder or
WebCTRL application.
Before you can look at a trend graph for a point, you must enable trending for that point and then
define how you want the controller to collect the point's data.
1 On the GEO tree, select the equipment that has the point you want to trend.
2 Click the Trends button drop-down arrow, select Disabled Points, then select the point.
3 Click the Enable/Disable tab, then select Enable Trend Log to have the controller collect trend
data.
4 Enter information in the appropriate fields. See table below.
5 Click OK.
TIP You can set up all trends for a piece of equipment at once on the Trend Sources tab of the
equipment's Properties page.

66

Field

Notes

Sample every _:_:_

(hh:mm:ss)

Records the points value at this interval.

NOTE Set trend intervals for U line controllers to one minute or
greater. U line controllers are designed to meet low end, high volume
terminal control applications and are not suited to very short trend
intervals.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Field

Notes

Sample on COV
(change of value)

Records the points value only when the value changes by at least the
amount of the COV Increment.
NOTE Use this method for a binary point or for an analog point that
has infrequent changes in value.

Allocate memory for __

samples in the controller

Type the maximum number of samples to be stored in the controller.

NOTES

Trending consumes memory in the controller. The amount of

memory available depends on the type of controller. Each
trended point consumes 48 bytes of memory plus 10 bytes for
each trend sample. Each trend microblock consumes 416 bytes
of memory plus 10 bytes for each trend sample.

Click Reset to delete all samples currently stored in the controller.

Changing the value in Allocate memory for __ trend samples in

the controller will delete all of the point's trend samples currently
stored in the controller. Click the Store Trends Now button before
changing the value to transfer the trend data from the controller
to the system database.

The sample and memory allocation fields together define trend data
storage in the controller in terms of hours.
EXAMPLE If you set these fields so that samples are collected every
5 minutes for a maximum of 120 samples, the controller will store
600 minutes (5 x 120) or 10 hours of trend data.
Stop When Full

Select this field to stop trend sampling when the maximum number
of samples is reached.

Enable trend log at specific

times only?

Collects trend data for the specific period of time you define in the
time and date fields.

Enable Trend Historian

Archives trend data to the system database.

Store Trends Now

Writes all trend data in the controller to the system database without
having to enable trend historian.

Every __ trend samples write

to historian

Writes all trend data in the controller to the system database each
time the controller collects the number of samples that you enter in
this field. This number must be greater than zero and less than the
number entered in the field Allocate memory for __ samples in the
controller. The number of trends specified must be accumulated at
least once before the historical trends can be viewed.

Trend samples accumulated

since last notification

Shows the number of samples stored in the controller since data was
last written to the database.

Last Record Written to

Historian

Shows the number of trend samples that were last written to the
database.

Keep historical trends

for __ days

This is based on the date that the sample was read. Set this field to 0
to use the system default value.

Delete

Deletes all trend samples stored in the database for the item
selected in the GEO tree.

2012 Automated Logic Corporation

67

WebCTRL v5.5 User Manual

Field

Notes

BACnet Configuration

The Object Name is a unique alphanumeric string that defines the

BACnet object. Although the Object Name field can be edited, it is not
recommended. The Notification Class is set to 1 to receive alarms
generated by Automated Logic controllers.

NOTES

You can use Global Copy (page 44) to copy trend properties to other pieces of equipment that use
the same control program.

Run a Trend Usage report (page 115) to view trend data.

Graphing data for multiple points

You can graph multiple trend points simultaneously to help monitor and troubleshoot your system.

A comparison trend graph can display up to 4 graphs on the page. Each graph can display up to 4
similar points4 binary points or 4 analog points.
NOTES

68

Before you create a comparison trend graph, you must enable trending for the individual points
you want to include in the graph. See To collect trend data for a point (page 66).

You can display icons and hover text in the GEO tree that show where trend graphs for multiple
points have been created. See Tree icons and hover text (page 25).

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

To create a comparison trend graph

You can select up to 16 trends to view, then save them for graphing again later.
1 In the GEO tree, select the area or equipment where you want to view the graph.
2 Click the Trends button drop-down arrow, then select New Graph.
3 Select up to 16 trends from the selection tree.
NOTES

Use Ctrl+click, Shift+click, or both to select multiple items.

The tree shows only points that have trending enabled. See To collect trend data for a point
(page 66).
4 Click View.
5 Optional: Click Save to name and save the trend graph configuration so the graph will be
accessible from the Trends button.

To edit a comparison trend graph

1
2
3
4

On the GEO tree, select the tree item where the trend was created.
Click the Trends drop-down arrow, then select the trend graph.
Select the Configure tab.
Follow the instructions below for the edits you want to make.

To add another graph to a trend graph page

1
2
3
4

Click the Add button below the Graphs list.

Type a Y-axis label.
Add up to 4 points. (See below.)
Click OK.

To add a point to a trend graph

1
2
3

Select the graph in the Graphs list.

Click the Add button below the Points list.
Select a point from the Data source tree.
NOTES

The tree shows only points that have trending enabled. See To collect trend data for a point
(page 66).

Each graph can display up to 4 similar type points (all binary or all analog).
Click OK.

To delete a point from a trend graph

1
2
3
4

Select the graph in the Graphs list.

Select the point in the Points list.
Click the Delete button below the Points list.
Click OK.

2012 Automated Logic Corporation

69

WebCTRL v5.5 User Manual

To delete a graph from a comparison trend graph page

1
2
3

Select the graph you want to delete in the Graphs list.

Click the Delete button below the Graphs list.
Click OK.

To delete a comparison trend graph

1
2

On the GEO tree, select the tree item where the trend was created.
Click the Trends drop-down arrow, then select the trend graph.

Click the menu button

, then select Delete.

Using trend graphs

In the WebCTRL interface, you can view and print trend graphs. You can also copy the trend data to a
spreadsheet program.

To view a trend graph

1
2
3

On the GEO tree, select the equipment whose trend(s) you want to view.
Click the Trends button drop-down arrow, then select the graph you want to view.
Select the View tab.

NOTES

70

A large marker indicates a point that is in alarm, in fault, out of service, or has been overridden.
Ctrl+click the marker to view details.

A dotted vertical line indicates:

Trend Historian has been enabled or disabled.

The trend object ID of a third-party trend source has been changed. For information only, you
do not need to do anything.

Equipment received a time synchronization from its network router or from the WebCTRL
application. Ctrl+click the line to view the time correction.

Trend Log has been enabled or disabled.

Ctrl+click a dotted vertical line to view details.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Tools for viewing trends

Right-click anywhere on a trend graph to access most of the tools described below.
Shortcut

Tool

Notes

Arrow keys

Pan

If you display more than one graph, panning up and down affects
only one graph at a time. Panning left to right affects all graphs.
You can also Alt+click and drag inside the graph.

Page Down

Zoom in

You can also use the + key on the numeric keypad, the X key, or
drag a rectangle around area.

Page Up

Zoom out

You can also use the - (minus) key on the numeric keypad or the
Z key.

Home

Zoom to extents

Shows all the data you have viewed in the current session of a
particular trend graph.

End

Reset view

Resets the display to its default setting. You can also use the
Enter or R key.

Esc

Undo

Undo up to 10 changes to your view.

Set start date

Enter the date you want the trend to jump to. The trend displays
the same time range for the new date. Press the J key again to
hide the date fields.

History Only

Displays only the historical data on the graph.

Auto Update

The trend graph polls for data every 10 seconds. Press U again to
stop updating.

Point Markers

Shows a marker for each data point in the graph.

Ctrl-C

Copy data to
clipboard

Copies only the data from the time range that is currently
displayed.

Refresh the display

(gather trend data)

Click Trends.

Display a specific
samples data

Ctrl+click a sample to view the point name, time and date the
sample was read, the exact point value, and if the point is in
alarm, is in fault, out of service, or has been overridden. Click
anywhere to clear the details.

To print a trend graph

On the GEO tree, select the equipment that has the trend(s) you want to print.
Click the Trends button drop-down arrow, then select the point graph or custom graph you want to
print.
Select the View tab to display the graph.

Click the print button

1
2

2012 Automated Logic Corporation

71

WebCTRL v5.5 User Manual

To transfer trend data to a table format

You can copy the trend data currently displayed in the graph and paste it into a spreadsheet
application, such as Microsoft Excel.
1 On the GEO tree, select the equipment.
2 Click the Trends button drop-down arrow, then select the point graph or custom graph.
3 Select the View tab to display the graph.
4 Right-click somewhere in the graph, then select Copy data to clipboard.
5 Click OK.
6 Start your spreadsheet program and paste the trend data into your spreadsheet.

72

Convert the trend data in the Time column to a readable date/time format using the spreadsheet
applications formatting options. For example, in Microsoft Excel, highlight the cells you want to
format and choose Format > Cells. On the Number tab, choose Time from the Category list, and
select the type of format you want to see.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Customizing graph appearance

To edit graph properties
Each point trend graph has a standard format. However, you can change the format and how much
data is displayed on the graph.

1
2
3
4
5

On the GEO tree, select the equipment that has the trend graph properties you want to configure.
Click the Trends button drop-down arrow, then select the trend you want to change.
Click the Configure tab.
Edit the graph properties as needed. See table below.
Click OK.

Field

Notes

Font size

Lets you change the font size of the graph's title and other text.

Enable Grid?

Show or hide the graph's grid.

Autoscale x-axis

Gathers the most recent 2000 data samples and then autoscales the x-axis
to include the complete time range of all the samples.

X initial range

If you do not autoscale the x-axis, type in this field how far back in time you
want to display data. For example, if you want to see trend data from a
week ago, type 7 in the Days field.

Autoscale y-axis

Gathers the trend data from the controller and then autoscales the y-axis to
include the complete range of values.

Y-axis minimum and

maximum

If you do not autoscale the y-axis, type the minimum and maximum value
that you want the graph to display.

Graphs*

Add or delete graphs from the page.

Points*

Add or delete points from the graph selected in the Graphs table.

* for custom graphs only

2012 Automated Logic Corporation

73

WebCTRL v5.5 User Manual

To edit colors, line styles, and marker types

You can change colors, line styles, and marker types for both point trend graphs and custom trend
graphs. The changes you make apply to all graphs in the system, and become the default settings for
future trend graphs.
1
2
3

On the CFG tree, select Trends Display Setup to change the settings for displaying trend graphs or
select Trends Print Setup to change the settings for printing trend graphs.
Follow the appropriate instructions below.
Click OK.

To change a color
Click the colored box to the right of the graph element that you want to change, then select the new
color in the color palette. Or, you can type the hexadecimal value in the RGB field.

To change line styles and marker types

For a point trend graph, select the new line style and marker type under Graph 1, Data Series 1.
For a custom trend graph:
1 Click the plus sign (+) to the left of the graph you want to change.
2 The 4 Data Series refer to the 4 points that you can include on a custom trend graph. Under the
appropriate Data Series, select the new line style and marker style you want.

74

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Default settings on Trends Display Setup and Trends Print Setup pages
If you make changes to the Trends Display Setup and Trends Print Setup pages and then find you
need to return them to their original settings, refer to the images below that show the default settings.
Trends Display Setup

2012 Automated Logic Corporation

75

WebCTRL v5.5 User Manual

Trends Print Setup

To copy a trend graphs properties

You can use Global Copy (page 44) to copy trend properties to other pieces of equipment that use the
same control program.

To add, edit, or delete a trend category

A point trend graph is in the Enabled or Disabled category in the Trends button drop-down menu.

You can add categories for your custom trend graphs.

1 On the CFG tree, click the plus sign (+) to the left of the Categories folder, then select Trend.
2 Click Add or select a category to edit.
3 Type the Category Name and Reference Name.

76

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

4
5

Select a privilege so that only operators with that privilege can access trends in the category.
Click OK.

NOTE To delete a category, select the category, click Delete, then click OK.

2012 Automated Logic Corporation

77

WebCTRL v5.5 User Manual

Chapter 8
Alarms
An alarm is a message sent from an alarm source (usually a microblock in a control program) to the
WebCTRL application to notify you that certain conditions exist, such as a piece of equipment has
stopped running or a temperature is too high. When the WebCTRL application receives an alarm, it
displays information about the alarm on the Alarms page. It can also perform alarm actions to inform
personnel of the condition and to record information about the alarm. An alarm source can also send a
return-to-normal message when the alarm condition returns to its normal state.

Alarm sources and the alarms they generate are assigned to categories, such as HVAC Critical or HVAC
Maintenance, to help you work with related alarms.
The application engineer usually sets up alarm sources in the EIKON LogicBuilder application. In the
WebCTRL interface, you can:

78

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

View, acknowledge, and delete alarms (page 79)

Set up the alarm actions that the WebCTRL application performs (page 83)

Edit alarm sources that were set up in the EIKON LogicBuilder application or set up new alarm
sources to generate alarms (page 101)

Customize alarms by changing the category or message (page 104)

NOTE Besides the alarms that you set up, the WebCTRL application has built-in system and
equipment alarms.

Viewing, acknowledging, and deleting alarms

In the WebCTRL interface, you can view, acknowledge, and delete alarms that have been received.
Select an item in the tree to see all alarms at that level and below it.
Click the system-wide alarms button to view all alarms in the system. The color of this button signifies
one of the following conditions:

RedCritical alarms need to be acknowledged.

YellowNon-critical alarms need to be acknowledged.
GreenNo alarms need to be acknowledged.

You must acknowledge alarms that have been set up to require acknowledgement.
The WebCTRL application closes an alarm when all of the following have occurred:
You acknowledge the alarm (if required)
The WebCTRL application receives a return-to-normal (if required)
The WebCTRL application performs all alarm actions
You should delete alarms from your system as they are closed because large quantities of stored
alarms can reduce the efficiency of your system. To save alarm information before deleting, select
Alarms > Reports tab > Alarms > click Run button.

To view alarms in the WebCTRL interface

1

2
3

On the GEO or NET tree, select the system level, an area, or a piece of equipment.
NOTE The WebCTRL tree is limited to 10 levels. When an alarm source is deeper than 10 levels,
the alarm is reassigned to the system level.
Click Alarms, then select the View tab.
Select the alarm categories that you want to view. Use Ctrl+click, Shift+click, or both to select
multiple categories, or select the Select All checkbox.
The alarms list displays all alarms received for the selected location and below. See table below.
Double-click an alarm to see more information. Double-click again to hide this information.

2012 Automated Logic Corporation

79

WebCTRL v5.5 User Manual

NOTE This information includes a path to the alarm source. Each section of the path is a link to
that location. For example, in the path West Wing/RTU-1/SSP_LO, West Wing links to the West
Wing graphic, RTU-1 links to the equipment graphic, and SSP_LO links to microblock's Properties
page.
Item

Notes

View By

Select one of the following options to sort the alarms list:

Date

Displays all alarms based on the time the alarm was generated
with the most recent alarm at the bottom of the list.

To Do

Displays only alarms that are waiting on one or more actions to

complete before they are closed.

Incident
Group

Groups the alarms in an alarm incident group with a bracket to

the left of the icons.
Alarm incident group All alarms related to a particular incident.
For example, an alarm and its return-to-normal form an alarm
incident group.

Status table

Gives the status of alarms at the current location (Here) and in the entire
system (Total). This table shows the number of alarms that need a
return-to-normal, need to be acknowledged, or are closed.

Alarm icon

Indicates the alarm category.

Critical alarms: The category icon plus

. For example,

Maintenance alarms: The category icon plus

80

. For example,

Occurred

The date and time the alarm was generated

To Do

Acknowledge indicates the alarm needs to be acknowledged.

Waiting for normal indicates the alarm requires a return-to-normal.
A checkmark indicates the alarm is closed.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Item

Notes

Details

The alarm message.

NOTE An alarm that requires a return-to-normal appears in red text until the
alarm condition returns to normal.

Navigation buttons

Use these buttons to move through the alarm list.

Additional Actions

You can:

Activate
Time-lapse

acknowledge or delete multiple alarms simultaneously

search for an alarm generated on a particular date and time

To troubleshoot an alarm, you can select it and then click the Activate
Time-lapse button. This opens the Alarms time-lapse showing the 1-hour period
in which the alarm occurred. You can step backward or forward through the
time-lapse at 1-minute intervals to see what other alarms occurred at each
minute during that hour. You can also go to the Graphics or Trends time-lapse to
see what else happened when the alarm occurred. See Time-lapse (page 113)
for information on using this feature.

NOTES

Alarms generated by the WebCTRL application appear at the system level.

Alarms generated by controllers appear at the system level on the GEO tree, but in the network
hierarchy on the NET tree.

To acknowledge alarms
To acknowledge a single alarm
1
2
3

On the Alarms page, select the View tab.

Select an alarm that shows Acknowledge in the To Do column.
Click the Acknowledge button beneath the list.

To acknowledge all alarms in the selected categories:

1
2
3

On the Alarms page, select the View tab.

Click Additional Actions.
Click All under Acknowledge alarms in selected categories.

TIP Acknowledging many alarms simultaneously can take a long time. Acknowledge alarms as
they occur to avoid long waits.

2012 Automated Logic Corporation

81

WebCTRL v5.5 User Manual

To delete alarms
To delete a single alarm:
1
2
3

On the Alarms page, select the View tab.

Select an alarm.
Click Delete.

To delete multiple alarms in the selected categories:

1
2
3

On the Alarms page, select the View tab.

Click Additional Actions.
Click the appropriate button under Delete alarms in selected categories.

Closed Incidents deletes all closed incident groups. An incident group is considered closed
when all alarms in the group are closed.

All System deletes all system alarms.

All deletes all alarms at the selected location and below.

NOTES

To have the WebCTRL application automatically delete alarm incident groups a specified number
of days after the groups close, select this option on the Scheduled Tasks tab in System Settings
(page 159).

Also on the Scheduled Tasks tab in System Settings, you can set the WebCTRL application to
archive alarm information to a text file as alarms are deleted.

An alarm source may be set up to generate an alarm and a return-to-normal. If an alarm occurs
but the WebCTRL application never receives the return-to-normal, you can click Force Normal so
that the alarm can be closed. Force Normal has no effect on the alarm condition that generated
the alarm.

To receive audible notification of alarms

You can set up the WebCTRL application to play an audio file on your workstation when it receives a
critical or non-critical alarm.
1 On the CFG tree, select My Settings.
2 On the Settings tab, select Non-critical alarms or Critical alarms to be notified of each type of
alarm.
3 In the Sound File field, type the path to the sound file.
When an alarm triggers the audio file to play, you can temporarily silence the sound by clicking the
and selecting Silence. The alarm is silenced for a period of about 5 minutes or
menu button
until another alarm that triggers a sound is received.

82

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Setting up alarm actions

The WebCTRL application can perform alarm actions listed below to notify personnel of an alarm or
to record information about the alarm. You can assign alarm actions to an alarm source, a category of
alarm sources, alarm sources from a certain location, or a combination of these criteria.
The alarm actions are:
Alarm Popup
Print
Propagate To Server
Run External Program
Send Alphanumeric Page
Send E-Mail
Write to File
If your system has the Advanced Alarming package, the WebCTRL application can also perform the
following alarm actions:
Send SNMP Trap
Write Property
Write to Database
See the following topics for a description of each alarm action.

To assign alarm actions to alarm sources

To assign alarm actions to multiple alarm sources
Although you can assign an alarm action to a single alarm source, you typically assign an action to
multiple alarm sources at the area or equipment level. The alarm action applies to all instances of the
alarm sources at the selected location and below. Click an actions Edit button to make any changes.
To assign an alarm action to alarm sources:
1 On the GEO or NET tree, select the area, equipment, or controller containing the alarm sources.
2 Click Alarms, then select the Actions tab.
3 Follow the 3 steps on the screen.
NOTE Use Ctrl+click, Shift+click, or both to select multiple items.
4 Click Add.
5 Set up the alarm action by editing the fields on the alarm action page. See the appropriate alarm
action below for field descriptions.
6 Click OK.
After you have assigned alarm actions to an alarm source, simulate the alarm (page 103) to check
your work. If an alarm action fails, the WebCTRL application receives an alarm for the failed action.
NOTES

Click View Selected Sources to view or change settings for each alarm.

You can display icons and hover text in the GEO tree that show where alarm actions have been
created. See Tree icons and hover text (page 25).

2012 Automated Logic Corporation

83

WebCTRL v5.5 User Manual

To assign an alarm action to a single alarm source

1
2
3
4
5

On the GEO or NET tree, select the alarm source (microblock).

Click Alarms, then select the Actions tab.
Click the drop-down arrow to select an alarm action, then click Add.
Set up the alarm action by editing the fields on the alarm action page. See the appropriate alarm
action below for field descriptions.
Click OK.

Alarm Popup
The Alarm Popup alarm action pops up a message on any computer that is running the WebCTRL
Alarm Notification Client application.
Field

Notes

To Operator
To Group

Select individual operators or operator groups who should receive alarm

notification.

Generate alarm if
delivery fails

Select this checkbox to generate a System Info alarm if the popup recipient is
not currently running the Alarm Notification Client application.

Message text

Use punctuation, spaces, or returns after the entries to format the text.
To add live data to the text, select field codes (page 107) from the Append
Field Code list.

Append Field Code

Add field codes (page 107) to the message text if desired.

Perform Action

By default, the WebCTRL application performs an alarm action when the

alarm source generates an alarm and when it returns to normal. Under
Perform Action, you can choose to run the alarm action:

Only when the alarm source generates an alarm or when it returns to

normal.

After a specified amount of time if the alarm has not been acknowledged
or has not returned to normal. Use this option for alarm escalation. *

If the alarm occurs during the occupied hours defined for a schedule
group or run if the alarm occurs during the unoccupied hours defined for a
schedule group. *
EXAMPLE To have one alarm action performed during work hours and a
different alarm action performed after work hours:
1. Create a schedule group (page 59), but do not assign members to it.
2. Create a schedule for the group. Set the occupied hours to be the
same as the work hours.
3. Create the alarm action that is to be performed during work hours.
Under Perform Action, select If schedule group <your new group> is
Occupied.
4. Create the alarm action that is to be performed after work hours.
Under Perform Action, select If schedule group <your new group> is
Unoccupied.
* Available only if you have the Advanced Alarming package.

84

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Using the Alarm Notification Client application

The Alarm Notification Client application must be running on each client computer that should receive
popup notifications. Keep the application minimized to the right side of the Windows task bar. The
window will pop up with a message whenever an alarm occurs.
to open a browser window displaying the piece of equipment
Select an alarm message, then click
that generated the alarm. A grayed out alarm indicates that it was acknowledged in the WebCTRL
interface.
If the Alarm Notification Client is set up to play a continuous alarm sound, you can silence an alarm by
clicking Silence!, by pressing Ctrl+S, or by acknowledging the alarm in the WebCTRL interface.

Button

Notes
Opens a browser window that displays the equipment that generated the alarm.
Copies the selected alarm information to the clipboard.
Removes the alarm information from the alarm popup list. Removing items from this list
has no effect on the alarms list in the WebCTRL interface.
View information about the server connection.
On this tab...

You define...

Server
Connection

The WebCTRL server and port, and the WebCTRL operator name
and password
NOTE The default port is TCP 47806. If you change this, you must
also change the Port field in the WebCTRL System Settings. See "To
set up the WebCTRL Server application to support Alarm Popup
clients" below.

Browse To

The WebCTRL page that you want to see first when browsing to the
equipment

Internet Explorer Whether or not browsing to the equipment opens a new browser
window
Notification
Sounds

If you want to hear a sound when an alarm occurs

Which sound you want to hear for each type of alarm.

NOTE A Connection Failure occurs when the Alarm Notification
Client loses communication with the WebCTRL Server application.

Whether you want the sound to continue until silenced

NOTE If multiple types of alarms occur simultaneously, the
application plays the sound of the most critical alarm (Connection
Failure first, then Critical, then Normal).

2012 Automated Logic Corporation

85

WebCTRL v5.5 User Manual

To set up the WebCTRL Server application to support Alarm Popup clients

On the WebCTRL CFG tree, select System Settings.
On the General tab, select Enable support for Alarm Popup clients to connect to this server.
If the server has more than one network interface adapter, type in the Restrict to IP Address field
the IP address that the Alarm Notification Client application will connect to. You must specify the
same IP address in the Server field in the Alarm Notification Client.
4 Use the default port or specify a different port. You must specify the same port in the Port field in
the Alarm Notification Client.
NOTE If the Alarm Notification Client application is not on the local network and will access
WebCTRL alarms through a NAT router, you must port forward the TCP port you defined in step 4
above.
1
2
3

To install the Alarm Notification Client application

Follow the steps below on each client computer that should receive alarm popups.
PREREQUISITE Enable support for Alarm Popup client in System Settings. See above topic.
1 On the CFG tree, click Client Installs.
2 Select the Alarm Popup Application.
3 Click Run, then follow the on-screen instructions to install the Alarm Notification Client application.
After you click Done, the application starts automatically.
4

5
6

In the Settings dialog box, enter appropriate values. You can also click
to open this box. See
the table above for a description of each setting.
NOTE You can lock the Settings so that a user cannot edit them. See To lock a client's Settings
feature below.
Click OK.
Minimize the Alarm Notification Client window.

To lock a client's Settings feature

To prevent a user from editing the Settings
:
1 Right-click Alarm Notification Client in the Windows Start menu.
2 Select Properties.
3

86

On the Shortcut tab, type -lockconfig at the end of the Target path.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Print
The Print alarm action prints alarm information.
Field

Notes

Text Printing

Select to use the WebCTRL server's local dot-matrix printer. Text Printing will
not print to a network printer.
In the Printer Name field, type the computer port that the printer is connected
to. In the Line Width field, type the number of characters to be printed per
line.
Prints multiple alarms per page.

Graphics Printing

Select to use the WebCTRL server's default printer (local or network printer).
Prints one alarm per page to the WebCTRL server's default printer.

Text to Print

Use punctuation, spaces, or returns after the entries to format the text.
To add live data to the text, select field codes (page 107) from the Append
Field Code list.

Perform Action

By default, the WebCTRL application performs an alarm action when the

alarm source generates an alarm and when it returns to normal. Under
Perform Action, you can choose to run the alarm action:

Only when the alarm source generates an alarm or when it returns to

normal.

After a specified amount of time if the alarm has not been acknowledged
or has not returned to normal. Use this option for alarm escalation. *

If the alarm occurs during the occupied hours defined for a schedule
group or run if the alarm occurs during the unoccupied hours defined for a
schedule group. *
EXAMPLE To have one alarm action performed during work hours and a
different alarm action performed after work hours:
1. Create a schedule group (page 59), but do not assign members to it.
2. Create a schedule for the group. Set the occupied hours to be the
same as the work hours.
3. Create the alarm action that is to be performed during work hours.
Under Perform Action, select If schedule group <your new group> is
Occupied.
4. Create the alarm action that is to be performed after work hours.
Under Perform Action, select If schedule group <your new group> is
Unoccupied.
* Available only if you have the Advanced Alarming package.

2012 Automated Logic Corporation

87

WebCTRL v5.5 User Manual

Propagate To Server
The Propagate To Server alarm action sends the selected alarm to the parent server in a system with
hierarchical servers.
Field

Notes

Message text

The alarm message that is sent to the parent server.

Append Field Code

Add field codes (page 107) to include live data in the Message text field.

Perform Action

By default, the WebCTRL application performs an alarm action when the

alarm source generates an alarm and when it returns to normal. Under
Perform Action, you can choose to run the alarm action:

Only when the alarm source generates an alarm or when it returns to

normal.

After a specified amount of time if the alarm has not been acknowledged
or has not returned to normal. Use this option for alarm escalation. *

If the alarm occurs during the occupied hours defined for a schedule
group or run if the alarm occurs during the unoccupied hours defined for a
schedule group. *
EXAMPLE To have one alarm action performed during work hours and a
different alarm action performed after work hours:
1. Create a schedule group (page 59), but do not assign members to it.
2. Create a schedule for the group. Set the occupied hours to be the
same as the work hours.
3. Create the alarm action that is to be performed during work hours.
Under Perform Action, select If schedule group <your new group> is
Occupied.
4. Create the alarm action that is to be performed after work hours.
Under Perform Action, select If schedule group <your new group> is
Unoccupied.
* Available only if you have the Advanced Alarming package.

Run External Program

The Run External Program alarm action starts a program or batch file on the server.

88

Field

Notes

Command Line

The path of the executable file on the WebCTRL server followed by the path
of the output file.
EXAMPLE:
c:\windows\notepad.exe c:\WebCTRL\webroot\alarms.txt

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Field

Notes

Append Field Code

Add field codes (page 107) to the Command Line field.

EXAMPLE:
c:\reports\run_report.bat $Generation_time$$To_State$
This starts a batch file on the server and uses the alarms generation time
and state as values.

Synchronize

Tells the WebCTRL application to wait for the external program to finish
running before initiating the next Run External Program alarm action.

Perform Action

By default, the WebCTRL application performs an alarm action when the

alarm source generates an alarm and when it returns to normal. Under
Perform Action, you can choose to run the alarm action:

Only when the alarm source generates an alarm or when it returns to

normal.

After a specified amount of time if the alarm has not been acknowledged
or has not returned to normal. Use this option for alarm escalation. *

If the alarm occurs during the occupied hours defined for a schedule
group or run if the alarm occurs during the unoccupied hours defined for a
schedule group. *
EXAMPLE To have one alarm action performed during work hours and a
different alarm action performed after work hours:
1. Create a schedule group (page 59), but do not assign members to it.
2. Create a schedule for the group. Set the occupied hours to be the
same as the work hours.
3. Create the alarm action that is to be performed during work hours.
Under Perform Action, select If schedule group <your new group> is
Occupied.
4. Create the alarm action that is to be performed after work hours.
Under Perform Action, select If schedule group <your new group> is
Unoccupied.
* Available only if you have the Advanced Alarming package.

Send Alphanumeric Page

The Send Alphanumeric Page alarm action sends a page to one or more alphanumeric pagers or
sends text messages to cell phones. The pager or phone must be able to accept e-mail.
Field

Notes

To

Type the address(es) that you want to send the alarm to. To enter multiple
addresses, type a space or press Enter after each address.

From

Enter a valid address if required by your mailserver.

Mail Host

The mailserver's address. This can be an IP address or a system name,

such as mail.mycompany.com.

Mail Host Port

Change this field if using a port other than the default port 25.

2012 Automated Logic Corporation

89

WebCTRL v5.5 User Manual

Field

Notes

Mail Host Security

Options

Select the type of security the mailserver uses.

Cleartext Uses the SMTP protocol to send as clear text over TCP/IP

Secure SSL Uses SSL, a communication protocol that provides data

encryption

Secure TLS Uses SSL, but does not begin encryption until the
WebCTRL application issues STARTTLS command

Specify Mail User For Select if your mailserver requires a username and password.
Mail Host
Authentication
Send mail as MIME
attachment

Select if your mailserver allows only MIME attachments.

Message Text

Use punctuation, spaces, or returns after the entries to format the text.
To add live data to the text, select field codes (page 107) from the Append
Field Code list.

Perform Action

By default, the WebCTRL application performs an alarm action when the

alarm source generates an alarm and when it returns to normal. Under
Perform Action, you can choose to run the alarm action:

Only when the alarm source generates an alarm or when it returns to

normal.

After a specified amount of time if the alarm has not been acknowledged
or has not returned to normal. Use this option for alarm escalation. *

If the alarm occurs during the occupied hours defined for a schedule
group or run if the alarm occurs during the unoccupied hours defined for a
schedule group. *
EXAMPLE To have one alarm action performed during work hours and a
different alarm action performed after work hours:
1. Create a schedule group (page 59), but do not assign members to it.
2. Create a schedule for the group. Set the occupied hours to be the
same as the work hours.
3. Create the alarm action that is to be performed during work hours.
Under Perform Action, select If schedule group <your new group> is
Occupied.
4. Create the alarm action that is to be performed after work hours.
Under Perform Action, select If schedule group <your new group> is
Unoccupied.
* Available only if you have the Advanced Alarming package.

NOTE You should not assign this alarm action to frequently-occurring alarms as this may cause
problems on your network or the Internet.

To set up a dial-up networking connection

The WebCTRL application can use a dial-up internet connection through a modem to deliver e-mail
for the Send E-mail or Send Alphanumeric Page alarm action.
To set up the dial-up connection:

90

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

1
2
3
4
5
6
7

Set up your modem to dial out to your Internet Service Provider. See your modem documentation.
On the WebCTRL server, open Internet Explorer.
Select Tools > Internet Options.
On the Connections tab, click Setup.
Follow the instructions in the wizard. See Windows Help for assistance.
In a text editor such as Windows Notepad, open WebCTRLx.x\webroot\<system>\
system.properties.
At the end of the file, type the following line:

repactions.connection.name=<name of connection>
where <name of connection> is the ISP name you entered in the wizard in step 2.
8 Open Internet Explorer, then select Tools > Internet Options > Connections tab.
9 If the box under Dial-up and Virtual Private Network settings shows more than one connection,
select the connection that you just created, then click Set Default.
10 Select Always dial my default connection.

Send E-mail
The Send E-mail alarm action sends a message to one or more e-mail accounts. The alarm action can
also run a report and attach it to the e-mail as a PDF, HTML, or Excel file.
Field

Notes

To

Type the address(es) that you want to send the alarm to. To enter multiple
addresses, type a space or press Enter after each address.

From

Enter a valid address if required by your mailserver.

Mail Host

The mailserver's address. This can be an IP address or a system name,

such as mail.mycompany.com.

Mail Host Port

Change this field if using a port other than the default port 25.

Mail Host Security

Options

Select the type of security the mailserver uses.

Cleartext Uses the SMTP protocol to send as clear text over TCP/IP

Secure SSL Uses SSL, a communication protocol that provides data

encryption

Secure TLS Uses SSL, but does not begin encryption until the
WebCTRL application issues STARTTLS command

Specify Mail User For Select if your mailserver requires a username and password.
Mail Host
Authentication
Send mail as MIME
attachment

Select if your mailserver allows only MIME attachments.

Message Text

Use punctuation, spaces, or returns after the entries to format the text.
To add live data to the text, select field codes (page 107) from the Append
Field Code list.

2012 Automated Logic Corporation

91

WebCTRL v5.5 User Manual

Field

Notes

Attach Report

Select to attach a WebCTRL report to the e-mail, then select the Report and
the Format.
NOTE The Report Name field shows a custom report only if it was created at
the current system level.
Run as shows the name and login name of the operator creating the alarm
action. The report will be run using the privileges and report options of this
operator.
TIP You may want to create a new operator with limited privileges for this
purpose.

Perform Action

By default, the WebCTRL application performs an alarm action when the

alarm source generates an alarm and when it returns to normal. Under
Perform Action, you can choose to run the alarm action:

Only when the alarm source generates an alarm or when it returns to

normal.

After a specified amount of time if the alarm has not been acknowledged
or has not returned to normal. Use this option for alarm escalation. *

If the alarm occurs during the occupied hours defined for a schedule
group or run if the alarm occurs during the unoccupied hours defined for a
schedule group. *
EXAMPLE To have one alarm action performed during work hours and a
different alarm action performed after work hours:
1. Create a schedule group (page 59), but do not assign members to it.
2. Create a schedule for the group. Set the occupied hours to be the
same as the work hours.
3. Create the alarm action that is to be performed during work hours.
Under Perform Action, select If schedule group <your new group> is
Occupied.
4. Create the alarm action that is to be performed after work hours.
Under Perform Action, select If schedule group <your new group> is
Unoccupied.
* Available only if you have the Advanced Alarming package.

NOTE You should not assign this alarm action to frequently-occurring alarms as this may cause
problems on your network or the Internet.

To secure mailserver communication using Secure Sockets Layer (SSL)

Before the WebCTRL application sends an email using SSL, it requests an SSL certificate from the
mailserver. If the certificate that the WebCTRL application receives is in its list of trusted certificates,
it sends the email. If the certificate is not in the list, the WebCTRL application generates a system
alarm indicating that the email alarm action failed. If this occurs, you will need to add the mailserver's
certificate to the WebCTRL application's list of trusted certificates.
1 Get a copy of the certificate file from the mailserver. Ask your Network Administrator for help.
2 Put the file on the WebCTRL server.
3 From the server's Start menu, select Run.

92

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

In the Open field, type the following command:

C:\WebCTRL<x.x>\java\<operating_system>\jre\bin\keytool.exe -import
-trustcacerts -alias smtpserver -keystore webserver\keystores\certkeys
-file <file_path>

replacing:
<x.x> with the system's version number
<operating_system> with the WebCTRL folder name for the operating system you are running
<file_path> with the full path and file name of the certificate file
The information for the smtpserver key is displayed and you are prompted to trust this certificate.
Type yes.

To set up a dial-up networking connection

The WebCTRL application can use a dial-up internet connection through a modem to deliver e-mail
for the Send E-mail or Send Alphanumeric Page alarm action.
To set up the dial-up connection:
1 Set up your modem to dial out to your Internet Service Provider. See your modem documentation.
2 On the WebCTRL server, open Internet Explorer.
3 Select Tools > Internet Options.
4 On the Connections tab, click Setup.
5 Follow the instructions in the wizard. See Windows Help for assistance.
6 In a text editor such as Windows Notepad, open WebCTRLx.x\webroot\<system>\
system.properties.
7 At the end of the file, type the following line:
repactions.connection.name=<name of connection>
where <name of connection> is the ISP name you entered in the wizard in step 2.
8 Open Internet Explorer, then select Tools > Internet Options > Connections tab.
9 If the box under Dial-up and Virtual Private Network settings shows more than one connection,
select the connection that you just created, then click Set Default.
10 Select Always dial my default connection.

Send SNMP Trap

NOTE To see if your system has this optional package, click
package if Enabled Features shows Adv. Alarming.

, then select About. You have this

The Send SNMP Trap alarm action sends an SNMP trap in response to receiving an alarm. Traps
contain the text created in the Text to send as the SNMP Trap field in the alarm action dialog box. You
can configure up to five SNMP servers to receive traps.

2012 Automated Logic Corporation

93

WebCTRL v5.5 User Manual

NOTES

WebCTRL supports SNMP v1.

Each SNMP server you want to receive these traps must have SNMP monitoring equipment
installed. If problems arise with your SNMP connection or receiving traps, contact your IS
department.

This alarm action uses Port 162 to send SNMP traps. To use a different port, open
WebCTRLx.x\webroot\<system_name>\system.properties in a text editor such as Notepad. In
the line #snmp.trap.port = 162, delete # at the beginning of the line and change 162 to the port
you want to use. If you make this change while the WebCTRL Server application is running, you
must restart it to have the change take effect.
Field

Notes

Network Address*

The network address of the SNMP server receiving the SNMP trap.

Community Name*

The community name that the SNMP server belongs to.

Comment

The physical location of the SNMP server. This field is optional.

Trap number*

If the network administrator has configured trap numbers, type a unique

number from 1 to 127.
NOTE The same trap number is used for all messages from this alarm action.

Text to send as the

SNMP Trap

255 character limit. Type punctuation, spaces, or returns after the entries to
format the message. You can customize this text by selecting field codes
(page 107) from the Append Field Code list.

Perform Action

By default, the WebCTRL application performs an alarm action when the

alarm source generates an alarm and when it returns to normal. Under
Perform Action, you can choose to run the alarm action:

Only when the alarm source generates an alarm or when it returns to

normal.

After a specified amount of time if the alarm has not been acknowledged
or has not returned to normal. Use this option for alarm escalation. *

If the alarm occurs during the occupied hours defined for a schedule
group or run if the alarm occurs during the unoccupied hours defined for a
schedule group. *
EXAMPLE To have one alarm action performed during work hours and a
different alarm action performed after work hours:
1. Create a schedule group (page 59), but do not assign members to it.
2. Create a schedule for the group. Set the occupied hours to be the
same as the work hours.
3. Create the alarm action that is to be performed during work hours.
Under Perform Action, select If schedule group <your new group> is
Occupied.
4. Create the alarm action that is to be performed after work hours.
Under Perform Action, select If schedule group <your new group> is
Unoccupied.
* Available only if you have the Advanced Alarming package.

* Ask your network administrator for this information.

94

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Write Property
NOTE To see if your system has this optional package, click
package if Enabled Features shows Adv. Alarming.

, then select About. You have this

The Write Property alarm action writes a specified value to a BACnet property. You typically set up 2
alarm actions, the first writes a value when the alarm occurs and the other writes a value when the
return-to-normal occurs.
Field

Notes

Expression

Type the target propertys expression.

Value to Write

Type the value you want to write to the microblock property. Type 0 or 1 for a
binary property.

Append field code to

value

Select field codes (page 107) to add this information to the Value to Write
field.

Perform Action

By default, the WebCTRL application performs an alarm action when the

alarm source generates an alarm and when it returns to normal. Under
Perform Action, you can choose to run the alarm action:

Only when the alarm source generates an alarm or when it returns to

normal.

After a specified amount of time if the alarm has not been acknowledged
or has not returned to normal. Use this option for alarm escalation. *

If the alarm occurs during the occupied hours defined for a schedule
group or run if the alarm occurs during the unoccupied hours defined for a
schedule group. *
EXAMPLE To have one alarm action performed during work hours and a
different alarm action performed after work hours:
1. Create a schedule group (page 59), but do not assign members to it.
2. Create a schedule for the group. Set the occupied hours to be the
same as the work hours.
3. Create the alarm action that is to be performed during work hours.
Under Perform Action, select If schedule group <your new group> is
Occupied.
4. Create the alarm action that is to be performed after work hours.
Under Perform Action, select If schedule group <your new group> is
Unoccupied.
* Available only if you have the Advanced Alarming package.

2012 Automated Logic Corporation

95

WebCTRL v5.5 User Manual

Write to Database
NOTE To see if your system has this optional package, click
package if Enabled Features shows Adv. Alarming.

, then select About. You have this

The Write to Database alarm action stores alarm information in a table in the WebCTRL alarm
database or in a custom database. Third-party applications can access the alarm information for
building maintenance management or alarm analysis. For example, an application can perform actions
such as triggering a stored procedure or running a report.

Writing to the WebCTRL alarm database

When you add the Write to Database alarm action, by default the WebCTRL application writes alarm
information to the write_db_ra table in the WebCTRL alarm database. The following table describes
the information that is written to the database and gives the column name and data type you will need
in order to access the alarm information from a third-party application.

96

Description

Column Name

Data type

Alarm generation time

EVENT_TIME_

Datestamp

Path to the alarm source

Example: #slm/m073

SOURCE_PATH_

String

Display name path to the alarm source

Example: Atlanta Office/R&D Facility/Second Floor/VAV 2-1/Z
one Temp

DISPLAY_NAME_

String

Alarm state
Example: OFF NORMAL, LOW LIMIT, HIGH LIMIT

EVENT_STATE_

String

Alarm text as defined in the Text to write to the database field

on the alarm action page. You can add live data to the text by
selecting field codes (page 107) from the Append Field Code
list.

RA_TEXT_

String

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

By default, the WebCTRL application performs an alarm action when the

alarm source generates an alarm and when it returns to normal. Under
Perform Action, you can choose to run the alarm action:

Perform Action

Only when the alarm source generates an alarm or when it returns to

normal.

After a specified amount of time if the alarm has not been acknowledged
or has not returned to normal. Use this option for alarm escalation. *

If the alarm occurs during the occupied hours defined for a schedule
group or run if the alarm occurs during the unoccupied hours defined for
a schedule group. *
EXAMPLE To have one alarm action performed during work hours and a
different alarm action performed after work hours:
1. Create a schedule group (page 59), but do not assign members to it.
2. Create a schedule for the group. Set the occupied hours to be the
same as the work hours.
3. Create the alarm action that is to be performed during work hours.
Under Perform Action, select If schedule group <your new group> is
Occupied.
4. Create the alarm action that is to be performed after work hours.
Under Perform Action, select If schedule group <your new group> is
Unoccupied.
* Available only if you have the Advanced Alarming package.

NOTES

To keep the database table from growing too large, you must delete old entries using a third-party
database application. You cannot view, edit, or delete entries in the WebCTRL interface.

If your system uses an Access or MSDE database, you cannot open the database in a third-party
application while the WebCTRL or SiteBuilder application is running.

Writing to a custom database

The WebCTRL application can write alarm information to the following types of custom databases.
The custom database does not have to be the same type as the WebCTRL database.
SQL Server
MySQL
PostgreSQL
Oracle
You may create a table in an existing third-party database or create a new database.
Using your database management tool, create a table in your custom database that includes fields for
each alarm field code to be written to the table. Each field length in the table should be as long as the
longest value to be written to that field.
To set up writing to a custom database instead of the WebCTRL alarm database, select the Specify
Custom Database checkbox on the Alarms page Actions tab, then enter information in the remaining
fields. See table below.

2012 Automated Logic Corporation

97

WebCTRL v5.5 User Manual

98

Field

Notes

Text to write to the

database

The text is made up of field codes (page 107) that add live data to the text.
You can select additional field codes from the Append Field Code list.
NOTE To write the text in this field to the custom database, you must include
the Report Text field code ($report_text$) in the Database Insert String field
described below.

Database Connect
String

For database type...

SQL Server
MySQL
PostgreSQL
Oracle

Database Login and

Password

The login and password to connect to the database.

Database Insert
String

Use the following format:

Insert into <TABLE_NAME> (<column1_name>, <column2_name> ...) values
(<$field_code1$>, <$field_code2$>, ...)
Example:
Insert into WebCTRL_ALARMS (TIME_, LOCATION_, TO_STATE_, TEXT_) values
($generation_time$, $location_path$, $to_state$, $report_text$)
NOTES
You can add field codes (page 107) to the Insert String using the Append
Field Code list.
If you add a timestamp type field code (for example, $generation_time$), you
should have the data go into a timestamp data type field in the custom
database. Otherwise, you must use field code formatting (page 107) to format
the time.

The connect string format is...

jdbc:odbc:<odbc_alias>
jdbc:mysql://<host>:<port>/<instance>
jdbc:postgresql://<host>:<port>/<instance>
jdbc:oracle:thin@<host>:<port>/<instance>
where:
<host> is the database server name/IP address
<port> is the port number for the database
<instance> is the database name in the database
server
<odbc_alias> is the name of the ODBC data source

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Field

Notes

Perform Action

By default, the WebCTRL application performs an alarm action when the

alarm source generates an alarm and when it returns to normal. Under
Perform Action, you can choose to run the alarm action:

Only when the alarm source generates an alarm or when it returns to

normal.

After a specified amount of time if the alarm has not been acknowledged
or has not returned to normal. Use this option for alarm escalation. *

If the alarm occurs during the occupied hours defined for a schedule
group or run if the alarm occurs during the unoccupied hours defined for a
schedule group. *
EXAMPLE To have one alarm action performed during work hours and a
different alarm action performed after work hours:
1. Create a schedule group (page 59), but do not assign members to it.
2. Create a schedule for the group. Set the occupied hours to be the
same as the work hours.
3. Create the alarm action that is to be performed during work hours.
Under Perform Action, select If schedule group <your new group> is
Occupied.
4. Create the alarm action that is to be performed after work hours.
Under Perform Action, select If schedule group <your new group> is
Unoccupied.
* Available only if you have the Advanced Alarming package.

Write to File
The Write to File alarm action can do either of the following:

Record alarm information in a standard ASCII text file that you can view and edit using a text editor
such as Windows Notepad.

Write a WebCTRL report to a file.

Field

Notes

File Name

Path name for the file you want to write to such as

c:\WebCTRLx.x\webroot\alarms.txt.

Write as File

If you do not specify a path, the file is written to the system folder.
If you type a path that does not exist, the WebCTRL application will create
the necessary folders.
You can write to one of the following:
- a file on the server
- a networked computer if you map the network drive. Use
the drive mapping in the path from the server to the computer.
The path name may contain field codes (page 107).

Select to record alarm information in a text file.

2012 Automated Logic Corporation

99

WebCTRL v5.5 User Manual

Field

Notes

Append

Select to append new alarm information to the end of the file instead of writing
over existing data.
NOTE Because you can append new alarm information to the end of the file,
this file can become very large. You must back up and delete this file
frequently if you are using this alarm action with many alarms.

Text to write to the

file

Use punctuation, spaces, or returns after the entries to format the text.
To add live data to the text, select field codes (page 107) from the Append
Field Code list.

Write as Report

Select to write a WebCTRL report to a file, then select the Report and the
Format.
NOTE The Report Name field shows a custom report only if it was created at
the current system level.
Run as shows the name and login name of the operator creating the alarm
action. The report will be run using the privileges and report options of this
operator.
TIP You may want to create a new operator with limited privileges for this
purpose.

Perform Action

By default, the WebCTRL application performs an alarm action when the

alarm source generates an alarm and when it returns to normal. Under
Perform Action, you can choose to run the alarm action:

Only when the alarm source generates an alarm or when it returns to

normal.

After a specified amount of time if the alarm has not been acknowledged or
has not returned to normal. Use this option for alarm escalation. *

If the alarm occurs during the occupied hours defined for a schedule group
or run if the alarm occurs during the unoccupied hours defined for a
schedule group. *
EXAMPLE To have one alarm action performed during work hours and a
different alarm action performed after work hours:
1. Create a schedule group (page 59), but do not assign members to it.
2. Create a schedule for the group. Set the occupied hours to be the same
as the work hours.
3. Create the alarm action that is to be performed during work hours.
Under Perform Action, select If schedule group <your new group> is
Occupied.
4. Create the alarm action that is to be performed after work hours. Under
Perform Action, select If schedule group <your new group> is
Unoccupied.
* Available only if you have the Advanced Alarming package.

100

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Setting up an alarm source in the WebCTRL interface

The application engineer usually sets up alarm sources in the EIKON LogicBuilder application. In the
WebCTRL application, you can:

Edit an existing alarm sources settings or set up a new alarm source to generate alarms.

Set up all alarms for a piece of equipment at once on the Alarm Sources tab of the equipment's
Properties page.

Simulate an alarm to test its setup.

Two types of microblocks generate alarms in control programs.

Alarm microblocks include logic that takes into account conditions such as space occupancy.

I/O point microblocks can generate an alarm when the present value exceeds defined limits
(analog) or when the present value changes to an off-normal state (binary). This type of microblock
is typically set up for analog points to generate alarms for sensor failure.
Alarm microblocks and I/O microblocks can have similar names. So, when you are going to enable an
alarm source, first look for an alarm microblock in the GEO or NET tree.
This type of microblock...

Appears in the GEO or NET tree as...

To set up, edit, or disable alarm sources

To set up, edit, or disable a single alarm source
1
2
3
4

On the GEO or NET tree, select the alarm source (microblock).

Click Alarms, then select the Enable/Disable tab.
Make changes to the fields as needed. The fields can vary for different types of alarm sources. See
table below.
Click OK.

TIP To set up all the alarms for a piece of equipment at once, click Properties, then select Alarm
Sources.
Field

Notes

Potential alarm source

Select the checkbox to enable the alarm source to generate alarms. Clear
the checkbox to disable the alarm source.

2012 Automated Logic Corporation

101

WebCTRL v5.5 User Manual

Field

Notes

Alarm

Select to have the alarm source generate an alarm when the specified
conditions occur.

For a binary input, enter the conditions for generating an alarm.

For an analog input, type the low and high limits that, when exceeded,
will generate an alarm.

Deadband The amount inside the normal range by which an alarm

condition must return before a return-to-normal notification is generated.
EXAMPLE

NOTE If the Status checkbox is selected, the alarm condition currently

exists.
Return to Normal

Select to have the alarm source generate a return-to-normal when the

alarm condition returns to a normal state.

Alarm requires
acknowledgement

Select to have the WebCTRL application require that an operator

acknowledge the alarm.

Return requires
acknowledgement

Select to have the WebCTRL application require that an operator

acknowledge the return-to-normal.

Classified as critical

This property determines the color of the system-wide alarm button when
the alarm comes in.
= Critical

Event State

= Non-critical

The current state of the alarm source can be:

Normalvalue is normal
Off normalthe value is not normal (binary only)
Faultthe alarm source microblock may be misconfigured
High Limitthe value exceeds the normal range (analog only)
Low Limitthe value is below the normal range (analog only)

BACnet Configuration:
Dial on alarm

Select to have this alarm immediately delivered through a modem

connection.
NOTE When monitoring your system through a modem connection,
non-critical alarms are stored in the gateway until one of the following
happens:

102

a critical alarm occurs

the gateway is contacted by the WebCTRL application
the gateway buffer is full, at which time all alarms are sent to the
WebCTRL application
2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Field

Notes

Notification Class

Do not change this field.

To set up, edit, or disable multiple alarm sources simultaneously

On the GEO or NET tree, area, equipment, or controller containing the alarm sources.
Click Alarms, then select the Enable/Disable tab.
In step 1, select the categories that contain the alarm sources.
NOTE In step 1 and step 2, Ctrl+click, Shift+click, or both to select multiple items, or select the
Select All checkbox.
4 In step 2, select the alarm sources.
5 Make appropriate changes in step 3.
6 Click OK.
NOTE Click View Selected Sources to view or change settings for each alarm.
1
2
3

To simulate an alarm
To test the setup of an alarm source and its alarm actions (page 83), you can simulate an alarm or its
return-to-normal.
1
2
3
4
5

On the GEO tree, select the alarm source ( , but not

) whose alarm you want to simulate.
Click Alarms, then select the Enable/Disable tab.
Select the Enable checkbox next to Alarm or Return to Normal.
Click Simulate next to Alarm or Return to Normal.
Select the equipment on the tree, then select the View tab to see the alarm.

To view all instances of an alarm source

To find all instances of an alarm source at and below a selected area:
1 On the GEO or NET tree, select an area.
2 Select the Message, Actions, Enable/Disable, or Category tab.
3 Select an alarm source from the list in step 2.
4 Click View Selected Sources.
Each path in the dialog box links to the alarm source microblock.
NOTE You may be able to change settings that relate to the tab you selected.

2012 Automated Logic Corporation

103

WebCTRL v5.5 User Manual

Customizing alarms
Each alarm source has an alarm message, category, and template defined in the EIKON LogicBuilder
application. You can change messages and categories in the WebCTRL application.

Alarm messages
An alarm message is the information that appears on the Alarms page View tab for an alarm. An alarm
message can consist of 3 parts.

You can edit Text only at the alarm source in the EIKON LogicBuilder application.
Prefix and Details are hierarchical. They apply at the location where they are added and to all its
children. For example, you could enter Details at the system level to show the acknowledge time for
alarms in the HVAC Critical category. The acknowledge time would then be in any HVAC critical alarm
message in the system.
NOTE An alarm action can have a different message from the alarm message seen on the View tab.
To edit the message for a particular alarm action, see Setting up alarm actions (page 83).

To edit the message for an alarm source

1
2

On the GEO tree, select the alarm source (microblock).

Click Alarms, then select the Messages tab.
NOTE Sample Alarm Message and Sample Return Message show the messages as they are
currently defined.
Do the following as needed:

Edit the Text for Alarm or Return. You can add live data to the text by selecting field codes
(page 107) from the Append Field Code list.

Click the Edit button to edit Message Prefix or Message Details.

In the drop-down list to the right of Message formation, select Add new prefix to beginning of
message or Add new details to end of message, then click Add.
Click OK.

To add a Prefix or Details for multiple alarm sources

1
2

104

In the GEO or NET tree, select the area, equipment, or controller containing the alarm sources.
Click Alarms, then select the Messages tab.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

4
5
6
7
8

In step 1, select the categories that contain the alarm sources whose messages you want to edit.
NOTE In step 1 and step 2, Ctrl+click, Shift+click, or both to select multiple items, or select the
Select All checkbox.
In step 2, select the alarm sources.
In step 3, select Add new prefix to beginning of message or Add new details to end of message.
Click Add.
Type text and add field codes as needed.
Click OK.

Alarm categories
Alarm categories sort related alarm sources and their alarms into groups such as HVAC Critical and
Access Control General. Alarm categories let you:

View, acknowledge, or delete selected categories of alarms (page 79) received by the WebCTRL
application

Assign alarm actions (page 83) to selected categories of alarm sources

Set up alarm sources (page 101) in selected categories

Each alarm source is assigned to an alarm category in the EIKON LogicBuilder application, but you
can change the category assignment in the WebCTRL application.
The WebCTRL application has a number of default alarm categories, but you can create custom
categories, if needed.

To assign alarm sources to a different category

1
2
3

4
5
6

On the GEO or NET tree, select the area, equipment, or controller containing the alarm sources.
Click Alarms, then select the Category tab.
In step 1, select the category that currently contains the alarm sources.
NOTE In step 1 and step 2, Ctrl+click, Shift+click, or both to select multiple items, or select the
Select All checkbox.
In step 2, select the alarm sources whose category you want to change.
In step 3, select a category from the drop-down list, then click Change.
Click OK.

To add a custom alarm category

PREREQUISITE Add the custom alarm category in the EIKON LogicBuilder application. See "To use
custom alarm and schedule categories" in EIKON LogicBuilder Help.
1 On the CFG tree, click the plus sign (+) to the left of Categories.
2 Click Alarms.
3 Click Add. See table below.
4 Click OK.

2012 Automated Logic Corporation

105

WebCTRL v5.5 User Manual

Field

Notes

Reference
Name

Must be unique in the database, be lowercase, and not contain any spaces. This
name must be identical to the name of the custom alarm category that you added in
the EIKON LogicBuilder application.

Icon

1
2
3

Find or create a 32 x 32 pixel icon (.gif file) that represents the new category. For
example,
Store the .gif file in the WebCTRLx.x\webroot\_common\lvl5\
graphics\event_categories folder.
Type
/_common/lvl5/graphics/event_categories/<file_name>.gif in
the Icon field.

If you upgraded alarms from v2.0 or earlier

All v2.5 and later alarms use one template called Universal. This template lets you define your alarm
message text, the critical setting, and the required acknowledgements at the alarm source in the
EIKON LogicBuilder or WebCTRL application.

Templates in upgraded systems

If you upgraded your system from v2.0 or earlier, the alarm sources retained their existing templates
and existing alarm settings. If the existing alarm sources contain little or no customization to the alarm
settings, Automated Logic recommends that you change all of the alarms to use the Universal
template. If the alarm sources had customized alarm settings, continue using the existing templates.

To assign a different template to alarm sources

PREREQUISITE The Alarms Template tab must be visible. If it's not, on the CFG tree, select Privilege
Sets, then select the Maintain Alarm Templates checkbox.
1 On the GEO tree, select the piece of equipment containing the alarm sources to be changed.
2 Click Alarms, then select the Template tab.
3 Follow the 3 steps on the screen.
NOTE Use Ctrl+click, Shift+click, or both to select multiple items.
4 Click Change.
5 Click OK.
TIP To change all alarms in the system simultaneously, go to the system level and then select all
categories and all alarm sources on the Templates tab.

To add an alarm template

1
2
3
4
5

106

On the CFG tree, select Alarm Templates.

Click Add.
Select Source-based (a v2.5 template) or Stand-alone (a pre-v2.5 template), then click OK.
Edit the template fields as needed. See table below.
Click OK.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Field

Template Type

Notes

Reference Name

All

Must be unique in the database, be lowercase, and not

contain any spaces. This name must be identical to the
name of the template in the EIKON LogicBuilder
application.

Display Name

All

The name that will appear in the WebCTRL interface for

this template.

Alarm Message

Source-based

The message text displayed on the View tab or in the alarm

action when an Alarm requires acknowledgement.

Return Message

Source-based

The message text displayed on the View tab or in the alarm

action when a return-to-normal requires acknowledgement.

Fault Message

Source-based

The message text displayed on the View tab or in the alarm

action when a Fault requires acknowledgement.

Critical

Stand-alone

Select if this is a template you will use with a critical alarm.

Acknowledgement
Required

Stand-alone

Select which alarm states require an acknowledgement.

Out of Range

Stand-alone

Analog inputs and outputs that have low and high limit
alarm properties.
Click the plus sign (+) to the left of Out of Range to make
changes to the alarm messages displayed on the Alarms
page > View tab. Short text is the message displayed when
the alarm is not expanded. Long text is the message
displayed when the alarm is double-clicked and expanded.

Change of State

Stand-alone

Binary inputs and alarm microblocks.

See Out of Range above to change the alarm messages.

Copy Field Code to

Clipboard

Stand-alone

To add a field code to any of the message text fields:

1 Select a field code to copy it.
2 Click in the appropriate text field where you want the
field code.
3 Press Ctrl+V to paste the field code.

Using field codes

Use field codes to insert live data into:

The message on an alarm action

Text displayed on the Alarms page > View tab

Alarm information archived to a text file when an alarm is deleted

You can customize the setup of each of these items by appending field codes. For example, to have
the message in an alarm action include the device that generated the alarm, append the Device field
code to the action's message.

2012 Automated Logic Corporation

107

WebCTRL v5.5 User Manual

Format field codes

You can type a formatting command after a field code to format the field code in one of the following 3
ways:

Format a number field code (Example: ##.##)

Format a date/time field code (Example: MM/dd/yyyy hh:mm:ss)

Left, right or center align a field code and set the field width
A formatting command must have the following syntax:

Use the table below to determine the format_type and style for a formatting command.

format_type

Example

style

To format a
number

The actual formatting,

such as ##.##. The basic
format uses the pound
sign (#) to represent a
number. See Other
numerical formatting
System Options
http://java.sun.com/j2se
/1.4.2/docs/api/java/te
xt/DecimalFormat.html.

To always truncate an alarm

value to two digits to the right
of the decimal, the field code
is:
$alarm_value%N:##.##$
For example, 78.9935
becomes 78.99.

To format
date/time

The actual formatting,

such as MM/dd/yyyy
hh:mm:ss. See Date time
formatting System
Options
http://java.sun.com/j2se
/1.4.2/docs/api/java/te
xt/SimpleDateFormat.ht
ml.

To show the date and time

when an alarm is generated in
a format like 03/15/2004
10:50:43, the field code is:
$generation_time%D:MM/dd/
yyyy hh:mm:ss$

To set alignment
and field width

L for left align

R for right align
C for center align

Indicate the field width by To left align the name of the

number of characters.
device that generated the
alarm and set the field width
to 15 characters, the field
code is:
$device%L:15$

Using multiple formatting commands

You can type multiple formatting commands for a field code. For example, you can format a number
and then set the alignment and field width. The syntax for multiple formatting commands is:
$fieldcode%format_type1:style%format_type2:style$
EXAMPLE To format the alarm date and time, center it and set the field at 20 characters, the field
code is:
$generation_time%D:MM/dd/yyyy hh:mm:ss%C:20$
108

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

NOTE You must enter the date/time or number formatting command before the alignment/field width
command.

Field Codes
Field Code Name

Field Code

Description

Acknowledge
Operator

$acknowledge_operator$

The operator who acknowledged the alarm.

Acknowledge Time

$acknowledge_time$

The time when the operator acknowledged the

alarm.

Alarm Category

$event_category$

The alarm category that the alarm is assigned to.

Alarm Template

$event_template$

The alarm template that the alarm is assigned to.

Alarm Type

$event_type$

The alarm type of the alarm source; for example,

CHANGE OF VALUE, CHANGE OF STATE.

Alarm Value

$alarm_value$

The alarm value.

Alert Text

$alerttext$

For a converted SuperVision system if the option

Create a single alarm template... was selected
during upgrade. Retrieves alarm message text
from cmnet_alert_text.properties.
To use this field code:
1 Select the Alert Text field code.
2 After $alerttext, type one of the following:
:normalshort
:normallong
:alarmshort
:alarmlong
For example, $alerttext:alarmlong$

Character

$c$

A single ASCII character. Often used for form

feeds and other printer escape sequences.
For example, $C:65$ displays A.

Command Value

$command_value$

The commanded value from the alarm source.

Valid only for alarm type COMMAND FAILURE.

Dead Band

$deadband$

The deadband value from the alarm source. Valid

only for alarm type OUT-OF-RANGE.

Deletion Operator

$deletion_operator$

The operator who deleted the alarm.

Deletion Time

$deletion_time$

The time the alarm was deleted.

Device

$device$

The display name of the device where the alarm

came from.

Equipment

$equipment$

The display name of the equipment where the

alarm came from.

2012 Automated Logic Corporation

109

WebCTRL v5.5 User Manual

110

Field Code Name

Field Code

Description

Error Limit

$error_limit$

The error limit, from the alarm source. Valid only

for alarm type FLOATING LIMIT.

Exceeded Limit

$exceed_limit$

The exceeded limit value from the alarm source.

Valid only for alarm type OUT-OF-RANGE.

Exceeding Value

$exceeding_value$

The exceeding value from the alarm source. Valid

only for alarm type OUT-OF-RANGE.

Fault

$fault$

The status of the fault condition from the alarm

source.

Feedback Value

$feedback_value$

The feedback value from the alarm source. Valid

only for alarm type COMMAND FAILURE.

Field Message

$field_message$

Additional text recorded in the alarm by the

device.

From State

$from_state$

The previous state of the alarm source.

Generation
Operator

$generation_operator$

The operator who forced the alarm to return to

normal.

Generation Time

$generation_time$

The time in the controller when the alarm was

generated.

In Alarm

$in_alarm$

The in alarm status from the alarm source.

Incident Closed
Time

$incident_closed_time$

The time the alarm's entire incident group closed.

Latched Data Value

(Analog)

$latched_data_analog:x$

"x" ranges from 1 to 10.

Returns a numerical value.
Use for legacy systems.

Latched Data Value

(Digital)

$latched_data_digital:x$

"x" ranges from 1 to 10.

Returns On or Off.
Use for legacy systems.

Location Path

$location_path$

Displays all the path display names from root to

source.

Long Message

$long_message$

The formatted alarm long text displayed by

double-clicking the alarm on the Alarms page.

Message Details

$message_details$

The message details displayed on the Alarms

page View tab.

Message Prefix

$message_prefix$

The message prefix displayed on the Alarms page

View tab.

Message Text

$message_text$

The message text displayed on the Alarms page

View tab.

New State

$new_state$

The status of new state from the alarm source.

New Value

$new_value$

The new value from the alarm source. Valid only

for alarm type CHANGE OF VALUE.

Object ID

$object_ID$

Object ID of the alarm source.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Field Code Name

Field Code

Description

Out of Service

$out_of_service$

The status of 'out of service' from the alarm

source.

Overridden

$overridden$

The status of 'overridden' from the alarm source.

Program ID

$program_id$

The address of the control program that

generated the alarm.
BACnet program address format:
device ID, program number (example: 240219,5)
SuperVision program address format:
site, gateway, controller, fb (example: 1, 2, 13, 5)

Receive Time

$receive_time$

The time at the workstation when the alarm was

received.

Recipient Device ID

$device_id$

The device ID of the device where the alarm came

from.

Record Type

$record_type$

The type of alarm; for example, BACnet,

SuperVision, System.

Reference Path

$reference_path$

Path to alarm source. Available in all alarm

actions.

Reference Value

$reference_value$

The 'reference value' from the alarm source. Valid

only for alarm type FLOATING LIMIT.

Referenced
Bitstring

$referenced_bitstring$

The value of the 'referenced bitstring' value from

the alarm source. Valid only for alarm type
CHANGE OF BITSTRING.

Report Text

$report_text$

Used only with the Write to Database alarm

action. You must include this field code in the
Database Insert String.

RTN Time

$RTN_time$

The time when the alarm returned to normal.

Setpoint Value

$setpoint_value$

The 'setpoint value' from the alarm source. Valid

only for alarm type FLOATING LIMIT.

Short Message

$short_message$

The formatted alarm short text.

Site

$site$

The display name of the site the alarm came from.

Source

$source$

The display name of the alarm source that

generated the alarm.

Source description

$source:description$

The description of the alarm source that

generated the alarm.

2012 Automated Logic Corporation

111

WebCTRL v5.5 User Manual

112

Field Code Name

Field Code

Description

Source Path

$source:<path>$

Displays the value of the <path>.

Example to add text value:
$source:~equipment.display-name$
Example to add a numeric value:
$source:/trees/geographic/rd_facility/
zone_1/lstat/present_value$
The path for a numeric value must be an absolute
path.
NOTES

You can use Global Modify (page 44) to get

the path.

For legacy systems, use the latched data field

codes.

System Directory

$system_dir$

The system folder name.

To State

$to_state$

The current state of the alarm source; for

example, Normal, Fault, Off-normal, High limit,
Low limit.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Chapter 9
Time-lapse
You can replay up to 24 hours of Graphics, Alarms, or Trends pages starting on a specified date and
time. Time-lapse can be a helpful troubleshooting tool.
For Time-lapse to show thermographic colors, the WebCTRL application polls each router in the
system at specified intervals and collects color. Color is collected for the router and its downstream
controllers only if their control program contains a Setpoint, Set Color, or Set Color If True microblock.
The Server then uses the collected colors to create a trend called Color Trend.

To play Time-lapse
1

Select the location in the tree where you want to see the time-lapse.

2
3

Click the menu button

, then select Time-lapse.
In the Replay field, select the length of time that you want to replay. The replay will step through
the data at the interval shown.
In the Start field, select the date and time that you want the replay to begin. You can click:

The

buttons to change the day or time.

The
to select the date.

A date/time field, and then type the new number.

Click OK. The time-lapse immediately begins to play.
Use the following items to work with the time-lapse.

5
6

2012 Automated Logic Corporation

113

WebCTRL v5.5 User Manual

NOTES

While in time-lapse, you can navigate to other locations in the tree.

The Graphics page can replay only trended values. Values that are not trended are grayed out.
Floorplan areas without trend data are dark grey.

You can select an alarm on the Alarms page and then click the Activate Time-lapse button. This
changes the time-lapse to the 1-hour period in which the alarm occurred. You can step backward
or forward through the time-lapse at 1-minute intervals to see what other alarms occurred during
that hour. You can also go to Graphics or Trends to see what else happened when the alarm
occurred.

The white horizontal line on a Trends time-lapse indicates where the replay currently is in the
time-lapse range.

To change polling interval or duration or to turn off color collection

1
2

114

On the CFG tree, select System Settings.

On the Scheduled Tasks tab, do one of the following:

In the Poll Interval field, change the frequency that the server collects color from the routers.
NOTE Last Poll Duration shows how long the last polling of the routers took.

If directed by Automated Logic Technical Support, deselect Enable Server Trending of Color
to stop color collection.
Click OK.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Chapter 10
Reports
Use WebCTRL reports to monitor and troubleshoot your system. In the WebCTRL interface, you can:
View preconfigured reports
Create custom reports
See the table below for a list of all reports.
The Reports button drop-list varies depending on whether you selected the GEO
or NET tree and if you have created any custom reports at or above the
selected location.
A report shows data for the selected item and all of its children.
NOTE You can display icons and hover text in the GEO tree that show where
custom reports have been created. See Tree icons and hover text (page 25).

This preconfigured
report...

allows you to...

Schedules
Schedule Instances

Find every schedule with its location that is entered at and below a
selected tree item. This report can help you discover newly added and
conflicting schedules.

Effective Schedules

View all equipment that may be scheduled and the net result of all
schedules in effect for a selected date and time.

Commissioning
Test & Balance

View the results of VAV box commissioning. Running this report

automatically uploads calibration parameters to the WebCTRL
application.

Equipment Checkout

View the information on the Equipment Checkout tab of the equipment's

Properties page during commissioning. Also, find equipment that has
not been fully commissioned.

2012 Automated Logic Corporation

115

WebCTRL v5.5 User Manual

Alarms
Alarms

View, sort, and filter the information on the Alarms View (page 79) tab.

Alarm Sources

Create a summary of potential alarm sources as configured on the

Alarms > Enable/Disable (page 101) tab.

Alarm Prefixes & Details

Create a summary of the information configured on the Alarms >

Messages (page 104) tab.

Alarm Actions

Create a summary of the information configured on the Alarms > Actions

(page 83) tab.

Equipment
Point List

View the details of all points. Verify that all points have been checked
out during commissioning. Also, create custom lists for other
contractors. For example, create a list of BACnet IDs or Web services
links.

Locked Values

Find all locked points and locked values.

NOTE Locks in the Airflow microblock are not reported.

Network IO

Verify the programming and status of all network pointsespecially

useful for commissioning controllers used for third-party integration.

Trend Usage

Creates a summary of the information configured on the Trends >

Enable/Disable (page 66) tab.

Parameter Mismatch

Discover where your system has parameter mismatches that need to be

resolved.

Security

NOTE You must have the Advanced Security package to run these
reports.

Location Audit Log

View chronological lists of location-based changes, the operators that

made them, and the reasons for the changes. This report includes
changes such as property edits, downloads, driver changes, and view
changes.

System Audit Log

View chronological lists of system-wide changes, the operators that

made them, and the reasons for the changes. This report includes
changes such as any change made in the CFG tree, login/logout, and
scheduled processes like deleting expired trends

Network

116

Equipment Status

Display the thermographic color, status, and prime variable of each

control program.

Controller Status

Discover network communication problems (shown as purple squares on

the report) that need troubleshooting. The report also shows boot and
driver version, download information, and if controller has 4.x or later
driver, the report shows the serial number and Local Access port status.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Add-in reports

Install the following 2 reports if you need them.

1. On the CFG tree, select Reports Administration.
2. Click Add, browse to WebCTRLx.x\extras\web\reports,
then select a report.
3. Click OK.

Historical Trends Report

View historical trend information for the selected GEO tree item,
including the point that was trended, the number of trend samples
collected, and the date and time of the first and last sample.

Equipment Sources Report View heat and/or cool sources, the paths to the equipment, and the
names of the control programs.
This custom report...

allows you to...

Equipment Summary

View the following information for equipment at or below the location

where the report was created:

Color

Active alarm

Locked values

Current value of selected points

Effective schedule
See To create an Equipment Summary report (page 118).
Equipment Values

Compare point information. See To create an Equipment Values report

(page 119).
NOTE This report is available only if your system has the optional
Advanced Reporting package.

Trend Samples

View trend values for a particular time frame. See To create an Trend
Samples report (page 121).
NOTE This report is available only if your system has the optional
Advanced Reporting package.

NOTE The Send E-mail alarm action (page 91) can run any WebCTRL report and attach it to the
email. The Write to File alarm action (page 99) can run any WebCTRL report and save it as a file. For
both alarm actions, the report can be a PDF, HTML, Excel, or CSV file.

To run a report
1
2
3

Select an item on the GEO or NET tree.

Click the Reports button drop-down arrow, then select a report.
On the Options tab, define the layout and content of the report.
NOTES

Changing the size and orientation of the printed page also changes the report layout on the
View tab.

2012 Automated Logic Corporation

117

WebCTRL v5.5 User Manual

To create a CSV (Comma Separated Values) file after you run the report, select Support CSV
text format. See To create a PDF, Excel spreadsheet, or CSV file (page 122).

The current operator's report options are saved so that when that operator logs in again, the
same options are used.
Click Run.
Click PDF if you want to print the report.

4
5

To create an Equipment Summary report

An Equipment Summary report can provide the following information for equipment at or below the
location where the report is created.

Color
Active alarm
Locked values
Current value of selected points
Effective schedule

To create an Equipment Summary report:

1 On the GEO or NET tree, select the location where you want to view the report.
2 Click the Reports button drop-down arrow, then select New Report.
3 Select Equipment Summary.
4 Optional: Select a Category.
NOTE The Category field is visible only if you have defined report categories. See To organize
custom reports (page 123).
5 Type a name for the report.
6 Click Create.
7 Define the Title, Page Size and orientation, and the Maximum number of rows.
8 Select or clear the Optional Sections checkboxes as needed.
9 Optional: Select Include only specific control programs at or below this location, then type the
names of the control programs.
10 Select Available Points that you want to include in the report. Use Ctrl+click, Shift+click, or both to
select multiple items.
11 Click Add.
12 Click OK.
13 Click Run.
NOTE To run this report later, go to the location where the report was created. Click the Reports
button drop-down arrow, select the report, then click Run.

118

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

To create an Equipment Values report

NOTE To see if your system has this optional package, click
package if Enabled Features shows Adv. Reporting.

, then select About. You have this

An Equipment Values report allows you to compare point information.

To create an Equipment Values report:
1 On the GEO or NET tree, select the location where you want to view the report.
2 Click the Reports button drop-down arrow, then select New Report.
3 Select Equipment Values.
4 Optional: Select a Category.
NOTE The Category drop-down list is only visible if you have defined report categories. See To
organize custom reports (page 123).
5 Type a name for the report.
6 Click Create.
7 Do one of the following:

Select Include only specific control programs at or below this location, then type the control
program names.

On the selection tree, select the pieces of equipment you want to view in the report. (Use
Ctrl+click, Shift+click, or both to select multiple items.) Then click Add.
8 Optional: Select the Highlight alternate rows checkbox to make the report easier to analyze.
9 Click Next or
next to Columns.
10 Verify or change the report Title, Page units of measure for defining column widths, and Outer
border characteristics.
11 Select a column in the report preview.
NOTE The selected column is light purple.
12 Under Column Header, define how you want the column header to look.
13 Under Column Data, define the data you want in the column and how you want it to look. See table
below.
NOTE Select General from the Format drop-down list unless you want to define the number of
places to the right of the decimal point for the displayed value.
14 Optional: Use the Add, Delete, and arrow buttons below the report preview to manipulate the
columns.
15 Optional: Click
next to Page to change the page size and orientation.
NOTE Changing the size and orientation of the printed page also changes the report layout on the
View tab.
16 Click OK.
17 Click Run.
NOTE To run this report later, go to the location where the report was created. Click the Reports
button drop-down arrow, select the report, then click Run.

2012 Automated Logic Corporation

119

WebCTRL v5.5 User Manual

Type of Column Data

Point

Trend Sample

Trend
Calculation

Control Program

120

Displays point data in the column.

Display

Select the property to show in this column.

Data is named
differently in some
equipment

Select this checkbox if similar points have different names

in different control programs. Then add each of the names
to the Name to use list.
For example, if a point is named Zone Temp in one control
program and Zone Temperature in different control
program, add both names to the list.

Point to use

Select the name of the point to show in the column.

Display

Select First, Minimum, Maximum, or Last recorded trend

value.

Data is named
differently in some
equipment

Select this checkbox if similar points have different names

in different control programs. Then add each of the names
to the Name to use list.
For example, if a point is named Zone Temp in one control
program and Zone Temperature in different control
program, add both names to the list.

Trend to use

Select the name of the point to show in the column.

Set

Click to have all columns in the report use the same time
range.

Time Range

Select the time range to run the report for.

Display

Select the type of calculation to show in the column,

Average or Total.

Data is named
differently in some
equipment

Select this checkbox if similar points have different names

in different control programs. Then add each of the names
to the Name to use list.
For example, if a point is named Zone Temp in one control
program and Zone Temperature in different control
program, add both names to the list.

Trend to use

Select the name of the point to show in the column.

Set

Click to have all columns in the report use the same time
range.

Time Range

Select the time range to run the report for.

Display

Select Color, Display Name, Display Path, Notes, Prime

Variable, or Reference Name to show in the column.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Type of Column Data

Expression

Data is named
differently in some
equipment

Select this checkbox if similar points have different names

in different control programs. Then add each of the names
to the Name to use list.
For example, if a point is named Zone Temp in one control
program and Zone Temperature in different control
program, add both names to the list.

Expression

Type the path relative to the current control program. The

path must return a string value.
To display the Notes on an equipment's Properties page,
type .notations in this field.

To create an Trend Samples report

NOTE To see if your system has this optional package, click
package if Enabled Features shows Adv. Reporting.

, then select About. You have this

A Trend Samples report provides trend values for a particular time frame.
To create a Trend Samples report:
1 On the GEO or NET tree, select the location where you want to view the report.
2 Select the Reports button drop-down arrow, then select New Report.
3 Select Trend Samples.
4 Optional: Select a Category.
NOTE The Category drop-down list is only visible if you have defined report categories. See To
organize custom reports (page 123).
5 Type a name for the report.
6 Click Create.
7 Select a Time Range from the drop-down list, then refine that option by selecting an option from
the drop-down list(s) to the right.
8 Define the trend data.
NOTES

Calculate values for missing samples calculates a value based on the 2 closest values to the
time interval.

Find the closest sample displays the value closest to the time interval selected.
9 Optional: Select the Highlight alternate rows checkbox to make the report easier to analyze.
10 Click Next or
next to Columns.
11 Verify or change the report Title, Page units of measure for defining column widths, and Outer
border characteristics.
12 Select a column in the report preview.
NOTE The selected column is light purple.
13 Under Column Header, define how you want the column header to look.

2012 Automated Logic Corporation

121

WebCTRL v5.5 User Manual

14 Under Column Data, select the source of the trend data and how you want the data to look.
NOTE Select General from the Format drop-down list unless you want to define the number of
places to the right of the decimal point for the displayed value.
15 Optional: Use the Add, Delete, and arrow buttons below the report preview to manipulate the
columns.
16 Optional: Click
next to Page to change the page size and orientation.
NOTE Changing the size and orientation of the printed page also changes the report layout on the
View tab.
17 Click OK.
18 Click Run.
NOTE To run this report later, go to the location where the report was created. Click the Reports
button drop-down arrow, select the report, then click Run.

To create a PDF, Excel spreadsheet, or CSV file

PREREQUISITE FOR CSV TEXT You must enable Support CSV text format on the Options tab before
you run the report.
1
2
3

Run a report.
Click PDF, Excel, or CSV Text.
For Excel or CSV Text, click Open to view the file or Save to save it.

NOTE If you need a digitally signed PDF to comply with 21 CFR Part 11, open the PDF in a program
that supports digital signing such as Adobe Acrobat, then sign the PDF. The WebCTRL application
does not support digital signing because 21 CFR Part 11 requires that the signature be added
manually, not through an automated process.

To edit or delete a custom report

1
2
3

Select the item in the GEO or NET tree where the report was created.
Click the Reports button drop-down arrow, then select the report you want to edit or delete.
Do one of the following:

Edit the report, then click OK.

122

Click the menu button

, then select Delete.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

To organize custom reports

You can organize your custom reports by creating report categories that appear in the Reports button
drop-down list.

To add or edit a report category

1
2
3
4
5

On the CFG tree, click

to the left of the Categories folder, then click Report.
Click Add or select a category to edit it.
Type the Category Name and Reference Name.
Select a privilege so that only operators with that privilege can access reports in the category.
Click OK.

NOTE To delete a category, select the category, click Delete, then click OK.

To use custom reports from v2.5 or earlier

If you upgrade your WebCTRL system from a version that had custom reports created with
e.Spreadsheet, Report Designer, or Formula One, you can continue to view and edit those reports in
the WebCTRL interface.
Copy the following files from
WebCTRL2.5\webroot\WEB-INF\lib or WebCTRL3.0\lib to WebCTRLx.x\bin\lib in your upgraded
WebCTRL system.
f1j9_de.jar
f1j9_es.jar
f1j9_fr.jar
f1j9_it.jar
f1j9_ko.jar
f1j9_zhs.jar
f1j9_zht.jar
f1j9swing.jar
f1jtextures.jar
Then follow the steps below to make the reports appear in the Reports button drop-down list.

To add a new e.Spreadsheet report

1
2

Go to CFG > Reports Administration and add the report.

In the GEO tree where you want to be able to access the report, click the Reports button down
arrow, then select New Report.

2012 Automated Logic Corporation

123

WebCTRL v5.5 User Manual

Select Other, then select a report type from that drop-down list. Name the report, then click Create.

NOTE Report Designer is licensed to Automated Logic by Actuate Corporation for WebCTRL v2.5 and
earlier systems.

124

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Chapter 11
Operator access
Privileges control the parts of a WebCTRL system an operator can access. Privileges also control
what an operator can do and what he can change.
To set up operator access to your system:
1 Log in to the WebCTRL application as the Administrator. See Operators and operator groups
(page 129).
2 Define privilege sets by job function. See Privilege sets (page 125).
3 Enter each operator in the system by assigning him privilege sets and entering settings that apply
only to him. If you need to assign the same privilege set to multiple operators, you can create an
operator group and assign the privilege set to the group. See Operators and operator groups (page
129).
An operator can change many of his operator settings on the My Settings page (page 131).
To access the WebCTRL interface, an operator must enter his user name and password. This
password requirement can be enhanced by using the advanced password policy (page 137) (available
with the optional Advanced Security package).

Restricting operator access

To restrict access to your system, you can:

Restrict an operator's privileges

Use location-dependent operator access (page 133) (available with the optional Advanced
Security package)

Change a microblock's Editing Privilege from Preset to a specific privilege. The microblock's
properties will be editable only by an operator that has that privilege.
CAUTION Each microblock property has a default Editing Privilege (represented by the Preset
option) that is appropriate for that property. Changing Preset to a specific privilege changes every
property in the microblock to the same privilege which may produce undesirable results.

Privilege sets
A privilege set is a group of one or more privileges (page 126). The Administrator creates privilege sets
and assigns them to operators and operator groups.

2012 Automated Logic Corporation

125

WebCTRL v5.5 User Manual

Privileges
This privilege...

allows an operator to...

System Administration Privilege

Add, edit, and delete operators, operator groups, and privilege

sets.

Update the WebCTRL system with service packs and

patches.

Register the WebCTRL software. See To register your

WebCTRL software (page 167).

Enable and set up advanced security features (page 133)

(optional package) such as location-dependent operator
access and a configurable password policy.

Add and remove WebCTRL web applications such as

EnergyReports.

This Access privilege...

allows an operator to access (but not edit)...

Access Geographic Locations

pages from the GEO tree.

Access Network Items

pages from the NET tree.

Access Groups

pages from the GRP tree.

Access Config Items

pages from the CFG tree.

Access Alarms

alarms.

Access Logic Pages

logic pages.

Access User Category 1-5

anything in a category that has the same privilege assigned to it.

See "To create a custom privilege" below.

This Parameter privilege...

allows an operator to edit properties such as...

Edit Setpoint Parameters

occupied and unoccupied heating and cooling setpoints.

Edit Setpoint Tuning Parameters

demand level setpoint offsets, thermographic color band offsets,

heating and cooling capacities and design temperatures, color
hysteresis, and learning adaptive optimal start capacity
adjustment values.

Edit Tuning and Logic

Parameters

gains, limits, trip points, hysteresis, color bandwidths, design

temperatures, and optimal start/stop.

Edit Manual Override Parameters locks on input, output, and network points.

126

Edit Point Setup Parameters

point number, type, range, and network source and destination.

Edit Restricted Parameters

properties the installer restricted with this privilege.

Edit Category Assignments

Alarm, Graphic, Trend, and Report category assignments.

Edit History Value Reset

elapsed active time and history resets, and runtime hours.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

This Parameter privilege...

allows an operator to edit properties such as...

Edit Trend Parameters

enable trend logging, log intervals, and log start/stop times.

Edit Calibration Parameters

point calibration offsets.

Edit Hardware Controller

Parameters

driver properties.

Edit Critical Configuration

critical properties the installer protected with this privilege.

Edit Area Name

area display names.

Edit Control Program Name

control program display names.

Edit Alarm Configuration

enabling/disabling alarms and editing alarm messages, actions,

categories, and templates.

InterOp Privilege 1 - 10

those protected by password levels 1-10 in SuperVision.

This Functional privilege...

allows an operator to...

Manage Alarm Messages

and Actions

add, edit, and delete alarm messages and actions.

Maintain System Parameters

edit all properties on the System Settings page.

Maintain Schedules

add, edit, delete, and download schedules.

Maintain Schedule Group

Members

add, edit, and delete schedule groups.

Maintain Categories

add, edit, and delete categories.

Maintain Trends Display and

Print Setup

edit Trends Display Setup and Trends Print Setup on the CFG tree.

Maintain Alarm Templates

edit Alarm Template and Reporting Action Templates.

Acknowledge Non-Critical Alarms

acknowledge all non-critical alarms.

Acknowledge Critical Alarms

acknowledge all critical alarms.

Force Normal Non-Critical Alarms force non-critical alarms to return to normal.

Force Normal Critical Alarms

force critical alarms to return to normal.

Delete Non-Critical Alarms

delete non-critical alarms.

Delete Critical Alarms

delete critical alarms.

Execute Audit Log Report

run the Location Audit Log and System Audit Log reports.

Download Controllers

mark equipment for download and initiate a download.

System Shutdown

issue the Shutdown manual command that shuts down the

WebCTRL Server application.

Engineer System

2012 Automated Logic Corporation

log in and make database changes in SiteBuilder.

use the copy, notify, reload, and revert manual commands.
access the Configure and Set up Tree right-click menus in the
WebCTRL interface.
Add text in the Notes field on an equipment's Properties page.

127

WebCTRL v5.5 User Manual

This Functional privilege...

allows an operator to...

Access Commissioning Tools

access:

Equipment Checkout
Airflow Configuration
Trend, Report, and Graphic categories that require this
privilege
Discovery tool

Maintain Graphs and Reports

add, edit, and delete trend graphs and reports.

Maintain Connections

edit Connections page properties.

Remote File Management

access files using a WebDAV utility.

Remote Data Access-SOAP

retrieve WebCTRL data through an Enterprise Data Exchange

(SOAP) application.

Do not audit changes made

using SOAP (Web services)

not have his SOAP (Web services) changes recorded in the Audit
Log.

Manual Commands/Console
Operations

access the manual command dialog box and issue basic manual
commands.

Manual Commands/File IO

execute manual commands that access the server's file system.

Manual Commands/Adv Network execute manual commands that directly access network
communications.
Manual Commands/Unrestricted

execute manual commands that bypass all safeguards and may

cause unpredictable results if used incorrectly.

To create a custom privilege

You can assign a privilege to a Graphic, Property, Trend, or Report category so that only operators with
that privilege can access the category. You assign a category privilege on the page where you create or
edit categories.
If all the other privileges are too widely used to accomplish the results you want, you can assign one of
the five Access User Category privileges to the operator(s) and category.
For example, your system has 2 graphics categories, HVAC and Lighting/Security. You want HVAC
technicians to see only the HVAC graphics and security personnel to see only the Lighting/Security
graphics. To do this:

128

Assign...

To...

Results

Access User
Category 1

HVAC graphics category

and
HVAC technicians only

The security personnel cannot see the HVAC

graphics because they do not have Access User
Category 1.

Access User
Category 2

Lighting/Security Graphics
category
and
Security personnel only

The HVAC technicians cannot see the

Lighting/Security graphics because they do not
have Access User Category 2.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

To add or edit a privilege set

1
2
3
4
5

On the CFG tree, select Privilege Sets.

Click Add to create a new privilege set, or select a privilege set to edit.
Type the Name and Reference Name for the privilege set.
Select the checkbox beside each privilege you want to include in the privilege set.
Click OK.

CAUTION Include all required access privileges in a privilege set. For example, if you add
Acknowledge Non-Critical Alarms to a privilege set, also add Access Alarms to that privilege set.
TIP To create a privilege set that is similar to an existing set, select the existing set, then click
Add. The privileges that are initially selected are identical to those of the existing set.

To delete a privilege set

1
2
3
4
5

On the CFG tree, select Privilege Sets.

Select the privilege set to be deleted.
Click Delete.
Click OK.
Click OK again.

Operators and operator groups

The Administrator (see "Default operators" below) sets up each operator in the WebCTRL interface by
entering the necessary settings and assigning one or more privilege sets to the operator.
Operator groups give you the ability to assign privilege sets to a group of operators instead of the
individual operators. Operator groups are useful if you have multiple operators who need the same
privilege set or you have positions with high turnover rates. You can assign an operator to a group
when you enter the operator or when you create the operator group.
NOTE When using hierarchical servers, you must create identical operators on each server in order to
navigate across servers.

Default operators
A WebCTRL system has the following default operators:
Operator...

Has ...

To log in...

Administrator

Almost all privileges

Type Administrator in the Name

field, then click Log in.

Anonymous

The Standard privilege set that

contains only viewing privileges

Click Log in.

To ensure system security, log in as the Administrator, then do one of the following:

Assign the Admin privilege set to another operator, then delete the Administrator operator
Assign a password to the Administrator operator.

2012 Automated Logic Corporation

129

WebCTRL v5.5 User Manual

CAUTION Passwords can be forgotten. To ensure access to the WebCTRL administrative

functions, assign the Admin privilege set to at least 2 operators.
If you want to prevent Anonymous access to your system, delete the Anonymous operator.

To add or edit an operator

1
2
3
4

On the CFG tree, select Operators.

Click Add to enter a new operator, or select an operator to edit his settings.
Enter information on this page as needed. The only required fields are Name and Login Name.
See table below.
Click OK.

Field

Notes

Login Name

The name the operator must type to log in to the system. This name must be
unique within the system.

Change password

Enable this field, then type the current and new passwords.
NOTE An operator can change his password on the My Settings page (page
131).

Force User to
Change Password at
login?

Forces the operator to change his password immediately after his next login.
NOTE Use this field with the Change Password field to create a temporary
password that the operator must change after his next login.

Exempt From
Password Policy

If the advanced password policy is enabled in System Settings on the Security

tab (page 160), select this option if you do not want the policy to apply to this
operator.

Logoff options

If the automatic logoff feature is enabled in System Settings on the Security

tab (page 160), select one of the 3 logoff options.

Personal Information You can enter contact information for this operator.
NOTE An operator can enter contact information on the My Settings page
(page 131).

130

Starting Location
and
Starting Page

The WebCTRL location and page that will be displayed after the operator
logs in.

System-wide
Privilege Sets

To assign a privilege set to the operator, select the privilege set's checkbox.
NOTES

Click Show current privileges only to see only the selected privilege sets.

A grayed out privilege set with a group name beside it indicates the
operator is inheriting that privilege set from the group.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

To delete an operator
1
2
3
4

On the CFG tree, select Operators.

Select the operator.
Click Delete.
Click OK.

To add or edit an operator group

1
2
3
4
5
6

On the CFG tree, select Operator Groups.

Click Add to create a new operator group, or select an operator group to edit it.
Type the Display Name and Reference Name for the operator group.
Under Members, select the operators and/or groups that you want to add to the new group.
Under Privilege Sets, select the privilege sets that you want to assign to the new group.
Click OK.

TIP Every operator is automatically a member of a permanent default group called Everybody. You
can assign privilege sets to this group.

To delete an operator group

1
2
3
4

On the CFG tree, select Operator Groups.

Select the operator group.
Click Delete.
Click OK.

CAUTION When you delete an operator group, its individual members lose the privilege sets that
were assigned to the group.

To change My Settings
On the My Settings page, you can change settings, such as your:

Password
Viewing preferences
Contact information

NOTE The System Administrator can also change these settings on the Operators page.
To change your settings:
1 On the CFG tree, select My Settings.
2 Make changes on the Settings or Contact Info tab. See table below.
3 Click OK.

2012 Automated Logic Corporation

131

WebCTRL v5.5 User Manual

132

Field

Notes

Change password

Enable this field, then type your current and new passwords.

Starting Location and

Starting Page

The WebCTRL location and page that will be displayed after you log in.

Language

The language and formatting conventions you want to see in the

WebCTRL interface.
NOTES

If you will be using a language other than English, see Setting up

your system for non-English languages (page 178) for additional
requirements.

If support for your selected language is removed in SiteBuilder, the

WebCTRL application will automatically assign the System
language to you.

Automatically collapse
trees

Expands only one tree branch at a time.

Play sound at browser

when server receives

Select the Non-critical alarms or Critical alarms checkbox if you want

the system to audibly notify you when that type of alarm is received.
If you want to use a custom sound file (.au or .wav):
1 Put the file in the webroot\_common\lvl5\sounds folder.
2 In the Sound File field, replace warning_bell.au or critical_bell.au
with the name of your sound file.
NOTE You can put your sound file anywhere under the WebCTRLx.x
folder, but be sure to change the path in the Sound File field.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Chapter 12
Advanced security
Location-dependent operator access
NOTE To see if your system has this optional package, click
package if Enabled Features shows Adv. Security.

, then select About. You have this

With the Advanced Security package, you can set up operator access to your system to be
location-dependent. This type of operator access lets you assign privileges to an operator only at
locations in the system where he needs them. For example, you could assign an operator mechanic
privileges in one building in a system, view-only privileges in another building, and no privileges in a
third building.
New and converted WebCTRL systems default to location-independent operator access in which an
operators privileges apply throughout the system. You should understand this type of operator access
before switching to location-dependent. See Operator access (page 125) for more information on
location-independent operator access.
NOTE When using hierarchical servers, the security policy and privilege sets are local to each server,
so you can have location independent security on one server but not on another.

To switch to location-dependent access

CAUTIONS

Create a backup of your system before you begin. Switching to location-dependent operator
access changes the configuration of operators and privilege sets. If you need to revert to
location-independent operator access, your previous configuration cannot be automatically
restored.

If you change the policy after you create and assign privilege sets to operators, you may need to
reconfigure your operators privileges.

To switch to location-dependent operator access:

1 On the CFG tree, select System Settings.
2 Select the Security tab.
3 Click Change Policy.
4 Follow the on-screen instructions.

2012 Automated Logic Corporation

133

WebCTRL v5.5 User Manual

Privileges and privilege sets

When using location-dependent operator access, privileges are either system-wide or local.
System-wide privileges allow an operator to perform functions throughout the entire system, such as
accessing the Configuration tree or performing a system shutdown.
Local privileges allow an operator to perform functions in a specific area of the system, such as editing
setpoints or viewing alarms. Assigning any local privilege to an operator also allows him to change his
password and set preferences on the My Settings page on the CFG tree.
You assign system-wide privileges to system-wide privilege sets and local privileges to local privilege
sets. Use the following table in planning which privileges to assign to a privilege set. For a description
of each privilege, see Privileges (page 126).
System-wide privileges

Local privileges

Access Groups
Access Config Items
Maintain System Parameters
Maintain Schedule Group Members
Maintain Categories
Maintain Trends Display and Print Setup
Maintain Alarm Templates
Acknowledge Non-Critical Alarms
Acknowledge Critical Alarms
Force Normal Non-Critical Alarms
Force Normal Critical Alarms
Delete Non-Critical Alarms
Delete Critical Alarms
Execute Audit Log Report
Download Controllers
System Shutdown
Engineer System
Access Commissioning Tools
Maintain Graphs and Reports
Maintain Connections
Remote File Management
Remote Data Access-SOAP
Do not audit changes made using SOAP (Web services)
Manual Commands/Console Operations
Manual Commands/File IO
Manual Commands/Adv Network
Manual Commands/Unrestricted

Access Geographic Locations

Access Network Items
Access Alarms
Access Logic Pages
Access User Category 1 - 5
Edit Setpoint Parameters
Edit Setpoint Tuning Parameters
Edit Tuning and Logic Parameters
Edit Manual Override Parameters
Edit Point Setup Parameters
Edit Restricted Parameters
Edit Category Assignments
Edit History Value Reset
Edit Trend Parameters
Edit Calibration Parameters
Edit Hardware Controller Parameters
Edit Critical Configuration
Edit Area Name
Edit Control Program Name
Edit Alarm Configuration
InterOp Privilege 1 - 10
Manage Alarm Messages and Actions
Maintain Schedules

NOTES

134

For an operator to add, edit, or delete schedule groups, he must have the system-wide privilege
Maintain Schedule Group Members. He must also have the local privileges Access Geographic
Locations and Maintain Schedules at each location that is a member of the schedule group.

If you switch to location-dependent operator access in a system that has operators and privileges
set up, the WebCTRL application splits any existing privilege set containing local and
system-wide privileges into 2 separate privilege sets - one local and one system-wide. Operators
system-wide privilege sets still apply throughout the system. The operators local privilege sets are
automatically assigned at the system level. You can then reassign the local privilege sets to the
operators at the locations where they need them.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

To add a privilege set

Adding a privilege set using location-dependent operator access is the same as using
location-independent operator access except that you must select whether you are adding a
system-wide or local privilege set. See Privilege sets (page 125).

To assign privilege sets to an operator

Assign a system-wide privilege set to an operator on the Operators page in the same way you would
assign privilege sets in a system using location-independent operator access. See Operators and
Operator Groups (page 129).
Assign a local privilege set to an operator at locations on the GEO or NET tree where he needs the
privileges.
1 Select a location on the GEO or NET tree.
2 Click Privileges.
3 Click Add.
4 Select the operator or operator group.
5 Click OK.
6 Select the privilege set(s) that you want the operator to have.
7 Click OK.
NOTE You can display icons and hover text in the GEO tree that show where privileges have been
assigned. See Tree icons and hover text (page 25).

To delete a local privilege set assignment

1
2
3
4
5

On the GEO or NET tree, select the location where the assignment was made.
Click Privileges.
Select the assignment under Privilege Set Assignments at this Level.
Click Delete.
Click OK.

Restricting access in the system

Restricting an operators access to areas of the system
You can give an operator access to only a specific area of the system. All other areas will be either
grayed out or not visible when the operator logs in to the WebCTRL interface.
EXAMPLE If you give an operator the Access Geographic Locations privilege only at the first floor of the
system shown below, he will see a navigation tree like the one on the left. The areas above the first
floor are visible because he needs them to navigate to the first floor, but grayed out because he
cannot access them. The operator does not see Dallas, New York, or San Francisco because he cant
access them and does not need them to navigate.

2012 Automated Logic Corporation

135

WebCTRL v5.5 User Manual

Restricted access

Full system

Restricting all operator access to a location

To remove all operators local privileges from a location so that you can assign access only to a specific
operator(s), navigate to the location, select Privileges, then clear the checkbox Inherit security
privileges from above this level.

Security Assignments Report

A Security Assignments Report shows an operators local and system-wide privileges and privilege sets
at a specific location.
1 Select the location on the GEO or NET tree.
2 Click the Reports button drop-down arrow, then select Security > Security Assignments.
3 On the Options tab, select an operator.
4 Click Run.

Recording reasons for edits (21 CFR Part 11)

NOTE To see if your system has this optional package, click
package if Enabled Features shows Adv. Security.

, then select About. You have this

The Advanced Security package provides support for 21 CFR Part 11. With this feature enabled, the
WebCTRL application can require an operator to record a reason for changing an equipment property
before it accepts the change. The WebCTRL Audit Log report then displays the operator's name and
the recorded reason for making the change.
NOTE You cannot use WAP-enabled devices to change equipment that requires operators to log
changes.

136

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

To set up equipment to require reasons for changes

1 In the WebCTRL GEO or NET tree, right-click the equipment, then select Configure.
2 Select the Require operator to record any changes to equipment checkbox.
3 Click OK or Apply.
NOTE You can also turn this setting on in SiteBuilder in the equipment's properties dialog box.

To view reasons for changing equipment properties

1
2
3
4

In the WebCTRL tree, select a piece of equipment that requires reasons for change.
Click the Reports button drop-down arrow, select Security > Audit Log.
On the Options tab under Display the following columns, select the Reason checkbox.
Click Run.

Advanced password policy

NOTE To see if your system has this optional package, click
package if Enabled Features shows Adv. Security.

, then select About. You have this

With the Advanced Security package, you can set up a WebCTRL password policy to meet your
security needs.
1 On the CFG tree, select System Settings.
2 Select the Security tab.
3 Enter information in the fields described below.
NOTE See System Settings (page 159) for information on all the other fields.
Field

Notes

Use advanced password policy

Enable this field to put restrictions on passwords.

An operators login name and password must be different when
this policy is enabled.
After you change the password policy, any operator whose
password doesn't meet the new requirements will not be locked
out of the system, but will be prompted to create a new password.

Passwords must contain

You can require that passwords contain any or all of the following:
Numbers
Special charactersany keyboard character that is not a number
or letter.
Lettersuppercase, lowercase, or both.

Cannot be changed more than

once every __ days.

Enter a number to limit how often users can change their

passwords. When set to 0, users can change them as often as
they want.

2012 Automated Logic Corporation

137

WebCTRL v5.5 User Manual

138

Field

Notes

May not be reused until __

different passwords are used.

Enter a number between 1 and 20. Enter 0 to reuse passwords

without a delay.

Expire after __ days

Enable to set the number of days an operator can use his

password before the system requires him to change it. Enter a
number between 1 and 999.

Force expiration

Click this button to force every user's password to expire. Each

user will be prompted to change their password when they next
attempt to log in to the WebCTRL interface.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Chapter 13
Cost-saving strategies
HVAC equipment runs in order to maintain adequate temperature for zones. Some zones, like
classrooms, must maintain a comfortable temperature only while people occupy them. When a zone is
no longer occupied, you can define different setpoints that require less energy to maintain. Use
WebCTRL Schedules for these occupied/unoccupied zones so that equipment runs only as needed
to reduce energy consumption, but not comfort.
Other zones, like computer server rooms and production floors, must maintain particular cooling and
heating setpoints 24 hours a day, 7 days a week. Schedules would have no cost-saving effect on them.
Use one of the other cost-saving strategies to reduce energy consumption and equipment repairs for
these kinds of zones.
You can realize the greatest savings by using Schedules. Then fine tune Optimal Start, Demand
Control, and Setpoint Optimization. Each strategy depends on a particular microblock.
Microblock

Strategy

Description

Schedules
(page 57)

Define when a building or zone is occupied and

whether or not equipment should run, depending on
the occupied setpoints.

Optimal Start
(page 52)

Ensures that a zones ideal comfort range is reached

just as the zone becomes occupied.

Demand Control
(page 55)

Relaxes heating or cooling setpoints when a certain

level of energy use is reached in order to avoid peak
demand, ratchet, or time of use electric charges.

Setpoint
Optimization
(Trim and Respond)

Calculates a piece of equipments setpoint based on

the number of heating or cooling requests it receives
from other equipment.

2012 Automated Logic Corporation

139

WebCTRL v5.5 User Manual

Advanced topics and features

140

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Chapter 14
Manual commands
To run a manual command:
1
2

Click the menu button

, then select Manual Command.
Type the manual command in the dialog box, then click OK.
TIP Ctrl+M also opens the dialog box.

You must have the Manual Commands/Console Operations privilege to access the manual commands
dialog box. The descriptions below tell you if you need an additional privilege to run the corresponding
command.
Command

Description

addon

Opens a dialog box where you can upload, start, stop, or remove an
add-on program such as Tenant Override Billing.

arcnet

Run this command each time you plug a device, such as a laptop,
into a controller using an ARCNET card. The arcnet command
configures the WebCTRL application to recognize your device as
the WebCTRL server. Run this command from the equipment,
controller, or network level on the NET tree.

autopilot location

Displays the full path for the current location and copies the path to
the Windows clipboard. You can then paste the path into the
autopilot.xml file that runs the WebCTRL autopilot. See Running
the WebCTRL autopilot (page 148).

bbmd commands:

You must have the Manual Commands/Adv Network privilege to run

bbmd commands.

bbmd read <IP address>

Reads the BBMD table of the controller at the given IP address.

For example, to display the BBMD table in the BACnet device router
at IP address 154.16.12.101, type:
bbmd read 154.16.12.101

bbmd update <network

number>

Selects BBMDs on the specified network and marks them for

download. If no network is entered at the end of the command, all
networks in the system are scanned.
For example, if the network number is 888, type:
bbmd update 888

2012 Automated Logic Corporation

141

WebCTRL v5.5 User Manual

Command

Description

bbmd view <network

number>

Views the list of BBMDs that have been selected for the network
number at the end of the command. Assumes the update has been
run.
For example:
bbmd view 888

bbmd write <table file> <IP

address>

Writes the BBMD table into the controller at the given IP address.
See To set up BBMD's through the WebCTRL interface.
For example, to write the BBMD table in dallasbbmd.bdt into the
BACnet device router at IP address 154.16.12.101, type:
bbmd write dallasbbmd.bdt 154.16.12.101

bbmd clear <IP address>

Clears the BBMD for the specified controller.

For example:
bbmd clear 154.16.12.101

bbmd dump <network>

<file>

Writes to a file the BBMD from the specified controller.

For example:
bbmd dump 888 dallasbbmd.bdt

checkurls

1
2
3
4

142

Finds all network point exp: expressions for the selected item in
the GEO or NET tree.
Converts the exp: expressions to bacnet:// equivalent
expressions that the controllers use.
Compares the equivalent bacnet:// expressions to the bacnet://
expressions currently downloaded in the controllers.
Displays any mismatches.

checkurls -p

Does the same as checkurls, then adds any mismatches to the

download queue as parameter downloads.

checkurls -v

Does the same as checkurls, but displays the exp: and bacnet://
expressions for all network points that were checked.

commstat

Gives a complete set of diagnostic information for all defined

connections as well as information regarding all modems in the
system.

copy

Displays a global copy utility that allows you to selectively copy trend
graphs, custom reports and all editable properties from the selected
equipment to other equipment in the system with the same control
program. See To use Global Copy (page 45).

disconnect

Disconnects you from a BACnet dial-up session if you are the last
active operator.

download commands:

Each of these commands performs an immediate download to a

controller for the selected control program, device, or driver.

download m

Downloads all content, including parameters, schedules, and

BBMDs (if applicable).

download p

Downloads parameters only.

download s

Downloads schedules only.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Command

Description

go commands:
go <refname or path>

Goes to the point in the system that is referenced.

For example:
go #oa_conditions
or
go vav_1/m28

go ~net

Takes you from a piece of equipment on the GEO tree to the same
equipment on the NET tree.

go ~geo

Takes you from a piece of equipment on the NET tree to the same
equipment on the GEO tree.

go ~device

Takes you to the controller for a point or piece of equipment on the

NET tree.

go ~network

Takes you to the network the selected objects controller is

associated to.

go -logicpopup <refname>

Goes to the microblock pop-up for the microblock that is referenced.

You must run this command from the microblocks equipment in the
navigation tree.
For example:
go -logicpopup lstat

go <device ID>

Goes to a device in the NET tree.

For example, to go to device 301205 referenced in a dead module
alarm, type:
go 301205

go <device ID>/<object
ID>

Goes to a device and object in the GEO or NET tree.

For example:
go 300550/AI:3

go <object ID>

Goes to an object for the current device in the GEO or NET tree.
For example, if a module alarm reports a control program Locked
I/O Alarm and references an error in program 11, click the link to go
to the device, then go to the object by typing:
go PRG:11

go <s.g.m.p>

(site, gateway, controller, program) Goes to the item that the s.g.m.p
address references. Use this command for legacy equipment only.
For example:
go 2,1,4,1

localhost

Shows the IP address of the WebCTRL server

logoffuser

Logs off a user (without warning the user).

Type a whoson manual command to view the IDs of logged in
operators, then type logoffuser x, where x is a the user's ID.

2012 Automated Logic Corporation

143

WebCTRL v5.5 User Manual

Command

Description

markdownload commands:

These commands place the controller for the selected tree item on
the list to download at a later time. The download list can be viewed
at NET > Downloads.

markdownload

Marks for an All Content download, that includes parameters,

schedules, and BBMDs (if applicable).

markdownload p

Marks for a Parameters download.

markdownload s

Marks for a Schedules download.

memory

Shows the amount of server memory allocated for the WebCTRL

application and the amount being used.

memory -free

Releases unused server memory, then shows the WebCTRL

memory usage before and after the release.

modstat commands:

These commands display a Modstat report.

NOTE It is not necessary to download a controller before running a
Modstat on it. Binding takes place when you run the modstat.

modstat

Hardware components of the device

Software components of the device

Error conditions that may exist in the device

Date and time the device is using

modstat 8:<device instance

number>

Displays status for a specific controller in the IP network using the

controllers ID. Your location in the system does not have to be the
controller you are querying.
For example:
modstat 8:489202

modstat mac:<network
number>,<media type>:
<mac address>

Displays a Modstat for a specific controller in the system using the

controllers MAC address. Network number is the number of the
network this controller is on as specified in SiteBuilder; media type
is the type of network the controller is on; MAC address can be
either the controller address or the IP address and depends on the
controllers media type.
For example:
modstat mac:48161,arcnet:2
or
modstat mac:888,bacnet/ip: 172.16.101.119

notify

144

Displays status of the controller at the current location, including:

Sends a message to all operators currently logged in to the system.

For example, "The server is going to shut down in 5 minutes. Please
log off." To run this command, type: notify your message.
The message must use only alphanumeric characters. You must
have the Admin privilege set or the Engineer System privilege to run
this command.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Command

Description

paramupload

Uploads parameters (editable properties) to the WebCTRL

application from the equipment or driver at the current location and
below. If you want to upload editable properties for all equipment on
a floor, navigate to the floor level on the GEO tree. If you want to do
this for everything under a particular router, navigate to the router or
the network on the NET tree. You must have the Manual
Commands/Adv Network privilege to run this command.

ping

Ping to verify communication between to IP devices. You cannot

ping devices on non-IP networks. To run this command type: ping
<hostname> where <hostname> is the IP address or device name.
For example:
ping 192.168.168.1
(will ping the IP address 4 times)
or
ping 192.168.168.1 -t
(will ping the IP address constantly)

rebootserver

Restarts the WebCTRL Server application. You must log back in to

the WebCTRL interface if you want to continue. You must have the
System Shutdown privilege to run this command.

rebuild

Rebuilds a Properties page. Use if you make changes to control

program property text in the EIKON LogicBuilder application.

reload

Reloads a control program. Use if you make changes to control

program logic in the EIKON LogicBuilder application. You must
have the Engineer System privilege to run this command.

restartmodule

Restarts the current controller. You must have the Manual

Commands/Adv Network privilege to run this command.

rnet here

Overrides the address configuration of the Rnet host controller to

allow a subsequent All Content or Parameters download. Run this
command if you experience communication problems with the
controller because the controllers network number does not agree
with SiteBuilders network number. Run this command from a
control program, device or driver.

revert

Resets the selected driver or control program to its default values.

setdefault

Sets the current page as the default view for the selected action
button and the selected tree location. You must have the Engineer
System privilege to run this command.

2012 Automated Logic Corporation

145

WebCTRL v5.5 User Manual

Command

Description

setgcm

Initializes any LANgate (gateway) from a converted SuperVision

system.
After downloading to the LANgate, run setgcm if you:

Added a controller to a CMnet where the address is set higher

than any other address on the CMnet

Changed the 3-letter system name

Changed the dead module timeout value on the System Settings

page

Changed the site number in SiteBuilder (previously referred to

as the line number)
setgcm sends the following information from the WebCTRL
database to the LANgate:

Maxnet (the highest addressed controller plus one)

3-letter system name

Site number

Dead module timeout value

NOTES

146

You can send this command over network, direct or modem

connections, but not over a direct network (access port).

In SuperVision, the command set the workstation phone number

in the LANgate. You must now type the LANgates phone
numbers on the LANgates parameter pages.

You must have the Manual Commands/Adv Network privilege to

run this command.

showhistory

Gives historical information on the system, such as when it was

created and updated. You must have the Manual
Commands/Unrestricted privilege to run this command.

shutdown

Shuts down the WebCTRL Server application. This stops

communication between the server and the client, but does not
close any open WebCTRL pages. You must have the System
Shutdown privilege to run this command.

storetrends

Uploads trend data from the controller(s) to the database for all
equipment at and below the selected item on the GEO tree. This
command stores trend data for points that have Trend Historian
enabled.

timesync

Synchronizes the time on all controllers at the current location and

below to the time on the server. Run this command only from a
location in the NET tree.
NOTE For CMnet networks, executing a timesync on a controller
sends the timesync to its gateway, and all the controllers under that
gateway.
You must have the Manual Commands/Adv Network privilege to run
this command.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Command

Description

updatedriver commands:

You must have the Engineer System privilege to run updatedriver

commands.

updatedriver

Updates the selected controller to the latest version of its driver.

updatedriver net

Updates the selected controller to the latest version of its driver and
any other controllers on the same network that use that driver.

updatedriver all

Updates the selected controller to the latest version of its driver and
all other controllers in the system that use that driver.

whereami

Displays the full path for the current location and gives the display
and reference names of the action button, category, instance and
tab. If the selected tree location differs from the location shown in
the action pane (for example, a point trend page), whereami returns
information on both locations.
Use this command when you create links in ViewBuilder.

whoson

Shows the list of users currently logged in to the WebCTRL system,

the IP addresses from where they are logged on, what kind of
interface they are using (for example, lvl5 for an Internet browser on
a computer), and how long it has been since they have actively
interfaced with the WebCTRL system.

zap

Restarts the current controller. You must have the Manual

Commands/Adv Network privilege to run this command.

2012 Automated Logic Corporation

147

WebCTRL v5.5 User Manual

Chapter 15
Running the WebCTRL autopilot
To monitor your WebCTRL system, you can run the autopilot to display specified WebCTRL pages at
regular intervals. You can run the autopilot on the WebCTRL server or on one or more client
computers. Each computer can display a different set of pages.

To set up the WebCTRL autopilot

1
2

Copy the WebCTRLx.x\autopilot folder from the WebCTRL system to any location on the
computer where you will be running the autopilot.
In a text editor such as Windows Notepad, open the autopilot.xml file in the new folder you
created in step 1.
CAUTION Do not open or edit the original autopilot.xml file in the WebCTRL system. Keep
this file to set up the autopilot on other computers.
In the row that begins with <script, replace the highlighted text shown below with the information
needed to start your system.

NOTES

The Attribute list near the top of the file describes each field.

To prevent exposing someone's password in this file, create a generic user and password in
the WebCTRL interface.
4

Each pair of rows beginning with <navigate and <delay define a WebCTRL page and how many
seconds the page should display. Follow the steps below to replace each <navigate line with
information specific to your system. Add or delete rows as needed.
a) In the WebCTRL interface, go to the page you want to display.
b) Press Ctrl+M.
c) Type autopilot location.
d) Click OK. The path to the WebCTRL page is displayed and is copied to the Windows
clipboard.
e) In the autopilot.xml file, highlight a <navigate row, then press Ctrl+V to replace the highlighted
text with the copied WebCTRL path.
NOTE To have the autopilot run a report, define the path to the report's View tab.

148

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

5
6

In the <delay row below each path, change 20 to the number of seconds you want to display the
WebCTRL page.
Save the file.

To run the WebCTRL autopilot

NOTE If your computer is running Windows Vista, see To run autopilot with Windows Vista (page 149)
before starting the autopilot.
1
2

Start the WebCTRL Server application.

Run the autopilot.bat file that you created in step 1 of To set up the WebCTRL autopilot (page
148).

NOTES

To stop the autopilot, do one of the following:

Close the browser.

Close the Command Prompt window that is running the autopilot.bat file to stop the autopilot
but leave the WebCTRL interface running in the browser.

If the autopilot does not start, open autopilot.log to see the error.

To run autopilot with Windows Vista

To run the autopilot with the Windows Vista operating system, you must add the WebCTRL URL to
Internet Explorer's trusted sites.
1 In Internet Explorer, select Tools > Internet Options.
2 On the Security tab, select the Trusted Sites icon, then click the Sites button.
3 Under Add this Web site to the zone, type the url that autopilot uses to start your system. See step
3 in To set up the WebCTRL autopilot (page 148).
4 Clear the checkbox beside Require server verification (https:) for all sites in this zone.
5 Click Add.
6 Click OK to close both windows.
7 Close Internet Explorer to have the changes take effect.

2012 Automated Logic Corporation

149

WebCTRL v5.5 User Manual

Chapter 16
Managing files on a remote WebCTRL server
A WebCTRL system supports WebDAV, a network protocol designed for managing remote server files
through an Internet connection. By using WebDAV, you can access the Internet from anywhere in the
world and manage your system files residing on a distant WebCTRL server.

Methods for using WebDAV

A third-party WebDAV client application such as WebDrive allows you to open remote files in
addition to managing them.

Perform remote file management:

With Internet Explorer by opening the remote system as a web folder.

With Microsoft Windows file explorer by adding a network connection in file explorer.
NOTE These functions may not be available on all versions or combinations of Windows operating
systems or Internet Explorer.

To use WebDAV with Internet Explorer

PREREQUISITES
On your client computer, you must:

Be running a WebCTRL v2.0 or later system on the WebCTRL server.

NOTE Your WebCTRL system must be running on the remote server for WebDAV to work; you
can then access the webroot folder for the system. You cannot edit the WebCTRL database when
using WebDAV.

On the WebCTRL Systems Settings page Security tab, enable Remote File Management.

Have Remote File Management privilege assigned in your privilege set.

Have a password for the person logging in; the password field cannot be empty.

To use WebDAV from a client computer:

1 On the Internet Explorer menu bar, select File > Open.
2 In the Open dialog box, select Open as Web Folder.
3 In the Open field, type the IP address of your WebCTRL server/webdav. For example:
http://172.16.2.163/webdav.
NOTE On a Windows XP machine, you may need to include the HTTP port number in your URL. For
example: http://172.16.2.163:80/webdav.
150

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Type your WebCTRL user name and your password.

NOTES

The user name must not end with a space when using WebDAV.

The password field must contain a valid password, must not contain a space, and must not be
blank.
Browse to Web Folders to remotely view and manage your WebCTRL files.

2012 Automated Logic Corporation

151

WebCTRL v5.5 User Manual

Chapter 17
Using wireless devices with a WebCTRL system
The WebCTRL system supports Wireless Application Protocol (WAP), a communications protocol that
allows you to access your system through a wireless device, such as a mobile phone. The WebCTRL
application supports WAP-enabled browsers on 2G and 3G devices on the Sprint PCS network and
Pocket Internet Explorer on devices running Windows Mobile for Pocket PC 2003 or later.
Using a WAP device, you can access the Internet and remotely manage certain aspects of your system.
Only English alphanumeric characters are supported.
NOTES

Navigation buttons and how the information is presented varies among WAP devices.

To use WAP through a Secure Sockets Layer (SSL), you must use a certificate from a trusted
Certificate Authority (CA). Ask your phone company which Certificate Authorities they support. See
"To set up TLS/SSL using a self-signed certificate" in WebCTRL Help.

Supported WebCTRL features

The WAP interface supports the following WebCTRL features. You can:
Navigate through the GEO tree.
View and manage Alarms for the current location.
Receive an e-mail alarm message.
View and edit abbreviated Properties pages for areas and equipment.
View and edit abbreviated Properties pages for microblocks.
You cannot:

View and manage Schedules.

View and edit items under the CFG tree.
Configure and view Reports.
View Graphics pages.
Send manual commands.

To dial up a System using WAP

Dialing up a WebCTRL system using a WAP device differs from dialing a telephone number. Each
service has a slightly different method. The following method for connecting to a WebCTRL server
using WAP is similar to the Sprint PCS Wireless mobile phone process.
1 Turn on the WAP device.
2 Select Wireless Web.

152

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

3
4
5
6

Select Launch Browser.

Select Menu.
You can also select WebCTRL bookmark if one has been saved.
Select Goto.
Tap in the WebCTRL IP address; for example, 192.168.168.1.
NOTE If you do not see the WebCTRL login, tap in the IP address again and do the following:
If your WAP device supports...

...append these characters to the end of the

address.

WML browsers.
Applies to most older (pre 3G) WAP devices.

?t=w

XHTMLMP browsers.
Applies to most newer (3G) WAP devices.

?t=xmp

XHTML browsers.
A text only interface for PC's or PDA's.

?t=X

EXAMPLE 192.168.168.1?t=xmp
Log in to your WebCTRL system:

Tap in your WebCTRL username, then select OK

Tap in your WebCTRL password, then select Login.

To navigate the System

Navigating through the WAP interface is the same as navigating through the WebCTRL GEO treethe
WAP screen is similar to the WebCTRL navigation pane.

2012 Automated Logic Corporation

153

WebCTRL v5.5 User Manual

The WebCTRL application automatically generates default WAP interface pages. However, you can
create custom pages using ViewBuilder for WAP.
After you log in, the first screen shows the system level. The name at the top of the screen is the name
of the current level. To navigate deeper into the system, select an item by either pressing its number
on the keypad or by scrolling through the list and then selecting OK. To navigate to other areas of the
system, see below.
Select

Action

1...

Navigate up one level.

Menu

Navigation

Return to the navigation tree (area and equipment level only).

Alarms

List the alarms at the current level (area and equipment level only).

Properties

Show properties at the point level

and show properties at the area and equipment levels if custom
pages have been attached.

Back

Return to the previous page.

Go to Root

Return to the top of the GEO tree.

Logout

Log out of the WebCTRL application.

To view and edit Alarms

1
2
3
4
5
6

154

Navigate to the area you want to view alarms for.

Select Menu.
Select Alarms to view all alarms at this area.
Select an alarm, then click OK to view or edit its details.
Select Actions to view a list of actions for the alarm.
Select the action to be done, then select OK.

Select

Action

1 List

List all alarms at the current area or equipment level.

2 Navigation

Return to the navigation tree.

3 Ack All

Acknowledge all alarms at the current level.

4 Del All Closed

Delete all closed alarms at the current level.

5 Del All

Delete all alarms at the current level.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

To view and edit equipment properties

NOTE If your WebCTRL system requires reasons for changes to equipment (page 136), you cannot
edit equipment properties using WAP.
1 Navigate to a point or BACnet object to view.
2 Edit any properties in brackets.
NOTE You may need to scroll down the screen to view them all.
For example, from the BACnet analog input point level, you can view the following:
Select

Action

Value

Present value for that point.

Lock

Locked override status for that point; True locks the present value to the At
value.

At

Locked override value.

Alarm

Alarm state for that point.

2012 Automated Logic Corporation

155

WebCTRL v5.5 User Manual

Chapter 18
Setting up a system in the WebCTRL interface

Editing the GEO or NET tree

In the WebCTRL interface, you can edit the GEO or NET tree that was originally set up in SiteBuilder.
The system database is updated immediately.
Right-click an item in the GEO tree, then select Set up Tree. Click GEO or NET to display the tree you
want to edit.
Click this
button...

Or use this
shortcut...

To...
Add an area as a child of the selected area. (GEO tree only)
Import a clipping that was saved in SiteBuilder. See To import a
clipping (page 157) below.

Ctrl+X

Cut a selected item so it can be pasted in another location in the

tree. (GEO tree only)

Ctrl+V

Paste an item that was previously cut from another location in the
tree. The item will be pasted as a child to the selected item. (GEO
tree only)

Up arrow,
or
Drag and drop in
new location

Move the selected item up the tree to a new location. (GEO tree
only)

Down arrow,
or
Drag and drop in
new location

Move the selected item down the tree to a new location. (GEO tree
only)

Rename the selected item.

Delete

156

Delete the selected item. The item and all of its children will be
deleted.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Click this
button...

Or use this
shortcut...
Double-click the
tree item

To...
Edit the item's features such as:

names

viewSee To attach a graphic in the WebCTRL interface (page

35)

control programSee Working with control programs in the

WebCTRL interface (page 170)

CAUTIONS

Make a backup of your system before making changes.

Make changes carefully as they cannot be undone.

NOTES

You can also right-click items in the Set up Tree dialog box to perform the above tasks.

You can perform some of the above actions on multiple tree items simultaneously. Use Ctrl+click,
Shift+click, or both to select multiple items.

To import a clipping
You can export a clipping (a portion of a system) in SiteBuilder and then import it in the WebCTRL
interface. The following items are imported:

One or more selected Geographic and Network tree items including attached control programs,
graphics, and drivers

Reports

Alarm templates and categories

Location-dependent security information

Schedules and schedule group membership (including the entire schedule group and schedules, if
it does not exist in the target system)

Alarm actions

Alarm message prefixes and suffixes

Source tree relationships (including source tree rules if the source tree does not exist in the target
system)

To import a clipping:
1 Right-click an item in the GEO tree, then select Set up Tree.
2
3
4
5
6
7

Click the Import clipping button

.
Browse to and select the clipping you want to import, then click Next.
Optional: If necessary, you can change the location path where the clipping will be imported.
Select the system fragment, then select the import location in the tree below.
Click Next.
If asked if you want to replace event templates, follow the on-screen instructions.
If asked if you want to overwrite components, follow the on-screen instructions.

2012 Automated Logic Corporation

157

WebCTRL v5.5 User Manual

The interface shows any conflicts and problems that were found during the import. Make any
needed corrections in SiteBuilder.
NOTE Click Copy to Clipboard and then paste the list into another program such as Notepad for
viewing or printing.
9 Click Next.
10 Click Finish.
11 Do any of the following that apply.
8

158

If you imported...

Do the following in the SiteBuilder

application...

Do the following in the

WebCTRL application...

Another site into the system

Change the new site's BACnet/IP

network number to be the same as
the other BACnet/IP network(s).

Download All Content to all

Automated Logic IP routers in
the system.

A second BACnet/IP network

into a site

Move the items under the new

network to the original BACnet/IP
network, then delete the new
network.

Download Parameters to any

controllers that you moved.

Any controllers that use the

SiteBuilder option
Automatically Configure My
BBMDs

N/A

Download BBMDs to the routers.

Any controllers that use

manually configured BBMD
tables

N/A

Update the routers' BBMD tables.

See "To set up BBMD's through
the WebCTRL interface" or "To
set up BBMD's using the BBMD
Configuration Tool" in WebCTRL
Help.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

System Settings
The System Settings page contains information that you must enter before the WebCTRL application
can run properly.
1 On the CFG tree, select System Settings.
2 Click each tab, then enter the necessary information. Tab details are described below.

General tab
The General tab presents the following system information:

System Directory Name

System Date and Time
Path to the Web Root Directory
Database Type

You can edit or use the following fields and buttons.

Field

Notes

Time Sync

Click to synchronize the time on all controllers in the system to the

time on the server.

Time Format

Select one of the following for the system's time:

12-hour clock (Example: 4:34 pm)
24-hour clock (Example: 16:34)

Date Format

Select the format you want the system to use.

Node Name Display Depth

The number of levels displayed in WebCTRL paths. For example,

if Node Name Display Depth is set at:
2, a typical path might be ..\AHU-1\RA Temp
3, a typical path might be ..\Atlanta R&D\First Floor\AHU-1
NOTE Changing this field does not take effect until you restart the
WebCTRL Server application.

System Language

The language to be used for:

The default language for new operators
Alarms logged to the database
State text and object names downloaded to the field
The login page
NOTE Language also refers to formatting conventions. For
example, English uses the date format mm/dd/yy, but English
(International) uses the date format (dd/mm/yy).

Use a single alarm template for

CMnet alarms

If your system is an upgraded legacy system, do one of the

following:

2012 Automated Logic Corporation

Select this checkbox to have alarms for CMnet equipment use

only the alert_auto alarm template.

Disable this checkbox to allow multiple alarm templates.

159

WebCTRL v5.5 User Manual

Field

Notes

All Source Files

Use to export source files to a .zip file that can be imported into
Field Assistant. If the technician using Field Assistant changes or
adds files, he can export them from Field Assistant so that they
can then be imported in the WebCTRL or SiteBuilder
applications. Source files include:
Control programs (.equipment files only)
Drivers
Graphics (.view files only)
BACview files
NOTE If import detects a difference between a database file and
an import file with the same name, import does not overwrite the
database file. A message lists any file differences so that you can
resolve them.
See Commissioning equipment using Field Assistant.

Alarm Popup

Select the checkbox to use the Alarm Notification Client

application. See Alarm Popup (page 84).

Restrict to IP Address

If the server has more than one network interface adapter, type
the IP address of the server's network connection that the Alarm
Notification Client application will connect to.

Port

Change this field if the Alarm Notification Client application will

use a port other than 47806 on the server.

Current client connections

Shows any workstation whose Alarm Notification Client is actively

connected to this server.

Select a week of logs to review

For troubleshooting, you can download a zip file that contains logs
of system activity.

Security tab

160

Field

Notes

Log audit data to file

Records operator activities and some system activities (such as

opening and closing the database or automatic deletions) in a text
file.
The default file is auditlog.txt stored in
WebCTRL\webroot\<system_name>. You can change the file name
and include a different path.
To prevent the file from growing too large as new data is appended,
you can archive the data to another text file by selecting an archive
frequency in the Archive log file contents field. The archive file is
auditlog_yyyy_mm_dd.txt, where yyyy_mm_dd is the creation date of
the archive file. This file is created in the same location as
auditlog.txt.
NOTE If you do not archive the log file contents, you should manually
delete the oldest entries.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Field

Notes

Log audit data to database

Records audit data in a database named audit.mdb that can be

accessed by third-party software.
NOTE For Access or MSDE, the database is automatically created. An
Access database is named audit.mdb; a MSDE database is named
audit.mdf. For MySQL, SQL Server, PostgreSQL, or Oracle, you must
create the database manually.

Delete database entries

older than ____ days

Automatically deletes entries in the database that are older than the
number of days you specify.

Log errors for invalid URLs

Enable this field to write to the core.txt log any time an external
source sends a request to the WebCTRL Server application.
NOTE Regular maintenance scans by external software can cause
the log files to grow large.

Security Policy

See Location-dependent operator access (page 133) for information

on Change Policy.

Allow remote file

management

Lets you access the system using WebDAV.

Return operators to previous

locations when server
reconnects

Returns operators to current tree locations when the server

reconnects.

Log off operators after _:_

(HH:MM) of inactivity

The system automatically logs off an operator who has had no activity
in the system for the time period specified.
This is a default setting for the system. The System Administrator can
change this setting for an individual operator on the Operators page.

Lock out operators for __

minutes after __ failed login
attempts

Clear Lockouts removes lockouts for all users.

NOTE Restarting the WebCTRL Server application will remove
lockouts.

Use advanced password

policy

A feature of the Advanced Security package that provides additional

security. See Advanced password policy (page 137).

Do not synchronize operator

and privileges

If using hierarchical servers, WebCTRL automatically synchronizes

the operator/privilege settings on the child servers with those on the
parent server. You have the following options:

Synchronize Now

2012 Automated Logic Corporation

Enable this checkbox on all servers to stop the synchronization

process.

Enable this checkbox on a child server to remove it from the

synchronization process so that you can manage that server's
settings locally.

Click this button on the parent server for immediate synchronization

of operator/privilege settings.

161

WebCTRL v5.5 User Manual

Field

Notes

Permissions

When control programs, views, and bacview files are created by an

original equipment manufacturer (OEM), they cannot be used in a
WebCTRL system without the creator's permission. However, the
creator can produce a key for a system with a different license that
will grant permission to the key's recipient.
If you receive a key, put it in the WebCTRL X.X\resources\keys
folder. The table in the Permissions section of the Security page
shows all keys in the that folder. To activate a key, click Add, then
browse to the key.
To delete a key from your system, select the key in the table, then
click Delete.
Red text in the table indicates the key has a problem such as it does
not apply or has expired. See the Notes column for an explanation.

Communications tab
The fields on this tab let you define controller communication with the WebCTRL Server application
and BACnet network communication.

162

Field

Notes

WebCTRL Server BACnet

Device Instance
and
BACnet Alarm Recipient
Instance

The BACnet identifier for the system's server and the alarm recipient.
You enter these system properties in SiteBuilder.

Always upload properties

from controllers to WebCTRL
server on mismatch

Automatic uploads are listed in the Audit Log.

If you do not select this field, properties must be manually uploaded
or downloaded by the operator when a mismatch occurs.
NOTE If an automatic upload fails and the operator chooses to do
nothing at that time, the upload will be attempted again when he
returns to the page where he encountered the mismatch.

Ignore incoming alarms from

sources not in this database

The WebCTRL application will ignore alarms from third-party

devices not in the database or devices from other WebCTRL
systems on the same network.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Field

Notes

BACnet Settings

Native WebCTRL system only

Use Static BACnet Bindings

If selected, the WebCTRL application uses information in its

database to bind to BACnet devices rather than using BACnet's
Who-Is/I-Am/Who-Is-Router-To/I-Am-Router-To broadcasts to resolve
BACnet network and device bindings (dynamic binding).
If not selected, the WebCTRL application uses BACnet (dynamic)
binding for communication between devices.
Leave this field at its default setting unless you are doing one of the
following:

Log BACnet Binding Conflicts

Select this checkbox if your system uses NAT routing.

Clear this checkbox to use BACnet Discovery or for third-party

BACnet integration.

When checked, the WebCTRL application logs binding conflicts that

result from duplicate network numbers or device IDs.

Scheduled Tasks tab

Field

Notes

Automatically delete alarm

incident groups which have
been closed for more than
___ days

Alarm incident groups are all alarm actions, such as Off Normal,
Fault, and Return to Normal, that are triggered by a single alarm.
NOTE Alarms in an incident group are not deleted until all alarms in
the group have been closed.

Archive alarm information

upon alarm deletion

Writes alarm information to a text file.

Archive file

The default file is eventdel.txt stored in

WebCTRL\webroot\<system_name>. You can change the file name
and include a different path.

Archive file format

The alarm information to be written to the archive file. To add

information, select field codes in Append Field Code. To delete field
codes, highlight them in the Archive file format box and press Delete.

Automatically delete expired

schedules daily at ___

To ensure there are no time zone conflicts, the WebCTRL

application waits 2 days after a schedule expires to delete it.

Keep historical trends for ___ Stores trend data in the WebCTRL database for the time you
days
specify. This is a default setting that you can change when you set up
trends for an individual point.
Remove expired historical
trends daily at ____

2012 Automated Logic Corporation

Deletes trend data that has been in the database longer than then
time you specified in the previous field.

163

WebCTRL v5.5 User Manual

Field

Notes

Enable time synchronization

of controllers daily at____

Automatically synchronizes the time on all equipment to the time on

the server, adjusting for different time zones and Daylight Saving
Time. We recommend that you enable this field.
CAUTIONS

To prevent time sync problems when the transition to and from

Daylight Saving Time occurs, set the time sync to occur at least 1
hour after the last controller in the system is adjusted for DST.
For example, your server and part of your system is in the Eastern
Standard Time zone, but you also have controllers in the Pacific
Time zone. Your server is adjusted for DST at 2:00 a.m. Eastern
Standard Time, but the controllers in the Pacific Time zone are
not adjusted until 3 hours later. So you would set the time sync to
occur daily at 6:00 a.m. or later.

Make sure that your servers time and time zone setting are
correct.

Make sure that each sites time zone setting is correct in

SiteBuilder.
NOTES

You can disable this function for an individual site on the sites
Properties page. See To set up site properties (page 166).

You can also perform time synchronizations using the timesync

manual command (page 141).

Daylight Saving tab

On this tab, you can adjust the settings for Daylight Saving Time.
Click Update to automatically set the table's Begin and End dates for the next 10 years based on the
system's timezone. This marks all controllers with ExecB drivers for a Parameters download.

If the updated dates are incorrect

If you clicked Update but the dates are incorrect, your system's Java timezone data may be out-of-date.
Do the following:
1 Go to the Oracle Java SE Download site (http://java.sun.com/javase/downloads).
2 Download the JDK DST Timezone Update Tool (tzupdater-.zip).
3 In the WebCTRL interface, go to System Settings > Daylight Saving, then click Import.
4 Browse to the tzupdater.zip file, select it, then click Open.
5 Click Continue.
6 Restart the WebCTRL Server application.
7 On the System Settings > Daylight Saving tab, click Update.

164

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Web Applications tab

A web application, such as EnergyReports, is an application that retrieves and uses data from a
WebCTRL system. A web application is a standard Web Application Archive (.war) file as described in
the Java Servlet Specification. For example, EnergyReports is EnergyReports.war.

To install a web application

1
2
3
4

Save the web application's .war file to your computer.

On the System Settings > Web Applications tab, click Browse and open the .war file.
Click Add Web Application. After a few seconds, the message Web Application ____ was
successfully added is displayed.
Click OK. The web application appears in the table at the top of the page. See the table below for a
description of each column.

Column

Notes

Application

To open the web application in a web browser, append this path to your
WebCTRL system's address.
For example, to start EnergyReports, enter:
http://<system_name>/EnergyReports, or
http://<system_IP_address>/EnergyReports.

Name

The web application's actual name, if its author provided one.

TIP You can hover over the Application or Name cell to see a description of
the web application, if its author provided one.

Version

The web application's version, if its author provided one.

Running

The web application's status. This column must show running for you to open
the web application in a browser.

Sessions

The number of web browsers currently using the web application.

Data Directory

Web applications have 2 data directories:

A private directory in WebCTRLx.x\webroot\<system

name>\webapp_data\<web application> that contains information such as
configuration data

A public directory in WebCTRLx.x\webroot\<system

name>\webapp_public\<web application> that contains data generated by
the web application.
This column shows the <web application> directory.

Data Directories
Size
(private/public)

The size of the data stored in the private and public directories.

2012 Automated Logic Corporation

165

WebCTRL v5.5 User Manual

To back up the web application's private and public data directories

NOTE This procedure will not back up data stored in an external database. For example,
EnergyReports uses an external database.
1 Select the web application in the table.
2 Click Save Data.
3 Click OK.
4 Click Save.
5 Select the location where you want to save the data, then click Save.

To update a web application

1
2
3
4

Select the application in the table.

Click Remove App and Keep Data
Follow the procedure above to install the new version of the application.
Restart the WebCTRL Server application.

To uninstall a web application

1
2

Select the application in the table.

Click Remove App and Data.

To set up site properties

1
2
3

On the NET tree, select the site.

Click Properties.
Configure site properties.

Field

Notes

Enable Timesync

Daily synchronizes the time in the site's controllers with the server's time,
adjusting for different time zones and Daylight Saving Time. Synchronization
occurs each day at the time specified in the field Enable time synchronization
of controllers daily at on the System Settings > Scheduled Tasks (page 163)
tab.
CAUTION Make sure that your servers time and time zone setting are
correct. Also, make sure that the sites time zone setting is correct in
SiteBuilder.

Group Cache
Controller

166

The designated router where colors are cached when peer caching is enabled
in SiteBuilder.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

To register your WebCTRL software

To register your software, you must obtain a registered license from Automated Logic and then apply
it in the WebCTRL interface. You can apply it when you install the software or at a later time.
1 Go to http://accounts.automatedlogic.com (http://accounts.automatedlogic.com).
2 Select Support > Software Licenses > WebCTRL 2.5 and later (BAS License Manager).
3 Select filter criteria to narrow the list of licenses, then click Filter in the upper right-hand corner.
4 Select the appropriate row.
5 Fill in the blank fields in the License Registration Area.
6 Click Register License.
7 Select the checkbox for I agree to the terms of use.
8 Click Download License, then save the license file to a disk or to your hard drive.
9 Apply your license:

During the WebCTRL installationThe installation requests the location of your license file.
Browse to location where you saved it in step 4 above.

After the installation

a. In the WebCTRL interface, select CFG > License Administration.
b. Browse to the license file.
c. Click Apply.
d. Restart the WebCTRL Server application using the rebootserver manual command (page
141).
NOTES

Do not edit any part of this registered license file. Editing a license file invalidates the license.

Store the license in a safe location.

To replace the license when adding features

You can add any of the following optional WebCTRL packages to your system:

Enterprise integration: Web services (XML/SOAP) data retrieval

Advanced security: Location-dependent operator access, configurable password policies, and

required operator comments/verification for system changes

Advanced reporting: Custom reports

Additional alarm actions

You can purchase an optional package at http://orders.automatedlogic.com. Select Options under

Software Products.
To obtain an updated license and then apply it in the WebCTRL interface:
1 Go to http://accounts.automatedlogic.com (http://accounts.automatedlogic.com).
2 Select Support > Software Licenses > WebCTRL 2.5 and later (BAS License Manager).
3 Select filter criteria to narrow the list of licenses, then click Filter in the upper right-hand corner.
4 Select the appropriate row.
5 Select the checkbox for I agree to the terms of use.
6 Click Download License, then save the license file to a disk or to your hard drive.
7 To replace your license in the WebCTRL interface, select CFG > License Administration.
2012 Automated Logic Corporation

167

WebCTRL v5.5 User Manual

8 Browse to the license file.

9 Click Apply.
10 Restart the WebCTRL Server application using the rebootserver manual command (page 141).
TIP Back up your system (page 203) before replacing your license.

Adding links or text to the WebCTRL login page

You can add links or text, such as a disclaimer, to the login page.

168

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

To add links to the login page

1

In a text editor such as Notepad, type 2 lines for each link that you want on the login page.
Line 1: link#.text=<the link text that is to appear on the login page>
Line 2: link#.url=<the link's address>
Example to add links shown above:

Save the file with the following name and location.

File name: extra_login_links.properties
Location: WebCTRLx.x\webroot\<system_name>

To add text to the login page

1

In a text editor such as Notepad, type the text that you want on the login page.
Example to add text shown above:

Save the file with the following name and location.

File name: legal_disclaimer.txt
Location: WebCTRLx.x\webroot\<system_name>

2012 Automated Logic Corporation

169

WebCTRL v5.5 User Manual

Chapter 19
Working with control programs in the WebCTRL interface
A control program is typically defined in SiteBuilder when the system is engineered, but you can make
the following changes to a control program in the WebCTRL interface. These changes require you to
download All Content (page 46) to the controller.

Select a different control program

See topic below.

Reload a revised control program located in webroot\<system>\programs.

In the WebCTRL GEO tree, right-click the equipment, then select Reload.

NOTE If you change a control program in the EIKON LogicBuilder application and it does not display
correctly in the WebCTRL interface, Ctrl+right-click the WebCTRL action pane, and then select
Refresh.

To select a different control program

1
2

Right-click the equipment on the WebCTRL navigation tree, then select Configure.
If the system has other control programs of this type, select which control programs you want to
change.

NOTES

If you are changing an IP router's control program, the second option will change all control
programs of this type only on the IP network.

If you are changing a control program on the network below an IP router, the second option
will not change control programs of this type in the router.

170

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Do one of the following:

If the control program is...
In the Control Program drop-down list a. Select the control program.
b. Click OK.
Not in the Control Program
drop-down list

a. Click Add New.

b. Browse to select the control program.
c. Click Open.
d. Click Continue.
e. Click Close.
f. Click Close again.

Download All Content (page 46) to the controller.

NOTE You can click Delete Unused in the Control Programs section to delete all unattached control
programs and any supporting files with the same name from the programs folder.

To edit a control program on a WebCTRL client

On a WebCTRL client, you can get a copy of a control program from the server, edit it, then put it
back on the server.

To get the control program

1
2
3
4
5
6
7

Right-click the equipment on the WebCTRL GEO or NET tree, then select Configure.
In the Control Programs section, click Edit Existing.
Click Save.
Browse to the folder you want to put the file in.
Click Save.
Click Close.
Click Close again.

To put the edited control program back on the server

1
2
3
4
5
6
7

Right-click the equipment on the WebCTRL GEO or NET tree, then select Configure.
In the Control Programs section, click Add New.
Browse to select the control program.
Click Open.
Click Continue.
Click Close.
Click Close again.

2012 Automated Logic Corporation

171

WebCTRL v5.5 User Manual

Chapter 20
Working with drivers in the WebCTRL interface
A controller's driver is defined in SiteBuilder when the system is engineered, but you can make the
following changes to a driver in the WebCTRL interface.

Change or upgrade a driver. See topic below.

Reload a driver if it becomes corrupt (for example, a driver page is missing in the WebCTRL
interface). On the WebCTRL NET tree, right-click the controller or driver, then select Reload
Driver. Changes you made on the driver pages in the WebCTRL interface remain in effect.
After you make these changes, you must download All Content (page 46) to the affected controller(s).
NOTE You can also make these changes in SiteBuilder. See "To change or upgrade a driver" in
SiteBuilder Help.

To change or upgrade a driver

1
2

On the WebCTRL NET tree, right-click the controller, then select Configure.
If other controllers in the system use this driver, select which controllers you want to change.

Do one of the following:

If the driver is...
In the Driver Version drop-down list
Not in the Driver Version drop-down list

a. Select the driver.

b. Click OK.
a. Click Add.
b. Browse to select the driver.
c. Click Open.
d. Click Continue.
e. Click Close.
f. Click Close again.

Download All Content (page 46) to the controller.

NOTE You can click Delete Unused in the Controller section to delete all unused drivers in
WebCTRLx.x\webroot\<system_name>\drivers.

172

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Chapter 21
Working with BACview files in the WebCTRL interface
To use a BACview to view or edit a controller's property values, you must download a .bacview file to
the controller. The .bacview file is typically defined in SiteBuilder and downloaded with the initial
download to the controller, but you can select a different file in the WebCTRL interface.

To select a different .bacview file

1
2

On the WebCTRL NET tree, right-click the controller, then select Configure.
If other controllers in the system use this .bacview file, select which controllers you want to
change.

Do one of the following:

If the .bacview file is...

In the BACview file drop-down list

a. Select the file.

b. Click OK.

Not in the BACview file drop-down list

a. Click Add.
b. Browse to select the .bacview file.
c. Click Open.
d. Click Continue.
e. Click Close.
f. Click Close again.

Download All Content (page 46) to the controller.

NOTE You can click Delete Unused in the Bacview section to delete all unused BACview files in:

WebCTRLx.x\webroot\<system_name>\views
WebCTRLx.x\webroot\<system_name>\programs

2012 Automated Logic Corporation

173

WebCTRL v5.5 User Manual

To edit a .bacview file on a WebCTRL client

On a WebCTRL client, you can get a copy of a .bacview file from the server, edit it, then put it back on
the server.

To get the .bacview file

1
2
3
4
5
6
7

On the WebCTRL NET tree, right-click the controller that uses the .bacview file, then select
Configure.
Under BACview, click Edit.
Click Save.
Browse to the folder you want to put the file in.
Click Save.
Click Close.
Click Close again.

To put the edited file back on the server

1
2
3
4
5
6
7

174

On the WebCTRL NET tree, right-click the controller that uses the .bacview file, then select
Configure.
Under BACview, click Add.
Browse to select the .bacview file.
Click Open.
Click Continue.
Click Close.
Click Close again.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Chapter 22
Running WebCTRL Server as a Windows service
Run WebCTRL Server as a Windows service if you want WebCTRL Server to automatically start up when
the server computer is restarted.
NOTE If your WebCTRL system uses a non-MS Access database located on the same computer as
WebCTRL Server, you must set up Windows to delay starting WebCTRL Server until the database
service has started. See Microsoft's "How to delay loading of specific services"
(http://support.microsoft.com/kb/193888).

To install WebCTRL Server service

NOTE If you think the service was previously installed, see To determine if WebCTRL Server service is
installed (page 177).

On Windows 2003 and XP

1
2
3

Click the Windows Start button, then click Run.

Browse to the WebCTRLx.x folder, select WebCTRL Service.exe (the service install file), then click
Open.
Click OK.

On Windows 7, Vista, 2008, and 2008 R2

1
2

In the Windows Start menu, right-click Command Prompt, then select Run as administrator.
Select Yes in the User Account Control message.

3
4

In the Command Prompt window, type: cd <path to the WebCTRL install directory>
For example, type: cd c:\WebCTRL5.2
Press Enter.

5
6

Type: "WebCTRL Service.exe" -install

Press Enter.

2012 Automated Logic Corporation

175

WebCTRL v5.5 User Manual

To start WebCTRL Server as a Windows service

Click the Windows Start button, then select Control Panel.
Double-click Administrative Tools, then Services.
In the Services (Local) list, double-click WebCTRL.
In the WebCTRL Properties dialog box, select Automatic in the Startup type drop-down list.
Optional: If you want to be able to access WebCTRL Server on the server computer's desktop,
select Allow service to interact with desktop on the Log On tab.
NOTES

If you do not select this checkbox, the computer screen will give no indication that WebCTRL
Server is running; you must view the computer's Services page to see if it is running.

This checkbox applies only to a user logged in on the server. A Windows Remote Desktop user
cannot access WebCTRL Server running as a service.

If you select this checkbox, you cannot use the instructions below to set up printing to a
network printer. Ask your Network Administrator to set up Local System account to use a
network printer.

If you select this checkbox and the WebCTRL application is to run email alarm actions, ask
your Network Administrator to set up Local System account to send emails.
6 Click Start.
7 Click OK.
NOTES
1
2
3
4
5

To shut down the WebCTRL service, return to the WebCTRL Properties dialog box and click Stop.

If WebCTRL Server does not start when you click Start, you may have a Windows permissions
problem. Follow the procedure below in To set up the WebCTRL service for network printing (page
176) to set up the Windows user name and password.

To set up the service for network printing

If WebCTRL Server runs as a service on a computer that is using a network printer, you must set up the
Windows user name and password for the service. The Print alarm action requires this setup to be able
to print.
1 Open the Windows Control Panel.
2 Select Administrative Tools > Services.
3 Double-click WebCTRL Service x.x.
4 On the Log On tab, select This account.
5 Browse to the computer's domain, then select the user that the service will log in as.
NOTE Contact your network administrator if you need help determining the domain.
6 Type the user's password in the Password and Confirm password fields.

176

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

To remove WebCTRL Server service

On Windows 2003 and XP
1
2
3
4

Click the Windows Start button, then click Run.

Browse to the WebCTRLx.x folder, select WebCTRL Service.exe (the service install file), then click
Open.
At the end of the path, type: <space>-remove
EXAMPLE "c:\WebCTRL5.2\WebCTRL Service.exe" -remove
Click OK.

On Windows 7, Vista, 2008, and 2008 R2

1
2

In the Windows Start menu, right-click Command Prompt, then select Run as administrator.
Select Yes in the User Account Control message.

3
4

In the Command Prompt window, type: cd <path to the WebCTRL install directory>
For example, type: cd c:\WebCTRL5.2
Press Enter.

5
6

Type: "WebCTRL Service.exe" -remove

Press Enter.

To determine if WebCTRL Server service is installed

If you do not know if the service was previously installed, follow the appropriate steps below.

On Windows 2003 and XP

1

From the Windows Start menu, open Command Prompt.

2
3

In the Command Prompt window, type: cd <path to the WebCTRL install directory>
For example, type: cd c:\WebCTRL5.2
Press Enter.

4
5

Type: "WebCTRL Service.exe" -check

Press Enter.

On Windows 7, Vista, 2008, and 2008 R2

1
2

In the Windows Start menu, right-click Command Prompt, then select Run as administrator.
Select Yes in the User Account Control message.

3
4

In the Command Prompt window, type: cd <path to the WebCTRL install directory>
For example, type: cd c:\WebCTRL5.2
Press Enter.

5
6

Type: "WebCTRL Service.exe" -check

Press Enter.

2012 Automated Logic Corporation

177

WebCTRL v5.5 User Manual

Chapter 23
Setting up a system for non-English languages
English is the WebCTRL default language, but you can set up your system to display a different
language. You can also set up multiple languages so different operators can view the system in
different languages.
Follow the procedures below to display the WebCTRL interface in non-English languages.
1 Install a language pack (page 178).
2 Prepare your workstation for non-English text (page 178).
3 Create control programs and translation files (page 180).
4 Create graphics (page 182).
5 Create your system in SiteBuilder (page 184).
6 Set an operators language in the WebCTRL interface (page 185).

Installing a language pack

A language pack translates the text in the WebCTRL interface. A WebCTRL system is installed with
an English language pack. To download other language packs:
1 Go to http://accounts.automatedlogic.com/download
(http://accounts.automatedlogic.com/download).
2 Under Software Updates, select v# Language Packs, where # is your WebCTRL version.
3 Select the language you want.
4 Follow the instructions under To install this language pack.
NOTE If you create a system by copying an existing system that uses language packs, install the same
language packs on the new system.

Preparing your workstation for non-English text

Set up your workstation so you can type international fonts from your keyboard.
1 Install the appropriate fonts for the languages you will be using. In the Windows Control Panel,
open Fonts, select File > Install new fonts.
2 In the Control Panel, open Regional and Language Options, then select the Input language.

178

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Install an Input Method Editor (IME) for non-alphanumeric characters.

See your operating system's Help for more information.

2012 Automated Logic Corporation

179

WebCTRL v5.5 User Manual

Creating control programs and translation files for a non-English system

To have the WebCTRL interface display a control programs user-defined text (such as microblock
names and property text) in a non-English language, you must:
1 Create the control program using key terms instead of the text.
2 Create translation files of key terms and their language-specific equivalents.
In the WebCTRL interface, the key term is replaced with its equivalent in the translation file for the
current operator language. If a WebCTRL Properties page, Logic page, or graphic shows ??key
term??, the key term is missing from the translation file.
NOTES

You also use key terms and translation files with graphics that you create with WebCTRL
extensions for FrontPage (page 182).

To edit existing control programs or translation files, see Editing translation files, control
programs, or graphics (page 185).

To enter a key term in the EIKON LogicBuilder application

In the EIKON LogicBuilder Property Editor, type @ before each key term.

NOTES

Type only the key term in the EIKON LogicBuilder application. Expressions such as
$present_value$ are put in the translation file as part of the translated text. See EXAMPLES in
"Translation files" below.

Key terms can contain only alphanumeric characters and underscores (no spaces) and cannot
start with a number.

Translation files
Translation files are used to translate key terms in control programs and graphics created with
WebCTRL extensions for FrontPage (page 183). A translation file contains key terms and their
language-specific equivalents.
For a non-English system, you must create an English translation file and a non-English translation
file* for each of the following:

180

Each control program

Key terms used in multiple control programs
Each graphic created with WebCTRL Extensions for FrontPage
Key terms used in multiple graphics

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

EXAMPLES
Translation files

Key term=Language-specific equivalent

English

This_value=This value is $present_value$

Zone_temp=Zone temperature

Spanish

This_value=Este valor es $present_value$

Zone_temp=Temperatura de zona

*If the WebCTRL interface will display multiple non-English languages, create a translation file for
each language.

To create and implement a translation file

Create your translation file in a text editor, such as Microsoft Word, that supports the character
encoding you need.
1 Type one key term and language equivalent per line, left justified, starting in column 1. Do not put
spaces on either side of the equal sign.
2 Save the file using the appropriate file name and location in the table below.
If key terms are used
in...

the file name is...

File location

A single control program

<any_name>_xx.native*

Any location

Multiple control
programs

equipment_xx.native*

WebCTRL\webroot\
<system_name>\resources

A single
graphic

<graphic_name>_xx.native*

WebCTRL\webroot\
<system_name>\graphics\lvl5

Multiple
graphics

translations_xx.native*

WebCTRL\webroot\
<system>\resources

* xx = the language extension code. See "Extension codes and encoding" below.
If you are using:

the English character set, save the file as Text only.

a non-English character set, save the file as Encoded text . (See your applications help for
information on saving files as encoded text.) When prompted for the language and encoding,
see Extension codes and encoding below.
3

Open the control program in the EIKON LogicBuilder application, then select Control Program >
Bundled Resources.

Click
, locate and select the translation file(s) for this control program, then click Open.
NOTES

Do not add equipment_xx.native files that you created for multiple control programs.

You can use Ctrl+click or Shift+click to select multiple files.

Save the control program. The translation files are embedded in the control program; the original
files are no longer necessary.

2012 Automated Logic Corporation

181

WebCTRL v5.5 User Manual

Extension codes and encoding

Language

Extension codes

Encoding*

English

_en

ISO-8859-1

French

_fr_FR

ISO-8859-1

German

_de

ISO-8859-1

Japanese

_ja

EUC-JP

Korean

_ko

EUC-KR

Russian

_ru

KOI8_R

Spanish

_es

ISO-8859-1

Swedish

_sv

ISO-8859-1

Simplified Chinese

_zh

GB2312

Traditional Chinese

_zh_TW

Big5

Thai

_th

TIS620

Vietnamese

_vi

Cp1258

* Encoding is used when you create the translation file.

Creating graphics for a non-English system

Use ViewBuilder to create graphics for a single language system.
Use WebCTRL extensions for FrontPage to create graphics for a multi-language system.

Creating a non-English graphic in ViewBuilder

NOTES

The names of your .view file and any inserted image files must contain only ASCII characters.

Graphics created in ViewBuilder do not use translation files. Type non-English terms directly into
the graphic in ViewBuilder.

Before you begin adding objects to a graphic:

1 Select Configure > View Properties.
2 In the Language field, select the language you want to use.
3 Click OK.

182

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

To set the default font

If your system has language packs installed, you can select a language to be the default language for
all new graphics that you create in ViewBuilder. You can then change the language selection for an
individual graphic in its View Properties.
To set the default language:
1 Select Configure> Preferences.
2 Select the Languages tab.
3 Select the checkbox for the default language.
ViewBuilder uses the defined font for all text in your graphic. The default is Arial Unicode MS because it
supports all languages and is the only font that ensures controls and labels in your graphic will align
correctly in the WebCTRL interface. If you do not see Arial Unicode MS in the Font column, install it if
possible using the following instructions. If you cannot install it, use the font shown or click on it to see
other fonts that you can select.

To install the Arial Unicode MS font

Arial Unicode MS is only supplied with Microsoft Office. Although Office may be installed on your
computer, the font may not be installed.
1 Insert your Microsoft Office CD in the computer.
2 Select Start > Control Panel.
3 In the Control Panel, select Add/Remove Programs.
4 Make sure Change or Remove Programs in the upper left corner is selected.
5 Select Microsoft Office XP (or Microsoft Word 2002).
6 Click Change.
7 In the Setup window, select Add or Remove Features.
8 Click Next.
9 Expand Office Shared Features.
10 Expand International Support.
11 Click the icon next to Universal Font.
12 Select Run all from My computer.
13 Click Update.
14 Restart ViewBuilder if it was open.

Creating a graphic for a multi-language system using WebCTRL extensions for FrontPage
When you create a graphic using WebCTRL extensions for FrontPage, you enter a key term instead of
text in the graphic. When the graphic is displayed in the WebCTRL interface, the key term is replaced
with its equivalent in the translation file for the current operator language. See Creating control
programs and translation files (page 180).

2012 Automated Logic Corporation

183

WebCTRL v5.5 User Manual

To enter a key term for an image area label:

1
2

3
4

Double-click the image area label.

Enter a key term in the Label Text field.
NOTE Use only alphanumeric characters and underscores (no spaces). Do not start a key term
with a number.
Select Label Text is resource key.
Do one of the following:

If the translation file for the graphic is in WebCTRL\webroot\<system_name>\graphics\lvl5),

leave the Resource field blank.

If the translation file is in WebCTRL\webroot\<system_name>\resources, enter the following

in the Resource field: resources\<translation file prefix>
EXAMPLE resources\translation
Click OK.

To enter a key term for other text:

1
2
3
4
5

Click the International Text button

.
Double-click [Text] on the graphic.
Type the key term in the Key field.
Enter the location of the translation file in the Resource field. See step 4 above.
Click OK.

Creating a non-English system in SiteBuilder

To set language preferences
1
2
3

4
5
6

In SiteBuilder, select Configure > Preferences.

Select the Language tab.
Under Supported Languages, select each language that your system will display.
NOTE Each language you select requires a language pack. See Installing a language pack (page
178).
Select the system language under System. See System Language (page 185).
Click OK.
Save your database.

To create your system

To create your system in each language that the system will display:
1 In SiteBuilder, select Configure > Preferences.
2 Select the Font tab.
3 To the right of each language that your system will display, click Default and select the appropriate
font for that language from the drop-down list.
4 Click the Language tab.
184

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

5
6
7
8
9

Select a language in the Current Session field.

Click OK.
Create your system.
Save your database.
If your system will display multiple languages:
a) Select Configure > Preferences, select the Language tab, and select another language in the
Current Session field.
b) Re-enter all node names and display names in the current language.
c) Save your database.
d) Repeat steps a. through c. for each additional language the system will display.

System language
The system language is used for:
The default language for new operators
Alarms sent to the database
State text and object names downloaded to the field
The default login page *
All other information is displayed in the operators language, which may be different than the system
language. See To set an operators language in the WebCTRL interface (page 185).
* You can change the language shown on the WebCTRL login page by selecting a different language
from the list below the Password field.

To set an operators language in the WebCTRL interface

An operator can change their language preference in the WebCTRL interface.
1 On the CFG tree, select My Settings.
2 Under Preferences, select the Language in the drop-down list.
3 Click OK.

Editing translation files, control programs, or graphics for a non-English system

If you add or edit a key term in a control program or graphic, be sure to make the same change in the
translation file. See Creating control programs and translation files (page 180).
If you make changes after attaching a control program or graphic in SiteBuilder, do one of the
following:

If you changed text only in a control program or its translation file, right-click the control program in
the Geographic tree, then select Rebuild Equipment Pages.

If you changed logic in the control program, right-click the control program in the Geographic tree,
then select Reload Control Program.

If you changed a translation file located in WebCTRL\webroot\<system_name>\resources,

right-click each applicable graphic in the Geographic tree, then select Rebuild Graphic Resources.

2012 Automated Logic Corporation

185

WebCTRL v5.5 User Manual

To edit a bundled resource

The EIKON LogicBuilder application bundles (embeds) the translation file(s) for a control program
into the .equipment file. See steps 3 through 5 in To create and implement a translation file (page
181). To edit a bundled translation file:
1 Open the control program in the EIKON LogicBuilder application.
2 Select Control Program > Bundled Resources.
3
4

Select the file, then click

Edit the translation file.

In the Bundled Resources dialog box in the EIKON LogicBuilder application, click
the edited file.
Click OK to overwrite the existing file.

to save it to your hard drive.

and select

Editing an EIKON for WebCTRL control program in the EIKON LogicBuilder application
To edit a non-English control program that you created in the EIKON for WebCTRL application:
1 Open the .eiw or .equipment file in the EIKON LogicBuilder application, then make your edits.
2 Select Control Program > Bundled Resources.
3 Verify that the list shows all translation files specifically for the control program. Use the plus or
minus button to add or delete translation files.
NOTE This list shows the translation files in the WebCTRL\webroot\<system_name>\programs
folder. This list should not include translation files for multiple control programs or graphics.
4 Click OK.
5 Save the control program. The translation files are bundled with the control program; the original
files are no longer necessary.
NOTE If you need to change a translation file after you save the control program, see To edit a bundled
resource (page 186).

Copying translation files to another system

To copy most translation files from one system to another, you copy the files in the source system and
paste them into the same folders in the destination system.
However, if your source system and destination system have translation files with the same name,
copying and pasting would overwrite the file(s) in the destination system. In this case:
1 Open the source systems translation file in a text editor, then copy the key terms and translations.
2 Open the destination systems translation file in a text editor, then paste into it the key terms that
you copied. Remove any duplicate key terms.

186

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Chapter 24
Web services

NOTE To see if your system has this optional package, click

package if Enabled Features shows Enterprise.

, then select About. You have this

Using Web services to retrieve or change data

Web services are:

A class of data exchange using XML (extensible markup language) and SOAP (simple object access
protocol)
Self-contained, modular applications that can be run over the Internet and can be integrated into
other applications
A standardized method for combining remote applications distributed over the Internet so that
they may work together for a common purpose
Application-to-application interfaces

Using Web services, you can retrieve information or set values for items accessible through the
WebCTRL GEO or NET tree. You can retrieve trend data, reports, present values, setpoints, and any
other BACnet object property information from a remote WebCTRL server and import the information
into a SOAP client such as Microsoft Excel. You can also set present values, setpoints, and any other
object property information on a remote WebCTRL server.
The Web services examples we provide use Microsoft Excel as the SOAP client, but you can use other
software packages.
NOTE To use Web services with Microsoft Excel or Microsoft Word:

You should be comfortable writing Visual Basic scripts and setting up macros.

You must install the Soap Toolkit found at

http://download.microsoft.com/download/xml/Install/3.0/W982KMeXP/EN-US/SoapToolkit30.EXE.

2012 Automated Logic Corporation

187

WebCTRL v5.5 User Manual

WebCTRL privilege requirements

You should create a WebCTRL operator and a privilege set whose specific purpose is Web services.
The privilege set must have the following privileges:

Remote Data Access

Access Geographic Locations or Network Locations, as needed
Access Network items, as needed
Any privileges needed for the specific task

Every change made through Web services is recorded in the Audit Log. If you do not want these
changes recorded in the Audit Log, add the following privilege to the privilege set:

Do not audit changes made using SOAP (Web Services)

WebCTRL data access using SOAP

NOTE The operator attempting to use SOAP must have the Remote Data Access privilege.
You can use the following services with WebCTRL data:

Eval - Returns the value for the given path.

Trend - Returns trend data for a specified point

Report - Returns the WebCTRL report in CSV or HTML format

System - Returns a path to a folder in the system folder where a web application can store data so
that it is backed up with other system files
The information below gives the WSDL, methods, and parameters for each service.
NOTE You may discover other methods in our web services that are not listed below, but these are for
internal use only and not intended for use by our customers.

188

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

1. Eval
See:
Example using Web services to set a value (page 193)
Example using Web services to retrieve values (page 195)
WSDL:
http://<WebCTRL_server>/_common/webservices/Eval?wsdl
Methods:
a. String getValue(String expression)
Returns the raw value for the given expression.
b. String [] getValues(String [] expressions)
Returns an array of the raw values for the given expressions.
c.

String getDisplayValue(String expression)

Returns the display value for the given expression.

d. String [] getDisplayValues(String [] expressions)

Returns an array of the display values for the given expressions.
e. setValue(String expression, String rawVal, String reason)
Sets the given raw value for the expression.
f.

setValues(String [] expressions, String [] rawVals, String reason)

Sets an array of the given raw values for the expressions.

g. setDisplayValue(String expression, String displayVal, String reason)

Sets the given display value for the expression.
h. setDisplayValues(String [] expressions, String [] displayVals, String reason)
Sets an array of the given display values for the expressions.
Parameters:

expression:
For Methods a. through d., its the path to the value to be evaluated. For points, expression
only needs to refer to the microblock; present_value is assumed.
For Methods e. through h., its the path to the value to be set

rawVal: The raw value (for instance, 1, indicating a On status) *

displayVal: The display value (for instance, On, indicating On status) *

reason: Reason for the change.**

raw value versus display value: For a binary input that is on, the raw value would be "1".
For an operator whose default language is English, the display value would be "On". The
display value is in the operator's default language.

** reason can be used if you need to comply with 21 CFR Part 11 (page 136).
NOTE Methods b, d, f, and h above process multiple expressions. If an expression causes an
error, only that expression returns an error. The remaining expressions are processed as
intended.

For an expression that gets a value, an error is indicated by [ERROR]:error message.

Correctly processed expressions return a value.
For an expression that sets a value, an error is indicated by [ERROR]. Correctly processed
expression return [OK].

2012 Automated Logic Corporation

189

WebCTRL v5.5 User Manual

2. Trend
See Example using Web services to retrieve trend data (page 198).
WSDL:
http://<WebCTRL_server>/_common/webservices/Trend?wsdl
Method:
getTrendData(String trendLogPath, String sTime, String eTime, boolean limitFromStart, int
maxRecords)
Retrieves trend records for a given point or a trend log. A series of (time, value) pairs
representing trend samples is returned.
The first element of the array is the time for the first sample, second element of the array
is the trend data value for the first sample. The third element is time for second sample
fourth element is trend data value for second sample etc. The returned array is in the
following format:
10/02/2002 10:22:00 AM
76.1
10/02/2002 10:22:30 AM
76.1
10/02/2002 10:23:00 AM
76.2

---->
---->
---->
---->
---->
---->

Time for first sample

Trend data value for first sample
Time for second sample
Trend data value for second sample
Time for third sample
Trend data value for third sample

Parameters:

user: WebCTRL operator login Id. This user should have the Remote Data Access
privilege.

password: Password for the above WebCTRL user.

trendLogPath: The full path to the point, or trend log node whose trend data is desired. For
example, #mxm/ai_interval, or #mxm/ai_interval/trend_log

sTime: Start Time. Returns trend data values starting with this time.

eTime: End Time. Returns trend data values until this time.

limitFromStart: If maxRecords is >0, use True to retrieve maxRecords from the start (sTime
if specified or the first record in the database); use False to retrieve maxRecords from the
end (eTime if specified or the last record in the database)
maxRecords: Maximum number of records desired. Use a number >0 to limit records; use 0 to
retrieve unlimited records. If using 0, you must specify sTime and eTime; limitFromStart will be
ignored.
NOTES

190

sTime and eTime format: MM/dd/yyyy hh:mm:ss aa. Example: 10/02/2002 10:22:00
AM

If you do not want to specify a start time or end time, use NULL or an empty string for the
sTime or eTime. In this case, maxRecords must be >0.

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

EXAMPLES

sTime=04/07/2007 12:00:00 AM
eTime=NULL
limitFromStart=True
maxRecords=10
The first 10 records starting on 4/7/07 at 12:00:00 AM will be returned.

sTime=NULL
eTime=NULL
limitFromStart=False
maxRecords=10
The most recent 10 records in the database will be returned.

sTime=04/07/2007 12:00:00 AM
eTime=04/10/2007 11:59:00 PM
limitFromStart=False
maxRecords=0
All records in the database between 04/07/2007 12:00:00 AM and 04/10/2007
11:59:00 PM will be returned.

2012 Automated Logic Corporation

191

WebCTRL v5.5 User Manual

3. Report
See Example using Web services to retrieve a report (page 201).
WSDL:
http://<WebCTRL_server>/_common/webservices/Report?wsdl
Methods:
a. String runReport(String location, String reportName, String extension)
Runs the named report at the given location and returns the result as a large
string with embedded carriage returns.
b. String [] runReportCsvLines(String location, String reportName)
Runs the named report at the given location and returns an array of individual CSV
lines. The caller must still parse each line.
Parameters:

location: The location to run the report at in the database

reportName: The name of a built-in report or the reference name of a custom report
Built-in report names:
~schedule-instance
~effective-schedule
~point-list-report
~locked-value
~network-io
~test-and-balance
~equipment-checkout
~audit-log
~alarms
~alarm-source
~network-status
~module-version
~security-assignment
~alarm-messages
~alarm-actions
~trend-usage
~parameter-mismatch

192

extension: Type of report to run, CSV or html

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

4. System
WSDL:
http://<WebCTRL_server>/_common/webservices/System?wsdl
Method:
String getWebAppStorageDirectory(String webAppName)
Returns a path to a folder in the system folder where a web application can store data. The
web application is responsible for creating the folder.
Parameter:
webAppName: A name unique to the web application.

Example using Web services to set a value

Follow the process below to change a BACnet Binary Point's:

Raw value in the WebCTRL database and controller

Display value shown in the WebCTRL interface

Step 1: Create a spreadsheet

1

3
4

Enter the following information the spreadsheet uses to log in to the WebCTRL system.

WebCTRL server IP address or the server network name (Cell A1 in this example)

Operator name for logging in to the WebCTRL application (Cell A2 in this example)

Operator's WebCTRL password (Cell A3 in this example)

Enter the path to the property whose raw value you want to set (Cell A5), then enter the raw value
(Cell B5).
NOTE You can use an absolute path, such as /trees/geographic/points/io_points/m001, or a
global reference name.
Enter the path to the property whose display value you want to set (Cell A6), then enter the display
value (B6).
If you need to comply with 21 CFR Part 11 (page 136), enter the reason the values are being
changed (Cell C5 and C6).

2012 Automated Logic Corporation

193

WebCTRL v5.5 User Manual

Step 2: Create a macro

The macro will write the values from the spreadsheet to the WebCTRL system.
The following steps correspond to the numbered parts of the code shown below.
1 Name the subroutine (testSoapWrite) that will set the value in the WebCTRL application.
2 Define which spreadsheet cells contain the:
host (WebCTRL server)
user (WebCTRL operator)
password (WebCTRL operator's password)
3 Identify the Web services program that allows the spreadsheet to access the WebCTRL server over
the network or Internet.
4 Enter the code to authenticate the user.
5 Enter the error handling code.
6 Enter the code that uses the setValue method to set the raw value.
7 Enter the code that uses the setDisplayValue method to set the display value.
8 This displays an error checking statement if an error is found in the data.
Sub testSoapWrite()
host = Range("A1").Value
user = Range("A2").Value
passwd = Range("A3").Value
Dim changeReason As String
Dim client As MSSOAPLib30.SoapClient30
Set client = CreateObject("MSSOAP.SOAPClient30")
URL = "http://" & host &
"/_common/webservices/Eval?wsdl"
client.mssoapinit (URL)
client.ConnectorProperty("WinHTTPAuthScheme") = 1
client.ConnectorProperty("AuthUser") = user
client.ConnectorProperty("AuthPassword") = passwd
On Error GoTo err
i = 5
expression = Range("A" & i).Value
newValue = Range("B" & i).Value
changeReason = Range("C" & i).Value
client.setValue expression, newValue, changeReason
i = 6
expression = Range("A" & i).Value
newValue = Range("B" & i).Value
changeReason = Range("C" & i).Value
client.setDisplayValue expression, newValue, changeReason

194

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

GoTo done
err:
Range("D" & i).Value = err.Description
done:
End Sub
NOTE If you have problems connecting to the WebCTRL application using Visual Basic, add the
following line:
client.ClientProperty("ServerHTTPRequest") = TRUE
above the line:
client.mssoapinit (URL)

Step 3: Run the macro

NOTE The WebCTRL Server application must be running.
1 In Excel, click Tools > Macro > Macros.
2 Select the TestSoapWrite sub-routine.
3 Click Run. The macro will write the values into the WebCTRL database and field controllers.
NOTE Follow the steps below if you get an error message when you run the macro.
a) In Excel, select Tools > Macro > Visual Basic Editor.
b) In the Visual Basic editor, select Tools > References.
c) Select the Microsoft Soap Type Library v3.0 and click OK.

Example using Web services to retrieve values

Follow the process below to read the value of BACnet Binary Inputs.

Step 1: Create a spreadsheet

1

Enter the following information the spreadsheet uses to log in to the WebCTRL system.

WebCTRL server IP address or the server network name (Cell A1 in this example)

Operator name for logging in to the WebCTRL application (Cell A2 in this example)

Operator's WebCTRL password (Cell A3 in this example)

Enter the paths to the properties whose values you want to get (Cells A5, A6, and A7).
NOTE You can use an absolute path, such as /trees/geographic/points/io_points/m001, or a
global reference name.

2012 Automated Logic Corporation

195

WebCTRL v5.5 User Manual

The macro that will retrieve the values will write them to cells B5, B6, and B7.

Step 2: Create a macro

The macro will read the values from the WebCTRL system and write them to the spreadsheet.
The following steps correspond to the numbered parts of the code shown below.
1 Name the subroutine (testSoapRead) that will retrieve the values from the WebCTRL application.
2 Define which spreadsheet cells contain the:
host (WebCTRL server)
user (WebCTRL operator)
password (WebCTRL operator's password)
3 Identify the Web services program that allows the spreadsheet to access the WebCTRL server over
the network or Internet.
4 Enter the code to authenticate the user.
5 Enter the error handling code.
6 Enter the code to allocate and specify the expressions to get.
7 Enter the code to get the values and insert them into the spreadsheet.
8 This displays an error checking statement if an error is found in the data.
Sub testSoapRead()
host = Range("A1").Value
user = Range("A2").Value
passwd = Range("A3").Value
Dim changeReason As String
Dim client As MSSOAPLib30.SoapClient30
Set client = CreateObject("MSSOAP.SOAPClient30")
URL = "http://" & host &
"/_common/webservices/Eval?wsdl"
client.mssoapinit (URL)
client.ConnectorProperty("WinHTTPAuthScheme") = 1
client.ConnectorProperty("AuthUser") = user
client.ConnectorProperty("AuthPassword") = passwd

196

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

On Error GoTo err

REM
REM
Dim
Dim
Dim

VB arrays start at index 0 and are declared by the maximum index

some the next line declares an array of two strings at indices 0 and 1
expressions (2) As String
values (2) As String
result() As String

expressions(0) = Range("A5").Value
expressions(1) = Range("A6).Value
expressions(2) = Range("A7").Value
result = client.getValues(expressions)
Range("B5") = result(0)
Range("B6") = result(1)
Range("B7) = result(2)
GoTo done
err:
Range("D" & i).Value = err.Description
done:
End Sub
NOTE If you have problems connecting to the WebCTRL application using Visual Basic, add the
following line:
client.ClientProperty("ServerHTTPRequest") = TRUE
above the line:
client.mssoapinit (URL)

Step 3: Run the macro

NOTE The WebCTRL Server application must be running.
1 In Excel, click Tools > Macro > Macros.
2 Select the TestSoapRead sub-routine.
3 Click Run. The macro will write the values into the WebCTRL database and field controllers.
NOTE Follow the steps below if you get an error message when you run the macro.
a) In Excel, select Tools > Macro > Visual Basic Editor.
b) In the Visual Basic editor, select Tools > References.
c) Select the Microsoft Soap Type Library v3.0 and click OK.

2012 Automated Logic Corporation

197

WebCTRL v5.5 User Manual

Example using Web services to retrieve trend data

Follow the process below to retrieve a collection of zone temperature samples and put it in an Excel
spreadsheet.

Step 1: Create a spreadsheet

1

2
3
4

Enter the following information the spreadsheet uses to log in to the WebCTRL system.

WebCTRL server IP address or the server network name (Cell A1 in this example)

Operator name for logging in to the WebCTRL application (Cell A2 in this example)

Operator's WebCTRL password (Cell A3 in this example)

Enter the path to the trend object you want to retrieve (Cell A5 in this example).
NOTE You can also use a global path or a global reference name such as #zone_1.
Define the samples start time (Cell A6) and end time (Cell A7), and the maximum number of
samples to take (Cell A9).
The text in Cell A11 indicates where the results will be listed after the macro is run.

The macro will retrieve the trend data and write the time of each sample in column A and the
corresponding zone temperature in column B.

Step 2: Create a macro

The macro will retrieve the values from your systems trend log and put them in the spreadsheet.
The following steps correspond to the numbered parts of the code shown below.
1 Name the subroutine (evalTrends) that will retrieve the trend data from the WebCTRL
application.
2 Define which spreadsheet cells contain the:
host (WebCTRL server)
user (WebCTRL operator)
password (WebCTRL operator's password)

198

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

4
5
6
7
8

Add this section to define the trend data you want to retrieve from the path in cell A5. This
retrieves trends from startDate to endDate:
LimitFromStart - to retrieve maxRecords from beginning if true; from end if false
MaxRecords - the maximum numbers of records to retrieve
expression - the expression to evaluate
Identify the Web services program that allows the Excel spreadsheet to retrieve the data from the
WebCTRL server over the network or Internet.
Enter the code to authenticate the user.
Enter the error handling code.
Add this code to retrieve the trend data and displayed it.
This displays an error checking statement if an error is found in the data.
Sub evalTrends()
host = Range("A1").Value
user = Range("A2").Value
passwd = Range("A3").Value
startDate = Format(Range("A6").Value, "mm/dd/yyyy hh:mm:ss AMPM")
endDate = Format(Range("A7").Value, "mm/dd/yyyy hh:mm:ss AMPM")
limitFromStart = Range("A8").Value
MaxRecords = Range("A9").Value
expression = Range("A5").Value
Dim client As MSSOAPLib30.SoapClient30
Set client = CreateObject("MSSOAP.SOAPClient30")
URL = "http://" & host &
"/_common/webservices/Trend?wsdl"
client.mssoapinit (URL)
client.ConnectorProperty("WinHTTPAuthScheme") = 1
client.ConnectorProperty("AuthUser") = user
client.ConnectorProperty("AuthPassword") = passwd
On Error GoTo err
Dim result1() As String

2012 Automated Logic Corporation

199

WebCTRL v5.5 User Manual

result1 = client.getTrendData(expression, startDate, endDate,

limitFromStart, maxRecords)
Dim i, row, index, size As Integer
index = 0
Rem results is time/value string pairs
Rem compute size: result is 0 based, so add one to UBound to get size
size = (UBound(result1) + 1) / 2
For i = 1 To size
row = i + 11
Range("a" & row) = result1(index)
Range("b" & row) = result1(index + 1)
index = index + 2
Next
GoTo done
err:
Range("a10") = err.Description
done:
End Sub
NOTE If you have problems connecting to the WebCTRL application using Visual Basic, add the
following line:
client.ClientProperty("ServerHTTPRequest") = TRUE
above the line:
client.mssoapinit (URL)

Step 3: Run the macro

NOTE The WebCTRL Server application must be running.
1 To launch and run the macro, click Tools.
2 Click Macro > Macros.
3 Select the evalTrends sub-routine.
4 Click Run. The macro will retrieve the data and place it in the spreadsheet.
NOTE Follow the steps below if you get an error message when you run the macro.
a) In Excel, select Tools > Macro > Visual Basic Editor.
b) In the Visual Basic editor, select Tools > References.
c) Select the Microsoft Soap Type Library v3.0 and click OK.

200

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Example using Web services to retrieve a WebCTRL report

Follow the procedure below to retrieve a WebCTRL Point List report and put it in an Excel
spreadsheet.

Step 1: Create a spreadsheet

1

Enter the following information the spreadsheet uses to log in to the WebCTRL system.

WebCTRL server IP address or the server network name (Cell A1 in this example)

Operator name for logging in to the WebCTRL application (Cell A2 in this example)

Operator's WebCTRL password (Cell A3 in this example)

Enter the path to the WebCTRL report (Cell A5 in this example).
NOTE You can also use a global path or a global reference name such as #zone_1.

The macro will write the report data to Cell B1.

Step 2: Create a macro

The macro will retrieve the report data and add it to the spreadsheet.
The following steps correspond to the numbered parts of the code shown below.
1 Name the sub-routine (TestReport) that will retrieve the report.
2 Define which spreadsheet cells contain the:
host (WebCTRL server)
user (WebCTRL operator)
password (WebCTRL operator's password)
3 Identify the Web services program that allows the Excel spreadsheet to retrieve the report from the
WebCTRL server over the network or Internet.
4 Enter the code to authenticate the user.
5 Enter the error handling code.
6 Enter the code to run the report.
7 This displays an error checking statement if an error is found in the data.
Sub TestReport()
host = Range("A1").Value
user = Range("A2").Value
passwd = Range("A3").Value

2012 Automated Logic Corporation

201

WebCTRL v5.5 User Manual

Dim client As MSSOAPLib30.SoapClient30

Set client = CreateObject("MSSOAP.SOAPClient30")
URL = "http://" & host &
"/_common/webservices/Report?wsdl"
client.mssoapinit (URL)
client.ConnectorProperty("WinHTTPAuthScheme") = 1
client.ConnectorProperty("AuthUser") = user
client.ConnectorProperty("AuthPassword") = passwd
On Error GoTo err
location = Range("A4").Value
report = Range("A5").Value
result = client.runReport(location, report, "csv")
Range ("B1").Value = result
GoTo done
err:
Range("B1").Value = err.Description
done:
End Sub
NOTE If you have problems connecting to the WebCTRL application using Visual Basic, add the
following line:
client.ClientProperty("ServerHTTPRequest") = TRUE
above the line:
client.mssoapinit (URL)

Step 3: Run the macro

NOTE The WebCTRL Server application must be running.
1 To launch and run the macro, click Tools.
2 Click Macro > Macros.
3 Select the TestReport subroutine.
4 Click Run. The macro will retrieve the data and place it in the spreadsheet.
NOTE Follow the steps below if you get an error message when you run the macro.
a) In Excel, select Tools > Macro > Visual Basic Editor.
b) In the Visual Basic editor, select Tools > References.
c) Select the Microsoft Soap Type Library v3.0 and click OK.

202

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Chapter 25
System database maintenance
You should perform the following system maintenance on a regular basis.

To back up a system
The type of database your system uses determines the method you use to back up the system.

For Apache Derby, MS Access, MSDE, or SQLServer Express

1
2
3

Shut down the SiteBuilder and WebCTRL Server applications.

In the WebCTRLx.x\webroot folder, copy your system folder.
Paste the copy to a new location.
TIP Zip the copy before transporting it over a network or to a CD.

For MySQL, MS SQL Server, Oracle, or PostGreSQL

Use the database management system's backup method.

To compact and defragment

In a new WebCTRL system, the records in a database are contiguous. As records are added, deleted,
and modified, the records become scattered in the database. This condition, called fragmentation, can
slow down system performance and increase the database size. Compact the database to correct this
situation.
The files on the server's hard drive can also become fragmented. Defragment the hard drive to correct
this situation.
You should compact and defragment on a regular schedule such as once a month. But, you may need
to do these more often, depending on how often the data or files change.
NOTE Compacting a database may take several minutes to several hours, depending on its size.
TIP To minimize the effects of fragmentation, you should maintain at least 20% free disk space on
the server.

2012 Automated Logic Corporation

203

WebCTRL v5.5 User Manual

Compacting the database

MSDE, MySQL, MS SQL Server, Oracle, and PostGreSQL databases are compacted
dynamicallycompacting occurs in the background when a database is open.

To compact an MS Access database:

1
2
3
4
5
6
7
8
9
10
11
12

Shut down the SiteBuilder and WebCTRL Server applications.

Click Start > Control Panel.
Double click Administrative Tools.
Double click Data Sources (ODBC).
On the User DSN tab, click MS Access Database, then click Configure.
Click Compact.
Under Directories, select your system's folder under \webroot.
Under Database Name, select core.mdb, then click OK.
Under Format, select Version 4.x, then click OK.
When asked if you want to replace the database, click Yes.
When compacting finishes, click OK.
Repeat steps 5 - 10 to compact audit.mdb, events.mdb, and trends.mdb.

To compact a Derby database:

1

Shut down the SiteBuilder and WebCTRL Server applications.

2
3

Open a Windows command prompt application and type cd c:\WebCTRL5.5 to change to your
WebCTRL directory.
Click Enter.

4
5
6

Type "Derby Compression Tool.exe" <system name>.

Click Enter.
When compacting finishes, close the command window.

Defragmenting the server's hard drive

For all database types, use a defragmentation utility such as Windows Disk Defragmenter or Norton
SystemWorks.
NOTE If you are using a single computer as both the WebCTRL server and the client, you must
defragment the disk more often than the disk of a dedicated serverespecially if people access the
Internet from this computer.

To minimize the database size

The larger a database is, the less responsive it may become. Deleting closed alarm incident groups,
expired schedules, and expired historical trends on a regular basis will reduce the database size. You
can set up your WebCTRL application to automatically delete these. See "System Settings Scheduled Tasks tab (page 163)" in WebCTRL Help.

204

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

Index

Access database 203

Access User Category privilege 126
action button 23
action pane 23
Admin privilege set 125, 129
advanced password policy 137, 159, 160
Advanced reporting actions 83
advanced security 133, 136, 137
alarm actions 78, 83, 101, 104, 115
alarm categories 109
alarm messages 83, 104, 109, 126, 133,
156
Alarm Notification Client 84
Alarm Popup alarm action 83, 84, 159
alarm source 101
alarm templates 104, 109, 126, 133, 156,
159
alarms 78
acknowledging 79
alarm actions 83
archiving deleted alarms 159, 163
changing settings 78
deleting 79, 163
sounds for alarms 131
viewing 79
arcnet manual command 141
audible sounds for alarms 131
audit log 126, 133, 136, 159
automatic logoff 32, 129, 159, 160
automatically collapse trees 131
autopilot 148

category 23, 126

alarm 78, 79, 83, 103, 104, 109
graphic 35
schedule 63
trend 73
category privilege 125
changing modes 29
checkurls manual command 141
clipping 156
CMnet equipment 157
colors 27
colors in WebCTRL 23, 27
compact the database 203
comstat 141
control programs 39, 42, 44, 170
controllers 17, 29
copy manual command 141
copying a path 44
cost-saving strategies 139
CSV (Comma Separated Values) 117, 122
custom reports 44, 115, 118, 119, 121,
122, 123

B
Back button 23
backing up database 203
BACnet alarm recipient intance 159
BACnet binding conflicts 159, 162
BACnet devices 18
BACnet routers 18
BACnet/IP 156
BACview 18
BACview files 173
BBMD 47, 141
bbmd manual commands 141
binary schedule category 63
browser 17, 18, 29

2012 Automated Logic Corporation

D
database, system 29
back up 203
database type 159, 203
defragment 203
maintenance 203
minimize size 204
date format 159
Daylight Saving Time 159, 164, 166
defragmenting the database 203
demand control 52, 139
Design mode 29
device ID 162
Devices page 49
disconnect manual command 141
display name 35
download 27, 46, 49, 51, 58, 126, 133,
141, 156, 162, 164, 170, 172, 173
download manual commands 141
download options 47
Downloads page 47
driver 126, 141, 164, 172

205

WebCTRL v5.5 User Manual

E
editing a graphic 36
EIKON LogicBuilder 39, 42, 52, 63, 78,
101, 104, 141, 170, 178
energy consumption 52, 139
Equipment Summary report 115, 118
Equipment Values report 115, 119
error indicator 23, 31
errors 27, 31, 149
event recipient instance 159
extensions for FrontPage 180, 182

location-dependent operator access 133,

156, 159
location-independent operator access 125,
133
logging in 29, 125, 129, 131
logging out 32, 129, 141, 160
Logic pages 33, 42, 52, 126
login 29, 83, 129, 159, 168, 187
login name 129, 130
login, failed 159, 160
logoff 130

Field Assistant 47
floorplans 27
font 73, 178, 184

Help button 23
hierarchical servers 57, 129, 133, 159
historical trends 66, 159, 163, 204
HTTP 159

maintenance 203
manual commands 141
Manual Commands/Console Operations
privilege 126, 141
markdownload manual commands 141
memory 66
menu button 23
menu commands 23
microblock paths 44
microblock pop-up 33, 35, 39, 42, 141
microblock properties 33, 35, 39, 42, 44
microblocks 33, 35, 39, 42
minimize database size 204
mismatch 51, 141, 159, 162
modems 83, 101, 141
modstat 141
modstat manual commands 141
module memory 66
MSDE database 160, 203
multi-state schedule category 63
My Settings 82, 131, 133
MySQL database 160, 203

index 63
interactive thermostat control 38
Internet browser 17, 18, 29
IP address 141, 159

NAT 83
navigation pane 23, 26
navigation tree 23
navigation, WebCTRL 23
network number 162
node name 159
non-English system 178
Normal mode 29
Notify all users 32
notify manual command 141

G
global copy 44, 45, 66, 73, 141
global modify 35, 39, 42, 44, 109
go manual commands 141
graphics 24, 35, 178
attaching graphic files 35, 156
category 37, 126
editing 36
size 26, 35
Graphics button 35, 37
Graphics pages 33, 35, 52

K
keyboard shortcuts 71, 156

L
labels 42
language pack 178
languages 131, 178
license 167
links 24, 31, 35, 168
local privileges 133, 135

206

O
operator access 125, 133, 137
operator groups 125, 129
operators 125, 129, 130, 133, 135

2012 Automated Logic Corporation

WebCTRL v5.5 User Manual

optimal start 52, 139

Oracle database 160, 203

P
parameters 47
paramupload manual command 141
password 29, 125, 129, 130, 131, 137
password policy 130, 137, 159, 160
paths 44
PostgreSQL 160, 203
Print alarm action 83, 176
printing 26
priority level 58
privilege set 125, 129, 133, 134
assigning to an operator 130, 131, 135
privileges 44, 125, 126, 133, 134
Propagate To Server alarm action 83
properties 39, 42, 44
Properties pages 33, 39, 46, 48
protocol 18

R
rebootserver manual command 141
rebuild manual command 141
reload control programs 141, 170
reload manual command 141
remote data retrieval 187, 198
remote file management 150, 160
reports 115
categories 123
custom 115, 118, 119, 121, 122, 123
reset to defaults 42
restartmodule manual command 141
right-click menus 26
rnet here manual command 141
Run External Programs alarm action 83

S
schedule 46, 47, 57, 58, 63, 139
categories 63
deleting expired schedules 159, 163,
204
groups 59
occupancy 58, 63
reports 115
setting up 57, 58
viewing 58
secure socket layer (SSL) 152, 187
Security Assignments Report 133
Send Alphanumeric Page alarm action 83
Send E-mail alarm action 83
Send SNMP Trap alarm action 83
sequence of control 33
Server 18, 29

2012 Automated Logic Corporation

service packs and patches 126

setdefault manual command 141
setgcm manual command 141
setpoint optimization 52, 139
shortcuts, mouse and keyboard 71, 156
Show/Auto-hide button 23
showhistory manual command 141
shutdown manual command 29, 141
site properties 166
SNMP 83
SOAP 18, 126, 187
source files 47
spreadsheet data retrieval 187
SSL 152, 187
starting location 130, 131
starting page 130
starting the WebCTRL Server 29
starting WebCTRL 29
static BACnet bindings 159, 162
status values 33, 66
synchronize time 159, 163, 166
system database 29, 156
back up 203
database type 159, 203
defragment 203
maintenance 203
minimize size 204
system language 159
system maintenance 203
system name 159
System Settings 159
System-wide alarms button 23
system-wide privileges 130, 133, 134

T
tab 23
TCP ports 84
TCP/IP 18
thermographic colors 27
time format (12-hour or 24-hour) 159
time synchronization 159, 163, 166
time zone 163, 164, 166
Time-lapse 113
timesync manual command 141
TLS/SSL 152, 187
translation file 180, 185
trend data 43, 66, 68, 70, 163, 187
Trend Samples report 115, 121
trends 44, 66
copying 68
enabling historian 66
historical 66, 70, 163, 204
trend graph 68, 70, 73
viewing 70
troubleshooting 33, 42, 43
207

WebCTRL v5.5 User Manual

U
upload 49, 51, 162

W
WAP 152
WAP devices 152
Web applications 165
WebCTRL Server 18, 29
changing systems 29
restarting 29
shutting down 29
starting 29
WebCTRL Server BACnet device instance
159
WebCTRL action pane 23
WebCTRL client 18, 29
WebCTRL Design Server 31
WebCTRL extensions for FrontPage 180,
182
WebCTRL navigation 23
WebCTRL navigation tree 23
WebDAV 150, 160
WebPRTL 18
whoson manual command 141
Windows service 29, 175
Write Property alarm action 83
Write to Database alarm action 83
Write to File alarm action 83, 99

Z
zones 33, 52

208

2012 Automated Logic Corporation