WebCTRL v8.5 User Manual

WebCTRL® v8.
5
User Manual
1150 Roberts Boulevard, Kennesaw, Georgia 30144

770-429-3000 Fax 770-429-3001 | www.automatedlogic.com
ALC Proprietary & Confidential • All rights reserved
Rev. 3/24/2023
Verify that you have the most current version of this document from the Automated Logic® Partner
Community website.
Important changes are listed in Document revision history at the end of this document.
A Carrier Company
© 2023 Carrier. All rights reserved.
The content of this guide is furnished for informational use only and is subject to change without notice.
Automated Logic assumes no responsibility or liability for any errors or inaccuracies that may appear in the
informational content contained in this guide.
Contents
What is a WebCTRL® system?.................................................................................................................. 1
A typical WebCTRL® system ........................................................................................................ 2
WebCTRL® editions and optional packages................................................................................. 3
WebCTRL® tools ......................................................................................................................... 6
What's new in v8.5 .................................................................................................................................. 9
What's new in the WebCTRL® application ................................................................................... 9
What's new in the SiteBuilder application .................................................................................... 9
What's new in the ViewBuilder application ................................................................................. 10
Using the WebCTRL® application ........................................................................................................... 10
Running WebCTRL® Server ....................................................................................................... 10
To start the WebCTRL® system ................................................................................... 10
To start the WebCTRL® system ................................................................................... 11
To send a message to logged in operators ................................................................... 11
To log off an operator.................................................................................................. 11
To shut down a system ................................................................................................ 11
Getting to know the WebCTRL® interface................................................................................... 12
Navigation trees ......................................................................................................... 13
Navigating the system ................................................................................................ 14
Tree icons and hover text ............................................................................................ 15
To show, hide, or resize the navigation tree .................................................................. 16
Viewing vector graphics .............................................................................................. 17
Zooming in and out..................................................................................................... 18
Using right-click menus .............................................................................................. 19
To print the action pane .............................................................................................. 20
Colors and status in the WebCTRL® interface ............................................................. 20
Colors and setpoints .................................................................................................. 21
Working with equipment ............................................................................................................ 22
Graphics pages .......................................................................................................... 24
Properties pages ........................................................................................................ 29
Logic pages................................................................................................................ 32
Changing multiple microblock properties .................................................................... 34
Downloading to controllers ......................................................................................... 37
Checking controller status .......................................................................................... 40
Setpoints ................................................................................................................... 44
Setting up calculations ............................................................................................... 49
Schedules ................................................................................................................................. 52
To view schedules ....................................................................................................... 53
Setting up schedules .................................................................................................. 54
Using schedule categories .......................................................................................... 60
Trends....................................................................................................................................... 62
To collect trend data for a point .................................................................................. 63
Viewing a built-in, single-point trend graph ................................................................. 64
Creating a custom trend graph .................................................................................... 65
Adding trend categories ............................................................................................. 67
Using trend graphs ..................................................................................................... 68
Alarms ...................................................................................................................................... 70
Viewing, troubleshooting, acknowledging, and deleting alarms ................................... 71
Setting up alarm actions............................................................................................. 77
Setting up an alarm source in the WebCTRL® interface ............................................... 99
Customizing alarms .................................................................................................. 102
Using field codes ...................................................................................................... 106
Time-lapse .............................................................................................................................. 112
To play Time-lapse.................................................................................................... 112
To change polling interval or duration or to turn off color collection ............................ 113
Reports ................................................................................................................................... 114
Preconfigured reports ............................................................................................... 114
Custom reports ........................................................................................................ 122
To create a PDF, XLS, or CSV file ............................................................................... 161
Scheduling reports ................................................................................................... 162
Working with legacy (v6.5 and earlier) custom reports ............................................... 165
Semantic tagging .................................................................................................................... 170
To manually assign tags to a location or equipment ................................................... 171
To add, delete, import, or export custom tags ............................................................ 172
To add, delete, import, or export rules ....................................................................... 173
Source trees ............................................................................................................................ 175
Cool and Heat Sources ............................................................................................. 175
Demand Sources ...................................................................................................... 176
Environmental Index Sources .................................................................................... 177
To build or edit a predefined source tree ................................................................... 177
Source tree rules for predefined trees ....................................................................... 178
To create custom source trees................................................................................... 180
Operator access ...................................................................................................................... 182
Privilege sets ............................................................................................................ 183
Operators and operator groups ................................................................................. 187
To change My Settings .............................................................................................. 189
Advanced password policy ........................................................................................ 190
Advanced security .................................................................................................... 191
Cost-saving strategies ............................................................................................................. 196
Advanced topics ...................................................................................................................... 197
Manual commands .................................................................................................. 197
System database maintenance ................................................................................. 204
Defining WebCTRL® paths ....................................................................................... 206
Setting up and configuring a WebCTRL® system .................................................................................... 214
Setting up networks................................................................................................................. 214
Setting up IP network communication ....................................................................... 214
Troubleshooting networks ......................................................................................... 234
Using a Modstat to troubleshoot your system ............................................................ 236
Communicating locally with ExecB controllers ........................................................... 242
Communicating locally with the OptiFlex™ controller ................................................. 248
To disable a controller's Local Access ....................................................................... 251
Network security....................................................................................................... 251
Setting up BACnet/SC network communication ........................................................ 264
Setting up hardware ................................................................................................................ 270
Commissioning equipment ....................................................................................... 270
ACxelerate automated commissioning ...................................................................... 279
Commissioning equipment using Field Assistant ....................................................... 301
Performing ZN line test and balance in the WebCTRL® interface................................ 304
Working with control programs in the WebCTRL® interface ....................................... 306
Working with drivers in the WebCTRL® interface ....................................................... 309
Working with touchscreen or BACview® files in the WebCTRL® interface ................... 311
BACnet device tools and services .............................................................................. 312
Setting up WebCTRL® client devices and web browsers ........................................................... 314
Setting up and using a computer with the WebCTRL® system .................................... 315
Setting up and using a web browser to view the WebCTRL® interface ........................ 315
Setting up a system in the WebCTRL® interface ....................................................................... 319
System Settings ....................................................................................................... 319
To set up site properties ........................................................................................... 329
To register your WebCTRL® software ........................................................................ 330
Adding links or text to the WebCTRL® login page ...................................................... 331
Editing a system remotely through the Set up Tree .................................................................... 333
Editing the Geographic Tree ...................................................................................... 334
Editing the Network Tree ........................................................................................... 336
To import a clipping .................................................................................................. 340
Managing files on a remote WebCTRL® server ......................................................................... 342
Options for running the WebCTRL® system .............................................................................. 342
Running WebCTRL Server without connecting to controllers ....................................... 342
Switching WebCTRL Server to a different system ........................................................ 342
Running WebCTRL Server as a Windows® service ..................................................... 343
Running WebCTRL Server as a Linux® service ........................................................... 345
Setting up a system for non-English languages ......................................................................... 346
Installing a language pack ........................................................................................ 346
Preparing your workstation for non-English text ......................................................... 346
Creating control programs and translation files for a non-English system ................... 348
Creating graphics for a non-English system ............................................................... 350
Creating a non-English system in SiteBuilder ............................................................ 352
To set an operator’s language in the WebCTRL® interface ......................................... 353
Editing translation files, control programs, or graphics for a non-English system ........ 354
Using a converted SuperVision® system ............................................................................................... 355
Microblock pop-ups for converted SuperVision® systems ........................................................ 355
Alarms for converted SuperVision® systems ............................................................................ 356
Modifying Event IDs .................................................................................................. 357
Including Alert alarm text in WebCTRL® alarm templates .......................................... 357
Exec 3 bit alarms ...................................................................................................... 358
Trends for converted SuperVision® systems ............................................................................. 359
Trends and controller memory ................................................................................... 360
Trends for Exec 4 and 6 controllers ............................................................................ 360
Trends for Exec 3 and 4 controllers............................................................................ 362
Historical trend reporting logic .................................................................................. 368
Integrating a WebCTRL® system with other systems ............................................................................... 369
Integrating WebCTRL® data into other applications ................................................................. 369
Integrating third-party data into a WebCTRL® system .............................................................. 369
To determine the number of third-party points used in a controller ............................. 370
To discover BACnet networks, devices, and objects ................................................... 370
Document revision history .................................................................................................................... 372
What is a WebCTRL® system?
The WebCTRL® building automation system offers an intuitive user interface and powerful tools to help
facility managers keep occupants comfortable, manage energy conservation measures, identify key
operational problems, and analyze the results. The web-based WebCTRL® system can be accessed
from anywhere in the world through a web browser. On a workstation or mobile device, 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, and much more
WebCTRL® v8.5 Automated Logic Proprietary and Confidential A Carrier Company. © 2023 Carrier.
Rev. 3/24/2023 All rights reserved.
1
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 a web browser.
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:
2
The WebCTRL® client uses a web browser to access the WebCTRL® Server application as a website.
Access and security options may include:
WebCTRL® editions and optional packages

A WebCTRL® system is available in 4 editions: Standard, Advantage, Premium, and Life Sciences.
WebCTRL® edition
Feature Standard Advantage Premium Life

Sciences
Unlimited simultaneous users
Multiple operating systems and databases
Mobile devices
Custom graphics and dashboards for equipment,
system, floorplan and campus visualization
Alarms
The following alarm actions:
Requires Requires
○ Send SNMP trap Advanced Advanced
○ Web service request Alarming Alarming
○ Write property Package Package
○ Write to database
Trends
Hierarchical schedules
Time-lapse
3
WebCTRL® edition
Feature Standard Advantage Premium Life

Sciences
Third-party integration
Secure server access using TLS
International languages (International English,
Brazilian Portuguese, Canadian French, French,
German, Italian, Japanese, Korean, Russian,
Traditional and Simplified Chinese, Spanish,
Swedish, Thai, Vietnamese)
Reports:
Run preconfigured reports
Add custom logo to reports
Schedule reports
Import custom reports
Create custom reports (current and legacy) Requires
Advanced
Reporting
Package
Add electronic signatures (e-signatures) to
PDFs of scheduled reports
Life Sciences Reports:
○ Mean Kinetic Temperature Report
○ Trend Samples Report
○ Out of Range Report
Discovery and communication with Carrier Open Requires Requires Requires
and WebCTRL® WebCTRL® WebCTRL®
CCN controllers Superset Superset Superset
Package Package Package
Points (all input and output points regardless of

200 500 Unlimited Unlimited
vendor)
Supports licensed add-ons *
Free access to LDAP and Trend Export add-ons

Advanced security features Requires Requires
Advanced Advanced
Security Security
Package Package
* Does not support the Automated Demand Response add-on.
4
Optional WebCTRL® packages
Package Features
Advanced Reporting* Report Manager that lets you create:
• Custom reports
• Custom logos for reports
A legacy-style report designer for creating the following reports:

• Equipment Values (page 166)
• Trend Samples (page 168)
Advanced Security • Location-dependent operator access (page 191)

• Requirement of operator comments and operator verification prior to
accepting system changes or alarm acknowledgement (page 195)
• Location Audit Log and System Audit Log reports (page 114)
• All trend data is recorded during a Daylight Saving Time change
Advanced Alarming The following alarm actions:

• Send SNMP Trap
• Web Service Request (page 92)
• Write Property (page 93)
• Write to Database (page 94)
In addition to running an alarm action when an alarm or return-to-normal
occur, alarm actions can be set to run:
• After a delay period
• Based on a schedule group's occupancy status
WebCTRL® Superset Allows discovery of and communication with Carrier Open and CCN
controllers.
Multi-CCN Allows for mulltiple CCN Bus 0's for a WebCTRL system that has the
WebCTRL Superset optional package. See the CCN Integration Guide for
information on using this feature.
* Advanced Reporting features are included in WebCTRL® Premium. This package can be purchased
for WebCTRL® Advantage.
NOTES
• An optional package is enabled when you install a license (page 330) that provides the optional
package.
• What you can see and do in the WebCTRL® interface depends on your system's edition, optional
packages installed, and which privileges have been assigned to you.
5
WebCTRL® tools
A WebCTRL® system includes the following tools.
Design Tools
Use... To...
EIKON® Create control programs and Properties pages.
ViewBuilder Create graphics, touchscreens, and BACview® screens.
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.
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)
6
7
Start-up, Commissioning, and Service Tools
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.
8
What's new in v8.5
What's new in the WebCTRL® application
Feature Improvement
Interactive Zone Widget Also available in v8.0 with Cumulative Patch #5

(page 29)
Remote System Full featured system configuration in the WebCTRL Set Up Tree
Engineering (page 333)
Staged firmware • Keep the controller online while transferring a driver from the server
downloads (page 310) to the controller, then only take the controller offline when installing
those files
• Reduce downtime of controllers by at least 75%
Network Tree Organization Easier network organization for large IP controller networks
for IP Networks
Report options (page 114) • System-wide report formatting options available to all WebCTRL
report users
• New Operator Information Report
• Numerous improvements to Custom Reports
• Quarantine Data reports for Life Science Systems
New "programdata" • Enables quarterly releases
directory structure • Increases security
• Simplifies installation
• Place your system folder anywhere you like
Additional Features • License expiration shown on About page
• Personal Information fields removed from Operator page
• Built-in graphics control
What's new in the SiteBuilder application
Feature Improvement
Network Tree Organization Easier network organization for large IP controller networks
for IP Networks
9
What's new in the ViewBuilder application
Feature Improvement
Interactive Zone Widget • New zone control widget that is sensor agnostic.
• Allows setpoint, timed local override, and fan adjustment
• Optionally shows zone color as border color
• Also available in v8 with Cumulative 5
Using the WebCTRL® application
Running WebCTRL® Server

The WebCTRL Server application communicates with the system's controllers and accesses and
maintains the system database. You view and edit the system in client web browsers. WebCTRL Server
must be running for an operator to log in from a web browser.
The application's Current Users, Connections, and Output tabs let you monitor the status of the system.
Output information is continually archived to WebCTRLx.x\logs\< date >\core.txt.
NOTE The instructions below are for a system that has been designed and set up. While designing a
system, you can run the WebCTRL® application without communicating with the system's controllers.
See Options for running a WebCTRL® system (page 342).
To start the WebCTRL® system

1 Click Start > All Programs > WebCTRL x.x > WebCTRL Server.
TIP If you run the WebCTRL Server application as a Windows® service, your computer can
automatically start the application every time the computer starts. See Running WebCTRL Server
as a Windows service (page 343).
2 Open a web browser on one or more client computers.
3 Verify that your web browser is set up to display the WebCTRL® interface. See Setting up
WebCTRL® client devices and web browsers (page 314).
4 Type the WebCTRL® server's address in the web browser's address field.
NOTE You can type http://localhost if WebCTRL Server and the web browser are running
on the same computer.
5 Enter a Name and Password.
10
To start the WebCTRL® system
Privacy notices can be generated two ways:
• Create a privacy_notice.html file in the system directory with the information you wish to display.
OR
• Edit the system.properties file and add a privacy_notice_url=SOME_URL line with a link to an
existing privacy notice.
To send a message to logged in operators

Messages are delivered immediately to WebCTRL® client web 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 web browser window is minimized, the message is not visible.
1 On the WebCTRL Server application's Current Users tab, click beside the user you want to send
a message to. Or, click Notify All Users.
2 Type a message.
3 Click OK.
To log off an operator
From the WebCTRL Server application

NOTE The operator will be logged off without warning.
1 On the WebCTRL Server Current Users tab, right-click the operator, then select Log Off User.
2 Click Yes.
From the WebCTRL® interface

NOTE The operator will be logged off without warning.
1 In the WebCTRL® interface, press Ctrl+M.
2 Type whoson in the manual command field.
3 Obtain the ID number of the operator you want to log off.
4 Press Ctrl+M.
5 Type logoffuser x (where x is the ID number).
6 Click OK.
To shut down a system

1 In the WebCTRL Server application, select Server > Shut Down.
2 Optional: Select a delay option, then edit the Notification message.
3 Click Shut Down.
11
Getting to know the WebCTRL® interface
Computer and large-screen mobile interface
12
Small-screen mobile interface
Most of the WebCTRL® interface is the same on small-screen mobile devices except for the differences
shown below.
• When you click to hide the tree, the button changes to .
• Help and Print are in the menu.
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 189).
• 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.
Navigation trees
The WebCTRL® interface has 4 navigation trees.
Geographic tree
This tree lets you navigate through the WebCTRL® interface using the system's geographic layout.
Network tree
This tree lets you navigate through the WebCTRL® interface using the system's network layout.
Schedule Groups tree

On this tree, you can create groups that can consist of areas, equipment, or other groups. You can then
assign a schedule to the entire group instead of the individual items. See To apply a schedule to a
group of items (page 55).
13
System Configuration tree
Most of the items on this tree are used for the setup and maintenance of your system.
My Settings Lets you change settings that are specific to you such as your password
and viewing preferences. See To change My Settings (page 189).
System Settings Contains the system-wide settings that control the way the WebCTRL®
system runs. See System Settings (page 319).
Operators Lets your system administrator define operators and what they can see
Privilege Sets and do in the WebCTRL® interface. See Operator access (page 182).
Operator Groups
Categories Lets you define categories for the following. See schedules (page 60),
alarms (page 103), graphics (page 26), properties, trends (page 67), and
reports (page 146). Categories allow you to view or control groups of
similar items.
Scheduled Reports Shows any report that was scheduled on the report's page. See To manage
scheduled reports (page 163) for details.
Alarm Templates See If you upgraded alarms from v2.0 or earlier (page 105).
Connections Lets you set up, start/stop, and troubleshoot your network connections.
See Setting up networks (page 214).
Services Shows internal processes of the WebCTRL® application for
troubleshooting.
License Administration Lets you update your WebCTRL® license. See To register your WebCTRL®
software (page 330).
Update Click Update to select and apply patch, service packs, drivers, language
packs, graphics libraries, and Help updates.
Hierarchical Servers If your system has hierarchical servers, this page shows the servers that
your server is connected to.
Client Installs Lets you install applications that are to run on client computers.
Navigating the system

NOTE Use only the WebCTRL® interface to navigate; do not use the web browser’s navigation buttons.
To navigate to an item in the system

1 Select an item on the Geographic or Network tree.
NOTE The Schedule Groups and System Configuration trees are used to set up your
system.
2 Use the action buttons and their drop-down menus to navigate to specific types of information
about the selected tree item.
3 Use the tabs to filter the information further.
14
To navigate using links
Click links to jump to related pages.
On a Graphics page On a Properties page
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 on the
Geographic or Network tree, select Configure, then select the Icon. You can also select custom
icons in the EIKON® application.
Optional icons
You can display the following icons to denote locations on the Geographic 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 Geographic tree.
2 Select Tree Display Options.
3 Select the desired Tree Icons.
4 Click Accept.
15
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 Accept.
To show, hide, or resize the navigation tree
On a computer or large screen mobile device
Click at the top of the navigation tree to hide or show the tree.
Click and drag the tab on the right side of the tree to adjust its width.
16
On a small-screen mobile device
Touch at the top of the navigation tree to hide the tree. Touch to
show it.
Double-tap the arrow on the right side of the tree to widen the tree. Double-tap again to return to the
original size.
Viewing vector graphics

When viewing a vector graphic of a floorplan or site map in the WebCTRL® interface, you can
manipulate the views using buttons on the Graphics page.
The buttons are only present if, in ViewBuilder, when editing the SVG Floorplan Control Properties >
General tab, you select them to display.
Select in to see this button Click button to...

ViewBuilder... on the
WebCTRL®
Graphics page
Add 3D Toggle See 3D walls in your floorplan.
Add Ducting Toggle See ducting, if it was integrated into the floorplan graphic.
NOTE When the ducting is visible, click on a solid
rectangle (representing equipment) to open the
corresponding equipment graphic.
Allow Zoom Switch from a summary graphic to individual areas.
N/A Scroll through areas one at a time.
17
Zooming in and out
On a computer
• To zoom in and out on the WebCTRL® interface:
○ Hold down Ctrl and press + or -. Press Ctrl+0 to return to 100%.
○ Hold down Ctrl while rolling your mouse wheel.
○ Use your web browser's zoom functions.
• 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 Fit again to return the graphic to its original size.
On a mobile device
Apple® iPad and iPhone
• Double-tap to zoom in/out.
Microsoft® SurfaceTM
• Pinch-zoom works on individual frames, instead of the whole screen. So, you can zoom and scroll
the navigation pane and action pane separately.
• If browser text is too small, use Ctrl + to increase your browser's zoom level, then reload the page.
GoogleTM NexusTM and Nexus Lumia

• Pinch-zoom to zoom in/out.
18
Using right-click menus
On a computer
You can right-click the following items to select options:
A tree item The action pane
A property A trend
On a mobile device
To access the right-click menu for:
• A tree item–Select the item first, then touch and hold the item for several seconds.
• The action pane–Touch and hold the item for several seconds.
NOTE For iPhones and iPads, touch and hold your finger on the item to bring up the right-click menu,
then drag your finger to the menu option that you want without lifting your finger.
19
To print the action pane
On a computer
Click at the top of the page to print the contents of the action pane. Set the print orientation to
Landscape in the Print dialog box.
TIP To print a Graphics page that exceeds the size of the action pane, right-click the graphic and
select Scale to Fit.
On a mobile device
Touch and then select Print.
Colors and status in the WebCTRL® interface

The following colors indicate equipment status on floorplans, equipment property pages, and some
reports. The colors below are from the Classic SVG Floorplan Color palette. You can change the color
scheme in all vector floorplans to either Modern or Color Sensitive here:
1 Browse to http://<system_name>/_svgfloorplan.
2 Click the desired color palette and close the folder.
NOTE Your selection takes affect immediately for all vector floorplans in your system and will not affect
any floorplans that were not created as vector (.svg) graphics.
Color Color Name Status Code Condition Indicated

Mustard none In equipment when running WebCTRL Design Server
Purple 0 or 15 In a controller—non-operational or no
communications
In equipment—a hardware or software error
Charcoal 14 In a controller—a download is required or is already in
progress
In equipment—a 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 8 Maximum cooling
Dark blue 3 Maximum heating
Yellow 7 Moderate cooling
Light blue 4 Moderate heating
Gray 1 Unoccupied/inactive
20
Color Color Name Status Code Condition Indicated
White 10 Occupied/active
Light green 6 Free cooling
Green 5 In a controller—operational or operational read only
In equipment—No heating or cooling
Colors and setpoints

Thermographic colors indicate how much a zone’s actual temperature differs from its setpoints.
Five conditions may affect a zone’s thermographic color:
• Setpoint adjust
• Timed local override (TLO)
• Optimal start
• Demand level
• Hysteresis
In the examples below, a zone’s heating occupied setpoint is 70° and its cooling occupied setpoint is
74°.
If you when the zone but... then you will

normally temp is... see...
see...
green 72.5° someone adjusts the setpoints (for example, with a yellow
setpoint adjust of two degrees, the new setpoints
would be 68 and 72°)
gray 73° someone presses the Override button on a zone green
(unoccupied) sensor to use the occupied setpoints
gray 77° the zone is in optimal start and is ramping up to its an occupied
(unoccupied) occupied setpoint in the few hours before occupancy color
yellow 75° the zone’s electric meter is in demand level 2 with green
relaxed setpoints of 68 and 76°
green 73.5° cooling began when the temperature rose above 74° yellow
and the temperature has not yet dropped beyond the
1° hysteresis (to 73°)
21
Working with equipment
You can view and adjust equipment operation from the following pages:
Graphics pages (page 24)

You can view and adjust your essential building
controls on most Graphics pages.
• 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.
Properties pages (page 29)

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.
22
Logic pages (page 32)
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:
• 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.
23
Graphics pages
You can view and adjust your system from Graphics pages, which include navigation maps, floor plans,
and equipment.
Some typical items 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 (page 44)
• Trend graph to view trend (page 62) information
• Link to jump to another WebCTRL® page or to the Internet
• A data table, chart, or color map that pulls information from a custom report (page 147).
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 34) 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 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 Fit again to return the graphic to its original size.
• When a chart that is based on a report is displayed on a Graphics page, you can hover over various
points on the chart to see values. You can also click on each item in the legend to turn that
information on and off. See "Using a custom report as the source for a Graphics page" in
WebCTRL® Help for more information on a chart.
24
To attach a graphic in the WebCTRL® interface
1 On the navigation tree, right-click the item that you want to attach a graphic to, then select
Configure.
2 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.
3 Do one of the following:
If the graphic is...

In the Views Available list a. Select the graphic, then click Attach.
b. Click Accept.
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 following information for the graphic:
○ Display Name–The name that appears in the Graphics button drop-down list
○ Category–The 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 (page 301).
○ Reference Name–The name that is used to create links to the graphic in ViewBuilder
○ Default View–Sets the selected graphic as the default view if the tree item has multiple
graphics. The default graphic is bolded in the Attached list.
NOTE The default graphic is initially set in SiteBuilder.
○ Included in download–Equipment 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.
25
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 On the WebCTRL® Geographic tree, right-click the item that the graphic is attached to, then
select Configure.
2 At the bottom of the Views section, click Edit Existing.
3 Select the graphic you want to edit.
4 Click Save
5 Browse to the folder you want to put the file in.
6 Click Save.
7 Click Close.
8 Click Close again.
To put the edited graphic back on the server

1 On the WebCTRL® Geographic tree, right-click the item that the graphic is attached to, then
select Configure.
2 At the bottom of the Views section, click Add New.
3 Browse to select the .view file.
4 Click Open.
5 Click Continue.
6 Click Close.
To organize multiple graphics for a tree item

In the WebCTRL® interface, 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 a Graphics category in the WebCTRL® interface

1 On the System Configuration tree, click to the left of the Categories folder, then select
Graphic.
2 Click Add.
3 Type the Category Name and Reference Name.
4 Optional: Select a privilege so that only operators with that privilege can access graphics in the
category.
5 Click Accept.
NOTES
• To edit a category, select the category, make your changes, then click Accept.
• To delete a category, select the category, click Delete, then click Accept.
26
To assign a graphic to a category in the WebCTRL® interface
1 On the Geographic tree, right-click the item that the graphic is attached to, then select
Configure.
2 Under Views, select the graphic in the Attached list.
3 Select the category in the Category field.
4 Click Accept.
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... You can...

ZS
• Click to raise the setpoint or to lower the setpoint.
• 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.
RS Standard, Plus, or Pro

• 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:
• Outside air temperature, if enabled in the control program
• Override time remaining
• Heating setpoint
• Cooling setpoint
• See the Occupied/Unoccupied state in the display.
27
If the sensor is a... You can...
RS Pro-F
• 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.
LogiStat
• Click to raise the setpoint or to lower the setpoint.
• Click to override the schedule and put the zone in an occupied

state.
• See that the zone is in an occupied state when the red LED is lit.
28
To control equipment using an interactive zone control
An equipment graphic may include an Interactive Zone control that provides you with the following
control.
To... Click...
View or change temperature
Click . Use to raise or lower the setpoint.
TIP Check the Show Zone Color option in the control's properties
in ViewBuilder to match the color of the control's border with the
thermographic color of the zone.
Set timed override
Click . Use to override the schedule and put the zone in an
occupied state.
○ 0 — No override is active.
○ 999 — Continuous override is active. The override remains in
effect until the schedule transitions to occupied or until you
cancel it.
○ Any other number — Number of minutes remaining until the
next transition to an unoccupied state.
To cancel an override and return control to the schedule, continue
clicking until the display shows 0.
View or change fan speed
Click . Use to change the fan speed.
NOTE Check the Allow Fan Adjustment option in the control's
properties in ViewBuilder to enable fan speed control.
Click Accept to confirm changes.
Properties pages
Properties pages are automatically generated from control programs created in the EIKON®
application. Use Properties pages to:
• View the status of a piece of equipment. See Colors and status in the WebCTRL® interface (page
20).
• View or change the equipment or microblock properties currently stored in the controller
• Commission equipment (page 270)
29
To view or edit properties
1 Select a piece of equipment or a microblock on the Geographic or Network 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.
2 To change a property:
3 Click Accept.
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 34) to view and change the property in other
control programs.
• A yellow dashed box around a value indicates the value is locked.
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.
Code Point type

AI Analog Input
ANI Analog Network Input
ANI2 Analog Network Input 2
30
Code Point type
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
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
31
Code Point type
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
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 when 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 your keyboard's 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 Select a piece of equipment on the Geographic or Network tree.
2 Click Logic.
3 Click a microblock to view its details.
To locate a microblock, section, or label

1 Right-click the Logic page, then select Jump To.
○ 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.
32
To change properties, alarms, or trends
1 Click a microblock on the equipment’s Logic page.
2 In the microblock pop-up, click the Properties, Alarms, or Trends button.
3 Change properties, alarms, or trends for that microblock in the same way that you would make
changes on a regular Properties (page 29), Alarms, or Trends (page 63) page.
4 Click Accept.
NOTE Right-click a value, then select Global Modify (page 34) to view and change the property in other
control programs.
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 • The sensor has a short (or open) circuit. Verify wires are
excessively high or low 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 NOTE Equipment operates using effective setpoints. Open the
unexpected color - effective Setpoint microblock from the Logic page and check the following:
setpoints are different than the • Hysteresis
programmed setpoints
• Demand Level
• Optimal Start
• Timed Local Override (TLO)
• Setpoint Adjust
Gaps in trend data on trend Usually gaps result if network communication was disrupted or a
graph 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 Locate the microblock on the Logic page. If the color square on the
not receiving alarms from a microblock is black, the alarm is disabled. To enable it:
BACnet alarm microblock 1 Click the microblock.
2 In the microblock pop-up, click the Alarms button.
3 On the Enable/Disable tab, select Potential alarm source.
33
Unexpected feedback Possible cause
The equipment is on when I Use the Logic page to determine whether the program is sending
expect it to be off, or off when I an unexpected signal and why, or if the problem is with the physical
expect it to be on 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 Calibrate the sensor.
page does not match the On the Logic page, check to see if the output point is locked on.
reading from handheld sensor
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 microblock’s 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 Browse to any page that displays the property you want to view or change.
2 Do one of the following to open Global Modify:
○ Alt+click the property (Ctrl+Alt+click if Linux).
○ Right-click the property and select Global Modify.
3 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
* matches any control program
34
○ Click Show Advanced to view the location, value, and privileges associated with this property.
4 Select the tree item that you want to search under for every occurrence of that microblock in other
control programs.
5 Click Find All.
6 Select the properties in the list that you want to change.
35
a) Type a New Value to the right of each selected item.
b) Select Enable All, type a new value in b, then click Set All To.
c) Select Enable All, type a new value in c, then click Change All By.
8 Click Apply Changes.

NOTE To modify several properties in multiple control programs at the same time, use Global Copy.
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.
1 On the Geographic or Network tree, right-click the piece of equipment that has the
properties you want to copy, then select Copy Control Program Properties.
2 Click OK when you see This will copy this control programs properties to other control programs of
the same type. Continue?. This opens the next screen and does not lock in any changes.
3 In the Global Copy dialog box, select the items that you want to copy.
4 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.
5 Check or uncheck items as needed.
36
○ Check Skip bad values 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.).
○ Uncheck this field to prevent any values from being copied if a bad value is found.
7 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® • Change or reload a control program

interface • Change or reload a driver
• Change a schedule
NOTE A schedule change automatically downloads unless you uncheck
Automatically download schedules on each change on the My Settings
page.
• Change a touchscreen or BACview® file
• Check or uncheck a .view file's Included in download option
In SiteBuilder • Add a device
• Add equipment
• Change or reload a control program
• Set an object instance
• Change or reload a driver
• Assign or unassign equipment
• Check or uncheck 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 38) or Properties page (page 39) 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
38).
NOTES
• 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 Network 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.
37
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 • The names and executable portion of the driver and control programs
• The names and full content of Equipment Touch and BACview® 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.
• You can choose to have the All Content option download the full source files. On the WebCTRL®
Network tree, select a controller, then enable Download Source Files on the Properties page.
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 Network tree, select an item to download controllers at and below that item.
2 Click Downloads.
3 Click to the left of a Location to see controllers that require a download.
4 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 38).
d) Click Add, then click Close.
38
5 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.
6 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:
Active—The WebCTRL® application is downloading to the controller.
Pending—You initiated the download, and the controller is waiting for its turn to
download.
Failed—The download failed. See If a controller fails to download (page 39).
On Hold—Indicates either of the following:
• The controller requires a download
• You clicked Hold to stop a pending download.
• 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.
2 Correct the problem that caused the failure.
3 Select the controller on the Downloads page, then click Start.
39
Checking controller status
On the WebCTRL® Network tree, you can select a network, router, site, or the system, and then
click the Devices button to:
• View the status of controllers (page 40)
• View controller information such as address, model, driver, and .view files included in download
• Download or upload to resolve a mismatch (page 43)
• Troubleshoot network communication (page 234)
• Download or upload files for Field Assistant (page 301)
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 cannot be
stopped.
• Icons in the Tasks column indicate the following:
Active—The WebCTRL® application is downloading to the controller.

Active—The WebCTRL® application is uploading from the controller.
Pending—You initiated the download, and the controller is waiting for its turn to
download.
Failed—The download failed. See If a controller fails to download (page 39).
On Hold—Indicates 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® Network tree, you can select a router, network, site, or the system to view the
status of controllers. On the Devices page, 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, the WebCTRL® interface displays the message with the highest priority.
The table below shows all possible messages. The message color indicates the following:
Black—In process
Red—An error occurred
Blue—Requires action from the user
40
Status column Hover text message Notes
message
Black messages:
Downloading The controller is downloading,
communications may be disabled.
Pending This controller is waiting to be
processed.
Processing clipping Clipping operation is in progress. Do
not make changes as they may
corrupt your system.
Uploading The controller is uploading,
communications may be disabled.
Red messages:
Communications Cannot communicate with this
Error controller.
Connection The connection for this controller has Occurs if someone stopped the
Disabled been disabled. connection. This includes stopping a
connection, using the No Connect
connection, or running WebCTRL
Design Server.
Connection Error The connection for this controller Occurs if the connection is
failed to start. misconfigured or failed to start.
Download Failed (Message depends on the cause of
the failure.)
Error An unknown error has occurred.
Missing Files Upload failed. Server is missing
source files.
Not Uploadable This controller is not configured for Occurs if you attempt to upload a
content upload. controller with a pre-4.x driver.
Out of Service This controller is out of service. Out of Service is checked on the
controller's Properties page.
Unsupported Controller does not support content
controller upload.
Blue messages:
Controller Replaced This controller has been replaced by 4.x driver only
another controller of the same type in
the field.
Download All Content Please download all content to the
controller.
41
Status column Hover text message Notes
message
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".
Driver Parameter Driver parameter differences
Mismatch detected. Upload parameters from the
controller or download parameters to
the controller.
Parameter Mismatch Control Program parameter See Handling parameter
differences detected. Upload mismatches (page 43).
parameters from the controller or
download parameters to the
controller.
Program Mismatch Content differences detected. Upload 4.x or later driver
all content from the controller or
download all content to the controller.
Unprogrammed This is a programmable controller. To
controller add control programs, click on the
"Add Control Program" button at the
top of the screen.
Upload All Content Please upload all content from the
controller.
General messages:
This controller is ok.
Cancelled The last operation on this controller
was cancelled.
42
Handling parameter mismatches
A parameter mismatch occurs when a value in a controller does not match the value in the WebCTRL
Server application. This can be a driver or control program value.
Use either of the following methods to handle mismatches in your system.
• Method 1: Check Always resolve parameters on mismatch on the System Settings >
Communications tab to have the WebCTRL® application automatically upload if a value was
changed in the controller or automatically download if a value was changed in the WebCTRL®
interface.
Method 2: Uncheck Always resolve parameters on mismatch so that you can evaluate a mismatch to
determine the correct value.
To find mismatches in your system

If your system uses Method 2, you can find mismatches in the following places:
○ The Devices page > Manage tab > Status column will show Parameter Mismatch.
○ The Properties page for a controller, driver, control program, or point will show one of the
following red messages at the top of the page stating:
Control Program parameter differences detected.
Driver parameter differences detected.
Parameter download required.
The value that has a discrepancy will appear with a purple box around it. Hover your cursor
over the field to see:
o
r
○ Go to Reports > Equipment > Parameter Mismatch, and then click Run to get a report of any
existing mismatches in your system.
NOTE The Downloads page > Tasks column will show Resolve Parameters for any mismatches
that your system discovered in the 3 places listed above.
43
To resolve a mismatch
1 Go to one of the following:
○ Devices page - Click the Parameter Mismatch link
○ Properties page that shows one of the red messages above
2 Click one of the following:

○ Resolve to let the WebCTRL® application download changes made in the WebCTRL® interface
or upload changes made in the controller. Click the Details button to see what the discrepancy
is and whether Resolve will download or upload parameters. See NOTE below.
○ Upload to upload the parameters from the controller to the WebCTRL® application
○ Download to download the parameters from the WebCTRL® application to the controller
NOTE On the Devices page with Show Control Programs unchecked, if a controller has
simultaneous mismatches in the driver and control program, clicking Details will show that a
control program mismatch exists but it will only show details for the driver mismatch. You must go
to the control program in the tree to see details of that mismatch. However, clicking Resolve will
resolve both mismatches.
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 45).
• 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 196) to
adjust setpoints automatically:
• Optimal Start
• Demand Control
• Setpoint Optimization
44
To change programmed setpoints
1 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.)
2 On a programmed setpoint bar, click the segment or the gap between segments you want to
change.
3 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.
4 Click Accept.
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.
design temp – OAT
calculated capacity = x capacity at 65°
design temp – 65°
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
45
You can adjust the Optimal Start routine in the control program's setpoint microblock.
1 On the Geographic 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 The maximum rate (in °F/hr) that the zone temperature could be changed
Cooling Capacity by heating or cooling if the outside temperature were 65°F.
For example, if it takes 2 hours for a zone to warm up from 65°F to 72°F,
the heating capacity is 3.5°F/hr
NOTE Use 5°/hr as a starting point if you are unsure of actual capacities.
Heating Design Temp The most extreme outside winter and summer temperatures at which the
Cooling Design Temp 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 A Setpoint microblock with Learning Adaptive Optimal Start functionality automatically adjusts
the heating and cooling capacities to optimize efficiency.
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.
46
If you need to change the adjustment values in the Learning Adaptive Optimal Start routine:
1 On the Geographic tree, select the equipment that you want to change.
2 Click Properties.
3 Adjust the color fields between the Zone Setpoints graph and the Effective Setpoints graph.
CAUTION When using Learning Adaptive Optimal Start, be sure that all equipment is properly
maintained so that your system does not “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.
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 The rate (in °F/hr) that the zone temperature can change by heating or
heating capacity cooling at an outside temperature of 65°F.
Actual or The actual heating or cooling capacity of the equipment at an outside
adjusted capacity temperature of 65°F.
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.
47
A Setpoint microblock that has the Demand Limiting enabled uses a demand control strategy to
conserve energy by relaxing setpoints as the demand level rises. In the EIKON® application, you define
the amount that setpoints will be adjusted or relaxed based on the demand level.
To define Demand Control properties

1 On the Geographic or Network tree, select the electric meter.
2 On the Properties page, expand the Demand Level Parameters section.
3 Type the Start and End time to define the time period that you want demand control to be in effect
for this zone.
4 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® 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
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.
48
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.
Setting up calculations
Virtual Integrator allows you to define, view, and trend calculations based on the points defined in the
system.
• If you have calculations defined in Virtual Integrator, a Calculations tab appears in WebCTRL®. This
tab contains the following information.
○ Name (can be modified from inside WebCTRL®
○ Operation
○ Source (click the value in the source column to be taken to that point)
○ Value
○ Sample Range
○ State
These fields are described in greater detail in To add a calculation (page 49).
• Virtual Integrator calculations also appear on the Trend Sources tab in WebCTRL®.
To add a calculation
1 On the Calculations tab, click above the table. A new row is added at the bottom of the table.
TIP To add multiple calculations to the table, enter the number of calculations you want to add
in the number field , and then click .

2 Click on the calculation, and then enter its information as needed.
Field Notes
Name Enter a display name for the calculation
General
Reference Enter the system name for the calculation
Name
Source Point Enter the reference name from the Points tab for the point the calculation uses
49
Field Notes
Operation Select an operation for the calculation to perform
○ Difference (never decreasing): The positive amount of change for the
point during the sample time, negative changes are not measured
○ Difference: The amount of change for the point during the sample time
○ Maximum: The maximum value the point reaches during the sample
time
○ Minimum: The minimum value the point reaches during the sample time
Sample The elapsed time before the calculation resets, also the log interval
Rate NOTE Do not confuse Sample Rate with point sample frequency. The
calculation's operation is performed each time the source point's value is
updated.
Status:
Value The results of the calculation since the last sample was taken, as configured in
Sample Rate
Units Source point units (for example, liters per minute)
Error Error messages generated by calculation failures
Trend
Log:
Enabled Enables or disables trending of this calculation
Size Maximum number of calculation results the Virtual Integrator can hold (must be
at least 2)
Sample
Conditions:
Type Sample collection method
COV Minimum change required before a sample is taken
Increment
Historian:
Enable Enables archiving of trend data to the WebCTRL® trend database
Notify Every Number of samples at which the WebCTRL® application stores the trends to its
database (must be at least 1)
Max Notify Maximum time between trend archives
Time
Identification:
BACnet A unique name within the device for the BACnet trend object
Object
Name
BACnet A unique instance (0 to 4194302) of this point type within the device for the
Object BACnet trend object
Instance
Description A description, if any, for the BACnet trend object
50
Field Notes
Sample:
First Sample The time of the oldest sample in the Virtual Integrator
Time
Last Sample The time of the newest sample in the Virtual Integrator
Time
Total Total Samples Collected The total number of trend samples stored in the Virtual
Samples Integrator
Collected
Calculation example
The example below sets up a Calculation Point to report hourly consumption of a standard energy
meter. As the Source Point's value is refreshed, the calculation’s Value updates with increasingly larger
values. At the end of an hour, the calculation's Value is logged in the trend, and the calculation Value
returns to zero. The cycle then repeats. You can configure multiple calculations per Source Point as
needed.
1 Configure an energy consumption point on the Points tab, for example, Analog Value register
reading total kWh, with a Refresh Interval of 5 minutes.
Note the Reference Name of that point.
2 On the Calculations tab and create a new Calculation Point by clicking .

3 Enter a Name for the calculation and a Reference Name.
TIP Click Name, and then drag the fill-handle to the right, over Reference
Name, to quickly generate a Reference Name.
4 In Source Point, enter the Reference Name from step 1 to create a connection to that point’s
value.
5 Set Operation to Difference (never decreasing) to prevent negative values from being trended,
such as a negative spike if the meter is reset.
6 Under Sample Rate, type 1h and then press Enter.
NOTES
○ The system automatically changes the Sample Rate value to "1:00:00 hr:min:sec".
○ The Sample Rate is also the trend's Log Interval.
7 (Optional) If you utilize a third-party program that automatically handles trends based on their
name, click Trend at the top of the page to view the trend-related columns, then modify the BACnet
Object Name to follow the required naming pattern, for example: Elec_demand_tn.
51
To duplicate an existing calculation
1 On the Calculations tab, select the calculations that you want to duplicate.
2 Click . Another calculation with the same Name, but different Reference Name, is added.
3 Select the new calculation, and then enter the required information.
For a description of calculation fields, see To add a calculation (page 49).
To export and import calculations

Calculations are included when you export and import device information.
To delete a device
Select the calculation, and then click .
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 196).
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.
52
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 net result is the Effective schedule (page 58).
• Do not include preheating or precooling time in your schedules. Optimal Start (page 45), 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).
• If your system has no need to run schedules, you can turn off this feature. First, delete any existing
schedules. Then go to the System Settings > General tab (page 319), and check the box Disable
Schedules feature.
To view schedules
1 Select a Geographic tree item.
2 Click Schedules, then the View tab.
3 Optional: Click a white 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 on the Geographic tree that show where schedules have
been created. See Tree icons and hover text (page 15).
• 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 58).
53
Setting up schedules
To apply a schedule to equipment

WebCTRL® schedules are typically based on zone occupancy. See Using schedule categories (page 60)
if you want to create a schedule based on conditions other than occupancy.
1 On the Geographic tree, select the area or equipment you want to schedule.
2 Select Schedules > Configure tab.
3 Click Add.
4 Select a Priority. A schedule's priority determines whether affected zones will use occupied or
unoccupied setpoints.
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
5 Select a Type. See table below.

6 Type a schedule name in the Description field (50 characters maximum).
7 Enter desired values in the fields below Description.
8 On the graph, change a time segment's Start and End times by doing one of the following:
○ Click the segment, then type the times in the Start and End fields.
○ Click and drag either end of the segment or the entire segment.
9 Optional: Click Add Time Period to add one or more segments to the schedule. Or, select a
segment and click Delete Time Period to delete that segment.
10 Click Accept.
Select this Type... To use the schedule...

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 For 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 2 specified dates/times
Dated Weekly On specified weekdays 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.
54
NOTES
• To automatically download all schedules that you create or change, go to My Settings (page 189)
and check Automatically download schedules as you create them. If you want to manually
download schedules, uncheck Automatically download... and then see Downloading system
changes to controllers (page 37).
• When you apply a schedule to an item on the Geographic 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, check Ignore Schedules above this level on the Schedules > Configure tab.
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 Schedule Groups 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.
4 Optional: Change the default Reference name. A group's reference name must be unique
throughout the system.
5 Click Accept.
6 Click Add Members to Group.
7 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.
8 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 Accept.
10 Click the Schedules button, then Configure.
11 Add a schedule to the group. See To apply a schedule to equipment (page 54).
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.
55
To organize groups using folders
You can create folders and sort your groups into them to organize the Schedule Groups 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 Schedule Groups tree, select Scheduling Groups.
2 Click Add Folder.
3 Type a name for the new folder in the Name field.
4 Optional: Change the default Reference name.
5 Click Accept.
6 Repeat steps 1–4 for each folder that you want to add.
7 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 Accept.
○ Select the folder in the tree on the Scheduling Groups page, then click Add Group to add a new
group inside the folder.
NOTE You can also add a folder to a folder, or drag and drop a folder into another folder.
56
To edit or delete a schedule
○ On the Geographic tree, select the tree item where the schedule was defined, then select
Schedules > Configure tab.
○ On the Schedule Groups tree, expand Scheduling Groups, then select the group that has
the schedule you want to edit or delete.
2 Select the schedule you want to edit or delete.
3 Edit the fields you want to change or click Delete.
4 Click Accept.
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
319) page.
57
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.
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 on the
tree, then go to Schedules > Configure. Select the schedule, then click 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.
58
Feature Description
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:

• A Normal schedule that has it occupied every Monday–Friday, 6 am–5 pm
• A Holiday (unoccupied) schedule for the week of Spring Break
• An Override schedule on the first day of Spring Break from 9 am–1 pm for the
cafeteria only where a teacher's meeting will be held.
Type You must assign one of the following types to every schedule.*
Weekly Wildcard
Date Continuous
Date Range Dated Weekly
Date List
See To apply a schedule to equipment (page 54) for a description of each type.
EXAMPLE For a school, you define the following 3 schedules:
• Full calendar year: Normal, Weekly, Monday–Friday, 6am–5pm
• Summer months: Holiday, Continuous, 12am June 1st –11:59pm August 31st
• Work days in summer months: Override, Dated Weekly, Monday–Thursday, 9am–
2pm
* If you do not see one of the types listed above, on the System Configuration tree, select
Categories > Schedule. Select the Occupancy category, then the Priority. Under Schedule
Types, select the missing type, then click Accept.
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, Monday–Friday, September 1st–May 31st, 6am–5pm
Summer months: Normal, Dated Weekly, Monday–Thursday, June 1st–August 31st, 9am–2pm
59
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 equipment’s 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 Create the custom schedule category in the EIKON® application. See "To use custom alarm and
schedule categories" in EIKON® Help.
2 In the EIKON® application, select the new category from the Schedule Category droplist in a the
schedule microblock.
3 Create the same custom schedule category in the WebCTRL® interface. The Reference Name must
be identical to the category's name in the EIKON® application. See "To add a custom schedule
category in the WebCTRL® interface" below.
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® application. See "To use custom alarm and
schedule categories" in EIKON® Help.
• In the EIKON® application, select the new category from the Schedule Category droplist in a Time
Clock microblock.
1 On the System Configuration tree, click to the left of the Categories folder, then click
Schedule.
2 Click Add.
3 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.
4 Click Accept.
Field Notes
Category Name The name used in the WebCTRL® interface
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® application.
• Do not use occupancy as the reference name.
60
Field Notes
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.
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 priority’s 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

Schedule.
2 In the table, select the category you want to edit or delete.
3 Edit the fields or click Delete.
4 Click Accept.
61
Trends
The WebCTRL® system can read and store equipment status values over time and then display this
information in a trend graph to help you monitor the equipment’s operation.
You can collect trend data for any point value in the WebCTRL® system. The controller reads point
values at intervals that you define and then stores that data in the controller. A controller has limited
memory for storing trend data, so 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 the controller and the
database, or it can display only data stored in the database.
After you set up the desired points for trend data collection (page 63), you can:
• View built-in trend graphs that show a single point (page 64)
• Create custom trend graphs with multiple points (page 65)
62
To collect trend data for a point
Before you can see a point's trend graph, you must enable trending for that point and then define how
you want the controller to collect the point's data. This can be done in the EIKON® application or you
can do it in the WebCTRL® interface using the instructions below.
NOTE I/O microblocks have trending capability built-in, and you enable trend logging in the I/O
microblock. Any other microblock value must have a trend microblock attached in the control program,
and you enable trend logging of the value in the trend microblock.
To set up a point's trending in the WebCTRL® interface:

1 On the Geographic 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 On the Enable/Disable tab, check Enable Trend Log.
4 Enter information in the appropriate fields. See table below.
5 Click Accept.
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.
Field Notes
Sample every _:_:_ Records the point’s value at this interval.
(hh:mm:ss) 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.
Sample on COV Records the point’s value only when the value changes by at least the
(change of value) amount of the COV Increment.
NOTE Use this method for a binary point or for an analog point that
has infrequent changes in value.
Max samples The maximum number of samples that you want the controller to
store.
CAUTION Changing the value in Max samples 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.
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.
The above 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 Check this field to stop trend sampling when the maximum number
of samples is reached.
63
Field Notes
Enable trend log at specific Collects trend data for the specific period of time you define in the
times only 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.
Write to historian every __ Writes all trend data in the controller to the system database each
trend samples 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 Max samples. The number of trends
specified must be accumulated at least once before the historical
trends can be viewed.
Trend samples accumulated Shows the number of samples stored in the controller since data was
since last notification last written to the database.
Last Record Written to Shows the number of trend samples that were last written to the
Historian database.
Keep historical trends for __ This is based on the date that the sample was read. Select the first
days option to use the system default that is defined on the System
Settings > General tab. Select the second option to set a value for
this trend only.
Delete Deletes all trend samples stored in the database for the item
selected on the Geographic tree.
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 34) to copy trend properties to other pieces of equipment that use
the same control program.
• Run a Trend Usage report (page 114) to view trend configurations.
Viewing a built-in, single-point trend graph

1 On the Geographic tree, select the equipment whose trend you want to view.
2 Click the Trends button drop-down arrow, select Enabled Points, and then select the graph you
want to view.
3 Select the View tab. See Using trend graphs (page 68).
NOTE On the Configure tab, you can:

• Enable/disable the grid.
• Set the time range for the X axis. For example, enter 7 days to see the data for the last week.
• Turn off autoscaling so that you can define a range for the Y-axis
• Type a Y-axis label that will appear on the right side of the graph.
64
Creating a custom trend graph
When creating a custom trend graph, you can select up to 16 points. If you select more than 4 points or
points with different units, the WebCTRL® application splits the data into subgraphs. Each subgraph
can show a maximum of 4 points with similar units.
NOTES
• You must enable trending for points that you want to include in the custom trend graph. See To
collect trend data for a point (page 63).
• You can display icons and hover text on the Geographic tree that show where custom trend
graphs were created. See Tree icons and hover text (page 15).
To create a custom trend graph

1 On the Geographic tree, select the area or equipment where you want to see the graph.
2 Click the Trends button drop-down arrow, then select New Trend Graph.
NOTE If the Trends button does not have a drop-down arrow, the New Trend Graph page is already
displayed.
3 In the tree on the New Trend Graph page, use Ctrl+click or Shift+click to select the points (16
maximum) that you want to see on a graph.
NOTE The tree shows only points that have trending enabled. See To collect trend data for a point
(page 63).
4 Click Save.
5 Optional: If your system has trend categories defined, you can select a Category for this trend. For
more information on trend categories, see Adding trend categories (page 67).
6 Type a Name for the graph that will appear at the top of the graph and in the Trends button drop-
down list.
65
7 Click OK.
8 Select:
○ The View tab to see the custom trend graph. See Using trend graphs (page 68).
○ The Configure tab to edit the trend graph. See To edit a custom trend graph (page 66).
To edit a custom trend graph

1 On the Geographic tree, select the area or equipment where you created the graph.
2 Select the Trends > Configure tab. On this page, you can:
○ Change the name of the custom trend graph
○ Enable/disable the grid
○ Set the time range for the X axis
○ Edit a subgraph's Y-axis label that will appear on the right side of the graph
○ Turn off autoscaling so that you can define a range for the Y-axis
○ Add/delete subgraphs (see instructions below)
○ Add/delete points (see instructions below)
○ Change a point's name on the graph
○ Change a binary point's active/inactive text on the graph
○ Click Delete Trend Graph to delete the entire custom trend graph
To add a subgraph to a custom trend graph

1 Click Add below the Subgraphs list.
2 Type a Y-axis label.
3 Click Add below the Points list.
4 Select a point in the Data source tree.
(page 63).
5 Repeat steps 3 and 4 to add up to 4 points to the subgraph.
6 Click Accept.
NOTE To delete a subgraph, select it in the Subgraphs list, click Delete below the list, and then click
Accept.
To add a point to a subgraph

1 Select the subgraph in the Subgraphs list.
2 Click Add below the Points list.
3 Select a point from the Data source tree.
(page 63).
4 Click Accept.
NOTE To delete a point, select the appropriate subgraph, select the point, click Delete below the Points
list, and then click Accept.
66
Adding trend categories
A point trend graph is in the Enabled or Disabled category in the Trends button drop-down menu.
You can create additional categories for your custom trend graphs.
1 On the System Configuration tree, click to the left of Categories, then select Trend.
2 Click Add.
4 Optional: Select a privilege so that only operators with that privilege can access trends in the
category.
5 Click Accept.
NOTES
67
Using trend graphs
NOTES
• A gray triangle at the top of a graph indicates a note from the system. Hover your cursor on the
triangle to see which of the following occurred:
○ Equipment received a time synchronization from its network router or from the WebCTRL®
application.
○ Trend Historian has been enabled or disabled.
○ Trend Log 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.
• Click at the top of the WebCTRL® page to print the graph. You may need to set your printer's
orientation to Landscape.
• Toolbar options are also accessible by right-clicking a trend graph.
• You can check Display gap in graph line for missing data on an individual trend graph page, or you
can go to the System Settings > General tab (page 319) to set this for all future trend graphs.
68
To view trend data in a spreadsheet program
You can save trend data as csv data that you can open in a spreadsheet program such as Microsoft®
Excel®.
1 On the Trends > View tab, select > Save as CSV data.
2 Save the data (.zip file) wherever you want. The .zip file contains the following:
○ A .csv file for each trend source (point). The filenames match the point names.
○ A Combined folder containing a file with the combined data for all of the graph's trend sources.
3 Open the .csv file in a spreadsheet program.
NOTES
• You will need to convert the data in the spreadsheet's Time column to a readable date/time
format.
• If you use Microsoft® Excel® on a Mac and the converted date shows the wrong year, do the
following:
1. In Excel, go to File > Options > Advanced.
2. Scroll down to the section When calculating this workbook, and then uncheck Use 1904 date
system.
69
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® application. In the WebCTRL®
interface, you can:
• View, troubleshoot, acknowledge, and delete alarms (page 71)
• Set up the alarm actions that the WebCTRL® application performs (page 77)
• Edit alarm sources that were set up in the EIKON® application or set up new alarm sources to
generate alarms (page 99)
• Customize alarms by changing the category or message (page 102)
NOTE Besides the alarms that you set up, the WebCTRL® application has built-in system and
equipment alarms.
70
Viewing, troubleshooting, acknowledging, and deleting alarms
The WebCTRL® Alarms page displays alarms as they are received. If desired, an operator can set
options on the My Settings page to have the WebCTRL® application play an audio file when an alarm is
received.
An alarm's setup may require that it be acknowledged and/or the alarm condition returned to normal.
The alarm, its return to normal, and any other alarms related to the incident are referred to as an alarm
incident group. The WebCTRL® application closes an alarm incident group 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 defined for the group
You should delete alarms from your system as they are closed because large quantities of stored
alarms can reduce the efficiency of your system.
71
To view alarms in the WebCTRL® interface
• Click at the top of the page to see all alarms in the system.
or
• Click the Alarms button and then select an item on the navigation tree to see all alarms at and
below that level.
72
NOTES
• The WebCTRL® tree can show 10 levels. If an alarm source is deeper than 10 levels, the alarm is
reassigned to the system level.
• Alarms generated by the WebCTRL® application appear at the system level.
• Alarms generated by controllers appear at the system level on the Geographic tree, but in the
network hierarchy on the Network tree.
• An alarm's details include a path to the alarm source. Each section of the path is a link to that
location. For example, in the path East Wing/RTU-4/SSP_LO, East Wing links to the East Wing
graphic, RTU-4 links to the equipment graphic, and SSP_LO links to the microblock's Properties
page.
• You may see any of the following alarms icons in the WebCTRL® interface:
These icons... Indicate... Icon color indicates...
Access control Red = Critical
HVAC Blue = Maintenance
Fire system Gray = General
Lighting system Grayed out = Closed
General alarm
Unknown
System
FDD
FDD com fort
FDD energy
General message
Controller alarm
73
To control which alarms you see
Use these tools... To control the Alarms list
Click the arrow buttons to display other alarms.
Type a date and time or click to select a date.

Then click Go to show up to 50 alarms since that
date/time.
When finished, click to display the 50 newest

alarms or to display the oldest 50 alarms.
Date–Sorts list by date/time the alarms were

generated with the most recent at the top.
To Do–Shows only alarms that require one or more
actions before they are closed.
Incident Group–Sorts alarms by incident. For
example, an alarm and its return-to-normal form an
incident group. Brackets indicate a group.
Select the alarm categories that you want to see in

the alarms list. Use Ctrl+click, Shift+click, or both to
select multiple categories, or check Show all
categories.
74
To troubleshoot an alarm
You can select an alarm's checkbox and then click to open 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 112) for information on this feature.
To acknowledge alarms
You must acknowledge alarms that have been set up to require acknowledgment. An alarm shows if it
needs to be acknowledged.
The table in the upper left corner of the page shows how many alarms need acknowledgment at the
current location (Here) and in the entire system (Total). This table also shows how many alarms need a
return-to-normal and how many are closed.
To acknowledge an alarm
1 On the Alarms page > View tab, select the checkbox of an alarm that shows Acknowledge.
2 Click the Acknowledge button.
3 If your system requires a comment to acknowledge an alarm, enter your System login password,
and then enter your comment in Reason for acknowledgment.
To acknowledge all alarms in the alarms database for selected categories

1 On the Alarms page > View tab in the left-hand column, select the categories whose alarms you
want to acknowledge.
NOTE Use Ctrl+click, Shift+click, or both to select multiple categories, or select the Select All
checkbox.
2 Click Advanced.
3 Click Acknowledge All.
4 If your system requires a comment to acknowledge an alarm, enter your System login password,
and your comment in Reason for acknowledgment.
TIP Acknowledging many alarms simultaneously can take a long time. Acknowledge alarms as they
occur to avoid long waits.
75
To delete alarms
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, then click the Run button.
To delete an alarm
1 On the Alarms page > View tab, select an alarm's checkbox.
2 Click Delete.
To delete all alarms in the alarms database for selected categories

want to delete.
checkbox.
2 Click Advanced.
3 Click Delete All Acknowledged.
To delete all closed alarm incident groups in the alarms database

An incident group is all alarms related to a particular incident. For example, an alarm and its return-to-
normal form an alarm incident group. An incident group is considered closed when all alarms in the
group are closed.
want to delete.
checkbox.
2 Click Advanced.
3 Click Delete Closed Incidents.
NOTES
• An alarm that requires acknowledgment cannot be deleted until it has been acknowledged.
• To have the WebCTRL® application automatically delete alarm incident groups a specified number
of days after the groups close, select this option on the System Settings > Scheduled Tasks (page
325) tab.
• Also on the System Settings > Scheduled Tasks tab, 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 select the alarm and then
click Force Normal so that the alarm can be closed. Force Normal has no effect on the alarm
condition that generated the alarm.
76
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 System Configuration tree, select My Settings. See To change My Settings (page 189).
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 click and then select:
• Snooze to temporarily stop the sound for 5 minutes
• Silence to stop the sound
The alarm sound is silenced until another alarm that triggers a sound is received.
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
• Send SNMP Trap *
• Send Web Service Request *
• Write Property *
• Write to Database *
• Write to File
* These options may be limited to a specific license or optional package. See WebCTRL® editions and
optional packages for more information.
To see a report of each alarm action defined in your system and how it is configured, go to Reports >
Alarms > Alarm Actions.
See the following topics for a description of each alarm action.
77
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 action’s Edit button to make any changes.
To assign an alarm action to alarm sources:
1 On the Geographic or Network tree, select the area, equipment, or controller containing
the alarm sources.
2 On the Alarms page > Actions tab, follow the 3 steps on the screen.
NOTE Use Ctrl+click, Shift+click, or both to select multiple items.
3 Click Add.
4 Set up the alarm action by editing the fields on the alarm action page. See the appropriate alarm
action below for field descriptions.
5 Click Accept.
After you have assigned alarm actions to an alarm source, simulate the alarm (page 101) 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 on the Geographic tree that show where alarm actions
have been created. See Tree icons and hover text (page 15).
To assign an alarm action to a single alarm source

1 On the Geographic or Network tree, select the alarm source (microblock).
2 On the Alarms page > Actions tab, click the drop-down arrow, then select an alarm action.
3 Click Add.
4 Set up the alarm action by editing the fields on the alarm action page. See the appropriate alarm
action below for field descriptions.
5 Click Accept.
78
Alarm Popup
The Alarm Popup alarm action pops up a message on any computer with a Windows® operating
system that is running the WebCTRL® Alarm Notification Client application.
Field Notes
To Operator Select individual operators or operator groups who should receive alarm
To Group notification.
NOTE When using location-dependent security, users only receive alarms for
locations they are allowed to access.
Generate alarm if Check this field to generate a System Info alarm if the popup recipient is not
delivery fails currently running the Alarm Notification Client application.
Message text Use punctuation, spaces, or returns to format the text. To add live data to the
text, select field codes (page 106) from the Append Field Code list.
Append Field Code Add field codes (page 106) 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 55), 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.
Unoccupied.
* These options may be limited to a specific license or optional package. See

WebCTRL® editions and optional packages for more information.
79
Using the Alarm Notification Client application
The Alarm Notification Client application must be running on each client computer (Windows only) 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 when an alarm occurs.
Select an alarm message, then click to open the WebCTRL® interface displaying the piece of
equipment 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 the WebCTRL® interface displaying the equipment that generated the alarm.
NOTES
• If WebCTRL Server is to use https (SSL), you must do the following to enable
communication between the server and Alarm Notification Client. In SiteBuilder, go to
Configure > Preferences > Web Server. For Enabled Web Server Ports, select Both
HTTP and SSL or SSL only. In the Server Connection field described below, enter the
number of the SSL port.
• If WebCTRL Server is v6.0 and an Alarm Notification Client is an earlier version, you
will have to log in when you click .
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...
80
Button Notes
Server The WebCTRL® server and port, and the WebCTRL® operator name
Connection and password
NOTES
• If you upgraded Alarm Notification Client to v6.0, you will need to
reenter your operator name and password on this tab while Alarm
Notification Client is connected to the WebCTRL Server
application.
• 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.
• You can use an IPv6 Server address in the Server field. In the
WebCTRL® interface, in System Settings > General tab > Alarms,
you can restrict access to the IPv6 address.
Browse To The WebCTRL® page that you want to see first when browsing to the
equipment
Notification • If you want to hear a sound when an alarm occurs
Sounds • 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).
To set up the WebCTRL Server application to support Alarm Popup clients

1 On the System Configuration tree, select System Settings.
2 On the General tab, select Enable support for Alarm Notification Clients to connect to this server.
3 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.
5 Click Accept.
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.
81
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 System Configuration tree, click Client Installs.
2 Select Alarm Notification Client.
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 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.
5 Click OK.
6 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 On the Shortcut tab, type -lockconfig at the end of the Target path.
82
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 Port 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 to format the text. To add live data to the
normal.
schedule group. *
Occupied.
Unoccupied.

83
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 106) to include live data in the Message text field.
normal.
schedule group. *
Occupied.
Unoccupied.

84
Run External Program
The Run External Program alarm action starts a program or batch file on the server.
NOTE You must be running WebCTRL Design Server to set up this alarm action.
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
Append Field Code Add field codes (page 106) 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 alarm’s 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.
normal.
schedule group. *
Occupied.
Unoccupied.

85
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.
Mail Host Security Select the type of security the mailserver uses.
Options • 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 TLS, 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 Select if your mailserver allows only MIME attachments.
attachment
Message Text Use punctuation, spaces, or returns to format the text. To add live data to the
86
normal.
group or run if the alarm occurs during the unoccupied hours defined for
a schedule group. *
Occupied.
Unoccupied.

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 SSL or TLS

Before the WebCTRL® application sends an email using SSL or TLS, 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 On the WebCTRL® server, click the Windows® Start button.
4 In the Search programs and files field, type the following command:
C:\WebCTRL<x.x>\bin\java\jre\bin\keytool.exe -import -trustcacerts -

alias smtpserver -keystore
webserver\programdata\webserver_base\keystores -file <file_path>
replacing:
<x.x> with the system's version number
<file_path> with the full path and file name of the certificate file
87
5 The information for the smtpserver key is displayed and you are prompted to trust this certificate.
Type yes.
NOTE If your mailserver is using SSL or TLS, the WebCTRL® server is running antivirus software, and
the email alarm action fails because it cannot find an SSL certificate, do one of the following:
• Disable scanning of outgoing SMTP traffic in the antivirus software. See your antivirus software's
Help for assistance.
• Obtain the antivirus software's SSL certificate and install it on the WebCTRL® server using the
above procedure.
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 XLS file.
Field Notes
To and Type the address(es) that you want to send the alarm to. To enter multiple
CC addresses, type a space or press Enter after each address.
Subject Enter the text that you want to appear on the Subject line of the email. The
subject can include field codes (page 106).
Use default email Check this field to have this alarm action use the email server configuration
server configuration settings defined on the System Settings > General tab. Uncheck to enter
settings specific to this alarm action.
Mail Host The mailserver's address. This can be an IP address or a system name, such
as mail.mycompany.com.
Mail Host Select the type of security the mailserver uses.
Security Options • Cleartext (SMTP) – Uses the SMTP protocol to send as clear text over
TCP/IP
• Secure SSL (SMTP with SSL) – Uses SSL, a communication protocol that
provides data encryption
• Secure TLS (STARTTLS) – Uses TLS, but does not begin encryption until
the WebCTRL® application issues STARTTLS command
Specify Mail Select if your mailserver requires a username and password.
User For Mail
Host
Authentication
Send mail as MIME Select if your mailserver allows only MIME attachments.
attachment
Message Text Use punctuation, spaces, or returns to format the text. To add live data to the
88
Attach Report Select to attach a report to the e-mail, then select the Report and the
Format. The attached report will include the date and time. For example,
Alarm Sources 2017 Jan 01 1230.
NOTE The Report Name field shows a custom report only if it is accessible at
the current 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.
normal.
a schedule group. *
Occupied.
Unoccupied.

NOTE You should not assign this alarm action to frequently-occurring alarms as this may cause
problems on your network or the Internet.
89
To secure mailserver communication using SSL or TLS
Before the WebCTRL® application sends an email using SSL or TLS, 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 On the WebCTRL® server, click the Windows® Start button.
4 In the Search programs and files field, type the following command:
C:\WebCTRL<x.x>\bin\java\jre\bin\keytool.exe -import -trustcacerts -

alias smtpserver -keystore
webserver\programdata\webserver_base\keystores -file <file_path>
replacing:
<x.x> with the system's version number
<file_path> with the full path and file name of the certificate file
5 The information for the smtpserver key is displayed and you are prompted to trust this certificate.
Type yes.
NOTE If your mailserver is using SSL or TLS, the WebCTRL® server is running antivirus software, and
the email alarm action fails because it cannot find an SSL certificate, do one of the following:
• Disable scanning of outgoing SMTP traffic in the antivirus software. See your antivirus software's
Help for assistance.
• Obtain the antivirus software's SSL certificate and install it on the WebCTRL® server using the
above procedure.
Send SNMP Trap

* This feature is limited to a specific license or optional package. See WebCTRL® editions and optional
packages for more information.
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.
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
<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.
90
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 255 character limit. Type punctuation, spaces, or returns after the entries to
SNMP Trap format the message. You can customize this text by selecting field codes
(page 106) from the Append Field Code list.
normal.
or has not returned to normal. Use this option for alarm escalation.
schedule group.
Occupied.
Under PerformAction, select If schedule group <your new group> is
Unoccupied.
** Ask your network administrator for this information.
91
Send Web Service Request
The Web Service Request alarm action sends a web service request to a third-party server when an
alarm event occurs. For example, the WebCTRL® application could send a request to a work order
system so it could create a work order for someone to respond to the alarm condition.
Field Notes
Destination Address The URL of the server that will receive the request.
Example: https://192.168.168.102/workorder/bas
Web Service Action Select the type of web service request required by the target server:
GET or POST
Content Type If you selected POST in the previous field, select the format required by the
target server:
Application/json or /x-www-form-urlencoded
Web Service Request Optional–Create a parameter for each piece of information that the target
Parameters server requires. You should be able to find information about required
parameters in the target server's documentation.
Parameter Name Enter a name for the parameter. For example, Parm1 or Date.
Click Add Parameter.
Value Text required for the parameter. To add live data to the request, select a
field code (page 106) from the Append Field list.
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.
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 55), but do not assign members to
it.
Under Perform Action, select If schedule group <your new group>
is Occupied.
Under PerformAction, select If schedule group <your new group>
is Unoccupied.
92
Write Property
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 path to the target property. To get the path, right-click the property
on a Properties page, then select Global Modify. The Geographic Location
field in the Advanced section shows the path. Click to copy it.
NOTES
• A BACnet Parameter microblock's present value cannot be written to
directly. However, you can change the present value by writing to the
relinquish_default property, or to the priority_array/priority16 property. For
example, change
#rtu-1/vfd_ovrde/present_value to
#rtu-1/vfd_ovrde/relinquish_default, or
#rtu-1/vfd_ovrde/priority_array/priority16.
• Do not use a BACnet address in this field.
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 Select field codes (page 106) to add this information to the Value to Write
value field.
normal.
schedule group.
Occupied.
Unoccupied.
93
Write to Database
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 that you will
need to access the alarm information from a third-party application.
Description Column Name Data type

Alarm generation time EVENT_TIME_ Datestamp
Path to the alarm source SOURCE_PATH_ String
Example: #slm/m073
Display name path to the alarm source DISPLAY_NAME_ String
Example: Atlanta Office/R&D Facility/Second Floor/VAV 2-
1/Zone Temp
Alarm state EVENT_STATE_ String
Example: OFF NORMAL, LOW LIMIT, HIGH LIMIT
Alarm text as defined in the Text to write to the database field RA_TEXT_ String
on the alarm action page. You can add live data to the text by
selecting field codes (page 106) from the Append Field Code
list.
94
normal.
a schedule group.
Occupied.
Unoccupied.
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 Derby database, you cannot open the database in a third-party
application while the WebCTRL® or SiteBuilder application is running.
95
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, check Specify
Custom Database on the Alarms page Actions tab, then enter information in the remaining fields. See
table below.
Field Notes
Text to write to the The text is made up of field codes (page 106) that add live data to the text.
database 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 For database type... The connect string format is...
String SQL Server jdbc:odbc:<odbc_alias>
MySQL jdbc:mysql://<host>:<port>/<instance>
PostgreSQL jdbc:postgresql://<host>:<port>/<instance>
Oracle 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
Database Login and The login and password to connect to the database.
Password
Database Insert Use the following format:
String 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 106) 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
106) to format the time.
• You can add only one Database Insert String per alarm action.
96
Field Notes
normal.
schedule group.
Occupied.
Unoccupied.
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 to the file you want to write to such as

c:\WebCTRLx.x\webroot\alarms.txt.
• 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 106).
97
Field Notes
Write alarm data Select to record alarm information in a text file.

Select Append to add 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.
In the Text to write to the file, enter the information you want to record for an
alarm. Use punctuation, spaces, or returns to format the text. To add live data
to the text, select field codes (page 106) from the Append Field Code list.
Write a 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 is accessible at
the current 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.
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. *
2. Create a schedule for the group. Set the occupied hours to be the same
as the work hours.
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.

98
Setting up an alarm source in the WebCTRL® interface
The application engineer usually sets up alarm sources in the EIKON® application. In the WebCTRL®
application, you can:
• Edit an existing alarm source’s 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 on the Geographic or Network tree.
This type of microblock... Appears on the Geographic or Network tree as...
To set up, edit, or disable alarm sources

To set up, edit, or disable a single alarm source
1 On the Geographic or Network tree, select the alarm source (microblock).
2 Click Alarms, then select the Enable/Disable tab.
3 Make changes to the fields as needed. The fields can vary for different types of alarm sources. See
table below.
4 Click Accept.
TIP To set up all the alarms for a piece of equipment at once, click Properties, then select Alarm
Sources.
99
Field Notes
Potential alarm Check to enable the alarm source to generate alarms. Uncheck to disable the
source alarm source.
Alarm Check 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 Status is checked, the alarm condition currently exists.

Return to Normal Check to have the alarm source generate a return-to-normal when the alarm
condition returns to a normal state.
Alarm requires Check to have the WebCTRL® application require that an operator
acknowledgment acknowledge the alarm.
Return requires Check to have the WebCTRL® application require that an operator
acknowledgment 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 = Non-critical
Event State The current state of the alarm source can be:
• Normal—value is normal
• Off normal—the value is not normal (binary only)
• Fault—the alarm source microblock may be misconfigured
• High Limit—the value exceeds the normal range (analog only)
• Low Limit—the value is below the normal range (analog only)
BACnet Check to have this alarm immediately delivered through a modem connection.
Configuration: NOTE When monitoring your system through a modem connection, non-
critical alarms are stored in the gateway until one of the following happens:
Dial on alarm • 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
Notification Class Do not change this field.
100
To set up, edit, or disable multiple alarm sources simultaneously
the alarm sources.
2 Click Alarms, then select the Enable/Disable tab.
3 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 check Select
All.
4 In step 2, select the alarm sources.
5 Make appropriate changes in step 3.
6 Click Accept.
NOTE Click View Selected Sources to view or change settings for each alarm.
To simulate an alarm
To test the setup of an alarm source and its alarm actions (page 77), you can simulate an alarm or its
return-to-normal.
1 On the Geographic tree, select the alarm source ( , but not ) whose alarm you want to
simulate.
2 On the Alarms > Enable/Disable tab, check Enable next to Alarm or Return to Normal.
3 Click Simulate next to Alarm or Return to Normal.
4 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 Geographic or Network 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.
101
Customizing alarms
Each alarm source has an alarm message, category, and template defined in the EIKON® 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® 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 77).
To edit the message for an alarm source

1 On the Geographic tree, select the alarm source (microblock).
2 Click Alarms, then select the Messages tab.
NOTE Sample Alarm Message and Sample Return Message show the messages as they are
currently defined.
3 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 106) 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.
4 Click Accept.
102
To add a Prefix or Details for multiple alarm sources
the alarm sources.
2 Click Alarms, then select the Messages tab.
3 In step 1, select the categories that contain the alarm sources whose messages you want to edit.
All.
4 In step 2, select the alarm sources.
5 In step 3, select Add new prefix to beginning of message or Add new details to end of message.
6 Click Add.
7 Type text and add field codes as needed.
8 Click Accept.
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 71) received by the WebCTRL®
application
• Assign alarm actions (page 77) to selected categories of alarm sources
• Set up alarm sources (page 99) in selected categories
Each alarm source is assigned to an alarm category in either the EIKON® application or in the
WebCTRL® interface. See "To use custom alarm and schedule categories" in EIKON® Help.
In addition to the default alarm categories in your system, you can create custom categories if needed.
If you create a custom category in the EIKON® application, you must create the same category in the
WebCTRL® interface. The Reference Name must be identical in both applications.
To assign alarm sources to a category in the WebCTRL® interface

the alarm sources.
2 Click Alarms, then select the Category tab.
3 In step 1, select the category that currently contains the alarm sources.
All.
4 In step 2, select the alarm sources whose category you want to change.
5 In step 3, select a category from the drop-down list, then click Change.
6 Click Accept.
103
To add a custom alarm category
1 On the System Configuration tree, click to the left of Categories.
2 Click Alarm.
3 Click Add. See table below.
4 Click Accept.
Field Notes
Referenc Must be unique in the database, be lowercase, and not contain any spaces. This name
e must be identical to the name of the custom alarm category that you added in the EIKON®
Name application.
Icon Type /_common/lvl5/graphics/event_categories/<file_name>.gif,
replacing <file_name> with the name of the icon file you want to use.
The event_categories folder contains the following alarm icons:
Icons used in the WebCTRL interface: Icons available for custom categories:
Icons File name Icons File nam e
accesscontrol_*.png
hvac_*.png
firesystem_*.png
lightingsystem_*.png
general_alarm_*.png
unknown_*.png
fdd_*.png
fdd_comfort.png
fdd_energy.png
general_message_*.png
module_alarm.png
system_critical_error.png
system_error.png
system_info.png
system_error_closed.png
104
Field Notes
*Represents critical, maintenance, general, or closed
NOTE You can create your own 24 x 24 pixel icon (.gif or .png) and store it in the
event_categories folder. However, your custom file will not be transferred during a
WebCTRL® upgrade, so you will need to copy the file to the new install directory after the
upgrade.
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 acknowledgments at the alarm source in the
EIKON® 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 is not, on the System Configuration
tree, select Privilege Sets, then check Maintain Alarm Templates.
1 On the Geographic 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 Accept.
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 On the System Configuration tree, select Alarm Templates.
2 Click Add.
3 Select Source-based (a v2.5 template) or Stand-alone (a pre-v2.5 template), then click OK.
4 Edit the template fields as needed. See table below.
5 Click Accept.
105
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® 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 acknowledgment.
Return Message Source-based The message text displayed on the View tab or in the alarm
action when a return-to-normal requires acknowledgment.
Fault Message Source-based The message text displayed on the View tab or in the alarm
action when a Fault requires acknowledgment.
Critical Stand-alone Select if this is a template you will use with a critical alarm.
Acknowledgement Stand-alone Select which alarm states require an acknowledgment.

Required
Out of Range Stand-alone Analog inputs and outputs that have low and high limit
alarm properties.
Click 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 Stand-alone To add a field code to any of the message text fields:
Clipboard 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.
106
Formatting 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.
Example
format_type style
To format a N The actual formatting, To always round a setpoint

number such as ##.##. The basic value to two digits to the right
format uses the pound of the decimal, the field code
sign (#) to represent a is:
number. For more $setpoint_value%N:##.##$
information, search the For example, 78.9935
Internet for "customizing becomes 78.99.
number formats with
java".
To format D The actual formatting, To show the date and time
date/time such as MM/dd/yyyy when an alarm is generated in
hh:mm:ss. For more a format like 03/15/2004
information, search the 10:50:43, the field code is:
Internet for "customizing $generation_time%D:MM/dd/
date time formats with yyyy hh:mm:ss$
java".
To set alignment L for left align Indicate the field width by To left align the name of the
and field width R for right align number of characters. device that generated the
C for center align 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$
NOTE You must enter the date/time or number formatting command before the alignment/field width
command.
107
Field codes
Field Code Field Code Description

Name
Acknowledge $acknowledge_operator$ The operator who acknowledged the alarm.
Operator EXAMPLE John Doe
Acknowledge $acknowledge_time$ The time when the operator acknowledged the alarm.
Time EXAMPLE Nov 12, 2012 6:46:31 PM
Alarm $alarm_category$ The alarm category that the alarm is assigned to.
Category EXAMPLE HVAC Critical
Alarm Priority $alarm_priority$ The priority number associated with the alarm's priority (Off-
Normal, Fault, or Normal) on the controller's Driver >
Notification Class page.
Alarm $alarm_template$ The alarm template that the alarm is assigned to.
Template EXAMPLE Universal
Alarm Type $alarm_type$ The alarm type of the alarm source.
EXAMPLE CHANGE OF STATE
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.
EXAMPLE $C:65$ displays A
Command $command_value$ The commanded value from the alarm source. Valid only for
Value alarm type COMMAND FAILURE.
EXAMPLE 3
Control $equipment$ The display name of the equipment where the alarm came
Program from.
EXAMPLE Chiller
Controller $device$ The display name of the device where the alarm came
from.
EXAMPLE SE6104
Dead Band $deadband$ The deadband value from the alarm source. Valid only for
alarm type OUT-OF-RANGE.
EXAMPLE 5
Deletion $deletion_operator$ The operator who deleted the alarm.
108
Name
Deletion $deletion_time$ The time the alarm was deleted.
Error Limit $error_limit$ The error limit, from the alarm source. Valid only for alarm
type FLOATING LIMIT.
EXAMPLE 90
Event Values $event_values$ Returns a string of alarm values associated with the alarm.
Exceeded $exceeded_limit$ The exceeded limit value from the alarm source. Valid only
Limit for alarm type OUT-OF-RANGE.
EXAMPLE 90
Exceeding $exceeding_value$ The exceeding value from the alarm source. Valid only for
Value alarm type OUT-OF-RANGE.
EXAMPLE 91
Fault $fault$ The status of the fault condition from the alarm source.
EXAMPLE True or false
Field $field_message$ Text generated in the alarm by the controller.
Message
Feedback $feedback_value$ The feedback value from the alarm source. Valid only for
Value alarm type COMMAND FAILURE.
EXAMPLE 10
From State $from_state$ The previous state of the alarm source.
EXAMPLES NORMAL, FAULT, OFF NORMAL, HIGH LIMIT,
LOW LIMIT
Generation $generation_operator$ The operator who forced the alarm to return to normal.
Generation $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 $incident_closed_time$ The time the alarm's entire incident group closed.
Closed Time EXAMPLE Nov 12, 2012 6:46:31 PM
Latched Data $latched_data_analog:x$ "x" ranges from 1 to 10.
Value Returns a numerical value.
(Analog) Use for legacy systems.
Latched Data $latched_data_digital:x$ "x" ranges from 1 to 10.
Value Returns On or Off.
(Digital) Use for legacy systems.
Location Path $location_path$ Displays the path display names from root to source.
EXAMPLE Building B / Basement / VAV AHU B / SSP_STOP
The number of levels in the path is based on the System
Settings field Levels displayed in paths. To override this
setting, enter the field code as $location_path:#$,
substituting # with the number of path levels you want to
show. For example, $location_path:5$ will show 5 levels.
109
Name
Long $long_message$ The formatted alarm long text displayed by double-clicking
Message the alarm on the Alarms page.
Message $message_details$ The message details displayed on the Alarms page View
Details tab.
Message $message_prefix$ The message prefix displayed on the Alarms page View tab.
Prefix
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. Valid only
for alarm type CHANGE OF STATE.
EXAMPLE Alarm, Fault
New Value $new_value$ The new value from the alarm source. Valid only for alarm
type CHANGE OF VALUE.
EXAMPLE 70
Notification $notification_class$ The notification class assigned denotes how the received
Class alarm was generated. For example, if set to 1, the alarm
would typically be sent to WebCTRL by Automated Logic®
controllers.
Object ID $object_ID$ Object ID of the alarm source.
EXAMPLE 5:26
Out of $out_of_service$ The status of 'out of service' from the alarm source.
Service EXAMPLE True or false
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 2423101,1
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.
EXAMPLE Nov 12, 2012 6:46:31 PM
Recipient $device_id$ The device ID of the device where the alarm came from.
Device ID EXAMPLE 8:2423101
Record Type $record_type$ The type of alarm.
EXAMPLE BACnet, Supervision®, System
Reference $reference_path$ Path to alarm source. Available in all alarm actions.
Path EXAMPLE #e_b_vav_ahu_b/ssp_stop
Reference $reference_value$ The 'reference value' from the alarm source. Valid only for
Value alarm type FLOATING LIMIT.
EXAMPLE 83
110
Name
Referenced $referenced_bitstring$ The value of the 'referenced bitstring' value from the alarm
Bitstring source. Valid only for alarm type CHANGE OF BITSTRING.
EXAMPLE 1011011101101
RTN Time $RTN_time$ The time when the alarm returned to normal.
EXAMPLE Nov 12, 2012 6:46:31 PM
Setpoint $setpoint_value$ The 'setpoint value' from the alarm source. Valid only for
Value alarm type FLOATING LIMIT.
EXAMPLE 72
Short $short_message$ The formatted alarm short text.
Message
Site $site$ The display name of the site the alarm came from.
EXAMPLE Kennesaw
Source $source$ The display name of the alarm source microblock that
generated the alarm.
EXAMPLE SAT_HI
Source $source:description$ The Description field of the alarm source microblock that
description generated the alarm.
EXAMPLE High Cooling Supply Air Temp
Source Path $source:<path>$ Substitute <path> with the path to the value you want to
display. See Defining WebCTRL® paths (page 206).
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$
NOTES
• You can use Global Modify (page 34) to get the path.
• For legacy systems, use the latched data field codes.
System $system_dir$ The system folder name.
Directory EXAMPLE c:\WebCTRLx.x\programdata\systems\
world_corporation
To State $to_state$ The current state of the alarm source.
EXAMPLES NORMAL, FAULT, OFF NORMAL, HIGH LIMIT,
LOW LIMIT
111
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.
The Graphics page can replay only trended values. Values that are not trended are grayed out.
Floorplan areas without trend data are dark gray.
NOTES
• If a graphic is linked to a microblock value without an embedded trend but a Digital Trend or Analog
Trend microblock is attached to the linked microblock by a wire, Time-lapse will use the wire trend's
value.
When the graphic is viewed in Time-Lapse:
• The data in a data table or chart will not change.
• A color map will ignore report data and show thermographic colors.
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 on the tree where you want to see the time-lapse.
2 Click at the top of the page.

3 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.
4 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.
5 Click Accept. The time-lapse immediately begins to play.
6 Use the following items to work with the time-lapse.
112
TIP You can enable historical trending for trended values to have more trend data available in Time-
lapse and to have the data retrieved faster.
NOTES
• While in time-lapse, you can navigate to other locations in the tree.
• 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

2 On the General tab under Trends, do one of the following:
○ In the Poll Interval field, change the frequency that the server collects color trend data from
the routers.
NOTE Last Poll Duration shows how long the last polling of the routers took.
○ If directed by Automated Logic® Technical Support, uncheck Enable Server Trending of Color
to stop color collection.
3 Click Accept.
113
Reports
Use WebCTRL® reports to monitor and troubleshoot your system. Your WebCTRL® license and/or
edition determines which of the following things you can do in the WebCTRL® interface. You can:
• Run preconfigured reports
• Run custom reports
• Schedule reports
• Create custom reports
See WebCTRL® editions and optional packages.
Preconfigured reports
The preconfigured reports shown in the Reports button drop-down list vary depending on which tree
you selected.
In the Geographic tree: In the Network tree:
A preconfigured report shows data for the selected tree item and all of its children.
This preconfigured allows you to...

report...
Alarms
Alarm Actions Create a summary of the information configured on the Alarms > Actions
(page 77) tab.
Alarm Prefixes & Details Create a summary of the information configured on the Alarms >
Messages (page 102) tab.
Alarm Sources Create a summary of potential alarm sources as configured on the
Alarms > Enable/Disable (page 99) tab.
Alarms View, sort, and filter the information on the Alarms View (page 71) tab.
114
report...
Commissioning
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.
Test & Balance View the results of VAV box commissioning. Running this report
automatically uploads calibration parameters to the WebCTRL®
application.
Equipment
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 points—especially
useful for commissioning controllers used for third-party integration.
Parameter Mismatch Discover where your system has parameter mismatches that need to be
resolved.
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.
Trend Usage Creates a summary of the information configured on the Trends >
Enable/Disable (page 63) tab.
Life Sciences * These options may be limited to a specific license or optional package.
See WebCTRL® editions and optional packages for more information.
MKT Calculates Mean Kinetic Temperature (MKT) for selected temperature
trends over a selected time period.
Trend Value Lists trend sample values for selected trends logged over a selected
time period.
Out of Range Calculates the number of occurrences and the duration (in hours) that
selected trends deviated outside configured min/max values over a
selected time period. See To configure Out of Range reports with
Semantics (page 120) for details on report parameters.
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.
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.
* These options may be limited to a specific license or optional package.
Security See WebCTRL® editions and optional packages for more information.
115
report...
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.
Operator Information Lists operator name, login name, date of last login, date of last password
change, password exemption status, auto logoff setting, ready to e-sign
status, system-wide privilege sets, and starting location.
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 on the System Configuration
tree, login/logout, login failures, and scheduled processes like deleting
expired trends.
Network
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.
Equipment Status Display the thermographic color, status, and prime variable of each
control program.
Quarantine Summary * This option may be limited to a specific license or optional package.
Report See WebCTRL® editions and optional packages for more information.
Provides a summary of trend data that has been quarantined due to
recording discrepancies (switching from daylight saving time, changing a
timezone, etc).
This report is available in the Reports menu once you select a System or
Area in the Geographic tree.
Quarantine Detail Report Lists trend data that has been quarantined due to recording
discrepancies (switching from daylight saving time, changing a timezone,
etc).
This report is available in the Reports menu once you select a piece of
Equipment in the Geographic tree.
116
To run a preconfigured report
1 Select an item on the Geographic or Network tree.
2 Click the Reports button drop-down arrow, then select a report.
3 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.
○ To create a CSV (Comma Separated Values) file after you run the report, select Support CSV
text format. See To create a report PDF, XLS, or CSV file (page 161).
○ The current operator's report options are saved so that when that operator logs in again, the
same options are used.
4 Click Run.
NOTE Click Schedule to schedule the report to run on a recurring basis. See Scheduling reports (page
162).
To run an ad hoc report

Follow these steps to run a single ad hoc version of an Alarms, Life Sciences, or Security report.
1 Click the Reports drop-down arrow, and then select the report that you want to schedule.
○ Alarms > Alarms
○ Life Sciences*
▪ MKT
▪ Trend Value
▪ Out of Range
○ Security Reports
▪ Location Audit Log
▪ System Audit Log
2 Go to the Options tab.
3 In the Ad Hoc Report section, select the time span of the report.
Date range option Description
Unrestricted The report contains all data for the entire duration of available
dates.
Continuous Data (Date) The report contains all data occurring between the specified Start
and End dates.
Continuous Data (Date The report contains only the data occurring between the specified
and Time) Start Date and Time and End Date and Time.
Shift Report* The report contains only the data occurring between the specified
Shift Start and End Times within the specified date range.
117
4 For Life Sciences* reports, select any of the following options.
Report Option Description
MKT Choose trend You can select your trend sources:
Out of sources i. For a Trend Value report, click Select Trends. For an MKT or
Range Out of Range report, skip to the next step.
Trend ii. Under Trend Sources, click Choose Trends, and then select
Value your sources.
iii. To limit the report to specific locations, check only the
locations desired. Clicking Refresh checks any boxes that have
been unchecked.
NOTE To calculate Mean Kinetic Temperature on the MKT and
Out of Range reports, all trend samples should be in Celsius.
Out of Out of range See To configure Out of Range reports with Semantics (page
Range parameters 120) for a complete description.
Trend Report quarantine Check Report quarantine data to include a report of trend data
Value data that has been quarantined due to recording discrepancies.
Trend Custom reporting You can choose a custom reporting interval. If you do not select
Value interval a custom interval, every sample value in the database for the
defined time range will appear on the report.
i. Check Report by custom interval.
ii. Enter the interval and select the interval type (Hours,
Minutes, Seconds).
Trend Min/Max Adds a "Range" header to the top of each trend column in the
Value report for which Min/Max is checked. Values outside the
Min/Max range appear as bold.
i. Check Min/Max.
ii. Enter the Min Value and Max Value.
Trend Min/Max Change To set multiple Min/Max values at once:
Value Multiple Values i. Alt + click a Min/Max value.
ii. Check Enable next to the trends you want to modify.
iii. Enter the desired value in New Value.
iv. Click Apply Changes.
To modify all Min/Max values:

i. Check Enable All.
ii. Enter the desired value and click Set All To.
iii. Alternately, enter the amount you want to modify the value
by, and click Change All By. The value changes by that amount
every time you click.
5. Click Accept, and then click Run.
For Alarms or Security reports, changes made here affect ad hoc report settings for the selected
report in all locations. Life Sciences settings are specific to each location.
118
To configure scheduled Alarms, Security, and Life Sciences reports
The following reports have additional scheduling options available. Scheduling these reports without
configuring schedule options results in an error; see View History in To manage scheduled reports
(page 163).
• Alarms > Alarms
• Life Sciences*
○ MKT
○ Trend Value
○ Out of Range
• Security Reports
○ Location Audit Log
○ System Audit Log
1 Go to the Options tab, open Scheduled Report, and check Enable schedule options for this
location.
2 Select the time span of the report.
Date range option Description
Continuous Data (Date) The report contains all data occurring between the specified Start
and End dates.
Continuous Data (Date The report contains only the data occurring between the specified
and Time) Start Date and Time and End Date and Time.
Shift Report* The report contains only the data occurring between the specified
Shift Start and End Times within the specified date range.
3 Select the number of Days, Weeks, Months, Quarters, or Years the report will contain.
NOTES
○ The use of "previous": Selecting "previous week" returns data for the previous full calendar
week, Sunday through Saturday. Select "previous 7 days" to see the most recent week of data.
For example, selecting "previous 7 days" on a Wednesday returns data from last Wednesday
through the current Tuesday.
○ Checking include current causes the report to contain data for the most recent iteration of the
report. For example, a report for the previous week with the include current option checked
contains only the data for the current week, even if it is not a complete week. In order to get
the last week and the current week, it would be necessary to specify the previous 2 weeks.
4 For Life Sciences* reports, select any of the following options.
MKT Choose You can select your trend sources:
Out of trend i. For a Trend Value report, click Select Trends. For an MKT or
Range sources Out of Range report, skip to the next step.
Trend ii. Under Trend Sources, click Choose Trends, and then select
Value your sources.
iii. To limit the report to specific locations, check only the
locations desired. Clicking Refresh checks any boxes that
have been unchecked.
NOTE To calculate Mean Kinetic Temperature on the MKT and
Out of Range reports, all trend samples should be in Celsius.
119
Out of Out of range See To configure Out of Range reports with Semantics (page
Range parameters 120) for a complete description.
Trend Custom You can choose a custom reporting interval. If you do not
Value reporting select a custom interval, every sample value in the database
interval for the defined time range will appear on the report.
i. Check Report by custom interval.
ii. Enter the interval and select the interval type (Hours,
Minutes, Seconds).
Trend Min/Max Adds a "Range" header to the top of each trend column in the
Value report for which Min/Max is checked. Values outside the
Min/Max range appear as bold.
i. Check Min/Max.
ii. Enter the Min Value and Max Value.
Trend Min/Max To set multiple Min/Max values at once:
Value Change i. Alt + click a Min/Max value.
Multiple
ii. Check Enable next to the trends you want to modify.
Values
iii. Enter the desired value in New Value.
To modify all Min/Max values:

i. Check Enable All.
ii. Enter the desired value and click Set All To.
iii. Alternately, enter the amount you want to modify the value
by, and click Change All By. The value changes by that amount
every time you click.
5. Click Accept.
NOTE Changes made here affect the selected scheduled report in the current location only.
To configure Out of Range reports with Semantics

An Out of Range (OoR) report calculates the number of occurrences and the duration that selected
trends deviated outside configured min/max values over a selected time period. Follow the instructions
below to configure OoR reports using Semantics (page 170) tagging.
• Only a single probe per .equipment file should be included in an OoR report.
• Each trend included in the OoR report must be associated with a set of semantic tags representing
the high and low range values, and the time (in minutes) after which a diversion outside the range
is considered an out of range incident.
• The location the tags are defined depends upon the organization of your equipment, and the
uniformity of how out of range values are used throughout the system.
120
OoR Report Tags
Marker tags
For each trend in your report an OoR marker tag must be assigned. All OoR marker tags must start with
"oor". Four value tags must be associated with the OoR marker tag by name; for example, if the marker
is oor_cooler, the associated value tags would be oor_cooler_low, oor_cooler_high,
oor_cooler_low_delay, and oor_cooler_high_delay.
Value tags
Below are the four value tags that need to be defined for each trend in your report.
Parameter Definition
Low Lowest acceptable value
High Highest acceptable value
Low delay Time (in minutes) the trend must be below the Low value to be
considered out of range
High delay Time (in minutes) the trend must be above the High value to be
considered out of range
Semantic tags can be assigned at any level in the tree. A full set of four value tags must be used for
each trend source’s designated OoR marker tag, but the value tags do not have to be at the same
location in the tree. For example, when Delay values can be used more generically than range values,
the delay values may be defined higher in the tree than the High and Low values.
For each trend source in the report, the program searches for the first OoR marker tag, starting at the
microblock level and moving upward. Once the marker tag is found, the system searches for the
associated value tags, starting at the microblock level for each of the four value tags.
Built-in tags
The table below contains the built-in tags that are provided with the Life Sciences license.
ID Display Name Type
oor Oor Marker
oor_high Oor High Value
oor_low Oor Low Value
oor_high_delay Oor High Delay Value
oor_low_delay Oor Low Delay Value
121
Custom tags
Custom tags must start with "oor"; for example, if you create marker oorfreezer, the associated
value tags would be oorfreezer_low, oorfreezer_high, oorfreezer_low_delay, and
oorfreezer_high_delay. If the oorfreezer marker tag was identified for a trend source, the
system must find all four oorfreezer_* value tags.
NOTES
• Any of these tags can be assigned by the customer at any level in the tree. They can also be
assigned using a reference name rule.
• It is possible to use a mixture of built-in and custom OoR marker tags. The OoR marker tag closest
to the trend point is the one that is used.
• If no OoR marker tags are assigned, the built-in “oor” marker tag is assumed by default. The
system searches for the associated value tags, starting at the microblock level for each of the four
built-in “oor” value tags.
• Only a single OoR marker tag can be used at a single location.
Custom reports
Custom reports are managed through the WebCTRL® Report Manager that shows a list of all custom
reports in your system. In the Report Manager, you can:
• Create a new custom report (page 123)
• Copy an existing report as a starting point for a new report (page 123)
• Edit or delete an existing report (page 144)
• Export report(s) to a file so that it can be imported into another system (page 145)
A custom report can provide data for a data table (page 147), chart (page 152), or color map (page
156) on a Graphics page.
NOTES
• A custom report may appear in the Report Manager but not appear in the Reports button menu
because its only purpose may be to provide data to an item on a Graphics page.
• To support upgraded systems, you can still create and access legacy (v6.5 and earlier) custom
reports (page 165). These reports appear only in the Reports button drop-down menu, but not in
the Reports Manager.
122
Creating a custom report
1 Click the Reports drop-down arrow, and then select Report Manager.
2 Click Add.
TIPS
○ To save time when making a report that is similar to an existing report, select the existing
report in the Report Manager, and then click Copy. The Report Editor opens the new report so
that you can make changes.
○ Click on the Display Name or ID heading in the Report Manager to sort the column.
3 Enter information on the following Report Editor tabs until you have created the report.
○ Type tab (page 123)
○ Columns tab (page 127)
○ Variables tab (page 139)
○ Where tab (page 140)
○ Options tab (page 140)
○ Output tab (page 141)
NOTES
• As you create your report, you can use the Preview section on each tab to check your work. See To
preview a report (page 144).
• After you create the report, you can go to any item in the tree where the report is accessible, and
run it. See To run a custom report (page 144).
• A report can have a maximum of 50 columns and 1000 rows.
CAUTION As you move from tab to tab in the Report Editor, click Apply to save your changes on a
tab. If you click Cancel on a tab, all unsaved changes on any tab will be lost. Tabs that have unsaved
changes have a pencil icon beside the tab name. For example, .
Type tab
1 Enter the necessary information about the report you are creating. See table below.
2 Click Accept or Apply.
Field Notes
Display name The name that will appear in the Reports button drop-down list.
ID A unique ID for the report (letters, numbers, underscores, and hyphens only;
no spaces or special characters).
123
Field Notes
Show in Reports By default, the report name will appear directly in the Reports button drop-
menu down list, not in a category. You can:
• Check this box and then select a category for the report. See To organize
custom reports by category (page 146).
• Uncheck this box so that this report does not appear in the Reports button
drop-down list. For example, you could uncheck this box if the report will
provide data to a Graphics page but does not provide valuable information
as a stand-alone report.
Primary column Select the type of information that you want the report to be based on.
NOTE If you change your initial selection, click Change to have your new
selection take effect.
Select... Then...
Control Programs Do one or both of the following to create the list of

control programs. The primary column will list the
equipment that use those control programs.
• Enter a control program name, and then click Add.
You can use wildcards. See the help text to the
right of this field.
• Select from the list of existing control programs.
Locations Do one or both of the following to create the list of
locations that will appear on each row in the primary
column:
• Select locations in the Geographic or Network
tree.
• Enter a location name, and then click Add.
Reference Names Enter a reference name and then click Add. You can
use wildcards. See the help text to the right of this
field.
Add more reference names, if desired, to build a list of
reference names. The primary column will list the
locations that have the reference names.
Select the type(s) of reference names that you added.
124
Field Notes
Tag Names To create the list based on tagged locations for each
row in the primary column of the report:
1 Click to the left in the list of system tags to

add that tag to the Tag Names table.
NOTE To combine several tags for a single location,
keep clicking next to each tag you want.
2 Click Add to assign the selected tag(s) to the list of
tag names to use for a location.
3 Check the type(s) of locations (Area, Equipment,
Microblock) that you want in the column.
4 Click Apply.
The locations selected for the report will be those that
match any row of tag names.
For example, to get a report of locations tagged
Chilled Water and Hot Water:
1 Click next to Chilled.
2 Click next to Water.

3 Click Add.
4 Click next to Hot.
5 Click next to Water.

6 Click Add.
125
Field Notes
Date Range Choose one of the following:
• Previous: A specified number of previous days,
weeks, months, quarters, or years. You can choose
to include the current time period.
• From date: A specified number of days, weeks,
months, quarters, or years starting at a specific
date (yyyy/mm/dd).
NOTE You can enter a value or variable name in the
fields for these 2 options. If you enter a variable, it
must be defined on the Variables tab (page 139).
Frequency: If you choose Months or Days in the
Previous or From date fields, you can choose how
often the data is to be reported. For example, if you
choose a frequency of Every 15 minutes, the primary
column could look similar to the following:
Date Range format in report: Type the date format

that you want to see in the report. See Date formats
(page 127) for a list of supported formats.
Existing Report Select an existing report from the drop-down list or
enter a report name in the text field. The existing
report will be embedded in the new report so that you
can add columns to it. Any changes to the existing
report will also be reflected in the new report.
Color Map Select this option to show colors on a Graphics page.
For example, you could have a campus map where
each building would show green for good energy
usage or red for high energy usage. See To produce a
color map (page 156).
Hide Primary column Check to have this column not appear in the report.
in report
Primary column If you do not hide the Primary column, type the header that you want to
header appear at the top of this column.
126
Date formats
If your Primary column is a Date Range, use the following information to enter a format in the Date
Range format in report field.
For Type... Example

Year yyyy 2017
yy 17
Month MMMM September
MMM Sep
MM 9
Week in year w 27
Week in month W 2
Day in year D 189
Day in month d 12
Day of week in month F 2 (2nd Thursday in June)
Day name EEEE Tuesday
E Tue
Day number in week u 1 (Monday), 2 (Tuesday), etc.
Examples of combinations:
yyyy-MM-dd = 2017-06-02
MMMM yy = June 17
MMM/yyyy = Jun/2017
MM/dd/yy D = 06/02/17 153
NOTES
• To include a single quote, type two single quotes. Example: MMM ''yy = Jun '17
• To include static text, enclose it in single quotes. Example: 'Year' yyyy = Year 2017
• For more information on date formats, search the Internet for "java simple date format".
Columns tab
The Primary column for a table is defined on the Type tab. You define the remaining columns on the
Columns tab. To define the columns in your report, you can:
• Add each individual column (page 128)
• Copy an existing column (page 130)
• Replicate a column (Trend Data only) (page 130)
127
To add a column
1 Click Add.
2 Enter or select options in the first four fields that appear. See table below.
3 Select an option in the Column data is from field. See the gray rows in the table below for a
description of the options.
NOTE If you change your initial selection, click Change to have your new selection take effect.
4 Select or enter information for the option you chose in step 1. See table below.
Field Notes
The following four fields are common to all of the options from step 1 above.
Display name The name that will be shown in the report as the column's header.
ID A unique ID for the column (letters, numbers, underscores, and
hyphens only; no spaces or special characters).
Render data as Value Shows a value in the report.
Hidden Hides the column in the report. The column's data can be
used to produce a value for another cell.
Color Uses the column's value to determine a color on a color map
(page 156). Set the Column data is from field to Expression
or Function, and then enter the appropriate information that
returns a color value.
Icon Shows an icon to indicate a certain condition. Set the
Column data is from field to Expression, and then enter an
expression that says what icon filename to show for a
particular condition. You can use the icons included with
your system or you can create custom icons. See Icons for
more information.
Column format Lets you define the column's alignment, width, and format of digits.
NOTE Column format does not apply if you select Hidden or Color in
the Render data as field.
The following fields are based on your selection in the Column data is from field.
Path The column's output will be based on a path to a value in the
WebCTRL® system.
Path Enter the path to the value you want. See Defining WebCTRL® paths
(page 206).
Show value as text Check to have the value reported as text instead of its numerical
value. For example, show the word On instead of 1.
128
Field Notes
Expression The column's output will be based on the result of an expression (page
131).
Trend Data The column's output will be based on a value calculated from a range
of trend data.
Trend path Do one of the following:
• Click the Select Trend Path button to choose the trended point.
Typically, you want the full (absolute) path, but if needed, you can
choose to get the relative path.
• Type the path to the trend that you want the report to pull data
from.
See Defining WebCTRL® paths (page 206).
Operation Select the type of value or calculation that you want the column to
show. See Operations (page 137) for a description of each option.
Interval sample If the selected operation allows, you can choose how to handle the
first and last sample of the time period. For example, Include start
time / exclude end time.
Database trends only Check to include only trends saved in the database, not those in the
controller.
Show time of sample Check to include the time of the sample in the column.
Time range From primary You can use this option if the report's primary
column column is a date range.
From column You use this option if your report began with an
embedded external report that has a column
containing date ranges.
Value A time period specified by entering a Start date and
End date.
Past Enter a number of days, weeks, months, quarters,
and years in the past. You can select whether or not
to include the current time period.
NOTE You can use a variable (page 139) for a Time range count or
date field. The variable must be defined on the Variables tab.
Function The column's output will be based on the value or manipulation of the
value from another column.
Input column The column that you want to perform a function on.
Function Select an option in the drop-down list. See Functions (page 135).
Arguments A statement that contains the criteria of the function. See Functions
(page 135) for argument formats and examples.
NOTE You can use a variable (page 139) name in the argument. The
variable must be defined on the Variables tab.
129
Field Notes
+/- Date Range The column's output will be based on the date range you choose.
Adjust by Adjusts the data by this many days, weeks, months, quarters, or years.
Enter a value or variable name.
From column Enter the Column ID of the date range you want to adjust. To adjust
the primary date range, leave this field blank.
NOTES
• To delete a column, select the column in the table at the top of the page, then click Delete.
• To change the order of the columns, select a column and then click or to move the column.
To copy a column
1 Select the column you want to copy in the table at the top of the Columns tab.
2 Click the Copy button.
3 Change the column's fields as needed. See field descriptions in To add a column (page 128).
NOTE The column's ID is incremented by 1.
To replicate a Trend Data column

When you have defined all the criteria for a trend column, you can quickly reproduce that column for
other trend sources.
1 Select the column in the table at the top of the Columns tab.
2 Click the Replicate Column button.
3 Select whether you want the Trend Path for the new columns to be the full (absolute) path or the
relative path. Typically, you will leave this set on Full path. See Defining WebCTRL® paths (page
206).
4 In the left column, select a location.
5 The right column displays all trend sources at or below the selected location. Select the trend
sources that you want. A column will be added for each instance of the selected trend sources at or
below the selected location.
6 Repeat steps 4 and 5 for any additional locations and points that you want in you report.
7 Click Apply.
8 Click Close.
9 Change each column's fields as needed. See field descriptions in To add a column (page 128).
130
Expressions
On the Report Editor's Columns tab, you can specify that a column's data is from an expression.
WebCTRL® expressions are similar to expressions used in spreadsheet programs. The most basic
expression is a math calculation, but an expression can also manipulate text.
An expression generally consists of at least one item in dollar signs and an operator. See table below.
The item in dollar signs can be:
• Another column's ID
• A path to an item in your system or a semantic tag
• A variable defined on the Report Editor's Variables tab
Static text in an expression must be enclosed with quotes (either single or double quotes can be used).
Any item that results in text should also be enclosed with quotes. This example shows both
situations: 'Filter is ' + '$filter_status$'
Example of a simple expression to compute the average value of min_temp and max_temp columns
Expression: ($min_temp$ + $max_temp$) / 2
To verify that the expression you entered is formatted correctly, click Check Syntax. The result appears
to the right of the button. The first error's numerical position in the expression appears and the error is
highlighted.
NOTE The result of checking an expression with a variable may not be accurate since variables can be
used in such a wide variety of ways.
Operators
An operator defines how each piece of an expression is to be handled. The following table lists
operators that can be used in expressions.
Operators that return true/false (1/0)
< Less than Compares numeric data. Returns true if the value to the left of the
operator is smaller than the value to the right.
> Greater than Compares numeric data. Returns true if the value to the left of the
operator is larger than the value to the right.
<= Less than or equal to Compares numeric data. Returns true if the value to the left of the
operator is smaller than or equal to the value to the right.
>= Greater than or equal to Compares numeric data. Returns true if the value to the left of the
operator is larger than or equal to the value to the right.
! Not Evaluates the expression and returns the opposite.
Example: !$zone_temp$ > 72
If zone_temp is greater than 72, the expression is false. If zone_temp is
not greater than 72, the expression is true.
== Equal to Compares data. Returns true if the value on both sides of the operator
are equal.
!= Not equal to Compares data. Returns true if the value to the left of the operator does
not match the value to the right.
&& And Combines expressions. Returns true if the expressions on both sides of
&& result in true.
|| Or Combines expressions. Returns true if the expression on either side or
both sides of the operator results in true.
131
Operators that return a numeric value
+ Add Adds numeric data, expressions, or values.
NOTE You can use this operator to concatenate mixed numbers and
strings. Example: 1 + 'alpha' returns "1alpha".
- Subtract Subtracts numeric data, expressions, or values.
* Multiply Multiplies numeric data, expressions, or values.
^ Power To the power of.
Example: 2^3 (returns 8)
/ Divide Divides numeric data, expressions, or values.
% Modulus Finds the remainder in the division of numeric data, expressions, or
values.
Other operators
() Parentheses Use to nest expressions. Operations in parentheses are evaluated
before those outside parentheses.
if Syntax: if (expression, true value, false value)
Expression is evaluated and if 1/true, the true value is returned,
otherwise the false value is returned
? Ternary Syntax: <condition> ? <expression to execute if the condition is true> :
<expression to execute if the condition is false>
This operator can be used as an alternative to an if statement.
Example: 1 == 2 ? 'true' : 'false'
# Comment Use to make the characters in the line after this operator a comment
NOTE If no operator is present in an expression, "+" is assumed. Example: "1 2 3" returns "6", and "a b
c" returns "abc".
Combining expressions
Example 1:
Expression: $zone_temp$ < 60 || $zone_temp$ > 75
Translation: True if the current zone temperature is less than 60 or greater than 75
Example 2:
Expression: ! ( $ai1/locked$ || $ai1/present_value$ > 100 )
Translation: True if ai1 is not locked and al's present value is not greater than 100
Example 3:
Expression: if ($zone_temp$ < 60 || $zone_temp$ > 75, 'out of range', 'good')
Translation: If zone temperature is less than 60 or greater than 75, show out of range. Otherwise, show
good.
132
Math functions
Function Description
abs (a) Returns the absolute value of a value.
acos (a) Returns the arc cosine of a value; the returned angle is in the range 0.0
through pi.
asin (a) Returns the arc sine of a value; the returned angle is in the range -pi/2
through pi/2.
atan (a) Returns the arc tangent of a value; the returned angle is in the range -pi/2
through pi/2.
atan2 (y, x) Returns the angle theta from the conversion of rectangular coordinates (x, y)
to polar coordinates (r, theta).
cbrt (a) Returns the cube root of a value.
ceil (a) Returns the smallest (closest to negative infinity) value that is greater than or
equal to the argument and is equal to a mathematical integer.
cos (a) Returns the trigonometric cosine of an angle.
exp (a) Returns Euler's number e raised to the power of a value.
floor (a) Returns the largest (closest to positive infinity) value that is less than or
equal to the argument and is equal to a mathematical integer.
hypot (x, y) Returns sqrt(x2 +y2) without intermediate overflow or underflow.
IEEEremainder (f1, f2) Computes the remainder operation on two arguments as prescribed by the
IEEE 754 standard.
log (a) Returns the natural logarithm (base e) of a value.
log10 (a) Returns the base 10 logarithm of a value.
max (a, b) Returns the greater of two values.
min (a, b) Returns the smaller of two values.
pow (a, b) Returns the value of the first argument raised to the power of the second
argument.
random () Returns a value with a positive sign, greater than or equal to 0.0 and less
than 1.0.
rint (a) Returns the value that is closest in value to the argument and is equal to a
mathematical integer.
round (a) Returns the closest long to the argument, with ties rounding to positive
infinity.
sin (a) Returns the trigonometric sine of an angle.
signum (float f) Returns the signum function of the argument; zero if the argument is zero,
1.0f if the argument is greater than zero, -1.0f if the argument is less than
zero.
sqrt (a) Returns the correctly rounded positive square root of a value.
tan (a) Returns the trigonometric tangent of an angle.
133
toDegrees (angrad) Converts an angle measured in radians to an approximately equivalent angle
measured in degrees.
toRadians (angdeg) Converts an angle measured in degrees to an approximately equivalent
angle measured in radians.
Text functions
char (code) Returns a single character string for the given Unicode character code. For
example, char(36) will create the string "$".
charAT (s, pos) Returns the character and the position.
compareTo (s1, s2) Compares two strings. <0 if s1 <s2, 0 if s1 == s2, >0 if s1 > s2
compartToIgnoreCase Compares two strings ignoring case. <0 if s1 <s2, 0 if s1 == s2, >0 if s1 > s2
(s1, s2)
concat (s1, s2, ...) Concatenates the two or more strings together. Same as "s1 + s2 + "
dateDiff (s1, s2) Returns the difference between two dates, in days. Parameters may be date
variables or strings of format 'yyyy/mm/dd'
endsWith (s1, s2) Returns "1" if s1 ends with the string s2, else "0".
equals (s1, s2) Returns "1" if strings are equal, else "0".
equalsIgnoreCase Returns "1" if strings are equal ignoring case, else "0".
(s1, s2)
indexOf (s1, s2, start) Returns the index (position) of the first occurrence of the second string in the
first string after "start" position. Use 0 to start from beginning of string. It
returns -1 if S2 is not found.
lastIndexOf (s1, s2) Returns the index (position) of the last occurrence of the seconds string in
the first string. It returns -1 if S2 is not found.
length (s1) Returns the length of the strings.
newline() Inserts a return.
or
\n
now (s1) Returns the current time and accepts one time-format string based on "Java
SimpleDateFormat". If the string is empty, the default system date and time
format is used. Examples:
○ "" → 08/28/2020 8:56:59 AM
○ "EEEE" → "Friday"
○ "MM/dd/yyyy" → 08/28/2020
○ "h:mm a" → 8:56 AM
○ "hh:mm a" → 08:56 AM
replace (s1, s2, s3) Replaces all occurrences in "s1" of "s2" with "s3".
startsWith (s1, s2) Returns 1" if s1 starts with s2.
134
substring (s1, i2, i2) Returns subset from string s1 starting at index i1 to index i2. (i2 must be >=
i1)
toLowerCase (s) Converts string to lower case.
toUpperCase (s) Converts string to upper case.
trim (s) Removes white space from the beginning and end of the string.
\ Used to escape operator characters by placing it before the operator.
Example: 'Cost is \$' +$cost$' returns "Cost is $10.99".
Functions
On the Report Editor's Columns tab, you can specify that a column's data comes from one of the
following functions that returns another column's value or manipulation of that value.
Valid Column Returns true/false if input column is valid
Default Value Returns the column's value if it is a valid value, otherwise returns the
argument.
Format Formats a value using Java String format function.
For more information, search the Internet for "string format with java
8".
Format Duration Formats a trend duration value.
Argument formats:
%d%, %h%, %m%, %s% (clock based)
%D%, %H%, %M%, %S% (total count rounded down)
Example 1: %ddd% days %hh%:%mm% = 003 days 13:50
Example 2: %M% min = 283 min
Convert Values to Text Converts a number to a text value.
Argument format:
Define a set of comma separated statements.
Format of each statement: lower limit=value
Example 1: 0=F,60=D,70=C,80=B,90=A,100=A+
Example 2: F,60=D,70=C,80=B,90=A,100=A+
(first bucket is default for anything below second bucket's value)
Example 3: Cold,68=Perfect,75=Warm
Example 4: 65=Cold,68=Perfect,74=Perfect,75=Warm,76=Warm
Convert Integer to Text Converts an integer value to text. If no match, value is empty.
Argument format:
Comma separated list of statements.
Format of each statement: #=text
Example: 0=Zero,1=One,2=Two,3=Oops
135
Convert Text to Integer Converts text to an integer value. Matching is case insensitive.
Argument format:
Comma separated list of statements.
Format of each statement: text=#
Use * to match any letters.
Example 1: Off=0,On=1 -or- off=0 -or- OFF=0
Example 2: a*=1,b*=2
a=1 -or- APPLE=1
B=2 -or- Book=2
Convert to Color Attempts to convert an ALC color value (0 to 15) to a color for a color
map.
Color Gradient Converts a defined minimum and maximum number each to a color. It
then maps numbers between minimum and maximum to colors to
form a gradient.
Format: min,max,color1,color2
Example 1: 1, 10, red, blue
Example 2: 1, 10, #FF0000, #0000FF
Date Range Start Formats the START date/time of a Date Range.
Examples: yyyy/MM/dd hh:mm = 2017/07/04 11:30
hh:mm:ss = 08:35:16
For more information, search the Internet for "customizing date time
formats with java".
Date Range End Formats the END date /time of a Date Range.
Examples: yyyy/MM/dd hh:mm = 2017/07/04 11:30
hh:mm:ss = 08:35:16
For more information, search the Internet for "customizing date time
formats with java".
Ordinal Value Converts a text enumeration to its integer value when possible.
Location Tags Lists all of the semantic tags assigned to the location in each row.
Enter location for the input column ID to create a simple report that
shows all of the tags for the locations.
Regular Expression Finds a piece of text from a larger text body. Example: Finds a piece of
text in a modstat.
For more information, search the Internet for "regular expression
patterns with java 8".
136
Operations
On the Report Editor's Columns tab, you can specify that a column's data comes from trend data. You
can then specify one of the following operations be performed on the trend data.
This operation... Shows the following for the specified time range
Average Value The average value.
Count All Trend Records Number of trend records collected (includes items such as time
changes and enabling/disabling the trend log).
Count Trend Samples Only Number of times the trend value was read.
First Value w/Time The first trend sample and the time it was read.
Last Value w/Time The last trend sample and the time it was read.
Maximum Value w/Time The largest value and the time it was read.
Minimum Value w/Time The smallest value and the time it was read.
Aggregate Consumption Total consumption for meter trend data. This operation makes
appropriate calculations for meters that reset to 0.
Sum of Values The total of all trend values.
% Time in Range You can enter 3 types of arguments to determine the percentage of
time that the trend value was:
• One or more single values.
Format: A comma separated list of values
Example: Enter 1,2,3,4 to get the percentage of time that the
trend value was 1, 2, 3, or 4.
• Between two values

Format: A single statement or a comma separate list of
statements
Example 1: Enter the statement 65:75 to get the percentage of
time that the trend value was 65 to 75.
Example 2: Enter the statement 28:30,38:40,48:50 to get the
percentage of time that the trend value was 28 to 30, 38 to 40, or
48 to 50.
• Not a specified value or between two values

Format: !(value)
Example 1: Enter !10 to get the percentage of time that the trend
value was not 10.
Example 2: Enter !28:30,38:40 to get the percentage of time that
the trend value was not 28 to 30 or 38 to 40.
137
Icons
You can design a report to show icons to indicate certain conditions. You can use the icons included
with your system or create custom icons. On the Report Editor's Columns tab:
1 Set Column data is from field to Expression.
2 Set Render data as field to Icon.
3 Enter an Expression that contains the icon's file name. See the table below for the file names of
icons included with your system, or see "Custom icons" below.
Included icons
Color On Off Animated .gif that flashes

on and off
Red
light_on_red.png light_off_red.png light_alarm_red.gif
Blue
light_on_blue.png light_off_blue.png light_alarm_blue.gif
Light blue
light_on_ltblue.png light_off_ltblue.png light_alarm_ltblue.gif
Green
light_on_green.png light_off_green.png light_alarm_green.gif
Yellow
light_on_yellow.png light_off_yellow.png light_alarm_yellow.gif
Magenta
light_on_magenta.png light_off_magenta.png light_alarm_magenta.gif
Orange
light_on_orange.png light_off_orange.png light_alarm_orange.gif
White
light_on_white.png light_off_white.png light_alarm_white.gif
Custom icons
If you choose to use a custom icon, put the icon in one of the following places:
• In <system name>\tables. Put only the icon's file name in the expression.
• Anywhere under the webroot folder. Put the full path from the webroot folder in the expression.
Example: /_common/lvl5/skin/graphics/type/area.gif.
138
Variables tab
You can enter a variable in a Report Editor field so that you can edit that field when you run the report.
For example, if you create a Date Range report for the previous 4 months, you can put a variable
named number_of_months in the field instead of a 4. When you run the report, you can change the
variable value to 12 to show the previous 12 months.
1 Click Add to create a new variable.
2 Enter the variable's criteria. See table below.
Field Notes
ID This ID is what you will insert in a report field that you want to be able to
change when you run the report. (Use letters, numbers, underscores, and
hyphens only; no spaces or special characters).
Type Select an option from the drop-down list, and then enter a Value.
Type Value
String A text phrase. Can contain letters, numbers, and special
characters.
Number Can contain any number in any format.
Date Format is yyyy/mm/dd.
Time Format is hh:mm:ss.
User editable Check to let a user edit the variable's value when they run the report. Enter a
Display name Display name for the variable that will appear on the page where you run the
report.
NOTE The table at the top of the Variables tab shows the variables that you defined. Their order in this
table is how they will appear in on the page where you run the report. To change the order on the
Variables tab, select a variable in the table and then click or .
139
Where tab
1 Click the drop-down list for This report can be accessed from, and then select an option.
2 Click Define Where.
3 Select or enter information for the option you chose. See table below.
Field Notes
Anywhere The report can be run from anywhere in the system.
Control Programs Do one or both of the following:
• Type a control program name, and then click Add.
NOTE You can use wildcards. See the examples in the WebCTRL®
interface.
• Select existing control program(s) from the list.
Location Types Select the type(s) of locations where you want the report to be available.
Locations Select location(s) on the trees, or type a location name in the text box.
Options tab
1 Click the drop-down list to the left of the Add button, and select an option.
2 Click Add.
3 Select or enter information for the option you chose. See table below.
Field Notes
Show Check the appropriate boxes to show
Max/Min/Avg/Total the maximum value, minimum value,
average, standard deviation, or total at
the bottom of the columns. Enter the
Column ID of the column that you want
labels to be in.
Show first ___rows Enter the maximum number of rows to be displayed when the report is
previewed or run. This does not include the Max/Min/Avg/Total rows.
NOTE You can enter a value or variable name in this field. If you enter a
variable, it must be defined on the Variables tab.
Sort column Sorts the specified column(s) from A to Z or 1 to ...
Example of comma separated list of column IDs:
date_range, kw_usage, normalizer
Check Reverse Sort to sort Z to A, ... to 1.
Filter rows Select Include row when or Exclude row when a specified column (ID) equals
a specified value.
140
Field Notes
Table Calculations Allows custom expressions to be run after all columns have been generated.
See Advanced Reports and Table Concepts.
Reorder columns Set the order in which columns appear by listing the column IDs separated by
commas.
Add appended rows Displays data from appended rows in charts, such as Maximum and
to chart Minimum.
NOTE You can use multiple options for your report, but be aware that they will be processed in the
order that they appear in the table at the top of the Options page. For example, if your first option is to
Show the first 10 rows and your second option is Filter rows, only the 10 rows will be filtered. To
change the order of processing, select an option in the table and then click or .
Output tab
On this tab, you can define the criteria for a report PDF or a chart on a graphic.
1 Select or enter information as needed. See table below.
Field Notes
PDF Output
Page orientation
Select Portrait or Landscape .
Page size Select the page size that you want for a pdf.
Ignore page width If the report exceeds the width of the selected Page size, select to ignore that
width and show all columns in the online PDF.
Font size You can adjust the font size for the report's body.
Title font size You can adjust the font size for the report's title.
Chart These fields apply if you add a Chart control to a graphic in ViewBuilder. See
To produce a chart (page 152).
Axis label For a Horizontal Bar Chart, this label will appear below the X axis.
For a Vertical Bar Chart or Line Chart, this label will appear to the left of the Y
axis.
Data series A column or row of numbers that are plotted in the chart.
Example: For this report...
A horizontal bar chart will look like this...
141
Field Notes
By column
By row
NOTE Pie charts show only one data series.
142
Field Notes
Show title
Show legend
Show chart border
Graphics Refresh A chart or data table control will refresh its report data every time you visit the
Graphics page or at the following refresh rates while the Graphics page is
displayed.
If the report's primary column is... Default refresh rate is...

A Date Range with a Frequency of Hourly Every 5 minutes
or Every 15 minutes
Any other Date Range 0 (never refreshes)
Anything else Every 30 seconds
Use custom refresh Check this field to change the refresh rate. If your chart or data table shows a
rate lot of data, refreshing frequently could slow down your system. If most of the
data is historical data that does not change, you may want to set a longer
refresh time.
Reset to defaults Click Reset to return all fields on the Output tab to their original settings.
143
To preview a report
At the bottom of every tab in the Report Editor is a Preview section so that you can check your work.
Click Show to see the report. If you make changes to the report, click Refresh to update the preview.
You have the following options when previewing the report:
Show all columns Includes columns defined as hidden and a column with additional
information about the Primary column.
Show Column ID Each column header shows the display name and column ID.
Show Debug Information Gives information for troubleshooting a report.
NOTES
• If the preview shows Error, hover your cursor over the word to see a description of the error.
• If the preview shows ?, this indicates there is no data.
To run a custom report

1 Select an item on the Geographic or Network tree where the report you want to run is
accessible.
2 Click the Reports button drop-down arrow, and then select the report.
3 Optional: If the report was designed with variables (page 139), you can change the variables'
values at the top of the page.
NOTE Click Reset if you want to change the variables back to the value that was assigned when
the report was created.
4 Click Run.
NOTES
• A ? in the report indicates there is no data.
• Click Edit to change the report's design. See Creating a custom report (page 123) for field
descriptions.
• Click Schedule to schedule the report to run on a recurring basis. See Scheduling reports (page
162).
To edit or delete a custom report

1 Click the Reports button drop-down arrow, and then select Report Manager.
TIP Click on the Display Name or ID heading to sort the column.

2 Select the report, and then do one of the following:
○ Click Edit to open the Report Editor, make changes as needed, then click Accept. See Creating
a custom report (page 123) for field descriptions.
NOTE You can also double-click a report to open it in the Report Editor.
○ Click Delete, then click OK.
144
To export or import a custom report
You can export one or more reports from one system, copy them to another system, and then import
the reports into the WebCTRL® interface.
To export reports
1 Click the Reports drop-down arrow, and then select Report Manager.
2 Click Export.
3 Select the checkbox(es) for the report(s) that you want to export, or check Select All.
4 Click Export.
NOTE A single report is exported as a .table file. Multiple reports are exported as a .zip file.
TIP In the Report Manager or Export Report window, you can click on the Display Name or ID
heading to sort the column.
To import reports
1 Copy the .table or .zip file to the computer where you are importing them.
2 In the WebCTRL® interface, click the Reports drop-down arrow, and then select Report Manager.
3 Click Import.
4 Browse to the file that you are importing.
5 If a report ID that you are importing matches an existing report ID, select how you want to handle
the situation:
Rename Rename the report that you are importing.
Replace Replace the existing report with the report you are importing.
Skip Do not import the report with the duplicate name.
6 Click Import.
145
To organize custom reports by category
When you create a custom report, you can assign it to a category so that the report appears in the
category in the Reports button drop-down list.
To create a report category

Report.
2 Click Add.
4 Select a privilege so that only operators with that privilege can access reports in the category.
5 Click Accept.
NOTES
146
Using a custom report as the source for a Graphics page
A WebCTRL® custom report can be the data source for the following items on a Graphics page:
• A data table
• A value
• A chart
• A color map
For example, this report... ...supplies data to the chart and data table on this graphic
When the graphic is viewed in Time-Lapse:

• The data in a data table or chart will not change.
• A color map will ignore report data and show thermographic colors.
Note You can modify custom report variables (page 139) directly from a graphic in WebCTRL® by
clicking the button.
To produce a data table

To produce a data table like the example below, first create the report in the WebCTRL® interface and
then create the corresponding graphic in ViewBuilder.
147
To create the report in the WebCTRL® interface
Instructions Example
1. Click the Reports drop-down
arrow, and then select Report
Manager.
2. Click Add.
3. On the Report Editor's Type tab,
type a Display name and ID for
the report.
4. In the Primary column field, select
the type of information that you
want the report to be based on
(Control Programs in this
example).
5. On the Type tab (page 123), enter the
criteria
for the option that you selected in
step 4.
6. In the Primary column header field,
enter the heading that you want for
that column (Equipment in this
example).
7. Define each column in the report on

the Columns tab (page 127). See the
examples
on the right.
8. Define any other information you
may want, and then click Accept.
148
149
To create the graphic in ViewBuilder
1. Select File > New > Graphic, and

then click OK.
2. Click the Add Control tab

in the Tools window.
3. Click the Data Table control and
then click in the workspace.
4. In the Properties window, enter the

Report ID exactly as it appears in
the WebCTRL® Report Editor.
5. Resize the control so that it is at least
the size that the table will be in the
WebCTRL® interface. To resize,
enter a specific size in the Properties
window or drag the handles on the
control.
NOTE If the table is cut off when
you view the graphic in the
WebCTRL® interface, increase the
size of the control in ViewBuilder.
6. If you defined variables in the Report
Editor and you want to use a
different default value for the Data
Table, click in the Properties
window, type the variable's ID (from
the Report Editor), and then type
the new default value.
NOTE To have the data table show data
for a location other than the graphic's
location, add a variable and type
location in the ID column. Type the
path to the location in the Value column.
7. Save the graphic.
150
To reference a value in a data table
To reference the value of a cell in a data table, use one of these expressions:
CELL::table ID,column ID,column ID=value
CELL::table ID,column ID,numerical position in the column
NOTE The numerical position in the column can be positive if counting for the top or negative if coming
from the bottom.
Examples
To reference the value of 17.02 in the table below called "sample_table", below are a few ways you can
reference the value:
CELL::sample_table,c1,location=#e8
CELL::sample_table,c1,ref=#e8
CELL::sample_table,c1,3
CELL::sample_table,c1,-5
151
To produce a chart
To produce a bar chart like the example below, first create the report in the WebCTRL® interface and
then create the corresponding graphic in ViewBuilder.
NOTE When a chart that is based on a report is displayed on a Graphics page, you can hover over
various points on the chart to see values. You can also click on each item in the legend to turn that
information on and off. See "Using a custom report as the source for a Graphics page" in WebCTRL®
Help for more information on a chart.
152
To create the report in the WebCTRL® interface

Manager.
2. Click Add.
the report.
4. In the Primary column field, select
the type of information that you
want to report based on (Date
Range in this example).
5. On the Type tab (page 123), enter the
criteria
for the option that you selected in
step 4.
6. In the Primary column header field,
enter the heading that you want for
that column (Date Range in this
example).
153

the Columns tab (page 127).
NOTE In the example on the right,
all four columns have the same
criteria.
8. Define the Chart options on the

Output tab (page 141).
9. Define any other information you
may want, and then click Accept.
154
To create the graphic in ViewBuilder
1. Select File > New > Graphic, and

then click OK.
2. Click the Add Control tab

in the Tools window.
3. Click the Chart control and then
click in the workspace.
4. In the Properties window, enter the

Report ID exactly as it appears in
the WebCTRL® Report Editor.
5. Select the Type of chart you want.
6. Resize the control so that it is at least
the size that the chart will be in the
WebCTRL® interface. To resize,
enter a specific size in the Properties
window or drag the handles on the
control.
NOTE If the chart is cut off when
you view the graphic in the
WebCTRL® interface, increase the
size of the chart control in
ViewBuilder.
7. If you defined variables in the Report
Editor and you want to use a
different default value for the chart,
click in the Properties window,
type the variable's ID (from the
Report Editor), and then type the
new default value.
NOTE To have the chart show data for a
location other than the graphic's location,
add a variable and type location in
the ID column. Type the path to the
location in the Value column.
8. Save the graphic.
155
To produce a color map
A Graphics page color map shows specified colors for various conditions that are defined in a
WebCTRL® report. For example, each building on a campus map could show a color that indicates its
energy usage. See image below.
A color map can also have an option that lets a user switch between different kinds of information. For
example, in the image below, a user could click on the MTD kWh drop-down list and select YTD kWh.
To produce a color map:

1 Create the graphic in ViewBuilder.
2 Create the corresponding report in the WebCTRL® interface.
3 Edit the graphic to add information specific to the WebCTRL® report.
See instructions below.
156
Create the graphic in ViewBuilder
1. Add an image (floorplan, campus

map, etc.) to the graphic, and then
double-click the image to open the
Associations window.
2. Associate each item on your
image (zone, building, etc.) just
as you would associate zones on a
thermographic floorplan. See
"Associating zones on a floorplan
to equipment" in ViewBuilder
Help.
NOTE The Variable Color
checkbox in the Associations
window must be checked.
3. Click Save and Close.
Create the report in the WebCTRL® interface

Manager.
2. Click Add.
the report.
4. In the Primary column field,
select Color Map.
157
5. Type a location in your system so

that you can preview the report
(#building_1 in the example).
This location is only for testing
your entries in the Report Editor.
Associations to actual locations
in the system will be made in
ViewBuilder.
NOTE You can add more than one
location if you want to see more in
the preview.
6. Click Add.
7. Optional: Select Include
equipment color column if you
want to automatically include a
column for WebCTRL®
thermographic colors.
NOTE You can see this column in
the Preview section if you check
Show all columns.
the Columns tab (page 127). See
examples
of the first two columns on the
right.
158
A color map can retrieve color

information only from a column
that has the Render data as field
set to Color.
9. Define any other information
needed on the Report Editor tabs,
and then click Accept.
Edit the graphic in ViewBuilder to add report information
Follow steps 1 through 5 if the colormap

will show information from more than
one report column. If not, skip to step 6.
1. Select Configure > View
Properties.
2. On the Local Variables tab, click
.
3. Double-click Boolean in the Type
column, and then select Report
column in the drop-down list.
4. Double-click variable in the Name
column, and then replace
variable with colormap_column.
NOTE If the Graphic has multiple
images that will pull data from
different reports, add one variable
called colormap_column1, another
called colormap_column2, etc.
5. Click OK.
159
6. Double-click the image to open the

Associations window.
7. Click , and then enter the
following information:
• Report ID: Get the report ID
from the WebCTRL® Report
Editor.
• Default Column ID: This is
the column whose color is
displayed when the graphic
first appears. Get the Column
ID from the WebCTRL®
Report Editor. Leave blank if
the graphic will pull data from
only one report column.
• Column Name Local
Variable: Type the name of
the variable that you created in
step 5 above. Leave blank if
the graphic will pull data from
only one report column.
8. If a report uses a variable and
you want the colormap to use
a different default value than
what is defined in the
WebCTRL® Report Editor,
click in the Report
Properties window, type the
variable's ID (defined in the
Report Editor), and then type the
new default value.
9. If the colormap will show
information from more than one
report column, add a control
(droplist or radio buttons) that will
allow the user to select the
information they want to see.
10. In the Microblock Path field,
enter the local variable that you
defined in step 4, enclosing it in
$$.
11. Finish the graphic and then test it
in the WebCTRL® interface.
160
Troubleshooting custom reports
• If a Graphics page contains a chart, data table, or color map that is retrieving information from a
very large report, the graphic may be slow to load or refresh. You can do the following to improve
this condition:
○ Verify that your system follows the recommendations in WebCTRL® v8.5 client, server,
operating system, and database requirements.
○ Reduce the size of the report by redefining the primary column criteria on the Report Editor's
Type tab.
○ Filter the report to show only a portion of the information. You can filter the report on the
Report Editor's Options tab.
○ Increase the refresh time (default is 30 seconds). If the chart, data table, or color map is based
on information that changes infrequently, increase the refresh rate or set it to 0 to turn off
refreshing. You can adjust the refresh rate on the Report Editor's Options tab.
○ Reduce the number of controls on the graphic that are pulling data from different reports.
• If an Invalid Report Definitions section appears at the bottom of the Report Manager page, one of
the following has occurred:
○ The report's file or file name has been manually manipulated, invalidating the report's digital
signature. Contact Technical Support to resolve this problem.
○ The report is set up to have an add-on supply content for the report, but the add-on has not
been installed in the WebCTRL® interface. Install the add-on to resolve this problem.
To create a PDF, XLS, or CSV file
These reports... Can be output as... Notes
v7.0 and later custom reports • A PDF file

• A CSV file
Preconfigured reports and • A PDF file For a v6.5 and earlier CVS file, you must
v6.5 and earlier custom • An XLS file enable Support CSV text format on the
reports • A CSV file Reports > Options tab before you run the
report.
To output a file:
1 Run a report.
2 Click PDF, XLS, or CSV to download the file.
NOTE To create a CSV file when using Safari, see instructions below.
161
To create a CSV file when using Safari
1 Run a report.
2 Click CSV. A pop-up displays the results.
3 Select File > Save As.
4 In the Format field, select Page Source.
5 Add the .csv extension to the file name.
6 Select the save location in the Where field.
7 Click Save.
8 Close the popup.
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 the Adobe® Acrobat® application, 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.
Scheduling reports
You can schedule a report so that it runs on a recurring basis. The report is saved as a file (PDF, CSV, or
XLS), and you can choose to have it automatically emailed to someone.
NOTE You can also use the following alarm actions to run a report:
• The Send E-mail alarm action can run any WebCTRL® report and attach it to the email.
• The Write to File alarm action (page 97) can run any WebCTRL® report and save it as a file.
For both alarm actions, the report can be a PDF, HTML, XLS, or CSV file.
To schedule a report
1 Click the Reports drop-down arrow, and then select the report that you want to schedule.
2 Click the Schedule button.
3 Enter the information in each field.
Fields Notes
Description Enter a brief description of the report or how this schedule will be used.
Operator The report will be run based on the selected operator's privileges.
Run report Define when the report will run by selecting options in the drop-down lists.
At __:__ __ Enter the time of day that you want the report to run.
Save report as v7.0 reports can be output as a PDF or CSV file. Preconfigured reports and
v6.5 reports can also be output as an XLS file. Select the type of report file
that you want.
NOTE See Output tab (page 141) for a description of the PDF options that
are available in the Report Editor.
Keep latest Enter the number of files and Schedule History entries that you want to
keep for this report. As a new file or entry is saved, the oldest one is
deleted.
162
Fields Notes
Email report Enter the information needed to email the report each time it runs.
NOTE For the WebCTRL® application to email a report, you must define
the Email Server configuration on the System Settings > General tab
(page 319).
4 Click Accept.
NOTE The following reports have additional scheduling options available. Scheduling these reports
without configuring schedule options results in an error; see View History in To manage scheduled
reports (page 163).
• Alarms > Alarms
• Life Sciences*
○ MKT
○ Trend Value
○ Out of Range
• Security Reports
○ Location Audit Log
○ System Audit Log
See To configure scheduled Alarms and Security Reports (page 119).
To manage scheduled reports

Click the Reports drop-down arrow, and then select Scheduled Reports. The table shows any report
that was scheduled to run.*
Select a schedule To...

and then click...
Edit Change the report's schedule in the Schedule Editor.
NOTE You can also double-click a schedule in the table to open the Schedule
Editor.
View History See when the report ran. Click PDF, CSV, or XLS in the Results column to
download the report that was produced.
NOTE The XLS option is not available for v7.0 custom reports.
Delete Remove the schedule. This removes its history and all associated files.
* You can also access this table by going to the System Configuration tree and selecting Scheduled
Reports.
163
If a report fails
The table below will show a red X and a system alarm will be generated.
Select the schedule in the table above, and then click View History. Hold the cursor over the word
Failure to see hover text describing what failed.
To add an e-signature to scheduled reports

Electronic signatures uploaded for use within the system are intended to be the legally binding
equivalent of traditional handwritten signatures. To add an e-signature to a scheduled report, you must
have the correct privileges (page 183), and an e-signature file and password (page 189) in the system.
The signature appears on the last page of the report PDF.
1 Click the Reports drop-down arrow, and then select Scheduled Reports.*
2 Select a schedule and then click View History.
3 Click Add Signature in the Checked By or Approved By column, as required.
NOTE Once an Approved By signature is added to the report, you can no longer add a Checked By
signature.
4 Enter your system password in Password.
5 Enter your e-signature password in E-signature Password.
6 Enter your comments in Comments.
To remove e-signatures from a scheduled report

1 Click the Reports drop-down arrow, and then select Scheduled Reports.*
2 Select a schedule and then click View History.
3 Click Remove signatures to remove all Checked By and Approved By signatures from the report.
* You can also access this table by going to the System Configuration tree and selecting
Scheduled Reports.
164
Working with legacy (v6.5 and earlier) custom reports
Although the WebCTRL® v7.0 interface has a new method of creating and managing reports, you can
still create or edit the following reports that were available in WebCTRL® v6.5 and earlier systems.
These reports will be accessible from the Reports button drop-down list, but not the Report Manager.
This 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
• Combined schedule
See To create an Equipment Summary report (page 165).
Equipment Values Compare point information. See To create an Equipment Values report
(page 166).
Trend Samples View trend values for a particular time frame. See To create a Trend
Samples report (page 168).
NOTES
• You can display icons and hover text on the Geographic tree that show where custom reports
have been created. See Tree icons and hover text (page 15).
• You can schedule a report to run on a recurring basis. See Scheduling reports (page 162).
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 Geographic tree, select the location where you want to view the report.
2 Click the Reports button drop-down arrow, then select Add Legacy 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 146).
5 Type a name for the report.
165
6 Click Create.
7 Define the Title, Page Size and orientation, and the Maximum number of rows.
8 Check or uncheck the Optional Sections checkboxes as needed.
9 Optional: Check 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 Accept.
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.
To create an Equipment Values report

An Equipment Values report allows you to compare point information.

To create an Equipment Values report:
2 Click the Reports button drop-down arrow, then select Add Legacy Report.
3 Select Equipment Values.
NOTE The Category drop-down list is only visible if you have defined report categories. See To
organize custom reports (page 146).
6 Click Create.
○ 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: Check Highlight alternate rows 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 blue.
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.
166
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 Accept.
17 Click Run.
Type of Column Data

Point Displays point data in the column.
Display Select the property to show in this column.
Data is named Select this checkbox if similar points have different names
differently in some in different control programs. Then add each of the names
control programs 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.
Trend Sample Display Select First, Minimum, Maximum, or Last recorded trend
value.
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.
Trend Display Select the type of calculation to show in the column,
Calculation Average or Total.
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.
Control Program Display Select Color, Display Name, Display Path, Notes, Prime
Variable, or Reference Name to show in the column.
167
Type of Column Data
Expression Data is named Select this checkbox if similar points have different names
Expression Type the path relative to the current control program. The
path must return a string value. See Defining WebCTRL®
paths (page 206) for more information on paths.
To display the Notes on an equipment's Properties page,
type .notations in this field.
To create a Trend Samples report

A Trend Samples report provides trend values for a particular time frame.
To create a Trend Samples report:
2 Select the Reports button drop-down arrow, then select Add Legacy Report.
3 Select Trend Samples.
NOTE The Category drop-down list is only visible if you have defined report categories. See To
organize custom reports (page 146).
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: Check Highlight alternate rows 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.
168
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 Accept.
18 Click Run.
To save a v6.5 or earlier custom report's design for use in another location or
system
You can save the design of an Equipment Values report or a Trend Samples report for reuse in another
location or in another system. Or, you can create a library of different report designs to pull from as
needed.
To save a report's design

1 Create the Equipment Values (page 166) or Trend Samples (page 168) report.
2 On the Reports > Design tab, click the Save Report Design button. The design is saved to
<system_name>\Reports\<report name>.reportdesign.
NOTE The .reportdesign file includes the report name. If you save multiple report designs in your
system, each of those reports must have a unique name.
To use the report design at a different location in the system

1 Select the location in the Geographic tree.
2 Select Reports > Add Legacy Report.
3 In step 1, select Report design, then select the report name in the drop-down list.
4 In step 2, type a report Name.
5 In step 3, click Create.
To copy individual report design file(s) to another system

1 In Windows Explorer, go to the <system_name>\Reports\ folder.
2 Copy the *.reportdesign files that you want.
3 In the new system, paste the copied files in the <system_name>\Reports\ folder.
4 Follow the steps above in "To use the report design at a different location in the system".
169
To create a .zip file to import into another system
NOTE The import process will not import a file if it has the same name as a file in the other system.
Make sure your file names are unique.
○ Create a .zip file that contains the *.reportdesign files that you want. These files may be in the
<system_name>\Reports\ folder, or in a library that you created.
○ On the System Settings > General tab, under Source Files, click Export.
NOTE Export creates a .zip file that contains all of the system's source files (control programs,
drivers, view files, touchscreen or BACview files, report design files).
2 In the new system, go to the System Settings > General tab.
3 Under Source Files, click Import.
4 Browse to the .zip file.
5 Click Continue.
6 Click Close. The WebCTRL® application will put the imported files in the correct folder.
To edit or delete a v6.5 or earlier custom report

1 Select the item on the Geographic tree where the report was created.
2 Click the Reports button drop-down arrow, then select the report you want to edit or delete.
3 Do one of the following on the Design tab:
○ Edit the report, then click Accept.
○ Click the Delete Report button, then click OK.
Semantic tagging
Semantics tags and rules are included in the WebCTRL® v8.5 application to apply semantic meaning to
locations in the system. You can use the tags that are included or create custom tags. You can assign
tags to locations manually or by rules that are included or your custom rules. Once assigned, the
locations can be selected by their semantic tags to use in reports, graphics, and ACxelerate™
Automated Commissioning Tool.
The Built-in and Haystack tags are included in the WebCTRL® v8.5 application and you cannot alter or
delete them. The Built-in rules cannot be modified but you can disable them. You can create custom
tags and rules as needed.
The two kinds of tags are Marker and Value. The key difference is that Value tags also have a string
value associated with them. You assign a Value tag to a location and specify the value. Value tags
assigned by a rule have the same value assigned to each location.
On the Geographic tree > Properties > Tags tab, you can:
○ Assign tags manually to a selected location
○ View tags that are assigned by a rule or manually for a location
○ View any microblocks underneath an equipment location that have been tagged by a rule
170
On the System Configuration tree > Semantics, you can:
○ Search, add, delete, import, and export custom tags
○ Search, enable, and disable the Built-in Rules
○ Search, add, delete, edit, import, and export Custom Rules
You can also use semantic tagging:

• In Reports > Report Manager, to create custom reports.
• In ViewBuilder, in place of microblock reference names for a path on a graphic.
• In the ACxelerate™ Automated Commissioning Tool
To manually assign tags to a location or equipment

Tags are typically assigned using rules. The only way to assign a tag to a microblock is through a rule.
You can manually assign tags to an individual location area or equipment location from the Geographic
tree.
When selecting an equipment (control program) in the Geographic tree > Properties > Tags tab, all
tags currently assigned to that equipment are displayed. There may also be a Microblock Tags table to
display the tags that are assigned from the Built-in or Custom rules.
Use the Search Tag/ID: field to find one or more specific tags. Type a word or phrase that is included in
the Tag or the ID column of the tag(s) you want to isolate in the table. For example, "cool". Click the
Show All button to return to viewing the entire list.
1 On the Geographic tree, select a location and go to Properties, or select an equipment and go
to the Properties > Tags tab.
2 Click to expand the Assign Tags table. See column descriptions below.
NOTE Click in any column heading to arrange the order of the tags alphabetically by that column.
Click again to reverse the order.
3 Click to the left of a tag in the Assign Tags table to assign it to your selection in the tree.
NOTES
○ You can assign an unlimited number of tags to a selection
○ You can assign a tag to more than one selection
○ To remove an assigned tag, click in the Assigned Tags table.

4 Click Accept when finished assigning tags.
5 Select another location or equipment in the Geographic tree and repeat the above steps until
finished.
171
Assign Tags table
Column
Click to add the tag to a location or equipment that you selected in the Geographic
tree.
Tag Semantic tag name
NOTE Tags beginning with ACx are available for the ACxelerate™ Automated
Commissioning Tool to use.
ID Reference name
Value Tag Displays a check mark for an item with a value. For example, the square feet in an
area.
Namespace • Built-in - created specifically for the WebCTRL® v8.5 application
• Haystack - an industry standard
• Custom - created by the user
Description An understandable explanation of the tag
To add, delete, import, or export custom tags

The System Configuration tree > Semantics > Tags tab is for viewing and managing custom tags.
Every tag in your system is included in the table.
Use the Search Tag/ID: field to find one or more specific tags. Type a word or phrase that is included in
the Tag or the ID column of the tag(s) you want to isolate in the table. For example, "cool". Click the
Show All button to return to viewing the entire list.
To add a custom tag

1 On the System Configuration tree, click Semantics > Tags tab.
2 Click Add and enter the following information:
In this field... enter the...

Display Name Semantic tag name - no limits or special rules for characters
ID Reference name - (letters, numbers, underscores, and underscores
only; no spaces or special characters)
Description An understandable explanation of the tag
Value Click the checkbox if the tag has a value
3 Click Accept.
172
To delete a custom tag
1 Select a custom tag in the Tags table by clicking anywhere in the tag's row.
NOTES
○ Use the Search Tag/ID: to easily locate a tag
○ You cannot delete Built-in and Haystack tags
2 Click Delete to remove the tag.
3 Click Accept.
To import or export custom tags

• Click Import Custom, click in the Choose File field to browse to and select a .csv file you have
saved from another WebCTRL® system. Click Import.
• Click Export Custom to create a .csv file that you can import into another WebCTRL® system.
To add, delete, import, or export rules

Rules govern the semantic tags that are assigned to a location-based Reference Name or Equipment
Name. To view and manage the Custom Rules and the Built-in Rules, go to the System Configuration
tree and select Semantics.
To search for specific tags in rules, built-in or custom, enter a word or words from the Tag Name in the
Search Tags: field.
Built-in Rules
All of the Built-in Rules are included in the WebCTRL® application and all of them assign tags based on
a microblock's Reference Name. On the System Configuration tree, select Semantics > Built-in
Rules tab. All Built-in Rules are enabled by default. Uncheck the Enabled checkbox to disable. They
cannot be deleted or modified.
Custom rules
The WebCTRL® v8.5 application does not come equipped with custom rules. You can create your own
or import them from another WebCTRL® system. You can also enable, disable, delete, or export them.
To import or export
• Click Import, click in the Choose File field to browse to and select a .csv file you have saved from
another WebCTRL® system. Click Import.
• Click Export to create a .csv file that you can import into another WebCTRL® system.
173
To add a new custom rule
1 On the System Configuration tree > select Semantics > Custom Rules tab.
2 Click the Add button and follow the table below:
Rule Enter a description.

Enabled Enabled by default. Uncheck to disable.
Type Select:
Control Program Name Matches for control programs
NOTE Using the control program names can save time by finding groups of
equipment.
or
Reference Name Matches for matching the reference name of any location
in the Geographic tree: Areas, equipment, or microblocks.
Name(s) Enter the Control Program Names or Reference Names.
NOTE To locate a name, go to the Geographic tree, select the area or
control program, right-click, and select Configure.
Control Program Name Matches
Use ? (to match one letter) and * (to match any letters) for matching names.
Separate additional names with a comma and no spaces.
Reference Name Matches
Use ? (to match one letter) and * (to match any letters) for matching names.
You can match a partial path using /. For example, “vav*/zone_temp”.
Separate additional names with a comma and no spaces.
3 To assign a tag from the Available Tags table, click once anywhere in a row and it is immediately
added to the Assigned Tags table.
NOTE To narrow the list of tags, in the Search field, type a word or phrase that is included in the
Tag name or the ID field (visible on the Tags tab).
4 Continue to add as many tags as necessary for that rule.
5 Click Accept.
To delete or modify tags in an existing custom rule

1 Select a rule in the Rules table by clicking anywhere in the row.
2 Click the Delete button to remove the rule.
3 To assign a tag, see step 3 above.
4 To remove an assigned tag, click in the Assigned Tags table.
174
Source trees
A source tree defines mechanical relationships between pieces of equipment, just as the Geographic
tree defines physical relationships and the Network tree defines network relationships.
You can use the Source Tree Manager in the WebCTRL® interface to build up to 20 source trees. You
can build predefined source trees or create your own custom source trees.
NOTE You can also use SiteBuilder to create source trees.
The following are predefined source trees that are included with every WebCTRL® application. You
cannot delete them.
• Cool Source (page 175)
• Heat Source (page 175)
• Demand Source (page 176)
• Environmental Index (page 177)
Cool and Heat Sources

If a terminal unit requests air from an air handling unit to meet space cooling or heating needs, the air
handling unit is both the cool source and the heat source for the terminal unit.
The air handling unit requests colder chilled water from a chiller (cool source) to meet its cooling needs.
The same air handling unit requests warmer hot water from a boiler (heat source) to meet its heating
needs. Because different equipment may provide cooling and heating in a system, different source
trees are used to define these relationships.
In this example, the chiller is the last source of cooling for the system. When the chiller is providing as
much cooling as possible, no more cooling is available to the system. Therefore, the chiller is the
highest piece of equipment in the Cool Source tree - the parent of all equipment below it. Under the
chiller is each piece of equipment (child) that requests cooling directly from the chiller, and so on down
to the terminal unit in each zone.
175
After you have built your source trees, you can view the Cool and Heat Source trees in the WebCTRL®
interface. Right-click a site or equipment in the Geographic tree and select Equipment Sources.
To view the cool and heat operation in the WebCTRL® interface, right-click the cool or heat parent
equipment in the Geographic tree. On Properties > Network Points tab, in the Address column, the
equipment and its requests for heating or cooling are listed.
Demand Sources
A Demand source tree defines the relationship between the source of demand, such as an electric
meter, and every piece of equipment that responds to the demand.
176
Environmental Index Sources
The EI Source tree links zones that calculate the Environmental Index to a roll-up program.
Layer the roll-up programs as needed. You can arrange them as shown in the image below. Or, you can
roll the zones into area roll-ups, and then roll the areas into an EI roll-up for the building. Zones and
roll-up programs can be mixed as needed in a roll-up program.
To build or edit a predefined source tree

Predefined source trees are included with every WebCTRL® application and you cannot delete them.
You can assign or unassign equipment and create appropriate parent-child relationships among the
equipment.
1 Open the Source Tree Manager using either of the following methods.
○ Right+click any item in the Geographic tree and select Set up Tree.
○ Click and select Set up Tree.
2 In the Set up Tree window, click to open the Source Tree Manager.
3 In the Source Trees table, select one of the predefined trees.
NOTE You can click the Properties button to view the Tree Name and Reference Name, but you
cannot delete or change them for predefined trees. Type Notes if desired.
4 Click Ok. The Geographic tree and the source tree windows appear below.
5 See Source tree rules for predefined trees (page 178) for details on setting up or editing the source
rules.
177
6 Create and edit your source tree:
○ To move equipment into the source tree, select it the Geographic tree window and also select
the location in the source tree where you want to assign it. Click the Assign button .
○ To remove equipment from the source tree, select it in the source tree and click the Unassign
button .
○ Use Ctrl+click, Shift+click, or both, to select multiple equipment. To deselect, click again.
○ The Assign and Unassign arrows are greyed out for invalid selections.
○ Use the Up and Down buttons to create appropriate parent-child relationships among the
equipment.
○ Any equipment or site that has equipment attached to it, is assigned or unassigned together.
NOTES
○ When the equipment is assigned to the source tree, the rules in the Rules table that match the
mechanical relationships are applied to the equipment sources. The matching microblock
reference names are added in parentheses next to the equipment sources for the rules that
were successfully applied
○ If an error occurs, a description of the error appears in red at the top left of the Source Tree
Manager and at the bottom in the Problem History.
7 Repeat the above until you have a complete source tree.
8 If you add or change source rules, click the Reapply Source Rules button.
Source tree rules for predefined trees

1 Select a predefined tree in the Source Trees table.
2 In the Rules table, do one of the following:
○ Click Add to add a new rule. You must enter both the Parent Microblock Reference Name and
the Child Microblock Reference Name
○ Select a rule, then click Edit to edit its content.
○ Select a rule, then click Delete to delete it.
3 Select the Data Target Microblock Type:
○ InterOp disables the Parent Microblock Reference Name.
○ Tot/Min/Max/Avg adds an asterisk to the Parent Microblock Reference Name to signify a
wildcard, after you save the rule.
○ Manually adding an asterisk to the Parent Microblock Reference Name results in an error.
4 Click Ok.
NOTE If your rules are incorrrectly applied, select the equipment or site in the source tree, and click the
Reapply Rules button under the source tree window. You can choose to clear all existing values or keep
them.
To reapply rules
Select the site or any equipment in the source tree, and click the Reapply Rules button. The rules in the
Rules table that match the mechanical relationships are applied to the equipment sources. The
matching microblock reference names will be added in parentheses next to the equipment sources for
the rules that are successfully applied.
NOTE If any equipment source in the source tree is red, the source tree rules are not applied. Select
the Reapply Rules button to apply the rules in the rules table.
178
If you want to use WebCTRL®'s predefined source tree rules, your input and request microblocks must
have the reference names listed in the table below.
NOTES
• Control programs in the EquipmentBuilder Library use these source tree rules. Automated Logic®
recommends that you do not change the default rules.
• If you change the BACnet device instance number of any parent in a source tree, select the site in
the source tree and select Reapply Rules. In the resulting dialog, you can choose to clear all
existing values or keep them.
Type of request Parent Child

input reference name request reference name
Number of cooling requests in_cool_req cool_request
Number of heating requests in_heat_req heat_request
Number of preheating requests in_heat_req pht_request
Cool runtime in_run_req cl_run_for
Heat runtime in_run_req ht_run_for
Preheat runtime in_run_req pht_run_for
Runtime and occupied state in_run_req run_request_code
Demand level broadcast demand_level demand_level
Airflow stat_press air_flow
Airflow cd_stat_press cd_flow
Airflow hd_stat_press hd_flow
Runtime and occupied state in_run_req_* sys_run_req
Number of active zones in_act_zones_* active_zones
Total weight of zones in_ei_weight-* total_weight
Weighted environmental index in-enviro-windex* enviro_windex
Number of zones in_max_zones_* item_count
179
To create custom source trees
You can create up to 20 custom source trees if the four predefined source trees do not meet your
needs. For example, if the fire/smoke dampers reside in a remote controller and their state must be
retrieved by multiple controllers across the network, you can build a fire/smoke source tree to create
the relationships (source tree rules) between the sending and receiving microblocks.
1 Open the Source Tree Manager using either of two methods.

○ Right+click any item in the Geographic tree and select Set up Tree.
or
○ Click and select Set up Tree.
2 Click the tab.

3 Under the Source Trees table, click Add to open the Tree Properties.
NOTE Once you reach a total of 20 source trees, the Add button is disabled. To add any more
trees, you must first delete one or more custom trees. You cannot delete the predefined trees.
4 Enter descriptive names for the Tree Name and Reference Name. Notes are optional.
NOTE You cannot use upper case, special characters, or the same Reference Name more than
once.
5 Click Ok. The Geographic tree and the source tree appear below.
6 Follow the instructrions below to set up your source rules.
7 Create and edit your source tree:
○ To move equipment into the source tree, select it the Geographic tree window and also select
the location in the source tree where you want to assign it. Click the Assign button .
○ To remove equipment from the source tree, select it in the source tree and click the Unassign
button .
○ Use Ctrl+click, Shift+click, or both, to select multiple equipment. To deselect, click again.
○ The Assign and Unassign arrows are greyed out for invalid selections.
○ Use the Up and Down buttons to create appropriate parent-child relationships among the
equipment.
○ Any equipment or site that has equipment attached to it, is assigned or unassigned together.
NOTES
○ When the equipment is assigned to the source tree, the rules in the Rules table that match the
mechanical relationships are applied to the equipment sources. The matching microblock
reference names are added in parentheses next to the equipment sources for the rules that
were successfully applied
○ If an error occurs, a description of the error appears in red at the top left of the Source Tree
Manager and at the bottom in the Problem History.
8 Repeat the above until you have a complete source tree.
9 If you add or change source rules, click the Reapply Source Rules button.
180
To set up custom source tree rules
When equipment is assigned to the source tree, the rules in the Rules table that define the mechanical
relationships are applied to the equipment sources. The matching microblock reference names are
displayed in parentheses next to the equipment sources when rules are successfully applied.
1 Click Add under the Rules table.
NOTE Source tree rules define network communications between pieces of equipment in the
source tree and enable WebCTRL® to link network points with the correct BACnet objects.
2 In the Parent Microblock Reference Name cell, type the reference name that you defined in the
microblock of the parent control program.
3 In the Child MB Reference Name cell, type the reference name that you defined in the microblock
of the child control program.
4 In the Data Target Microblock type drop-down list, select a microblock type. See table below.
NOTE This selection tells WebCTRL® which direction to send information—parent to child or child
to parent.
5 Click Ok.
6 Repeat above steps if you need to add more source tree rules.
NOTE For WebCTRL® to construct the source tree, you must add a rule for each parent/child
reference name combination found in the tree.
TIP To simplify source tree rules, standardize your parent/child microblock reference name
naming convention
Data Target MB Types Purpose
Network Point Defines Network Input microblocks.
Tot/Avg/Min/Max Allows one control program to receive network values—total, average,

minimum, or maximum— from other control programs.
The Tot/Avg/Min/Max Data Target MB Type is defined differently than the
other types because there are normally more than one of these
microblocks in a control program. The source tree allows you to define a
wildcard reference name in the rule. The microblocks must have identical
names except for a numeric sequence at the end.
For example, cool_request_1, cool_request_2 and
cool_request_55. The reference name must end in unique, but not
necessarily sequential, numbers. SiteBuilder indicates the wildcard status
of a Tot/Avg/Min/Max target microblock by placing an asterisk (*) in
place of the number in the user-identified target reference name.
InterOp The parent reference name is disabled because the target must always
be the child.
Network Input 2 Primary Defines the primary and secondary sources for Network Input 2
and Network Input 2 microblocks.
Secondary
T and B Airflow Defines airflow relationship so that the WebCTRL® test and balance tool
can find the air source during commissioning.
181
Operator access
Privileges control which parts of the 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 operator. See Operators and operator
groups (page 187).
2 Define privilege sets by job function. See Privilege sets (page 183).
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
187).
An operator can change many of his operator settings on the My Settings page (page 189).
To access the WebCTRL® interface, an operator must enter his user name and password. You can
change the rules for passwords in the advanced password policy.
Restricting operator access

To restrict access to your system, you can:
• Restrict an operator's privileges
• Use location-dependent operator access
• 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.
182
Privilege sets
A privilege set is a group of one or more privileges (page 183). The Administrator creates privilege sets
and assigns them to operators and operator groups.
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 330).
• Enable and set up advanced security features such as
location-dependent operator access (page 191).
• Add and remove WebCTRL® add-ons such as EnergyReports.
This Access privilege... allows an operator to access (but not edit)...

Access Geographic Locations pages from the Geographic tree.
Access Network Items pages from the Network tree.
Access Groups
pages from the Schedule Groups tree.
Access Config Items
pages from the System Configuration 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 gains, limits, trip points, hysteresis, color bandwidths, design
Parameters temperatures, and optimal start/stop.
Edit Manual Override Parameters locks on input, output, and network points.
Edit Point Setup Parameters point number, type, range, and network source and destination.
183
This Parameter privilege... allows an operator to edit properties such as...
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.
Edit Trend Parameters enable trend logging, log intervals, and log start/stop times.
Edit Calibration Parameters point calibration offsets.
Edit Hardware Controller driver properties.
Parameters
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 add, edit, and delete alarm messages and actions.
and Actions
Maintain System Parameters edit all properties on the System Settings page.
Maintain Schedules add, edit, delete, and download schedules.
Maintain Schedule Group add, edit, and delete schedule groups.
Members
Maintain Categories add, edit, and delete categories.
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.
184
This Functional privilege... allows an operator to...
Engineer System • 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
• add text in the Notes field on an equipment's Properties page.
• set Device Passwords in SiteBuilder, or the WebCTRL®
interface, to restrict access to the controller setup pages
through the Service Port (applies only to routers with the
drv_gen5 driver)
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. Also required for
Time-lapse.
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 not have his SOAP (web services) changes recorded in the Audit
using SOAP (Web services) Log.
Manual Commands/Console access the manual command dialog box and issue basic manual
Operations 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.
Change My Settings edit his preferences on the My Settings page.
This Digital Signature* allows an operator to...

privilege...
Checked By Add their e-signature to a scheduled report PDF verifying that they
checked the report.
Approved By Add their e-signature to a scheduled report PDF verifying that they
approved the report.
Delete Signature Delete all e-signatures from a scheduled report PDF.
185
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:
Assign... To... Results
Access User HVAC graphics category The security personnel cannot see the HVAC
Category 1 and graphics because they do not have Access User
HVAC technicians only Category 1.
Access User Lighting/Security Graphics The HVAC technicians cannot see the
Category 2 category Lighting/Security graphics because they do not
and have Access User Category 2.
Security personnel only
To add or edit a privilege set

1 On the System Configuration tree, select Privilege Sets.
2 Click Add to create a new privilege set, or select a privilege set to edit.
3 Type the Name and Reference Name for the privilege set.
4 Check each privilege (page 183) that you want to include in the privilege set.
5 Click Accept.
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 (Location-independent security only) 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 On the System Configuration tree, select Privilege Sets.
2 Select the privilege set to be deleted.
3 Click Delete.
4 Click OK.
5 Click Accept.
186
Operators and operator groups
When you create a new system in SiteBuilder, you assign a login name and password to the
administrator operator. This administrator operator sets up each operator in the WebCTRL® interface
by entering the necessary settings and assigning one or more privilege sets (page 183) 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.
CAUTION Passwords can be forgotten. To ensure access to the WebCTRL® administrative

functions, assign the Admin privilege set to at least 2 operators.
To add or edit an operator

1 On the System Configuration tree, select Operators.
2 Click Add to enter a new operator, or select an operator to edit their settings.
3 Enter information on this page as needed. See table below.
4 Click Accept.
Field Notes
Login Name The name the operator must type to log in to the system. This name must be
unique within the system. Login names of deleted operators cannot be
reused.
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
189).
Force User to Forces the operator to change his password immediately after his next login.
Change Password at NOTE Use this field with the Change Password field to create a temporary
login? password that the operator must change after his next login.
Exempt From If Use advanced password policy is enabled on the System Settings >
Password Policy Security tab, select this option if you do not want the policy to apply to this
operator.
Ready to e-sign This checkbox indicates the operator can e-sign documents. It only appears
checked when E-signature file uploaded and Signing privileges granted are
checked.
• E-signature file uploaded indicates the operator has uploaded a valid e-
signature file (page 189).
• Signing privileges granted indicates the operator has e-signature signing
privileges (page 183).
NOTE These checkboxes are read only.
187
Field Notes
Logoff options If Log off operators after __ of inactivity is enabled on the System Settings >
Security tab, select one of the 3 logoff options.
Starting Location The WebCTRL® location and page that will be displayed after the operator
and Starting Page logs in.
System-wide Select the privilege set(s) that you want to assign to the operator. The
Privilege Sets Effective System-wide Privileges list show which privileges the operator will
have.
NOTES
• Click Show current privileges only to see only the selected privilege sets
and privileges.
• A grayed out privilege set with a group name beside it indicates the
operator is inheriting that privilege set from the group.
TIP To test the settings and privileges that you gave to an operator, you can open a second
browser session on your computer and log in as the operator. For instructions on opening a second
session in the browser you are using, see Setting up and using a web browser to view the WebCTRL®
interface (page 315).
To delete an operator
1 On the System Configuration tree, select Operators.
2 Select the operator.
3 Click Delete.
4 Click Accept.
To add or edit an operator group

1 On the System Configuration tree, select Operator Groups.
2 Click Add to create a new operator group, or select an operator group to edit it.
3 Type the Display Name and Reference Name for the operator group.
4 Under Members, select the operators and/or groups that you want to add to the new group.
5 Under Privilege Sets, select the privilege sets (page 183) that you want to assign to the new group.
NOTE To see what privileges are included in a privilege set, go to the Privilege Sets page and then
select the privilege set in the table.
6 Click Accept.
TIP Every operator is automatically a member of a permanent default group called Everybody. You
can assign privilege sets to this group.
188
To delete an operator group
1 On the System Configuration tree, select Operator Groups.
2 Select the operator group.
3 Click Delete.
4 Click Accept.
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
• E-signature file*
NOTE The System Administrator can also change these settings on the Operators page.
To change your settings:

1 On the System Configuration tree, select My Settings.
2 Make changes on the Settings or E-signature* tab. See table below.
3 Click Accept.
Field Notes
Settings Tab
Change password Enable this field, then type your current and new passwords.
Starting Location and The WebCTRL® location and page that will be displayed after you log in.
Starting Page
Language The language and formatting conventions you want to see in the
NOTES
• If you will be using a language other than English, see Setting up
your system for non-English languages (page 346) 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 Expands only one tree branch at a time.
trees
Automatically download Select to automatically download all new schedules that you create and
schedules on each schedules that you change.
change
189
Play sound at browser Check Non-critical alarms or Critical alarms if you want the system to
when server receives audibly notify you when that type of alarm is received.
You can specify a different sound file.
• Edge®, Firefox®, and Safari® support .wav, .mp3, or .au files.
• GoogleTM ChromeTM supports .wav or .mp3 files.
1 Put your file in the webroot\_common\lvl5\sounds folder.
2 In the Sound File field, replace normal_alarm.wav or
critical_alarm.wav with the name of your sound file.
NOTE You can put your sound file anywhere under the WebCTRLx.x
folder, but you must change the path in the Sound File field.
E-signature
E-signature File An e-signature file is required to add an e-signature to Scheduled
Reports (page 164).
1 Click Choose File and select your e-signature file.
2 Click Upload.
Advanced password policy

This feature lets you define the requirements for operator passwords.
2 On the Security tab under Operators, enter information in the fields described below.
NOTE See System Settings (page 319) for information on all the other fields.
Field Notes
Use advanced password policy Enable this field to define rules for passwords.
An operator’s 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.
NOTE This password policy also applies to site-level passwords.
Passwords must contain You can specify how many characters and which of the following
types of characters a password must contain:
• Numbers
• Special characters—any keyboard character that is not a
number or letter.
• Letters—uppercase, lowercase, or both.
Cannot be changed more than Enter a number to limit how often users can change their
once every __ days. passwords. When set to 0, users can change them as often as
they want.
May not be reused until __ Enter a number between 1 and 20. Enter 0 to reuse passwords
different passwords are used. without a delay.
190
Field Notes
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.
NOTE The Advanced password policy settings do not synchronize across hierarchical servers. You
should set up each system with the same advanced password settings to avoid problems when
navigating between the systems.
Advanced security
Location-dependent operator access
Using this feature, 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
operator’s privileges apply throughout the system. You should understand this type of operator access
before switching to location-dependent. See Operator access (page 182) 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:

2 On the Security tab under Security Policy, click Change Policy.
3 Follow the on-screen instructions.
191
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 his My Settings (page 189) page.
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 183).
System-wide privileges Local privileges
Access Groups Access Geographic Locations

Access Config Items Access Network Items
Maintain System Parameters Access Alarms
Maintain Schedule Group Members Access Logic Pages
Maintain Categories Access User Category 1 - 5
Maintain Trends Display and Print Setup Edit Setpoint Parameters
Maintain Alarm Templates Edit Setpoint Tuning Parameters
Acknowledge Non-Critical Alarms Edit Tuning and Logic Parameters
Acknowledge Critical Alarms Edit Manual Override Parameters
Force Normal Non-Critical Alarms Edit Point Setup Parameters
Force Normal Critical Alarms Edit Restricted Parameters
Delete Non-Critical Alarms Edit Category Assignments
Delete Critical Alarms Edit History Value Reset
Execute Audit Log Report Edit Trend Parameters
Download Controllers Edit Calibration Parameters
System Shutdown Edit Hardware Controller Parameters
Engineer System Edit Critical Configuration
Access Commissioning Tools Edit Area Name
Maintain Graphs and Reports Edit Control Program Name
Maintain Connections Edit Alarm Configuration
Remote File Management InterOp Privilege 1 - 10
Remote Data Access-SOAP Manage Alarm Messages and Actions
Do not audit changes made using SOAP (Web services) Maintain Schedules
Manual Commands/Console Operations
Manual Commands/File IO
Manual Commands/Adv Network
Manual Commands/Unrestricted
Change My Settings
NOTES
• 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.
192
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 183).
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 187).
Assign a local privilege set to an operator at locations on the Geographic or Network tree
where he needs the privileges.
1 Select a location on the Geographic or Network tree.
2 Click Privileges.
3 On the Configure tab, 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 Accept.
NOTE You can display icons and hover text on the Geographic tree that show where privileges have
been assigned. See Tree icons and hover text (page 15).
To delete a local privilege set assignment

1 On the Geographic or Network tree, select the location where the assignment was made.
2 Click Privileges.
3 Select the assignment under Privilege Set Assignments at this Level.
4 Click Delete.
5 Click Accept.
193
Restricting access in the system
Restricting an operator’s 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 can’t access
them and does not need them to navigate.
Restricted access Full system access
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 uncheck Inherit security privileges from
above this level.
Security Assignments Report

A Security Assignments Report shows an operator’s local and system-wide privileges and privilege sets
at a specific location.
1 Select the location on the Geographic or Network 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.
194
Recording reasons for edits (21 CFR Part 11)
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,
or acknowledging an alarm, before it accepts the change. The WebCTRL® Audit Log report then
displays the operator's name and the recorded reason for making the change.
To set up equipment to require reasons for changes

1 On the WebCTRL® Geographic or Network tree, right-click the equipment, then select
Configure.
2 Check Require operator to record any changes to control program and when acknowledging
alarms.
NOTE In order to enable this feature to record changes, you must also enable Alarm requires
acknowledgment and/or Return requires acknowledgment. See To set up, edit, or disable alarm
sources (page 99).
3 Click Accept.
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 On the WebCTRL® tree, select a piece of equipment that requires reasons for change.
2 Click the Reports button drop-down arrow, select Security > Location Audit Log or System Audit
Log.
3 On the Options tab under Display the following columns, check Reason.
4 Click Run.
195
Cost-saving strategies
HVAC equipment runs to maintain adequate zone temperatures. 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 52) Define when a building or zone is occupied and

whether or not equipment should run, depending on
the occupied setpoints.
Optimal Start (page 45) Ensures that a zone’s ideal comfort range is reached
just as the zone becomes occupied.
Demand Control (page Relaxes heating or cooling setpoints when a certain

47) level of energy use is reached in order to avoid peak
demand, ratchet, or time of use electric charges.
Setpoint Optimization Calculates a piece of equipment’s setpoint based on

(page 49) (Trim and the number of heating or cooling requests it receives
Respond) from other equipment.
196
Advanced topics
Manual commands
To run a manual command:
1 Click , then select Manual Command.

2 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.
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 Network tree.
autopilot location Displays the full path for the current location. You can copy and
paste the path into Enter custom autopilot location of the Autopilot
add-on user interface. See the Autopilot User Guide for details.
bacnet bind show Shows the selected device's current BACnet bindings.
bacnet bind clear Clears the selected device's BACnet bindings so that they can be
rediscovered.
bacnet showindex Displays all files (file name, size, date) downloaded to the selected
controller.
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 Selects BBMDs on the specified network and marks them for
number> 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
197
Command Description
bbmd view <network Views the list of BBMDs that have been selected for the network
number> number at the end of the command. Assumes the update has been
run.
For example:
bbmd view 888
bbmd viewall <network> Displays all devices with auto-managed bbmd for network
bbmd write <table file> <IP Writes the BBMD table into the controller at the given IP address.
address> See To set up BBMDs through the WebCTRL® interface (page 228,
page 229).
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> Writes to a file the BBMD from the specified controller.
<file> For example:
bbmd dump 888 dallasbbmd.bdt
bbmdFdr [active] Returns information on which BBMD is active for FDR (no
[<connection>] connection parameter gives information on all active connections)
checkurls 1 Finds all network point exp: expressions for the selected item on
the Geographic or Network tree.
2 Converts the exp: expressions to bacnet:// equivalent
expressions that the controllers use.
3 Compares the equivalent bacnet:// expressions to the bacnet://
expressions currently downloaded in the controllers.
4 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 36).
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.
198
Command Description
download s Downloads schedules only.
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
See Defining WebCTRL paths (page 206).
go ~net Takes you from a piece of equipment on the Geographic tree to
the same equipment on the Network tree.
go ~geo Takes you from a piece of equipment on the Network tree to the
same equipment on the Geographic tree.
go ~device Takes you to the controller for a point or piece of equipment on the
Network tree.
go ~network Takes you to the network the selected object’s 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 microblock’s equipment in the
navigation tree.
For example:
go -logicpopup lstat
go <device ID> Goes to a device on the Network tree.
For example, to go to device 301205 referenced in a dead module
alarm, type:
go 301205
go <device ID>/<object Goes to a device and object on the Geographic or Network
ID> tree.
For example:
go 300550/AI:3
go <object ID> Goes to an object for the current device on the Geographic or
Network 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
199
Command Description
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 the user's ID.
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 Network tree > 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 (page 236) 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 Displays status of the controller at the current location, including:
• 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 Displays status for a specific controller in the IP network using the
number> controller’s ID. Your location in the system does not have to be the
controller you are querying.
For example:
modstat 8:489202
modstat mac:<network Displays a Modstat for a specific controller in the system using the
number>,<media type>: controller’s MAC address. Network number is the number of the
<mac address> 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
controller’s media type.
For example:
modstat mac:48161,ms/tp:2
or
modstat mac:888,bacnet/ip: 172.16.101.119
notify 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.
200
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 Geographic tree. If you
want to do this for everything under a particular router, navigate to
the router or the network on the Network 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)
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. If you make changes to control program
property text in the EIKON® application, navigate to a control
program in the WebCTRL® tree, and then run this command to see
your changes.
reload Reloads a control program. Use if you make changes to control
program in the EIKON® application. Reloading updates all instances
of the control program throughout the system and marks the
controller(s) for download. The WebCTRL® application determines
the type of download based on what changed in the control
program. 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 controller’s network number does not agree
with SiteBuilder’s 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.
201
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 Generate controller alarm after no communication
for ___ minutes (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
• 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 LANgate’s phone
numbers on the LANgate’s 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.
202
Command Description
sreview Provides a Security Report that displays critical security compliance
in your WebCTRL® system. This includes:
Web Server
• SSL Mode: on or off or both
• TLS in use: true or false (only displayed if SSL Mode is on)
• TLS protocols: version number (only displayed if SSL Mode is on)
• Allow unsigned add-ons: true or false
• Allow SOAP over HTTP: true or false
• Reads X-Forwarded-For Header: true or false
Certificate
• Self-signed certificate in use: true or false
• Certificate issued by: Distinguished Name of the certificate
signer
• Certificate expired: true or false
• Certificate not yet valid: true or false
• Certificate expires: date and time the certificate becomes invalid
Email
• Secure SMTP enabled on email server: true or false
Passwords
• Password policy enforced: true or false
Software Updates
• Latest cumulative update applied: none or date
You must have the Admin 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 Geographic
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 on the Network 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.
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.
203
Command Description
upgradejsp commands: Upgrading to a v6.0 or later system automatically upgrades any .jsp
graphics created in WebCTRL® Extensions for FrontPage. If you edit
one of the .jsp files after upgrade, you must run one of the following
commands. These commands could take several minutes to
complete. A message is displayed when finished.
upgradejsp <absolute path> Use to update a single graphic. For example:
c:\webctrlx.x\programdata\systems\<system>\graphics\lvl5\sitea\
building1.jsp
upgradejsp <folder path> Use to update all graphics in a folder. For example:
c:\webctrlx.x\programdata\systems\<system>\graphics\lvl5\sitea
upgradejsp all Use to update all graphics in <system>\graphics\lvl5
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 a web 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.
System database maintenance

You should perform the following system maintenance on a regular basis. See To safely shut down the
WebCTRL® application for database server maintenance (page 206) before doing any maintenance on
your database server.
To back up a system
The type of database your system uses determines the method you use to back up the system. In
WebCTRL®, you can find the database type on the System Settings (page 319) > General tab.
CAUTION Do Not use SiteBuilder's Replicate feature to back up your database.
For Apache Derby or SQL Server Express

1 Shut down the SiteBuilder and WebCTRL Server applications.
2 Copy your system folder.
3 Paste the copy to a new location.
TIP Zip the copy before transporting it over a network or to a CD.
204
For MySQL, MS SQL Server, Oracle, or PostGreSQL
1 Follow the instructions above to copy your system folder.
2 Use the database management system's backup method. See To safely shut down the WebCTRL®
application for database server maintenance (page 206) before doing any maintenance on your
database server.
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.
Compacting the database

The following databases are compacted dynamically—compacting occurs in the background when a
database is open.
• MySQL
• MS SQL Server
• MS SQL Server Express
• Oracle
• PostGreSQL
To compact a Derby database:

1 Shut down the SiteBuilder and WebCTRL® Server applications.
2 Open the computer's Command Prompt application and type cd c:\WebCTRLx.x, replacing x.x
with your system version number.
3 Click Enter.
4 Type "Derby Compression Tool.exe" <system name>.
5 Click Enter.
6 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.
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 server—especially if people access the
Internet from this computer.
205
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 325)" in WebCTRL® Help.
To safely shut down the WebCTRL® application for database server

maintenance
Occasionally, the database server is shut down for maintenance or backups. If this is done without
shutting down the WebCTRL® Server first, the database may get locked and the WebCTRL® application
may not be able to reconnect.
1 Shut down the WebCTRL® application.
2 Shut down the database server.
3 Perform the maintenance or repair needed on the server.
4 Restart the database server.
5 Restart the WebCTRL® application.
To unlock a database
1 In SiteBuilder, click File > Open and Select Database to open your site. The following message
appears The database appears to be in use by another application ….. Do you want to override
the lock?”
2 Click Yes to override the lock.
3 Log in to the site.
4 Exit SiteBuilder.
5 Start the WebCTRL® Service.
Defining WebCTRL® paths

A path tells the WebCTRL® application the route through the system hierarchy to an item in the system.
For example, a path tells the WebCTRL® application where to find a microblock property value to
display on a graphic or where to jump to when the operator clicks a link on a graphic.
You can use semantic tags as part of the path. See Using semantic tags in a path (page 212).
In ViewBuilder, you use paths in:

• Controls
• Links
• Conditional expressions
In WebCTRL®, you use paths in:

• The source field code (page 106) in alarm actions and messages
• An Equipment Values report (page 166)
• The go manual command
• Custom reports (page 123)
206
You can do one of the following to get the path:
• In ViewBuilder, let ViewBuilder write the path or use Logic Graphics Properties that were defined in
the EIKON® application.
• In the WebCTRL® interface, determine the path yourself (page 210).
A path consists of the reference name of each tree item included in the path, separated by a forward
slash (/). For example, first_floor/zone_1/lstat.
A path can be absolute (page 207) or relative.
WebCTRL® paths are based on parent-child hierarchy. In the tree below, the Lobby is a child of First
Floor, and First Floor is a child of Atlanta R&D Facility. Conversely, Atlanta R&D Facility is the parent of
First Floor, which is the parent of Lobby.
A system in the WebCTRL® Same system in SiteBuilder showing
interface: reference names in blue:
Absolute path
An absolute path begins at a specific point in the system hierarchy and is followed by the children
below it down to the object or property of interest. An absolute path can begin with either of the
following:
• A global reference name—a reference name that is unique within the entire system and begins with
a # sign.
EXAMPLE If OA Conditions has a global reference name of #oa_conditions, the absolute path to OA
Conditions is simply #oa_conditions. The absolute path to any child of OA Conditions, such as OA
Temperature, begins with #oa_conditions. For example, #oa_conditions/oa_temp.
• The top of the WebCTRL® tree
EXAMPLE (using the system in the figure above) To display the Lobby’s zone temperature on any
graphic, the absolute path is /trees/geographic/atlanta_-_rd_facility/first_floor/zone_1/lstat.
207
Relative path
A relative path is useful for items such as graphics or alarm messages that you will reuse in multiple
WebCTRL® locations because the path is relative to the item that contains the path.
A relative path going down the tree

A relative path going down the tree begins with the reference name of the item below the location
where the path is used. Examples using the system shown above:
• To display the Lobby’s zone temperature on the Lobby’s graphic, the path is rs.
• To display the Lobby’s zone temperature on the Atlanta-R&D Facility graphic, the path is
first_floor/zone_1/rs.
A relative path going up the tree

A relative path going up the tree begins with a ~ followed by one of the options below:
Use... To go... Examples using the system shown above

~parent Up one level 1 To put a link on the Lobby graphic that goes to
the First Floor graphic, the path is ~parent.
2 To put a link on the Lobby graphic that goes to
the Atlanta R&D Facility (up 2 levels), the path is
~parent/~parent.
3 To display the Lobby’s zone temperature on the
Boiler graphic, the path is ~parent/~parent/
first_floor/zone_1/lstat/present_value.
~equipment To the microblock's control To display the Lobby zone temperature in a High
program Temp alarm message, the path is
~equipment/lstat/present_value.
~device From a control program in To show the device name on an equipment graphic,
the Geographic tree to its use ~device.display-name.
device in the Network tree.
~network From a location in the 1 To show the network name on an equipment
Network tree up to its graphic, ~device/~network.display-name.
network (IP, ARCNET, etc.) 2 To show the network number on a dead module
alarm, use the following field code and path:
$source:~network.network-number$.
~geo From a control program in Use the manual command go ~geo.
the Network tree to the
same item in the
Geographic tree.
~net From a control program in Use the manual command go ~net.
the Geographic tree to the
same item in the Network
tree.
208
Use... To go... Examples using the system shown above
~instance(#) To sibling equipment See the system shown below. To display the Boiler
within a multi-equipment Plant outdoor air temperature on the Chiller Plant
device graphic, the path is ~instance(2)/oat/present_value.
Relative path to heat, cool, demand, or custom source values

To get a heat, cool, demand, or custom source value, use one of the following relative paths, replacing
xxx with the reference name of the point you want to display and yyy with the reference name of a
custom tree.
~heat/~parent/~geo/xxx
~cool/~parent/~geo/xxx
~dem/~parent/~geo/xxx
~changetree(yyy)/~parent/~geo/xxx
NOTE You must do the following before you can display a source value using the above paths. In the
EIKON® application, configure Analog Status microblocks in the child control program for outgoing
heat, cool, and run requests. Also configure Total, Minimum, and Maximum microblocks for the
incoming requests in the parent control program. In SiteBuilder, assign your child equipment to its
parent on the Heat Source or Cool Source tab. See “Building source trees” in SiteBuilder Help.
Relative path to prime variables and thermographic colors

To get a prime variable, use the relative path ~prime. The control program must contain a Prime
Variable microblock.
To get a thermographic color, use the relative path ~color. The control program must contain a Setpoint
or Set Color If True microblock
209
Determining a path or microblock property
To get the path to an area, equipment, or microblock
In the WebCTRL® interface, right-click the item on the tree, then select Copy Path. Paste the path
where you need it.
210
To get the path to a microblock property value
1 In the WebCTRL® interface, right-click the value, then select Global Modify.
2 Click Show Advanced to see the full path to the property value and the Edit Privilege associated
with the property.
211
Using semantic tags in a path
You can use a semantic tag in place of a reference name in paths. Follow the conventions in the table
below to use them in the WebCTRL® v8.5 interface to set up custom reports and, in ViewBuilder, to use
on graphics. See "Semantic tagging" in WebCTRL® Help for details on assigning tags and the rules
governing them.
Specify a semantic tag A tag is always preceded by "@" to differentiate it from a reference
name.
Use multiple tags "|" for ANY
"&" for ALL
Examples
• @tag1|tag2|tag3 - find the first child tagged "tag1" OR "tag2" OR
"tag3" (ANY tag)
• @tag1&tag2&tag3 - find the first child tagged "tag1" AND "tag2"
AND "tag3" (must have ALL tags)
NOTE You cannot mix "|" and "&" in the same tag list.
Search up Search from the current location and up by prefixing the tag with
"@up:".
Example
@up:tag1&tag2 - search up the tree, including the current location for
a location with "tag1" AND tag2"
Search down Search from the current location and down by prefixing the tag with
with "@down:". This returns the first matching location.
Example
@down:tag1&tag2 - search down the tree, INCLUDING the current
location for tags with "tag1" AND tag2"
Get a value Value tags can be used like an attribute. Use the "@" tag name where
an attribute would be specified.
NOTE Like all attributes, you must precede the name with a period to
obtain a value.
Examples
• #floor1.@area
• To search up for a location with an Area tag and get the Area tag
value: @up:area.@area
212
Determining a path or microblock property in a converted SuperVision system
1 Follow the procedure in Determining a path or microblock property (page 210) to get the
equipment path. For example, #o_a_conditions_1801.
2 Select the equipment on the Geographic tree.
3 Click Properties.
4 Alt+click the value that you want the path to.
In Global Modify, the Expression field shows the path to the microblock property.
The full path of the microblock property is

#o_a_conditions_1801/legacy_fb/status/rtre/val
NOTES
• A status microblock does not have a property.
• For a graphic to display a trend graph for a microblock property in a converted SuperVision system,
type the microblock property path followed by /~trend in the trend graph control's Trend
location field. To add a comparison trend graph, type the path followed by /~reports/<name
of trend>.
213
Setting up and configuring a WebCTRL® system
Setting up networks
Setting up IP network communication

To set up an IP network:
1 Set the controllers' IP addresses. See:
Setting ExecB controller IP addresses (page 215)
Setting OptiFlex™ controller IP addresses (page 222)
2 Set up a BACnet/IP connection in the WebCTRL® interface (page 223)
3 Test the server-to-client connections (page 227)
4 Test the server-to-controller connections (page 228)
5 Set up BACnet Broadcast Management Devices if an IP router is used. (page 228)
NOTES
• The WebCTRL® server name must be less than 15 characters and must not contain hyphens or
underscores.
• For Linux systems, you must change the WebCTRL® server's default name (localhost.localdomain).
214
Setting ExecB controller IP addresses
For the WebCTRL® server to communicate with Automated Logic® controllers on the IP network, the
WebCTRL® server and each controller must have the following:
• IP address (unique and static)
• Subnet mask
• Default gateway address, if your system has a default gateway (IP router)
You can use one of the following IP addressing methods for the WebCTRL® system.
Use... If...
DHCP addressing The IP network uses a DHCP server for IP addressing

(page 215)
(requires v6.0 or later
controller drivers)
Custom addressing The answer to any of the following questions is yes and you do not have a
(page 217) DHCP server.
• Will the system share a facility's existing IP data network?
• Will it have 199 or more Automated Logic® IP devices, or 254 or more
devices with static IP addresses?
• Will it be connected to the Internet?
• Will it have at least one device located on the other side of an IP router?
• Will it have any third-party controllers?
Default addressing The answer to all of the above questions is no.
(page 221)
To set an ExecB controller's DHCP IP address

PREREQUISITES
• A computer with a USB port
• A USB Link Kit. See the USB Link Kit Technical Instructions.
NOTE The USB Link Kit driver is installed with a WebCTRL® v5 or later system. Please refer to the
Silicon Labs website and search "CP210x USB to UART Bridge VCP Drivers" for the most current
device drivers. Install the driver before you connect the USB Link Kit to your computer.
• v6.0 or later driver
CAUTION If multiple controllers share power but polarity was not maintained when they were
wired, the difference between the controller's ground and the computer's AC power ground could
damage the USB Link Kit and the controller. If you are not sure of the wiring polarity, use a USB isolator
between the computer and the USB Link Kit. Purchase a USB isolator online from a third-party
manufacturer.
215
1 Connect the computer to the controller using the appropriate USB Link Kit cable(s).
Connect to C onnec t to 5 - pin
U SB port L oc al A c c es s port
7 3/4 in. 12 ft.

ALC Part #2 3 5 0 3 8 ALC Part #2 3 5 1 2 3

12 ft.
ALC Part #2 3 5 1 2 5
NOTE If using a USB isolator, plug the isolator into your computer's USB port, and then plug the
USB Link Kit cable into the isolator.
2 LGR line or ME line controller only: Turn off the controller's power, set its Enhanced Access Port
DIP switch to ON, then turn its power on again.
3 In SiteBuilder, set your Configure > Preferences > Connections tab settings.
Field Value
Port The laptop's Com port number that the USB Link Kit is connected to.
Baud Rate 115200
Data Bits 8
Parity None
Stop Bits 1
4 On the Network tree, double-click the controller.

5 On the Address tab, click Module Status.
6 Note the controller’s Ethernet MAC address.
7 When finished, turn off the controller's power, set its Enhanced Access Port DIP switch to OFF to
restore normal functionality to the Local Access port, then turn the power on again.
8 Give the Ethernet MAC address to your DHCP network administrator and request that he reserve a
static IP address for that MAC address.
9 Get from him the reserved IP address, subnet mask, and default gateway address for your router.
10 Repeat steps 1 and 2.
11 Set the controller's Default/Assigned DIP switch to Default.
12 Repeat steps 3 and 4.
13 On the Address tab, select Specify a custom or DHCP IP Address.
14 Type the IP Address, Subnet Mask, and Default Gateway Address that the DHCP network
administrator gave you.
15 Click Download Address.
16 LGR line or ME line controller only: When finished, turn off the controller's power, set its Enhanced
Access Port DIP switch to Off, then turn the power on again.
216
To set the ExecB controller's custom IP address
If your system's IP addresses are assigned by the network administrator, you can connect a laptop to a
controller's Local Access Port and then use either of the following methods to set the controller's
custom IP address so that the WebCTRL® server can communicate with it.
• Set the custom IP address in SiteBuilder (page 217)
• Set the custom IP address using PuTTY (page 218)
To set a controller's custom IP address in SiteBuilder

PREREQUISITES
• The appropriate controller driver
Local Access port Product ExecB driver requirement
5-pin LGR or ME line v1.73a.038 or later
Round 8-pin LGE, LGRM-E v2.00 or later
manufacturer.
7 3/4 in. 12 ft.

ALC Part #2 3 5 0 3 8 ALC Part #2 3 5 1 2 3

12 ft.
ALC Part #2 3 5 1 2 5
3 Set the controller's IP Address DIP switch to Assigned.
217
4 In SiteBuilder, set your Configure > Preferences > Connections tab settings.
Field Value
Port The laptop's Com port number that the USB Link Kit is connected to.
Baud Rate For LGR, ME line 115200
For LGE or LGRM-E 38400
Data Bits 8
Parity None
Stop Bits 1
5 Click OK.
6 Double-click the controller.
7 On the Address tab, select Specify a custom or DHCP IP Address.
8 Type the IP Address, Subnet Mask, and Default Gateway Address.
9 Click Download Address.
10 After the download is complete, click Module Status to verify the router's address.
To set a controller's custom IP address using PuTTY

PREREQUISITES
Local Access port Product ExecB driver requirement
5-pin LGR or ME line v1.73a.038 or later
Round 8-pin LGE, LGRM-E v2.00 or later
manufacturer.
218
1 Download and install PuTTY from the PuTTY website
(http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html).
7 3/4 in. 12 ft.

ALC Part #2 3 5 0 3 8 ALC Part #2 3 5 1 2 3

12 ft.
ALC Part #2 3 5 1 2 5
4 Set the controller's IP Address DIP switch to Assigned.
5 Start PuTTY.
6 Under Category > Connection, select Serial.
7 Under Options controlling local serial lines, enter the following settings:
Field Value
Serial line to connect to Replace X with the computer's port number that the USB Link Kit
cable is connected to.
NOTE To find the port number, select Start > Control Panel >
System > Device Manager > Ports (Com & LPT). The COM port
number is beside Silicon Labs CP210x USB to UART Bridge.
Speed (baud) Type the appropriate baud rate from the table below.
For... Speed
LGR, ME 115200 for Rnet
38400 for S2
LGE, LGRM-E, WebPRTL 38400
Data Bits 8
Stop Bits 1
Parity None
Flow Control None
219
8 Click Open. A window similar to the one below appears.
9 Type the number of the address field, then press Enter.

10 Type the new address, then press Enter.
11 Type 1, then press Enter to restart the controller.
12 Close PuTTY.
To remotely change a controller's custom IP address

Steps 1 through 5 below change the IP address in the controller. Steps 6 through 10 change it in the
system database. Communication with the controller will be disrupted until all steps are performed.
1 On the WebCTRL® Network tree, go to the controller's Driver > BACnet Router Properties
page.
2 Under IP Configuration, select Enable IP configuration changeover.
NOTE The field Allow remote management of IP configuration is for future use.
3 In the Next column, type the new IP Address, Subnet Mask, and Default Gateway Address. Type
the UDP Port that your server is using to communicate to all controllers.
NOTE You must enter values in all 4 fields, even if the values will not change.
4 Do one of the following.
Set the Changeover timeout To have the controller use the Next settings...
field to...
0:00 As soon as the controller can communicate with the Next Default
Gateway Address.
A specific length of time As soon as the controller can communicate with the Next Default
Gateway Address, or when the timeout expires, whichever occurs
first.
220
5 Click Accept.
6 On the System Configuration tree, select Connections.
7 On the Configure tab, select the BACnet/IP Connection, then click Stop.
8 On the Network tree, go to the controller's Properties page.
9 Make the necessary changes in the Address, Subnet mask, and Default Gateway fields.
10 Click Accept.
12 On the Configure tab, select the BACnet/IP Connection, then click Start.
13 On the Network tree, go to the controller's Properties page, then click Module Status to verify
communication with the controller.
To set an ExecB controller's default IP address

NOTES
• If you want to use the default IP addressing but a DHCP server exists, follow the instructions in To
set a controller's custom IP address (page 217), and enter the default addresses listed in step 2
below.
• A network using default addressing does not have a default gateway (IP router).
1 If wired for power, turn off the controller's power.
2 NOTE The controller only reads the rotary switch positions during power up or upon reset.
3 Set the Default/Assigned DIP switch to the Default position to use the following IP networking
parameters.
IP address = 192.168.168.x
where x is the controller address you will set in steps 3 and 4.
Subnet mask = 255.255.255.0
Default gateway address = 192.168.168.254
4 Using the rotary switches, set the controller's address to match the Address in the controller's
properties dialog box in SiteBuilder. Set the Tens (10's) switch to the tens digit of the address, and
set the Ones (1's) switch to the ones digit.
5 Set the +0/+100 DIP switch to off for a controller address from 0 to 99, or to on for a controller
address from 100 to 199. (On your controller, this DIP switch may be labeled 100's or +100 and 0.)
EXAMPLE Setting the switches as shown in the figures below produces an IP address of
192.168.168.125.
10's 1's
Default/Assigned
9 0 9 0
1
1
7 8
7 8
2 34
2 34
+0 / +100
5 5
O
N
6 On SiteBuilder's Network tree, double-click the controller.

7 On the Address tab, select Use Default IP Address.
8 In the Address (Dial Setting on Device) field, type the value of x.
9 Click OK.
NOTE The default address is an intranet address. Data packets from this address are not routable to
the Internet.
221
Setting OptiFlex™ controller (drv_fwex driver) IPv4 addresses
See the device's Technical Instructions for details.
For the WebCTRL® server to communicate with Automated Logic® controllers on the IP network, the
WebCTRL® server and each controller must have the following:
• IP address (unique on the IP network)
• Subnet mask
• Default gateway address, if your system has a default gateway (IP router)
Use one of the IP addressing schemes described below with the associated instructions that follow.
Use a... If...

DHCP IP Address The IP network uses a DHCP server for IP addressing
generated by a DHCP server
Custom Static IP Address You do not use a DHCP server and the answer to any of the
from your network administrator following questions is yes. Will the WebCTRL® system:
• Share a facility's existing IP data network?
• Have 254 or more devices with static IP addresses?
• Be connected to the Internet?
• Have at least one device located on the other side of an
IP router?
• Have any third-party IP devices?
Default IP Address The answer to all of the above questions is no.

that your system creates
NOTE Carefully plan your addressing scheme to avoid duplicating addresses. If third-party devices are
integrated into the system, make sure your addresses do not conflict with their addresses.
To set the IP address in the controller setup pages

You must define the OptiFlex™ controller's IP address in 2 places, in SiteBuilder and in the controller
setup pages. Defining it in the controller setup pages sets the IP address in the controller. See the
device's Technical Instructions for details.
To remotely change the OptiFlex™ controller's custom IP address

Steps 1 through 5 below change the IP address in the controller. Steps 6 through 10 change it in the
system database. Communication with the controller will be disrupted until all steps are performed.
1 On the WebCTRL® Network tree, go to the controller's Driver > BACnet Router Properties
page.
2 Under IP Configuration, select Enable IP configuration changeover.
3 In the Next column, type the new IP Address, Subnet Mask, and Default Gateway Address. Type
the UDP Port that your server is using to communicate to all controllers.
NOTE You must enter values in all 4 fields, even if the values will not change.
222
4 Do one of the following.
Set the Changeover timeout To have the controller use the Next settings...
field to...
0:00 As soon as the controller can communicate with the Next Default
Gateway Address.
A specific length of time As soon as the controller can communicate with the Next Default
Gateway Address, or when the timeout expires, whichever occurs
first.
5 Click Accept.
7 On the Configure tab, select the BACnet/IP Connection, then click Stop.
8 On the Network tree, go to the controller's Properties page.
9 Make the necessary changes in the Address, Subnet mask, and Default Gateway fields.
10 Click Accept.
12 On the Configure tab, select the BACnet/IP Connection, then click Start.
13 On the Network tree, go to the controller's Properties page, then click Module Status to verify
To set up a BACnet/IP connection in the WebCTRL® interface

Using a BACnet/IP connection and an Ethernet Network Interface Card, the WebCTRL® server can
speak BACnet/IP over an Ethernet network.
2 On the Configure tab, select BACnet/IP Connection.
3 If the Status column shows:
○ Connected, click Disconnect.
○ Stopped or Design Mode, go to step 4.
4 Set up the fields as needed for that connection. See tables below.
5 Click Accept.
6 If running the WebCTRL Server (not WebCTRL Design Server) application, select the BACnet/IP
Connection, then click Start.
223
Field or button Notes
Server IP Address Type the server's IP address. The IP address and subnet mask must
also be set on the server's network connections page.
NOTE If the server has more than 1 NIC, use the IP address of the
interface connected to the controllers.
Server IP Subnet Mask • For default IP addressing, type 255.255.255.0.
• For custom IP addressing, type the subnet mask provided by the
facility network administrator.
BACnet Port Type 47808 unless you need to communicate with a third-party device
using a different port for BACnet communication or your IT
administrator specified a different port.
Disable Field Alarms Select if you do not want to retain incoming alarms on this connection.
Typically this box might be checked during start-up then cleared for
normal operation.
Poll Interval How often the WebCTRL® application checks the communication
status of the peer caching router. If it cannot communicate with the
router, the WebCTRL® application generates a Dead Module Timeout
alarm.
Foreign Device If the WebCTRL® server is on an IP network segment that does not
have an Automated Logic® controller serving as a BBMD, select Force
Registration. See Setting up BBMDs (page 228).
Register with Device If you selected Force Registration in the previous field, select the
BBMD on a remote IP network from which the WebCTRL® server will
receive BACnet/IP broadcasts.
Network Node Specify which network the WebCTRL® server is physically connected
to. This is primarily used to specify which ARCNET network the ARCNET
card is connected to. This is also used to specify which BACnet/IP
network the WebCTRL® server is on if there are multiple BACnet/IP
network nodes with different network numbers in your system.
Tuning Parameters Notes
Comm Timeout Amount of time, in milliseconds, that is allowed before retrying a

transmission on the network if a required acknowledgment is not
received.
Comm Attempts The number of times to try a transmission on the network.
Do Sync Amount of time, in milliseconds, allowed for the WebCTRL®
application to complete a communication task such as downloading to
a controller or reading trends from a controller.
Register FD Interval Amount of time, in seconds, that is allowed before the WebCTRL®
application notifies a BBMD that the WebCTRL® server is a foreign
device to that BBMD. If the re-registration does not occur within this
time, the BBMD will delete the WebCTRL® server from its list.
224
To set up a BACnet/IPv6 connection in the WebCTRL® interface
Using a BACnet/IPv6 connection and an Ethernet Network Interface Card, the WebCTRL® server can
speak BACnet/IPv6 over an Ethernet network.
2 On the Configure tab, select BACnet/IPv6 Connection.
4 Set up the fields as needed for that connection. See tables below.
5 Click Accept.
6 If running the WebCTRL Server (not WebCTRL Design Server) application, select the BACnet/IPv6
Connection, then click Start.

Server IPv6 Address Type the server's IPv6 address. The IPv6 address and subnet mask
must also be set on the server's network connections page.
NOTE If the server has more than 1 NIC, use the IP address of the
interface connected to the controllers.
Prefix Length Value set between 10 and 128 to define the number of leftmost bits
identifying the network portion of the address.
BACnet Port Type 47809 unless you need to communicate with a third-party device
using a different port for BACnet communication or your IT
administrator specified a different port.
Ensure that you IPv6 ports are different than your IPv4 ports and that
you assign the connection to the same IPv6 multicast group.
IPv6 Multicast Address Used for broadcasts on an IPv6 network using SLAAC. Defined by the
building network administrator.
IPv6 Multicast Port The port that the controller will use for BACnet communication
broadcasts and must be the same as the BACnet Port.
Disable Field Alarms Select if you do not want to retain incoming alarms on this connection.
Typically this box might be checked during start-up then cleared for
normal operation.
Poll Interval How often the WebCTRL® application checks the communication
status of the peer caching router. If it cannot communicate with the
router, the WebCTRL® application generates a Dead Module Timeout
alarm.
Foreign Device If the WebCTRL® server is on an IPv6 network segment that does not
have an Automated Logic® controller serving as a BBMD, select Force
Registration. See Setting up BBMDs (page 228).
Register with Device If you selected Force Registration in the previous field, select the
BBMD on a remote IPv6 network from which the WebCTRL® server
will receive BACnet/IPv6 broadcasts.
Primary BBMD If you selected Force Registration in the previous field, select the
primary BBMD.
225
Backup BBMD if To have a backup in case the first BBMD fails, select another BBMD.
primary fails
to. This is used to specify which BACnet/IPv6 network the WebCTRL®
server is on if there are multiple BACnet/IPv6 network nodes with
different network numbers in your system.
Comm Timeout Amount of time, in milliseconds, that is allowed before retrying a

transmission on the network if a required acknowledgment is not
received.
Do Sync Amount of time, in milliseconds, allowed for the WebCTRL®
application to complete a communication task such as downloading to
To set up a BACnet/IP Service Port connection in the WebCTRL® interface

You can connect to the Service Port to access your network through the:
• WebCTRL® application
• Automated Logic® touchscreen device
The Service Port on OptiFlex™ controllers could be either an Ethernet or USB port. Also, the information
shown on the controller setup pages is specific to the controller. See the controller's Technical
Instructions for details on connecting the controller's Service Port to a laptop and on using the
controller setup pages.
1 Connect the controller's Service Port to your laptop as specified in the Technical Instructions.
2 Turn off the computer's Wi-Fi if it is on.
3 If your computer uses a static IP address, use the following settings:
○ Address: 169.254.1.x, where x is 2 to 7
○ Subnet Mask: 255.255.255.248
○ Default Gateway: 169.254.1.1
4 If it uses a DHCP address, leave the address as it is.
5 Open a web browser on the computer and open your WebCTRL® application.
6 In the WebCTRL® interface, on the System Configuration tree, select Connections.
7 On the Properties page > Configure tab, select BACnet/IP Service Port Connection from the drop-
down list and click Add.
8 If needed, enter the Service Port Network Number as follows:
○ 0 - the will communicate only with the computer or
○ 1 to 65534 - the 's network number for network communication
○ 65535 - searches for an available network number from 65531 to 65534. If any of these
numbers are not available, you will have to assign a network number and enter it.
9 Click Accept.
226
10 On the right of the page, in the Networks using selected connection table, click the checkbox next
to the network you want to connect to.
11 Click the Start button. The status changes to Connected.
NOTE If an error message appears, make sure the COM port you selected is not in use. For
example, PuTTY may be open and is holding the port open.
Testing the server-to-client connections

After making sure that the Ethernet cabling has been set up properly, make sure you can ping the
server from each client computer. Then test the HTTP connection by running WebCTRL Design Server.
To ping the server from each client

Use the Ping utility from each client computer to test its low-level IP communication with the
WebCTRL® server.
PREREQUISITES
• An IP network connection between your server and client computers
• A solid Link light and a flickering LAN light on the WebCTRL® client computers and the Network
Interface Card (NIC) of the WebCTRL® server. If either device indicates it is not on the network, see
Troubleshooting the Ethernet connections (page 234)
After the link and the LAN lights on the server’s NIC and on the client are lighting properly, ping the
WebCTRL® server from each client machine.
1 At the Command Prompt, type the following command: ping xxx.xxx.xxx.xxx [Enter],
where xxx.xxx.xxx.xxx is the IP address of the device you are pinging.
The reply should indicate that a device with address xxx.xxx.xxx.xxx is present and passing IP
packets on the network.
EXAMPLE For a device with an IP address of 192.168.168.100, type the following:
ping 192.168.168.100
TIP To continuously ping a device, type the following command: ping xxx.xxx.xxx.xxx
-t.
Press Ctrl+C to stop the ping command.
2 If you receive the reply Request timed out or you do not receive a reply, contact the facility’s
network administrator to check the NIC, the hub's settings, and the IP configuration settings. You
do not have a valid IP connection between the 2 devices.
To test the HTTP connection

WebCTRL Design Server does not attempt communication with field hardware, so you can isolate client-
to-server issues from server-to-field issues.
1 Click Start > All Programs > WebCTRL x.x > WebCTRL Design Server.
2 From each client computer, start the web browser, then type the IP address of the server in the
Address field.
If the WebCTRL® login screen does not appear, contact the facility's network administrator.
227
Testing the server-to-controller connections
If the system is running, go to the WebCTRL® Devices page from different levels of the Network
tree to view the status of your communication networks and controllers. If you detect a networking
problem with an Ethernet connection, see Troubleshooting an Ethernet connection (page 234).
After making sure that the Ethernet cabling has been set up properly, use the Ping utility from the
WebCTRL® server to test its low-level IP communication with each controller on the IP network, then
obtain a Modstat (page 236) from each controller to ensure its BACnet communication with the
WebCTRL® server.
To ping a controller on the IP network from the WebCTRL® server

Use the Ping utility to test low-level IP connections between the server and each controller on the IP
network.
PREREQUISITES
• An IP network connection between the server and the Automated Logic® controller.
• A solid link light and a flickering LAN light on the Automated Logic® controller and the WebCTRL®
server's Network Interface Card (NIC). See Troubleshooting an Ethernet connection (page 234).
After the link and LAN lights on the server’s NIC and on the controller are lighting properly, ping each
controller from the WebCTRL® server.
1 At the Command Prompt, type the following command: ping xxx.xxx.xxx.xxx [Enter],
where xxx.xxx.xxx.xxx is the IP address of the device you are pinging.
The reply should indicate that a device with address xxx.xxx.xxx.xxx is present and passing IP
packets on the network.
EXAMPLE For a device with an IP address of 192.168.168.100, type the following:
ping 192.168.168.100
TIP To continuously ping a device, type the following command: ping xxx.xxx.xxx.xxx
-t.
Press Ctrl+C to stop the ping command.
2 If you receive the reply Request timed out or you do not receive a reply, contact the facility’s
network administrator to check the NIC, the hub's settings, and the IP configuration settings. You
do not have a valid IP connection between the 2 devices.
Setting up BACnet Broadcast Management Devices (BBMDs)

To minimize network communications, IP routers do not pass on broadcasts that they receive. If your
system has controllers on different IP subnets separated by an IP router, you must set up a BACnet
router on each IP subnet as a BACnet Broadcast Management Device (BBMD). A BBMD passes
BACnet/IP broadcasts across the IP router to other BBMDs.
IP Router
172.18.1.1 172.16.1.1
IP subnet IP subnet
R
BBMD BBMD
Controller Controller
To set up BBMDs, use the appropriate method in the table below.
228
If your WebCTRL® system has... Use this method
100 or less IP subnets with:* Let SiteBuilder automatically

• No third-party BACnet routers configure your BBMDs.
• Authority from your customer to manage all NOTE This is not supported in a
Automated Logic® and third-party BBMDs on the OptiFlex™ router with the drv_gen5
network driver
• Third-party BACnet routers that support BBMD writes

from the network
Any of the following: Set up custom BBMDs through the
• More than 100 IP subnets * WebCTRL® interface or using the
• Third-party BBMDs that you do not have authority to BBMD Configuration Tool.
manage
• Third-party BBMDs that use a non-standard port for
BACnet communications
* If your system has only OptiFlex™ routers, this number changes from 100 to 500.
NOTE If the WebCTRL® server is on an IP subnet without an Automated Logic® BACnet router, register
the server as a foreign device. See To set up the WebCTRL® server as a foreign device (page 233).
To set up BBMDs in SiteBuilder

As you add each Automated Logic® BACnet router to an IP network on the Network tree, check
Automatically Configure My BBMDs on the Address tab. SiteBuilder automatically selects a router in
each IP subnet as the BBMD and sets up BBMD tables appropriately.
To see which BACnet routers SiteBuilder assigned as BBMDs, select View > Display > BBMD. BBMDs
show B=assigned on the Network tree.
To override SiteBuilder's BBMD selection, right-click a different BACnet router on the same IP subnet,
then select Force to BBMD.
NOTE If you are managing 3rd party BBMDs, you must add every 3rd party device that could be a
BBMD as a 3rd party device router in SiteBuilder.
To set up BBMDs through the WebCTRL® interface

If the BBMD controller has the drv_gen5 driver, using this feature only installs the BBMD table in the
network that is set as the home network. We recommend using the Driver/controller setup pages to set
up BBMD tables. For instructions, see the next section To set up BBMDs through the WebCTRL®
interface for OptiFlex™ controllers (drv_gen5 driver) (page 228, page 231).
1 Make a list of the IP addresses for every controller that will function as a BBMD in your system.
CAUTION Multiple BBMDs on an IP subnet disrupt BACnet communications. Define only one
BBMD on either side of each IP router in your system.
2 In Notepad, type the list putting each IP address on a separate line. (ExecB routers support up to
100 IP addresses per file; OptiFlex™ routers support up to 500.)
229
NOTE If you must communicate with a third-party router that does not use the BACnet/IP port
47808 (0xbac0), you must include the hexadecimal port number in the IP address. For example,
172.168.23.67:0xe78a
3 Save the file to your folder of choice or the <system_name> folder. Use a .bdt, .bbmd, or .text
extension instead of .txt.
4 On the WebCTRL® Network tree, select one of the Automated Logic® controllers that will
function as a BBMD.
5 To check if the controller has an existing BBMD table, click , then select Manual Command.
6 In the manual command field, type: bbmd read x.x.x.x
where x.x.x.x is the IP address of the controller you are on.
7 Click OK.
8 If the Broadcast Distribution Table contains IP addresses that are not in your file, add them to your
file.

10 In the manual command field, type: bbmd write filename.ext x.x.x.x
where filename.ext is the .bdt, .bbmd, or .text file in the <system_name> folder and
x.x.x.x is the IP address of the controller you are on.
11 Click OK.
12 Issue another bbmd read command to verify that the file was written correctly.
230
To set up BBMDs through the WebCTRL® interface for OptiFlex™ controllers (drv_gen5 driver)
1 In the WebCTRL® interface, on the Network tree, select one of the Automated Logic®
controllers with the drv_gen5 driver that will function as a BBMD.
2 Click Driver > Properties page.
3 On the Configuration > Gig-E Port tab.
4 Select the network to import a BBMD to and click Import BBMD.
5 Save the file to a convenient location on your computer.
6 Click the file and a confirmation message appears.
7 Repeat steps 4 to 6 for any other networks you need to import a BBMD file to.
Address formatting
• An IPv4 address with optionally space-delimited subnet mask
ip address:port subnetmask
• An IPv6 address with default port
ip address
• An IPv6 address with specified port
NOTE This is standard IPv6 notation where the address is surrounded by brackets followed by a
colon and the port.
[ip address]:port
• A host name address with optionally space-delimited subnet mask.
NOTE The host name must be within quotes
"host name":port subnetmask
To set up BBMDs using the BBMD Configuration Tool

This utility is not supported for a device with a drv_gen5 driver.
Before you begin, do the following:
○ Set up the IP address, subnet mask, default gateway, and network numbers for the WebCTRL®
server and each Automated Logic® controller on the IP network. See Setting up controller IP
addresses (page 215).
○ Go to the Automated Logic® Partner Community website. Under Engineering and Startup
Tools, select Utilities > BBMD Configuration Tool. Follow the instructions.
1 Make a list of the IP addresses for every controller that will function as a BBMD in your system.
CAUTION Multiple BBMDs on an IP subnet disrupt BACnet communications. Define only one
BBMD on either side of each IP router in your system.
2 In Notepad, type the list putting each IP address on a separate line. (ExecB routers support up to
100 IP addresses per file; OptiFlex™ routers support up to 500.)
231
NOTE If you must communicate with a third-party router that does not use the BACnet/IP port
47808 (0xbac0), you must include the hexadecimal port number in the IP address. For example,
172.168.23.67:0xe78a
3 Save the file to your folder of choice or the <system_name> folder. Use a .bdt, .bbmd, or .text
extension instead of .txt.
4 Open the BBMD Configuration Tool.
5 In the IP Address or Host Name field, type the IP address of an Automated Logic® controller that
functions as the BBMD (BACnet Broadcast Management Device) for its subnet.
6 Click the Broadcast Distribution Table Read button to see if the controller has an existing BBMD
table. The information found is displayed in the bottom half of the window.
7 If the Broadcast Distribution Table contains IP addresses that are not in the file you created in
steps 2 and 3, add them to your file.
8 Verify that the same controller IP address is still in the IP Address or Host Name field.
9 Click the Broadcast Distribution Table Browse button, then select the file that you created in steps
2 and 3.
10 Click the Broadcast Distribution Table Write button to send the information to the controller.
11 Click Read again to verify that the new file was written to the Automated Logic® controller.
12 Repeat steps 5 through 11 for each Automated Logic® controller that will function as a BBMD in
your system.
232
To set up the WebCTRL® server as a foreign device
If the WebCTRL® server is on an IP subnet without an Automated Logic® BACnet router, register the
server as a foreign device to a BBMD in the system. That BBMD will then forward BACnet broadcasts to
the server. Register the server with the BBMD that will have the fastest response time. Response time
is affected by distance and network complexity.
1 On the WebCTRL® System Configuration tree, select Connections.

2 On the Configure tab, select BACnet/IP Connection.
4 Type the WebCTRL® server's IP address in the IP Address field. (172.18.64.37, in the example
above.)
NOTE If you have more than one network interface card, type the address that connects to the
controller network.
5 Type the WebCTRL® server's subnet mask in the IP Subnet Mask field. (255.255.0.0, in the
example above.)
6 Select Force Registration from the Foreign Device drop-down list.
7 Select the BBMD in the Primary BBMD field.
8 To have a backup in case the first BBMD fails, select another BBMD in the Backup BBMD if
primary fails field.
9 Click next to Tuning Parameters.

10 Keep the 600-second default value in the Register FD Interval field.
NOTE If the re-registration does not occur within this time, the BBMD will delete the WebCTRL®
server from its list.
11 Click OK.
12 If running WebCTRL® Server (not WebCTRL® Design Server), select the BACnet/IP Connection,
then click Start.
If your system does not have any BBMDs

Follow the steps below to create pseudo BBMDs so that you can register the server.
1 In the SiteBuilder application, double-click each BACnet router and check Automatically Configure
My BBMDs on the Address tab.
2 In the WebCTRL® application, select any location on the Network tree.
3 Run the manual command bbmd update to create a blank .bdt table in every router and mark
them for download.
4 Download parameters to the routers.
5 Follow the steps above to register the WebCTRL® server as a foreign device to one of the routers.
233
Troubleshooting networks
If a controller is not communicating, select the controller's network on the WebCTRL® Network
tree, then click the Devices button. This page shows the communication status of all controllers on the
network. If all controllers on the network are not communicating, you have a network problem. Begin
moving up the Network tree, checking communication status at each level to determine the
starting point of the communications problems.
Troubleshooting an IP/Ethernet connection

Normal condition
Most Ethernet devices have link lights that indicate connectivity. If the Ethernet cable is terminated
correctly, the link lights at each port (server, Automated Logic® controller, and hub or switch) will be lit.
A controller's LAN lights will flicker, indicating Ethernet data packet activity.
Problem
If the Ethernet connection is not wired correctly, you may experience the following symptoms:
• Link light is off
• LAN light remains off
Possible cause Solution

The physical integrity of the If a known good cable results in a normal condition, replace the
cable or connectors is cable.
compromised.
An improper connection type is • Use a crossover cable to connect two IP devices without a
used. hub.
• Use a straight-through cable to connect an IP device to a
hub.
A cable is plugged into a hub's Use a different port.
uplink port. NOTE Many hubs and switches share the first or last port with
the uplink port. Other hubs have an uplink switch or button. If
you need to use the first port, make sure that the hub or switch
is set up correctly (usually a small switch on the back or bottom
of the device) and that the first port is not shared with the
uplink connection.
The devices are not on the Change one of the IP addresses or install an IP router.
same IP network.
TIP To determine whether the devices are on the same
network, use the Subnet calculator below.
A NIC is installed incorrectly. If you are unable to ping the host's IP address from the host
computer, reinstall the NIC, checking for correct drivers.
Faulty hardware: NIC, hub, The diagnosis may be the same as the solution: replace the
switch, or Automated Logic® faulty hardware.
controller
234
NOTES
• After checking these possible causes, if you are unable to get a link or LAN light on an Automated
Logic® controller, contact Automated Logic® Technical Support.
• When troubleshooting an Ethernet connection, Automated Logic® Technical Support may request
that you provide network diagnostics information from the System Configuration tree >
Connections > Statistics tab.
Troubleshooting an ARCNET connection

Problem
Intermittent communication over an ARCNET network may cause the following symptoms:
• WebCTRL® graphics or properties pages intermittently display actual values then question marks.
• You can obtain a Modstat (page 236) from a controller, but a download fails.
Possible cause
The WebCTRL® communication timeout settings are not sufficient for your network configuration.
Solution
Increase your communication timeout settings.
2 On the Configure tab, select your BACnet/ARCNET Connection.

4 Double the values in the Comm Timeout and Comm Attempts fields.
5 Click Accept.
NOTE If changing these values does not fix your intermittent communication, contact Automated
Logic® Technical Support.
Troubleshooting BACnet bindings

Every controller has a Device Binding Table that contains all Device IDs that the controller
communicates with and the network address of each device. This typically includes the Device ID of the
BACnet Alarm Recipient. If Network Address Translation (NAT) is enabled in SiteBuilder, the alarm
recipient is omitted.
If the WebCTRL® application is not receiving alarms/trends or if the a point's value is incorrect, you can
view this table to see where the controller is looking for its data.
1 On the WebCTRL® Network tree, select the controller that has incorrect or missing data.
2 On the Properties page, click Show Bindings.
EXAMPLE: If a controller has been sending alarm/trend data to Device 249999, but someone changed
the BACnet Alarm Recipient field in SiteBuilder to 249996 and did not download parameters, the
following information will be displayed at the bottom of the Device Binding Table:
*** No binding for event recipient DEV:249999

*** Will not be able to deliver alarms/trend notifications
*** Alarms should be delivered to DEV:249996
235
Working around supernetting limitations
What is supernetting?
Supernetting is a method of combining separate networks and making them behave as a single larger
network using a common subnet mask.
Organizations are issued Class A (16777216 hosts), B (65535 hosts), or C (256 hosts) blocks of IP
addresses based on how many hosts they have on their networks. If an organization needs 975 IP
addresses, rather than being assigned one Class B block of IP addresses, it might be assigned four
Class C blocks, or four different Class C networks. If the blocks are contiguous, they can be grouped
together to behave as a single larger network.
EXAMPLE A subnet mask of 255.255.252.0 supernets these four Class C networks into one large
network with a network number of 192.168.0.0 and a broadcast message number of 192.168.3.255:
192.168.0.0
192.168.1.0
192.168.2.0
192.168.3.0
The following Automated Logic® controllers support supernetting:

LGR line
ME-LGR line
ME812u-LGR
ME812u-E
To use WebCTRL® with a supernetted network

Although the LGE, LGRM-E, and WebPRTL do not support supernetting, the WebCTRL® server can
communicate with these controllers if you set up the controllers and the WebCTRL® server on the
same subnet as the default gateway and set their subnet masks (for Class C networks) to
255.255.255.0.
NOTE Your WebCTRL® server and the controllers may not be able to communicate with devices on
other subnets that are part of the supernet.
EXAMPLE
Hardware IP Address Subnet mask
Default gateway 192.168.1.16 255.255.252.0
WebCTRL® server 192.168.1.30 255.255.255.0
LGE1 192.168.1.18 255.255.255.0
LGRM-E2 192.168.1.20 255.255.255.0
WebPRTL1 192.168.1.59 255.255.255.0
Using a Modstat to troubleshoot your system

A Modstat (Module Status) provides information about a controller and verifies proper network
236
To obtain a Modstat
You can get a controller's ModStat in the following places:
• ExecB controller—In the WebCTRL® or SiteBuilder application
• OptiFlex™ controller—In the WebCTRL® application or the controller's setup pages
In the WebCTRL® application

Use one of the following methods:
• Right-click a controller on the Network tree, then select Module Status.
• Select a controller on the Network tree. On the Properties page, click Module Status.
NOTE You cannot get a Modstat if running WebCTRL Design Server because it cannot communicate
with controllers.
In the SiteBuilder application (ExecB controller only)

1 Use a USB Link Kit to connect your computer to the controller's Local Access port. See To connect
to a device's Local Access port (page 243).
2 In SiteBuilder, select Configure > Preferences.
3 On the Connections tab, select the computer Port that the USB Link Kit cable is connected to, and
Baud Rate to one of the following:
Local Access port Baud Rate

5-pin Rnet 115200
8-pin round 38400
4 Right-click the controller in SiteBuilder's Network tree, then select Module Status.
In the controller's setup pages (OptiFlex™ controller only)

1 Connect the controller's Service Port to your laptop as specified in the Technical Instructions.
2 Turn off the computer's Wi-Fi if it is on.
3 If your computer uses a static IP address, use the following settings:
○ Address: 169.254.1.x, where x is 2 to 7
○ Subnet Mask: 255.255.255.248
○ Default Gateway: 169.254.1.1
4 If it uses a DHCP address, leave the address as it is.
5 Open a web browser on the computer.
6 Navigate to http://local.access or http://169.254.1.1 to see the Service Port controller setup
pages.
237
Modstat field descriptions
NOTE Modstats vary for different types of controllers. The list below describes all information that
could appear on any Modstat. If a description differs between different generations of controllers, the
generation is noted.
Field Description
Date/Time Date and time the Modstat was run
CM The controller's rotary switch address (MAC address)
Model Name Identifies the Product Type
Device Instance A unique ID assigned to the controller
Driver built When the driver was built
Downloaded by When and where the last download was performed
Application Software Version The name of the first control program that is downloaded
Flash Archive Status Shows the validity, date, and time of the most recent archive of
parameters and status to the controller's permanent flash
memory. The archive takes place once a day.
# PRGs initialized If applicable, the number of control programs that were
# PRGs running downloaded vs. the number that are running. If these numbers
are not the same, the controller has a problem such as lack of
memory.
Firmware sections in flash The name, version, and date of the driver
memory
Reset Counters: ExecB controller: The number of times each of the following
events have occurred since the last time the controller was
formatted.
OptiFlex™ controller: The number of times each of the following
events have occurred since the last time the controller was
commanded to clear the reset counters.
See NOTE below this table.
Power failures Interruption of incoming power
Brownouts Low-level incoming power
Commanded boots Includes commands issued from the WebCTRL® interface
such as the zap manual command, plus commands issued
during a memory download.
System errors Error in the controller's firmware or hardware
Watchdog timeouts Watchdog is firmware that monitors the firmware for normal
operation. If watchdog detects a problem, it restarts the
firmware.
S/W Watchdog Watchdog is firmware that monitors the application firmware
timeouts for normal operation. If the watchdog firmware detects a
problem, it restarts the application firmware.
H/W Watchdog H/W Watchdog will restart the controller if it detects a severe
timeouts problem with the controller's operating system
238
Field Description
System status Gives the current status of the controller's operation.
Network status Gives the current status of the controller's networks.
System error message history ExecB controller: High-severity errors since the last memory
download or format. Shows the first 5 and last 5 messages.
OptiFlex™ controller: High-severity errors since the last memory
download. Shows the most recent 10 messages.
Warning message history ExecB controller: Low-severity errors and warning messages
since the last memory download or format. Shows the first 5
and last 5 messages.
OptiFlex™ controller: Low-severity errors and warning
messages since the last memory download. Shows the most
recent 10 messages.
Information message history ExecB controller: Information-only messages since the last
memory download or format. Shows the first 5 and last 5
messages.
OptiFlex™ controller: Information-only messages since the last
memory download. Shows the most recent 10 messages.
Manifest revision Firmware revision
Installed bundles Components of the firmware
ARC156 reconfigurations An ARCNET network normally reconfigures itself when a
during the last hour controller is added to or taken off the network. The Total field
indicates the number of reconfigurations in the last hour.
Initiated by this node indicates the number of reconfigurations
initiated by this controller. Typical sources of the problem could
be this controller, the controller with the next lower rotary
switch address, any controller located on the network between
these two controllers, or the wiring between these controllers.
An excessive number in these fields indicates a problem with
the network.
BACnet comm errors in the BACnet communication errors usually indicating dropped
last 7 days packets caused by high traffic on network.
Core (or Main) and Base Gives the following information about the controller's boards:
board hardware • Type and board numbers that are used internally by
Automated Logic®.
• The manufacture date and serial number.
• ExecB controller only: The core board's RAM and Flash
memory.
RAM is used for driver and control program executables.
Flash memory is used for firmware and file storage. See
Flash storage size below.
Number of BACnet objects The number of BACnet objects that were created in the device
and the number of those objects that are network visible.
Largest free heap space Size of the largest piece of unused dynamic memory
239
Field Description
Database size ExecB controller: Size of the controller's memory designated
for running programs. Database memory is used for control
program parameters, status and history; trends, schedules,
and alarms; and driver parameters, status and history.
OptiFlex™ controller: Size of the controller's memory.
Flash storage size The size of the flash memory that is not used by the firmware.
This memory is used for file storage and archiving.
Archive storage size The amount of flash memory remaining for archival after files
are downloaded.
File storage size The size of all files (control programs, graphics, driver, etc.)
downloaded to the controller. How much information is in
these files depends on whether the controller's Download
source files option is selected in SiteBuilder or WebCTRL®.
Raw physical switches The readings used to test the DIP or rotary switches
Network Information ExecB controller: The various network addresses for a
controller installed on an Ethernet. The Current and Assigned
addresses will be the same unless:
• The Assigned addresses were changed in PuTTY.
• The controller's Default/Assigned DIP switch was moved to
the Default position after the Assigned addresses were
defined in SiteBuilder.
• The Enable IP configuration changeover on the on the
BACnet Router Properties page is being implemented.
OptiFlex™ controller: The various network addresses for the
controller. The Current and Assigned addresses will be the
same unless the Enable IP configuration changeover on the
BACnet Router Properties page is being implemented.
Route Information BACnet networks that a router is currently routing traffic to.
The list changes as BACnet routers are added or removed from
the system.
Ethernet statistics Diagnostic counters directly related to the ethernet
communications hardware.
Field Description
Secondary ARC156 AAR only - The following diagnostic counters relate directly to the
diagnostics secondary ARC156 network communications.
Rx READY or STOPPED indicates the present state of the receive
process. STOPPED can indicate initialization is in progress.
Continued and persistent STOPPED indicates driver or hardware
problems.
240
Field Description
Tx READY or STOPPED indicates the present state of the transmit
process. STOPPED can indicate initialization in progress.
Continued and persistent STOPPED indicates driver or hardware
problems.
SlaveResets The number of times the slave processor has been explicitly reset.
This is a normal part of initialization and should be a low number.
RxCmd The number of completed command receptions from the slave
processor. This can be used to gauge the amount of activity
between the main processor and the slave processor.
TxCmd The number of successful command transmissions to the slave
processor. This can be used to gauge the amount of activity
between the main processor and the slave processor.
OverrunErrors The number of serial overrun errors detected on reception from
the slave processor. This is uncommon and should be a low
number.
ParityErrors The number of serial parity errors detected on reception from the
slave processor. This is uncommon and should be a low number.
FramingErrors The number of serial framing errors detected on reception from
the slave processor. This is uncommon and should be a low
number.
SlaveNotReadyRx The number of receptions from the slave processor that were
discarded during initialization. This should be a low number.
SlaveNotReadyTx The number of transmissions to the slave processor that were
discarded during initialization. This should be a low number.
SlaveTimeoutTx The number of transmissions to the slave processor that timed
out. This is uncommon and should be a low number. A high
number could indicate a driver or hardware problem.
SlaveCTSWaitTx The number of character times elapsed while waiting for the slave
processor to be ready to receive a command. This is a normal part
of communicating to the slave processor. This number should
increment quickly and is commonly a very large number.
BadLlc The number of arcnet packets received with an unrecognized
logical link control service specified. This should be zero unless
non-BACnet devices are connected to the arcnet.
BadSAP The number of arcnet packets received with an unrecognized
service access point specified. This should be zero unless non-
BACnet devices are connected to the arcnet.
BadServicePrimitive The number of BACnet packets received with an unsupported
service primitive specified. This should be zero.
NoPacketErrors The number of BACnet packets that could not be received
because of temporary packet memory shortages.
UpQueueErrors The number of receptions from the slave processor that could not
be queued for processing.
241
Field Description
DownQueueErrors The number of commands to the slave processor that could not
be queued for transmission.
RxCmdQueueErrors The number of command receptions from the slave processor that
could not be queued for processing.
PowerOnResets The number of times the arcnet coprocessor reported a power up
event. This number should mirror closely the SlaveResets counter.
ExcessiveNaks The number of times the arcnet coprocessor reported excessive
naks.
Reconfigs The number of times the arcnet coprocessor reported a reconfig
event.
ReconfigsThisNode The number of times the arcnet coprocessor reported that this
node caused a reconfig event.
NOTE OptiFlex™ controller only—If you want to clear the Reset counters and the three message history
fields, click the Clear Counts/Logs button on the controller's Properties page in the WebCTRL®
application or in the OptiFlex™ controller's setup pages that you access through the Service Port.
Communicating locally with ExecB controllers

You can connect locally to controllers and some sensors to commission, start up, or troubleshoot
equipment, or download to controllers. Use a local connection in any of the following situations:
• The entire network is not yet functional.
• The permanent WebCTRL® server is not operating.
• The server is operating, but you don't have a convenient IP connection.
To make a local connection, use a USB Link Kit to connect a laptop running either the:
• WebCTRL® application - Requires a copy of the system database and that you set up a Local
Access connection in the WebCTRL® interface.
• Field Assistant application - Use this option if more than one person is starting up the system. See
Field Assistant Help for more information.
NOTE If needed, you can disable a controller's local access (page 251).
242
To connect to a device's Local Access port
PREREQUISITES
For... Use driver...
Devices with a 5-pin Local Access port v1.70 or later
Devices with a round 8-pin Local Access v2.00 or later
port
Field Assistant v4.x or later
manufacturer.
1 Connect the laptop to the controller, ZS sensor, or RS sensor using the appropriate USB Link Kit
cable(s).
7 3/4 in. 12 ft.

ALC Part #2 3 5 0 3 8 ALC Part #2 3 5 1 2 3

12 ft.
ALC Part #2 3 5 1 2 5
2 LGR line or ME line controller only: Turn off the controller's power, set the controller's Enhanced
Access DIP switch as follows, then turn its power on again.
To communicate with... Set switch to...

The WebCTRL® application Off
PuTTY or HyperTerminal On
SiteBuilder to set a custom IP address On
243
3 When you are through communicating with the Local Access port, return the Enhanced Access DIP
switch to its original setting.
NOTES
• Using a Local Access port does not interrupt the delivery of alarm and trend notifications to the
controller's specified BACnet Alarm Recipient.
• You cannot use a Local Access port to set up BBMDs because Local Access connections do not
communicate using BACnet/IP.
• A router must be present to receive colors from the controller network.
To set up a Local Access connection

To set up communication between the WebCTRL®application on your laptop and the controller:
2 On the Configure tab, click Add.
3 On the Configure tab, from the Type drop-down list, select BACnet/Rnet Local Access Connection.
4 Click Add.
5 Optional: Edit the Description.
6 Type the computer's Port number that the USB cable is connected to.
NOTE To find the port number, plug the USB cable into the computer's USB port, then select Start
> Control Panel > System > Device Manager > Ports (Com & LPT). The COM port number is beside
Silicon Labs CP210x USB to UART Bridge.
7 Set the Baud rate.

Local Access port Baud Rate
5-pin 115200
8-pin round 38400
9 Click Accept.
10 Click the Start button.
11 If using the 5-pin Local Access port, on the Network tree, select the controller that you are
connected to.

13 Type rnet here in the dialog box, then click OK.
14 On the Properties page, click Module Status. If a Modstat (page 236) report appears, the
WebCTRL® application is communicating with the controller.
244
Troubleshooting a Local Access connection
Inability to communicate over a Local Access connection may cause the following symptoms:
• Question marks on WebCTRL® Properties pages and Graphics pages
• Cannot obtain a Modstat from the connected controller
• Controller Status report displays purple for a connected BACnet/IP controller
• Cannot download to connected controller
• A message says Local Access is disabled or unable to connect.
Possible cause Solution
Network number in Use the rnet here manual command to force the local device to
SiteBuilder does not accept the next download applied.
match the number found
in the controller 1 Click , then select Manual Command.
2 In the manual command field, type rnet here.
3 Download Parameters or All Content to the controller to which you
are connected.
4 On the WebCTRL® Network tree, select the controller.
5 On the Properties page, click Module Status to verify
WebCTRL® Increase your communication timeout settings.
communication timeout
settings are not sufficient 1 On the System Configuration tree, select Connections.
for your network 2 On the Configure tab, select BACnet Local Access.
configuration.
4 Double the values in the Comm Timeout and Comm Attempts
fields.
NOTE If changing these values does not fix your intermittent
communication, contact Automated Logic® Technical Support.
Selected COM port is in Shut down other applications such as PuTTY that may be running and
use holding the port open.
Baud rates are Verify that the Silicon Labs CP210x USB to UART Bridge and the
inconsistent WebCTRL® application are using the baud rate used by the controller.
Local Access is disabled See To disable a controller's Local Access port (page 251).
245
Communicating using PuTTY
You can connect a computer to a controller's Local Access port and then use PuTTY, a free open source
terminal emulation program, to:
• Set the baud rate for ports S1 or S2 on LGR and ME line controllers
• Set controller properties, such as IP address and network information
• Retrieve a Modstat (page 236)
PREREQUISITES
For devices with a... Use driver...
5-pin Local Access port v1.70 or later
Round 8-pin Local Access port v2.00 or later
manufacturer.
1 Download and install PuTTY from the PuTTY website

(http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html).
2 Connect the laptop to the controller, ZS sensor, or RS sensor using the appropriate USB Link Kit
cable(s).
7 3/4 in. 12 ft.

ALC Part #2 3 5 0 3 8 ALC Part #2 3 5 1 2 3

12 ft.
ALC Part #2 3 5 1 2 5
4 To change a router's IP address, subnet mask, or default gateway, set its IP Address DIP switch to
Assigned.
5 Start PuTTY.
246
6 Under Category > Connection, select Serial.
7 Under Options controlling local serial lines, enter the following settings:
Field Value
Serial line to connect to Replace X with the computer's port number that the USB Link Kit
cable is connected to.
NOTE To find the port number, select Start > Control Panel >
System > Device Manager > Ports (Com & LPT). The COM port
number is beside Silicon Labs CP210x USB to UART Bridge.
Speed (baud) Type the appropriate baud rate from the table below.
For... Speed
LGR, ME 115200 for Rnet
38400 for S2
LGE, LGRM-E, WebPRTL 38400
Data Bits 8
Stop Bits 1
Parity None
Flow Control None
8 Click Open. A window similar to the one below appears.
247
○ To change a property value:
a. Type the number of the property, then press Enter.
b. Type the new value, then press Enter.
○ To take an action, type number of the action, then press Enter.
10 If you changed a value, type 1, then press Enter to restart the controller.
11 Close PuTTY.
Communicating locally with the OptiFlex™ controller

You can connect a laptop to the OptiFlex™ controller's:
• Service port to set up the controller's address, ports, protocols, baud rates, or to communicate with
the WebCTRL® application
• Rnet port to commission, download, and troubleshoot equipment through WebCTRL® or Field
Assistant
NOTE If needed, you can disable communication with the Rnet port (page 251).
To communicate with the OptiFlex™ controller's Service Port

You can communicate with the OptiFlex™ controller's setup pages through a web browser to:
• View the controller's Module Status report
• View/change controller and network settings
• Set up ports, protocols, and baud rates
• Communicate with the WebCTRL® application (See To set up a BACnet/IP Service Port connection
in the WebCTRL® interface (page 226)
• Troubleshoot
You can set a Device Password in the WebCTRL® interface at the site level to control access to the
Service Port setup pages for controllers that have the drv_gen5 driver. See To set up site properties
(page 329).
248
To communicate locally through the OptiFlex™ controller's Rnet port
You can connect a computer to the OptiFlex™ controller's Rnet port to commission, download, and
troubleshoot equipment through the WebCTRL® application or Field Assistant.
PREREQUISITES
NOTES
○ The USB Link Kit driver is installed with a WebCTRL® v5 or later system. Please refer to the
Silicon Labs website and search "CP210x USB to UART Bridge VCP Drivers" for the most
current device drivers. Install the driver before you connect the USB Link Kit to your computer.
○ You will use only the portion of the USB Link Kit that has the USB connector.
damage the USB Link Kit and the controller. If you are not sure of the wiring polarity, use a USB
isolator between the computer and the USB Link Kit. Purchase a USB isolator online from a third-
party manufacturer.
• A 3-pin screw terminal connector and 3-wire cable
1 Connect one end of a piece of 3-wire cable to the 3-pin connector.
2 Connect the other end of the 3-wire cable to the 's Rnet port as shown in the drawing above in step
1.
3 Connect the 3-pin connector to the portion of the USB Link Kit shown in the drawing below, then
connect the USB connector to the computer.
249
To set up a BACnet/Rnet connection in the WebCTRL® interface
For the WebCTRL® application to communicate with the Rnet port, you must do the following:
2 On the Configure tab, from the Type drop-down list, select BACnet/Rnet Local Access Connection.
3 Click Add.
4 Optional: Edit the Description.
5 Type the computer's Port number that the USB cable is connected to.
NOTE To find the port number, plug the USB cable into the computer's USB port, then select Start
> Control Panel > System > Device Manager > Ports (Com & LPT). The COM port number is beside
Silicon Labs CP210x USB to UART Bridge.
6 Set the Baud rate to 115200.

8 Click Accept.
9 Click the Start button.
10 On the Network tree, select the controller that you are connected to.

12 Type rnet here in the dialog box, then click OK.
13 On the Properties page, click Module Status. If a Modstat report appears, the WebCTRL®
application is communicating with the controller.
250
To disable a controller's Local Access
To limit access to your system, you can disable the ExecB controller's Local Access port or the
OptiFlex™ controller's Rnet port from communicating with the WebCTRL® application, Field Assistant,
or Test and Balance running on a laptop.
1 Select the controller on the WebCTRL® Network tree.

2 On the Properties page, select Disable Local Access to Server and Tools.
3 Click Accept.
NOTES
• Use Global Modify (page 34) to change this setting for multiple controllers simultaneously.
• The following can communicate with a disabled port:
○ Touchscreen device
○ PuTTY (ExecB only)
○ Virtual BACview® application (ExecB only)
○ HyperTerminal (ExecB only)
○ SiteBuilder—for IP devices (ExecB only)
Network security
Your WebCTRL® building automation system's controllers and server should be as secure as possible.
However, achieving this security can be challenging because of the complexities of networks, firewalls,
and virtual private networks (VPN's). Two means for increasing the security of your system are:
• While the WebCTRL® server was designed to be secure, BACnet is an open protocol that can pose
risks for the controllers. The most secure system is one that is completely isolated from the
Internet, but that is not always possible. The v6-02 or later drivers for Automated Logic®
controllers with Ethernet capability have a BACnet firewall feature that allows you to restrict
communication with the controller to all private IP addresses and/or to a whitelist of IP addresses
that you define. To set this up, go to the Network tree > the router > Driver > Bacnet Firewall.
Follow the instructions in the interface.
• You should use TLS (HTTPS, not HTTP) to secure the client device that you are using to connect to
the WebCTRL® server. See What is TLS (HTTPS)? (page 252) for instructions on setting up TLS.
For information on secure network configurations, options, and best practices, see the following
documents on the Automated Logic® Partner Community website.
• Security Best Practices for a WebCTRL® system
• WebCTRL® Security
251
What is TLS (HTTPS)?
The WebCTRL® application supports Transport Layer Security (TLS), a secure protocol used for
transmitting private information over the Internet using HTTPS.
NOTE TLS is a more recent version of Secure Sockets Layer (SSL).
TLS uses a method called public-key cryptography to provide:
• Client/server authentication before transmitting data.
• Strong encryption of all data before it is transmitted over the TLS connection and decryption of the
data upon receipt.
Public key cryptography uses keys and certificates to authenticate users. The keys and certificates are
protected with a keystore password.
You have 2 options for creating a certificate. You can use:

• A certificate from a trusted Certificate Authority (CA). This option provides the most security
because the CA performs the authentication. See To set up TLS using a Certificate Authority (CA)
certificate (page 252).
• A self-signed certificate. This option is quicker and easier to set up, but is less secure. See To set
up TLS using a self-signed certificate (page 257).
Keystore Explorer (page 261) is an open source, third-party tool that can be used to manage your
certificates.
To set up TLS using a Certificate Authority (CA) certificate

NOTES
• TLS is a more recent version of Secure Sockets Layer (SSL).
• For a list of trusted Certificate Authorities consult your web browser’s certificates documentation.
Step 1: Create a key and certificate

1 In SiteBuilder, select Configure > Preferences > Web Server.
2 Select HTTPS Only in the Enabled Web Server Ports field.
NOTE For quicker navigation, select Both HTTP and HTTPS if operators will connect to the system
from an internal network and the Internet. Change the setting in the HTTPS Port field only if the
system will be using a non-standard port.
3 Click Delete Certificate.
CAUTION Clicking this button will delete all certificates in your system.
4 Click Make Certificate.
5 In the Make Certificate dialog box, type a Keystore password.
252
6 In the DNS name of your server field, type the address of the server using one of the following
formats:
• The domain name if accessing through the Internet. Example: www.abi.com.
• The IP address if accessing through the Internet. Example: 216.227.49.36.
• The computer name if accessing internally. Example: mycomputerxp.
NOTES
○ The address format you use in this field is the format operators must use to access the system
in a web browser.
○ The entered names will be used as the Subject Alt Names in the certificate.
○ You can enter more than one name. Separate the names by a comma and no spaces.
7 The next 5 fields are optional, but the more information you enter, the more secure your key is.
8 Click Apply.
9 In the Keystore Password field, type the password that you entered in step 5 above.
NOTE This field is case sensitive.
10 Click OK.
Step 2: Obtain a CA certificate

You can use either a Certificate Signing Request or Provided Certificates (PFX). See the instructions
below.
To set up a webserver using a Certificate Signing Request
Prerequisites
• An account with a Certificate Authority
• Webserver configured for HTTPS with self-signed certificate. See To set up TLS using a self-signed
• The keystore password that was used to setup the self-signed certificate
1 Open the Webserver Keystore

a) In Keystore Explorer, click File > Open, and browse to <WebServer
Install>\programdata\webserver_base\keystores.
b) Select certkeys, and then click Open.
c) Enter the keystore password.
d) Click Entry Name, and select webctrl.
2 Generate CSR (Certificate Signing Request)
A CSR is a text file signed with your private key.

a) Right-click webctrl, and select Generate CSR.
b) Enter the keystore password.
c) Copy and save the path in CSR File. This is where the CSR file will be written and you will need
it later.
d) Check with your CA for any additional required fields, for example, Challenge, Optional
Company Name, or Signature Algorithm. Defaults are set for most common options.
253
3 Import the CSR File
a) Send the CSR File to your Certificate Authority. Your CA Authority may accept requests by email
attachment, or provide a portal where you can upload the file.
b) Save the CA reply file the CA provides to your computer.
c) Open the webserver keystore, click Entry Name, and select webctrl.
d) Right-click and select Import CA Reply" (From File).
e) Save the keystore.
f) Restart the webserver.
To Set up a Webserver using Provided Certificates (PFX file)
Prerequisites
• A Certificate Archive with private key, .pfx file, .jks file, .pcks12
• The password for the archive and private key.
Create certkeys file from certificate archive.

1 Click Open > File and select the .pfx file containing certificates.
2 Enter the keystore password.
3 Click Tools > Change Keystore Type and select PKCS12.
5 Click File > Save As and save the files as "certkeys". Type must be "All Files" with no file suffix.
6 Select the private key entry.
7 Right-click and select Rename.
8 Enter alias webctrl.
9 Save the file.
10 Move the new certkeys file into "<Install Directory>\programdata\webserver_base\keystores".
11 Replace the existing certkeys file with the new certkeys file.
Configure keystore password using Sitebuilder

1 Open Sitebuilder™.
2 Click Configure and then select Web Server.
3 Set keystore password to the password used to create the certkeys file.
4 Restart the WebServer.
254
Step 3: Install the certificate
Start the WebCTRL® Server application (this may take up to a minute), then do the appropriate steps
below on each workstation that will access WebCTRL Server.
1 Start your browser.
2 In the address bar, type the URL of the server running the WebCTRL® application using the server
address that you entered in Step 1: Create a key and certificate (page 252). Use the TLS indicator
https instead of http. For example, https://216.227.49.36.
○ If the TLS certificate is valid and trusted by the browser, skip to Step 4: Enable TLS in your web
browser (page 257).
○ If the certificate is not valid or not trusted by the browser, follow the steps below for your
browser.
Edge®
1 If the page displays Your connection is not private, follow the steps below.
2 Export certificate to a known location:
a) Press F12 to bring up the Developer Tools pane.
b) Navigate to the Security tab, and then click View Certificate.
c) On the Details tab, click Copy to File.
d) In the Certificate Export Wizard, click Next.
e) Choose an option, then click Next.
f) Click Browse.
g) In the File Name field, type a name for your export file.
h) Click Save.
i) Click Next.
j) Click Finish.
k) In the message box The export was successful, click OK.
l) Click OK again.
m) Press F12 to close the Developer Tools pane.
3 Import saved certificate:
a) Click ... on the browser toolbar, then select Settings.
b) Click Privacy, search, and services, then click Manage certificates.
c) On the Trusted Root Certification Authorities tab, click Import.
d) In the Certificate Import Wizard, click Next.
e) Click Browse, then select the file you exported in step 2.
f) Click Open.
g) Click Next.
h) Select Place all certificates in the following store.
i) Click Browse, then select Trusted Root Certification Authorities.
j) Click OK.
k) Click Next.
l) Click Finish.
4 Click Yes in the Security Warning dialog box to install the certificate.
5 In the message box Import was successful, click OK.
6 Click Close.
255
7 Close Edge®, then open it again.
8 Log in to the WebCTRL® interface.
GoogleTM ChromeTM
f) Click Browse.
h) Click Save.
i) Click Next.
j) Click Finish.
l) Click OK again.
a) Click on the browser toolbar, then select Settings.
b) Click Advanced.
c) Scroll down to Privacy and security, then click Manage certificates.
d) On the Trusted Root Certification Authorities tab, click Import.
e) In the Certificate Import Wizard, click Next.
f) Click Browse, then select the file you exported in step 2.
g) Click Open.
h) Click Next.
i) Select Place all certificates in the following store.
j) Click Browse, then select Trusted Root Certification Authorities.
k) Click OK.
l) Click Next.
m) Click Finish.
6 Click Close.
7 Close Chrome, then open it again.
256
Mozilla® Firefox®
1 If the page displays This Connection is Untrusted, expand I understand the Risks, then click Add
Exception.
2 Check Permanently store this exception.
3 Click Confirm Security Exception.
4 Close Firefox, then open it again.
Safari®
1 If the page displays the message, Safari can’t verify the identity of the website, click Show
Certificate.
2 Check Always trust <DNS name you entered in SiteBuilder> when connecting to <WebCTRL
Server address>.
3 Click Continue.
4 Enter the administrator password for your Apple® device.
5 Click Update Settings.
Step 4: Verify that TLS is enabled in your web browser

The WebCTRL® application attempts to use TLS when communicating with a web browser. The web
browser must be set up for TLS.
• GoogleTM ChromeTM, Mozilla® Firefox®, and Safari® use TLS by default.
• In the Internet Explorer® security options:
○ Verify that Use TLS 1.x is checked.
○ Verify that SSL 2.0 and SSL 3.0 are not checked.
To set up TLS using a self-signed certificate

NOTE TLS is a more recent version of Secure Sockets Layer (SSL).
Step 1: Create a key and certificate

1 In SiteBuilder, select Configure > Preferences > Web Server.
2 Select HTTPS Only in the Enabled Web Server Ports field.
NOTE For quicker navigation, select Both HTTP and HTTPS if operators will connect to the system
from an internal network and the Internet. Change the setting in the HTTPS Port field only if the
system will be using a non-standard port.
3 Click Delete Certificate.
CAUTION Clicking this button will delete all certificates in your system.
4 Click Make Certificate.
5 In the Make Certificate dialog box, type a Keystore password.
257
6 In the DNS name of your server field, type the address of the server using one of the following
formats:
• The domain name if accessing through the Internet. Example: www.abi.com.
• The IP address if accessing through the Internet. Example: 216.227.49.36.
• The computer name if accessing internally. Example: mycomputerxp.
NOTES
○ The address format you use in this field is the format operators must use to access the system
in a web browser.
○ The entered names will be used as the Subject Alt Names in the certificate.
○ You can enter more than one name. Separate the names by a comma and no spaces.
7 The next 5 fields are optional, but the more information you enter, the more secure your key is.
8 Click Apply.
9 In the Keystore Password field, type the password that you entered in step 5 above.
NOTE This field is case sensitive.
10 Click OK.
Step 2: Install the certificate

NOTE If you change the server address after you create and install your certificate (for example,
change from an IP address to a domain name), you must create a new key and certificate using the
new address, then install the new certificate.
Start the WebCTRL® Server application (this may take up to a minute), then do the appropriate steps
below on each workstation that will access WebCTRL Server.
Edge®
f) Click Browse.
h) Click Save.
i) Click Next.
j) Click Finish.
l) Click OK again.
a) Click ... on the browser toolbar, then select Settings.
b) Click Privacy, search, and services, then click Manage certificates.
c) On the Trusted Root Certification Authorities tab, click Import.
258
d) In the Certificate Import Wizard, click Next.
e) Click Browse, then select the file you exported in step 2.
f) Click Open.
g) Click Next.
h) Select Place all certificates in the following store.
i) Click Browse, then select Trusted Root Certification Authorities.
j) Click OK.
k) Click Next.
l) Click Finish.
6 Click Close.
7 Close Edge®, then open it again.
GoogleTM ChromeTM
1 Start Chrome.
address that you entered in Step 1: Create a key and certificate (page 252). Use https instead of
http. For example, https://216.227.49.36.
f) Click Browse.
h) Click Save.
i) Click Next.
j) Click Finish.
l) Click OK again.
a) Click on the browser toolbar, then select Settings.
b) Click Advanced.
c) Scroll down to Privacy and security, then click Manage certificates.
d) On the Trusted Root Certification Authorities tab, click Import.
e) In the Certificate Import Wizard, click Next.
f) Click Browse, then select the file you exported in step 2.
g) Click Open.
h) Click Next.
259
i) Select Place all certificates in the following store.
j) Click Browse, then select Trusted Root Certification Authorities.
k) Click OK.
l) Click Next.
m) Click Finish.
8 Click Close.
9 Close Chrome, then open it again.
Mozilla® Firefox®
1 Start Firefox.
address that you entered in Step 1: Create a key and certificate (page 252). Use https instead of
http. For example, https://216.227.49.36.
3 If the page displays This Connection is Untrusted, expand I understand the Risks, then click Add
Exception.
4 Check Permanently store this exception.
5 Click Confirm Security Exception.
6 Close Firefox, then open it again.
Safari®
1 If the page displays the message, Safari can’t verify the identity of the website, click Show
Certificate.
2 Check Always trust <DNS name you entered in SiteBuilder> when connecting to <WebCTRL
Server address>.
3 Click Continue.
4 Enter the administrator password for your Apple® device.
5 Click Update Settings.
Step 3: Verify that TLS is enabled in your web browser

The WebCTRL® application attempts to use TLS when communicating with a web browser. The web
browser must be set up for TLS.
• GoogleTM ChromeTM, Mozilla® Firefox®, and Safari® use TLS by default.
• In the Internet Explorer® security options:
○ Verify that Use TLS 1.x is checked.
○ Verify that SSL 2.0 and SSL 3.0 are not checked.
260
Step 4: Periodically change the password
You may want to periodically change the keystore password as an extra precaution. To do this, you
must delete your existing certificate and create a new one. Follow the procedure in Step 1: Create a
key and certificate (page 252).
To set up Keystore Explorer

Keystore Explorer is an open source, third-party tool that replaces working with the JAVA™ keytool on
the command line. Follow the directions below to set up Keystore Explorer for WebServer and
BACnet/SC Certificates. These instructions are for Keystore Explorer 5.4. Versions after 5.4 may have
variations to the steps described in this document.
To download and install Keystore Explorer

NOTE The instructions in the following sections apply to Keystore Explorer 5.5.0 or later.
1 Ensure you have the required version of Java. Java Runtime Environment (JRE) Version 8 or above
is required. You may obtain Java from the following sources.
○ https://www.java.com/en/download/ *requires oracle technology network license agreement
○ https://adoptopenjdk.net/releases.html *open source option
2 Download Keystore Explorer from https://keystore-explorer.org.
3 Follow the directions in the Keystore Explorer user manual for installation and use. The user
manual can be found on the same site as the download files.
To set up a web server with Keystore Explorer

There are two methods available for setting up a web server using Keystore Explorer. You can use
either of the following:
• Certificate Singing Request (page 261)
• Provided certificates (.pfx) (page 262)
To set up a web server using Certificate Signing Request

For a web server to use HTTPS, it must have a TLS certificate signed with a standard trusted certificate
authority (CA). This section describes how to take the generated self signed certificate, generate a CSR,
and import the response from the CA.
Prerequisites
• An account with a Certificate Authority
• Webserver configured for HTTPS with self-signed certificate. See To set up TLS using a self-signed
• The keystore password that was used to setup the self-signed certificate
261
1 Open the Webserver Keystore
a) In Keystore Explorer, click File > Open, and browse to <WebServer
Install>\programdata\webserver_base\keystores.
b) Select certkeys, and then click Open.
c) Enter the keystore password.
d) Click Entry Name, and select webctrl.
2 Generate CSR (Certificate Signing Request)
A CSR is a text file signed with your private key.

a) Right-click webctrl, and select Generate CSR.
b) Enter the keystore password.
c) Copy and save the path in CSR File. This is where the CSR file will be written and you will need
it later.
d) Check with your CA for any additional required fields, for example, Challenge, Optional
Company Name, or Signature Algorithm. Defaults are set for most common options.
3 Import the CSR File

a) Send the CSR File to your Certificate Authority. Your CA Authority may accept requests by email
attachment, or provide a portal where you can upload the file.
b) Save the CA reply file the CA provides to your computer.
c) Open the webserver keystore, click Entry Name, and select webctrl.
d) Right-click and select Import CA Reply" (From File).
e) Save the keystore.
f) Restart the webserver.
To setup a web server using provided certificates (.pfx file)
Prerequisites
• A Certificate Archive with private key, .pfx file, .jks file, .pcks12
• The password for the archive and private key.
Create certkeys file from certificate archive.

1 Click Open > File and select the .pfx file containing certificates.
3 Click Tools > Change Keystore Type and select PKCS12.
5 Click File > Save As and save the files as "certkeys". Type must be "All Files" with no file suffix.
6 Select the private key entry.
7 Right-click and select Rename.
8 Enter alias webctrl.
9 Save the file.
10 Move the new certkeys file into "<Install Directory>\programdata\webserver_base\keystores".
11 Replace the existing certkeys file with the new certkeys file.
262
Configure keystore password using Sitebuilder
1 Open Sitebuilder™.
2 Click Configure and then select Web Server.
3 Set keystore password to the password used to create the certkeys file.
4 Restart the WebServer.
To create a BACnet/SC Certificate Authority using Keystore Explorer

Use Keystore Explorer to create a Certificate Authority (CA) to sign BACnet/SC certificates for the
devices on a BACnet/SC network.
NOTE We recommend creating a separate keystore for each network, each with its own password.
1 Create a new keystore by clicking Create a Keystore from the Quick Start menu or by clicking the
New icon in the tool bar.
2 Select keystore type PKCS#12.
3 Click File > Save to save the keystore as a ".pkcs12" file.
4 Click Tools > Generate Key Pair.
5 Select one of the following algorithms, set the associated fields as indicated below, then click OK.
Algorithm Fields
EC (recommended) ○ Set: SEC
○ Named Curve: secp256r1
RSA ○ Key Size: 2048
6 Set the Validity Period, and then click Apply. We recommend a minimum of 20 years. See To
replace a BACnet/SC network’s Certificate Authority (page 269).
TIP Set Validity Start to a previous date to avoid potential time zone issues.
7 Click the Edit icon beside the Name field to complete the Name fields with appropriate values for
the site and customer.
8 Click Add Extensions > Use Standard Template, select CA, then click OK.
9 Click OK on the Add Certificate Extensions dialog.
10 Click OK on the Generate Key Pair Certificate dialog.
11 In Enter Alias, enter a meaningful alias that identifies the owner of the signing certificate and how it
is to be used, then click OK.
12 Set a key pair password. We recommend giving each CA its own unique password.
13 If this new CA will be used to replace an existing CA on a BACnet/SC network, export the new CA’s
certificate:
a) Right click on the CA and select Export > Export Certificate Chain.
b) On the Export Certificate Chain dialog choose:
1. Export Length: Head Only
2. Export Format: X.509
3. PEM: select checkbox
4. Filename: Enter path and filename. File extension should remain .cer
263
To sign a BACnet/SC certificate signing request using Keystore Explorer
A BACnet/SC network requires each device to have a unique operational certificate signed by a
common Certificate Authority (CA). You can use Keystore Explorer to sign an operational certificate
using an existing CA.
1 Open the keystore containing the CA you wish to use.
2 Right-click on the CA and select Sign > Sign CSR.
3 Select the CSR file to sign. For example, "cert.csr".
4 On the Sign CSR dialog:
1. Select the desired Validity Period on the Sign CSR dialog, and then click Apply.
NOTE When choosing a validity period, consider that this process will have to be repeated
whenever certificates expire. See To create or replace a BACnet/SC device’s operational
certificate (page 268) to replace this certificate when it expires.
TIP Set Validity Start to a previous date to avoid potential time zone issues.
2. Click Add Extensions.
3. Click Use Standard Template.
4. Select SSL Server, then click OK.
5. Select the Extended Key Usage extension and click to select TLS Web Client
Authentication. TLS Web Server Authentication should already be selected, do not deselect it.
Click OK, then click OK on the Add Certificate Extensions dialog.
6. On the Sign CSR dialog, click OK.
7. On the Export Certificate Chain dialog, set the fields as indicated below, then click Export.
▪ Export Length: Select Entire Chain
▪ Export Format: Select X.509
▪ Export File: Set the path and filename where the signed certificate (.cer) file will be created.
Setting up BACnet/SC network communication

To set up a BACnet/SC network:
1 Set the controllers' IP addresses. See Setting OptiFlex™ controller IP addresses for BACnet/SC
(page 264).
2 Set up a BACnet/SC connection in the WebCTRL® interface. (page 266)
Setting OptiFlex™ controller IP addresses for BACnet/SC

See the device's Technical Instructions for details.
To communicate on the IP network, each controller must have the following:
• IP address (unique on the IP network)
• Subnet mask
• Default gateway address (IP router)
264
Use one of the IP addressing schemes described below with the associated instructions that follow.
Use a... If...

DHCP IP Address The IP network uses a DHCP server for IP addressing
generated by a DHCP server
Custom Static IP Address You do not use a DHCP server and the answer to any of the
from your network administrator following questions is yes. Will the WebCTRL® system:
• Share a facility's existing IP data network?
• Have 254 or more devices with static IP addresses?
• Be connected to the Internet?
• Have at least one device located on the other side of an
IP router?
• Have any third-party IP devices?
Default IP Address The answer to all of the above questions is no.
that your system creates
NOTE Carefully plan your addressing scheme to avoid duplicating addresses. If third-party devices are
integrated into the system, make sure your addresses do not conflict with their addresses.
To set the IP address in the controller setup pages

You must define the OptiFlex™ controller's IP address in the controller setup pages. See the device's
Technical Instructions for details.
To set a DHCP IP address

1 On the controller setup pages Modstat tab, find the controller’s Ethernet MAC address and write it
down.
2 In the Primary BACnet/IP section on the Gig-E Port tab under Configuration, select DHCP for the
Address Mode.
3 Write down the Address that was obtained through DHCP.
4 Give the DHCP network administrator the IP address and Ethernet MAC address and ask him to
reserve that IP address for the controller so that it always receives the same IP address from the
DHCP server.
To set a custom IP address

1 Obtain the IP address, subnet mask, and default gateway address for the controller from the facility
network administrator.
2 On the controller setup pages Ports tab under IP Port, select Custom Static.
3 Enter the IP Address, Subnet Mask, and Default Gateway addresses that the network
administrator gave you.
4 Click Save.
265
To set a default IP address
Default IP addressing assigns the following to the controller:
• IP address = 192.168.168.x
where x is the setting on the rotary switches in the range from 1 to 253
• Subnet Mask = 255.255.255.0
Default Gateway = 192.168.168.254
1 Set the controller's three rotary switches to a unique address on the network. Set the left rotary
switch to the hundreds digit, the middle switch to the tens digit, and the right switch to the ones
digit.
EXAMPLE The switches below are set to 125.
2 On the controller setup pages in the Primary BACnet/IP section on the Gig-E
Port tab under Configuration, select Default IP Address for the Address Mode.
To set up a BACnet/SC connection in the WebCTRL® interface

Using a BACnet/SC connection and an Ethernet Network Interface Card, the WebCTRL® server can
communicate using BACnet/SC over an Ethernet network.
2 On the Configure tab, select BACnet Secure Connect Connection.
3 Click Add.
○ Stopped or Design Mode, go to the next step below.
5 Set up the fields as needed for that connection. See the tables below.
6 Set up Certificates for BACnet/SC (page 268).
7 Under Networks using selected connection, select the BACnet/SC network.
8 Click Accept.
9 If running the WebCTRL® Server (not WebCTRL® Design Server) application, select the BACnet
Secure Connect Connection, then click Start.

Primary Hub URI The web address WebCTRL® uses to connect to the Primary Hub.
Primary Hub The web address used to access the Primary Hub's management user
Management URL interface.
Failover Hub URI The web address WebCTRL® uses to connect to the Failover Hub in
the event the Primary Hub is unavailable.
Failover Hub The web address used to access the Failover Hub's management user
Management URL interface.
266
to. This is used to specify which ARCNET network the ARCNET card is
connected to, and which BACnet/IP or BACnet/SC network the
WebCTRL® server is on if there are multiple BACnet/IP or BACnet/SC
network nodes with different network numbers in your system.
Comm Timeout (in Amount of time, in milliseconds, allowed before retrying a
milliseconds) transmission on the network if a required acknowledgment is not
received.
Do Sync (in Amount of time, in milliseconds, allowed for the WebCTRL®
milliseconds) application to complete a communication task such as downloading to
Minimum Reconnect Minimum amount of time, in seconds, allowed before retrying a
Time connection to the Hub. Increases with each failure until Maximum
Reconnect Time is reached.
Maximum Reconnect Maximum amount of time, in seconds, allowed before retrying a
Time connection to the Hub.
Connection Wait Amount of time, in seconds, allowed for a hub to reply to a connection
Timeout request.
Disconnect Wait Amount of time, in seconds, allowed for a hub to reply to a disconnect
Timeout request.
Initiating Heartbeat How frequently, in seconds, a device that is idle sends a heartbeat to
Interval the hub.
Accepting Heartbeat Amount of time, in seconds, the hub waits to receive a heartbeat
Interval before disconnecting.
267
To manage certificates for BACnet/SC
To create or replace a BACnet/SC device's operational certificate
Every device on the BACnet/SC network includes a user interface where the operational certificates are
managed. The procedure to create or replace a device’s operational certificate is outlined below and is
the same for all devices.
Device Type Certificate management tab

Connections > BACnet/SC Port
WebCTRL® interface Connections > Configure tab > Manage Certificates
Connections > BACnet/SC Port
1 Create Keystore: If a keystore has not yet been created, update the five Certificate Name fields
(Name, Organization, City, State, Country) as desired, then click Create Keystore.
2 Create Certificate Signing Request (CSR): Update the five certificate Name fields (Name,
Organization, City, State, Country) as desired, then click Download CSR. A .csr file will be created
and downloaded to your PC.
3 Sign the CSR: Send the .csr file to be signed by the manager of the BACnet/SC network’s signing
CA. If you are using self-signed certificates, see To sign a Certificate Signing Request using
Keystore Explorer (page 264).
4 Upload the CSR response: When you receive the CSR response file, click Upload and select the .cer
response file. The Certificate Authority will be added to the certificate table, and the operational
certificate’s information and expiration date will be updated.
To renew an expiring operational certificate

2 On the Configure tab, select the BACnet/SC connection, and then click Manage Certificates.
3 Update any fields if needed.
Name Certificate name
Department Department name
Organization Organization name
City Organization city
State Organization state
Country Organization country
4 Click Download CSR to generate a Certificate Signing Request (CSR) and download as a .csr file.
5 Sign the operational certificate with the BACnet/SC network's Certificate Authority using the
downloaded CSR file. Keystore Explorer is one option for signing the certificate.
6 Click Upload to upload the CSR response file or new Trust Certificate - supports .pem, .cer, or .p7r.
268
To replace a BACnet/SC network's Certificate Authority
If a Certificate Authority (CA) is expiring or has been compromised, every BACnet/SC device on the
network must get an updated operational certificate signed by a new CA. In order to do this without
losing connectivity to existing devices, you must load the new CA onto every device before removing the
old CA from any device.
1 Create a new CA. If you are using self-signed certificates, see step 13 in To create a BACnet/SC
Certificate Authority using Keystore Explorer (page 263).
2 On each device, add the new CA to the device by uploading the .cer file created in step 1.
IMPORTANT Do not move on to step 3 until this has been done on every device on the network.
3 On each device, update the operational certificate by having it signed by the new CA and uploading
the newly signed certificate to the device. You can use the device’s original .csr file or create a new
one. After uploading the newly signed certificate, check the certificate table to validate that the
operational certificate’s issuer now matches the description of the new CA that was uploaded in
step 2. See To create or replace a BACnet/SC device’s operational certificate (page 268).
IMPORTANT Do not move on to step 4 until this has been done on every device on the network.
4 On each device, remove the old CA by clicking Delete beside it in the certificate table.
To monitor certificate expiration

BACnet/SC Certificate Expiration alarms will trigger whenever a BACnet/SC certificate in the WebCTRL®
application or on the BACnet/SC Hub will expire within configured thresholds. See Scheduled Tasks tab
(page 325) to configure these thresholds. When a certificate is within the warning threshold, the alarm
repeats once per week. If a certificate is within the critical threshold, the alarm repeats every day and
every operator will get a pop-up message when they log in.
TIPS:
• Create alarm actions to receive an email when a system error or system critical alarm is triggered.
• To turn off the login pop-up, click Run Now on scheduled task after resolving critical certificate
problem.
269
Setting up hardware
Commissioning equipment
Follow the process below to commission system equipment.
Step 1: Check out point setup

1 On the WebCTRL® Geographic tree, select the piece of equipment you want to check out.
2 Click Properties.
3 View and change properties on the I/O Points, Alarm Sources, Trend Sources, Network Points,
Display Points, BACnet Objects, and Rnet Points tabs. See "Property descriptions" below.
4 After completing the equipment checkout, click the Equipment Checkout tab.
5 Select Checked Out. This field is for your reference only.
6 Optional: Type notes.
○ Notes typed in this field appear in the Equipment Checkout report and can also be changed
from the SiteBuilder Notes tab and the Properties page Notes field for this piece of equipment.
○ Notes remain in this field until an operator deletes them.
7 Optional: Click the Reports drop-down arrow button, then select and run each of the following
reports to verify your work:
○ Equipment > Point List
○ Alarms > Alarm Sources
○ Equipment > Trend Usage
○ Equipment > Network IO
TIP You can export the calibrated data so that you can import it into another control program. See
Optional: Import/export calibration data (page 278).
Property descriptions
I/O Points
Name Click the name to display the microblock pop-up.
NOTE A red name indicates a fault condition where the point may be
misconfigured.
EXAMPLE No input/output number or a nonexistent input/output number.
Type Type of Input or Output point. See Point types (page 30).
Value The point's present value.
Offset Allows for fine calibration of the present value of an analog point.
Polarity Determines the point’s binary normal polarity in the control program.
NOTE Polarity is not the hardware normally open/normally closed position.
270
Locked Select the checkbox to lock the present value at the value you specify.
Exp:Num Expander numbers and input or output numbers associated with where the
physical point wires, such as a sensor wire, are physically connected to a
controller.
I/O Type Selects the bank of physical inputs or outputs on the controller.
Sensor Selects how the physical input is mapped to the engineering units.
Min/Max is used with the sensor type of linear to scale the input to engineering
units.
NOTE This field is ignored for sensor types other than linear.
EXAMPLE: AI linear sensor type
min -10
max 50
when input reads 100% the value is 50
50% 20
0% -10
Actuator Selects how the present value in engineering units is mapped to the physical
output.
Min/Max is used with the actuator type of linear to scale the output from
engineering units.
NOTE This field is ignored for actuator types other than linear.
EXAMPLE: AO linear sensor type
min -10
max 50
when input reads 50 the output is 100%
20 50%
-10 0%
Resolution Amount by which the present value will change.
EXAMPLE If a physical input changes by 1, but the resolution is set at 2, then
the present value remains the same. If the input changes by 2, the present value
will then change by 2.
Checked Out These fields are for your reference only.
Checkout
Notes
Alarm Sources
Type Type of point that is an alarm source. See Point types (page 30).
Alarm Shows Alarm in red if a current alarm exists.
Network Select to allow the microblock to be seen by the WebCTRL® application and
Visible third-party BACnet controllers on the network.
Potential Select to enable the microblock to generate alarms.
Alarm Source
271
Alarm Enabled Alarm—Select to generate an alarm when conditions exceed the limits set in the
Condition column.
Return—Select to generate a return-to-normal message when the alarm condition
returns to a normal state.
Fault—Select to have an alarm generated if the alarm source is not configured
correctly. For example, a misconfigured channel number produces a no sensor
fault.
Requires ack Alarm—Select to require that the alarm be acknowledged.
Return—Select to require that the return-to-normal message be acknowledged.
Critical Select if the alarm is critical.
Template You can change the alarm template assigned to the microblock.
Category You can change the alarm category assigned to the microblock.
Dial on alarm Select to have this alarm immediately delivered through a modem connection.
Condition An alarm will be generated if conditions exceed the low or high limits set.
Deadband:
The amount inside the normal range by which an alarm condition must return
before a return-to-normal notification is generated.
EXAMPLE
Delay Delay time in seconds for notification after an alarm is generated.
Trend Sources
NOTE A red name indicates a fault condition where the point may be
misconfigured. EXAMPLE No input/output number or a nonexistent input/output
number.
Type The type of point being trended. See Point types (page 30).
Sample The interval or COV (Change of Value) increment that triggers the trend sample.
Interval
Max Samples The maximum number of trend samples the controller will hold before replacing
oldest samples with newest.
NOTE Changing Max Num of Samples will delete all of the point's trend samples
currently stored in the controller. But, you can transfer the trend data from the
controller to the system database before you change the value. Click on the point
name. In the pop-up, go to Trends > Enable/Disable, and then click Store Trends
Now.
Stop When Stops trend sampling when the maximum number of samples is reached.
Full
272
Historian - Triggers the trend historian to record trends when the controller has
Enable accumulated the defined number of samples. This must be less than the Max
(Samples) Samples allocated.
TIP A good value is a little less than 1/2 of the Max Samples.
Keep for __ Defines how long trend data is stored in the system database. This is based on
days the date that the sample was read. Select System Default to use the value
defined on the System Settings > General tab, or select Custom to set a value
for this trend only.
Samples in The number of samples that are currently stored in the controller.
Controller
Network Points
NOTE A red name indicates a condition where the point may be misconfigured.
Type Type of network point. See Point types (page 30).
Value The point's present value.
EXAMPLE For a Maximum point type, Value is the maximum value of all the
target BACnet object properties the point is communicating with.
Locked Select the checkbox to lock the present value at the value you specify.
Default Value The value that the control program will use as the point’s value when
communication with the target defined in the Address column is lost or
communication is disabled.
Com Enabled Select to enable this point’s network communications. Disable this property for
troubleshooting.
NOTE Select All in the column header to quickly enable all points in the control
program.
COV Enable Select to make:
• A digital network output point write a value to the target defined in the
Address column only when the value changes.
• An analog network output point write a value only when the value changes by
the specified increment.
Refresh Time The time interval at which the network point writes or retrieves the value to or
(mm:ss) from the target. For network output points, this time is used when COV is not
enabled or when COV is enabled but fails.
NOTE If COV fails and the Refresh Time is zero, the value is sent once per
second.
Test Select to test the network connections. The WebCTRL® application immediately
writes to or retrieves the value from the target.
273
Address The address of the target BACnet object property or third-party value that the
point communicates with.
NOTES
• An address from a SiteBuilder source tree, such as a cool or heat source tree,
can be edited only in SiteBuilder.
• Click Search/Replace at the top of the Address column to have the
WebCTRL® application replace all instances of specific text in the addresses
with different text. This is especially useful when copying a control program to
use for multiple third-party devices.
Error The error code and error if the point cannot communicate with the target.
Present Value Current value of the target defined in the Address column.
Next Shows one of the following:
Refresh/Next • The next time the network point will write to or retrieve a value from the
Subscription target defined in the Address column.
(mm:ss)
• The next time the network point will subscribe to the target.
Checked Out These fields are for your reference only.
Checkout
Notes
BACnet Objects
This tab shows all BACnet objects in the control program. Display microblocks that have a Device Alias
appear in separate tables, one table for each alias.
Name The name used in the WebCTRL® interface for this object.
NOTE A red name indicates a condition where the point may be misconfigured.
Reference A unique identifier that allows the point to be referenced for use in graphics,
name source tree rules, or network links.
Type The BACnet object type.
Present Value The object's current value.
Locked Check to lock the third-party object to a specific value.
Device A device alias. See "To reuse a control program" in Device Alias.
Object Name An alpha-numeric string that is unique within the third-party device.
Object ID A combination of the object type and a unique instance number. The object ID
must be unique within the device.
Address The address of the third-party object that the microblock references.
Network Allows other BACnet equipment to read or change the microblock's present
Visible value. Must be enabled for this microblock to generate alarms.
274
Rnet Points
This tab shows varying information for the different point types. Below are all possible properties that
may appear on this tab and a list of the applicable points. The following list is arranged alphabetically.
Combination (Analog Sensed Values)

Algorithm The method used to combine the ZS sensors' values to determine the
microblock's output value.
Default Value (Analog Parameters, Binary Parameters, Multi-State Parameters)
The value the control program uses until a user changes the value in the system
interface.
Display Name (All points)
The microblock label used in the EIKON® application and the WebCTRL®
interface. You can use any characters except the " character.
Display (Analog Sensed Values, Analog Statuses, Analog Parameters)
Resolution Defines the resolution of the value to be displayed on the ZS sensor. For
example, 1 displays only integers (example: 74) and 0.5 displays values to the
nearest 0.5 (example: 74.5).
Edit Increment (Analog Parameters)
The amount that you want each press of the sensor's or button to change
the microblock's value.
Editable (Analog Parameters, Binary Parameters)
When enabled, the microblock's value is editable on the ZS sensor.
Lock Present (Binary Parameters)
Value to Check to output the locked value from the microblock instead of the microblock's
calculated value.
Maximum (Analog Parameters)
The highest amount that this value can be changed to on the ZS sensor or in the
Menu (All points)
Configuration Shows which sensor screens display the value.
Minimum (Analog Parameters)
The lowest amount that this value can be changed to on the ZS sensor or in the
Minimum off (Binary Parameters)
time The minimum period (seconds) that the microblock sends an off signal to the
controller, regardless of the input signal to the microblock.
Minimum on (Binary Parameters)
time The minimum period (seconds) that the microblock sends an on signal to the
controller, regardless of the input signal to the microblock.
Object Id (All points)
A combination of the object type and a unique instance number.
Object Name (All points)
A unique alphanumeric string that defines the BACnet object. Although the
Object Name field can be edited, it is not recommended.
275
Reference (All points)
name A unique identifier that allows the point to be referenced for used for graphics,
source tree rules, or network links.
Rnet Tag (All points)
Defines what type of information this value represents and determines how the
sensor will display the value. For example, for the Rnet Tag Fan Status, the
sensor automatically displays on the Home screen when the microblock is
active.
Show on (Analog Sensed Values)
sensors Defines whether the ZS sensors are to display their individual sensed values, or
the value determined by the Combination Algorithm.
Type (All points)
Type of Input or Output point. See Point types (page 30).
Value (All points)
The point's present value.
Step 2: Check controller to sensor wiring

PREREQUISITE On the Logic page, disable the run condition(s) in the control program to prevent
control program execution from affecting output values while you check out the equipment.
Binary inputs (BI)

1 Short the binary inputs wires at the end device, for example, at a pump proof or fan proof.
2 On the Properties page I/O Points tab, verify the binary input point is closed.
3 Open the binary input at the end device.
4 Verify the binary input point is open on the Properties page.
5 Repeat for all binary inputs.
NOTE If the readings on the Properties page are reversed from actual conditions, the polarity (normally
closed/normally open contact position) is set incorrectly.
Analog inputs (AI)

1 Verify the sensor type and the min/max values are configured correctly.
2 On the Properties page I/O Points tab, read the analog input value.
3 Short the point. The sensor should go to full range when shorted.
4 Calibrate analog input value by adjusting the calibration offset if needed.
276
Binary outputs (BO)
1 If the controller's binary output is wired through an equipment starter, set the starter HOA switch to
Automatic.
2 On the controller, set the binary output’s HOA switch to On.
3 Verify that the controlled equipment has turned on.
4 On the controller, set the binary output’s HOA switch to Automatic.
5 On the Properties page I/O Points tab, lock the binary output point to On.
6 Verify the device has turned on.
7 Unlock the binary output point.
8 On the controller, set the binary output’s HOA switch to Automatic.
NOTE If the locked conditions on the Properties page are reversed from actual conditions, the polarity
(normally closed/normally open contact position) is set incorrectly.
Analog outputs (AO)

1 Verify the output/actuator type and the min/max values are configured correctly.
2 Lock the analog output point to the device minimum output, such as 2 volts or 0%.
3 Verify movement of the end device to the desired position.
4 Lock the voltage output to the device maximum, such as 10 volts or 100%.
5 Verify movement of the end device to the desired position.
6 Unlock.
Step 3: Check controller communication

1 On the Network tree, select the network that the controller is on.
2 On the Devices page, view the status of all controllers on that network.
TIPS
• Navigate to a network or router further down in the tree to show its controllers on the Devices
page.
• In the Reports button drop-down list, select Network > Equipment Status, then click Run to see the
status of all controllers below the selected tree item.
Step 4: Check equipment operation

Refer to the sequences of operation in the system specifications to verify that the equipment operates
in each operational mode (for example, occupied and unoccupied) as specified.
TIPS
• If needed, you can import calibration data that you exported from another control program. See
Optional: Import/export calibration data (page 278).
• To verify heating and cooling source tree associations, right-click an item the WebCTRL® tree, and
then select Equipment Sources.
277
Step 5: Collate checkout information
If field technicians use copies of a system database during the commissioning process, each technician
can export their Equipment Checkout status and notes. Then, you can import their Equipment Checkout
information into the final system database.
1 In a technician's copy of SiteBuilder, select an area or piece of equipment.
2 Select Edit > Export Checkout Information to export the checkout information for that tree item
and its children.
3 Name and save the .xml file to any folder.
4 In the final system database, select any area or piece of equipment.
NOTE You can import the .xml files to any tree item regardless of their exported location.
5 Select Edit > Import Checkout Information.
6 Browse to the .xml file that you want to import, then click Select.
NOTE SiteBuilder displays Checkout Conflicts if the imported information conflicts with the
database information. Check Replace to overwrite the database information with the imported
information.
7 Repeat steps 5 and 6 for each .xml file that needs to be imported.
Step 6: Check the commissioned status of all equipment

1 In the WebCTRL® interface, select the system.
2 Click the Reports drop-down arrow button, then select Commissioning > Equipment Checkout.
3 Run the report.
Optional: Import/export calibration data

You can export I/O point calibration data from a control program and import it into the same control
program or another control program with the same I/O point configuration.
To export calibration data

1 On the WebCTRL® Geographic tree, select the control program whose data you want to export.
2 Scroll to the bottom of the Properties page I/O Points tab, and then click Export. The file <control
program name>_<ref name>.xml is saved in your browser's Downloads folder.
To import calibration data

NOTE We recommend that you export existing data as a backup before you import new data.
1 On the WebCTRL® Geographic tree, select the control program that you want to import the
data into.
2 Scroll to the bottom of the Properties page I/O Points tab, and then click Import.
3 Browse to the file you want to import.
278
4 Click Continue. A side-by-side comparison of existing data and the new import data will appear. Red
text indicates one of the following errors:
○ Duplicate data—Existing data has duplicate I/O numbers so that import cannot determine its
match.
○ I/O type mismatch—I/O Type in existing data does not match I/O Type in import data.
○ Missing import data—Existing data has a point that import data does not have.
○ Missing system data—Import data has a point that existing data does not have.
5 Click OK to complete the import. Existing data that does not show an error will be overwritten by the
imported data.
ACxelerate automated commissioning

ACxelerate automated commissioning allows you to verify and report on the health state of VAV
dampers and reheat valves in your VAV boxes.
To obtain the health report for any of your equipment, you first need to:
1 Configure the equipment.
2 Configure and design your test. See Configuration & Design (page 287).
3 Set up and initiate a Run Test on selected equipment. See Run Test (page 289).
4 View the analytics report. See Analyzing Data (page 294).
ACxelerate Requirements
To use ACxelerate, you will need to:
• have Access Commissioning Tools privilege
• purchase and download the Automated Commissioning Tool license
ACxelerate License
• Your free 6 month trial must be used within 2 years of the WebCTRL® license issue date, and
begins on the first use of ACxelerate. You can purchase a renewal license for ACxelerate; this
period begins immediately after activation.
• To activate renewal license: upload the ACxelerate license file to System Configuration >
License Administration.
• Both the ACxelerate free trial and renewal license include unlimited Run Tests.
• If the ACxelerate free trial or renewal license expires, the Configuration and Analyze Data page
remains accessible but Run Tests are locked.
If using a dealer license, no ACxelerate license is required. It includes unlimited Run Tests but report
downloads are disabled.
279
Before you begin checklist
General
 Avoid using consecutive underscore characters in the equipment display name, or the test won’t
execute properly. For example, type VAV_1, not VAV__1.
 Verify that the WebCTRL® BACnet communication is well established between the VAVs and AHUs you
will be testing. This tool sends override commands to VAVs at fixed time intervals (18 minutes is the
default). If communication fails, commands will not reach the VAV boxes and the test may return
incorrect results.
 AHU and VAV Display Names must be unique in the WebCTRL® database. AHU and VAV Reference
Names must start with the ‘#’ symbol.
 We recommend creating an AHU display name with no more than 31 characters. Otherwise, the AHU
group tab hyperlink present in Reports downloaded in Excel® format will not work. However, you can
still manually access the AHU tab.
 Zero flow balancing of all VAV boxes must be done prior to starting a Run Test. Otherwise, the VAV
airflow sensor issue may be marked as damper stuck.
 VAV must be linked to AHU using any one of the following sources:
Cool Source Tree
Links VAV to AHU Group with Cool Source. Set to the following microblock and reference names:
• Parent microblock used in AHU: Tot/Min/Max/Avg
• Parent microblock reference name: in_cool_req*
• Child microblock in VAV reference name: cool_request
Any source tree will work if the above mentioned microblock and reference name is used to link AHU
and VAV.
NOTE
• Multi-layer cooling source is not supported. For cool source to work, there must be a direct link
between AHU and all VAVs.
• See Using Custom Source Tree in place of Cool Source (page 301)
Geographic Tree
AHUs can be linked to VAV by having them both in a dedicated
area. For example, in the tree to the right, AHU1 and VAV1-
VAV7 are in dedicated area ‘floor1’. VAVs can reside in area
(ZoneA, ZoneB...) which are under the area floor1 where AHU
is present.
280
 The AHU must be fully commissioned. High static shutdown (hardware/software interlock) must be
working before using ACxelerate. The supply fan speed control static pressure setpoint must be
constant and high enough to avoid starving VAV when cumulative VAV damper load on AHU fan is 60%
of actual box size.
NOTE During the damper/reheat valve Run Test, average damper/reheat valve open position of all
VAVs served by an AHU is between 40% to 60% open.
 The AHU supply air temperature must be at a constant setpoint (bypass any setpoint optimization
algorithms).
 People should not be occupying the zones being tested, but make sure the equipment schedule
microblock is in the occupied state.
For systems with series fan VAVs, the series fan boxes' schedule must be occupied so the fan is rotating
in the right direction before initiating the Run Test.
 All hardware configuration and design parameters of the Airflow Control microblock must be set to the
appropriate value as per the VAV box's design. This includes the Manufacturer's specified air flow at 1"
water column parameter (value is supplied by the VAV box manufacturer and is usually printed on the
side of the VAV box).
 ACxelerate does not support any browser extension or built-in browser feature for content filtering,
including ad-blocking. Before using ACxelerate, disable any such browser extension or feature. Example:
uBlock Origin.
Reheat valve test
 The boiler control system must be fully commissioned.
 Bypass any setpoint optimization algorithms to keep the boiler supply temperature at a constant
setpoint. Set to the highest temperature allowed by the operator. Maintaining a constant hot water
temperature ensures a noticeable difference in the VAV’s discharge air temperature when the reheat
coil goes from the closed position to the open position.
 The associated boiler pumps should operate continuously over the duration of the test and be kept at a
constant setpoint.
 Keep the AHU supply air temperature at a constant setpoint. We recommend keeping the setpoint at
55°F (13°C) or lower to achieve a noticeable difference between AHU supply air temperature and the
VAV discharge air temperature when the VAV reheat coil is 100% open.
281
Setting up the ACxelerate Automated Commissioning Tool
To obtain the health report for any of your equipment, complete the following tasks in this order.
Task 1. Configuration & Design

In the first task, create a database of equipment in order to do the following:
• Discover all the equipment
• Define the relationships between AHUs and VAVs
• Define reference names of points which need to be targeted
• Defines the test configuration parameters for damper loop and reheat valve loop test
This only needs to bet set up one time, but you can return here at any time to the following:
• Rediscover new equipment and point list due to change in equipment or its point names
• Change the equipment's configurations
See Configuration & Design (page 287) for further instruction on creating your database of equipment.
Task 2. Run Test

In the second task configure the test by selecting the equipment for the test, setting up parameters,
and scheduling the test. This also displays the progress of the test running for each VAV.
Once the test is complete, it passes the collected samples through to the analytics engine to find faults
in VAVs.
NOTE If the Configuration & Design task has previously been performed, start from here.
See Run Test (page 289) for further instruction.
Task 3. Analyze Data

In the third task use a dashboard to display the result of the analytics performed by the Run Test task
above. It also allows the end user to download the reports in HTML and Excel formats (NOTE This
feature is not available with a dealer license). This task activates once the Run Test is completed.
NOTE If the test was run in the past, then you can visit the dashboard of the last run test from this
tool's homepage.
See Analyzing Data (page 294) for further instruction.
282
283
Semantic tagging for ACxelerate
Use semantic tagging (page 170) to reference AHU equipment and points in AHU and VAV equipment.
VAV equipment does not need semantic tags. It includes:
• Built-in semantic tags which are used by ACxelerate (you may see more built-in tags for ACxelerate,
but they are for future use)
• Built-in semantic tag rules
Semantic Tags used in ACxelerate

Below is a list of semantic built-in tags that refer to the points in the description.
For AHU equipment

Tag ID Description
ACx AHU acx_ahu Applied to VAV AHU equipment to be tested
Hot Water Source acx_hw_source Optionally applied to Hot Water System or
Boiler System equipment in which Hot Water
Supply Temperature Point is present
For points in VAVs

Tag ID Description
ACx Flow Control acx_airflow Applied to airflow microblock to override

damper command
ACx Airflow Value acx_airflow_value Applied to point to read airflow value
ACx Enable Damper Lock acx_dmp_lock_check Applied to point to read damper lock status -
This is an optional point and required only if
external damper lock enable point is present
in VAV equipment.
ACx Heat Type acx_heat_type_check Applied to read heat type at
relinquish.default used in equipment file.
This is an optional point which is generally
used in Carrier factory controllers
ACx HW Valve acx_hw_valve Applied to analog output microblock intended
to override Reheat Valve command. This is
an optional point required only for reheat
valve test.
ACx Smart HW Valve CF acx_hw_smart_valve_cf Applied to analog output microblock intended
to override smart Reheat Valve command.
This is an optional point required only for
reheat valve test that are smart valve in the
Carrier factory controller.
ACx VAV Discharge Temp acx_vav_dat_value Applied to point to read VAV Discharge Air
Temperature. This is an optional point
required only for reheat valve test.
284
For points in VAV AHUs
Tag ID Description
ACx Cool Requests acx_ahu_cool_source Applied to point in AHU equipment to read

associated VAVs from cool source.
ACx AHU Supply Air Temp acx_ahu_sat_value Applied to point to read AHU Supply Air
Temperature. This is an optional point
required only for reheat valve test.
ACx AHU Supply Fan Status acx_ahu_fan_status Applied to point to read AHU Supply Fan
Status.
ACx Supply Fan Speed acx_ahu_fan_speed Applied to point to read AHU Supply Fan
Speed in percentage only (Hertz unit is not
supported). This is an optional point, used to
monitor AHU fan speed during damper tests,
and to display warning messages when the
fan is reaching maximum capacity.
For points in Hot Water systems

Tag ID Description
ACx HWS Temp acx_hws_temp Applied to point in Hot water system to read
Hot Water Supply Temperature. This is an
optional point. It is used in Reheat valve test
to neutralize the effect of Hot Water Supply
temp variation on the reheat valve test.
Semantic Built-in Tags rules for Point Tags

The following list shows the built-in rules for points in VAV and in VAV AHU (there are no built-in rules for
AHU equipment tag). Note that the reference names used in rules are taken from the EquipmentBuilder
library as well as reference names used in Carrier factory controllers.
If you are using an EquipmentBuilder generated equipment file, Carrier factory controller, or reference
name mentioned in the table below, then you do not need to assign any tags for any points.
Rule name Reference name Tags (ID)

ACx Flow Control air_flow ACx Flow Control (acx_airflow)
ACx Airflow Value air_flow/flow_input ACx Airflow Value (acx_airflow_value)
ACx Enable Damper Lock lock_dmpr ACx Enable Damper Lock (acx_dmp_lock_check)
dmpr_lock
ACx Heat Type heat_type ACx Heat Type (acx_heat_type_check)

ACx HW Valve hw_valve ACx HW Valve (acx_hw_valve)
ACx Smart HW Valve CF hw_valve_b ACx Smart HW Valve CF (acx_hw_smart_valve_cf)
285
Rule name Reference name Tags (ID)
ACx VAV Discharge Temp da_temp ACx VAV Discharge Temp (acx_vav_dat_value)
sa_temp
ACx Cool Requests in_cool_req* ACx Cool Requests (acx_ahu_cool_source)

ACx AHU Supply Air Temp sa_temp ACx AHU Supply Air Temp (acx_ahu_fan_status)
sat
lvg_air_temperature
sa_temp_sens
supply_temp
ACx AHU Supply Fan Status sf_status ACx AHU Supply Fan Status (acx_ahu_sat_value)
sf_status_bi
sfan_status
sfs
supfanstat
ACx Supply Fan Speed sf_vfd_output ACx Supply Fan Speed (acx_ahu_fan_speed)
vfd_output
ACx HWS Temp hws_temp ACx HWS Temp (acx_hws_temp)
pri_hws_temp
NOTE These built-in rules are only for VAV, VAV-AHU, and HWS points. AHU equipment tag ‘ACx_AHU
(ID: acx_ahu)’ needs to be assigned manually to each AHU equipment and HWS equipment tag. ‘Hot
Water Source (ID: acx_hw_source)’ must be assigned manually to HWS equipment in which a Hot Water
Supply temperature point is present. Either individually assign it to each equipment through the Tags
tab in Properties page of each equipment, or create custom rules in System Configuration >
Semantics > Custom Rules.
Semantic tagging for ACxelerate
CAUTION Before disabling ACxelerate make sure there is no ACxelerate activity in progress and
no concurrently open ACxelerate browsers.
The ACxelerate database connection can be enabled or disabled from the ACxelerate home page
(System Configuration > ACxelerate). In the disabled state, ACxelerate is not connected to its
database and cannot be used. In the enabled state, ACxelerate can be used as usual.
By default, it will be in the enabled state and for every restart of the WebCTRL® application it will retain
its last state.
NOTE Enabling/disabling ACxelerate allows for a hot backup of the WebCTRL® application. If a hot
backup is necessary, we recommend disabling ACxelerate when it’s not in use. Otherwise, leave it
enabled.
286
Configuration and Design
Once the ACxelerate database connection is enabled, you can configure and design ACxelerate.
This section covers:
• Discovering all VAV equipment and relating it to the appropriate AHU group with AHU equipment
tagging
• Defining time step interval
• Designing the Run Test database for the configured VAVs
To initiate Configuration and Design

1 In the System Configuration tree, click ACxelerate.
2 Enable ACxelerate (if not already enabled).
3 Click Configuration & Design, then click Detect devices.
4 Click Auto-detect devices.
○ Verify project and data source information:
▪ Project Name is written by default. Change as per project needs.
▪ Data Source From option defaults to Cool Request (for Cool Source). Geo Tree source is
also available based on which option is used to link AHU and VAV. See Before you begin
checklist for details.
5 Click OK to accept values or click Reset to revert to default values.
ACxelerate will scan the WebCTRL® database to find all VAVs and associate them with the AHU
group. It will also find all required points for the damper and reheat valve test in the VAV and AHU
equipment. ACxelerate is not required to be connected to the live system in order to complete
Configuration & Design.
Once complete, the VAV matrix is displayed on-screen and the same data is also saved to Project
Namecommission.xlsx where 'Project Name' is the name you created. The file is saved to
<system_name>\webapp_public\_acxelerate.
The content in each column of the VAV matrix is explained below:
Point Description
Air Source ‘Display Name’ of AHU equipment that this group of VAVs belong to
Equipment ‘Displays Name’ of VAV that the configuration parameter belongs to
Component Actuator Parameters in this row belong to damper or reheat valve test
287
Time Step By default, the step size is fixed at 20%. This means for the range of 0% to
100% as full stroke of actuator, there will be 6 steps where complete
actuation range will be tested (0%, 20%, 40%, 60%, 80% and 100%). The
time period for which data will be collected for each step is set here. The
default value is 1080 seconds (18 minutes). While changing this make
sure that:
All VAVs damper and reheat valve tests are set to the same value.
Values are set in multiples of 60 seconds.
Values are not set less than 840 seconds for both damper and reheat
valve system. For a damper only system, values cannot be set less than
660 seconds.
If the system response is slower and more data points are required, then
this period should be increased.
Actuator Node Path of the point to the override actuator value in VAVs
Actuator Enable Node Path of the point to enable the actuator override in VAVs
Air Flow Path of the trend point which store data for the airflow value in VAVs
VAV Dis Temp Path of the trend point which store data for the VAV discharge air
temperature value in VAVs
AHU Sup Temp Path of the trend point which store data for the AHU supply air temperature
value present in VAVs
Fan Status Path of the Boolean status point to read the AHU supply fan status present
in AHUs
Max AirFlow Path of the point to read the cooling max airflow value in VAVs
Min AirFlow Path of the point to read the occupied minimum airflow value in VAVs
HW Sup Temp Path of the point to read the Hot water supply temperature from Hot
water/Boiler System (Optional)
Fan Speed Path of the point to read the AHU Supply Fan Speed from VAV AHU.
(Optional)
NOTE Excel® contains additional columns for internal use only and should not be changed. These
include Constraint Type, Constraint Limit, Lower Range, High Range, Var Step, Nominal Flow, and
Location.
Causes of auto-detect device failure:

○ AHU Equipment Tag ‘ACx_AHU (ID: acx_ahu)’ is not assigned to AHU Equipment.
○ Option selected for Data Source (where AHU and VAV are linked) is either incorrect or not
working. Note that for Geo Tree; VAVs are searched from their controller model type.
288
To modify time step from the table, use one of two methods:
Modify
1. Click Modify.
2. Time Step is the only value that can be modified from here. Changing the value in any row
applies the same value to all rows.
3. Click Save.
Load file/Load existing file
To use this option, the auto-detect device option must have been used at least once so that
the Excel® file "Project Namecommission.xlsx" already exists. Use Excel® to modify the file and
upload it here.
NOTE Changes made in Excel® are not verified when uploading but will be verified in the
Component tab.
1 After verifying that the equipment and parameter information from the VAV Matrix is correct, click
Component.
○ Damper is selected by default in the component selection option. If there is any reheat valve
present on site, then only check the Reheat Valve check box.
○ Click OK. Here you can modify Time Step for the selected component, if necessary.
○ To temporarily clear a reheat valve for test, do this in RunTest/Group-Equip Select; see Setting
up and running a test.
○ Entries in the VAV Matrix that are marked in red have points missing that are required for the
damper test.
○ Entries marked in orange have points missing that are required for the reheat valve test.
○ Missing points are caused by a semantic tagging mismatch and can cause the damper test
and reheat valve test to fail.
2 Click Design. ACxelerate will automatically define the override values for each step of all VAVs to be
used in the damper/reheat valve test.
NOTE The list is complete when all items are marked "Done". This may take up to a minute. If any
of the AHU groups fail, start over at Component.
3 Click Test.
Run Test
Run Test allows ACxelerate to:
• select VAVs for the test
• schedule the damper and/or reheat valve test
• collect the field present value data and store it in its own database
• pass data through the Analytics engine to find VAV faults
• route you to the Analyze Data Dashboard where results are displayed
NOTE If the Configuration & Design task has been previously performed, you can start the Run Test
from here.
289
To select VAVs for Run Test
1 Click Data source, then click Functional Test. Click OK to continue.
2 Click Group-Equip select.
3 Select AHU(s) from the Group selection column (left) and the desired associated VAV(s) from the
Equip selection column (center).
NOTE AHU groups marked in red have failed or were aborted in the previous test.
4 Right click to select a VAV from the Equip selection column.
5 Click to move selected VAV from the Equip selection column to the Enable or disable the test
individually column (right). To move all VAVs, click .
NOTE The Enable or disable the test individually column shows VAVs selected for the function test.
VAV names are prefixed by AHU followed by two underscores. For example, if AHU name is ‘AHU1’
and VAV name is ‘VAV1’ then it will display as ‘AHU1__VAV1’.
6 Right click to select/deselect VAVs in the Enable or disable the test individually column. Selection
status is shown by the damper and reheat valve selection symbols:
Symbol Meaning
Damper test is selected for VAV
Damper test is not selected for VAV
Reheat valve test is selected for VAV
Reheat valve test is not selected for VAV
7 Click to remove selected VAVs from the Enable or disable the test individually column. To
remove all VAVs, click .
8 Once the required VAVs are selected, you can group select/clear the damper or reheat valve test
from the Group Select check box in the bottom of Equipment selection window.
9 Click OK to continue.
CAUTION For systems with low diversity and/or significantly over-sized VAV boxes causing
AHU supply fan to max out for 70% of damper load, we recommend testing half of the VAVs in an
AHU system at a time to avoid supply-starvation incidents.
We recommend to:
○ Test the damper first. Fix any faults and re-run the test until it passes.
○ After the damper test passes, test the reheat valve. Fix any faults and re-run the test until it
passes. You can also test the damper and reheat valves together.
290
To schedule Run Test
Click Time and select the date and time to run the test on all selected equipment. Date format is
mm/dd/yyyy, and time format is HH:MM (24 hour).
• To ensure the test runs, schedule it to at least 2 minutes in the future.
If the damper and reheat valve tests are selected together, the damper test is scheduled first, followed
by reheat valve. By default, the reheat valve test time is set to begin 30 minutes after the damper test
is scheduled to be completed. (Damper Run Test is completed in = Time Step * 6 in minutes)
• To edit reheat valve test time, click Unlock and schedule the reheat valve test at least 30
minutes after the damper test is scheduled to be completed.
• If the reheat valve is selected for testing, you can set the damper Lock at to a value between 40 to
60% (default is 50%.) This locks all VAV dampers to the set value while the reheat valve test is in
progress.
• Select the Temperature Unit to which Temperature points are set. The default is °F.
To initiate Run Test

1 Click OK to proceed to Run Test.
○ The Run Test screen shows the Run Test Under Progress status. The damper test and reheat
valve test each have their own tabs, depending on whether one or both tests are selected.
○ All VAVs selected for the test are grouped by serving AHUs. Each VAV has dedicated rows with
8 steps displayed in columns described as follows:
Step 1: Lock
○ In the damper test, Lock indicates an active damper override.
○ In the reheat valve test, Lock indicates an active damper and reheat valve override.
○ When executed, it turns from black to green. If failed, it turns red.
Steps 2-7: Test override values
○ The damper test displays 6 damper override values in order of execution.
○ The reheat valve test displays 6 reheat valve override values in order of execution.
○ The reheat valve test in progress damper will be overridden to the value set in the Time
window (not displayed in Run Test section).
○ Each step will be executed for the time set in Time Step in Configuration & Design. When
executed, each value turns from black to green. If failed, they turn red.
Step 8: Unlock
○ In the damper test, Unlock indicates that the damper override is released.
○ In the reheat valve test, Unlock indicates that the damper and reheat override is released.
○ When executed, it turns from black to green. If failed, it turns red.
○ In the damper test, all VAVs start the test at the same time. Unless VAVs are aborted, they
execute each step at the same time and finish at same time.
○ The reheat valve test follows the same procedure.
291
2 Click View ALL VAV to view test progress of any group. The test is not complete until all items in the
list are marked Done in the Test Status column.
The VAV Run Test will end in one of three states:
State Meaning
VAV test was completed successfully.
VAV test failed to start due to a missing point. If the reheat valve is
not present in the VAV but is selected for the reheat valve test
from Group-Equip Select, it will show as failed and can be ignored.
VAV test was either automatically or manually aborted and failed
to complete.
3 Once Run Test is complete, click Analyze. This process will take a few minutes.
4 Once complete, click Go Analytics to view results on the Analyze Data Dashboard.
NOTE If you go to the Analyze Data Dashboard without first clicking Analyze, the dashboard will display
results from the previously run test.
NOTE While initiating Run Test, ACxelerate may display an orange pop-up screen as shown below. Do
not perform any actions until this message closes. It will stay on screen for up to several minutes
depending on server processing power and number of VAVs.
Once the orange pop-up screen closes, you can leave the screen while the test is in progress and return
here when the test is expected to complete.
292
To cancel Run Test
a. To cancel a specific VAV test, click Abort.
CAUTION Aborting the majority of the VAV tests for an AHU can create a high static risk if they
are run while Building Schedule is unoccupied.
b. To cancel all VAV tests associated with an AHU, click Abort All VAV.
c. To cancel all AHU-VAVS tests in the lists, click Abort All.
Automatic Aborts
○ If the AHU fan status is OFF, all VAVs associated to that AHU group will automatically abort.
Automatic abort may take up to 30 seconds to start.
○ If the AHU fan status is not readable due to a communication issue, ACxelerate will attempt to
read the AHU fan status for 3 minutes. If the AHU fan status is still not readable, then all VAVs
associated with that AHU group will automatically abort.
○ If a VAV point with the Tag Name ‘ACx Enable Damper Lock’ (Tag ID: acx_dmp_lock_check)
turns true while test is in progress, it will automatically abort. Automatic aborts may take up to
30 seconds to start.
○ If the damper override command does not match the damper position for 3 minutes from the
step start time (applicable for all 6 steps in Run Test), the VAV test will be automatically
aborted.
○ If VAV controller is not readable while Run Test is under progress, ACxelerate will continue to
make attempts until the end of the currently active step. If the VAV remains unreachable, it will
automatically abort.
293
VAV test data details
VAV damper test data

▪ VAV damper test data is not collected for the first 3 minutes of each step. This time is used
to allow the damper to transition to a new commanded state while allowing the air flow
value to stabilize. Sample collection for the airflow sensor value starts from end of 4th
minute and continues every minute for the duration of the step. This process is repeated
for all 6 steps.
▪ A minimum of 7 stable state samples are required for ACxelerate analytics to work. The
damper test time step value (set at the time of configuration) cannot be lower than 10 total
minutes (3 minutes transition time + 7 minutes stable state data).
VAV reheat valve test data

▪ VAV reheat valve test data is not collected for the first 6 minutes of each step. This time
allows the valve to transition to a new commanded state while allowing the VAV discharge
air temperature value to stabilize. Sample collection for the AHU supply temperature and
the VAV discharge air temperature sensor value starts after 7 minutes and continues every
minute for the duration of the test. This process is repeated for all 6 steps.
▪ A minimum of 7 stable state samples are required for ACxelerate analytics to work. The
reheat valve test time step value (set at the time of configuration) cannot be lower than 13
minutes (6 minutes transition time + 7 minutes stable state data).
▪ During the reheat valve test, it could take more than 6 minutes for the sensor value to
stabilize. Some transition data nearing the stabilized state may be recorded. If this occurs,
increase the time step to a higher value (a minimum of 7 stable state samples are
required).
Analyzing data
To view the analysis
1 Click Go Analytics in Run Test to view the current test results. You can also view previous test
results from Analyze Data on the Home page.
2 Click on each Damper Performance and/or Valve Performance tab to view results.
3 From upper overview, select any AHU Group to review from either the Group Select drop-down list
or from any pie chart. Each AHU pie chart is divided into 3 fault categories: Healthy, Minor, and
Major faults.
4 All VAVs from the selected AHU group are grouped by fault category. Each category displays a point
curve for all VAVs with that fault. Click any filled fault box to see further details. This screen will also
show any healthy faults.
5 This section will display the potential root cause of the VAVs. Click on the Equip select drop-down
list and select any VAV to see its corresponding IO curve. The damper test IO curve has the damper
position on the X axis and airflow on the Y axis. The reheat valve test IO curve has the reheat valve
position on the X axis and the temperature differential (VAV discharge temperature minus AHU
supply temperature) on the Y axis.
6 Add any comments you wish to retain into the comments box on the right. Comments will be
exported to the reports. Select either Html or Excel in the upper-right; then click Export results. Test
results are found in your system's Download folder or wherever you have designated your browser
to save the files.
7 AHU level warning message (if any) appear here.
NOTE Report downloads are disabled for dealer licenses.
294
TIP Raw data is available in the Excel® file on each AHU tab. This data is hidden to the right of
column ‘P’. To view the additional details, hover over the column headings, right-click, and select
Unhide.
Faults identified by ACxelerate

ACxelerate VAV test results are divided into 4 fault types with 3 severity levels:
Fault type Fault name Description

Healthy Healthy No fault identified; device and sensor
(Severity Level: 0) under test are working normally.
Indicates a healthy VAV. It Maximum Airflow Error Maximum recorded airflow value during
may also show system level (Damper performance only) the test is less than the cooling maximum
anomalies or unusual VAV airflow setpoint.
configurations. This could also indicate a possible
starving box, as the maximum VAV load
on AHU Fan is up to 60% at any point
during the test.
295
Minimum Airflow Error Minimum recorded airflow value during
(Damper performance only) the test is more than the occupied
minimum airflow setpoint.
This could also indicate a possible
leakage fault.
If minimum airflow is set to 0 cfm, the
minimum airflow alarm will always
appear.
For CAVs with minimum airflow and
maximum cooling airflow set to same
value, the minimum airflow error alarm
will never appear.
Minimum and Maximum Both maximum and minimum airflow
Airflow Error errors are detected.
(Damper performance only)
Minor Faults Starving For the damper, there may be a starving
(Severity Level: 1) actuator.
Indicates minor functional For the reheat valve, causes could include:
faults in the VAV. It may • starving valve
also show system level • oversize
anomalies or minor issues.
• valve and actuator together displaying
quick-opening behavior
• stuck actuator
Obstruction There may be obstacles in the duct/pipe
or higher airflow/water flow resistance.
Over-Stroking Damper/reheat valve is stroking at a
higher percentage than the actuator
percentage.
Under-Stroking Damper/reheat valve is stroking at a
lower percentage than the actuator
percentage.
Major Functional Faults Leakage Leakage of air/water when
(Severity Level: 2) damper/reheat valve is closed.
Indicates major functional Stuck Damper/reheat valve is stuck in a
faults in the VAV. Shows particular position.
critical issues in VAV An error in airflow sensor zero flow
functionality. calibration could cause a damper test
sensor issue to be flagged as Stuck
Alarm.
Sensor Issue For damper test, the VAV airflow sensor is
at fault.
For reheat valve test, the VAV discharge
air temperature and/or AHU supply air
temperature sensor are at fault.
Reverse-Stroking Damper/reheat valve operating in reverse
of the expected direction.
296
Expert Diagnosis Required If the input-output curve is abnormal but
does not fall under any of the mentioned
faults, manually check the VAV box for
issues.
This fault could be caused by higher
variation in airflow or static pressure from
the AHU fan during the damper or reheat
valve test.
It could also be caused by higher variation
in boiler supply temperature or boiler
pump speed during the reheat valve test.
Time step value may need to be increased
to allow residual heat to settle during step
position changes.
Actuation Range Insufficient Data samples collected by the tool do not
cover all of the expected steps defined at
design stage. Actuation range is
comprised of 6 steps: 0%, 20%, 40%,
60%, 80%, 100%. If data associated with
any of these steps is not available, it will
lead to this fault.
Major Data Faults Data Insufficient Data samples collected by the tool from
(Severity Level: 2) the WebCTRL® database are not
sufficient to run analytics. 42 or more are
Indicates major faults in
required to run the analytics.
collecting data from VAV
and/or AHU controllers. Data Unavailable Data sample collection failed due to
There may be a offline VAV, or VAV test failed.
communication issue or the
controller is offline.
NOTE If damper and reheat valve test are selected together and any fault is identified during a damper
test for a VAV, the reheat valve test results may not be valid. Repair the damper, then re-run the tests.
297
Testing other types of VAV boxes
ACxelerate can run tests for single-duct VAVs with damper and reheat valve control. Fan control or dual-
duct (two damper) control is not available. See the guidelines below for testing other types of VAVs.
Fan power box

• Series Fan VAVs: Manually override the series fan running in the correct direction before running
the ACxelerate damper and reheat valve test. For a reheat valve test, go to Run Test > Time >
Damper Lock at and set the damper lock value to 60%.
NOTE For Series fan VAV, during the reheat Valve test it is important that the air flowing through VAV
damper (when the damper is 60% open) is greater than or equal to the air pulled by VAV Fan. To
achieve this, run the AHU at highest allowed statis pressure setpoint. If this does not help, then try
reducing the VAVs for the test and ensure all unselected VAV dampers are closed.
• Parallel Fan VAVs with reheat coil installed in series: Manually override the parallel fan to Off
before running the ACxelerate damper and reheat valve test.
• Parallel Fan VAVs with reheat coil installed in parallel duct before fan: Manually override the
parallel fan to Off before running the ACxelerate damper test (you cannot execute a reheat valve
test for this VAV).
NOTE The additional built-in tags and tag rules for series and parallel fans in Semantics for ACxelerate
are for future use, and can be ignored at this time.
298
Dual duct VAVs
Only one damper and airflow sensor can be tested at a time in a VAV. To test both decks in dual-duct
VAVs:
1 Create separate custom semantic tag rules for each airflow microblock and airflow value for each
deck (cold and hot) using tags as shown in the table below. Keep them disabled.
Point Description Reference name Built-in Tags (ID)

Cold Deck Airflow Control at actual ACx Flow Control (acx_airflow)
Microblock
Hot Deck Airflow Control at actual ACx Flow Control (acx_airflow)
Microblock
Cold Deck Airflow Value at actual ACx Flow Control / Flow Input
(acx_airflow_value)
Hot Deck Airflow Value at actual ACx Flow Control / Flow Input
(acx_airflow_value)
2 To test a cold deck:

a) Enable Cold Deck Airflow Control Microblock and Cold Deck Airflow Value Custom Semantic Tag
rules.
b) Force hot deck damper to close.
c) Discover ACxelerate equipment and run the test.
d) Once the testing is complete, disable the custom tag rules from step a.
3 To test a hot deck:
a) Enable Hot Deck Airflow Control MicroBlock and Hot Deck Airflow Value Custom Semantic Tag
rules.
b) Force cold deck damper to close.
d) Once testing is complete, disable the custom tag rules from step a.
NOTE You can also follow this strategy to test VAV controllers with extension VAV controllers.
299
VAVs with 2 reheat coils
The process below is only for valves with 2 reheat coils installed in series with a VAV damper, with both
reheat coils supplying air to the same VAV discharge air temperature sensor. This can also be used for
parallel smart valves used for reheat coils.
1 Create separate custom semantic tag rules for each reheat coil valve AO microblock as shown in
the table below. Keep them disabled.
Point Description Reference name Built-in Tags (ID)
Reheat Valve1 AO at actual ACx HW Valve (acx_hw_valve)

Microblock
Reheat Valve2 AO at actual ACx HW Valve (acx_hw_valve)
Microblock
2 To test reheat valve 1:

a) Enable Reheat Valve1 AO Microblock Custom Semantic tag rules.
b) Force Reheat Valve2 AO Microblock to close.
d) Once the testing is done, disable the custom tag rules from step a.
3 To test reheat valve 2:
a) Enable Reheat Valve2 AO Microblock Custom Semantic tag rules.
b) Force Reheat Valve1 AO Microblock to close.
d) Once testing is complete, disable the custom tag rules from step a.
NOTES
• ACxelerate can test only one reheat valve at a time.
• Base board valves cannot be tested.
VAVs with SCR Control Electric Reheat

The ACxelerate reheat valve test is designed for water coils control with value and actuator. However,
this tool can also be used to test whether the SCR system is functioning or failed. If you do so, note the
following:
1 This test requires VAV discharge air temperature.
2 In the Run Test section, at the Time popup screen on the reheat valve side, set the damper Lock at
to 60%.
3 Ignore all minor faults. Proceed as if SCR Reheat is functioning properly.
4 Consider stuck faults as SCR Control Reheat failures.
300
Using Custom Source Tree in place of Cool Source
You can use a Custom Source Tree for ACxelerate built-in to WebCTRL® v8.5, provided that the Parent
Microblock used in AHU is Tot/Min/Max/Avg (marked blue in image) and the Child Microblock has the
reference name cool_request (marked red in image).
To use the source tree option to find the relationship between AHU and VAV in ACxelerate:
1 In System Configuration > Semantic > Built-in Rules, search for ‘acx cool requests’ and
uncheck the Enabled checkbox.
2 Go to System Configuration > Semantic > Custom Rules. Create a Reference Name Match
custom rule for the Tot/Min/Max/Avg point reference name. This point is in the AHU used as the
Parent Microblock Reference Name for creating a Custom Source Tree (marked green in image).
Assign the tag acx cool requests.
3 If the Custom Source Tree is ready (VAVs are assigned to AHUs), go to ACxelerate and click Detect
Device. Select data source from = Cooling Request (default option) and click OK. It will find and
create an AHU and VAV relation table and you can proceed with the test.
Commissioning equipment using Field Assistant

PREREQUISITES Your controllers have v4.x or later drivers.
To start up and commission a piece of equipment or a network of controllers, you can run Field
Assistant on:
• A laptop connected to a controller's or sensor's Local Access port. See Communicating locally with
ExecB controllers (page 242).
• A laptop connected to a controller's or sensor's Rnet port. See Communicating locally with the
OptiFlex™ controllers (page 248).
• A laptop or computer connected to an IP network if your controllers are communicating on the
network.
See Field Assistant Help for information on using Field Assistant.
301
Providing source files to Field Assistant
Field Assistant requires a controller's source files. Source files include:
• Control programs (.equipment)
• Drivers (.driver)
• Graphics (.view)
• Touchscreen files (.touch)
• BACview® files (.bacview)
To provide Field Assistant with source files, do one of the following:

• Download source files from the WebCTRL® application (page 302) to the controller so that they
can be uploaded in Field Assistant. The controller must have a 4.x driver and enough memory for
the files.
NOTE An equipment's .view file will be downloaded only if its Included in download option is
selected in the WebCTRL® or SiteBuilder application.
• Export the source files from the WebCTRL® application (page 303) to a zip file so that they can be
imported in Field Assistant. This option exports all source files for all controllers in the system.
NOTE If you download source files to a controller, you may still want to export files from the WebCTRL®
application. Importing the files in Field Assistant will reduce the time required to upload the controllers.
If the technician using Field Assistant changes or adds source files, he can get the new source files
back to the WebCTRL® application by doing one of the following:
• Download the source files to the controller in Field Assistant so that you can upload the files in the
WebCTRL® application (page 303).
• Export the source files from Field Assistant to a zip file so that you can import the files in the
WebCTRL® application (page 303).
This option exports the source files for all controllers in the system to the zip file.
See Field Assistant Help for instructions on uploading, downloading, importing, or exporting source files
in Field Assistant.
To download source files from the WebCTRL® application

1 On the WebCTRL® Network tree, select the controller.
2 On the Properties page, select the Download Source Files option.
3 Click Accept.
4 On the Network tree, select the controller's network.
5 On the Devices page, select the controller that you want to download.
NOTE Shift+click or Ctrl+click to select multiple controllers to download.
6 Select All Content in the Download drop-down list, then click the Download button.
NOTE If you check Download Source Files on the Properties page but the controller does not have
enough memory for the files, the download will fail. Uncheck the option and export the source files.
302
To export source files from the WebCTRL® application
2 On the General tab under Source files, click Export.
To upload source files in the WebCTRL® application

1 On the WebCTRL® Network tree, select the controller's network.
2 On the Devices page, select the controller whose files you want to upload.
NOTE Shift+click or Ctrl+click to select multiple controllers to upload.
3 Select All Content in the Upload drop-down list, then click the Upload button.
NOTE If an equipment has multiple views attached, the views will be uploaded with a display name of
Default. To change the names, right-click the equipment in the tree, select Configure, then select the
view in the Views > Attached list. The Display Name field appears for you to edit.
To import source files in the WebCTRL® application

2 On the General tab under Source files, click Import.
3 Browse to the *sourcefiles.zip file.
4 Click Continue.
5 Click Close.
NOTE If the 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.
303
Performing ZN line test and balance in the WebCTRL® interface
You can use the WebCTRL® interface to calibrate a ZN line controller’s flow sensor during test and
balance. Each VAV terminal unit (VAV box) must be controlled by a control program that uses an Airflow
Control microblock. Control programs for dual duct boxes require 2 Airflow Control microblocks.
Follow the process below to perform test and balance on one or more VAV boxes.
Step 1: Define airflow source rules

NOTE This step is typically done by the controls engineer that designed the system.
If you used SiteBuilder’s default source rules when you created the heat and cool source trees and you
named the BACnet Analog Input microblock and the Airflow Control microblock to agree with the source
rules, go to Step 2: Set initial values (page 305).
If you used a different naming convention, you must add new source rules to SiteBuilder’s source trees
to define the relationship between equipment. The relationship allows the WebCTRL® test and balance
tool to find the air sources.
NOTE Do not delete the default source rules. Any standard Automated Logic® control programs would
no longer function correctly if these were deleted.
To add new source rules:

1 In SiteBuilder, select a source tab in the right pane.
2 Double-click the system to open the System dialog box.
3 Select the Source Rules tab.
4 Click Add.
5 In the Parent Microblock Reference Name field, type the reference name of the static pressure
BACnet Analog Input microblock in the parent air source.
6 In the Child Microblock Reference Name field, type the reference name of the Airflow Control
microblocks.
7 In the Data Target Microblock type column, select T&B Airflow.
8 Click OK.
9 Repeat steps 4–7 to add more source tree rules. You must add a rule for each parent/child
reference name combination found in the tree.
10 Click OK.
NOTE If you change the BACnet device instance number of any parent in a source tree, right-click the
source tree in SiteBuilder and select Reapply Source Tree Rules.
304
Step 2: Set initial values
NOTE This step is typically done by the controls engineer that designed the system and then verified by
the Test and Balance technician.
The test and balance procedure calibrates the airflow sensor by comparing raw sensor readings to
measured air flows at different flow rates (damper positions).
Follow the steps below to set up initial values for each airflow microblock.
1 On the WebCTRL® Geographic tree, right-click the area or equipment that you want to set up,
then select Airflow Config.
NOTE To set up your entire system, right-click the system level, then select Airflow Config.
2 Change the desired design properties.
Step 3: Calibrate the zero flow point (Auto Zero)

NOTE This step is done by the Test and Balance technician.
Use the following steps to calibrate the zero flow point.

1 To prevent damage to equipment, ensure that the parent air source is turned off.
2 On the WebCTRL® Geographic tree, select the flow control point under the piece of equipment
that you want to test and balance.
3 Click the Properties page Details tab.
4 Click Global Damper Commands under Test and Balance.
5 Select the airflow dampers (microblocks) you want to set. Use Ctrl+click, Shift+click, or both to
select multiple items.
6 Click Zero Flow.
7 Wait for the Message column to show that Auto Zero is complete.
After Auto Zero is complete, use other global commands to set the VAV boxes to another mode to
prepare the system for flow calibration. There are many different ways to do this, and it is up to the test
and balance technician to decide how to operate the system while calibrations are performed. The goal
is to have a system at a steady static pressure that is near the design operating conditions. The air
source should not be restarted until the VAV boxes have been commanded to a state where some
dampers are open. Some suggested modes are:
• Set all VAV boxes to control to the occupied minimum setpoint.
• Set a subset of VAV boxes to damper full open and the remaining VAV boxes to damper closed.
• Set all VAV boxes to automatic control.
After all selected dampers have been set to Auto Zero, close the Global Damper Commands dialog box.
305
Step 4: Calibrate each VAV box
NOTE This step is done by the Test and Balance technician.
After the air source and associated VAV boxes are controlling to the state determined above, calibrate
each VAV box. You must calibrate each VAV box at Zero Flow and Cool Max Airflow or Heat Max Airflow.
For improved accuracy, calibrate additional points such as Dampers Full Open and Occupied Min
Airflow. When calibrating additional points, follow the numeric order shown under Damper command.
NOTE Some systems cannot maintain design static pressure until test and balance is performed. To
raise the air source's static pressure, close some VAV dampers or have them control to the occupied
minimum setpoint.
1 On the WebCTRL® Geographic tree, select the flow control point under the piece of equipment
that you want to test and balance.
2 Click the Properties page Details tab.
3 Under Test and Balance, click the damper position you want to calibrate.
4 Wait for the damper to quit moving as indicated by the status message on the Properties page.
5 Measure the airflow from the VAV box that you are calibrating.
6 Under the Test and Balance section, type the measurement into the Measured Flow field next to
the damper command.
7 Click the arrow to copy the current reading, or type the raw sensor reading.
8 Click Accept.
9 To calibrate additional points, repeat steps 1 through 6 for each calibration point.
10 When the desired calibration points are complete, return the VAV box to the mode it was in
previously until you finish calibrating all VAV boxes.
11 After you calibrate all the VAV boxes, return all the VAV boxes to Automatic Control using the Global
Damper Commands button.
NOTE If you leave a VAV box in any test and balance mode other than Automatic Control for more than
12 hours without any additional calibration activity, the VAV box resumes automatic control.
Working with control programs in the WebCTRL® interface

A control program is typically defined in SiteBuilder when the system is engineered, but you can do the
following in the WebCTRL® interface. These changes require you to download (page 37) the controller.
• Add a control program to a controller

• Replace an existing control program
• Retrieve a control program from the WebCTRL®, edit it in EIKON®, and then return the edited
program to the server (page 309)
• Reload a revised control program located in <system_name>\programs.
On the WebCTRL® Geographic tree, right-click the equipment, then select Reload Control
Program. Reloading updates all instances of a control program throughout the system and marks
the controller(s) for download. WebCTRL® determines the appropriate download option (page 38)
based on what changed in the control program.
NOTE If you change a control program in the EIKON® application and it does not display correctly in
the WebCTRL® interface, Ctrl+right-click the WebCTRL® action pane, and then select Refresh.
306
To add a control program to a controller
1 Select the controller on the WebCTRL® Network tree.
2 On the Devices page > Manage tab, click the Add Control Program button.
3 Type a Display Name for the control program.
4 Select the Controller that you are adding the program to.
5 Optional: You can change the control program's Reference Name if needed.
6 Optional: You can select a different Icon.
If the control program is...

In the Control Program drop-down list Select the control program.
Not in the Control Program drop- a. Click Add New.
down list b. Browse to select the control program.
c. Click Open.
d. Click Continue.
e. Click Close.
8 Optional: Check Require operator to record any changes to control program and when
acknowleding alarms. See Recording reasons for edits (21 CFR Part 11) (page 195).
9 Click Accept.
10 Download All Content (page 37) to the controller.
NOTES
• 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.
• In the Add Control Program dialog box, you can also attach or remove a .view file that will be
displayed in the WebCTRL® interface for the control program.
• If you need to change a control program's Object Instance number, right-click the control program
in the navigation tree, and then select Configure. Click next to the field for additional
information.
307
To replace an existing control program
1 Right-click the control program on the WebCTRL® navigation tree, then select Configure.
2 The following steps are optional:
a) Change the Display Name for the control program.
b) Change the control program's Reference Name if needed.
c) Select a different Icon.
3 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.
If the control program is...
In the Control Program drop-down list Select the control program.
Not in the Control Program drop- a. Click Add New.

down list b. Browse to select the control program.
c. Click Open.
d. Click Continue.
e. Click Close.
5 Optional: Check Require operator to record any changes to control program and when
acknowledging alarms. See Recording reasons for edits (21 CFR Part 11) (page 195).
6 Click Accept.
NOTES
• 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.
• In the Add Control Program dialog box, you can also attach or remove a .view file that will be
displayed in the WebCTRL® interface for the control program.
308
To edit a control program
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 Right-click the equipment on the WebCTRL® Geographic or Network tree, then select
Configure.
2 In the Control Programs section, click Edit Existing.
3 Click Save as.
5 Click Save.
6 Click Close.
To put the edited control program back on the server

1 Right-click the equipment on the WebCTRL® Geographic or Network tree, then select
Configure.
2 In the Control Programs section, click Add New.
3 Browse to select the control program.
4 Click Open.
5 Click Continue.
6 Click Close.
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 in the WebCTRL® interface.
• Change the driver settings. See "Setting up the driver" in the controller's Technical Instructions.
• 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® Network tree, right-click the controller or driver, then select
Reload Driver. Reloading updates all instances of the driver throughout the system and marks the
controller(s) for an All Content download. 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 37) to the affected controller(s).
NOTE You can also make these changes in SiteBuilder. See "To change or upgrade a driver" in
SiteBuilder Help.
309
To change or upgrade a driver
1 On the WebCTRL® Network tree, choose a network and go to the Devices > Drivers tab.
2 Select the controllers you want to update and click .

If the driver is...

In the Driver Version drop-down list a. Select the driver.
b. Click Accept.
Not in the Driver Version drop-down list a. Click Add.
b. Browse to select the driver.
c. Click Open.
d. Click Continue.
e. Click Close.
4 Download All Content to the controller. See Downloading to controllers (page 37).
NOTE You can click Delete Unused in the Controller section to delete all unused drivers in
<system_name>\drivers.
To stage a driver for later installation

To avoid interrupting controller function when installing a driver, you can first stage the driver to the
controller before installing it. The controller retains full functionality while the new driver is staged and
continues to use the existing driver until you install the new driver.
1 Follow steps 1–3 above. When selecting the driver, check Stage driver in controller.
2 On the Devices > Drivers tab, click Start Staging.
3 Once you are ready to install the staged driver to the controller, click Start Installation.
310
Working with touchscreen or BACview® files in the WebCTRL® interface
To use a touchscreen device or BACview® device to view or edit a controller's property values, you must
download a screen file (.touch, .bacview, .S37, or.kpd) to the controller. The screen 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 screen file

1 On the WebCTRL® Network tree, right-click the controller, then select Configure.
2 If other controllers in the system use the current screen file, select which controllers you want to
change.
If the screen file is...

In the Screen file drop-down list a. Select the file.
b. Click Accept.
Not in the Screen file drop-down list a. Click Add.
b. Browse to select the screen file.
c. Click Open.
d. Click Continue.
e. Click Close.
NOTE You can click Delete Unused in the Screen File section to delete all unused screen files in:
• <system_name>\views
• <system_name>\programs
311
To edit a screen file on a WebCTRL® client
On a WebCTRL® client, you can get a copy of a screen file from the server, edit it, then put it back on
the server.
To get the screen file

1 On the WebCTRL® Network tree, right-click the controller that uses the screen file, then select
Configure.
2 Under Screen File, click Edit.
3 Click Save as.
5 Click Save.
6 Click Close.
To put the edited file back on the server

1 On the WebCTRL® Network tree, right-click the controller that uses the screen file, then select
Configure.
2 Under Screen File, click Add.
3 Browse to select the file.
4 Click Open.
5 Click Continue.
6 Click Close.
BACnet device tools and services

The tools and services described below let you control or troubleshoot BACnet devices. To access the
tools and services, click on the BACnet device on the WebCTRL® Network tree, then click
Properties.
Tool Description
Module Status Generates a Modstat report. See Using a Modstat to troubleshoot your system
(page 236).
Show Bindings Displays all Device IDs that the BACnet device communicates with and the
network address of each device. See Troubleshooting BACnet bindings (page
235).
312
BACnet device services
Although the following BACnet device services can be used for Automated Logic® controllers, you
should not need to use them for this purpose. Their primary target is a third-party device that supports
these services.
Service Description
Time Sync Sends the site's local time to the BACnet device.
UTC Time Sync Sends the Coordinated Universal Time (UTC) to the BACnet device. The device
must be able to convert the time to its local time zone.
NOTE Some devices support only one of the above time sync services.
Backup, Restore, Executes a BACnet Backup or BACnet Restore service as defined by the
and Abort BACnet standards. A message appears when the backup or restore is
complete.
Click Abort to stop a Backup or Restore.
NOTE These services are vendor-specific and should be used with caution. A
failed restore could make a device inoperable. Before using these on a device
running in a live system, test them on the device during installation.
BACnet Password Applies to Backup, Restore, Warmstart, and Coldstart. Enter your BACnet
password if required by the BACnet device. This password is typically defined
in a third-party tool.
Warmstart or Restarts the BACnet device.
Coldstart For a third-party device, see the manufacturer's documentation to determine
the difference between these 2 services.
For Automated Logic® controllers, these services are the same. These
services will cycle the controller's outputs.
DCC Use to stop or start the BACnet device's communication. Select one of the
following options in the droplist, then click DCC.
Enable Starts the device's communication.
Disable Stops the device's communication for the amount of time that
you enter in the Timeout field. See NOTE below.
Disable Stops the device from initiating communication for the
Initiation amount of time that you enter in the Timeout field. See NOTE
below. The device will continue to respond to communications
from other devices.
NOTE Type -1 in the Timeout field to disable communication indefinitely.
Normal communication will resume only when the device receives an Enable
command.
Event Info Displays detailed information about the objects that are currently in alarm.
Event Summary Displays summary information about the objects that are currently in alarm.
313
Setting up WebCTRL® client devices and web browsers
The WebCTRL® system can be viewed on the following client devices and web browsers.
Computers
The client computer should have at least:
• Quad core processor
• 4 GB RAM
• Communications link of 100 Mbps or higher
The WebCTRL® application will work with slower computers and slower links, but the results may not
be satisfactory.
A computer with this Supports these web browsers...

operating system...
Windows® GoogleTM ChromeTM v84.0 or later 1
Microsoft® Edge v84 or later
Mozilla® Firefox® v79.0 or later
Mac® OS X® Safari® v11 or later 2
(Apple® Mac only) Google Chrome v84.0 or later
Mozilla Firefox v79.0 or later
Linux® Google Chrome v84.0 or later
Mozilla Firefox v79.0 or later
1 Best performance
2 Best performance unless browser is running on a Mac® Mini or a MacBook:
WARNING If machine is running Mountain Lion 10.8x with an integrated Intel HD 400
graphics card, it will experience display issues. Use one of these workarounds for better
performance:
• If an additional NVIDIA graphics card is available, manually switch the graphic card setting in
MAC® OS X® to use that card.
• If not, use GoogleTM ChromeTM v84.0 or later.
Mobile devices
Device type Platform support

Smart phone AndroidTM, iOS
Tablet AndroidTM, iOS, SurfaceTM
NOTE Some functionality may be limited by the capability of the mobile device and operating system.
314
Setting up and using a computer with the WebCTRL® system
• Set the monitor's screen resolution to a minimum of 1920 x 1080 with 32-bit color quality
• You may want to disable the computer's navigation sounds.
Mac only
NOTE The instructions below are for a Mac OS X 10.8. Other versions may vary slightly. See your
computer's Help if necessary.
Computer settings To change setting...

Enable right-clicking to see
right-click menus:
On a Mac 1 Select System Preferences > Mouse.
2 Click the drop-down list that points to the mouse's right-click
button, then select Secondary Button.
On a MacBook 1 Select System Preferences > Trackpad.
2 Enable Secondary click.
The instructions in Help are for a Windows computer. For instructions that include the Ctrl key, replace
Ctrl with Command. For example, replace Ctrl+click with Command+click.
Setting up and using a web browser to view the WebCTRL® interface

To set up and use Microsoft Edge
The instructions below are for Microsoft® Edge.
Web browser settings To set in Microsoft Edge...
Do not block cookies 1 Click . . . to display the Actions droplist.

2 Select Settings > Site Permissions > Cookies.
Disable web browser's pop-up 1 Click . . . to display the Actions droplist.
blockers * 2 Then select Settings > Site Permissions > Pop-ups and
redirects.
To... Do the following...
Maximize the web browser Use the minimize/maximize button in the top right corner of the
window * browser window.
Have 2 different users logged in 1 Click . . . to display the Actions droplist.

to the WebCTRL® system on the 2 Select New Window.
same computer *
315
Clear browser cache 1 Click . . . to display the Actions droplist.

2 Select Settings > Privacy, Search, and Services > Clear
browsing data.
3 Click Choose what to clear.
4 Click Clear now.
* Does not apply to Microsoft Edge on a phone.
To set up and use Mozilla Firefox

NOTES
• The instructions below are for Mozilla® Firefox® v60.0 on a Windows operating system. Other
versions may vary slightly. See your web browser's Help if necessary.
• If the menu bar is not visible, right-click on the window's title bar, and then select Menu bar.
• If a message appears in the WebCTRL® interface that includes the checkbox Prevent this page
from creating additional dialogs, DO NOT check this box.
Web browser settings To set in Firefox...
Disable Pop-up blocker 1 Click Tools > Options > Privacy & Security.
2 Under Permissions, click Exceptions next to Block pop-up
windows.
3 Type http:// (or https://) and then the server name
or IP address of your system.
4 Click Allow and then Save Changes.
Enable JavaScript 1 In the address bar, type about:config, and then press
Enter.
2 Click I accept the risk.
3 In the Search bar, type javascript.enabled.
4 If the value field shows true, JavaScript is enabled. If it shows
false, right-click javascript:enabled, and then select Toggle.
Add-ons Manager Select Tools > Add-ons > Extensions. On this page, you can
enable/disable installed add-ons such as:
• Adobe® Acrobat® Reader (to view PDF's)
• QuickTime Plug-in (to play audible alarms)
Only installed Firefox add-ons will show up in the list.
316
Maximize the web browser Press F11 to turn full-screen mode on\off.
window
Clear browser cache 1 Click Tools > Options > Privacy & Security.
2 Under Cookies and Site Data, click Clear Data.
3 Click Clear.
Have 2 different users logged in Start a new web browser session. Select File > New Private
to the WebCTRL® system on the Window.
same computer
To set up and use Google Chrome

NOTES
• The instructions below are for GoogleTM ChromeTM v66.0. Other versions may vary slightly. See your
web browser's Help if necessary.
• If a message appears in the WebCTRL® interface that includes the checkbox Prevent this page
from creating additional dialogs, DO NOT check this box.
On a computer
Web browser settings To set in Chrome...
Enable pop-ups 1 Click on the browser toolbar.
2 Select Settings.
3 Click Advanced at the bottom of the page.
4 Under Privacy and security, click Content settings.
5 Under Pop-ups > Allow, click ADD, and then type http:// (or
https://) and then the server name or IP address of your
system.

Clear browser cache 1 Click on the browser toolbar.
2 Select More tools > Clear browsing data.
3 Select a time range in the drop-down list.
4 Check the types of information that you want to remove.
5 Click CLEAR DATA.
Maximize the web browser Press F11 on your keyboard to turn full-screen mode on/off.
window
Have 2 different users logged in Start a new web browser session. Click , then select New
to the WebCTRL® system on the incognito window.
same computer
317
On Chrome for Android
NOTE The following settings are based on Android v11 - options may vary with versions.
Web browser settings In the Chrome menu...

Turn off desktop mode Uncheck Request desktop site
Disable pop-up blocker Settings > Advanced > Site Settings > uncheck Block
pop-ups
Enable JavaScript Settings > Advanced > Site Settings > check Enable JavaScript
Enable Cookies Settings > Advanced > Site Settings > check Accept Cookies
To... In the Chrome menu...

Clear browser cache Settings > Basics > Privacy > CLEAR BROWSING DATA
To set up and use Safari

NOTES
• The instructions below are for Safari® v11. Other versions may vary slightly. See your web
browser's Help if necessary.
• We recommend that you do not run Safari in full-screen mode. If you do, WebCTRL® pop-ups will
open full-screen, covering the main application window.
On an Apple® computer (Mac®)

Web browser settings To set in Safari...
Disable pop-up blocker Preferences > Security > uncheck Block pop-up windows
Enable JavaScript Preferences > Security > check Enable JavaScript
Enable Plug-ins Preferences > Security > check Enable plug-ins
Prevent pop-ups from opening in Preferences > Tabs > uncheck Command-click opens a link in a
a new browser tab new tab
Prevent Safari from automatically Preferences > General > uncheck Open "safe" files after
opening zip files exported from downloading
the WebCTRL® application

Clear browser cache History > Clear History
Have 2 different users logged in Start a new web browser session. Select Safari > Private
to the WebCTRL® system on the Browsing > File > New window
same computer
318
On an Apple® iPad
Web browser settings To set on the iPad...
Disable pop-up blocker Settings> Safari > set Block pop-ups to Off
Enable JavaScript Settings > Safari > set JavaScript to On
TIP Re-enable popup blocking on your device when not using our software.

Clear browser cache Settings > Safari > Clear History
TIP Re-enable popup blocking on your device when not using our software.
On an Apple® iOS 12.2

Web browser settings To set on the iPhone...
Enable JavaScript Settings > Safari > Advanced
Setting up a system in the WebCTRL® interface

System Settings
The System Settings page contains information that you must enter before the WebCTRL® application
can run properly.
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
• Path to the Webroot Directory
• Database Type
• 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).
319
You can edit or use the following fields and buttons.
Field Notes
System Information
System Statistics button Click to see the following system information:
• Number of controllers
• Number of controllers that can run control programs
• Number of points, regardless of vendor
• Number of trend sources in database
• Number of trend samples in database
Levels displayed in paths 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.
Logs
Select a week of logs to review For troubleshooting, you can download a zip file that contains logs
of system activity.
Time
Time Sync Click to immediately synchronize the time on all IP network
controllers in the system database to the WebCTRL® server's
time.
Time synchronization occurs daily if the Enable time
synchronization of controllers daily at____ field on the Scheduled
Tasks tab (page 325) is enabled. (Click this link for more
information on time synchronization.)
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.
Update Devices Click to apply Time Format and Date Format to all IP network
controllers in the system database. This function only applies to
controllers with Gen 5 firmware or later.
Alarms
Use a single alarm template for If your system is an upgraded legacy system:
CMnet alarms • Check to have alarms for CMnet equipment use only the
alert_auto alarm template.
• Uncheck to allow multiple alarm templates.
Enable support for Alarm Check to use the Alarm Notification Client application. See Alarm
Notification Clients to connect to Popup (page 79) alarm action.
this server NOTE When using location-dependent security, users only receive
alarms for locations they are allowed to access.
320
Field Notes
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.
Reports
Display Date and Time in Choose whether to display the date and time together in a single
column or to have separate columns for each.
Display preceding zeros in Date Yes—displays preceding zeros. Ex. 01/01/2023 02:05:09 PM
and Time No—omits preceding zeros. Ex. 1/1/2023 2:05:09 PM
Display missing Trend data as You can specify text of up to 20 characters to appear in the report
when there is no tend data. The default is a dash "-".
Report logo 1 Click Choose File, and select your logo file. The logo must be a
JPEG or PNG of less than 2 MB in size.
2 Click Upload. A preview of the logo appears to the right. You
can review the preview to ensure the correct file was
uploaded.
TIPS
• For best results, use a transparent or white background on
your logo.
• The logo is resized to fit within a 100 x 100 pixel area. We
recommend that you upload a logo of this size or larger.
Schedules
Disable Schedules If your system has no need to run schedules, check this box so
that the Schedules feature is no longer visible in WebCTRL®
interface.
Trends
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. Specify the time of day that the
trends are deleted on the Scheduled Tasks tab.
Display gap in graph line for Check to show a gap if trend data is missing.
missing data
Enable Server Trending of Color Leave this checked unless directed otherwise by Technical
Support.
Poll Interval The frequency that the server polls routers for color trend data.
Increase this field only if Last Poll Duration exceeds the Poll
Interval.
321
Field Notes
Source Files
All Source Files Use to export source files to a .zip file that can be imported into
another WebCTRL® or Field Assistant system. Source files
include:
• Control programs (.equipment files only)
• Drivers
• Graphics (.view files only)
• Touchscreen files
• BACview® files
• Report design files for Equipment Values or Trend Sample
reports
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 (page 301).
Email Server Configuration The information in this section is used by the Send email alarm
action and used to email a Scheduled Report (page 162).
Mail Host The mailserver's address. This can be an IP address or a system
name, such as mail.mycompany.com.
Mail Host Security Options Select the type of security the mailserver uses.
• Cleartext (SMTP) – Uses the SMTP protocol to send as clear
text over TCP/IP
• Secure SSL (SMTP with SSL) – Uses SSL, a communication
protocol that provides data encryption
• Secure TLS (STARTTLS) – Uses TLS, but does not begin
encryption until the WebCTRL® application issues STARTTLS
command
Specify Mail User for Mail Host Select if your mailserver requires a username and password.
Authentication
Test connection Click to have the WebCTRL® application try to connect to the
email server. A message will appear below this button stating if
the connection was successful or if it failed.
322
Security tab
Field Notes
Logging
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 the system folder. 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.
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, MSDE, and Derby, the database is automatically
created. An Access database is named audit.mdb; a MSDE database
is named audit.mdf. The Derby database consists of multiple files in
a folder called audit. For MySQL, SQL Server, PostgreSQL, or Oracle,
you must create the database manually.
Delete database entries Automatically deletes entries in the database that are older than the
older than ____ days number of days you specify.
Log errors for invalid URLs Check 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
Change Policy See Location-dependent operator access (page 191) for information
on Change Policy.
Remote Access
Allow remote file Lets you access the system using WebDAV.
management
Operators
Return operators to previous Returns operators to current tree locations when the server
locations when server reconnects.
reconnects
Log off operators after _:_ The system automatically logs off an operator who has had no activity
(HH:MM) of inactivity 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.
323
Field Notes
Lock out operators for __ Clear Lockouts removes lockouts for all users.
minutes after __ failed login NOTE Restarting the WebCTRL Server application will remove
attempts lockouts.
Use advanced password You can place specific requirements on passwords to increase
policy security. See Advanced password policy.
Do not synchronize operator If using hierarchical servers, the WebCTRL® application automatically
and privileges synchronizes the operator/privilege settings on the child servers with
those on the parent server. You have the following options:
• Check this field on all servers to stop the synchronization
process.
• Check this field on a child server to remove it from the
synchronization process so that you can manage that server's
settings locally.
Synchronize Now Click this button on the parent server for immediate synchronization
of operator/privilege settings.
Permissions
Permissions When control programs, views, and touchscreen 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.
Field Notes
WebCTRL Server BACnet The BACnet identifier for the system's server and the alarm recipient.
Controller Instance You enter these system properties in SiteBuilder.
and
BACnet Alarm Recipient
Instance
324
Always upload properties Automatic uploads are listed in the Audit Log.
from controllers to WebCTRL If you do not check this field, properties must be manually uploaded
database on mismatch 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 The WebCTRL® application will ignore alarms from third-party
sources not in this database devices not in the database or devices from other WebCTRL®
systems on the same network.
BACnet Settings Native WebCTRL® system only
Log BACnet Binding Conflicts The WebCTRL® application uses BACnet (dynamic) binding for
communication between devices unless your system uses NAT
routing. If using NAT, the WebCTRL® application uses information in
its database to bind to BACnet devices.
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 An incident group is all alarms related to a particular incident, such as
incident groups which have Off Normal, Fault, and Return to Normal.
been closed for more than NOTE Alarms in an incident group are not deleted until all alarms in
___ days the group have been closed.
Archive alarm information Writes alarm information to a text file.
upon alarm deletion
Automatically delete expired To ensure there are no time zone conflicts, the WebCTRL®
schedules daily at ___ application waits 2 days after a schedule expires to delete it.
Remove expired historical Deletes trend data that has been in the database longer than the
trends daily at ____ time specified in the Keep historical trends for ___ days field on the
General tab.
325
Field Notes
Enable time synchronization Automatically synchronizes the time on all equipment to the time on
of controllers daily at____ the server, adjusting for different time zones and Daylight Saving
Time. We recommend that you check this field.
The WebCTRL® application will send a daily time sync message to
each IP network device that is in the system database. IP devices not
in the database will not be synchronized. For all ARC156 or MS/TP
networks in the database, the WebCTRL® application will send a
broadcast time sync message. All devices on these networks will be
synchronized, regardless of whether or not the devices are in the
database.
CAUTIONS
• Make sure that your server’s time and time zone setting are
correct.
• Make sure that each site’s time zone setting in SiteBuilder is
correct.
• 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.
NOTES
• You can disable this function for an individual site on the site’s
Properties page. See To set up site properties (page 329).
• You can perform system-wide time synchronizations using the
Time Sync button on the General tab (page 319). Or, you can
synchronize individual devices using the Time Sync button on the
devices' Properties page (page 312).
• Between time sync broadcasts, Automated Logic® routers
include time sync information in each color request to the devices
below the router. This ensures devices without a battery-backed
clock will get the time shortly after powering up.
Check for expiring Triggers an alarm when a BACnet/SC Hub certificate will expire within
BACnet/SC certificates daily the Warning or Critical thresholds. While in the Warning threshold,
at ____ the alarm repeats once per week. In the Critical threshold, the alarm
repeats daily and every operator will get a pop-up message when they
log in.
326
Daylight Saving tab
On this tab, you can adjust the Daylight Saving Time settings for WebCTRL Server.
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-< version >.zip) and unzip the file. The
zip file contains 2 items:
○ tzdata.tar.gz
○ tzupdater.jar
3 In the WebCTRL® interface, go to System Settings > Daylight Saving, then click Import.
4 Browse to the tzupdater.jar file, select it, then click Open.
5 Click Continue. This restarts the WebCTRL Server application.
6 After the restart, in the WebCTRL® interface, go to System Settings > Daylight Saving, and then
click Import.
7 Browse to the tzdata.tar.gz file, select it, and then click Open.
8 Click Continue. This restarts the WebCTRL Server application.
9 On the System Settings > Daylight Saving tab, click Update.
NOTE If you have sites in different time zones that use Daylight Saving Time, you can click View DST
Dates on the site's Properties page to see DST information and time change dates.
Add-ons tab
A WebCTRL® system supports add-ons, such as EnergyReports, that retrieve and use the WebCTRL®
data.
By default, the WebCTRL® application allows only signed add-ons that are supported by Automated
Logic®. If needed, you can override this setting in SiteBuilder by going to Configure > Preferences >
Web Server, and checking Allow unsigned add-ons.
327
To install an add-on
1 Save the add-on's file (.addon or .war) to your computer.
2 On the System Settings > Add-ons tab, click Browse, and then open the file.
3 Click Install. After a few seconds, the add-on will appear in the Installed table, and will be enabled.
The table below gives a description of each column.
Column Notes
Name The add-on's name.
Path To open the add-on in a web browser, append this path to your
WebCTRL® system's address.
For example, to open EnergyReports, type:
http://<system_name>/EnergyReports, or
http://<system_IP_address>/EnergyReports
Version The version is shown if the author provided the information in the
add-on.
Status If this column shows:
• Running, you can open the add-on in a web browser.
• Disabled, click Enable to run the add-on.
• Startup error, select the table row to see an
explanation of the error under Details.
4 Select an add-on in the Installed table to disable or enable it, or to see the following Details.
Add-on Click the main page link to open the add-on, if the author provided
main page a main page.
Description A description of the add-on, if the author provided one
Vendor Name The add-on's author
Public Data Directory This public directory contains data generated by the add-on. This
data is visible in a web browser.
Private Data Directory This private directory contains information such as configuration
data.
To back up the add-on'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 add-on 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.
328
To update an add-on
NOTE Add-ons for WebCTRL® v6.0 or later systems have a different folder structure than previous
versions.
2 Click Remove Add-on and Keep Data
3 Follow the procedure above to install the new version of the add-on.
To uninstall an add-on
2 Click Remove Add-on and Data.
To set up site properties

1 On the Network tree, select the site.
2 Click Properties.
3 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 325)
tab.
CAUTION Make sure that your server’s time and time zone setting are
correct. Also, make sure that the site’s time zone setting is correct in
SiteBuilder.
View DST Dates If the site's time zone (set in SiteBuilder) uses Daylight Saving Time, you can
click View DST Dates to see DST information and time change dates.
Group Cache The designated router where colors are cached when peer caching is enabled
Controller in SiteBuilder.
Device Password Applies only to devices with a drv_gen5 driver
Set this password to restrict access to the Service Port controller setup pages
of a controller with a drv_gen5 driver. You will have to know the password to be
able to see the setup interface.
329
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 the Automated Logic® Partner Community website.
2 Locate Software Licenses > BAS License Manager - For WebCTRL 2.5 and later.
3 Your unregistered license will show on the right side of the blue bar. Expand the blue bar.
4 Click on the row that shows unregistered in the Registration Status column.
5 Fill in the fields under Owner Information and Site Information.
6 Click Register License.
7 Check 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® installation—The installation requests the location of your license file.
Browse to location where you saved it in step 4 above.
○ After the installation—
a. On the WebCTRL® System Configuration tree, select License Administration.
b. Browse to the license file.
c. Click Apply.
d. Restart the WebCTRL Server application.
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:
• Advanced security: Location-dependent operator access, configurable password policies, and
required operator comments/verification for system changes
• Advanced reporting: Custom reports
• Advanced Alarming: 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:

2 Locate Software Licenses > WebCTRL 2.5 and later (BAS License Manager).
3 Your unregistered license will show on the right side of the blue bar. Expand the blue bar.
4 Click on the row that shows unregistered in the Registration Status column.
5 Fill in the fields under Owner Information and Site Information.
6 Click Register License.
330
7 Check 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 To replace your license, on the WebCTRL® System Configuration tree, select License
Administration.
10 Browse to the license file.
11 Click Apply.
12 Restart the WebCTRL Server application.
TIP Back up your system 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.
331
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>
NOTE link#.text and link#.url must be lowercase.
Example to add links shown above:
2 Save the file in your system folder with the name extra_login_links.properties.
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:
2 Save the file in your system folder with the name legal_disclaimer.txt.
332
Editing a system remotely through the Set up Tree
In the WebCTRL® interface, you can edit the Geographic or Network tree that was originally set
up in SiteBuilder. The system database is updated immediately.
Right-click an item on the Geographic tree, then select Set up Tree.
To... Use...
Add a new tree item Right-click an item under which to add a new child item and select an
add option. Ex. Add Network.
Edit an item Right-click the item and select Edit. Or, double-click the tree item.
NOTE You must either save or cancel any changes you made in the
edit menu before adding a new control program, screen file, graphic,
or driver.
Delete an item Right-click the item and select Delete. Deleting an item also deletes all
of its children.
Move an item to a Drag and drop the selected item up or down the tree.
new location on the
tree
Add a new control 1 On the Geographic tree, right-click the system or area where
program you want to add the control program.
2 Click Add Equipment.
3 Click Add New Equipment.
4 If the system has other control programs of this type, select which
control programs you want to change.
5 Click Add New.
6 Browse to select the control program.
7 Click Open.
8 Click Continue.
9 Click Close.
Add a new screen 1 On the Network tree, right-click the device that you want to add
file the new screen file to.
2 Click Edit Device.
3 Click Add New Screen File.
4 If other controllers in the system use the current screen file, select
which controllers you want to change.
5 Click Add New.
6 Choose a file and click Continue.
333
To... Use...
Add a graphic (.view In the Geographic tree, double-click the area or equipment that
file) to an area or you want to attach a graphic to. If the graphic is...
piece of equipment
In the Views 1 Select the graphic, then click Attach.
Available list 2 Click Accept.
Not in the Views 1 Click Add New.
Available list 2 Browse to select the view file.
3 Click Open.
4 Click Continue.
5 Click Close.
Assign equipment Drag and drop the equipment onto the item you want to assign it to.
Unassign Right-click the equipment and select Unassign Equipment.
equipment
CAUTIONS
• Make a backup of your system before making changes.
• Make changes carefully as they cannot be undone.
Editing the Geographic Tree
To add or edit an area

An area is a logical group of areas or mechanical equipment.
1 To add an area:
a) Right-click the system or an area on the Geographic tree that will be the parent of the
new area.
b) Select Add Area.
2 To edit an existing area:
a) Double-click the area on the Geographic tree. Or, right-click the area and select Edit Area.
3 Enter values in the Area dialog box.
4 Attach graphic (.view) files now or later.
5 Optional: Click Notes, then type in the notes field.
6 Click Save.
334
To add or edit a piece of equipment
A piece of equipment represents a mechanical device that provides heating, ventilating, air
conditioning, or other service to a building.
1 To add equipment:
a) On the Geographic tree, right-click the system or area where you want to add the
equipment.
b) Select Add Equipment.
2 To edit existing equipment:
a) Double-click the equipment on the Geographic tree. Or, right-click the equipment and select
Edit Equipment.
3 Enter values in the Equipment dialog box. See table below.
5 Click Save.
Field Notes
Name The name displayed on the Geographic or Network tree.
Reference Name A permanent name for a tree item that allows the item to be referenced from
graphics, Properties pages, external spreadsheets, etc. A reference name
consists of lowercase letters, numbers, hyphens, and underscores (no
spaces), and it cannot begin with a number. In the system hierarchy, a
reference name must be unique among its siblings, unless it is a global
reference name that begins with a # sign.
Object Instance SiteBuilder automatically assigns this unique number when you assign a
piece of equipment to a controller.
Control Program Select an existing control program from the list of control programs in the
<system_name>\programs folder.
Require operator to If your system has the Advanced Security package that provides support for
record any changes 21 CFR 11, you can check this field to require a WebCTRL® operator to
to equipment record a reason for changing an equipment property. See Recording reasons
for edits (page 195).
Views You may attach graphic files now or later.
335
Editing the Network Tree
To add or edit a site

1 To add a site:
a) On the Network tree, right-click the system .
b) Select Add Site.
2 To edit an existing site:
a) On the Network tree, double-click the site . Or, right-click the site and select Edit Site.
3 Enter values in the Site dialog box. See table below.
5 Click Save.
Field Notes
Name The name displayed on the Network tree.
Reference Name Global reference names begin with # and must be unique within the
entire system. Non-global reference names (no #) must be unique among
siblings.
Site Number SiteBuilder automatically assigns a unique site number, but if needed,
you can change it to some other unique number.
Device Password Supported only for a router with a drv_gen5 driver.
Set this password on the Network tree > Site level to restrict access to
the controller setup pages when connecting through the Service Port.
Use Server's Time Zone By default, the site is set to the same time zone as the WebCTRL® server.
Use Peer Caching The peer caching router will poll other routers on the IP network for colors
and prime variables. Peer caching also checks the communication status
of the peer caching router and any routers for which it is caching. If any of
the routers cannot communicate, a Dead Module Timeout alarm is
issued.
You can uncheck this field to slightly reduce network bandwidth, but you
will not receive Dead Module Timeout alarms for the BACnet routers.
336
To add or edit a network
1 To add a network:
a) On the Network tree, right-click a site under which to add the new network.
b) Select Add Network.
2 To edit an existing network:
a) On the Network tree, double-click the network . Or, right-click the network and select Edit
Network.
3 Enter values in the BACnet Network dialog box. See table below.
5 Click Save.
Field Notes
Reference Name Global reference names begin with # and must be unique within the entire
system. Non-global reference names (no #) must be unique among siblings.
Network Number Use the default number unless your BACnet administrator gives you a different
number.
Media Type Select a media type for this network.
Allow IP devices Check this box when adding a BACnet/IP controller to a BACnet/SC network.
that use the IP <->
BACnet/SC modem
To add or edit a device

1 To add a device:
a) On the Network tree, right-click a network .
b) Select either Add BACnet Device or Add BACnet Device Router.
2 To edit an existing device:
a) On the Network tree, double-click the device. Or, right-click the device and select Edit Device.
3 Enter values in the BACnet Device or BACnet Device Router dialog box. See table below.
4 Click Save.
General tab
Controller Select the controller in the drop-down list.
NOTE If the controller you are adding is not listed, browse to the controller's
driver.
337
General tab
Device Instance This number must be unique throughout an entire BACnet system. Do one of
the following:
• Use the default number based on SiteBuilder's next sequential Device
Instance number
• Enter a specific number.
OptiFlex™ router only—Check Autogenerated only if you plan to let the

controller autogenerate its Device instance. The number you enter must
match the autogenerated number in the controller setup pages that you
access through the Service Port. This number is equal to:
(IP network number x 100) + the router's rotary switch address
EXAMPLE If the IP network number is 00 and the rotary switch address is
15, the Device Instance is 0015.
Screen File If you have a file for a BACview® or touchscreen device, select a .bacview or
.touch file from the drop-down list.
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, .touch, .bacview, and .driver/.driverx source files,
plus any .view files marked to be included in download.
• Select this 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.
To export from the SiteBuilder application, see Miscellaneous SiteBuilder

menu commands in SiteBuilder Help.
To export from the WebCTRL® application, see Commissioning

equipment using Field Assistant (page 301).
NOTE If you select this field but the controller does not have enough
memory, the WebCTRL® download will fail. You can then disable this option
on the controller's Properties page and download again.
For the OptiFlex™ router on an IPv6 network, all of the addressing is automatically obtained using the
Device Instance that was set up on the controller setup pages. The Address fields are not displayed.
338
Address tab
Address Type the device's private IP address that you got from the network
administrator.
CAUTION The WebCTRL® interace allows duplicate private IP

addresses in the system, even on the same private network. So you
must verify with your network administrator that the private network
has no duplicate addresses.
NOTE If the WebCTRL® server will use a port other than 47808 for
BACnet communication, type :<port number> after the address.
For example, 172.18.64.38:47901.
Subnet Mask Type the device's default subnet mask that you got from the network
administrator.
Default Gateway Address Type the device's default gateway address that you got from the
network administrator.
Automatically Configure My Check this field for all devices in your system even though this kind of
BBMDs network cannot use BBMDs.
Networks tab OptiFlex™ router only—Shows the network number, media type, and if
applicable, lets you select the router port that each network will use.
Notes tab These notes can also be seen on WebCTRL® Properties page.
Add New Screen File If other controllers in the system use the current screen file, select which
controllers you want to change.
339
To change or upgrade a driver
1 On the Network tree, double-click the driver.
2 To change to an existing driver:
a) Select a driver from the Driver dropdown list.
3 To add a new driver:
a) Click Add New Driver.
b) If other controllers in the system use the current driver, select which controllers you want to
change.
c) Click Add New.
d) Choose a file and click Continue.
4 Enter the values in the BACnet Driver dialog box. See table below.
5 Click Save.
General tab
Driver Choose a driver from the drop down list.
Notes tab These notes can also be seen on WebCTRL® Properties page.
Add New Driver tab If other controllers in the system use the current driver, select which controllers
you want to change.
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
• Trend data (if included in the clipping)
• 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)
340
To import a clipping:
1 Right-click the system on the Geographic tree, then select Import Clipping.
2 Browse to and select the clipping you want to import, then click Next.
3 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.
4 Click Next.
5 If asked if you want to replace event templates, follow the on-screen instructions.
6 If asked if you want to overwrite components, follow the on-screen instructions.
7 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.
8 Click Next.
9 Click Finish.
10 Do any of the following that apply.
If you imported... Do the following in the SiteBuilder Do the following in the

application... WebCTRL® application...
Another site into the system Change the new site's BACnet/IP Download All Content to all
network number to be the same as Automated Logic® IP routers in
the other BACnet/IP network(s). the system.
A second BACnet/IP network Move the items under the new Download Parameters to any
into a site network to the original BACnet/IP controllers that you moved.
network, then delete the new
network.
341
If you imported... Do the following in the SiteBuilder Do the following in the
application... WebCTRL® application...
Any controllers that use the N/A Download BBMDs to the routers.
SiteBuilder option
Automatically Configure My
BBMDs
Any controllers that use N/A Update the routers' BBMD tables.
manually configured BBMD See "To set up BBMDs through
tables the WebCTRL® interface (page
228, page 229)"
or
"To set up BBMDs using the
BBMD Configuration Tool"
in WebCTRL® Help.
A clipping without trends into N/A Restart IP connection(s) to new

a system using NAT devices.
Managing files on a remote WebCTRL® server

The WebCTRL® application supports WebDAV, a network protocol designed for managing remote
server files through an Internet connection. Use a third-party WebDAV client application, such as
WebDrive, to access the Internet from anywhere in the world and manage your system files residing on
a distant WebCTRL® server.
Options for running the WebCTRL® system

Running WebCTRL Server without connecting to 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 web browser.
NOTE Question marks or purple thermographic color indicates correct microblock paths. Missing data
or dark yellow thermographic color indicates errors.
Switching WebCTRL Server 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 and mode.
3 Click Select.
342
Running WebCTRL Server as a Windows® service
For Windows 8.1, 10, 2012R2, 2016, 2019, and 2020
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 database other than Derby and the database is 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 "How to delay loading of specific services"
(http://support.microsoft.com/kb/193888) on the Microsoft® website.
To install WebCTRL® Server service

NOTE If you are not sure if the service was previously installed, see To determine if WebCTRL Server
service is installed (page 345).
1 In the Windows Start menu, select All Programs > Accessories.

2 Right-click Command Prompt, then select Run as administrator.
3 Select Yes in the User Account Control message.
4 In the Command Prompt window, type: cd <path to the WebCTRL install
directory>
For example, type: cd c:\WebCTRLx.x
replacing x.x with your current version number.
5 Press Enter.
6 Type: "WebCTRL Service.exe"
7 Press Enter.
To start WebCTRL® Server as a Windows service

1 In the Windows Start menu, select Control Panel.
2 Select Administrative Tools, then double-click Services.
3 In the Services (Local) list, double-click WebCTRL Service X.X.
4 In the Startup type drop-down list, select Automatic.
5 On the Log On tab, do one of the following:
○ Use the defaulted Local System account.
○ Select This account, then browse to select a user who is a member of the Administrator Group
on that computer.
6 Optional: If you selected Local System account in step 5 and you want to be able to access
WebCTRL Server on the server computer's desktop, check Allow service to interact with desktop.
NOTES
○ If you do not check this field, 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 check this field, 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 check this field and the WebCTRL® application is to run email alarm actions, ask your
Network Administrator to set up Local System account to send emails.
343
7 On the General tab, click Start.
8 Click OK.
NOTE If WebCTRL Server does not start after 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 344)
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.
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.
To stop or uninstall WebCTRL® Server service

To stop WebCTRL Server service
2 Select Administrative Tools, then double-click Services.
3 In the Services (Local) list, double-click WebCTRL Service X.X (where x.x is the WebCTRL version
number.
4 In the WebCTRL Service x.x Properties dialog box, click Stop on the General tab.
5 Click OK.
To uninstall WebCTRL Server service

1 In the Windows Start menu, right-click Command Prompt, then select Run as administrator.
directory>
4 Press Enter.
5 Type: "WebCTRL Service.exe" -remove
6 Press Enter.
344
To determine if WebCTRL® Server service is installed
If you do not know if the service was previously installed, follow the appropriate steps below.
1 In the Windows Start menu, right-click Command Prompt, then select Run as administrator.
directory>
4 Press Enter.
5 Type: "WebCTRL Service.exe" -check
6 Press Enter.
Running WebCTRL Server as a Linux® service
To set up as a service on Ubuntu or RedHat

1 On the terminal screen, type: cd /opt/WebCTRLx.x
2 Click Enter.
3 On the terminal screen, type: sudo ./WebCTRL\ Service add
4 Click Enter.
5 Reboot the computer for the application to run as a service.
To remove as a service on Ubuntu or RedHat

1 On the terminal screen, type: cd /opt/WebCTRLx.x)
2 Click Enter.
3 On the terminal screen, type: sudo ./WebCTRL\ Service remove
4 Click Enter.
5 Reboot the computer.
345
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 346).
2 Prepare your workstation for non-English text (page 346).
3 Create control programs and translation files (page 348).
4 Create graphics (page 350).
5 Create your system in SiteBuilder (page 352).
6 Set an operator’s language in the WebCTRL® interface (page 353).
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:
2 Locate Software Products and Updates and 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

NOTE The instructions below are for a Windows XP operating system. If you have a different operating
system, see your system's Help for instructions.
Set up your workstation so you can type international characters in control programs, graphics, or
SiteBuilder.
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.
346
3 Install an Input Method Editor (IME) for non-alphanumeric characters.
See your operating system's Help for more information.
347
Creating control programs and translation files for a non-English system
To have the WebCTRL® interface display a control program’s 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 or Logic page shows ??key term??, the key
term is missing from the translation file.
NOTE To edit existing control programs or translation files, see Editing translation files or control
programs for a non-English system.
To enter a key term in the EIKON® application

In the EIKON® Property Editor, type @ before each key term.
NOTES
• Type only the key term in the EIKON® 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.
348
Translation files
Translation files are used to translate key terms in control programs. 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:
• Each control program
• Key terms used in multiple control programs
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 the file name is... File location
in...
A single control program <any_name>_xx.native* Any location
Multiple control equipment_xx.native* <system_name>\resources
programs
* 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 application’s help for
information on saving files as encoded text.) When prompted for the language and encoding,
see “Extension codes and encoding” below.
1 Open the control program in the EIKON® application, then select Control Program > Bundled
Resources.
2 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.
349
3 Save the control program. The translation files are embedded in the control program; the original
files are no longer necessary.
Extension codes and encoding

Language Extension codes Encoding*
Brazillian Portuguese pt_BR ISO-8859-1
English en ISO-8859-1
Canadian French fr ISO-8859-1
French fr_FR ISO-8859-1
German de ISO-8859-1
Italian it 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

To create a non-English graphic in ViewBuilder:
1 Set the language font (page 351).
2 Create the graphic. (page 351)
3 Save the .view file.
NOTE The names of your .view file and any inserted image files must contain only ASCII characters.
350
Setting the language font
If your system has language packs installed, you can select a font for each language. Your selection
affects only how text in your graphic appears in ViewBuilder.
To set the font for each language

1 Select Configure > Preferences > Graphic (.view).
2 On the Language tab, check the language that you want to be the default for all new graphics.
To select the default language font for all new graphics

In the Preview Font column, click the font name to select a different font.
To select the active language when creating a view

If you will use multiple language fonts in a single view, you can switch to a different language font as
follows:
1 Select Configure > View Properties.
2 In the Language field, select the language you want to use.
3 Click OK.
To create a Non-English graphic

The method you use to create a graphic that will be displayed in a non-English WebCTRL® system
depends on the following:
• If the WebCTRL® system will display only a single non-English language, create the graphic in that
language.
• If the WebCTRL® system will display multiple non-English languages, use either of the following
methods:
○ Create the graphic in layers (one layer for each language), and then assign a show/hide
conditional expression (see format below) to each layer so that it displays in WebCTRL® based
on the operator language. See "To show/hide a layer in the WebCTRL® interface" in
ViewBuilder Help.
○ Create each piece of the graphic in the different languages, and then assign a show/hide
conditional expression (see format below) to each piece so that it displays in WebCTRL® based
on the operator language. See "Setting objects on a graphic to show/hide in the WebCTRL®
interface" in ViewBuilder Help.
351
Show/Hide conditional expression format
$$operator_language$$='language'
where language is the language code from the list below.
For example, the conditional expression to display French would be:

$$operator_language$$=='fr_FR'
Language Language code

Brazillian Portuguese pt_BR
English en
Canadian French fr
French fr_FR
German de
Italian it
Japanese ja
Korean ko
Russian ru
Spanish es
Swedish sv
Simplified Chinese zh
Traditional Chinese zh_TW
Thai th
Vietnamese vi
Creating a non-English system in SiteBuilder

To choose the language(s) for your system
2 Select the Language tab.
3 Under Supported Languages, select each language that you want to be available in your system.
NOTE This list shows all installed language packs. To install additional languages, see Installing a
language pack (page 346).
4 In the System field, select the system Language (page 353).
5 Click OK.
6 Save your database.
352
To create your system
To create your system in each language that the system will display:
2 Optional: The Font tab shows the font that will be displayed in SiteBuilder for each language that
you selected on the Language tab. To change a font, click on the name in the Preview Font column,
then make a new selection.
3 On the Language tab, select a language in the Current Session field.
4 Click OK.
5 Create your system.
6 Save your database.
7 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 operator’s language, which may be different than the system
language. See To set an operator’s language in the WebCTRL® interface (page 353).
* 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 operator’s language in the WebCTRL® interface

An operator can change their language preference in the WebCTRL® interface.
1 On the System Configuration tree, select My Settings.
2 Under Preferences, select the Language in the drop-down list.
3 Click Accept.
353
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 348).
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 on
the Geographic tree, then select Rebuild Equipment Pages.
• If you changed logic in the control program, right-click the control program on the Geographic tree,
then select Reload Control Program.
• If you changed a translation file located in <system_name>\resources, right-click each applicable
graphic on the Geographic tree, then select Rebuild Graphic Resources.
To edit a bundled resource

The EIKON® 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. To edit a bundled
translation file:
1 Open the control program in the EIKON® application.
2 Select Control Program > Bundled Resources.
3 Select the file, then click to save it to your hard drive.
4 Edit the translation file.
5 In the Bundled Resources dialog box in the EIKON® application, click and select the edited file.
6 Click OK to overwrite the existing file.
Editing an EIKON® for WebCTRL control program in the EIKON® 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® 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 <system_name>\programs folder. This list should
not include translation files for multiple control programs.
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 354).
354
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 system’s translation file in a text editor, then copy the key terms and translations.
2 Open the destination system’s translation file in a text editor, then paste into it the key terms that
you copied. Remove any duplicate key terms.
Using a converted SuperVision® system

To convert a legacy system, see the SuperVision Support Manual found at the Automated Logic®
Partner Community website.
After conversion, equipment and controllers from converted systems support most of the functions of a
WebCTRL® system. However, some differences are discussed in the topics below.
Microblock pop-ups for converted SuperVision® systems

To view and modify microblock properties, click a microblock on an equipment logic page. In the
microblock pop-up, you can:
• View current property status and conditions such as alarm status
• Configure hardware and software settings for that microblock
• Edit properties and view the dynamic responses of a microblock and the underlying logic page
• Perform a global modify by Alt-clicking on the property field
• View, enable, disable, or configure a trend
• Enable or disable an alarm
355
Alarms for converted SuperVision® systems
A WebCTRL® system can support alarms generated from SuperVision (Exec 6 and earlier) hardware.
However, if your system includes any Exec 3 or Exec 4 controllers with older function blocks, you are
limited to the older Exec 3-style trends and alarms.
The WebCTRL® sequence for alarm generation and delivery is similar to the alarm sequence in a
SuperVision system:
1 A function block in a controller generates an alarm based on hardware inputs and user-defined
conditions.
2 The Alert microblock in the function block turns on, then sends alarm information to the router.
3 The router transmits the alarm to the WebCTRL® application.
4 The WebCTRL® application uses the Event ID contained in the alarm to associate it with the
reference name of an alarm template. Or, if the single alarm template option was chosen during
the InterOp® conversion, the template alert_auto is used and the text which includes the Event ID
in the file cmnet_alert_text.properties is displayed.
For Exec 3-style bit alarms, the Alarm Text number contained in the alarm is used to associate the
alarm with the reference name of an alarm template (or the appropriate text in the file
cmnet_alert_text.properties if using the single alarm template). See Exec 3 bit alarms (page 358).
NOTE If you are using a CMnet/IP connection to receive alarms, you must type the CMnet Station
Number when you configure the connection. See "Setting up CMnet connections for converted
SuperVision systems" in the SuperVision Support Manual found on the Automated Logic® Partner
Community website.
Alarms from SuperVision hardware can be simulated in the WebCTRL® interface. See Setting up an
alarm source in the WebCTRL® interface (page 99).
356
Modifying Event IDs
After the SuperVision® function blocks have been converted to a WebCTRL-compatible format, if an
alarm template was created for each legacy alarm name, the Event ID contained in an Alert microblock-
style alarm determines which alarm template is used.
To change the Event ID of an Alert microblock in the WebCTRL® interface

1 On the Geographic tree, select the piece of equipment.
2 Click Properties.
3 Verify that the Parameters tab is selected.
4 Scroll to the portion of the screen that contains the parameters for the Alert microblock.
5 Select the Event ID field, then type the desired ID.
6 Click Accept.
To change the default Event ID of an Alert microblock in Eikon

CAUTION Make this change in Eikon, not the EIKON® application.
1 Start Eikon.
2 In the Edit Variables mode, click the Alert microblock.
3 Type the new Event ID in the Alert MB pop-up. After the function block has been successfully
compiled and saved, this ID will be used as the default Event ID for this alarm for all instances of
this function block.
Including Alert alarm text in WebCTRL® alarm templates

The InterOp Conversion Wizard includes Alert alarm text in the .interop file. The Alert alarm text is
automatically added to the short and long text fields in the new WebCTRL® alarm templates. The Off
Normal Short Text field defaults to "$Field_Message$ is in alarm." The field code “$Field Message$”
retrieves the address and Event ID from the equipment where the alarm was generated.
NOTE Field codes automatically convert to their WebCTRL® equivalent, but their formatting does not.
You will need to redo any formatting. See Formatting field codes (page 107).
Optional - Single alarm template

If the single alarm template option was chosen during the InterOp Conversion, a file was generated in
the <system_name> folder called cmnet_alert_text.properties. For any alarms which use the Alert Auto
template, the WebCTRL® application will look up the appropriate text in this file.
NOTE If the system was originally created without using this option, the file can be created, alarm text
added to it, and then any appropriate alarms can be assigned to the Alert Auto template and the
cmnet_alert_text.properties will be used.
To edit the text for any alarms using the Alert Auto template, edit cmnet_alert_text.properties. (Text
prefixes and suffixes can still be added using the in the WebCTRL® interface).
357
The following is the format for text in the cmnet_alert_text.properties file:
EVENT_ID.alarmshort=Short alarm text.
EVENT_ID.alarmlong=Long alarm text \r\n Long text line 2:\r\n Long text line 3
EVENT_ID.normalshort=Return to normal short text.
EVENT_ID.normallong=Return to normal long text \r\n Long text line 2:\r\n Long text line 3
HI_ZONE.alarmshort=High Zone Temp
HI_ZONE.alarmlong=High Zone Temp \r\n At the time of the alarm:\r\n Zone Temp =
$latched_data_analog:1$
HI_ZONE.normalshort=Zone Temp is normal.
HI_ZONE.normallong=Zone Temp is normal.
NOTE “\r\n” is used to determine where a carriage return (CR or Enter) should be placed when the
alarm is displayed in the WebCTRL® interface. The entire text string should be typed in with no CRs
used on the keyboard until the end of the field.
Exec 3 bit alarms

The WebCTRL® application uses the Alarm Text number defined on the Parameters page to determine
which alarm template to use. When a bit alarm or message is received, the WebCTRL® application
uses the message text number preceded by an "a" or an "m" to display the alarm template. For
example, if a particular bit alarm has the number "31" defined as its alarm text,t he WebCTRL®
application uses the alarm template with a reference name of "a31".
Bit alarms are automatically assigned to the General Alarm alarm category. Bit messages are assigned
to the General Message alarm category.
To modify the message text for a bit alarm

1 On the Geographic tree, select the equipment.
2 Click Properties.
3 Verify that the Parameters tab is displayed.
4 Change All Options to Y.
5 Select the appropriate bit alarm message text field, then type the new number.
6 Click Accept.
See Including Alert alarm text in WebCTRL® alarm templates.
358
Trends for converted SuperVision® systems
The following can be trended:
• Any input or output point
• Any value tied to an Analog Trend or Digital Trend microblock in the system
All trend properties, including graph properties, are converted.
Trend types are limited based on the following controllers:

• Exec 3 - can have only the following Exec 3-style trends:
○ Standard
○ Extended
○ Enhanced
• Exec 4 - has Exec 3-style trending built in. However, if its function block was remade in Eikon with
new-style trending with a trend microblock, the controller has probably been changed to use the
new style.
• Exec 6 - can have only the new-style trends.
The type of trends your SuperVision system uses at the time of conversion affects how you make
changes to the trends in the WebCTRL® system. Trend types also affect the amount of trend data that
can be stored, the sampling interval, and whether historical trend data can be stored in a database.
Control Type of Number of Number of points Sampling rate Can be

module trend samples per function (interval) saved to
stored per block or controller database?
point
Exec 3 or 4 Exec 3-style 60 1 per function block 1 to 255 minutes Yes
standard
Exec 3 or 4 Exec 3-style 30 2 per function block 1 to 255 minutes Yes
standard
Exec 3 or 4 Exec 3-style 60 1 extra per 1 to 255 minutes Yes
with extended controller (module
driver)
Exec 3 or 4 Exec 3-style 30 2 extra per 1 to 255 minutes Yes
with extended controller (module
driver)
Exec 3 Exec 3-style 288 limited by available 1 to 255 seconds No
with enhanced memory or minutes
using XF2
function blocks
Exec 4 New-style 288 50 per controller 1 to 255 seconds Yes
(limited by available or minutes
memory)
Exec 6 New-style 288 limited by available 1 to 255 seconds Yes
memory or minutes
NOTE T-Line and U-Line controllers are used for low-end, high-volume terminal control applications so
they are not suited for time-critical applications (including very short trend intervals). Trend intervals on
T-Line and U-Line function blocks should be set to one minute or greater.
359
Trends and controller memory
NOTE If the function blocks in a controller support new-style trends, Exec 3-style trends generally are
not needed. If the controller is configured to display new-style trends, Exec 3-style trends will not be
displayed. (The displayed trend type is set on the Parameters tab of the driver’s Properties page.)
You must consider the types of points you are trending to ensure adequate memory if you do not use
standard or extended trends. Analog points require more memory to store the same number of samples
as digital points. Non-linear points, such as thermistors, require twice as much memory as linear points,
such as 4 to 20 mA sensors.
If you disable a trend to free memory so you can trend a different type of point in an Exec 4 controller
(for example, an analog point instead of a digital point) you must restart the controller to reallocate
memory for the trends.
NOTE When you restart Exec 3 and 4 controllers, you lose existing trend information in the controller’s
memory. Also, any equipment controlled by the controller will restart.
If you change the type of point in an Exec 6 controller, trended memory is automatically reallocated
without restarting the controller. Trends are cleared from an Exec 6 controller’s memory when you
transfer memory to the controller or change the value in the Interval field. See Trends for Exec 4 and 6
controllers (page 360).
Trends for Exec 4 and 6 controllers

This topic applies to the following hardware:
You can trend input/output points and other wire values that are attached to Trend microblocks on all
Exec 6 and some Exec 4 controllers’ GFBs. All trend graph parameters are included from the
SuperVision® system during a conversion. Use this procedure if you need to change any of the values.
Each trend object can hold 288 samples in the controller. (Historical trends allow the system to extend
beyond this limit by transferring trend data to the server.)
If you are using an older trend type (such as if all of the options below are npt visible), see Trends for
Exec 3 and 4 controllers (page 362).
To configure trends for Exec 4 and Exec 6 controllers

1 Click the Trends button drop-down arrow, then a trend item.
2 Click the Enable/Disable tab to allow the controller to collect trend data.
3 Type information in the appropriate fields. See below.
4 Click the Configure tab to access the trend graph’s display properties.
NOTE Autoscaling selects the most appropriate display range as defined on the equipment
Parameters page for each point on the graph.
5 Click Accept.
Click the View tab to see the trend graph.
360
Field Notes
log interval _:_ Records (samples) the point's value at the time interval you define. Can
be set to a value from 1-255.
TIP Since the controller stores 288 samples, you can hold trends in
the controller for a 24-hour period by setting the interval to 5 minutes.
Interval in seconds Changes the log interval from minutes to seconds.
NOTE Trend intervals in function blocks in TNI or UNI controllers should
be set to one minute or greater. These controllers are not suited to very
short trend intervals.
Enable Historian Select to have the trend data saved to the server database.
NOTE An Alarm microblock using the Event ID of "TREND" is required in
the function block if you want historical trends from Exec 4 or 6
controllers.
Delete Deletes the trend’s historical data from the server database.
Keep historical trends Type the number of days the database should store a point's data
for __ days before automatically deleting it. Even if you disable a trend, the data
still remains in the database until its age exceeds the number of days
defined.
NOTE If you type a zero, the WebCTRL® application uses the System
Settings page’s Keep historical trends for __ days field to determine
the value.
NOTE Multiple trends on a graph are viewed and configured the same as they are in a native
WebCTRL® system.
Configuring historical trends for Exec 4 and 6 controllers

You can save trend data from controllers to the WebCTRL® database. These historical trends can be
viewed on the trend graph like any other trend. See To collect trend data for a point (page 63).
Exec 4 and 6 trends using a Trend microblock must be configured for the point on the Enable/Disable
tab of the Trends page by enabling the Enable Trend Log and Enable Trend Historian fields. Each
function block with trends that you want stored in the database must also contain trend reporting logic.
See Historical trend reporting logic (page 368).
For Exec 4 and 6 trends, you can also enable the point for reporting by setting the Report field on the
Parameters tab of the Properties page to Yes after setting All Options to Yes.
361
Trends for Exec 3 and 4 controllers
When working with Exec 3 or early Exec 4 controller function blocks that do not have the Exec 4 or 6
type trends under each point, you can use standard trends to trend up to two points in a function block.
If you use standard trends and need to configure additional trends, you can use extended trends. For
limitations, see To configure Exec 3 and 4 controllers with extended trends (page 364).
Some Exec 3 controllers support enhanced trends which allow more items to be trended and more
flexibility. For more details, see To configure Exec 3 controllers with enhanced trends using XF2
function blocks (page 366).
For details on configuring historical trends, see Configuring historical trends for Exec 3-style controllers
(page 367).
To configure standard trends for Exec 3 and 4 controllers

1 Click the Trends button drop-down arrow, then a trend item.
2 Click the Enable/Disable tab.
3 Type information in the appropriate fields. See below.
4 Click the Configure tab to access the trend graph’s display properties.
Parameters page for each point on the graph.
The remaining parameters are configured in the same manner as for ExecB trends.
5 Click Accept.
Click the View tab to see the trend graph.
Setting Details
Log Interval Set the interval value from 1 to 255 minutes. You can show a 24-hour
period on a trend graph if you set the interval to 24 minutes for one trend
or 48 minutes for two trends. (A controller stores 60 samples for one
trend or 30 samples each for two trends.)
NOTE Any changes to this value also appear on the equipment's
Parameters page.
Enable Historian Select to have the trend data saved to the server database.
NOTE A daily trend report must be configured by enabling Message bit 7
to keep historical trends from Exec 3 controllers. This allows controllers to
try to deliver the trends to the server at 1:00 am. See Configuring
historical trends for Exec 3-style controllers (page 367).
Delete all historical Deletes the trend’s historical data from the server database.
data for this trend
log?
362
Keep historical trends Type the number of days the database should store a point's data before
for __ days automatically deleting it. The data remains in the database until its age
exceeds the number of days defined in this field even if you stop trending
a point.
NOTE If you type a zero, the WebCTRL® application uses the System
Settings page’s Keep historical trends for __ days field.
Inactive Text and Type the text you want to appear on the trend graph for the inactive and
Active Text active (on/off) state of the item being trended.
Determining a trend code

You must know the available trend codes when configuring Exec 3-style trends. For example, if you
want to add a trend in one of the two available trend logs or you want to add a trend log as an
enhanced trend, you must know the appropriate trend code.
1 On the Geographic tree, select the equipment.

2 Click Properties.

5 Type console, then click OK.
6 Type cmnet connect, then press Enter.
7 Type cmnet iocodes, then press Enter.
8 Select an available trend code from the list that contains the MbCodes, trend names, point types,
and trend codes.
363
For example, the fan start/stop has an MbCode of "fan" and its trend code is 235.
To configure Exec 3 and 4 controllers with extended trends

Extended trends allow up to 2 additional trends per controller for the following situations:
• When Exec 3 and 4 controllers that have already used both of the trends available in the
equipment’s function block need additional trends
• When the trend code in the equipment’s function block is greater than 255
For limitations, see Trends for converted SuperVision® systems (page 359).
1 On the Network tree, select the driver for the device that contains the Equipment Definition
that has the point you wish to trend.
2 Click Properties.
4 Set All Options to Y.
364
5 Scroll to the bottom of the page. If you have Exec 4 controllers and need to use Exec 3 trends, set
This module should display old-style trends to Yes.
6 To obtain the extended trend code, type the following parameters:
Parameter Details
In FB - Type the number of the function This point must be in the same controller as the
block that contains the point to be trended. driver. You can find the function block number at the
top of every equipment Parameters page.
Code - Type the trend code as it would be To obtain this code, see Determining a trend code
at the equipment itself to configure the (page 363).
trend.
Type - Type the Type number from the Extended trend types are based on the "type" per the
Extended Trend table. CMnet iocodes output list used to determine a trend
code. See Determining a trend code (page 363).
The extended Trend Code is calculated and displayed. This code is unique to all points in the
controller.
365
7 Scroll back to the top of the page and enter the Trend Code in the Code field.
8 Click Accept to transfer the changes to the controller.
To configure Exec 3 controllers with enhanced trends using XF2 function

blocks
For some Exec 3 controllers, enhanced trends are used for the following situations:
• When you need more trends than allowed with standard and/or extended trends
• To store more than 60 samples per trend
You must configure an XF2 function block in the controller as function block number 14 to use
enhanced trends. You can then view this function block or piece of equipment from the WebCTRL®
Geographic or Network tree.
1 On the Geographic or Network tree, navigate to the function block’s trend information.
2 Click Properties.
3 Toggle any of the channel fields in the Daily Trend Reports section to Yes if you want to enable a
trend to log alarms.
NOTE These changes also appear on the trend’s Configuration tab.
366
4 Click Trends, then select one of the trends.
5 Click the Enable/Disable tab.
6 The Log Enable check box reflects your setting from Step 3.
Set the remaining trend properties as needed.
7 Click the Configure tab to change the graph’s display settings as needed.
Properties page for each point on the sub-graph.
Configuring historical trends for Exec 3-style controllers

You can configure Exec 3 standard, extended, and enhanced trends for historical trending.
NOTE See To collect trend data for a point (page 63).
1 On the Network tree, select the driver.
2 Click Properties.
4 Set All Options to Y.
5 Type x in message bit 7.
An Eikon GFB must contain a Message microblock that will generate trend data whenever the
microblock is tripped; these messages are treated as critical alarms. A pre-Eikon function block has this
functionality built into it.
NOTE Pre-Eikon function blocks automatically deliver historical trends at 1:00 a.m.
367
Historical trend reporting logic
To configure historical trend reporting, use the sequence of logic shown below in your graphic function
block. This sequence is available from the InterOp® Tools section of the SuperVision® installation CD.
The logic contains the following elements:

1 The Alert Event microblock generates a trend report using an Event ID of TREND and the MbCode
TRN1.
NOTE Exec 3 controllers require a Message microblock because they do not support the Event
microblock.
2 The Binary parameter microblock determines whether trend reports are sent once per day or at
some other frequency. This microblock uses the MbCode TRN2.
3 A time parameter microblock determines how frequently the trend report is sent. This microblock
uses the MbCode TRN3.
4 If the trend report is sent once per day, a second time parameter microblock determines the time
of day the trend report is sent. This microblock uses the MbCode TRN4.
NOTE If you choose not to use this logic, you must at least include an Alert Event microblock in the
GFB with an Event ID of TREND and enable trending on the Parameters page. When activated, this
microblock tells the WebCTRL® application to collect historical trend data. You can include additional
logic determining how often the TREND event should be activated, and set up the necessary
parameters on the GFB’s Parameter page.
368
Integrating a WebCTRL® system with other systems
Integrating WebCTRL® data into other applications

The WebCTRL® product has an application programming interface (API) that allows a programmer to
write an application that can retrieve WebCTRL® data, communicate with controllers, and in some
case, contribute features to the WebCTRL® application. In addition, WebCTRL® supports data transfer
using web services. If you need a new feature, report, or data from your system, you may be able to
contract someone to develop an add-on or custom report to meet your need. Contact your local field
office for more information.
Integrating third-party data into a WebCTRL® system

You can integrate third-party devices into a WebCTRL® system if the following are true:
• The third-party devices are physically connected on the WebCTRL® system’s network.
• You have an Automated Logic® controller that supports third-party integration.
• You have the correct Automated Logic® driver for the third-party protocol.
• You have enabled a port for a third-party protocol on the Automated Logic® controller’s driver
page.
To read from or write to a third-party device, you need the following information from the third-party
vendor:
• Protocol
• Third-party device’s network address
• Memory location of the object in the device you want to read from or write to
If you are integrating with BACnet devices, you can use the WebCTRL® BACnet Discovery feature to
gather this information. See To discover BACnet networks, devices, and objects (page 370).
Before you begin a third-party integration, study the Automated Logic® controller’s Technical
Instructions and the third-party protocol’s Integration Guide. Both are available on the Automated
Logic® Partner Community website.
NOTES
• While BACnet third-party points are not restricted by hardware, we recommend that you do not
exceed 2000 third-party integration points in a router's applications. You also should consider baud
rate, number of nodes, number of network points, and trending frequency as these factors
generally lower this recommendation.
• The point allowance of a controller that provides third-party points applies to only itself. For
example, if you purchase an LGR1000 and download control programs that use 500 third-party
Network I/O points, you cannot apply the unused 500 points to a different controller.
• Third-party points count towards the point limitation of a WebCTRL® system.
369
To determine the number of third-party points used in a controller
1 On the Network tree, click to the left of the controller.
2 Click Driver.
○ For a device with a drv_fwex driver:
Scroll to Network Microblocks. Number of integration points requested and Number of
integration points active show how many non-BACnet third-party Network I/O microblocks the
controller is using. These two counts will differ if you exceed the product's integration point
limits. For example, if your controller provides 25 points and its control program includes 27
Modbus points, your Integration points requested will be 27 and your Integration points active
will be 25.
○ For a device with a drv_gen5 driver:
Click the Control Programs tab, then see the table in the Point Licensing section.
To discover BACnet networks, devices, and objects

The WebCTRL® BACnet Discovery feature locates all accessible BACnet networks, BACnet devices, and
BACnet objects (including devices in your WebCTRL® system) on a BACnet network. The information
gathered in this process is typically used to integrate third-party BACnet devices and their BACnet
objects into the WebCTRL® system.
To use BACnet Discovery:
2 On the Configure tab, disconnect the BACnet/IP connection.
3 While the connection is stopped, enter or verify the server's IP Address and Subnet Mask for the
BACnet/IP connection.
4 Restart the connection.
5 On the Network tree, select the system level.
6 Click Devices.
7 On the Advanced tab, click Start to discover BACnet sites for the system. An item called Discovered
Networks appears in the tree.
8 To discover BACnet networks, select Discovered Networks, then click Go. A list of all BACnet
networks appears on the Network tree. After all networks are found, close the status dialog
box.
TIP Run a commstat manual command to determine which device routes to each network. The
BACnet Bind Show Network section of the Commstat window shows the IP address of the router to
each network.
9 To discover BACnet devices on a network, select a network on the Network tree, then click Go.
After all devices are found, close the status dialog box. Click the plus sign beside an item to expand
the list of devices.
10 To discover BACnet objects on a device, select the device on the Network tree, then click Go.
After all objects are found, close the status dialog box. A list of all BACnet objects in this device
appears on the Network tree.
TIP Make sure you are discovering objects in the correct device. It may take some time to
discover objects in devices with more than 100 objects.
370
11 Optional: Do the following to export the BACnet information so that it can be used in the Third-Party
BACnet Utility or in the EIKON® application:
a) On the Network tree, select a discovered network with devices or a single device.
b) Click Export.
c) Name and save the .discovery file in any folder.
NOTES
• Some third-party BACnet devices may not be discovered because they do not support the BACnet
methods required for auto discovery.
• If the discovery process returns ambiguous information, such as multiple points with similar
names, contact the third-party manufacturer's representative for clarification.
• Device configuration or network load can prevent the WebCTRL® interface from showing all
BACnet devices. If you do not see a BACnet device that you expect to see, check the system's
BBMD configurations. If the configurations are correct, try the discovery process again.
371
Document revision history
Important changes to this document are listed below. Minor changes such as typographical or formatting
errors are not listed.
Date Topic Change description Code*

No updates yet
* For internal use only
372

WebCTRL v8.5 User Manual

Uploaded by

Copyright:

Available Formats

WebCTRL v8.5 User Manual

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

WebCTRL v8.5 User Manual

Uploaded by

Copyright:

Available Formats

WebCTRL® v8.

1150 Roberts Boulevard, Kennesaw, Georgia 30144

ALC Proprietary & Confidential • All rights reserved

A typical WebCTRL® system may include:

WebCTRL® editions and optional packages

Feature Standard Advantage Premium Life

Feature Standard Advantage Premium Life

Points (all input and output points regardless of

Free access to LDAP and Trend Export add-ons

* Does not support the Automated Demand Response add-on.

A legacy-style report designer for creating the following reports:

Advanced Security • Location-dependent operator access (page 191)

Advanced Alarming The following alarm actions:

What's new in the WebCTRL® application

Interactive Zone Widget Also available in v8.0 with Cumulative Patch #5

What's new in the SiteBuilder application

Using the WebCTRL® application

Running WebCTRL® Server

To start the WebCTRL® system

To send a message to logged in operators

To log off an operator

From the WebCTRL Server application

From the WebCTRL® interface

To shut down a system

Computer and large-screen mobile interface

• When you click to hide the tree, the button changes to .

• Help and Print are in the menu.

Schedule Groups tree

Navigating the system

To navigate to an item in the system

On a Graphics page On a Properties page

Tree icons and hover text

System Area Equipment

Schedule Groups Reports Privileges

To turn on optional icons:

To turn on hover text:

To show, hide, or resize the navigation tree

On a computer or large screen mobile device

Viewing vector graphics

Select in to see this button Click button to...

N/A Scroll through areas one at a time.

GoogleTM NexusTM and Nexus Lumia

A tree item The action pane

Touch and then select Print.

Colors and status in the WebCTRL® interface

Color Color Name Status Code Condition Indicated

Colors and setpoints

If you when the zone but... then you will

Graphics pages (page 24)

• Equipment graphics show the current

Properties pages (page 29)

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

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

If the graphic is...

To get the graphic

To put the edited graphic back on the server

To organize multiple graphics for a tree item

To add a Graphics category in the WebCTRL® interface

To control equipment using an interactive zone sensor