Niagara AX Browser Access Guide
Niagara AX Browser Access Guide
Niagara AX Browser Access Guide
Copyright Notice
The software described herein is furnished under a license agreement and may be used only in accordance with the terms of the
agreement.
This document may not, in whole or in part, be copied, photocopied, reproduced, translated, or reduced to any electronic medium
or machine-readable form without prior written consent from Tridium, Inc.
The confidential information contained in this document is provided solely for use by Tridium employees, licensees, and system
owners; and is not to be released to, or reproduced for, anyone else; neither is it to be used for reproduction of this Control System
or any of its components.
All rights to revise designs described herein are reserved. While every effort has been made to assure the accuracy of this document,
Tridium shall not be held responsible for damages, including consequential damages, arising from the application of the information
contained herein. Information and specifications published here are current as of the date of this publication and are subject to
change without notice.
The release and technology contained herein may be protected by one or more U.S. patents, foreign patents, or pending applications.
Trademark Notices
BACnet and ASHRAE are registered trademarks of American Society of Heating, Refrigerating and Air-Conditioning Engineers.
Microsoft and Windows are registered trademarks, and Windows NT, Windows 2000, Windows XP Professional, and Internet
Explorer are trademarks of Microsoft Corporation. Java and other Java-based names are trademarks of Sun Microsystems Inc. and
refer to Sun's family of Java-branded technologies. Mozilla and Firefox are trademarks of the Mozilla Foundation. Echelon, LON,
LonMark, LonTalk, and LonWorks are registered trademarks of Echelon Corporation. Tridium, JACE, Niagara Framework,
NiagaraAX and Vykon are registered trademarks, and Workbench, WorkPlaceAX, and AXSupervisor, are trademarks of Tridium Inc.
All other product names and services mentioned in this publication that is known to be trademarks, registered trademarks, or
service marks are the property of their respective owners.The software described herein is furnished under a license agreement and
may be used only in accordance with the terms of the agreement.
CONTENTS
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Document Change Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
About This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Document Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Commonly Used Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
NiagaraAX-3.x
i
Browser Access Guide
May 30, 2007
NiagaraAX-3.x
ii
Browser Access Guide
May 30, 2007
NiagaraAX-3.x
iii
Browser Access Guide
May 30, 2007
NiagaraAX-3.x
iv
Browser Access Guide
CONTENTS
Preface
Document Change Log
Intended Audience
The following people should use this document:
• NiagaraAX system owners
• NiagaraAX end users
To get this most from this guide, you should already know how to use a computer and mouse. Previous
experience using a web browser such as Microsoft Explorer or Mozilla Firefox is also helpful, but is not
necessarily required.
Document Summary
This document contains the following chapters:
“Getting Started”—Topics include browser requirements, connection information needed, procedures to
connect and sign on the system, using basic browser controls, mouse and cursor behavior, and signing off
of the system.
“About Graphic (Px) views and commands”—Is about system graphics (Px Pages), including image and
text elements, visual alarm indication, and issuing commands.
“About Schedules”—Provides information on using the graphical views for scheduling. Included are
procedures to review and modify schedules, special events and holidays.
“About Alarms”—Covers standard browser access to alarms in the system, including procedures to
acknowledge these alarms.
“About Histories”—Covers viewing history log data in the graphical History Chart views, and History
maintenance views.
NiagaraAX-3.x
v
Browser Access Guide
About This Document
Related Documentation May 30, 2007
Related Documentation
The following documents are related to the content in this document and may provide addition infor-
mation on the topics it covers:
• NiagaraAX User Guide
• NiagaraAX Platform Guide
• NiagaraAX Provisioning Guide
Commonly Used Terms
Throughout this guide, references are made to acronyms and terms that might be unfamiliar to you. This
section provides definitions of some terms and is intended to ensure their consistent use.
browser Or web browser. This refers to an application like Microsoft Internet Explorer or Mozilla Fire-
fox, widely used to locate and display web pages.
click, double-click, right-click To click is to tap a mouse button, pressing it down and then imme-
diately releasing it. Clicking a mouse button is different from pressing (or dragging) a mouse button,
which implies that you hold the button down without releasing it. When used as an instruction, click
means to move the mouse pointer over that object and click the left mouse button (sometimes called but-
ton number one).
Some operations may require a double-click, which means that you click the (left) mouse button twice in
rapid succession. Some operations require that you click the right mouse button. By convention, 'clicking'
refers to the left mouse button. In this guide, the term right-click is used anywhere you need to use the
right mouse button.
clipboard A special memory buffer that is used to temporarily store data that is being copied to another
location. When you cut and paste data in a Windows application, you are removing the data from its
source location and placing a copy of it in this buffer area, then pasting it from the clipboard to its final
location (target).
dialog box or pop-up A graphical element (in the form of a box) used in Windows to display infor-
mation or request input. Typically, dialog boxes request information and pop-ups convey information.
They are both temporary - they disappear once you have entered the requested information and click OK.
folder Typically, this refers to a graphical representation of what used to be called a directory or subdi-
rectory. Folders can contain other folders and files of various types.
Px Page Graphics page, referring to the NiagaraAX view that contains images and/or text that update
(in real time) as a web page. A NiagaraAX system may have many Px Pages, with hyperlinks between each
other (as well as their sub-elements, such as schedules, holiday calendars, history charts, and so forth).
HTML HyperText Markup Language - the authoring language used to create documents on the World
Wide Web. HTML defines a set of codes that web browsers use to format web pages.
HTTP HyperText Transfer Protocol - the protocol used by the World Wide Web. HTTP defines how
web servers and browsers transmit and format messages, including actions commands. HTTP is called a
stateless protocol because each command is executed independently, without knowledge of the com-
mands that came before it. The other main standard that controls how the World Wide Web works is
HTML, which determines how web pages are formatted and displayed.
hyperlink An element contained on a web page that links the user to a different web page on the same
site or an entirely different site. Hyperlinks are also used as user controls in electronic documents that
take the user to another place on the current page or to a completely different document.
JACE controller Java Application Control Engine. (Rhymes with “space”.) The Tridium-manufac-
tured controller that runs the core runtime NiagaraAX software in a Java Virtual Machine (JVM), provid-
ing a station with direct support for field device integration plus enterprise LAN connectivity. Among
other duties, each JACE controller acts as a web server, with some models capable of directly serving their
own web graphics (Px or Hx Pages).
objects NiagaraAX stations are engineered using “components,” which have known properties, includ-
ing inputs and outputs used for sharing information and control. There are many types of components,
including container components and child components.
station A NiagaraAX station is a combination of services and processes that run in the JVM (Java Vir-
tual Machine) in a JACE controller or Web Supervisor PC. It is engineered and represented as a collection
NiagaraAX-3.x
vi
Browser Access Guide
About This Document
Related Documentation May 30, 2007
of components. A Web Supervisor station can archive data from other networked JACE controller sta-
tions in a database, and may also serves graphics. A JACE controller station provides access to (and inte-
gration of) various networked control devices, and may also serve graphic views to remote browsers.
SQL Structured Query Language. A database language widely-used for querying, updating, and manag-
ing relational databases.
URL Uniform Resource Locator. The global address of a document or other resource. To access your
system, you enter a URL in your browser’s address bar (location bar), typically with the “http://” prefix
and the IP address (or host name) of the target Web Supervisor or JACE controller. Various URLs used
for routine access to NiagaraAX stations are provided throughout this document.
view A generic term that applies to what you see in your browser, for example, calendar view, history
chart view, and so forth. Data can often be presented in several different views.
Web Supervisor Refers to a NiagaraAX station running on a PC, which is typically configured as the
Supervisor station for any networked JACE controller(s). Typically, this PC is also running the full suite
of NiagaraAX applications, including WorkplaceAX and the Alarm Console.
XML eXtensible Markup Language. A specification developed by the W3C (World Wide Web Consor-
tium). XML is a subset of SGML, designed especially for web documents. Use of custom tags provides
“extensibility”, not available using HTML. The NiagaraAX Framework uses XML as one method of sta-
tion database storage, also as an output option for text data (for example: logs, archives, and status que-
ries).
NiagaraAX-3.x
vii
Browser Access Guide
About This Document
Related Documentation May 30, 2007
NiagaraAX-3.x
viii
Browser Access Guide
CHAPTER 1
Getting Started
Special software is not necessary to access your NiagaraAX system. You can use the same web browser
that you already use to browse the Internet.
This chapter provides information and procedures to help you start exploring your NiagaraAX system.
The following main sections are included:
• “What You Need to Connect”
• “Connecting to the System (Signing On)”
• “Using Browser Controls”
• “Right-click (popup) menus”
Web Browser
You probably already have this. A “Java-enabled” browser is required—the typical configuration for most
modern browsers. For two popular browsers (Internet Explorer and Mozilla Firefox), the following proce-
dures describe parameter settingss that have proven most essential:
• “Setting browser options (Microsoft Internet Explorer )”
• “Setting browser options (Mozilla Firefox )”
NiagaraAX-3.x
1–1
Browser Access Guide
What You Need to Connect Chapter 1 – Getting Started
Your Connection Information May 30, 2007
NiagaraAX-3.x
1-2
Browser Access Guide
Chapter 1 – Getting Started Connecting to the System (Signing On)
May 30, 2007 Your Connection Information
Step 3 Type the host name (or host IP address) supplied by your NiagaraAX system administrator into the
address bar (location bar) in your browser, as shown in Figure 1-4.
You can include the leading http:// portion (or omit it if desired).
(Do not include “www” characters.)
NiagaraAX-3.x
1-3
Browser Access Guide
Connecting to the System (Signing On) Chapter 1 – Getting Started
Your Connection Information May 30, 2007
If your user name and password is not accepted, you are re-prompted (the popup dialog box remains with
the entered user name, but the password is cleared). Check your information, correct any errors, and try
again.
Note: Within any browser window, three logon tries are permitted before you receive a “401 Error: Access Denied.”
Note: It is possible that your system has been engineered to allow some “public access.”
If so, you may not be prompted for your user name and password, at least when first connecting. In this
scenario, however, it is likely that later you will be prompted (at some point while navigating your way
through the system). In this case, just enter your assigned user name and password and proceed as normal.
NiagaraAX-3.x
1-4
Browser Access Guide
Chapter 1 – Getting Started Using Browser Controls
May 30, 2007 Your Connection Information
These type of links have been engineered as part of the station database, meaning that your access was
“anticipated” (even more precisely, facilitated).
In addition to these links, you also use standard browser and windows controls, including the following:
• Back and Forward buttons”
Click on your browser's Back button to return to the previously viewed browser display. After using
the Back button, you can click on the Forward button to return again to the previous display.
In most browsers, Back and Forward buttons are in the upper left of the toolbar.
• Back—Click to back up one display.
• Forward—Click to return forward.
You can continue to click back or forward, as needed.
Note: Even if you click back to before your original (pre-sign-on) display, you should not have to sign
on again.
NiagaraAX-3.x
1-5
Browser Access Guide
Using Browser Controls Chapter 1 – Getting Started
Your Connection Information May 30, 2007
Figure 1-9 Example of a static table view that may require a periodic Refresh (Reload).
While viewing these displays, you may wish to periodically click on your browser's Reload button
to update the display—particularly if you have displayed the page using the Back or Forward but-
ton. Otherwise, you may be viewing values “cached” (stored) by the browser, instead of the latest val-
ues.
• Bookmarks
You can set and save browser bookmarks (Favorites) for any point during your access of your
NiagaraAX system. This allows you to return to a favorite display in your system directly whenever
you are using your browser. The following procedure describes how to add a Bookmark (or Favorite)
in your browser:
Step 2 In the Add a Favorite (Add Bookmark) dialog box, give the bookmark a descriptive name by typing
in the Name field. You can also organize your Favorites (Bookmarks) in existing folders or create new
folders from this same dialog box.
Step 3 Complete the Favorite (Bookmark) creation by clicking the OK button.
A dialog box disappears and the new Favorite (Bookmark) appears under the Favorites menu in the
appropriate folder.
NiagaraAX-3.x
1-6
Browser Access Guide
Chapter 1 – Getting Started Right-click (popup) menus
May 30, 2007 Command menus
Note: During a browser session in which you have not already signed into your system, and you select
a saved bookmark (into the system), you will be prompted first for your user name and password—just
like when you first accessed the system.
• Browser-window controls
When accessing your system, you should typically maximize your main browser window to ensure
you can see all parts of graphics and menus. Do this by simply double-clicking anywhere on the Title
Bar (the top of the browser window)—this acts as a toggle you can use to set the browser window
back to a re-sizeable window.
In some cases, especially if your display is less than XGA resolution (1024 x 768 pixels), even a max-
imized browser window might not be able to display the complete contents of a system-graphic or
menu. In this case, your browser window automatically provides scroll bars: either vertical, horizon-
tal, or both. Just click and drag on the scroll bar sliders, as needed, to view the complete area.
A highlighted element or bounding-box is the visual signal that a right-click, command menu may be
available for that object. (The menu appears only if you have the necessary command rights).
Note: Systems may be engineered so as not to show bounding-boxes or highlighting. In this case, you simply need
to “know” that a right-click command menu exists.
Command menus
You can right-click on any object that is “commandable” to see the associated popup menu, as shown in
Figure 1-12. If the menu appears, you have command rights. If you do not have rights to commands in
the popup menu, nothing will happen.
Caution Do not issue commands “just because you can.” You should understand how the commands affect your
system (and even more importantly) discuss this topic with your NiagaraAX system administrator, before
you issue commands.
NiagaraAX-3.x
1-7
Browser Access Guide
Types of special views Chapter 1 – Getting Started
Command menus May 30, 2007
• History
These views present historical data in several different ways, including: graphical charts, tabular, and
data-management views where you can build charts using multiple history files.
• Property sheet
For any selected component in the station, its property sheet view lists its available properties, where
some properties may be "child" containers-each "expandable" listing their own properties (and so
on).
Depending on your permissions, you may or may-not see all available properties. In addition, some
properties may be writable by some users, but read-only by other users.
• Wire sheet
A wire sheet view is available only if you have the "Default Wb Web Profile" and you have "admin
write" permissions on a component (typically, a folder). This advanced view lets you graphically add
and wire components together, to create control logic.
NiagaraAX-3.x
1-8
Browser Access Guide
Chapter 1 – Getting Started Types of Web profiles
May 30, 2007 Command menus
• Category sheet
Category sheet views are available only if you have the "Default Wb Web Profile" and you have "ad-
min write" permissions on components. This advanced view lists all categories in the station, and
shows a check mark beside any that are assigned to this component.
• Slot sheet
Slot sheet views are available only if you have the "Default Wb Web Profile" and you have "admin
write" permissions on components. This advanced view lists all slots (properties, actions, topics) for
a component, and allows you to set config flags, change display names, and even add new slots.
• Link sheet
Link sheet views are available only if you have the "Default Wb Web Profile" and you have "admin
write" permissions on components. This advanced view provides a tabular list of links out of (and
into) the selected component, and allows editing or deletion of links.
• Manager views
Various table-based manager views are available only if you have the "Default Wb Web Profile" and
you have "admin write" permissions on certain container components. These advanced views pro-
vide a tabular list of child components, and typically allow editing, creation, and deletion of sub-
components, and often other "job-based" operations.
NiagaraAX-3.x
1-9
Browser Access Guide
Types of Web profiles Chapter 1 – Getting Started
Default Wb Web Profile May 30, 2007
NiagaraAX-3.x
1-10
Browser Access Guide
Chapter 1 – Getting Started Status bar information
May 30, 2007 Default Hx Profile
Default Hx Profile
This profile uses a special “Hx” technology and provides a real-time user interface without the Java plugin
download. An example of the Default Hx Web Profile is shown in Figure 1-17.
Basic Hx Profile
This profile uses a special “Hx” technology. It provides a reduced set of features but includes real-time
user interface without the Java plugin download. An example of the Basic Hx Profile is shown in Figure 1-
18.
NiagaraAX-3.x
1-11
Browser Access Guide
Logging off (signing off ) the system Chapter 1 – Getting Started
Basic Hx Profile May 30, 2007
Figure 1-19 Status bar shows link destinations and other details related to cursor position.
Menu Items
• Data parameters
This control allows you to choose from a list of time options that filter the data that is displayed in
the table. These controls include Delta (for history logging) and Time Range settings.
• Delta reporting option
This option is useful for history logging, when you want to display value changes (delta) in your
report.
• Time range option list
NiagaraAX-3.x
1-12
Browser Access Guide
Chapter 1 – Getting Started Chart controls and options
May 30, 2007 Basic Hx Profile
This list has a variety of predefined time range options, including an option that allows you to
restrict your data presentation to a particular date and time range that you specify.
• Title bar
This area of the table displays the name of the data collection on the left side of the title bar and in
some tables (collection table, history table, alarm extension manager, and others) displays the total
number of records in the table on the right side of the title bar.
• Column headings
Each column of data has a title that indicates the data type.
• Column boundaries
Each column has a movable column boundary that can be used to re-size the column using the
mouse control. Stretch or shrink column width by dragging the column boundary, as desired. Use
the Reset column widths menu item to reset all column widths to their default size.
• Table Options menu
This menu is located in the top right corner of the table and provides one or more of the following
controls and options. The standard table options menu includes the following items:
• Reset column widths
This menu item sets all columns in the table to their default widths. This is useful if you manu-
ally changed widths of columns, and now some contents are hidden (even after scrolling).
• Export
This menu item opens the Export dialog box where you can choose to export the table to PDF,
text, HTML, or CSV (comma separated variable).
• Context-sensitive menu items
Additional context-sensitive menu items appear in the table options menu, depending on
the type of table that you are viewing. These additional menu items allow you to select or dese-
lect the item in order to display or hide the column data in the table.
Chart Title
Y Axis
Zoom Control
Charted Data
X Axis
• Data parameters
These controls include Delta (for history logging) and Time Range settings.
• Delta reporting option
This option is useful for history logging, when you want to display value changes (delta) in your
report. Checking the delta box causes the chart or table to be recalculated and replotted using
delta values. Instead of plotting the recorded values for each sample, the difference (delta) be-
tween the recorded values is plotted. This is useful when electrical consumption has been re-
corded as a totalized (summed) log and you want to display the amount of consumption that
was used during each sample interval.
• Time range option list
This list has a variety of predefined time range options, including an option that allows you to
restrict your data presentation to a particular date and time range that you specify.
• Chart Title
This area of the chart displays the name of the chart. This title is editable in the chart builder view.
• y Axis
Displays units for the y axis.
• x Axis
Displays units for the x axis.
NiagaraAX-3.x
1-13
Browser Access Guide
Beginner's FAQs (Frequently Asked Questions) Chapter 1 – Getting Started
Basic Hx Profile May 30, 2007
• Charted Data
The color of the line and type of line is editable in the chart builder view:
• Zoom Control
The zoom control appears when you drag the mouse cursor across the chart display area. The direc-
tion that you drag the mouse determines which axis gets “zoomed” in on. If you drag horizontally,
the zoom effect is in the horizontal axis only. If you drag the mouse vertically, the zoom effect is in
the vertical only. You can zoom multiple times if you want to, until you reach the maximum enlarge-
ment. You can also use the zoom controls to reduce the magnification amount, or to move the chart
left, right, up, or down.
NiagaraAX-3.x
1-14
Browser Access Guide
CHAPTER 2
About Graphic (Px) views and commands
System graphic views (technically called "Px views") provide real-time data using both images and text.
Usually these views are the main interface to your system, and provide links to other graphics and special
views-and possibly access to commandable "actions" via image and text elements. Each Px view can
display a screen with animated graphics that contain system information, as shown in Figure 2-1.
Animated graphics are graphics that change, or “update”, based on data values that come from object
sources that are connected (or “bound”) to them. A “graphic” can be as simple as a single word of text
(“ON”) or a number (“72”), or it can be an animated image (rotating fan). Most Px views are assembled
using a variety of elements, known as "widgets," that include graphic layout elements plus images and text
that are linked to real-time data. Widgets provide the graphic visualization of data in NiagaraAX, so
animated graphics are comprised of one or more widgets assembled in a Px file, available for display in
the browser.
About Widgets
“Widget” is the name given to special components that provide visualization in a NiagaraAX system.
System engineers use the NiagaraAX Px Editor to work with the widget properties in defining user
interface functions for control and information display. User-interface widgets can process input in the
form of mouse, keyboard, and focus events or they can be read-only displays of real-time data. These
features provide the tools for building rich user interfaces. Widgets include things such as charts and
graphs, tables of data, animated graphics, and even simple lines of animated, or continuously updating
text.
Widgets are animated by binding any widget property to a legitimate data source. This means that system
engineers can connect numeric values to widget properties that use numeric values and connect binary
values to objects that can use binary values. By animating the properties of a widget, the engineer can
control text and image appearance as well as change a widget’s location on the page and even its visibility.
Widgets in Px views typically include one or more "background" images, plus other images that may
represent various devices, buildings, or data presentations. Figure 2-2, shows a few examples of different
types of widgets.
NiagaraAX-3.x
2–1
Browser Access Guide
About Widgets Chapter 2 – About Graphic (Px) views and commands
May 30, 2007
Some images graphically represent different types of values. For example, in Figure 2-3, the fan is
"animated" (appears moving when on and not moving when off ). This display is a graphic representation
of a boolean (“on” or “off ”) value. The outside-air damper is also proportionally displayed (currently at a
87% open position). This is a graphic display of a numeric-type value (87%).
Typically, text-only widgets are used for both “labels” and for directly displaying values. Values appearing
in text may be formatted in different fonts and colors, as designed by the system designer. In Figure 2-3,
text widgets show temperature values, and are used for other values and labels too.
Besides showing analog values, text values may be binary (two-state) or multi-state (three-or-more
states). For example, a value may display as On or Off Slow, or Fast, Yes or No, or any needed state, as
shown in Figure 2-4.
NiagaraAX-3.x
2-2
Browser Access Guide
Chapter 2 – About Graphic (Px) views and commands Types of graphic status indicators
May 30, 2007
Figure 2-5 Graphic portion with two text elements currently displaying red (alarm)
If you (as a system user) are given alarm acknowledgment privileges and a link to the alarm display, you
may be able to find and acknowledge the associated fault alarm—this records the time, date, and user
(you) that acknowledged it. However, the element remains red until the fault condition is over.
• Fault (orange)
Fault status is indicated by black text on orange background .
Typically, this indicates an NiagaraAX configuration error or license error. If a fault occurs following
normal (ok) status, it could be a "native fault" condition detected within the device, or perhaps some
other fault criteria that was met.
Example Orange (fault) When a graphic element turns orange, it means that the object represented
currently has a fault status. Less common than alarm status, a fault usually means the value received from
a sensor or device is outside any reasonable (measurable) limits. This condition may occur from an open
NiagaraAX-3.x
2-3
Browser Access Guide
Types of graphic status indicators Chapter 2 – About Graphic (Px) views and commands
May 30, 2007
or shorted-connection in a sensor cable, for example. During this fault period, the element will remain
orange. The color may return to “normal” only when the fault condition no longer applies—in some cases,
an alarm status (red) color may be seen first.
Figure 2-6 Graphic portion with one text element currently displaying orange (fault).
• Down (yellow)
Down status is indicated by black text on yellow background .
This status usually means that communications to the parent device are currently lost, based upon
the device status (Monitor) configuration for that network.
Example Yellow (down) When a graphic element turns yellow, it means that communications are down
between the station and the device with the originating data. Although not typical, when this occurs
usually multiple elements in a display are yellow.
Figure 2-7 Graphic portion with text elements currently displaying yellow (down)
If you (as a system user) are given alarm acknowledgment privileges and a link to the alarm display, you
may be able to find and acknowledge an associated device down alarm—this records the time, date, and
user (you) that acknowledged it. However, elements remain yellow until device communications are re-
established.
Status colors (other)
• Overridden (magenta)
Override status is indicated by black text on magenta background .
An override means that the current point control is from a user-invoked command.
• Disabled (gray)
Disabled status is indicated by black text on light gray background .
This status means that the point (or its parent device or network) has been manually disabled.
• Stale (tan)
Stale status is indicated by black text on tan background
This status means that the associated point has not received the requested response for this data
item within an expected (preconfigured) amount of time.
• null (no color indication)
Null status is indicated by the word “null”.
This status means that the point control has entered a state without a value (null) as opposed to hav-
ing a specific value and priority level. This status is typically used for a “fallback” setting for a point.
NiagaraAX-3.x
2-4
Browser Access Guide
Chapter 2 – About Graphic (Px) views and commands Using actions (commands)
May 30, 2007 Priority of status indication
Actions that are available on the popup menu include different types of actions that have different priority
levels. For example, an Emergency Active action and an Active action are both “override” type
actions but Emergency Active has a higher priority that Active.
Figure 2-9 Example popup menu with actions and secondary dialog box
NiagaraAX-3.x
2-5
Browser Access Guide
Using actions (commands) Chapter 2 – About Graphic (Px) views and commands
Types of Actions May 30, 2007
Note: For some actions, another dialog box appears to allow you to type in the desired value.
Step 3 If a secondary popup or dialog box appears, type in the desired value and click the OK button.
The dialog box and popup menu disappear and the action is applied to the object.
Types of Actions
Actions include the following types:
• Override actions
Override actions involve the concept of “priority”. When you use an override action, you are chang-
ing an action setting at a certain priority level. If your new override setting has a higher priority than
the current setting priority level, then the new override takes effect. Override actions may be set at
Emergency or Normal priority levels and include the following types of override options:
• Permanent override
If an override is set as “permanent” it remains in effect until this override is removed using the
Auto option.
• Timed override
This is a temporary override that is effective for a defined length of time. You can select from
an option list of preset times or you can type in a custom time for the timed override.
• Auto
The Auto option removes any permanent or temporary override of equal or lower priority level
and allows the default value or any other input value to control the point.
• Set actions
Set actions are simply actions that allow you to define (“set”) a specific value at a point. When you
type in or choose a value for a “set” action, the value that you use is only in effect when the “auto”
option is in effect for that point. You can change a point value using the Set dialog box associated
with the Set menu option at the point.
Types of override actions
The following types of override actions are available, depending on the type of point you are controlling.
Note: For Boolean and for Enum (multi-state) type overrides, you should set (or at least review) the override value
or state first, and then issue the override action. During an active override, any changes that you make to
the override value are ignored until the next override.
• Boolean override
Figure 2-10 shows an example of the popup menu associated with a boolean control point.
The Boolean override is used to control a binary-type point, such as might be used to turn lights and
equipment on or off. The following override options are available at a boolean control point and are
listed, in order of priority, from lowest to highest priority level:
• Active—On or Start, this action sets a “true” value at the boolean control point.
• Inactive—Off or Stop, this action sets a “false” value at the boolean control point.
• Auto—Clears any values set previously using the Active or Inactive menu items. Auto
does not clear values set using the Emergency Active or Emergency Inactive menu
items.
• Emergency Active—On or Start, this action sets a “true” value at the boolean control point
at the highest priority level.
• Emergency Inactive—Off or Stop, this action sets a “false” value at the boolean control
point at the highest priority level.
• Emergency Auto—This action clears any previously issued command at the highest priority
(Emergency) level and returns control to the next-highest priority action (active or inactive).
• Numeric override
Figure 2-11 shows an example of the popup menu associated with a numeric control point.
NiagaraAX-3.x
2-6
Browser Access Guide
Chapter 2 – About Graphic (Px) views and commands Using actions (commands)
May 30, 2007 Types of Actions
The numeric override is used to control an analog-type point, such as might be used to manually set
or modify temperature setpoints, for example. The following override options are available at a nu-
meric control point and are listed, in order of priority, from lowest to highest priority level:
• Override—The override action sets a numeric value that you specify. Selecting this menu
item opens an Override dialog box, as shown in Figure 2-12. Choose a preset time option or
select Custom to set a specific time in the associated time field and click the OK button.
• Auto—Clears any values set previously using the Override action. Auto does not clear val-
ues set using the Emergency Override action.
• Emergency Override—This action sets a value at the numeric point at the highest priority
level. Selecting this menu item opens an Emergency Override dialog box, as shown in
Figure 2-13. Type in a numeric setting in the field, as desired and click the OK button.
• Emergency Auto—This action clears any previously issued action at the highest priority
(Emergency) level and returns control to the next-highest priority action.
• Enum writable (multi-state) override
Figure 2-14 shows an example of the popup menu associated with an enum (multi-state) control
point.
This type of override action might be used to control a multi-state device, such as a multiple-speed
fan or any other device that has an enumerated set of modes. The following override options are
available at an enum control point and are listed, in order of priority, from lowest to highest priority
level:
• Override— The override action sets a value that you choose from an option list. Selecting this
menu item opens an Override dialog box, as shown in Figure 2-15. Use a preset time option
or select Custom to set a specific time in the associated time field and click the OK button.
NiagaraAX-3.x
2-7
Browser Access Guide
Using actions (commands) Chapter 2 – About Graphic (Px) views and commands
Types of Actions May 30, 2007
Figure 2-15 Enum override dialog box (showing duration and value options)
• Auto—Clears any values set previously using the Override action. Auto does not clear val-
ues set using the Emergency Override action.
• Emergency Override—This action sets a value at the enum point at the highest priority
level. Selecting this menu item opens an Emergency Override dialog box, as shown in
Figure 2-13. Type a numeric setting in the field, as desired and click the OK button.
• Emergency Auto—This action clears any previously issued action at the highest priority
(Emergency) level and returns control to the next-highest priority action.
• String override
This type of override might be used to set a string value at a control point where custom text labeling
is allowed to be set from the browser user interface, for example.
The override is used to control string data at the point. The following override options are available
at a string control point and are listed, in order of priority, from lowest to highest priority level:
• Override— The override action sets a numeric value that you specify. Selecting this menu
item opens an Override dialog box, as shown in Figure 2-18. Use a preset time option or se-
lect Custom to set a specific time in the associated time field and click the OK button.
• Auto—Clears any values set previously using the Override action. Auto does not clear val-
ues set using the Emergency Override action.
• Emergency Override—This action sets a value at the numeric point at the highest priority
level. Selecting this menu item opens an Emergency Override dialog box, as shown in
Figure 2-13. Type in a numeric setting in the field, as desired and click the OK button.
NiagaraAX-3.x
2-8
Browser Access Guide
Chapter 2 – About Graphic (Px) views and commands Using actions (commands)
May 30, 2007 Types of Actions
• Emergency Auto—This action clears any previously issued action at the highest priority
(Emergency) level and returns control to the next-highest priority action.
Set actions
Set actions are used to “set” a value at a control point using a graphic element in your browser display. Set
actions are permanent unless they are overridden by an override action or an input from a different
source at a higher priority level. The value at a control point returns to the “set” value (or “fallback” value)
when a temporary override action (timed) expires or if the override is removed (set to “auto”). Figure 2-
20 shows an example of the popup menus associated with the various types of control points.
When you select Set from the popup menu, the associated dialog box displays, as shown in Figure 2-21.
Each dialog box is specific for the type of control point (and associated data).
Each control point type has an associated Set action which is described in the following list.
• Numeric Set—Set a value for a control point associated with numeric data. A secondary popup
dialog box displays the current value, which you may override by typing a different value or selecting
a different option and clicking the OK button.
• Boolean Set—Set a value for a control point associated with boolean data. A secondary popup
dialog box displays the current value, which you may override by selecting a different value option
(On/Off, True/False, or similar) and clicking the OK button.
• Enum (multi-state) Set—Set a value for a control point associated with enumerated data. A
secondary popup dialog box displays the current value, which you may override by selecting a differ-
ent value option (Slow, Medium, Fast, or similar options) and clicking the OK button.
• String Set—Set a value for a control point associated with string data. A secondary popup dialog
box displays the current value, which you may override by typing in a different string value and click-
ing the OK button.
Other control actions
Depending on the type of object a Px widget is bound to, other types of control actions may be available.
Typically, such actions have been given a descriptive right-click menu command.
NiagaraAX-3.x
2-9
Browser Access Guide
Using actions (commands) Chapter 2 – About Graphic (Px) views and commands
Types of Actions May 30, 2007
NiagaraAX-3.x
2-10
Browser Access Guide
CHAPTER 3
About Schedules
Schedules provide regular time-of-day, day-of-week control for controlling equipment such as lights,
fans, and pumps. Schedules may reside in either a Web Supervisor station or in a JACE controller station.
A station may contain many different schedules, or relatively few (one schedule can control many devices
or systems).
Types of schedules
There are three types of schedules; one or all of them may be used and available in your particular
interface. Figure 3-2 shows an example of each of the following schedule types:
NiagaraAX-3.x
3–1
Browser Access Guide
Types of schedules Chapter 3 – About Schedules
Common schedule characteristics and properties May 30, 2007
• Weekly Schedule
The Weekly Schedule defines regular, repeating, events by “time-of-day” and “day-of-week.” Also,
you can configure any number of “special events” within a Weekly Schedule. The Weekly Schedule
is typically the most commonly used type of schedule. For more information about the Weekly
Schedule, refer to “Weekly Schedule tabs” on page 3-4.
• Calendar Schedule
The Calendar Schedule is available to define specific days. Typically, you use them to define partic-
ular days that have scheduling exceptions (for example, holidays) so that you can reference them in
the “Special Events” tab setup of Weekly Schedules. For more information about the Calendar
Schedule, refer to “Weekly Schedule tabs” on page 3-4.
• Trigger Schedule
You can use a Trigger Schedule to schedule the firing of topics, such as resetting a run time accumu-
lator to zero at the beginning of each month. Unlike using a Weekly Schedule, which has specific on
and off event times, the Trigger Schedule sends a command to execute at the event time. For more
information about the Trigger Schedule, refer to “About Trigger Schedules” on page 3-17.
TriggerSchedule provides a two-part view combining a “day picker” and an event “time picker” for
specifying when topics are fired on those days.
Caution Always save the current schedule view before changing views (clicking another link) and before refreshing
the current page (using either the schedule view Refresh button or the Browser refresh button). Any unsaved
information is lost when the page is refreshed.
Note: For Weekly Schedules, you should usually save while working in each tab, even though any
save applies to changes made on all tabs.
NiagaraAX-3.x
3-2
Browser Access Guide
Chapter 3 – About Schedules About the Weekly Schedule
May 30, 2007 Weekly schedule output processing
Note: The Refresh and Save buttons apply to all tabs in the Weekly Schedule view (not just the one displayed).
NiagaraAX-3.x
3-3
Browser Access Guide
About the Weekly Schedule Chapter 3 – About Schedules
Weekly Schedule tabs May 30, 2007
NiagaraAX-3.x
3-4
Browser Access Guide
Chapter 3 – About Schedules About the Weekly Schedule
May 30, 2007 Weekly Schedule tabs
as low, medium, or high settings or even setting one or more devices, such as a thermostats, to specific
numeric values for certain days and times. These different types of control applications affect what type
of schedule properties you see in your Weekly Schedule tab, as shown in Figure 3-5.
The following list describes four types of Weekly Schedule data:
• Boolean
This type of Weekly Schedule allows you to set a “True” or “False” state which usually relates to an
“On” or “Off” condition. By editing the facets on the Properties tab, you can change the “True” value
to display as “On”, for example.
• Enum
Note: When using Enum schedules you must first have a defined range facet set up. If not already
set, you can do this using the Schedule’s Properties tab tab. See “Facets” on page 3-11 for more details.
This type of Weekly Schedule allows you to choose from a range of predefined values. By editing the
facets on the Properties tab, you can change the value options that are displayed in the Weekly
Schedule tab.
• String
This type of Weekly Schedule allows you to type in a text string to use as an output.
• Numeric
This type of Weekly Schedule allows you to type in a numeric value to use as an output.
Using the Weekly Schedule tab The following sections describe how to use the Weekly Schedule tab
to:
• Schedule Events
• “Tune” event times
• Set output values
• Use the right-click (popup) menus
Schedule Events To add a new schedule event to the Weekly Schedule tab, simply click in a day at the
approximate event start time, and drag downward to define the start and finish time (Figure 3-6). To edit
an existing event, drag the event’s top or bottom edge to change its start or finish time (in broad incre-
ments). Figure 3-6 shows an example of dragging in the day column to adjust the finish time of an event.
The event displays dark blue when it is selected (as indicated by dark blue). The event remains selected
until you refresh the display using the Refresh button or by selecting another area or tab.
Figure 3-6 Click and drag to enter weekly events in the Weekly Schedule tab
“Tune” event times With any event selected, “fine tune” its start and finish time using the controls,
selecting the hours portion or minutes portion (Figure 3-7). Or, click and type values in directly.
NiagaraAX-3.x
3-5
Browser Access Guide
About the Weekly Schedule Chapter 3 – About Schedules
Weekly Schedule tabs May 30, 2007
Note: For any event, start time is inclusive, and the event extends to (but is exclusive of ) the end time. In other
words, there is no output “blip” between adjacent events, even if across days. For example, if a Monday
event ends at midnight, then a Tuesday event starts at midnight, the schedule output is continuous
(providing both events have the same Set output values).
Set output values For any event, you can select the “null” checkbox (the schedule’s calculated value is
null for that event). However, you typically select or type a value instead, as follows:
• If your schedule uses Boolean or Enum data (refer to “Types of Weekly Schedule data” for informa-
tion about these types of data) select the event value in the output field, see Figure 3-8, left.
Note: If an EnumSchedule, first specify its facets (on Properties tab tab) before entering values. This
allows selection of possible values.
• If your schedule uses numeric of string data (refer to “Types of Weekly Schedule data” for informa-
tion about these types of data), type the value in the output field, then press Enter to register it in the
event block, as shown in Figure 3-8, right.
Figure 3-8 Select (Boolean, Enum) or type (Numeric, String) output value
Use the right-click (popup) menus Right-click in the Weekly Schedule area for an event menu. If you
have any event selected, this menu provides the most commands, as shown in Figure 3-9.
Event menu options are straightforward, and may include the following:
• Delete Event — Deletes the selected event.
• Paste Day — Appears only if copy day option was used first. Copies all events into selected day.
• All Day Event — Makes currently selected (or last entered) event extend to entire day.
• Apply M-F — Copies all events in the selected day to Mon, Tue, Wed, Thu, and Fri (and overwrites
any existing events on those days).
• Copy Day — Copies all events in the selected day, to use with paste day option.
• Clear Day — Clears all events in the selected day.
• Clear Week — Clears all events in the entire Weekly Schedule.
NiagaraAX-3.x
3-6
Browser Access Guide
Chapter 3 – About Schedules About the Weekly Schedule
May 30, 2007 Weekly Schedule tabs
Additional details about the Special Events tab are described in the following sections:
• About special events
• Adding special events
• Event times and output values
• Special event priorities
• Right-click menus and other controls
About special events Special events apply to Weekly Schedules only, and are considered any exception
to the (normal) Weekly Schedule. Special events can be “one-time” only event changes or recurring event
changes, such as holidays. Configuration includes both day(s) of occurrence and related time-of-day
events.
In the time-of-day event definitions of special events, you can have them “intermingle” with regular
weekly events, or completely override the Weekly Schedule. In addition, you visually prioritize special
events, via list order. This allows any overlapping special events to occur in an ordered fashion.
Each individual Weekly Schedule has its own special events, configured on the Special Events tab. Event
times (and values) entered for any special event apply to that schedule only. However, if the special event
is a “reference” type, days of its occurrence are specified in the Calendar Schedule that is referenced. This
allows you to globally change the days that special events occur in Weekly Schedules, by editing one or
more referenced Calendar Schedules. For more details, see “Calendar Schedule usage” on page 3-13.
Adding special events Click the Add button to add a new special event. An Add dialog appears, as
shown in Figure 3-11.
NiagaraAX-3.x
3-7
Browser Access Guide
About the Weekly Schedule Chapter 3 – About Schedules
Weekly Schedule tabs May 30, 2007
After you have a name and type selected (and defined as needed), click OK to add it to this schedule’s
special events. It remains selected for further editing, except for type.
Event times and output values A newly-created special event has no events defined. With the special
event selected, click in the right-side events column and enter events as necessary. Start, finish, and
output controls work the same as in the Weekly Schedule tab tab. See ““Tune” event times” on page 3-5
and “Set output values” on page 3-6 for details.
You can also right-click in the column for an event menu, as shown in Figure 3-13. This is useful to add
an all-day event or set the entire day to the schedule’s default value.
NiagaraAX-3.x
3-8
Browser Access Guide
Chapter 3 – About Schedules About the Weekly Schedule
May 30, 2007 Weekly Schedule tabs
Note: You must specify events for any special event to occur. Where nothing is scheduled, the special event relin-
quishes control back to any lower-priority schedule events, and finally “intermingles” with the Weekly
Schedule. To completely override the Weekly Schedule, configure a special event for the entire day.
Special event priorities All special events take priority over regular weekly events. Among special
events, you define relative priorities by the order of listing in the Special Events table, as follows:
• Highest priority is at top of list. Events in this special event, when active, always occur.
• Lowest priority is at bottom of list. Events occur only if not overlapped by other special events active
during the same period.
Change a special event’s priority by selecting it and using the priority arrow buttons (Figure 3-14).
Right-click menus and other controls Right-click in the special events table for a menu. If you have any
special event selected, this menu provides the most commands, as shown in Figure 3-15.
Special event menu options are straightforward, and may include the following:
• Add — Add a new special event (same as using Add button).
• Edit — Edit day(s) selection criteria (but not changing special event type). Same as Edit button.
• Rename — Rename selected special event (same as using Rename button).
• Priority (up) — Move special event up in priority list (same as using Priority button).
• Priority (down) — Move special event down in priority list (same as using Priority button).
• Delete — Removes selected special event from the schedule.
Note: When you delete a special event, a confirmation dialog appears as shown in Figure 3-16.
NiagaraAX-3.x
3-9
Browser Access Guide
About the Weekly Schedule Chapter 3 – About Schedules
Weekly Schedule tabs May 30, 2007
Note: A special event must have at least one defined event action to be highlighted in a calendar.
Return to the current calendar month and day by clicking the Today button.
Properties tab
As shown in Figure 3-18, this tab in About the Weekly Schedule is where you specify the schedule’s:
• Effective Period
• Default Output
• Facets
• Cleanup Special Events action
NiagaraAX-3.x
3-10
Browser Access Guide
Chapter 3 – About Schedules About the Weekly Schedule
May 30, 2007 Weekly Schedule tabs
Effective Period By default, a Weekly Schedule is always “in effect” because of the “Any...” settings.
Whenever a schedule is not effective, its output goes to its default output value, regardless of its Weekly
Schedule or any special events.
In most cases, you leave Weekly Schedules as always effective. However, if you have an application for a
schedule effective only at certain times, use the “start” through “end” range fields to limit the effective
period. When you save the changes, only effective days in the calendar months are shown highlighted
green.
Default Output Whenever a schedule event (special or weekly) is not defined, the schedule output value
is set to this “default” value. The white area in listed events (Figure 3-19) displays the current default
value. The default output value is also used whenever the schedule is not effective.
Note that “null” is an available choice—depending on control logic, this may be a valid choice.
Null means that no value is output from the schedule. The original default “Default Output” varies by
schedule type (see “Types of Weekly Schedule data” on page 3-4), as follows:
• BooleanSchedule — false
• EnumSchedule — null
• NumericSchedule — null
• StringSchedule — null
Facets The schedule facets determine how its output value is formatted for display. For example, instead
of “true” and “false” for a BooleanSchedule, you may need “On” and “Off ” instead. Assigned facets appear
in schedule views when adding events, displaying summary data, and so on.
Note: Facets are especially important for Enum type schedules. You need to define “range” facets before you add
Weekly Schedule events (in order to pick an event’s enumerated value). Range facets should match those
used in any controlled (output-linked) points.
In the case of string type schedules, facets have no application.
Figure 3-20 shows output selections for an Enum type schedule.
Figure 3-20 Facets determine event value selections for Enum type schedules
NiagaraAX-3.x
3-11
Browser Access Guide
About the Weekly Schedule Chapter 3 – About Schedules
Weekly Schedule tabs May 30, 2007
Figure 3-21 Summary tab shows all events for any selected day
NiagaraAX-3.x
3-12
Browser Access Guide
Chapter 3 – About Schedules About Calendar Schedules (holidays)
May 30, 2007 Calendar Schedule usage
For example, Figure 3-22 shows a Weekly Schedule and a portion of its special events tab, listing four
special events. Three of these are “Reference” types, meaning their calendar day(s) are defined remotely
in the configuration of the referenced Calendar Schedules. Although all special event links are shown
here in the same container (“.../HousingUnit”), quite often Calendar Schedules are located elsewhere in
the station.
Calendar Schedule usage by “special event reference” allows global changing of day definitions, where
many Weekly Schedules can reference one or more Calendar Schedules. Any edit of a Calendar Schedule
affects all Weekly Schedules containing a special event that references it.
NiagaraAX-3.x
3-13
Browser Access Guide
About Calendar Schedules (holidays) Chapter 3 – About Schedules
Calendar Schedule view May 30, 2007
As shown in Figure 3-23, existing calendar events (if any) are listed in the table by name and summary.
When you select a calendar event, its day(s) of occurrence are highlighted in green in the monthly
calendars at the top of the view.
Additional Calendar Schedule topics include:
• Adding calendar events
• Right-click menus and other controls
Adding calendar events
Click the Add button to add a new calendar event. An Add dialog appears, as shown in Figure 3-24.
NiagaraAX-3.x
3-14
Browser Access Guide
Chapter 3 – About Schedules About Calendar Schedules (holidays)
May 30, 2007 Calendar day selections
After you have a name and type selected (and defined as needed), click OK to add it to this calendar’s days.
It remains selected for further editing, except for type.
Right-click menus and other controls
Right-click in the calendar events table for a menu. If you have any calendar event selected, this menu
provides the most commands, as shown in Figure 3-25.
Note: Priority selections (right-click menu or in bottom buttons) only affect the list order for events in a Calen-
darSchedule—true priority applies only to special events (in Weekly Schedules).
Calendar event menu options are straightforward, and may include the following:
• Add — Add a new calendar event (same as using Add button).
• Edit — Edit day(s) selection criteria (but not changing calendar type). Same as Edit button.
• Rename — Rename selected calendar event (same as using Rename button).
• Priority (up) — Move calendar event up in display list (same as using Priority button).
• Priority (down) — Move calendar event down in display list (same as using Priority button).
• Delete — Removes selected calendar event from the schedule.
Note: When you delete a calendar event, a confirmation dialog appears as shown in Figure 3-26.
NiagaraAX-3.x
3-15
Browser Access Guide
About Calendar Schedules (holidays) Chapter 3 – About Schedules
Calendar day selections May 30, 2007
NiagaraAX-3.x
3-16
Browser Access Guide
Chapter 3 – About Schedules About Trigger Schedules
May 30, 2007 Trigger Schedule view
Each criteria offers an “any” selection, in addition to a specific selection (weekday, week-in-month,
month-of-year). In addition, the following criteria offer additional selections, as follows:
• week-in-month: last 7 days
• month-of-year:
• Jan-Mar-May-Jul-Sep-Nov
• Feb-Apr-Jun-Aug-Oct-Dec
The result is from “ANDing” the criteria. For example, as shown in Figure 3-29, if selections are for
weekday as Monday, the month as February, and the week as 3, the event occurs only on the third Monday
in February.
Custom selection notes
As shown in Figure 3-30, Custom calendar selection has 5 criteria: day-of-month, month-of-year,
weekday, week-in-month, and year.
Unlike with other calendar types, you can make multiple selections within each criteria (except if you
select “any,” which allows only that selection). To select multiples, first select something other than “Any,”
then hold down the Ctrl or Shift key while you select more values.
Each criteria offers an “any” selection, in addition to a specific selection. In addition, the following criteria
offer additional selections, as follows:
• day-of-month:
• Last Day
• Last 7 Days
• week-in-month: Last 7 Days
Within any criteria, selections are “OR’ed.” The overall result is from “AND’ing” all criteria. For example,
Figure 3-30 shows a custom selection for U.S. General Election Day, which must be configured as the
“first Tuesday after the first Monday in November.”
NiagaraAX-3.x
3-17
Browser Access Guide
About Trigger Schedules Chapter 3 – About Schedules
Trigger Schedule view May 30, 2007
NiagaraAX-3.x
3-18
Browser Access Guide
Chapter 3 – About Schedules About Trigger Schedules
May 30, 2007 Trigger Schedule view
Set the desired time in the hour:minute editor, either by clicking up/down controls or typing in times
directly. Click the Add button to add a trigger at that time, which adds it to the list. You can also enter
multiple triggers simultaneously, using the Range option.
Range option To add multiple triggers that occur at a repeating interval, select the Range checkbox. This
enables the Range End and Range Interval fields for entering values, as shown in Figure 3-34.
When entering a trigger range, note that the top (hour:minute) editor acts as the first (or Range Begin)
trigger time. By default, the Range Interval is set to one hour (“+00001h 00m 00.000s”). You can set this
to whatever interval is needed.
To delete a trigger time, click to select, then click the Remove button. To select multiple trigger times,
hold down the Ctrl or Shift key while you select.
NiagaraAX-3.x
3-19
Browser Access Guide
Using schedules and calendars Chapter 3 – About Schedules
Using Weekly Schedules May 30, 2007
Note: Priority selections (right-click menu or in bottom buttons) only affect the list order for events in a Trigger-
Schedule—true priority applies only to special events (in Weekly Schedules).
Event menu options are straightforward, and may include the following:
• Add — Add a new calendar event (same as using Add button).
• Edit — Edit day(s) selection criteria (but not changing calendar type). Same as Edit button.
• Rename — Rename selected calendar event (same as using Rename button).
• Priority (up) — Move calendar event up in display list (same as using Priority button).
• Priority (down) — Move calendar event down in display list (same as using Priority button).
• Delete — Removes selected calendar event from the schedule.
Note: When you delete a calendar event, a confirmation dialog appears as shown in Figure 3-36.
NiagaraAX-3.x
3-20
Browser Access Guide
Chapter 3 – About Schedules Using schedules and calendars
May 30, 2007 Using Weekly Schedules
NiagaraAX-3.x
3-21
Browser Access Guide
Using schedules and calendars Chapter 3 – About Schedules
Configuring Calendar Schedules May 30, 2007
NiagaraAX-3.x
3-22
Browser Access Guide
CHAPTER 4
About Alarms
Alarms notify personnel that a predefined set of parameters has been met. Also, alarm records record
certain conditions or system properties that are present when any monitored point is out of “normal”
parameters. The “normal” parameters for an individual point are properties that may be set and edited,
as desired, by a user with proper access and privileges. Typically, an alarm provides some visual and
audible indication that a limit or value is met or exceeded. Alarm notifications may be routed and
displayed in a variety of ways, including the following:
• alarm console (Workbench or browser-based)
• email
• line printer
• remote station(s)
In addition, in some applications, alarm “portals” are available to simultaneously monitor alarms from
one or more remote stations.
Alarm examples
The following are examples of possible ways that alarms are used:
• Out of operating range notification (offNormal)
An alarm is most commonly used to indicate that some value is not within an appropriate or expect-
ed range. For example, normal operating temperature range of a device may be 70 to 100 degrees F.
You can set the “out of range” parameters to generate an “alarm” if the operating temperature ex-
ceeds the upper limit or goes below the lower limit of this range.
• Advisory notification (alert)
You may use an alarm in situations to report on a parameter that does not really have a “normal”
state. For example, a motor may require lubrication after every 400 hours of operation (this is not an
“out of range” condition). Using the alert function, a system integrator can setup an control point
that monitors accumulated device run-time and sends an email alert notification at or before the 400
hours run-time has occurred.
• Device fault notifications (fault)
Some devices may report values that are so far out of range that it is obvious that there is a device or
system “fault” that needs attention. For example, if a device with a normal operating temperature of
between 70 to 100 degrees reports a temperature of 0 degrees F or 1000 degrees F, then it is probable
that there is a device or system fault and that the reported temperature is not the actual temperature
at the device. The system engineer or supervisor can set parameters and enable alarms for a separate
notification for values that are judged to be “faults” as opposed to simply “out of range”.
This chapter includes the following topics that describe alarming in terms of:
• Alarm concepts
• Alarm views
• Alarm tasks
Alarm concepts
This section describes the following alarm concepts:
• Types of alarms
• Types of alarm Source States
• Types of alarm Ack States
• About alarm data
• About alarm class
NiagaraAX-3.x
4–1
Browser Access Guide
Alarm concepts Chapter 4 – About Alarms
Types of alarms May 30, 2007
Types of alarms
Alarms may originate from different types of control points, using different types of data and may
represent an alarm state for a variety of reasons. The following list provides a short description of
different types of alarms:
• Out of range (numeric)
This type of alarm provides alarming based upon numeric high and low limits that you set. For ex-
ample, temperature values that are outside of a defined temperature range may generate an alarm
when alarming is enabled for that point.
• Change of state (boolean)
This type of alarm provides alarming based upon one of two possible values (state) as an alarm con-
dition. For example, any time a device is turned off, the state change from ON to OFF could generate
an alarm, if alarming is enabled for that point.
• Command failure (boolean)
This type of alarm provides alarming based upon a mismatch between a commanded value and ac-
tual (sensed) value. For example, if a device is commanded to turn on but does not come on (or is
sensed to have not come on) an alarm is generated.
• Change of state (enum)
This type of alarm provides alarming based upon one of several possible values (state) as an alarm
condition. For example, any time a device is commanded to change state, the state change from OFF
to LOW, Medium, or High (for example) could generate an alarm, if alarming is enabled for that
point.
• Command failure (enum)
This type of alarm provides alarming based upon a mismatch between a commanded value and ac-
tual (sensed) value. For example, if a device is commanded to change from a Low to High state but
the device does not change that state (or is sensed to have not changed to the correct state) an alarm
is generated.
• Status
Provides alarming based upon any one or more specified status flags. For example, a Status Alarm
can be generated if any one or more of the following status conditions are specified as “offnormal”
or “fault” conditions: disabled, fault, down, alarm, stale, overridden, null, unacknowledged (unacked)
alarm.
NiagaraAX-3.x
4-2
Browser Access Guide
Chapter 4 – About Alarms Alarm concepts
May 30, 2007 Types of alarm Ack States
NiagaraAX-3.x
4-3
Browser Access Guide
Alarm concepts Chapter 4 – About Alarms
About alarm class May 30, 2007
About notes
Notes are simple text entries that are associated with a particular alarm. It is possible to add a Note to one
alarm or to multiple alarms. Alarm records that have notes are indicated by a “note” icon”. Refer to “Notes
dialog box” on page 6 for more information about Notes.
NiagaraAX-3.x
4-4
Browser Access Guide
Chapter 4 – About Alarms Alarm views
May 30, 2007 Common alarm controls and indicators
Alarm views
This section describes the alarm views as well as the controls and options that are common to one or
more of the views. The following topics are included:
• Common alarm controls and indicators
• About the alarm console
• About the Instructions Manager view
• About the alarm database maintenance view
NiagaraAX-3.x
4-5
Browser Access Guide
Alarm views Chapter 4 – About Alarms
About the alarm console May 30, 2007
The alarm console manages alarms on a per–point basis, which means that each row in the alarm console
is the most recent alarm from a point. To view all the current alarms or to get more details about a
particular alarm from that point, double click on a record and use the Open Alarm Sources - details view.
Filters dialog box
The Filters dialog box displays parameters, as shown in Figure 4-2, that you can use to include or
exclude alarms from the alarm console by selecting or deselecting parameters. This filter action only
affects which alarms display in the alarm console, it does not edit any alarm record data or perform any
alarm “maintenance”.
You can choose, for example, to filter out any alarms in the alarm console that are currently in a “Normal”
state by selecting the “Source State” check box and then selecting all states except “Normal” and clicking
the OK button. This action filters out all alarm records that have “Normal” current Source States. If the
source state changes or if you change the settings in the Filters dialog box, the alarm console table will
update to change the display, as indicated.
Note: It is important to remember that the settings do not reset automatically—you must remove any filters that
you set in order to view all alarm records.
Notes dialog box
Use the Notes dialog box to add a note to one or more alarms. To add a note to all the alarms from a
selected source, open the Notes dialog box directly from the alarm console view, using the Notes
button. If the selected alarm record represents a source with multiple alarms, any note that you add is
added to all the alarms associated with that alarm source. When there is more than one alarm associated
with an alarm record, the Notes dialog box displays a <Multiple Alarms> message, as shown in Figure 4-3.
NiagaraAX-3.x
4-6
Browser Access Guide
Chapter 4 – About Alarms Alarm views
May 30, 2007 About the alarm console
Figure 4-4 Opening the Notes dialog box from the Alarm Record dialog box
NiagaraAX-3.x
4-7
Browser Access Guide
Alarm views Chapter 4 – About Alarms
About the alarm console May 30, 2007
The following control buttons are located at the bottom of the dialog box, below the detailed alarm data
information:
• Acknowledge
• Hyperlink
• Notes
• Close
Refer to “Common alarm controls and indicators” on page 4-5 for details about using these buttons.
NiagaraAX-3.x
4-8
Browser Access Guide
Chapter 4 – About Alarms Alarm views
May 30, 2007 About the Instructions Manager view
NiagaraAX-3.x
4-9
Browser Access Guide
Alarm views Chapter 4 – About Alarms
About the alarm database maintenance view May 30, 2007
Figure 4-7 Instructions Manager view with one point and one master instruction selected
NiagaraAX-3.x
4-10
Browser Access Guide
Chapter 4 – About Alarms Alarm tasks
May 30, 2007 About the alarm database maintenance view
The following control buttons are located at the bottom of the dialog box, below the detailed alarm data
information:
• Acknowledge
• Hyperlink
• Notes
• Close
Refer to “Common alarm controls and indicators” on page 4-5 for details about using these buttons.
Alarm tasks
The following tasks are common procedures used to manage alarms in a system.
• Acknowledging alarms from the alarm console view
• Viewing alarm notes
• Adding alarm notes
• Silencing alarms
• Filtering alarms in the Alarm view
• Viewing individual alarm record properties
• Viewing individual open alarm sources
• To delete alarm records
• To acknowledge alarms from the alarm console view
NiagaraAX-3.x
4-11
Browser Access Guide
Alarm tasks Chapter 4 – About Alarms
About the alarm database maintenance view May 30, 2007
Step 2 In the Open Alarm Sources pane, select one or more alarm sources that you want to acknowledge.
Select multiple alarms using the Shift or Ctrl key.
Note: Each record that appears in the alarm console table represents one alarm source and one or more alarms
from that source. You may acknowledge either the latest (most recent) alarm or acknowledge all alarms
that are reported from that source by choosing either the “Acknowledge” command or the “Acknowledge All”
command, as described in the following step.
Step 3 Acknowledge selected alarm(s) by doing one of the following:
• At the bottom of the Open Alarm Sources pane, click the Acknowledge button (to acknowl-
edge all alarms associated with the selected alarm sources)
OR
• Right click on any selected alarm and select Acknowledge Most Recent from the popup menu.
The selected alarms are acknowledged.
Silencing alarms
A silenced alarm sounds again if the screen is refreshed.
To silence an alarm, do the following:
• Click the Silence button in the Alarm Console view.
The audio alert is silenced for the current session of the Alarm Console view.
Note: The Silence mode is cancelled if the Alarm Console view is refreshed. This includes any time you use the
Filter button to update or change Alarm Console view data.
NiagaraAX-3.x
4-12
Browser Access Guide
Chapter 4 – About Alarms Alarm tasks
May 30, 2007 About the alarm database maintenance view
NiagaraAX-3.x
4-13
Browser Access Guide
Alarm tasks Chapter 4 – About Alarms
About the alarm database maintenance view May 30, 2007
NiagaraAX-3.x
4-14
Browser Access Guide
CHAPTER 5
About Histories
In NiagaraAX, a data log is referred to as a history. Histories are ordered collections of timestamped
records. A single “history” is a collection of specific data values from a point within any station - local or
remote. Histories are organized (or grouped) by their source station (device).
History examples
The following examples illustrate possible ways that histories are used:
• Intervals
Control points that are configured to collect history data have properties that may be set to record
this data at specific time intervals. For example, in a manufacturing facility, a control point may be
configured to record conveyor belt speed every 15 minutes. In this case, the history data is collected
and timestamped to identify the belt speed values at each 15 minute interval. The history records
may then be displayed in various different views, including tables and charts.
• Change of value
Control points are often configured to record data whenever there is a change in value at that control
point. A change in value may be defined as any of the following: a change in state—such as ON to
OFF, a change in a setting—from LOW to MEDIUM or HIGH, or it may be defined as any temper-
ature change greater than .03 degrees, for example. These parameters are set by a systems engineer
or integrator who “configures” the control point history properties. Timestamped history data is col-
lected and stored based on these “change of value” property settings. The history records may then
be displayed in various different views, including tables and charts.
The following topics describe user-related interfaces and interactions that are related to working with
histories:
• History concepts
• Types of history views
• History tasks
History concepts
The following history concepts are addressed
• Various History views
• Types of histories
• About history data
History views
When you access a NiagaraAX station from the browser, you may have access to a variety of views that
look different from the graphics in the topics presented here. Also, depending on your privilege level, the
history views that you can access and the tasks that you can perform, may vary. The following topics
address user interactions that are representative of what an average user may see when working with
histories.
NiagaraAX-3.x
5–1
Browser Access Guide
History concepts Chapter 5 – About Histories
Types of histories May 30, 2007
Types of histories
Histories may be associated with different types of control points using different types of data. The
following list provides a short description of the different types of histories:
• Interval (numeric)
This type of history records numeric history data at a specified time interval that can be set in hours,
minutes and seconds. For example, temperature values may be recorded at a control point every
hour, every 22 minutes or every 13 seconds, if desired.
• Change of value (numeric)
This type of history records numeric data whenever a control point value changes by an amount
greater than a specified “tolerance” amount or whenever there is a status change. The change toler-
ance amount may be zero or greater.
• Interval (boolean)
This type of history records boolean history data at a specified time interval that can be set in hours,
minutes and seconds. For example, ON or OFF equipment state values may be recorded at a control
point every hour, every 22 minutes or every 13 seconds, if desired.
• Change of value (boolean)
This type of history records boolean data whenever a control point value changes or when there is a
status change. For example, a history record can be created every time a control point detects the
state of a door going from OPEN to CLOSED.
• Interval (enum)
This type of history records enum (enumerated) history data at a specified time interval that can be
set in hours, minutes and seconds. For example, enum data could be something like Fan Speed
(LOW, MED, HIGH) values. These values may be recorded at a control point every hour, every 22
minutes or every 13 seconds, if desired.
• Change of value (enum)
This type of history records enum (enumerated) history data whenever a control point value changes
or when there is a status change.
• Interval (string)
This type of history records string history data at a specified time interval that can be set in hours,
minutes and seconds.
• Change of value (string)
This type of history records string history data at any time that the string data changes or on any sta-
tus change.
NiagaraAX-3.x
5-2
Browser Access Guide
Chapter 5 – About Histories History concepts
May 30, 2007 About history data
• Timestamp
This data field indicates the time that the recorded value occurred.
• Trend Flags
This data field displays trend flag information about the recorded data - for trend record types.
These flags provide extra context information about the record data. For example: “Start”,
“OutofOrder”, “Hidden”, “Modified”, and “Interpolated” are possible trend flags.
• Status
This data field displays the status of the history’s parent component; for example, “OK” or “null”.
• Value
This data field displays the record value.
NiagaraAX-3.x
5-3
Browser Access Guide
Types of history views Chapter 5 – About Histories
About the chart builder view May 30, 2007
NiagaraAX-3.x
5-4
Browser Access Guide
Chapter 5 – About Histories Types of history views
May 30, 2007 About the chart builder view
Drag and drop any available history (from the Histories pane) onto this area. Each history dis-
plays as a row in the pane with the following configurable options:
• Editable plot color icon allows you to change the plot color in the history chart.
• Chart Type option list allows you to select the type of plot that you want to use for each indi-
vidual history file (Line Chart, Area Chart, Pie Chart, or others).
• The “up” and “down” arrows allow you to rearrange the vertical order of the history files in the
pane. This also affects the display order in the History Chart legend.
• The “delete” icon allows you to remove a file from the Current Charts pane.
• Chart configuration options
Three option lists and a text field allow you to set the following parameters for a chart:
• Time Range
Select a time parameter option from the list, including an option that allows you to set a specific
time range using the Edit Time Range dialog box.
• Title
Type a title for your chart in this text field. This title is displayed at the top of the generated
chart.
• Grid Lines
Select yes or no to show or hide grid lines on the history chart.
• Histories pane
Select histories from this pane and drag them to the Current Charts pane, as desired. Histories
are grouped under the station that they originate from.
• Rollup
Use rollup options to create plots that display minimum, maximum, average, and the sum of
values. Rollup settings allow you to chart data at various intervals using the two rollup option
parameters:
– Interval option
The interval option allows you to choose an interval at which data is evaluated. Choose
None if you do not want to use the rollup function.
– Rollup option
These options allow you to choose how the data is to be treated.
• Current Charts pane
• Control buttons
The following buttons are located at the bottom of the view:
• Build button
Click this button to build the chart using the histories that are in the selected histories target
area.
• Clear button
this button to remove histories from the selected histories target area.
The right side of the view contains the following fields and options for configuring the chart that you want
to build:
Figure 5-4 shows an example of chart that displays two histories.
NiagaraAX-3.x
5-5
Browser Access Guide
Types of history views Chapter 5 – About Histories
About the database maintenance view May 30, 2007
Figure 5-5 History “Pie Chart” and “Area Chart” created using chart builder view
Refer to “Chart controls and options” on page 1-13 for more details about chart displays.
The left side of this view contains the available histories pane. This pane displays all histories
that are available in your local station or any station histories that are available via a network connection.
Histories are grouped under the station according station name.
The right side of the Histories area contains the targeted histories pane. This pane displays the
histories that are affected when you click the Run Maintenance button. Move the histories that you
want to manage into this pane using the control buttons, as described below:
Controls and options for the database maintenance view are described in the following list:
• Add history button (right arrow)
Click this button to move histories that are selected in the available histories pane to the
targeted histories pane.
• Remove history button (left arrow)
Click this button to remove histories from the targeted histories pane.
• Clear Old Records option
Select this option and use the Before date selector to remove records, based on date, from the his-
tories that are in the targeted histories pane.
• Before date field
Use this field with the Clear old records option to set the year, month, day, and time param-
eters that you want to use for removing old records.
• Clear all records
Select this option to delete all records from the selected history database. The actual history file is
not deleted and remains in the pane.
• Delete Histories
Select this option to delete all histories that are in the targeted histories pane. the history file is de-
leted and no longer appears in either of the panes.
NiagaraAX-3.x
5-6
Browser Access Guide
Chapter 5 – About Histories Types of history views
May 30, 2007 About the history manager view
NiagaraAX-3.x
5-7
Browser Access Guide
Types of history views Chapter 5 – About Histories
About the nav container view May 30, 2007
Double-click on any of the history rows to display the individual histories in the History Chart view. Or
right-click on any history and switch to any other view of that history using the popup menu.
The history chart view contains the standard chart controls and options to help you customize and view
the data. Refer to “Chart controls and options” on page 1-13.
NiagaraAX-3.x
5-8
Browser Access Guide
Chapter 5 – About Histories Types of history views
May 30, 2007 About the collection table view
In addition to a title bar that displays the history name and number of records in the table, the history
table has the following four columns that are described in “Types of history data fields” on page 5-3.
• Timestamp
• Trend Flags
• Status
• Value
Use the Table Options menu in the top right corner of the history table to modify the table view or
to export the data in the view, as desired. Refer to “Common table view controls and display options” on
page 1-12 for a description of the Table Options menu.
In addition to a title bar that displays the number of rows in the table, the history table has the following
four columns that are described in “Types of history data fields” on page 5-3.
• Timestamp
• Trend Flags
• Status
• Value
Use the Table Options menu in the top right corner of the history table to modify the table view or
to export the data in the view, as desired. Refer to “Common table view controls and display options” on
page 1-12 for a description of the Table Options menu.
NiagaraAX-3.x
5-9
Browser Access Guide
Types of history views Chapter 5 – About Histories
About the history summary view May 30, 2007
• Status parameters
These parameters display data that is updated as of the time you select the history summary view.
• Record count
This is the current number of total records, as of the Last Timestamp.
• First Timestamp
This is the date, time, and timezone information for the initial history record.
• Last Timestamp
This is the date, time, and timezone information for the latest history record in the history file.
• Configuration parameters
These parameters display data that identifies and characterizes the specific history. Configuration
parameters are typically edited by a system engineer or system integrator.
NiagaraAX-3.x
5-10
Browser Access Guide
Chapter 5 – About Histories Types of history views
May 30, 2007 About the history editor view
• Select Outliers
This button is not typically available for users. When it is available, it opens the Configure
Outliers dialog box that allows you to set outlier filter parameters for filtering data in the his-
tory file.
NiagaraAX-3.x
5-11
Browser Access Guide
History tasks Chapter 5 – About Histories
About the history editor view May 30, 2007
History tasks
Following are common tasks that are performed using history files:
• To create a history chart using the Chart Builder view
• To edit history data (History Editor view)
NiagaraAX-3.x
5-12
Browser Access Guide
Chapter 5 – About Histories History tasks
May 30, 2007 About the history editor view
• Value
Type in the desired data value in the text field. Any change in the text field selects the associated op-
tion box and indicates the selection by placing a check in the option box. If you decide not to apply
a change to this parameter, deselect the option by clearing the check box.
Step 5 In the Edit Record dialog box, click the OK button.
The data is changed or hidden in all selected records. Records with changed values display a “modified”
flag in the “Trend Flags” column of the history editor table. Hidden records display a “hidden” flag in the
“Trend Flags” column.
NiagaraAX-3.x
5-13
Browser Access Guide
History tasks Chapter 5 – About Histories
About the history editor view May 30, 2007
NiagaraAX-3.x
5-14
Browser Access Guide