enteliWEB 4.20 Operator Guide
enteliWEB 4.20 Operator Guide
enteliWEB 4.20 Operator Guide
20
Operator Guide
Edition 1.0
© 2021 Delta Controls Inc. All rights reserved.
No part of this document may be reproduced, transmitted, transcribed, stored in a retrieval
system, or translated into any language (natural or computer), in any form or by any means,
without the prior written permission of Delta Controls Inc.
Limited permission is granted to reproduce documents released in Adobe® Portable Document
Format (PDF) electronic format in paper format. Documents released in PDF electronic format
may be printed by end-users for their own use using a printer such as an inkjet or laser device.
Authorized distributors of Delta Controls Inc. products (Delta Partners) may print PDF documents
for their own internal use or for use by their customers. Authorized Delta Partners may engage a
printing or copying company to produce copies of released PDF documents with the prior written
permission of Delta Controls Inc.
Information in this document is subject to change without notice and does not represent a
commitment to past versions of this document on the part of Delta Controls Inc. Delta Controls
Inc. may make improvements and/or changes to this document/the associated software/or
associated hardware at any time.
BACstat, Earthright, enteliBRIDGE, enteliBUS, enteliCLOUD, enteliSTAT, enteliTOUCH, enteliVIZ,
enteliVAULT, enteliWEB, enteliZONE, O3, ORCAview, and ORCAweb are registered trademarks of
Delta Controls Inc.
All other trademarks are the property of their respective owners.
Document edition: 1.0
Contents
Operator Guide Introduction 16
Organization 16
Getting Started 18
Welcome 18
Support 18
Version 18
Searching for Information in enteliWEB 18
Searching the Graphics Tree View 19
Changing Your Personal User Settings 19
User Information 19
Site and Device Navigation 22
Device View Concepts 22
Network Tree View 22
BACnet Devices List 24
Device View Tasks 25
Network Tree View Tasks 25
BACnet Devices List Tasks 26
Object List 29
About the Object List Page 29
How many objects are listed? 29
Managing the Object List page 29
Simple and Advanced Search Filters 30
Simple filter 30
Advanced filter 30
How Object Instances Are Derived 31
Command Objects 31
Auto 31
Manual 32
Other 32
Reset Object 32
Archive 32
Enabled and Disabled 33
Run and Halt 33
Scanning and Stopped 33
Manage Objects 33
Create Object 33
Delete Object 34
Copy Object 34
Paste Object 34
Source device goes offline during copy/paste 39
Stuck paste task 40
Rename Object 40
Create Trend Logs 40
Configure Trend Logs 40
Load from File 41
Save to File 41
Show Access Users tab 41
Device Actions 41
Reload Objects 41
Reconfirm Status 42
Communication Control 42
Reconfigure 43
Reset 43
Set Time 43
Object Security 44
Activate Network Change 45
Save Database to File 46
Save Database to Flash 46
Save Database to Server 47
Load Database from File 47
Load Database from Flash 48
Load Database from Server 48
Clear Database 49
Object Pages 50
Object Page Tasks and Related Information Views 50
Object Page 50
What is an Object Reference? 50
Common Object Page Tasks 52
Commanding or Overriding an Object Manually 57
Related Information Views on an Object Page 58
Object Description Field 62
Dashboards 63
About Dashboards 63
System dashboard type 63
Enterprise dashboard type 63
Personal dashboard type 63
About Personal Dashboards 63
Creating a Personal Dashboard 63
Adding a Widget to a Personal Dashboard 64
Adding an Object to a Watchlist Widget 64
Removing an Object from a Watchlist Widget 65
Deleting a Personal Dashboard 65
Calendars and Schedules 66
Calendar (CAL) Object Concepts 66
About the Calendar object 66
About Calendar view 66
Types of calendar entries 66
Calendar (CAL) Object Tasks 67
Adding a Single Date calendar entry 67
Adding a Date Range calendar entry 67
Adding a Recurring Week and Day calendar entry 68
Adding a Recurring Date calendar entry 68
Deleting a calendar entry 68
Deleting a Calendar Object 69
Schedule (SCH) Object (BACnet Revision 4) Concepts 69
About the BACnet Revision 4 Schedule Object 69
Time ranges 70
Week view 72
Month view 73
Details view 73
Intrinsic Alarm 73
Automatic Deletion of Event Schedules 73
Schedule (SCH) Object (BACnet Revision 4) Tasks 73
Setting the Schedule Type 74
Adding a Weekly Schedule 74
Adding a Single Date Event Schedule 74
Adding a Date Range Event Schedule 75
Adding a Recurring Week and Day Event Schedule 75
Adding a Recurring Date Event Schedule 76
Adding a Calendar Reference Event Schedule 76
Editing a Schedule 77
Deleting a Schedule 77
Changing Schedule Configuration Properties 77
Schedule (SCH) Object (BACnet Revision 3) Concepts 78
About the BACnet Revision 3 Schedule Object 78
Schedule (SCH) Object (BACnet Revision 3) Tasks 78
Adding a Time Range 78
Adding a Calendar Object Reference 78
Editing a Time Range 79
Viewing Time Range Setting 79
Deleting a Time Range 79
Trend Logs 80
About the Trend Log Object 80
Viewing Sample Data 80
Chart Span Axis and the Time Span Axis 81
Plotting COV Samples 81
Archiving to Historian 82
Data Archiving Design Goals 82
How to Avoid Data Loss 83
Archiving to a CopperCube 83
Multiple CopperCubes 84
Archiving to enteliVAULT 84
How enteliVAULT Collects Data Samples from Controller TL Objects 84
Trend Log Object Settings 85
Configuration 85
Trend Log (TL) Object Tasks 89
Multitrend (MT) Object Concepts 93
Chart Options 94
Legend 95
Plotting COV Samples 95
Plotting Large Number of Samples 96
Multitrend (MT) Object Configuration Reference 96
Expand Chart 96
Include Non-Data Samples 96
Chart Options 96
Values 97
Trend Setup 98
Configuration 98
Multitrend (MT) Object Tasks 100
Configuring a Multitrend Object - Main Steps 100
Adding a Trend Log Object to the Multitrend Object Chart 100
Setting the Time Span to Always View New Samples 101
Setting the Time Span to View Samples in the Past 101
Updating Sample Data Automatically (Refresh) from the TL Objects 101
Zooming In the Chart View 101
Panning the Chart View 102
Loading and Viewing Adjacent Earlier or Later Data Samples 102
Zooming Out the Chart View 102
Viewing Sample Data from the Chart 102
Removing and Restoring a TL Object Plot from the Chart Temporarily 103
Printing the Chart 103
Downloading Data Samples to CSV File 103
Importing Sample Data in CSV file into Excel 104
Alarms and Events 105
About Delta Controls' Event Management System 105
Sequence of Steps in Event Management 106
Detecting Alarm Conditions 107
Out of Range 107
Floating Limit 108
Change of State 109
Command Failure 110
Buffer Ready 110
Prioritizing Events and Alarms in the Delta System 111
Categorizing Events with the EVC Object 111
Prioritizing Alarms with Alarm Groups 112
Managing Events and Alarms 112
Presenting Active Alarms to a User 112
Annunciating an Alarm to a User 112
Acknowledging Alarms 112
Logging Events and Alarms 112
Archiving Events and Alarms 113
Alarm and Alert List Concepts 113
About the Alarm and Alert List 113
How the Alarms and Alert List Page Is Organized 116
Managing Filters 122
About Alarm Notifications 123
Server Not Responding Error 126
Permissions and Alarm Management 126
Alerts Concepts 126
System Alerts 127
Energy Alerts 129
Application Module Alerts 131
Alert Notifications 131
Active Alarm List Details and Tasks 133
Alarm and Alert List Reference 133
Information in an Active Alarm and Alert Listing 133
Filter Dialog 135
Advanced Filter 139
Filter Attributes 141
Alarm Details 142
Alarm Acknowledge Dialog 143
Alarm and Alert List Tasks 143
Alarm and Alert List Tasks 143
Acknowledging Alarms Tasks 145
Alarm Details Tasks 147
Search Tasks 148
Filter Tasks 148
Quickbar Tasks 151
Saving to File Tasks 152
Email Tasks for Non-administrative Users 152
Notifications Tasks 154
Totalizers 157
Analog Totalizer (AT) Object Concepts 157
About the Analog Totalizer Object 157
Monitoring Parameters 157
Value Bar 157
Start Time 157
COV Minimum Increment 157
Monitored Object 157
Binary Totalizer (BT) Object Concepts 158
About the Binary Totalizer Object 158
Monitoring Parameters 158
Value Bar 158
Number of <active state name> State Changes 158
Since 158
COV Minimum Increment 158
Control Loops 160
Control Loop Object 160
Monitoring Parameters 160
Value Bar 160
Input Source 160
Input Value 160
Setpoint Source 160
Setpoint Value 161
COV Minimum Increment 161
Real-Time Control Loop Performance 161
Optimum Start 162
Optimum Start (OS) Object Concepts 162
About the Optimum Start Object 162
Optimum Start Calculation 162
History 163
Monitoring Parameters 165
Value Bar 165
Status 166
Start Type 166
Target Temperature 166
Indoor Temperature 166
Schedule 167
Schedule Next On at 167
Time to Next Schedule On 167
Reports 168
Reports Concepts 168
Report Features 168
Access Control Reports 168
Building Automation Reports 168
Energy Reports 168
Reports Tasks 168
Creating a Report 169
Scheduling a Report 169
Deleting a Report 169
Managing Report History 169
Exporting a Report 170
Emailing a Report 171
Copying a Report 171
Modifying the Report Setup 171
Energy Management Reports 172
Energy Reports Concepts 172
About Energy Reports 172
Consumption Report 174
About the Consumption Report 174
Report Parameters 175
Consumption by Meter Report 176
About the Consumption by Meter Report 176
Report Parameters 177
Consumption by Time Report 178
About the Consumption by Time Report 178
Report Parameters 179
Consumption Comparison Report 181
About the Consumption Comparison Report 181
Report Parameters 182
Consumption Target Report 184
About the Consumption Target Report 184
Report Parameters 184
Contribution Comparison Report 186
About the Contribution Comparison Report 186
Report Parameters 187
Cost Ranking Report 188
About the Cost Ranking Report 188
Report Parameters 189
Cumulative Consumption Report 190
About the Cumulative Consumption Report 190
Report Parameters 191
Daily Average Report 193
About the Daily Average Report 193
Report Parameters 193
Degree Days Report 195
About the Degree Days Report 195
Report Parameters 196
Load Duration Report 198
About the Load Duration Report 198
Report Parameters 199
Single Meter Occupancy Report 201
About the Single Meter Occupancy Report 201
Report Parameters 202
Energy Reports Tasks 204
Building Automation (BAS) Reports Concepts 206
About Building Automation Reports 206
Offline Devices 206
Calibration Report 206
About the Calibration Report 206
Report Parameters 206
Commissioning Sheets Report 207
About the Commissioning Sheets Report 207
Report Parameters 208
Decommissioned and Fault Report 208
About the Decommissioned and Fault Report 208
Report Parameters 209
Input Points Report 209
Input Points Report 209
Report Parameters 210
Objects in Manual Report 210
About the Objects in Manual Report 210
Report Parameters 211
Object Query Report 212
About the Object Query Report 212
Report Parameters 213
Output Points Report 214
About the Output Points Report 214
Report Parameters 214
Trend Log Report 215
About the Trend Log Report 215
Report Parameters 215
Date Configuration 215
Sample Configuration 216
Report Format 217
Plotting a Large Number of Samples 218
Advanced Object Filter 218
Building Automation Reports Tasks 221
Version 3 Access Control Reports 224
About Version 3 Access Control Reports 224
Card Access Activity Report 224
Card Access Activity Report 224
Report Parameters 225
Card Access Activity by Card User Report 226
Card Access Activity by Card User Report 226
Report Parameters 227
Card User Activity by Door Report 228
Card User Activity by Door Report 228
Report Parameters 228
Door Activity Report 230
Door Activity Report 230
Report Parameters 230
Transactions by Event Type Report 232
Transactions by Event Type Report 232
Report Parameters 232
Version 3 Access Control Reports Tasks 234
O3 Access Control Reports 237
About O3 Access Control Reports 237
O3 Access Control Reports Tasks 237
Document Revision History 243
Operator Guide Introduction
This guide is intended for facility operators and others responsible for the day-to-
day operation of the site or sites being managed by enteliWEB. Daily tasks include
monitoring values, changing setpoints, setting schedules and calendars, handling
alarms, trending, and printing. This guide does not cover administrative functions.
To use this guide, you must be a member of an enteliWEB user group with the
following permissions:
l User Interface permissions for Dashboards, Navigation, Graphics and Alarms
l No Manage permissions.
l No Show Configuration Properties on Object Pages permission
l Allow permission for all devices on the site
l Read permission for all objects, except Create permission for Multitrend and
Trend Log objects, and Write permission for schedule objects
Organization
This guide is organized into the following sections:
l Getting Started provides important information to get you started. Review the
section about changing your personal user settings and set up your account
accordingly.
l Site and Device Navigation covers site navigation and the site's device list.
This section describes tasks associated with the device list and devices.
l Object List covers the Object List page, which lets you manage a device's
database. This section describes tasks associated with the object list and
with commanding objects.
l Object Pages provides information common to most BACnet object pages and
covers common object page tasks.
l Dashboards describes the enteliWEB dashboards and covers the tasks
associated with the personal dashboard.
l Calendars and Schedules covers the Schedule and Calendar objects. This
section describes the capabilities of each object and tasks associated with
schedules.
l Trend Logs covers the Trend Log and Multitrend objects. This section
describes the capabilities of each object and tasks for creating, maintaining,
visualizing, and printing trend logs.
l Alarms and Events introduces the Delta Controls Event Management System.
This section describes alarm and event management, the alarm list page, the
notification history window, and how user group permissions affect alarm
management.
l Active Alarm List Details and Tasks covers the Alarm List page. This section
describes tasks associated with managing alarms and events.
l Totalizers covers the analog and binary totalizer objects.
l Control Loops covers the Loop object and describes how to monitor the
performance of the loop.
l Optimum Start covers the Optimum Start object and describes how to
monitor the optimum start object's operational history.
l Reports describes tasks associated with printing enteliWEB building
automation reports.
l Energy Management Reports covers the reporting aspects of Energy
Management, include a description of each report and the tasks associated
with creating and managing the reports.
l Building Automation System Reports covers building automation reports and
includes a description of each report and the tasks associated with creating
and managing the reports.
l Version 3 Access Control Reports covers V3 access control activity reports
and includes a description of each report and the tasks associated with
creating and managing the reports.
l O3 Access Control Report covers the V4 access control activity report and
includes a description of the tasks associated with creating and managing
the report.
Welcome
Welcome to enteliWEB - the complete control system software for BACnet-based
facility automation systems.
enteliWEB combines the power of enterprise dashboards with easy-to-use facility
management tools. Customizable energy management dashboards and powerful
energy reports give managers the tools they need to reduce consumption and
lower costs.
Visualizing both energy management and facility management on a single
dashboard makes it easy to close the loop between monitoring and control.
Support
This operator guide is intended to be an intuitive and comprehensive document
about using enteliWEB as an operator. However, given the flexibility of enteliWEB
and the many different ways in which our partners use it, we recognize you may
have additional questions that are not covered.
If you are a Delta Controls partner, contact Delta Technical Services for
assistance with any technical questions about Delta Controls products. Your email
address must be registered in Delta's Case Management System, or your question
will not be received.
Version
This document is current for enteliWEB version 4.20.
For complete information about this version of enteliWEB, see the release notes
document that is available on the enteliWEB product page of George Support.
Follow the links below to learn about the available search functions.
Search Alarm List
Search Devices on a Site Network
Search Navigation Tree for One or More Sites
User Information
Username
Username displays the name that enteliWEB uses to identify you. Contact the
enteliWEB administrator if you want to change your username.
Email Address
Email Address displays the email address that enteliWEB uses to send
information such as alarm notifications to you.
For the supported email address formats for HTML mail and SMS or plain text
mail, see the User Account Settings Reference help topic.
Email Address is optional, the field can be blank.
To add or change your email address, enter the email address you want to use and
Click Save.
Email Format
Email Format lets you choose an email message template that suits the type of
client or device you want to receive enteliWEB email with.
For detailed information about the email templates, see the User Account Settings
Reference help topic.
Start Page
Start Page indicates the enteliWEB page that is displayed when you log in. Select
your start page from the list. If you don't see the page you want on the list, then
that is because the access permissions of the group you are a member of prevent
it from being listed.
Open in Fullscreen
Select Open in Fullscreen when you want the start page to occupy the entire
screen.
Language
Language lets you select the language you want enteliWEB to use when you log in.
Select the language from the list and click Save.
Site
The network tree view lists all the sites known to enteliWEB. When you expand a
site node , you can see the devices on the site network ordered by their
device number (address). Each device is identified by an icon, followed by the
device name and, in parentheses, the device number. The device name and
number are set in the DEV object.
The tree view shows both Delta devices and third-party devices. Third-party
devices can be combined with Delta devices or kept in a separate folder. This is
defined in the user's settings. Delta devices include Delta Controls devices, virtual
devices that reside on an enteliBRIDGE device, and Delta Electronics devices.
These devices have vendor IDs of 8, 402, and 435 respectively.
Hierarchical relationships among Delta devices are shown as parent-child
relationships in the tree. Devices in the tree are organized into three levels,
corresponding to the area, system, and subnet groupings in Delta Controls'
Derived Network Addressing (DNA) scheme.
Under the DNA scheme, the device number format is AASSDD where:
AA represents the area level in the range 010000 to 990000 (in increments of
10000)
SS represents the system level in the range 0100 to 9900 (in increments of
100)
DD represents the subnet level in the range 01 to 99 (in increments of 1)
Subnet devices are grouped under system devices, and system devices are
grouped under area devices (if present).
For example:
Area Device 1 (140000)
System Device 1 (140100)
Subnet Device 1 (140101)
Subnet Device 2 (140102)
System Device 2 (140200)
Subnet Device 1 (140201)
enteliWEB builds the tree based on the device number in the controller's DEV
object. It does not use the network number or on-board switch settings. Delta
devices that are properly addressed are displayed in a logical order in the tree.
Third-party devices, when combined with the Delta devices in the tree, are always
shown as children of the site.
Workstation
Servers and workstations are contained in a separate folder labeled Workstation.
Servers that are offline when the tree is constructed are hidden. Servers that go
offline after the tree is constructed are indicated by .
Third Party
Devices from manufacturers other than Delta Controls are contained in a separate
folder labeled Third Party when that option is selected in the user's settings.
If there are no third-party devices on the network, the Third Party folder is not
shown.
The organization of the device list can be tailored to meet your needs by
rearranging the column positions and hiding columns you don't want to see.
The search filter lets you narrow down the number of devices in the list to show
only the devices you are interested in.
At the bottom of the page, the number of devices in the list is displayed.
When you select one or more devices in the device list, the Object List page opens.
Actions
The Action menu contains a list of actions for managing the site, such as finding
new devices and sending a network time synchronization message.
To expand all branches, press and hold the Ctrl key, and then click . All
branches below the node are expanded, including subnets.
To collapse all branches, press and hold the Ctrl key, and then click . All
branches below the node are collapsed, including subnets.
Finding a Device
To find a device, click Action, and then click Find Device. In the Find Device dialog,
enter the device number of the device that you want to find, and then click Find.
enteliWEB looks for the specified device on the BACnet network. If the device
responds, enteliWEB updates its list of known devices.
Reinitializing Descriptors
If the network tree view doesn't represent the network accurately, or if a network
routing change has resulted in a large number of devices going offline, you can
reinitialize (reload) the device descriptors.
To reinitialize the descriptors, click Action, and then click Reinitialize Descriptors.
A confirmation message appears. Click Yes to continue. You are asked to confirm
the operation because the process can take a while, especially on sites with a
large number of devices.
enteliWEB displays the following indications of progress for the re-initialization
process:
l A banner with the message Reinitialize Descriptors: OK is
displayed at the top of the page to confirm that the reinitialization has begun.
l While the reinitialization is in progress, is displayed for the site in the tree.
l The tree is updated every two seconds for up to 60 seconds.
The BACnet Server deletes the device table, the descriptor table, and the active
alarm list tables from its local data caches. Then it starts a network-wide
discovery process that populates these tables with current information.
When the BACnet Server discovers a new device on the network, it performs
following three operations:
1. The BACnet Server confirms the device. It reads definition settings from the
device such as the model name, the vendor, the version information, the
BACnet services supported, the object types supported and so on.
The BACnet Server uses the device information to identify the device uniquely
and to determine what the device is capable of doing. The device information
is stored in the device table.
2. The BACnet Server loads the descriptors from the device. Once the BACnet
Server has identified a device, it then needs to know what BACnet objects are
in that device. The BACnet Server queries the list of object identifiers in the
device and then reads the object name and optionally the HAL flag for every
object.
For the BACnet Server, a descriptor is essentially just an object name. For
Version 3 systems and ORCAview, a descriptor was the collection of data that
was associated with an object: the object name plus other object info that
may have been cached.
The object information is stored in the descriptor table.
3. The BACnet Server loads the alarm list from the device by querying the list of
active alarms in the device. The alarm information is stored in the active
alarm list tables.
Together, the device table (devices), the descriptor table (objects), and the active
alarm list tables (alarms) act as local data caches. By using these caches, the
BACnet Server provides much better performance than if it had to request the
information directly from devices each time it was needed.
Because devices are not added or removed from the network frequently, and
because objects are not created or deleted often, these tables allow enteliWEB to
display the network tree view, device list, and object list as soon as a user logs in.
Search doesn't find objects that are filtered out by the BACnet device
filter.
Simple filter
A simple filter is created by entering one or more search terms in the Search field
and pressing Enter.
Advanced filter
An advanced filter consists of one or more rules that include objects, object
properties, logical operators and comparison operators.
An advanced filter adds the object properties it references as columns in the
object list.
You can create your own advanced filters or use the built-in filters. The following
filters are included in enteliWEB:
l Inputs Output. Lists input and output objects.
l Alarms. Lists EV and EVC objects.
l Trends. Lists TL objects and MT objects.
l Values. Lists AV, BSV, BV, CSV, IV, LAV, MV, PIV objects.
l Manual. Lists all objects that are overridden, using the rule: Manual_
Override not equal to null.
l LINKnet. Lists objects and properties that pertain to LINKnet: IP, OP, AV
(101-1299), LNK, LCD objects.
l CO Tuning. Lists objects and properties that pertain to CO object tuning: AI,
AO, AV, CO, MT, TL objects.
l Network. Lists BACnet network-related objects: BCP, BDE, BMD, DER, DES,
DEV, IPS, NET objects.
In enteliWEB 4.18 and later, you can create up to 50 advanced filters. These filters
can be exported and imported, allowing them to be reused in different projects.
The built-in filters cannot be exported or imported.
Command Objects
The Object List page for a device lets you perform the following commands that
act on selected objects.
Auto
The Auto command is enabled for all object types to let you cancel an override on
selected objects.
Manual
The Manual commands let you command a permanent override for one or more
objects. The Auto command lets you cancel the override.
l Manual is enabled for all object types to allow you to command a permanent
override.
l Manual Value is enabled for analog objects and multi-state objects to allow
you to command a permanent override and set the override value.
l Manual On and Manual Off are enabled for binary objects to allow you to
command a permanent override and to set the objects override state to
Active or Inactive. The associated BDC object determines the actual terms
displayed for these states. When no BDC object is associated with the binary
object, then the terms On and Off are used.
For Accumulator (AC) objects that use scaling, enter the unscaled value
as the manual override value. Scaling is then applied and the resulting
scaled value is displayed on the Object List page.
Other
The Other command is enabled when one or more object property columns have
been added to the object list.
The Other command lets you set a value for an object property.
Reset Object
The Reset Object command is enabled for all object types that support object
reset to allow you to reset one or more objects.
When an object that does not support reset is selected, the Reset Object command
is disabled.
The operation of the reset function varies depending on the object type.
Archive
The Archive command lets you add a Trend Log object to one or more Historians
or CopperCubes. enteliVAULT is excluded from the list of supported archivers.
Manage Objects
The Object List page lets you perform the following management tasks that act on
selected objects.
Create Object
Create Object creates an object of specified type, instance and name that does not
conflict with existing objects in the device.
Conflicts that prevent you from creating an object are as follows.
l duplicate object name
l duplicate object instance for specified object type
l duplicate object instance for similar object type (for example, attempting to
create MI1 when AI1 or BI1 exist)
l device allows only a limited number of the object type in its database and that
limit has already been reached
l device is a CopperCube, which does not allow object creation, or an
enteliBRIDGE, which is managed by an embedded user interface
The Create Object dialog presents a list of possible object types that you can
create. Only the listed object types can be created for the device.
Delete Object
Delete object deletes the selected objects from the device database. Certain
objects such as the DEV object can't be deleted.
Copy Object
Copy Object is the first step for you to replicate objects. The second step is the
Paste Object operation.
When you perform the Copy Object operation, enteliWEB copies all the information
it needs to replicate the selected object or objects from the source device
database to the browser cache memory.
The copied information is retained in the browser cache memory. That information
is lost when you navigate to another page in the enteliWEB user interface.
Paste Object
Paste Object is the second step for you to replicate objects. The first step is the
Copy Object operation.
The Paste Object operation addresses two scenarios:
l Paste the objects in the same or source device that you copied from
l Paste the objects in a different or destination device or devices
Both scenarios are described in detail in following sections.
Before an object is created, you are prompted to accept the suggested instance
and name or to change them. For an LO object suggestion see How an LO object
suggested instance number is determined.
When you are copying multiple objects, then for each object you are prompted to
accept the suggested instance and name or to change them. Alternatively, you can
apply an instance number rule to the created objects. The instance number rules
are described in following paragraphs.
l Use instance numbers of copied objects + offset
Allows you to specify a number that is added to the copied objects' instance
numbers to calculate the pasted objects' instance numbers. For example,
when you copy AI1101, AI1102 and AI1106 and specify an offset number of
1000, the pasted objects will be AI2101, AI2102 and AI2106.
Object is overwritten with pasted object if instance number exists on target
device.
l Use lowest available instance numbers
Objects are pasted to the lowest available instance numbers.
l Use instance numbers starting at highest number in use +1
Objects are pasted to instance numbers that are higher than in use numbers.
That is, the highest instance number in use + 1, + 2, + 3 and so on.
l Use available instance numbers starting at:
Allows you to specify the starting instance number for the pasted objects. If
the number you specify is already in use, the paste operation uses the next
available instance numbers that are higher.
Example 1, when you copy AI1101, AI1102 and AI1106 and specify the starting
instance number of 20000 when the instance numbers 20000, 20001 and
20002 are not in use, the pasted objects will be AI20000, AI20001 and
AI20002.
Example 2, when you copy AI1101, AI1102 and AI1106 and specify the starting
instance number of 20000 when the instance numbers 20000, 20001 and
20002 are in use, the pasted objects will be AI20003, AI20004 and AI20005.
The rule you select becomes your default setting for future object pasting
operations.
For copy/paste of a CU object, the rule defaults to "Use instance numbers starting
at highest number in use +1."
monitored object. That is, copy 100.TL1 (monitoring 100.AV1) and 100.AV1,
paste creates 100.TL2 (monitoring 100.AV2) and 100.AV2.
Example 2, different device: when you copy/paste an AI object and its AIC
object on a different device then the pasted AI object links to the pasted AIC
object. That is, copy 100.AI1 (linked to 100.AIC1) and 100.AIC1, paste creates
200.AI1 (linked to 200.AIC1) and 200.AIC1.
2. When the referenced object is not included in the Paste Object operation, that
is, it is not one of the objects that you are copying, then any references to it in
the pasted objects are not changed.
Example 1: when you copy/paste a TL object without including its monitored
object then the monitored object link in the pasted TL object remains the
same as the monitored object in the copied object. That is, copy 100.TL1
(monitoring 100.AV1), paste creates 100.TL2 (monitoring 100.AV1).
Example 2: when you copy/paste an AI object without including its AIC object
then the pasted AI object links to the original AIC object. That is, copy 100.AI1
(linked to 100.AIC1), paste creates 100.AI2 (linked to 100.AIC1).
l 100.TL1 refers to 101.AV1 and is copied to device 92201. In this case, the
paste is at a different level of the hierarchy, so parent/child relationships
don't exist. 92201.TL1 still refers to 101.AV1 (no change).
l 101.TL1 refers to 200.AV1 and is copied to device 102. 200 is not 101's parent,
but the paste to 102 retains the same link. 102.TL1 still refers to 200.AV1 (no
change).
l 101.TL1 refers to 200.AV1 and is copied to device 301. 200 is not 301's parent.
301.TL1 still refers to 200.AV1 (no change).
Rename Object
Rename Object lets you change the name of selected object or objects in the
following ways.
l Replace some or all text in the object name.
l Add a prefix or suffix or both to the object name.
When multiple objects are selected, enteliWEB may suggest some text in the Text
to Find field, when it recognizes the same text fragment in the object names. This
recognition is case-sensitive.
(COV). The Max Samples property, which defines the maximum number of
samples to hold in the trend log object's buffer memory, is set at 100.
You can adjust these settings as needed.
Save to File
Save to File lets you save one or multiple objects from the database to a file. A
saved object can be reused as described above in Load from File. When you save a
single object, a .zob file is created. When you save multiple objects, a .zip
containing multiple .zob files is created.
Device Actions
Actions are tasks that act on the entire device rather than selected objects.
You access these actions from the Device Actions list.
The Object List page for a device lets you perform the following actions .
Reload Objects
The Reload Objects action is a "lighter-weight" action than Reconfirm Status
because it performs a subset of the Reconfirm Status processing and therefore it
takes less time to complete.
The Reload Objects action causes BACnet Server to perform only the third step of
the device discovery mechanism. This step gets a list of objects from the device
and then sequentially reads each of the objects' names.
enteliWEB then updates the Object List page with this new object list and gets the
related information for each object.
Reconfirm Status
The Reconfirm Status action causes the BACnet Server to execute its entire device
discovery mechanism, for the selected device or devices. The device discovery
mechanism is sometimes referred to as reloading descriptors. This mechanism
consists of four main steps and can take many seconds to complete for each
device.
When the discovery is completed, enteliWEB updates the Object List page with this
new object list and gets the related information for each object.
Communication Control
Device Communication Control lets you command a device to stop communicating
on the network for a specified duration of time. Applies to the device's peer and
subnet levels.
The Communication Control feature is typically used in the following situations.
l Stop a device from sending too much traffic over a network for a specified
duration.
l Set a device to only respond to requests and to not initiate communication for
a specified duration.
l Locate a device causing problems when troubleshooting a network.
Device Communication Control can be password-protected when the device's DEV
object has its Communications Control Command password configured.
Devices that support the Device Communication Control feature indicate so by
their DEV.Protocol_Services_Supported property.
The device stops initializing communication and optionally stops responding to
APDUs. An APDU (Application Protocol Data Unit) is an encoded message that is
exchanged between devices over the BACnet network. BACnet defines a variety of
APDU types such as confirmed request, unconfirmed request, simple
acknowledge, complex acknowledge, segment acknowledge and so on.
The Device Communication Control feature implements ASHRAE Standard 135,
Annex K, clause K.5.5.
Reconfigure
Reconfigure is used for devices that display a yellow wrench icon in the left
pane navigation tree, which indicates an incorrect or duplicate BACnet network
number. Network numbers must be unique for each network segment, and all
devices on the same network segment must be configured with the same network
number.
Reconfigure commands the device to forget the network number it thinks it should
use and to ask the network which one to use. Reconfigure may disrupt network
operation and does not always resolve the network number problem. Typically,
additional actions are required.
Reset
Reset performs a software reset by sending the BACnet ReinitializeDevice service
to the selected device.
Reset is disabled when more than one device is selected.
When a Delta Controls or Delta Electronics device is selected, then Reset
performs a cold start.
When a third-party device is selected, the Reset lets you choose a warm or cold
start service to specify the state of the device after its reinitialization.
Warm start is defined by the BACnet standard. A warm start causes the device to
reboot and start over, retaining all data and programs that are retained during a
brief power outage.
Cold start is defined by the vendor. For most Delta devices, a cold start is
equivalent to a warm start. For the O3-DIN system, a cold start turns off and on
the power to the system. For a third-party device, see the vendor's
documentation.
The Reset action can be password-protected by configuring the Reset Command
Password in the device's DEV object.
The Reset feature implements ASHRAE Standard 135, Annex K, clause K.5.15.
Set Time
Set Time sends a BACnet time synchronization message to the selected device.
Set Time displays the local date and time of the client that you are accessing
enteliWEB from, but actually sends the local date and time of the enteliWEB
server unless you specify a different date and time.
If Offset from UTC is enabled in the device's DEV object, the time synchronization
message is converted to the device's local time.
Set Time is disabled in the Device Actions list if the selected device does not
support the BACnet TimeSynchronization service.
If you want to send a time synchronization broadcast to all devices on the network,
use the Sync Device Times action on the device list page.
Object Security
Object Security works with the device's Object Restriction Settings (ORS) objects
to provide device-based security for objects in the device database. An ORS object
restricts the operations by BACnet network requests on objects in the database
based on the list of object exceptions it contains.
When object security is in effect, the object list displays only the objects that are
permitted by both the object exceptions in the ORS object and by the enteliWEB
device and object permissions of the group you are a member of.
The Object Security action is enabled when ORS1 object exists on the device.
When the time difference between the device and the enteliWEB server is
5 minutes or more, the Lock and Unlock operations fail. To eliminate the
time difference, you should define the time zone for the device or
synchronize the device time.
The object list is updated to display the objects that are permitted by both the
object exceptions in the ORS1 object and by the enteliWEB device and object
permissions of the group you are a member of.
Objects listed in the ORS exception list are visible to all enteliWEB users.
The ORS object identifies the temporary user by the MAC address of the
device that the user logged in from. Since the device (and, therefore, the
MAC address) is always the enteliWEB server, when a device with ORS is
temporarily unlocked, it is unlocked to the whole machine—in this case,
enteliWEB.
On an O3-DIN controller running firmware version 4.9 and later, the ACC,
ACU and ACR objects in the database are cleared after loading the
database in enteliWEB. If you have enteliSYNC 4.14 or later running on
the same system, these objects are replaced with objects from the
enteliSYNC database during synchronization.
Load Database from File takes a saved database file that was created by the Save
Database to File action or a .pdb file that was created by ORCAview and downloads
it to the device. The device's entire configuration is replaced by the contents of the
downloaded file.
The saved database file must be accessible from your client computer.
The Load Database from File action is logged in the DEV object History and in the
enteliWEB log.
To perform Load Database from File, you must be a member of a group that has
the Object Permissions for the DEV object set to Delete.
On an O3-DIN controller running firmware version 4.9 and later, the ACC,
ACU and ACR objects in the database are cleared after loading the
database in enteliWEB. If you have enteliSYNC 4.14 or later running on
the same system, these objects are replaced with objects from the
enteliSYNC database during synchronization.
Load Database from Flash copies the database from the device's non-volatile
flash memory to the overwrite the resident active database in the device. By
loading the database from flash, you restore the device to a backup or snapshot
that was saved by the Save Database to Flash action. Load Database to Flash can
be performed on one device or on multiple devices.
The Load Database from Flash action is logged in the DEV object History and in
the enteliWEB log.
Load Database from Flash is available only for devices that are manufactured by
Delta Controls.
To perform Load Database from Flash, you must be a member of a group that has
the Object Permissions for the DEV object set to Write and has Service
Permissions to Load Database.
On an O3-DIN controller running firmware version 4.9 and later, the ACC,
ACU and ACR objects in the database are cleared after loading the
database in enteliWEB. If you have enteliSYNC 4.14 or later running on
the same system, these objects are replaced with objects from the
enteliSYNC database during synchronization.
Load Database from Server takes a saved database file that was created by the
Save Database to Server action and downloads it to the device. The device's entire
configuration is replaced by the contents of the downloaded file.
Load Database from Server performs a similar operation to Load Database from
File except that the saved database file is downloaded from the enteliWEB server.
The Load Database from Server action is logged in the DEV object History and in
the enteliWEB log.
To perform Load Database from Server, you must be a member of a group that
has the Object Permissions for the DEV object set to Delete.
Load Database from Server will fail if the device that you are loading to
has a password. In that case, use Load Database from File, which
prompts for a password.
Clear Database
Clear Database causes the device to delete all database objects and to re-create
the standard system objects such as DEV, DBI, and so on. Network settings
necessary to maintain a connection to the controller are retained on database
clear. On controllers running O3/enteliBUS firmware V4.9 and later, time settings
necessary to maintain a Secure Connect connection are also retained on database
clear (see Device Time for details).
Clear Device Database does not affect or remove the saved database from the
device's flash memory.
To perform Clear Database, you must be a member of a group that has the Object
permissions for the DEV object set to Write and Delete.
For information about the format of the object reference instance number for an
I/O object that resides on an enteliBUS controller, see Object List Page Reference
section in the enteliWEB help.
For information about the format of the object reference instance number for an
I/O object that resides on a DSC or DAC controller, see Object List Page Reference
section in the enteliWEB help.
For information about the format of the object reference instance number for
objects that reside on the O3 devices, see Object List Page Reference section in
the enteliWEB help.
Site Independence
The device address.object identifier component of the object reference can be the
same on different sites that are managed by an enteliWEB server, but it must be
unique in a particular site.
When you enter an exact object reference such as AV4 or an exact object name,
the object picker accepts it without the need for you to select from a list of
suggestions, when the object or name exists.
When you enter a partial object reference such as AV or a partial object name, the
object picker searches for and lists the matching objects. Local matching objects
are listed first, followed by matching objects on remote devices.
The object picker makes sure that the list of objects contains only the object types
that meet the requirements of the field. For example, when the field you are
configuring must reference an analog object, the object picker lists analog objects
only. Or, when the reference must be to an object on the same controller, then
only local objects are listed.
Local objects are listed first followed by remote objects.
You can work around the object picker's constraints for object type by entering the
complete object reference for the object you want. For example, if an object picker
is constrained to list only AV objects, you can force it to accept an AI object by
entering the AI object reference in the field.
An object picker containing a valid object reference looks like this:
Although the object name is displayed in the object picker field, the value sent to
the controller is the object reference.
To specify an object property other than Present_Value, at the end of the object
name enter a period followed by a partial name of the property you want. For
example, .cov. The matching properties are listed.
When you are configuring an object reference in an offline scenario, the object
picker may not be able to list the object you want to reference. In this case the
object picker lets you enter the complete object reference in the form
//sitename/device address.object identifier .
An object picker containing a valid complete object reference looks like this:
//MainSite/2001.BI3
See Using the Object Picker for a Local Reference and Using the Object Picker for
a Remote Reference for how to use the object picker.
1. In the object picker field, enter the local reference in one of the following
formats.
<object reference>
<object name>
<object name>.<property name>
You can enter partial references or names. The Object Picker lists matches
for you to choose from. Select the object that you want to reference from the
list.
To specify an object property other than Present_Value, at the end of the
object name enter a period followed by a partial name of the property you
want. For example, .cov. The matching properties are listed. Select the
property you want to use.
2. Click Save to send the configuration to the object.
The result of the Save operation is indicated by a banner at the top of the object
page.
OK Result
When all configuration properties are valid, then the confirmation banner
is displayed at the top of the page. Click the confirmation banner to list
all the properties that were affected by the save operation, marked as OK.
Click More..., on the right side of the banner, to see the complete list of affected
properties.
Error Result
When one or more of the configuration properties was invalid, then the error
banner is displayed at the top of the page. Click the error banner to list
all the properties that were affected by the save operation. When a change to a
property was accepted by the object, it is marked as OK. When a change to a
property was rejected by the object, it is marked with an error message.
Click More... , on the right side of the banner, to see the complete list of affected
properties and their corresponding error messages.
When you have made changes to the object page, the Are you Sure You Want to
Leave This Page dialog opens. Click Leave this page.
added.
Deleting an Object
1. Click Delete. The delete confirmation dialog opens.
2. Click Yes to delete the object.
When the object is deleted, the object page closes and the Object List page
for the device is displayed.
To go to the previous object page, click or press the SHIFT + Page Up keys.
To return to the Object List page, click Back to Object List or click Close on the
object page, or select the device in the left pane navigation tree.
The Manual mode icon and the Timed Override mode icon are
displayed on the Value bar.
Associated System
The Associated System pane lists the system or systems that the object is a
member of.
When the object is not a member of any system, the Associated System pane is not
displayed.
Configuration
The Configuration pane lists the objects that provide configuration information to
the object you are viewing, or it lists the objects that reference the object you are
viewing for configuration information. For example, an AIC object provides
configuration information to an AI object which that object applies to its
conversion algorithm for its present value, or a BDC object provides state
numbers and state text state configuration information to BI, BO, and BV objects.
An AIC object, for example, lists all the AI objects that reference that AIC object.
Controlled By
The Controlled By pane lists the objects that provide control values to the object
you are viewing, when it is in Auto mode. For example, a CO object provides a
value in % to an AO object which that object converts to its present value, or a SCH
object provides schedule state to an OS object.
Objects for which you are denied access because of your user group's BACnet
permissions are not listed.
Controlling
The Controlling pane lists the objects that receive the output of the object you are
viewing. For example, a CO object may control an AO object or a SCH object may
provide its schedule state to multiple objects such as OS objects.
Dashboard
The Dashboard pane lists the watchlist widgets that watch the object you are
viewing and it lets you add the object to other watchlist widgets.
When there are no watchlists on any dashboards, the Dashboard pane is not
displayed.
When the object is on all watchlists, then the Watchlist list and the Add button are
not displayed.
Graph
The Graph pane displays a real-time chart that corresponds to a TL object that is
monitoring and recording samples of the object.
To open the TL object page, click the graph.
History
The History pane displays the 10 most recent events that occurred for the object
such as the results of each Save operation.
When more than 10 events have occurred for the object, the pane title,
History, becomes a link, History, to a view of the Log that is filtered for
the object. The Log view lists the full history of the object.
Save operations
The result of a save operation displays date and time, property changed or
attempted to be changed and the username of person who made the change.
indicates that the save operation was successful. indicates that the save
operation failed.
When a property has multiple components, such as a group, union or array, the
results are formatted to make it clear what each component was set to.
Alarm transitions
Alarm transitions are displayed in History when the object is configured for
intrinsic alarm reporting, otherwise the alarm transitions are displayed in the
monitoring EV object History pane.
For alarm transitions, the date and time is the device date and time when the
transition occurred.
When both the from state and the to state are known, then the History pane
displays both states as from-state => to-state.
When only the to state is known, then the History pane displays only that state.
For example, Normal by itself means the transition resulted in the normal state.
Other transitions
For DEV objects, the History pane displays when the device goes online and
offline.
Member
The Member pane is displayed for the access group (AG) object. The Member
pane lists the card users (CU objects) that are members of the access group you
are viewing. The Member pane limits the number of card users that it displays.
The Member pane is displayed for the access user (ACU) object. The Member
pane lists the access credential (ACC) objects that are assigned to the access
user.
Member Of
The Member Of pane is displayed for the card user (CU) object. The Member Of
pane lists the access groups (AG objects) that the card user is a member of.
The Member Of pane is displayed for the access credential (ACC) object. The
Member Of pane lists the access user (ACU) object that the credential is assigned
to.
Monitored By
The Monitored By pane lists the objects such as TL and MT objects that the object
you are viewing is an input to.
Objects to which you are denied access because of your user group's BACnet
permissions are not listed.
Sometimes an object displays a PG object in both the Monitored By pane and the
Controlled By pane when PG is writing to the object and you would expect to see
the PG object in the Controlled By pane only. The PG object is listed in the
Monitored By pane because it is monitoring the object's out of service status.
Monitoring
The Monitoring pane lists the objects that are inputs to the object you are viewing.
For example, the AV object that is providing a setpoint to a CO object or the AI
object that is providing indoor temperature to an OS object.
Objects for which you are denied access because of your user group's BACnet
permissions are not listed.
Watch
The Watch pane is used by the PG object to list the names and values of constants,
object references and variables in the program you are viewing. The values are
updated periodically when the program is running.
2. From the Action list that is located at the bottom of the Dashboards section,
select Create Personal Dashboard. The Create Personal Dashboard dialog
opens.
3. Enter a name for the dashboard in the Name field and then click Add. A
personal dashboard with this name is displayed in the Dashboards section of
the left navigation pane.
4. Select the new personal dashboard to open it in the right pane.
The layout of a personal dashboard is fixed to the following layout. The layout
can't be changed.
1. Navigate to the object page for the object you want to add to the watchlist.
2. On the right side of the object page, in the Dashboard pane, select your
watchlist widget from the Add to Watchlist list and click Add.
3. Return to your personal dashboard to confirm that the object is included in
the watchlist widget.
Single Date
A Single Date entry specifies the date for one day.
indicates a Single Date.
Date Range
A Date Range entry specifies the dates for one or more consecutive days.
indicates the dates that the Date Range entry occurs on.
Recurring Date
A Recurring Date entry specifies a repeating pattern for one day in a month. The
selected day can be configured to repeat in many ways.
indicates the dates that the recurring entry occurs on.
Schedule Type
The schedule type setting determines the nature of the values that the SCH object
provides to subscriber objects and therefore which type of objects can be
controlled by the schedule.
You select the schedule type when you open a SCH object that has no schedules
defined. Typically, that means when you open a SCH object for the first time after
it is created.
The following schedule types are possible:
Binary
A schedule of type Binary provides schedule values as 1 for On and 0 for Off
schedule states.
Multistate
A schedule of type Analog provides schedule values as analog values, that is, real
numbers, such as periodic setpoint changes, in the range from -65534 to +65534.
Boolean
A schedule of type Boolean provides schedule values as 1 for True and 0 for False
schedule states.
True state is displayed as On and False state is displayed as Off.
View Tabs
The view tabs provide the following functions:
Week displays the schedule week view and the weekly schedules and event
schedules for that week.
Month displays the schedule month view and lets you navigate the timeline
from month to month.
Details displays a list view of the weekly schedules and event schedules that
are in the schedule.
Setup displays configuration fields that allow certain SCH object properties
to be viewed and changed.
Time ranges
The schedule represented by a SCH object consists of one or more time ranges
and corresponding schedule values that you define. Time Ranges are defined by
weekly schedules, event schedules and the SCH object's default value.
Default value
The default value that you specify is applied to all time ranges that are not covered
by a weekly schedule or an event schedule.
Weekly schedule
A weekly schedule is typically used to define the facility's normal weekly
equipment operation or its occupancy hours. A weekly schedule time range
repeats every week, at the same times and days. Although you can define multiple
weekly schedules, a given time range can be defined by only one weekly schedule.
Unlike event schedules described below, a weekly schedule doesn't have a priority
setting and doesn't overlap with other weekly schedules.
Event schedule
An event schedule defines a temporary or recurring event that take priority over
the default value and the weekly schedule time ranges. An event schedule is
typically for a one-time event such as a holiday or an event that occurs regularly
but doesn't work as a weekly schedule.
An event schedule can repeat, for example as a specific month and day every year
such as the first Monday of January, the New Year's Day holiday, or as a recurring
time range such as the third week of every month. Alternatively, an event
schedule can link to a local calendar which defines its time ranges.
You can add up to 100 event schedules to a schedule. Event schedules that will
never occur again are deleted automatically.
You can add the following types of event schedules:
Single Date event schedule
A Single Date event schedule defines an event schedule that occurs on one day
only.
Date Range event schedule
A Date Range event schedule defines an event schedule that occurs at the same
time on one or more consecutive days.
Recurring Week and Day event schedule
A Recurring Week and Day event schedule defines an event schedule that recurs
at the same time on specified days, weeks and months.
A Recurring Date entry specifies a repeating pattern for one day in a month. The
selected day can be configured to repeat in many ways.
Calendar Reference event schedule
A Calendar Reference event schedule defines an event schedule that occurs at the
same time on the days determined by the referenced Calendar object. A Calendar
Reference event schedule provides a convenient method of overriding the normal
weekly schedule of a Schedule object.
Week view
In the Week view, color shading indicates the time range associated with weekly
schedules and event schedules. When a time range is colored white, no weekly
schedule or event schedule is defined for that time range and therefore the
default schedule value is in effect for that time range. See the legend for the
association between color and event type.
Click this button to display the previous week in the schedule timeline.
Click this button to display the next week in the schedule timeline.
Click this button to display the calendar dialog where you can choose the
week and month that you want to view the schedule for.
Display Events checkbox in Week view, lets you select whether or not the
event schedules are displayed. When Display Events is not selected, then
weekly schedules only are displayed.
or Click this button to display the legend for the colors associated
with each type of weekly schedule and event.
Month view
In the Month view, the month calendar lists the time ranges and associated color
dot on the days when they occur to indicate weekly schedules and events and their
schedule types. When a time range is not listed, the default schedule value is in
effect for that time range. See the legend for the association between color and
event type.
Click this button to display the previous month in the schedule timeline.
Click this button to display the next month in the schedule timeline.
Click this button to display the calendar dialog where you can choose the
month that you want to view the schedule for.
or Click this button to display the legend for the colors associated
with each type of weekly schedule and event.
Details view
In the Details view, all weekly schedules and all event schedules for the schedule
object are listed in tabular format. The schedules are organized in the tables by
date and time.
Intrinsic Alarm
Intrinsic alarming for the SCH object supports the Change of Reliability algorithm
to report fault and return to normal transitions that are derived from changes to
its Reliability property.
10. In the Priority list, select the priority for this event schedule.
11. Click Save to add the recurring week and day event schedule to the schedule.
3. In the Description field, enter a short phrase that describes this event
schedule.
4. Set the event schedule's daily start time in the left Time field.
5. Set the event schedule's daily end time in the right Time field.
6. Select or enter the name of the Calendar object.
7. In the Value field, enter the event schedule's value.
8. In the Priority list, select the priority for this event schedule.
9. Click Save to add the calendar reference event schedule to the schedule.
Editing a Schedule
1. Click Details to display information about all the schedules in a table.
2. Click the schedule's link in the Description column. The Edit Event Schedule
or the Edit Weekly Schedule dialog opens.
3. Change the settings as required.
4. Click Save to save the changes.
Deleting a Schedule
1. Click Details to display information about all the schedules, in tabular
format.
2. Select the schedule you want to delete. The Delete button becomes active.
3. Click Delete. You are prompted to confirm that you want to delete the
schedule.
4. Click Yes to delete the schedule.
The sample data that is plotted on the chart can be downloaded in CSV format to a
file.
Legend
1 - The Chart Span axis displays the time range of the samples that are
plotted on the chart.
2 - The Time Span axis displays the entire time range of the samples that are
listed in the sample data table.
3 - The Time Span axis displays the time range of the samples that are
plotted on the chart, highlighted in blue.
4 - Time range adjuster that sets the earliest time for the Chart Span axis.
5 - Time range adjuster that sets the latest time for the Chart Span axis.
When this time range adjuster is positioned at the extreme right end of the
time range then the chart refreshes periodically with the most recent
samples. When this time range adjuster is positioned elsewhere in the time
range, the chart does not refresh.
l When the difference between two adjacent samples is greater than 1.5 times
the COV increment, then the points are joined by a step change line.
l When the difference between two adjacent samples is less than or equal to
1.5 times the COV increment, then the points are joined by a sloped line.
When more than one sample has the same time stamp then increments of one
one-hundredth of a second are added to the time stamps to differentiate them.
Archiving to Historian
Historian is a licensed ORCAview add-on that collects and archives trend log data
permanently in a standard SQL database. Data samples that are collected by
thousands of TL objects are collected by Historian over the BACnet network and
archived in its SQL database. Historian provides an opportunity to record, view,
analyze and manage data in ways that are not possible using the TL object and the
Multitrend (MT) object.
Therefore, the rapid change in temperature causes a controller TL with Log Type
set to COV to experience a sudden influx of samples in a short period. Historian's
scheduler may not be able to respond quickly enough to avoid data loss.
Archiving to a CopperCube
A CopperCube is a licensed device from Delta Controls that collects and archives
trend log data permanently in a standard SQL database. Data samples from
thousands of TL objects are collected by CopperCube over the BACnet network
and archived in its SQL database.
A CopperCube provides a comprehensive user interface that lets you configure
trend log archiving and to manage data in ways that are not possible using the TL
object and the Multitrend (MT) object.
The same data archiving and design goals described for Historian apply for the
CopperCube.
Before you can view trend log data that is being archived on a CopperCube, you
must create a connection between enteliWEB and the CopperCube.
Multiple CopperCubes
It is possible for multiple CopperCubes to be connected to the same BACnet
network and for those CopperCubes to be archiving samples from the same TL
object, to provide a degree of redundancy.
When you open the TL object page for a TL object that is being archived on
multiple CopperCubes, enteliWEB selects the CopperCube that has archived the
most samples for that TL object. The samples from the selected CopperCube
archive are displayed on the TL object page.
The TL object page does not select the CopperCube based on any other criteria
such as older samples versus newer samples and it does not merge archived
samples from multiple CopperCubes.
Archiving to enteliVAULT
enteliVAULT collects and archives up to 50,000 TL objects from all sites created
on a single enteliCLOUD instance. The enteliVAULT archiving functionality is
available on enteliCLOUD instances that have purchased the enteliVAULT add-on
option.
Data samples are archived in a PostgreSQL database, and you access this data
using enteliWEB features such as the TL or MT object pages.
The same data archiving and design goals described for Historian and
CopperCube apply to enteliVAULT.
minutes.
l For COV or Triggered TLs, the collection schedule is based solely on the
buffer size. To avoid missing samples, it takes half the buffer size and uses
that in seconds. For example, if the trend log has a 120 sample buffer, the
calculation is 120/2 = 60 seconds, or every minute.
l For COV TLs with buffer-ready notification, data samples are collected as
soon as the buffer-ready notification is received over BACnet.
Name
Name specifies the name for the object.
Monitored Object
Monitored Object specifies the name of the object that you want the TL object to
collect samples from. By default, the TL object collects samples of the monitored
object's present value.
To monitor a property other than present value, specify that property name. For
example, 9100.AI1.Commissioned causes the TL object to collect samples of the
object's commissioned status.
When the collected samples are being archived by Historian, the Monitored Object
field is read-only.
Log Type
Log Type specifies how the TL object collects samples.
Polling
In the Polling method for collecting samples, the TL object collects a sample from
the monitored object periodically on a fixed time interval. The TL object collects a
sample regardless of whether or not the monitored object's value has changed.
For example, every minute.
Change of Value
In the Change of Value method for collecting samples, the TL object collects a
sample when it detects that the monitored object's value has changed by the
specified COV minimum increment or more. To detect that the monitored object's
value has changed, the TL object obtains the current value every database scan
and compares it to the value it obtained on the previous scan. When the monitored
object's value doesn't change significantly, no samples are collected.
Triggered
Historian does not support TL objects with Log Type set to Triggered.
In the Triggered method for collecting samples, the TL object collects a sample
from the monitored object when its Trigger property is set to True. The TL object
collects a sample regardless of whether or not the monitored object's value has
changed. The Trigger property remains True while the TL object is collecting the
sample and then it is returned to False by the TL object.
When the Trigger property is set to True while the logging type is either COV or
Polling, then no sample is collected based on the trigger. The Trigger property will
remain True until the logging type is set to Triggered, at which point a sample will
be taken and Trigger will be returned to False.
Sample Interval
Sample Interval specifies the time interval you want to elapse between samples
when Log Type is set to Polling.
When you select Daily, a sample is collected at 24 hour intervals, at the Start
Sampling at time.
When you select Interval, enter the time interval in the adjacent field in hours,
minutes and seconds. Sample interval range is from 00:00:01 second to 23:59:59
hours.
Max Samples
When the TL object is not archiving to Historian or to a CopperCube, Max Samples
specifies the maximum number of samples you want to hold in the TL object's
buffer memory.
As a rough guide, each sample requires approximately 10 bytes of memory. For
example, when Max Samples is set to 100 then 1000 bytes of buffer memory is
used to store 100 data samples.
When the maximum number of samples are stored in the TL object memory then
the trend log is considered to be full. When the trend log is full, the next sample
overwrites the earliest sample unless you set Stop Sampling at to When Trend Log
is Full.
When the TL object is archiving to Historian, Max Samples is disabled. It displays
Unlimited.
Start Sampling at
Start Sampling At specifies when the TL object will begin to collect samples.
When the Start Sampling At checkbox is cleared, the text "Specify Start Date" is
displayed. The TL object begins to collect samples immediately or when the
controller is reset or when the controller time changes.
To start sampling on a specific date and time, select the Specify Start Date
checkbox and configure the date and time when you want the sampling to begin.
When Log Type is set to Polling, the sampling start time affects when the TL
object polls for the sample. The TL object calculates the poll time using the
sampling start time and the Sample Interval setting. The table below provides
several examples of the behavior for determining when the poll occurs.
Sample
Start Time Poll Times
Interval
Stop Sampling at
Stop Sampling At specifies when the TL object will stop collecting samples.
When the Stop Sampling At checkbox is cleared, the text "Specify End Date" is
displayed.
To stop collecting samples on a specific date and time, select the Specify End Date
checkbox and configure the date and time when you want the TL object to stop
collecting samples. When the Specify End Date checkbox is cleared, sample
collection continues indefinitely.
To stop collecting samples when the TL object has collected the number of
samples specified by Max Samples, select When Trend Log is Full.
Alternatively, enter the complete object reference and specify the property
name. For example, //MainSite/9100.AI1.MaxValue
3. Select the Log Type.
Select Polling when you want the TL object to collect samples at regular time
intervals. When you select Polling, the Sample Interval setting appears below
Start Sampling At to allow you to set the polling interval.
Select Change of Value when you want the TL object to collect a sample
whenever the change in the monitored object's value is greater or equal to its
COV minimum increment setting.
Select Triggered when you want the TL object to collect a sample when the
Trigger property is set to True.
Historian does not support TL objects with Log Type set to Triggered.
4. Select Sample Interval. The Sample Interval setting is displayed when you
select Polling for the Log Type setting.
When you select Interval, enter the sampling or polling interval in the form
hh:mm:ss or choose it from the list.
5. Enter the maximum number of samples you want the trend log to hold.
6. Select when you want the TL object to start sampling:
l Clear the Start Sampling At checkbox to start immediately, or
l Select the Specify Start Date checkbox to set a date and time to start
sampling.
7. Select when you want the TL object to stop sampling:
l To set a specific date and time, select the Specify End Date checkbox
and enter the date and time, or
l To stop sampling when the TL object reaches the maximum number of
samples, select When Trend Log is Full, or
l To have sampling continue forever and never stop, clear all checkboxes.
8. Select Commissioned when appropriate.
9. Click Save to send the configuration to the object.
1. Method A: Click to zoom out to display all the samples that you obtained
from the TL object. When this button is not displayed, the chart is displaying
all the samples as specified by the Showing Samples setting.
2. Method B: Position the time range adjusters to the earliest and latest times
you want to view on the chart. The chart plot adjusts to display only the
samples that were collected between those times.
Click the menu indicator to display the selection menu. Select Columns
from the menu then select or clear a checkbox to add or remove a column.
5. Clear the Include Non-Data Samples checkbox to remove all the non-data
samples from the sample data table. The non-data samples are not deleted
from the TL object memory.
1. Set Showing Samples to the maximum value and click Go to upload all
samples from the TL object.
2. Select Include Non-Data Samples to list both the sample data and the non-
data samples in the sample data table.
3. Sort the Value column as Sort Descending. When the data samples are
numeric, the non-data samples are all displayed at the top of the Value
column. When the data samples are text, you need to scan the Value column
for groups of non-data samples.
Chart Options
Two settings, View Samples and Time Span, together, allow you to set the time
range window for the samples that the MT object loads from the TL objects and
that you can view on the chart. The pan and zoom functions are constrained to
operate in this time range window.
View Samples / Most Recent allows you view new samples as they are collected by
the TL objects. Then, Time Span lets you set the time interval in the past that you
want to view samples for.
View Samples / Go To sets the time at the start of the time axis. Then, Time Span
lets you set the width of the time range window.
Adjusters on the chart allow you to move the time range window in increments of
the Time Span setting.
Legend
3 - The time span axis displays the chart span axis time range highlighted in
blue.
4 - Time range adjuster that sets the earliest time for the chart span axis.
5 - Time range adjuster that sets the latest time for the chart span axis.
When this time range adjuster is positioned at the extreme right end of the
time range then the chart refreshes periodically with the most recent
samples. When this time range adjuster is positioned elsewhere in the time
range, the chart does not refresh.
Legend
The legend, which is located above the chart, displays the names of the objects
that are monitored by the TL objects and the colors of their plots.
If the monitored object has a property appended to the object name, that object
and property combination name is displayed in the legend.
When a TL object resides on a remote device rather than on the device with the MT
object, then the remote device's address is shown as a prefix to the object name.
The legend may be displayed in up to four groups as follows:
Left - objects are associated with the y-axis scale on the left side of the plot
Right - objects are associated with the y-axis scale on the right side of the
plot
Digital - objects are associated with TL objects that contain two-state
samples
Multistate - objects are associated with TL objects that contain multi-state
samples
Chart Options
View Samples
Most Recent
Most Recent specifies that you want the chart to be dynamic and to always
displays new samples collected by the TL objects. Data is refreshed every minute.
Go To
Go To lets you set the time and date at the start of the chart's timeline.
Time Span
Time Span specifies the time interval that you want to view data samples for. That
is, it sets the maximum extent of the chart's timeline.
Values
Monitored Object
Displays the name of the object being monitored by the trend log. Both the trend
log and its monitored object share the same color reference.
Value
This column displays the latest object value from the chart in the selected time
range.
Max / Last On
For trend logs that monitor analog objects, the column displays the largest value
in the trend log data.
For trend logs that monitor binary objects, the column displays the time stamp of
the last time the object had ON value.
This column is blank for trend logs with enumerated data types.
Average / On Time
For trend logs that monitor analog objects, the column displays the calculated
average value in the data.
For trend logs that monitor binary objects, the column displays the total time the
object spent in the ON state.
This column is blank for trend logs with enumerated data types.
Units
Displays the units used by the monitored analog object value. For binary objects,
this column displays the active and inactive states.
Trend Setup
TL Reference
TL Reference specifies the local or remote TL objects that you want to view data
samples from. The TL objects are listed by their names. Each name is a link to the
TL object.
When a referenced TL object is deleted, it remains on the TL Reference list as a
TL object reference, for example, 1000.TL5, with no link.
TL objects that are trending a Bitstring data type are accepted but the trend log
data is not plotted by the MT object.
Axis
Left and Right specify, for analog values, which y-axis, Left or Right, has the
corresponding label and unit of measure.
Digital specifies, for two-state values, that the Digital area of the chart is to be
used for the plot.
Multistate specifies, for multi-state values, that the Multistate area of the chart is
to be used for the plot.
Color
Color specifies the color of the line on the chart for the TL object samples.
Configuration
Name
Name specifies the name of the MT object.
Commissioned
The Commissioned checkbox, when selected, specifies that the object has been
field commissioned.
The Commissioned checkbox, when not selected, specifies that the object is not
field commissioned.
1. Method A: Click to enable Zoom mode. Click and drag the mouse cursor
over the chart to highlight the time range you want to expand. Release the
mouse and the chart timeline expands to display only the selected time
range.
2. Method B: Click and drag the time range adjusters to the earliest and latest
times you want to view on the chart. The chart plot adjusts to display only the
data samples that were collected between those times.
For example, as shown below, the time range adjusters set the earliest time
to 02:00 and the latest time to 06:00.
1. Click to zoom out to display all the data samples that the MT object
loaded from the TL objects. When this button is not displayed, the chart is
already displaying all the data samples that were loaded from the TL objects.
2. Click to load the adjacent later data samples for the interval specified by
Time Span.
3. Click to load the adjacent earlier data samples for the interval specified by
Time Span.
1. Method A: Click to zoom out to display all the data samples that the MT
object loaded from the TL objects. When this button is not displayed, the
chart is already displaying all the data samples that were loaded from the TL
objects.
2. Method B: Position the time range adjusters to the earliest and latest times
you want to view on the chart. The chart plot adjusts to display only the
samples that were collected between those times.
1. Click to begin.
When using Chrome as your browser, a preview page opens and displays the
chart that will be printed.
When the preview displays the chart in grayscale and you want color, then
select a color printer as the destination printer and select Background colors
and images.
2. Follow your browser's print dialog to complete the printing.
Delimiters used in CSV file are based on locale of user who downloads
the samples. User who imports the CSV into Excel must use same locale.
The following diagram depicts the main components of Delta's event management
system.
Legend
1. User manages alarms with enteliWEB using the Alarm List page and the
Notification History window.
2. LAN, WAN, or cloud
3. User receives alarm notifications via email
4. Historian server logs and archives alarm notifications
5. BACnet network
6. In this example, the EV object detects the alarm condition in the monitored
object, the AI object.
The EVC object sends a notification over the network.
7. In this example, the intrinsic alarming function of the object, the AI object,
detects the alarm condition. The EVC object sends a notification over the
network.
8. enteliWEB server
9. enteliWEB's alarm and event management system
10. Alarm list
11. Notification history
12. Alarm groups
13. Alert rules
14. Log
15. TCP/IP network
16. SMTP server, needed for emailing alarm notifications
Out of Range
The out of range algorithm asks: "Is the analog input or value in its normal range
between fixed limits?" A setpoint is not involved.
If the input or value is not in the normal range, a high limit or low limit alarm is
generated.
Legend
High Limit Alarm Normal Low Limit Alarm Input
Floating Limit
The floating limit algorithm asks: "Is the analog input close to the setpoint?" Or, in
the case of the Loop (CO) object: "Is the error between the input to the loop and
the setpoint small enough?"
If the input is not in the normal range with respect to the setpoint, a high limit or
low limit alarm is generated.
Legend
High Limit Alarm Normal Low Limit Alarm Input Setpoint
Change of State
The change of state algorithm asks: "Is the binary input or binary value on or off?"
Or: "Is the multi-state input or multi-state value equal to the expected state?"
If the input or value is not in the expected state, an alarm is generated.
Legend
Alarm Normal Input 1 = On state 0 = Off state
Legend
Alarm Normal Input 1 = On state 0 = Off state
Command Failure
The command failure algorithm asks: "Is the status reported by a binary or multi-
state input equal to the state of the binary or multi-state control signal?"
If the status is not in the same state as the control signal, an alarm is generated.
Legend
Alarm Normal Status Control 1 = On state 0 = Off state
Buffer Ready
The buffer ready algorithm asks: "Is the logging object recording samples as
expected?" This algorithm is only supported in intrinsic alarming and intrinsic
event reporting.
The buffer ready causes the object to report when the specified number of
samples have been recorded since the last notification. The buffer ready event
generates To-Normal transitions only.
Additional EVC objects can be created to allow better alarm filtering or for
specialized needs. For example, a building automation system consisting of
multiple buildings often benefits from having unique notification classes for each
building. If new EVC objects are added, however, they must be added to every
controller on the network.
The EVC object also lets you set an individual BACnet priority for each of the three
event transitions: To Alarm, To Fault, and Return to Normal. The BACnet priority
provides enteliWEB with an alternative to the Delta notification class categories,
for prioritizing alarms.
Acknowledging Alarms
The acknowledge settings in the EVC object determine if someone has to
acknowledge the alarm when it occurs. The EVC object lets you set an individual
acknowledge requirement for each of the three event transitions: To Alarm, To
Fault and Return to Normal. Typically, Return to Normal does not require an
acknowledgment.
The acknowledge settings in the EVC object are particular to each controller. For
consistent system behavior, the acknowledge settings for a given notification
class must be kept the same in all controllers.
What is an alert?
When a problem is detected with an enteliWEB subsystem in the enteliWEB
server, an alert notification is generated. An alert is an alarm that reports an
internal problem, rather than an alarm that reports a problem from the building
automation system over the BACnet network.
In addition, an application module that has been implemented with the enteliWEB
API can generate alerts.
The Alarm and Alert List page lets you manage alerts in the same way that you
manage alarms.
What is a filter?
Perhaps the most powerful feature of the Alarm and Alert List page is its filtering
capability. You can narrow down the list of alarms by specifying criteria that an
active alarm must match to appear in the alarm list.
You can create any number of filters to allow you focus quickly on the alarms you
are interested in, such as critical alarms, alarms assigned to you, alarms from
certain devices and so on.
A filter also governs some aspects of the treatment of the alarms such as visual
notifications and email notifications.
Legend
10 - Related Items
11 - Page Selection and Refresh
Command List
The Command list allow you to select from the following commands.
Acknowledge
The Delete Alarm command deletes the selected alarms from the alarm list.
When you delete an alarm from the alarm list, you are deleting it from
enteliWEB's internal list of active alarms. You are not acknowledging the alarm
and you are not changing the alarm state of the source object.
Therefore, when you update the alarm list, the alarms that you deleted are listed
again in the alarm list.
Update Alarms
The Update Alarms command discards the current alarm list that is held in the
BACnet Server and reloads the active alarms from all devices and objects on the
network.
Search
The search lets you narrow down the number of active alarms that are displayed
in the alarm list.
Search matches the text fragment you enter with any occurrence of that fragment
in any field in an alarm notification, for the active alarms that are listed.
For example, enter temp in the search field to view only the active alarms in the
list in which temp or words that include the letters temp appear in the alarm
notification or in associated information such as alarm flags, assign to and notes.
The Filter dialog lets you search based on information in certain fields of an active
alarm. You can save the filters that you use regularly.
The Filter dialog is where you can create filters and apply them against the active
alarm list to test them.
The Filter dialog is hidden when it is not being used.
The filter button allow you to open the Filter dialog and the Manage Filter dialog.
To indicate that the displayed alarm list is a filtered view, the Filter button is
highlighted as follows: Filtered.
Advanced Filter Dialog
The Advanced Filter dialog lets you create a BACnet network-oriented filter to
filter across multiple sites, by device range, system and object type.
The Advanced Filter dialog is included as an option in the Filter dialog.
Manage Filters
The Manage Filters dialog allows a user to view and change the filter setting and
attributes of saved filters, depending on the user's permissions. Administrative
users are granted more capabilities than non-administrative users.
The Manage Filters dialog allows administrative users to assign filters to users
and groups and to subscribe users and groups to receive alarm notification
emails.
See Managing Filters for information about filter management capabilities for
administrative and non-administrative users.
The button lets you save the active alarms in the list to a file in PDF format.
The button lets you save the active alarms in the list to a file in CSV (Comma-
Separated Value) format.
Quickbar
The Quickbar pane holds the filters that you use frequently, which lets you activate
and deactivate them with a click. An activated filter is displayed with highlighting,
as for example, Today's Alarms. The Quickbar displays two default filters:
Critical and Today's Alarms. The Critical filter includes alarms that belong to the
Critical BACnet notification class. The Today's Alarms filter includes alarms that
were generated for the current day.
The Quickbar is consistent across the alarm lists for multiple sites and views.
That is, when you select different items in the Alarms section of the left navigation
pane, the Quickbar remains in place with the all the filters displayed.
An alarm flag is an attribute that you can assign to one or more alarms. Typically,
an alarm flag is used to mark a critical alarm or to assist you to implement a
workflow for managing certain types of alarms. Alarm flags have no inherent
meaning to enteliWEB.
enteliWEB has four built-in alarm flags: Nuisance, Important, Needs Repair,
Under Repair
Assign to
Assign to lets you associate an enteliWEB user with one or more alarms. By
assigning alarms to users, you can implement a workflow for delegating alarms.
Each user should create an "assigned to me" filter.
Notes
Notes lets you add comments about one or more alarms. Anyone who views the
alarm will see the notes.
Trend Log
The trend log pane displays a plot from the trend log object that is trending the
monitored object.
The trend log pane is hidden when there is no trend log to display.
History
The History pane displays a list of the recent activity for a selected alarm.
indicates that an operator acknowledge message is associated with the activity
Related Items
The Related Items pane lists all the links to associated objects, dashboards and
graphics that pertain to the monitored object for a selected alarm.
The Refresh Operation and the Update Alarm List Operation Perform
Different Functions
The Refresh operation updates the alarm list from enteliWEB's internal
alarm list.
Update Alarm List replaces enteliWEB's internal alarm list by uploading
all active alarms from the devices on the network.
Managing Filters
You manage filters to keep them current with your changing alarm management
needs. Administrative users are granted more filter management capabilities than
non-administrative users.
The Manage Filters dialog is provided for managing filters. The Manage Filters
dialog consists of two main parts: the filter list and the filter settings for the filter
you select in the filter list.
The filter management capabilities for administrative users and for non-
administrative users are described separately in the following sections.
See Permissions and Alarm Management for other aspects of user permissions
and alarms.
When the notification history window is pinned, it remains active and open at all
times. A user may or may not be present when new notifications are received and
he or she will not see the annunciation. Therefore, a new alarm notification is
identified with a shaded background until it is cleared by the user.
Notification Sound
An alarm notification can be annunciated by sound at the user's workstation. You
choose the sounds by adding the sound files to the enteliWEB server and
assigning them to alarm groups. A different sound can be played for each alarm
group.
The notification sound is enabled or disabled in the user settings by the
administrator.
The notification sound can be disabled for certain alarms when an alarm list filter
has Exclude from Alarm Notification selected.
Emailing Notifications
By subscribing to email in an filter, a user can receive an email message for every
alarm or alert notification that matches the filter. The email is sent to the address
that is specified in the user settings.
See Managing Filters for information about subscribing to alarm or alert
notification by email.
Email notification is not enabled and disabled by the Alarm Notification setting in
the user settings.
Email notifications are not sent to disabled users.
See Permissions and Notifications for information about user permissions and
email notifications.
A user's email address is specified in the user settings email address.
Alerts Concepts
An alert is an alarm that reports a problem with an internal system, module, or
connection. Associated with each alert is a rule, which uses a built-in algorithm to
detect alarm states.
There are three types of alerts: system alerts, energy alerts, and application
module alerts.
System Alerts
System alerts are generated according to rules, which monitor specific systems,
connections, or devices. These rules can't be created or deleted.
There are five system rules:
l CopperCube Connection Detection
l Device Offline Detection
l Historian Offline Detection
l Service Monitor
l System Messages
To monitor a device with the rule, you must create a Device Offline Detection alert.
enteliWEB does not detect offline devices or generate alert notifications for offline
devices by default.
When an alert is created using the Device Offline Detection rule, an alert
notification is generated whenever the BACnet Server can no longer communicate
with the selected device(s). A configurable time delay lets you exclude intermittent
anomalies that you don't want to be notified about.
You can monitor any number of devices. The monitored devices remain defined
when an offline device is removed or when a Reinitialize Descriptors command is
given. Devices are no longer monitored when a site is deleted.
The frequency at which enteliWEB monitors an online device depends on the
device. Certain types of devices, such as enteliBUS controllers, are treated with
higher importance and are therefore checked more frequently.
The following table displays the poll frequency for common device types.
When a device is offline, enteliWEB monitors the device to detect when it comes
back online using the following timings.
The algorithm used by the Device Offline Detection rule is named Device Offline
Detection.
System messages that are not assigned to a user are deleted after 24
hours.
Energy Alerts
You can create any number of energy rules and alerts. Rules are used to monitor
the data that the energy management system imports from an area or a meter. An
alert notification is generated when an anomaly is detected in the imported data,
or when the imported data is significantly different from the target data.
Energy alerts have three components: rules, monitored objects, and configuration
parameters.
Rules
An energy rule is defined by the algorithm that you assign to it when you create
the rule. The algorithms are built into enteliWEB and can't be changed.
The anomaly detection algorithm calculates the arithmetic mean and the standard
deviation of the meter data that has been imported during the previous calendar
month. For example, if the current month is November, the previous calendar
month was October. Then it calculates the mean of the meter data of the previous
full hour. For example, if the current time is 11:28 AM, the previous full hour was
from 10:00 AM to 10:59 AM.
The algorithm calculates whether the mean data of the previous hour is within the
specified number of standard deviations of the mean data of the previous month. If
it is outside that range, the algorithm reports an anomaly, generating an alert
notification and setting the status of the alert to Alarm. If no meter data is found,
the status of the alert is set to Fault.
You must specify the type of data to monitor, such as electric consumption or gas
volume, and the number of standard deviations that must be exceeded for an
anomaly to be detected.
Target Algorithm
The target algorithm compares the consumption measured for a datapoint against
its target consumption for a specified time period. When the measured
consumption reaches a specified percentage of the target consumption, an alert is
generated and the status of the alert is set to High Limit. The status of the alert is
set to Fault when no target is set or when a consumption value is not found.
You must specify the type of data to monitor, such as electric consumption or gas
volume, the time range of data to monitor, and the threshold as a percentage of
the target consumption.
See Area and Meter Configuration for information about how to specify the target
data.
Rolling Target Algorithm
The rolling target algorithm compares the actual meter consumption against its
target consumption over a number of intervals. When the actual consumption
exceeds the target consumption by a specified percent, an alert is generated. The
status of the alert is set to Fault when no target is set or when a consumption
value is not found.
You must specify the type of data to monitor, such as electric consumption or gas
volume, the time range of data to monitor, the number of intervals to compare the
meter consumption and target consumption, and the threshold as a percentage of
the target consumption.
See Area and Meter Configuration for information about how to specify the target
data.
Monitored Objects
The monitored object defines the source of the data that the energy alert is
monitoring.
The source can be an area or a meter. An area represents a collection of meters
that is typically organized based on their physical location or function. A meter is a
collection of BACnet objects that read data from a physical meter. Typically, two
objects are required: one for consumption and another for demand.
See Area and Meter Configuration for information about areas and meters.
Configuration Parameters
The configuration parameters allow you to tailor the energy rule in following ways:
l Fine-tune the operation of the algorithm by tweaking certain parameters.
l Specify or create the notification class that is associated with the alert
notifications for the rule.
l Specify a meaningful name for the rule.
Alert Notifications
Like other alarm notifications, alert notifications can be assigned to another user
for investigation, searched, filtered, sent via email, and so on. See Alarm and
Alerts Tasks for more details.
An alert is prioritized on the Alarm and Alert List page in the same way that an
alarm is prioritized: by the alarm group that it is a member of. Alarm group
membership for an alert is determined by the notification class that is associated
with the alert rule. Alerts that use the same rule have the same priority.
System alerts are associated with the Critical notification class. When alarm list
filters are set to filter only on Critical, then both the alarms and the alerts that are
associated with Critical are listed or included in an email. To include only alerts,
the filter needs to exclude all sites.
When creating an energy rule, you can create a pseudo Notification Class (EVC)
object that is specifically for alerts. These objects are assigned an instance
number of 1000 or greater (to prevent conflicts with other EVC objects on the
BACnet network) and given a BACnet priority of 170.
The following paragraphs describe the information items that are shown in the
preceding Organization of Information in an Active Alarm Listing illustration.
Monitored Object
monitored object is the icon and name of the object that is in alarm or fault. Also a
link to the object page. When you hover the mouse cursor over the monitored
object name then its complete object reference is displayed.
When you select Network as the source of active alarms in the left navigation
pane, each monitored object also displays their site name in square brackets.
When config.xml is used to display an object name as both object name and object
description then monitored object obeys that setting.
Assigned To
assigned to is an optional item that indicates the username of the enteliWEB user
who is associated with the alarm.
Status Icon
status icon provides a visual indication of the status of the monitored object, as
reported by the corresponding alarm notification. The possible status icons are as
follows:
Alarm Notification
alarm notification is the text message that is included in the corresponding alarm
notification. The most recent alarm notification is listed first
Ack Flag
Filter Dialog
The filter dialog lets you apply more than one filter dialog setting to the alarm or
alert list. Multiple filter dialog settings are ANDed to create a composite filter.
The following paragraphs describe each filter dialog setting as shown in the above
image.
Alarm Group
Alarm Group specifies one or more alarm group names. When an alarm that is of
a notification class or of a BACnet priority that matches one of the alarm groups,
then that alarm is listed in the Alarm List page. Alarms that do not match are not
listed.
Alternatively, when exclude is selected then the alarms that don't match any of
the specified alarm groups are listed in the Alarm List page.
Notification Class
Notification Class specifies one or more classes or category names from a list of
all classes or categories that enteliWEB is aware of, for all the modules that
enteliWEB is aware of.
When an alarm is of a class or category that matches one of those that you
specified, then that alarm is listed in the Alarm List page. Alarms that do not
match are not listed.
Alternatively, when exclude is selected then the alarms that don't match any of
the specified notification classes are listed in the Alarm List page.
In the selection list, each notification class is displayed as notification class name
(EVC object instance). For example, Critical (2). The categories in the list do not
have numbers in parentheses following their names.
In the selection list, you may see a notification class with more than one number
in parentheses. In this case, the right-most number is the EVC object instance.
The other numbers are part of the notification class or EVC object name. The
numbers included in the name were added when the object was copied. These
objects should be renamed to remove the numbers.
There are two Critical notification classes: alarms use the BACnet - Critical
notification class whereas alerts use the Alert - Critical notification class.
Alarm State
Alarm State specifies one or more alarm states that are specified in all EVC
objects that enteliWEB has found on the network. When an alarm that is of an
alarm state that matches one of the alarm states, then that alarm is listed in the
Alarm List page. Alarms that do not match are not listed.
Alternatively, when exclude is selected then the alarms that don't match any of
the specified alarm states are listed in the Alarm List page.
Assigned To
Assigned To specifies the usernames of one or more enteliWEB users to which
alarms have been assigned. When an assigned alarm matches one of the
usernames, then that alarm is listed in the Alarm List page. Alarms that do not
match are not listed. The match must be complete, that is, for similar usernames,
only alarms in which the assigned username fully matches the Assigned To
username will satisfy the filter.
When Assigned To is blank, then the alarm's assigned to status is not considered.
Alternatively, when exclude is selected then the alarms that aren't assigned to any
of the users that are specified in the Assigned To field are listed in the Alarm List
page.
Alarm Flags
Alarm Flags specifies one or more of the alarm flags that can be added to an
alarm: Nuisance, Needs Repair, Important, Under Repair. When an alarm matches
one of the flags that you specify in the Alarm Flags field, then that alarm is listed
in the Alarm List page. Alarms that do not match are not listed.
Alternatively, when exclude is selected then the alarms that are not flagged or are
flagged with a flag that is not specified in the Alarm Flags field are listed in the
Alarm List page.
Ack Flags
Ack Flags specifies the acknowledged status of the alarms you want to be
displayed on the Alarm List page. When an alarm matches the flag that you
selected in the Ack Flags field, then that alarm is listed in the Alarm List page.
Alarms that do not match are not listed.
Select Acknowledged to list only the alarms in which the most recent alarm
notification does not require an acknowledgment. That is, it doesn't display .
Select Acknowledgement Required to list only the alarms in which the most
recent alarm notification requires an acknowledgment. That is, it displays .
When neither Ack Flag is selected, then the alarm's acknowledged status is not
considered.
Alarm Text
Alarm Text specifies a text phrase or fragment in the alarm text portion of the
notification for the alarms you want to be displayed on the Alarm List page. When
alarm text matches the text that you specify in the Alarm Text field, then that
alarm is listed in the Alarm List page. Alarms that do not match are not listed.
The filter performs the alarm text matching as case independent.
Priority
Priority specifies a range of numbers representing priority of a notification. A
notification with priority in the range that you specify is listed in the Alarm List
page. Notifications with priority that is outside the range are not listed.
When the notification originates from a BACnet device, priority is the BACnet
priority.
Start
Set the field labeled End to the highest number in the range.
When the End field is blank, then the filter assumes it is set to 255.
Date/Time
An alarm with an alarm notification that was time-stamped in the time range that
you specify is listed in the Alarm List page. Alarm notification that are time-
stamped outside the time range are not listed.
Date/Time lets you specify one of the following time ranges:
Today
Matches active alarms with an alarm notification that was time-stamped in the
date and time range you specify. You can use any combination of the four Date
Range fields to specify the exact the time range you want. Start date must be
earlier than or the same as End date, when you are using both date fields.
Alert
Alert specifies one or more sources for alerts that are present on the enteliWEB
server. By choosing an alert source for this field, you override the source that you
selected by the navigation tree.
When an application module that has been implemented with the enteliWEB API
uses the alarm management system, then its name is specified as a source for
alerts.
When an alert that is from a source that matches one of the specified sources,
then that alert is listed in the Alarm List page. Alerts that do not match are not
listed.
The Alert field is displayed for alerts only. When you are viewing alarms, the Alert
field is not displayed.
Object
Object specifies some text that you want to match with object information related
to an alert, such as the object name, the object type or the object reference. The
matching is case-insensitive.
The Object field is displayed for alerts only. When you are viewing alarms, the
Object field is located in the advanced filter.
Advanced Filter
The Advanced Filter dialog is displayed for alarms only. When you are viewing
alerts, the Advanced Filter dialog is not displayed.
Site
Site specifies one or more site names. When an alarm is from any of the specified
sites, then that alarm is listed in the Alarm List page. Alarms that do not match
are not listed.
When one or more sites are specified in the Site field, then the source that you
selected in the Alarms section of the left navigation pane is superseded or
overridden by these sites, in the filter.
When the Site field is blank then the site that you have selected in the Alarms
section of the left navigation pane is used.
Device Range
Device Range specifies a range of device addresses. When an alarm is from any of
the devices with an address in the range of device addresses, then that alarm is
listed in the Alarm List page. Alarms that do not match are not listed.
The device address you enter in the field labeled Start must be less than or equal
to the device address you enter in the field labeled End.
When the Device Range fields are blank then an alarm that is from any of the
devices from the source or sources is listed in the Alarm List page.
System
System specifies one or more system names. When an alarm is from any of the
objects that are associated with a system, then that alarm is listed in the Alarm
List page. Alarms that do not match are not listed.
When one or more systems are specified in the System field, then the source that
you selected in the Alarms section of the left navigation pane is superseded or
overridden by these systems, in the filter.
Object
Object specifies some text that you want to match with object information such as
the object name, the object type or the object reference. The matching is case-
insensitive.
When an alarm is from a matching object, then that alarm is listed in the Alarm
List page. Alarms that do not match are not listed.
Some examples:
AV2* selects alarms from all AV objects with instances that starts with AV2,
such as AV2, AV21, AV232 on so on.
AV2 selects alarms from AV2 objects only
5600.AV* selects alarms from all AV objects on device 5600
*107 selects alarms from all objects with instance number or object name
that ends in 107
You can enter multiple items that are comma-separated in the Object field. When
multiple items are entered, an alarm that matches one or more item is listed.
Filter Attributes
The filter attributes described in the following sections are displayed in the
Manage Filters dialog.
Add to Quickbar
Select Add to Quickbar when you want the filter to be accessible from the
quickbar.
To remove the filter from the quickbar, clear this attribute from the filter.
A filter that is subscribed to users must have Add to Quickbar selected to allow
the subscribed users to apply it.
Subscribe to Email
The Subscribe to Email setting is available to a user who is not a member of a
group with Manage Alarms permission.
Select Subscribe to Email when you want alarm or alert notifications that match
the filter to be emailed to you. The email messages are sent to the address you
specify in your user information settings.
When you select this attribute, the alarm or alert notifications that match the filter
are emailed to you regardless of any other filter that is currently in effect on the
Alarm Lists page.
To stop receiving email, clear this attribute from the filter.
Alarm Details
Alarm Flags
An alarm flag is an attribute that you can assign to one or more selected alarms.
Typically, an alarm flag is used to mark a critical alarm or to assist you to
implement a workflow for managing certain types of alarms.
Alarm flags have no inherent meaning to enteliWEB. They do, however, provide
additional options that you can use in a filter.
The following alarm flags are built-in to enteliWEB:
l Nuisance
l Important
l Needs Repair
l Under Repair
Assign To
Assign To specifies an enteliWEB user that you can assign one or more selected
alarms to. By assigning an alarm to a user, you can implement a workflow for
managing certain types of alarms.
Notes
Notes lets you add comments about one or more selected alarms.
Notes are included in the email message for this alarm.
The Alarm Flags, Assign To assignments, and Notes information that you enter for
an alarm are saved by enteliWEB. Then, when the same alarm occurs again and is
listed on the alarms list, the Alarm Flags, Assign To, and Notes from the previous
occurrence of that alarm are displayed.
Selecting the Source for Alarms or Alerts in Alarm and Alert List
1. In the left navigation pane in the Alarms section, navigate the tree view to
locate the source you want to list the alarms or alerts for.
2. Select the source. The Alarm List page opens to display the alarms or alerts
from the selected source.
Select Update Alarm List from the Command list. All alarms in the BACnet
Server's alarm table are deleted. The BACnet Server uploads all alarms from the
source devices and objects.
This command is displayed only for users who are members of a group with
Manage Alarms permission.
1. On the left Alarms section, expand Network and click the site name that
contains the alarms you're interested in.
2. Select the alarm or alarms you want to delete from the Alarm List page.
3. Select Delete Alarm from the Command list or press the Delete key on
your keyboard. A confirmation dialog opens.
4. Click Yes to delete the selected alarms from the alarm list
The deleted alarms are no longer viewable by any user.
Acknowledging an Alarm
1. On the left Alarms section, expand Network and click the site name that
contains the alarms you're interested in.
2. Select the alarm you want to acknowledge. Only an alarm that displays
can be acknowledged.
3. Click Acknowledge in the Flags, Notes and Assign To pane,
Or
Click
4. The Acknowledge Message dialog opens. Enter a brief message to describe
your acknowledge action. The acknowledge message is optional, it can
remain blank.
Click Acknowledge to save the message and to send an acknowledge
indication to the device.
5. See Verifying that an Alarm Acknowledgment is Confirmed.
You can also acknowledge alarms from the notification history window.
l When the alarm remains active after the acknowledgment, then the
alarm remains on the alarm list but the is removed.
l The confirmation is recorded in the History pane.
Error Result
1. On the left Alarms section, expand Network and click the site name that
contains the alarms you're interested in.
2. Identify the alarms you want to acknowledge by selecting the corresponding
checkboxes. Only alarms that display can be acknowledged.
3. Click Acknowledge in the Flags, Notes and Assign To pane,
Or
1. On the left Alarms section, expand Network and click the site name that
contains the alarms you're interested in.
1. On the left Alarms section, expand Network and click the site name that
contains the alarms you're interested in.
2. Select the alarm you want to add the flag to. The alarm details are displayed.
3. Select the flag or flags that you want to add to the alarm.
4. Click Save. See Saving Alarm Details to understand how the result of the
save operation is displayed.
1. On the left Alarms section, expand Network and click the site name that
contains the alarms you're interested in.
2. Select the alarm you want to assign. The alarm details are displayed.
3. Select the user you want to assign the alarm to, from the Assign To list of
users.
4. Click Save. See Saving Alarm Details to understand how the result of the
save operation is displayed.
1. On the left Alarms section, expand Network and click the site name that
contains the alarms you're interested in.
2. Select the alarm you want to add the note to. The alarm details are displayed.
3. Enter the text into the Notes field.
4. Click Save. See Saving Alarm Details to understand how the result of the
save operation is displayed.
Search Tasks
1. On the left Alarms section, expand Network and click the site name that
contains the alarms you're interested in.
2. In the Search field, enter the characters that you want to search for in the
listed active alarms.
Using the asterisk "*" character for a wildcard search is not supported in the
Search field. To perform a wildcard search for objects, use the Object field in
the Advanced filter.
3. Press Enter to start the search. The alarm list is updated to list the active
alarms that match the active filters.
Clearing a Search
1. Delete the characters in the Search field.
2. Press Enter. The alarm list is updated to list all active alarms, or, when a
filter is active, to list the active alarms that match the filter.
Filter Tasks
To indicate that the listed alarms is a filtered view, the Filter button
changes to Filtered.
5. To save the filter, see Saving a Filter for procedure.
To cancel or reset the filter, see Resetting or Canceling a Filter for
procedure.
1. On the left Alarms section, expand Network or Alerts, and click the
site name, Energy or System to open the list of alarms or alerts.
2. Click Filter. The Filter dialog opens.
3. Select the filter settings you want, in the Filter dialog. See Filter Dialog for a
description of the filter settings.
4. Click Advanced Filter Scope. The advanced filter dialog opens.
5. Select the advanced filter settings you want, in the Advanced Filter Scope
dialog. See Advanced Filter for a description of the advanced filter settings.
6. Click Apply. The alarm list is updated to display only the alarms that match
the active filters. The alarm source you chose in the left navigation pane is
ignored or overridden when you choose items in the advanced filter.
To indicate that the listed alarms is a filtered view, the Filter button
changes to Filtered.
7. To save the filter, see Saving a Filter for procedure.
To cancel or reset the filter, see Resetting or Canceling a Filter for
procedure.
Saving a Filter
1. On the left Alarms section, expand Network or Alerts, and click the
site name, Energy or System to open the list of alarms or alerts.
2. Create a filter. See Creating and Applying a Filter or Creating and Applying an
Advanced Filter for procedure.
3. Click Save Filter. The Add New Filter dialog opens.
4. Enter a name for the filter, in the Name field.
5. Click Save to save the filter. When you open the Manage Filters dialog, this
filter is listed under your username.
To select the filter attributes that you want to be in effect for this filter, click
Manage Filters and select the attributes. See Filter Attributes for information
about the filter attributes.
On the left Alarms section, expand Network or Alerts, and click the site
name, Energy or System to open the list of alarms or alerts.
The filter is deleted from your list of filters and it is removed from the quickbar.
Quickbar Tasks
1. On the left Alarms section, expand Network and click the site name that
contains the alarms you're interested in.
2. Create and apply the filter for the alarm notifications that you want to capture
in the PDF file. See Creating and Applying a Filter or Creating and Applying
an Advanced Filter for procedure.
3. Click . The PDF file is saved to your browser's download destination. Now
you can print the document.
1. On the left Alarms section, expand Network and click the site name that
contains the alarms you're interested in.
2. Create and apply the filter for the alarm notifications that you want to capture
in the CSV file. See Creating and Applying a Filter or Creating and Applying an
Advanced Filter for procedure.
3. Click . The CSV file is saved to your browser's download destination.
Delimiters used in CSV file are based on locale of user who downloads
the samples. User who imports the CSV into Excel must use same locale.
1. On the left Alarms section, expand Network and click the site name that
contains the alarms you're interested in.
1. On the left Alarms section, expand Network and click the site name that
contains the alarms you're interested in.
5. Click Apply to update the filter. is no longer displayed for the filter in the
Subscription column.
You will no longer receive emails about alarm notifications that match the
filter.
1. On the left Alarms section, expand Network and click the site name that
contains the alarms you're interested in.
Notifications Tasks
1. On the left Alarms section, expand Network and click the site name that
contains the alarms you're interested in.
5. Click Apply. is displayed for the filter in the Exclude Notifications column.
1. On the left Alarms section, expand Network and click the site name that
contains the alarms you're interested in.
To hide the notification history window, click the alarm notification indicator. To
hide the notification history window, it must not be pinned.
Monitoring Parameters
The AT object page presents the following information to allow you to monitor the
operation of the totalizer.
Value Bar
The Value Bar displays the object's present value and the object's mode.
In Auto mode, the present value represents the accumulated quantity of the
measured variable since the AT object was reset.
In Manual mode, the present value represents the accumulated quantity of the
measured variable when the object was set to Manual mode or to the value that
was entered manually.
Start Time
Start Time displays the date and time when the AT object's accumulated value was
reset to zero. Start Time indicates when the AT object started to accumulate its
current value.
Monitored Object
Monitored Object specifies the object that provides the measured variable that is
to be accumulated or totalized. Monitored Object must be one of the following
object types: Analog Input, Analog Output, Analog Value or Pulse Input object.
Monitoring Parameters
The BT object page presents the following information to allow you to monitor the
operation of the totalizer.
Value Bar
The Value Bar displays the object's present value and the object's mode.
In Auto mode, the present value represents the accumulated time in hours that a
binary object has been in its active state since the BT object was reset.
In Manual mode, the present value represents the accumulated time that a binary
object has been active when the object was set to Manual mode or to the value
that was entered manually.
Since
Since displays the date and time when the BT object was reset and the
accumulated time was reset to zero .
sample to be recorded in a trend log and to cause a COV data exchange message
to be sent.
Monitoring Parameters
The CO object page presents the following information to allow you to monitor the
operation of the control loop.
Value Bar
The Value Bar displays the object's present value and the object's mode: Auto,
Manual .
Auto Mode
In Auto mode, the CO object's present value is the control loop output that is
calculated according to the configuration of the CO object.
Input Source
Input Source displays the name of the object that provides the input value being
monitored by the CO object.
Input Value
Input Value displays the value being received from the Input Source by the CO
object.
Input Value is displayed to the same precision that it is on the referenced AI
object's page.
Setpoint Source
Setpoint Object displays the name of the object that provides the setpoint being
monitored by the CO object when you are using a setpoint that varies such as from
Setpoint Value
Setpoint Value displays the value being received from the Setpoint Source by the
CO object or the fixed value set by the CO object.
When the OS object achieves its target temperature before the scheduled
occupancy time, it remains On until the referenced schedule transitions to On or
occupied. The OS object transitions to Off when the referenced schedule
transitions to On or occupied.
History
The History section of the OS object page displays the results of the three most
recent active periods for the OS object. The information is presented in a tabular
format and a chart format.
History Table
Example History Table
Date and time when the OS object transitioned to the On state at the calculated
optimal start time.
Indoor
Date and time when the OS object transitioned to the Off state, at the scheduled
occupancy time.
Status
OS object status at the scheduled occupancy time when the OS object transitioned
to the Off state. See the Control Information, Status section, above for details
about OS object status.
Target
Indoor temperature when the OS object transitioned to the Off state at the
scheduled occupancy time.
Rate
Heating or cooling rate, in degrees per hour, that was achieved during the OS
object's On state.
History Chart
The history chart displays in line graph format, the data in the history table. The
history chart lets you understand at a glance, the recent performance of the OS
object.
The chart below plots the data from the example table above.
Legend
Monitoring Parameters
The OS object page presents the following information to allow you to monitor the
operation of optimum start.
Value Bar
The Value Bar displays the object's present state and the object's mode.
In Auto mode, the present state is On when the OS object is actively involved in
heating or cooling the building and Off when it is not active.
In Manual mode, the present state is the manually selected value.
Status
Status displays the phase of operation of the OS object, as follows:
Heating Start
The OS object is causing the space to be warmed in preparation for scheduled
occupancy.
Cooling Start
The OS object is causing the space to be cooled in preparation for scheduled
occupancy.
Achieved
The OS object has caused the space to reach its target temperature before the
scheduled occupancy time.
Off
The OS object is not participating in temperature control of the space. In the
history table, a status of Off indicates that the target temperature was met exactly
at the scheduled occupancy time or that the OS object under-achieved the target
temperature at the scheduled occupancy time.
Fault
The OS object is in fault.
Start Type
Start Type displays Heating when the OS object is configured to warm the space
during the object's active state.
Start Type displays Cooling when the OS object is configured to cool the space
during the object's active state.
Target Temperature
Target Temperature displays the space temperature that the OS object is
expected to achieve prior to scheduled occupancy.
Indoor Temperature
Indoor Temperature displays the space temperature when the OS status is
Heating Start, Cooling Start or Achieved. When the OS object is inactive, Indoor
Schedule
Schedule displays the name of the schedule object that provides the occupancy
times to the OS object.
Schedule Next On at
Schedule Next On at displays the time when the next scheduled occupancy period
starts.
O3 Access Reports
For information about O3 Access reports, see O3 Access Reports Concepts.
Energy Reports
For information about energy reports, see Energy Reports Concepts.
Reports Tasks
Tasks on this page assume you are viewing a report page.
Creating a Report
Scheduling a Report
Set up enteliWEB to generate a specific report automatically on a specific date, or
periodically.
1. Open Reports in the left pane navigation tree and select a saved report.
2. On the top right side of the screen, click Schedule. The Schedule a Report
page opens.
3. See the Help for the Schedule a Report page for information about
scheduling a report.
You can also schedule reports by going to > Report Scheduling > Schedule a
Report.
Deleting a Report
1. In the Reports section of the left pane navigation tree, click the saved report
you want to delete. The report opens in the right pane.
2. Click Delete. A confirmation dialog opens.
3. Click Yes to delete the report. The link to the report is removed from the
Reports section of the left pane navigation tree.
2. On the top right side of the screen click Report History and select the
report by date and time that you want to view from the list.
Exporting a Report
For best results when exporting to Excel, in the Edit Report Format
dialog, remove the Show in Groups setting and make the column that was
used for the grouping visible.
1. In the Reports section of the left pane navigation tree, click the saved report
you want to export and run it, or select the report from the report history list.
The report opens in the right pane.
2. On the top right side of the screen, click the button that corresponds to the
format you want the exported report to be saved to, from the following
formats:
Excel
PDF
PowerPoint
Word
3. Your browser downloads the report to a file in your downloads destination.
Emailing a Report
1. Configure an email server for enteliWEB.
2. In the Reports section of the left pane navigation tree, click the saved report
you want to send by email and run it, or select the report from the report
history list. The report opens in the right pane.
3. On the top right side of the screen, click Email. The Email dialog opens.
4. Enter the email address of the recipient you want to send the report to.
5. Click OK. enteliWEB attempts to send the report by email.
When the email is sent successfully, a dialog is displayed with the message:
Email sent successfully.
When the email is not sent successfully, a dialog is displayed with the
message: Failed to send email.
Copying a Report
1. In the Reports section of the left pane navigation tree, click the saved report
you want to copy. The report opens in the right pane.
2. Click Copy. The Copy dialog opens.
3. Enter a unique name for the copy of the report.
4. Click OK. A link to the copy of the report is added in the Reports section of
the left pane navigation tree. The copy of the report is displayed in the right
pane.
Occupied
Report Name Temperature Cost
Unoccupied
Consumption
Consumption by Meter
Occupied
Report Name Temperature Cost
Unoccupied
Consumption by Time
Consumption Comparison
Consumption Target
Contribution Comparison
Cost Ranking
Cumulative Consumption
Daily Average
Degree Days
Load Duration
Single Meter Occupancy
The rules for each type of report are described in the Meters Included section on
the help page for each report. To view a report's help page, select the report you
are interested in from the Report Name column of the Which Report do I Want
table.
Consumption Report
About the Consumption Report
For a single meter, area, building, region or meter group, the Consumption report
lets you view the following energy data over time:
l energy consumption or production. Production energy data is represented in
the report as negative consumption values.
l peak demand
l minimum demand for one year for a single meter, area, building, region, or
meter group
The report also contains the average monthly temperatures for the selected year,
when temperature data is available.
When baseline and target data are available then they are also included in the
report.
The results are presented as a bar chart and in tabular format, in increments of
one month.
Meters Included
If there are no groups in the Area/Meter List, then the first meter in the list is
included in the report.
If there are one or more groups in the Area/Meter List, then the first group, area
or meter is included in the report.
Limitations
Only data from one group, area or meter is included in the report.
If you want to see data from multiple groups, areas, or meters, use the
Consumption by Meter report or Consumption by Time report.
Report Parameters
Area/Meter List
The Area/Meter List specifies the areas, buildings, regions, and meters that you
want the report to include data for.
The Consumption report is limited to the maximum number of meters indicated in
Limitations.
Meter Group
Meter Group lets you specify an empty group for the of Area/Meter List. You can
then add arbitrary areas, buildings, regions, and meters to that group. The report
is generated by grouping the data of the items in a group.
To learn how to create a meter group, see Creating a Meter Group.
Report Name
Report Name specifies the name of the link that appears in the Energy Reports
section of enteliWEB's left pane tree view under Consumption, when you save your
report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Meter Type
Meter Type specifies the type of energy or resource that the report includes data
for.
When you change Meter Type, you are forced to specify the Area/Meter List again.
Site
Site specifies the site name that you want to appear on the report for site.
Site can be any arbitrary name. It does not have to be the same as a site that is
configured into enteliWEB.
Date/Time Format
Date/Time Format specifies the format of the date and time that is displayed in
the upper right corner of the report.
Year - Baseline
Year in the Baseline area specifies the year that is considered to be the baseline
data in the report.
Meters Included
The Consumption by Meter report examines the Area/Meter List and includes the
data from the meter or meters from each item in the list. When it encounters an
item that contains no meters, it ignored that item and moves on to the next item in
the list.
When the item is a meter, then that meter is included in the report.
When the item is an area, building or region, then the child meters of that parent
are included in the report.
When the item is a meter group, then the meters in that group are included in the
report.
Limitations
Up to nine meters, areas, buildings, regions, or meter groups can be included in
the report. Subsequent items in the Area/Meter List are ignored.
Report Parameters
Area/Meter List
The Area/Meter List specifies the areas, buildings, regions, and meters that you
want the report to include data for.
The Consumption by Meter report is limited to the maximum number of items
indicated in Limitations.
Meter Group
Meter Group lets you specify an empty group for the of Area/Meter List. You can
then add arbitrary areas, buildings, regions, and meters to that group. The report
is generated by grouping the data of the items in a group.
To learn how to create a meter group, see Creating a Meter Group.
Report Name
Report Name specifies the name of the link that appears in the Reports section of
enteliWEB's left pane tree view under Consumption by Meter, when you save your
report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Meter Type
Meter Type specifies the type of energy or resource that the report includes data
for.
When you change Meter Type, you are forced to specify the Area/Meter List again.
Site
Site specifies the site name that you want to appear on the report for site.
Site can be any arbitrary name. It does not have to be the same as a site that is
configured into enteliWEB.
Date Range
Date Range specifies the time period for the data over which the consumption and
demand is reported.
When Custom is selected, the From and To fields are displayed.
To - Date Configuration
To specifies the date when the custom date range ends.
Date/Time Format
Date/Time Format specifies the format of the date and time that is displayed in
the upper right corner of the report.
From - Occupancy
From specifies the time of day when the occupied period begins for occupied days.
To - Occupancy
To specifies the time of day when the occupied period ends for occupied days.
Days - Occupancy
Days specifies the day or days of the week that are considered to be occupied days
for the report. Choose All, Weekdays or Weekends from the list or select Other to
allow you to specify the exact weekday or days you want to be the occupied days.
Choosing no occupied days does not work.
Meters Included
The Consumption by Time report examines the Area/Meter List and includes the
data from the meter or meters from each item in the list. When it encounters an
item that contains no meters, it ignored that item and moves on to the next item in
the list.
When the item is a meter, then that meter is included in the report.
When the item is an area, building or region, then the child meters of that parent
are included in the report.
When the item is a meter group, then the meters in that group are included in the
report.
Limitations
Up to nine meters, areas, buildings, regions or meter groups can be included in
the report. Subsequent items in the Area/Meter List are ignored.
Report Parameters
Area/Meter List
The Area/Meter List specifies the areas, buildings, regions, and meters that you
want the report to include data for.
The Consumption by Time report is limited to the maximum number of items
indicated in Limitations.
Meter Group
Meter Group lets you specify an empty group for the of Area/Meter List. You can
then add arbitrary areas, buildings, regions, and meters to that group. The report
is generated by grouping the data of the items in a group.
To learn how to create a meter group, see Creating a Meter Group.
Report Name
Report Name specifies the name of the link that appears in the Reports section of
enteliWEB's left pane tree view under Consumption by Time, when you save your
report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Meter Type
Meter Type specifies the type of energy or resource that the report includes data
for.
When you change Meter Type, you are forced to specify the Area/Meter List again.
Site
Site specifies the site name that you want to appear on the report for site.
Site can be any arbitrary name. It does not have to be the same as a site that is
configured into enteliWEB.
Date Range
Date Range specifies the time period for the data over which the consumption and
demand data are reported.
When Custom is selected, the From and To fields are displayed.
To - Date Configuration
To specifies the date when the custom date range ends.
Group by
Group by specifies time intervals within the Date Range over which the
consumption is summed to provide a data point in the report.
Date/Time Format
Date/Time Format specifies the format of the date and time that is displayed in
the report.
From - Occupancy
From specifies the time of day when the occupied period begins for occupied days.
To - Occupancy
To specifies the time of day when the occupied period ends for occupied days.
Days - Occupancy
Days specifies the day or days of the week that are considered to be occupied days
for the report. Choose All, Weekdays or Weekends from the list or select Other to
allow you to specify the exact weekday or days you want to be the occupied days.
Choosing no occupied days does not work.
Meters Included
The Consumption Comparison report examines the Area/Meter List and includes
the data from the meter or meters from each item in the list. When it encounters
an item that contains no meters, it ignored that item and moves on to the next
item in the list.
When the item is a meter, then that meter is included in the report.
When the item is an area, building or region, then the child meters of that parent
are included in the report.
When the item is a meter group, then the meters in that group are included in the
report.
Limitations
Up to 9 meters, areas, buildings, regions or meter groups can be included in the
report. The 10th and subsequent items in the Area/Meter List are ignored.
Report Parameters
Area/Meter List
The Area/Meter List specifies the areas, buildings, regions, and meters that you
want the report to include data for.
The Consumption Comparison report is limited to the maximum number of items
indicated in Limitations.
Meter Group
Meter Group lets you specify an empty group for the of Area/Meter List. You can
then add arbitrary areas, buildings, regions, and meters to that group. The report
is generated by grouping the data of the items in a group.
To learn how to create a meter group, see Creating a Meter Group.
Report Name
Report Name specifies the name of the link that appears in the Reports section of
enteliWEB's left pane tree view under Consumption Comparison, when you save
your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Meter Type
Meter Type specifies the type of energy or resource that the report includes data
for.
When you change Meter Type, you are forced to specify the Area/Meter List again.
Site
Site specifies the site name that you want to appear on the report for site.
Site can be any arbitrary name. It does not have to be the same as a site that is
configured into enteliWEB.
Date Range
Date Range specifies the time period for the data over which the comparison is
reported.
When Custom is selected, the From and To fields are displayed.
To - Date Configuration
To specifies the date when the custom date range ends.
Group by
Group by specifies time intervals within the Date Range over which the
consumption is summed to provide a data point in the report.
Date/Time Format
Date/Time Format specifies the format of the date and time that is displayed in
the report.
Meters Included
The Consumption Target report examines the Area/Meter List and includes the
data from the meter or meters from each item in the list. When it encounters an
item that contains no meters, it ignored that item and moves on to the next item in
the list.
When the item is a meter, then that meter is included in the report.
When the item is an area, building or region, then the child meters of that parent
are included in the report.
When the item is a meter group, then the meters in that group are included in the
report.
Limitations
Consumption data from up to 9 meters, areas, buildings, regions or meter groups
can be included in the report. The 10th and subsequent items in the Area/Meter
List are ignored.
Report Parameters
Area/Meter List
The Area/Meter List specifies the areas, buildings, regions, and meters that you
want the report to include data for.
Meter Group
Meter Group lets you specify an empty group for the of Area/Meter List. You can
then add arbitrary areas, buildings, regions, and meters to that group. The report
is generated by grouping the data of the items in a group.
To learn how to create a meter group, see Creating a Meter Group.
Report Name
Report Name specifies the name of the link that appears in the Reports section of
enteliWEB's left pane tree view under Consumption Target, when you save your
report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Meter Type
Meter Type specifies the type of energy or resource that the report includes data
for.
When you change Meter Type, you are forced to specify the Area/Meter List again.
Site
Site specifies the site name that you want to appear on the report for site.
Site can be any arbitrary name. It does not have to be the same as a site that is
configured into enteliWEB.
Date Range
Date Range specifies the time period for the data over which the consumption
data is reported.
Select Custom when you want to specify a date range that is not covered by the
other options in the list.
To - Date Configuration
To specifies the date when the custom date range ends.
Group by
Group by specifies time intervals within the Date Range over which the
consumption is summed to provide a data point in the report.
Group by also affects how the target data is extrapolated to allow for an accurate
comparison for the time interval selected.
Date/Time Format
Date/Time Format specifies the format of the date and time that is displayed in
the report.
Meters Included
The Contribution Comparison report examines the Area/Meter List and includes
the data from the meter or meters from each item in the list. When it encounters
an item that contains no meters, it ignored that item and moves on to the next
item in the list.
When the item is a meter, then that meter is included in the report.
When the item is an area, building or region, then the child meters of that parent
are included in the report.
When the item is a meter group, then the meters in that group are included in the
report.
Limitations
Up to 9 meters, areas, buildings, regions or meter groups can be included in the
report. The 10th and subsequent items in the Area/Meter List are ignored.
Report Parameters
Area/Meter List
The Area/Meter List specifies the areas, buildings, regions, and meters that you
want the report to include data for.
The Contribution Comparison report is limited to the maximum number of items
indicated in Limitations.
Meter Group
Meter Group lets you specify an empty group for the of Area/Meter List. You can
then add arbitrary areas, buildings, regions, and meters to that group. The report
is generated by grouping the data of the items in a group.
To learn how to create a meter group, see Creating a Meter Group.
Report Name
Report Name specifies the name of the link that appears in the Reports section of
enteliWEB's left pane tree view under Contribution Comparison, when you save
your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Meter Type
Meter Type specifies the type of energy or resource that the report includes data
for.
When you change Meter Type, you are forced to specify the Area/Meter List again.
Site
Site specifies the site name that you want to appear on the report for site.
Site can be any arbitrary name. It does not have to be the same as a site that is
configured into enteliWEB.
Measurement Direction
Select Production if you are comparing production data and select Consumption if
you are comparing consumption data.
Date Range
Date Range specifies the time period for the data over which the comparison is
reported.
When Custom is selected, the From and To fields are displayed.
To - Date Configuration
From specifies the date when the custom date range ends.
Days
Days specifies which day or days of the week are included in the report. Choose
All, Weekdays or Weekends from the list or select Other to allow you to specify the
exact weekday or days you want in the report.
Date/Time Format
Date/Time Format specifies the format of the date and time that is displayed in
the upper right corner of the report.
Meters Included
The Cost Ranking report examines the Area/Meter List and includes the data from
the meter or meters from each item in the list. When it encounters an item that
contains no meters, it ignored that item and moves on to the next item in the list.
When the item is a meter, then that meter is included in the report.
When the item is an area, building or region, then the child meters of that parent
are included in the report.
When the item is a meter group, then the meters in that group are included in the
report.
Limitations
Consumption and demand data from up to 9 meters, areas, buildings, regions or
meter groups can be included in the report. The 10th and subsequent items in the
Area/Meter List are ignored.
Report Parameters
Area/Meter List
The Area/Meter List specifies the areas, buildings, regions, and meters that you
want the report to include data for.
The Cost Ranking report is limited to the maximum number of items indicated in
Limitations.
Meter Group
Meter Group lets you specify an empty group for the of Area/Meter List. You can
then add arbitrary areas, buildings, regions, and meters to that group. The report
is generated by grouping the data of the items in a group.
To learn how to create a meter group, see Creating a Meter Group.
Report Name
Report Name specifies the name of the link that appears in the Reports section of
enteliWEB's left pane tree view under Cost Ranking, when you save your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Meter Type
Meter Type specifies the type of energy or resource that the report includes data
for.
When you change Meter Type, you are forced to specify the Area/Meter List again.
Site
Site specifies the site name that you want to appear on the report for site.
Site can be any arbitrary name. It does not have to be the same as a site that is
configured into enteliWEB.
Date Range
Date Range specifies the time period for the data over which the costs are
reported.
Select Custom when you want to specify a date range that is not covered by the
other options in the list.
To - Date Configuration
From specifies the date when the custom date range ends.
Date/Time Format
Date/Time Format specifies the format of the date and time that is displayed in
the report.
Meters Included
The Cumulative Consumption report examines the Area/Meter List and includes
the data from the meter or meters from each item in the list. When it encounters
an item that contains no meters, it ignored that item and moves on to the next
item in the list.
When the item is a meter, then that meter is included in the report.
When the item is an area, building or region, then the child meters of that parent
are included in the report.
When the item is a meter group, then the meters in that group are included in the
report.
Limitations
Consumption data from up to 9 meters, areas, buildings, regions or meter groups
can be included in the report. The 10th and subsequent items in the Area/Meter
List are ignored.
Report Parameters
Area/Meter List
The Area/Meter List specifies the areas, buildings, regions, and meters that you
want the report to include data for.
The Cumulative Consumption report is limited to the maximum number of items
indicated in Limitations.
Meter Group
Meter Group lets you specify an empty group for the of Area/Meter List. You can
then add arbitrary areas, buildings, regions, and meters to that group. The report
is generated by grouping the data of the items in a group.
To learn how to create a meter group, see Creating a Meter Group.
Report Name
Report Name specifies the name of the link that appears in the Reports section of
enteliWEB's left pane tree view under Cumulative Consumption, when you save
your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Meter Type
Meter Type specifies the type of energy or resource that the report includes data
for.
When you change Meter Type, you are forced to specify the Area/Meter List again.
Site
Site specifies the site name that you want to appear on the report for site.
Site can be any arbitrary name. It does not have to be the same as a site that is
configured into enteliWEB.
Group by
Group by specifies time interval in the Date Range over which the consumption is
summed to provide a data point in the report.
Date Range
Date Range specifies the time period for the data over which the consumption
data is reported.
Select Custom when you want to specify a date range that is not covered by the
other options in the list.
To - Date Configuration
To specifies the date when the custom date range ends.
Date/Time Format
Date/Time Format specifies the format of the date and time that is displayed in
the report.
Meters Included
The Daily Average report examines the Area/Meter List and includes the data from
the meter or meters from each item in the list. When it encounters an item that
contains no meters, it ignored that item and moves on to the next item in the list.
When the item is a meter, then that meter is included in the report.
When the item is an area, building or region, then the child meters of that parent
are included in the report.
When the item is a meter group, then the meters in that group are included in the
report.
Limitations
Demand data from up to 8 meters, areas, buildings, regions or meter groups can
be included in the report. The ninth and subsequent items in the Area/Meter List
are ignored.
Report Parameters
Area/Meter List
The Area/Meter List specifies the areas, buildings, regions, and meters that you
want the report to include data for.
The Daily Average report is limited to the maximum number of items indicated in
Limitations.
Meter Group
Meter Group lets you specify an empty group for the of Area/Meter List. You can
then add arbitrary areas, buildings, regions, and meters to that group. The report
is generated by grouping the data of the items in a group.
To learn how to create a meter group, see Creating a Meter Group.
Report Name
Report Name specifies the name of the link that appears in the Reports section of
enteliWEB's left pane tree view under Daily Average, when you save your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Meter Type
Meter Type specifies the type of energy or resource that the report includes data
for.
When you change Meter Type, you are forced to specify the Area/Meter List again.
Site
Site specifies the site name that you want to appear on the report for site.
Site can be any arbitrary name. It does not have to be the same as a site that is
configured into enteliWEB.
Rollup Minutes
Rollup Minutes specifies the time interval in minutes over which the demand is
averaged for each data point on the report.
Date Range
Date Range specifies the time period for the data over which the average demand
is reported.
When Custom is selected, the From and To fields are displayed.
To - Date Configuration
To specifies the date when the custom date range ends.
Days
Days specifies which day or days of the week are included in the report. Choose
All, Weekdays or Weekends from the list or select Other to allow you to specify the
exact weekday or days you want in the report.
Date/Time Format
Date/Time Format specifies the format of the date and time that is displayed in
the upper right corner of the report.
Period - Baseline
Period displays the date range for the baseline data. When you specify Date Range
then Period adjusts automatically to match.
Offset By - Baseline
Offset By specifies the time period by which the baseline date range precedes the
date range for the current data.
For example, when Date Range is set to Previous Month and you want to show
baseline data for the same month of the previous year, then set Offset By to 12
months.
When Offset By is set to Other, the Starting Date field is displayed.
Degree days are a form of weather data, calculated from readings of outside air
temperature. Heating degree days and cooling degree days are used extensively in
calculations relating to building energy consumption.
Heating degree days are a measure of how much and for how long the outside air
temperature was below the base temperature. The base temperature of a building
is the temperature below which the building needs to be heated.
Cooling degree days are a measure of how much and for how long the outside air
temperature was above the base temperature. The base temperature of a building
is the temperature above which the building needs to be cooled.
Meters Included
This report requires a single outdoor air temperature datapoint. No energy
meters are required or included in the report.
Limitations
Only 1 area and the data from the outdoor air temperature datapoint associated
with that area is used. When multiple areas each with an outdoor air temperature
datapoint are configured in Selected Area/Meter list, the report is based on one of
the outdoor air temperature datapoints.
Report Parameters
Meter Group
It is not necessary to create a meter group for this report because the report uses
only one OAT datapoint.
To learn how to create a meter group, see Creating a Meter group.
Report Name
Report Name specifies the name of the link that appears in the Reports section of
enteliWEB's left pane tree view under Degree Days, when you save your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Site
Site specifies the site name that you want to appear on the report for site.
Site can be any arbitrary name. It does not have to be the same as the name of a
site that is configured into enteliWEB.
Base Temperature
Base Temperature specifies the outdoor temperature below which the building
needs to be heated and above which the building needs to be cooled.
The unit for Base Temperature is specified by Outdoor Temp on the Base Units
Configuration page.
Meter Type
No energy meters are required or included in the report. The Meter Type setting
has no effect on the degree-day report.
Date Range
Date Range specifies the time period for the data over which the degree days are
reported.
Select Custom when you want to specify a date range that is not covered by the
other options in the list.
To - Date Configuration
To specifies the date when the custom date range ends.
Group by
Group by specifies time intervals within the Date Range over which the degree
days are summed to provide a data point in the report.
Date/Time Format
Date/Time Format specifies the format of the date and time that is displayed in
the report.
Meters Included
The Daily Average report examines the Area/Meter List and includes the data from
the meter or meters from each item in the list. When it encounters an item that
contains no meters, it ignored that item and moves on to the next item in the list.
When the item is a meter, then that meter is included in the report.
When the item is an area, building or region, then the child meters of that parent
are included in the report.
When the item is a meter group, then the meters in that group are included in the
report.
Limitations
Demand data from up to 8 meters, areas, buildings, regions or meter groups can
be included in the report. The ninth and subsequent items in the Area/Meter List
are ignored.
Report Parameters
Area/Meter List
The Area/Meter List specifies the areas, buildings, regions, and meters that you
want the report to include data for.
The Load Duration report is limited to the maximum number of items indicated in
Limitations.
Meter Group
Meter Group lets you specify an empty group for the of Area/Meter List. You can
then add arbitrary areas, buildings, regions, and meters to that group. The report
is generated by grouping the data of the items in a group.
To learn how to create a meter group, see Creating a Meter Group.
Report Name
Report Name specifies the name of the link that appears in the Reports section of
enteliWEB's left pane tree view under Load Duration, when you save your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Meter Type
Meter Type specifies the type of energy or resource that the report includes data
for.
When you change Meter Type, you are forced to specify the Area/Meter List again.
Site
Site specifies the site name that you want to appear on the report for site.
Site can be any arbitrary name. It does not have to be the same as a site that is
configured into enteliWEB.
Load Step
Load Step specifies the incremental amount of energy or resource demand for
which the time is summed to provide a data point in the report. For example, to
report the amount of time for every 5 kW increment in demand, set Load Step to 5.
The unit of measure for Load Step is the same as for the type of energy or
resource that you specified for Meter Type.
Load Mark
Load Mark specifies the position of a horizontal dashed line on the report.
Typically, this line is interpreted as a demand load level or threshold you don't
want to exceed.
The unit of measure for Load Mark is the same as for the type of energy or
resource that you specified for Meter Type.
Date Range
Date Range specifies the time period for the data over which the demand is
reported.
When Custom is selected, the From and To fields are displayed.
To - Date Configuration
To specifies the date when the custom date range ends.
Days
Days specifies which day or days of the week are included in the report. Choose
All, Weekdays or Weekends from the list or select Other to allow you to specify the
exact weekday or days you want in the report.
Date/Time Format
Date/Time Format specifies the format of the date and time that is displayed in
the upper right corner of the report.
Period - Baseline
Period displays the date range for the baseline data. When you specify Date Range
then Period adjusts automatically to match.
Offset By - Baseline
Offset By specifies the time period by which the baseline date range precedes the
date range for the current data.
For example, when Date Range is set to Previous Month and you want to show
baseline data for the same month of the previous year, then set Offset By to 12
months.
When Offset By is set to Other, the Starting Date field is displayed.
Limitations
Data from one group, area, or meter is included in the report.
Report Parameters
Area/Meter List
The Area/Meter List specifies the areas, buildings, regions, and meters that you
want the report to include data for.
The Single Meter Occupancy report is limited to the maximum number of items
indicated in Limitations.
Meter Group
Meter Group lets you specify an empty group for the of Area/Meter List. You can
then add arbitrary areas, buildings, regions, and meters to that group. The report
is generated by grouping the data of the items in a group.
To learn how to create a meter group, see Creating a Meter Group.
Report Name
Report Name specifies the name of the link that appears in the Reports section of
enteliWEB's left pane tree view under Single Meter Occupancy, when you save
your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Meter Type
Meter Type specifies the type of energy or resource that the report includes data
for.
When you change Meter Type, you are forced to specify the Area/Meter List again.
Site
Site specifies the site name that you want to appear on the report for site.
Site can be any arbitrary name. It does not have to be the same as a site that is
configured into enteliWEB.
Date Range
Date Range specifies the time period for the data over which the data is reported.
Select Custom when you want to specify a date range that is not covered by the
other options in the list.
To - Date Configuration
To specifies the date when the custom date range ends.
Date/Time Format
Date/Time Format specifies the format of the date and time that is displayed in
the report.
From - Occupancy
From specifies the time of day when the occupied period begins for occupied days.
To - Occupancy
To specifies the time of day when the occupied period ends for occupied days.
Days - Occupancy
Days specifies the day or days of the week that are considered to be occupied days
for the report. Choose All, Weekdays or Weekends from the list or select Other to
allow you to specify the exact weekday or days you want to be the occupied days.
Choosing no occupied days does not work.
Period - Baseline
Period displays the date range for the baseline data. When you specify Date Range
then Period adjusts automatically to match.
Offset By - Baseline
Offset By specifies the time period by which the baseline date range precedes the
date range for the current data.
For example, when Date Range is set to Previous Month and you want to show
baseline data for the same month of the previous year, then set Offset By to 12
months.
When Offset By is set to Other, the Starting Date field is displayed.
Meters for which access is denied are listed in the Area/Meter List, but you
are prevented from adding them to the Selected Area/Meter List.
6. Enter the Report Name, Report Title and Site information.
7. Set Date Range to a large time interval such as Year-to-Date. Set Group by to
Week or longer time interval.
8. Click Run to generate the report. When the report is displayed, review it
and make any changes you need to achieve your intended result.
9. Click Save to save the report and to add a link to the report in the Reports
section of the left pane navigation tree.
Offline Devices
Objects from devices that are offline are included in the report. No information is
provided for those objects.
In the report, objects from offline devices are indicated with red-colored text.
Calibration Report
About the Calibration Report
The Calibration report lets you list AI objects that are calibrated, for a given site.
An AI object is calibrated when the value of its Calibration property is not zero.
AI objects that are not calibrated are not included in the report.
Limitations
The report includes Delta devices only because Calibration is a Delta proprietary
object property.
The report's object filter limits the object types that you can include in this report.
The report is limited to 7000 records.
Report Parameters
Report Name
Report Name specifies the name of the link that appears in the Building
Automation section of enteliWEB's left pane tree view under Calibration, when you
save your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Sites
The Sites field specifies the name of one or more enteliWEB sites that the report
includes information about.
Device Range
Device Range specifies the devices, by device address range, that you want to
include in the report.
Date/Time Format
Date/Time Format specifies the format you want to use in the report to display
date and time information.
Object Filter
Object Filter specifies one or more filter rules that define the objects and object
properties that you want to include in the report.
Limitations
The object filter limits the object types that you can include in this report.
The report is limited to 7000 records.
Report Parameters
Report Name
Report Name specifies the name of the link that appears in the Building
Automation section of enteliWEB's left pane tree view under Commissioning
Sheets, when you save your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Site
Site specifies the name of the enteliWEB site that the report includes information
about.
Device Range
Device Range specifies the devices, by device address range, that you want to
include in the report.
Date/Time Format
Date/Time Format specifies the format you want to use in the report to display
date and time information.
Object Filter
Object Filter specifies one or more filter rules that define the objects and object
properties that you want to include in the report.
Limitations
The report's object filter limits the object types that you can include in this report.
The report is limited to 7000 records.
Report Parameters
Report Name
Report Name specifies the name of the link that appears in the Building
Automation section of enteliWEB's left pane tree view under Decommissioned and
Fault, when you save your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Sites
The Sites field specifies the name of one or more enteliWEB sites that the report
includes information about.
Device Range
Device Range specifies the devices, by device address range, that you want to
include in the report.
Date/Time Format
Date/Time Format specifies the format you want to use in the report to display
date and time information.
Object Filter
Object Filter specifies one or more filter rules that define the objects and object
properties that you want to include in the report.
Limitations
The report includes the PI object for Delta devices only as it is a Delta proprietary
object type.
The report's object filter limits the object types that you can include in this report.
The report is limited to 7000 records.
Report Parameters
Report Name
Report Name specifies the name of the link that appears in the Building
Automation section of enteliWEB's left pane tree view under Input Points, when
you save your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Sites
The Sites field specifies the name of one or more enteliWEB sites that the report
includes information about.
Device Range
Device Range specifies the devices, by device address range, that you want to
include in the report.
Date/Time Format
Date/Time Format specifies the format you want to use in the report to display
date and time information.
Object Filter
Object Filter specifies one or more filter rules that define the objects and object
properties that you want to include in the report.
The Objects in Manual report includes information about the objects that you
specify with the Object Filter.
The Objects in Manual report includes information from the enteliWEB Log related
to the objects that you specify with the object filter.
The logic applied by the report to find applicable information in the Log is as
follows:
l Search the Log for records about objects that are in manual, for objects
specified with the object filter. Search is restricted to the time interval
specified by Date Range.
l Include information from the most recent record in the Log that shows the
object being set to manual
The information from the Log records that is included in the report is the
username of the user who set the object to manual and the date and time when
the object was set to manual.
Information from the Archive portion of the Log is not included in the report.
Limitations
The report is limited to 7000 records.
Report Parameters
Report Name
Report Name specifies the name of the link that appears in the Building
Automation section of enteliWEB's left pane tree view under Objects in Manual,
when you save your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Sites
The Sites field specifies the name of one or more enteliWEB sites that the report
includes information about.
Device Range
Device Range specifies the devices, by device address range, that you want to
include in the report.
Date/Time Format
Date/Time Format specifies the format you want to use in the report to display
date and time information.
Object Filter
Object Filter specifies one or more filter rules that define the objects and object
properties that you want to include in the report.
Log Filter
Date Range
Date Range specifies the time interval for the records in the Log that are searched
for objects being set to manual, for objects specified by the Object Filter.
Information from records that occurred in the time interval is included in the
report. The time interval ends with the date and time that the report was
generated.
Information about objects in manual in records that occurred outside of the time
interval is not included in the report.
Include Objects Not Modified By enteliWEB
When Include Objects Not Modified By enteliWEB is selected, then all objects in
manual, for the objects specified by the object filter, whether or not there is a
record in the Log for the object being set to manual, are included in the report.
When Include Objects Not Modified By enteliWEB is not selected, then objects in
manual, for the objects specified by the object filter, for which there is no record
in the Log, within the specified date range, are not included in the report.
You are not limited as to the object types or object properties that you include in
the report.
Limitations
The report is limited to 7000 records.
Report Parameters
Report Name
Report Name specifies the name of the link that appears in the Building
Automation section of enteliWEB's left pane tree view under Object Query, when
you save your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Sites
The Sites field specifies the name of one or more enteliWEB sites that the report
includes information about.
Device Range
Device Range specifies the devices, by device address range, that you want to
include in the report.
Date/Time Format
Date/Time Format specifies the format you want to use in the report to display
date and time information.
Object Filter
Object Filter specifies one or more filter rules that define the objects and object
properties that you want to include in the report.
Limitations
The report's object filter limits the object types that you can include in this report.
The report is limited to 7000 records.
Report Parameters
Report Name
Report Name specifies the name of the link that appears in the Building
Automation section of enteliWEB's left pane tree view under Output Points, when
you save your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Sites
The Sites field specifies the name of one or more enteliWEB sites that the report
includes information about.
Device Range
Device Range specifies the devices, by device address range, that you want to
include in the report.
Date/Time Format
Date/Time Format specifies the format you want to use in the report to display
date and time information.
Object Filter
Object Filter specifies one or more filter rules that define the objects and object
properties that you want to include in the report.
Limitations
This report is limited to TL objects only.
Up to eight TL objects can be included.
Values of datatype Bitstring cannot be recognized and displayed correctly in the
report.
When you want to generate a trend log report with a chart when a large number of
samples is involved, see Plotting Large Number of Samples for limitations.
Report Parameters
Report Name
Report Name specifies the name of the link that appears in the Building
Automation section of enteliWEB's left pane tree view under Trend Log, when you
save your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Trend Setup
Trend Setup specifies the TL objects for the source of samples that are plotted in
the chart and lets you specify which Y axis is associated with each TL object.
Up to eight TL objects can be included.
Date Configuration
Date Configuration specifies the time period for the TL objects samples that are
plotted and over which the Statistics are derived.
Date Range
When Custom is selected, the From and To fields are displayed.
To - Date Configuration
To specifies the date and time when the custom range ends.
Date/Time Format
Date/Time Format specifies the format you want to use in the report to display
date and time information.
Sample Configuration
Sample Roll Up
Sample Roll Up is an optional setting that lets you specify how the TL objects
samples data for the plot are rolled up or aggregated over a specified time
interval. You can perform one of three types of aggregation calculations to arrive
at the roll up value that is plotted.
The roll up capability is applicable only for TL objects that obtain sample
data from analog objects. Roll up doesn't work for TL objects that obtain
sample from binary or multi-state objects.
Interval
Interval specifies the time interval over which the aggregation function operates.
Aggregation Function
The aggregation function operates over the samples in Interval to calculate a
value of more significant meaning or measurement.
Min - lowest value of all samples in Interval
Max - highest value of all samples in Interval
Average - arithmetic mean value of all samples in Interval
Decimal Precision
Decimal Precision specifies the number of digits that follow the decimal point, in
the range from 0 to 10 digits, in the samples included in the report.
Report Format
Chart options
Show Chart
Select Show Chart when you want the report to include a plot of the samples or
aggregated data.
When Show Chart is not selected then the report shows the information in tabular
form.
Show Markers
Select Show Markers when you want the plotted samples to be indicated by
markers.
Select Show Chart to enable Show Markers.
When the number of samples is greater than 3,000, markers are not displayed,
even when Show Markers is selected.
Show Tooltip
Select Show Tooltip when you want the value of a plotted sample to be displayed
when you hover the mouse pointer over a marker.
Select Show Chart to enable Show Tooltip.
When the number of samples is greater than 10,000, tooltips are not displayed,
even when Show Tooltip is selected.
Y1 Axis Label
Y1 Axis Label specifies the text for the label shown on the chart for the Y1 axis.
Y2 Axis Label
Y2 Axis Label specifies the text for the label shown on the chart for the Y2 axis.
Show Statistics
Select Show Statistics when you want the report to include a table of minimum,
maximum and average data over the specified date range.
An advanced object filter specifies the object types, object instances, object
properties and comparison operators that determines what information is
included in the report or in the object list.
An advanced object filter consists of one or more filters. When there is more than
one filter specified, enteliWEB performs a logical OR of the filters when it
generates the report or the Object List page.
Object Type
Object Type specifies the object types that you want to include in the report or on
the Object List page.
For a report, the list of object types available to choose from includes only those
types that are applicable to the purpose of the report.
For the object list, the list of object types available to choose from includes all
object types.
IP lists input object types. Input object types are AI, BI, MI, PC and PI objects.
OP lists output object types. Output object types are AO, BO, MO and LO objects.
Instance Range
Instance Range specifies one or more object instance numbers or a range of
instance numbers that you want to include in the report or on the Object List page,
for the object types you specify.
Property
Property includes one or more property rules.
When one object type is specified, all properties are listed including
subproperties.
When multiple object types are specified, properties that are common to all
specified object types are listed. Sub-properties are not including.
When wildcard object type is specified, all properties are listed. Sub-properties
are not including.
When you enter a property name, only alphabetic characters, numbers and *_-.[ ]
are accepted.
Rule
A rule specifies the object properties and property values that must be present to
include the object types and instances in the report or the Object List page.
The rules engine supports the following comparison operators.
= equal
> greater than
>= greater than or equal
Union value
For object type = SCH, binary schedules that are in
the Off state.
Specific array index
Objects with state1 as the first entry in the State_
Text array.
Not supported: unspecified array index, for example,
State_Text[] = Off.
Report, Object Query Report, Objects in Manual Report, Output Points Report, or
Trend Log Report.
1. In the Building Automation section of the left pane navigation tree, click the
type of report you want to create. The blank report template opens in the
right pane.
2. Enter a Report Name.
3. Option: modify the Report Title.
4. Select the Site.
5. Enter a Device Range.
6. Select the Date/Time Format for the date and time that appears on the
report.
7. Option: click to modify or click to add to the Object Filter.
8. Select Hide Offline Devices as required.
9. Option: change the Report Orientation.
10. Option: click to modify or add to the Report Format.
11. Click Run to generate the report. When the report is displayed, review it
and make any changes you need to achieve your intended result.
12. Click Save to save the report and to add a link to the report in the Building
Automation section of the left pane navigation tree.
Objects from devices that are offline are included in the report and are
indicated with red-colored text. No information is provided for those
objects.
6. Select the Date/Time Format for the date and time that appears on the report
7. Option: configure the Sample Roll Up.
The roll up capability is applicable only for TL objects that obtain sample data
from analog objects. Roll up doesn't work for TL objects that obtain sample
from binary or multi-state objects.
8. Configure the Chart Options.
9. Option: change the Report Orientation.
10. Click Run to generate the report. When the report is displayed, review it
and make any changes you need to achieve your intended result.
11. Click Save to save the report and to add a link to the report in the Building
Automation section of the left pane navigation tree.
An access control report is limited to 8001 events. When your report filter
returns more than 8000 events, only 8001 events are included in the
report. The report indicates that it is limited by a message in red text.
Filters for card users, doors and event type allow you to narrow the report based
on your specific interest.
Limitations
The report is limited to 8000 events.
Report Parameters
Report Name
Report Name specifies the name of the link that appears in the Access Control
section of enteliWEB's left pane tree view under Card Access Activity, when you
save your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Site
Site specifies the name of the enteliWEB site that the report includes information
about.
Report Orientation
Choose between landscape or portrait page orientation.
Date/Time Format
Date/Time Format specifies the format you want to use in the report to display
date and time information.
Date Range
Date Range specifies the time interval for events that you want to include in the
report.
Card Users
Card Users specifies a filter to allow you to narrow the report to the card users
that you are interested in viewing events for.
To add a new filter, click the icon. To remove a filter, click the icon. The
report has a default filter All (*) that adds all the card users to the report.
Doors
Doors specifies a filter to allow you to narrow the report to the access control
doors that you are interested in viewing events for.
To add a new filter, click the icon. To remove a filter, click the icon. The
report has a default filter All (*) that adds all the access control doors to the
report.
Event Types
Event Types specifies a filter to allow you to narrow the report to the door and
card user events that you are interested in viewing.
To modify the filter, click the icon. The report has a default filter All (*) that
adds all event types to the report.
Card Number
Card Number specifies the one card number that you are interested in viewing
events for.
Site Code
Site Code specifies the one site code that you are interested in viewing events for
Limitations
The report is limited to 8000 events.
Report Parameters
Report Name
Report Name specifies the name of the link that appears in the Access Control
section of enteliWEB's left pane tree view under Card Access Activity by Card
User, when you save your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Site
Site specifies the name of the enteliWEB site that the report includes information
about.
Report Orientation
Choose between landscape or portrait page orientation.
Date/Time Format
Date/Time Format specifies the format you want to use in the report to display
date and time information.
Date Range
Date Range specifies the time interval for events that you want to include in the
report.
Card Users
Card Users specifies a filter to allow you to narrow the report to the card users
that you are interested in viewing events for.
To add a new filter, click the . To modify an existing filter, click the icon. To
remove a filter, click the icon.
Doors
Doors specifies a filter to allow you to narrow the report to the access control
doors that you are interested in viewing events for.
To add a new filter, click the icon. To remove a filter, click the icon. The
report has a default filter All (*) that adds all the access control doors to the
report.
Event Types
Event Types specifies a filter to allow you to narrow the report to the card user
events that you are interested in viewing.
To modify an existing filter, click the icon. The report has a default filter All (*)
that adds all the event types to the report.
Card Number
Card Number specifies the one card number that you are interested in viewing
events for.
Site Code
Site Code specifies the one site code that you are interested in viewing events for.
Limitations
The report is limited to 8000 events.
Report Parameters
Report Name
Report Name specifies the name of the link that appears in the Access Control
section of enteliWEB's left pane tree view under Card Access Activity by Door,
Report Title
Report Title specifies the text that appears as the title of the report.
Site
Site specifies the name of the enteliWEB site that the report includes information
about.
Report Orientation
Choose between landscape or portrait page orientation.
Date/Time Format
Date/Time Format specifies the format you want to use in the report to display
date and time information.
Date Range
Date Range specifies the time interval for events that you want to include in the
report.
Card Users
Card Users specifies a filter to allow you to narrow the report to the card users
that you are interested in viewing events for.
To add a new filter, click the icon. To remove a filter, click the icon. The
report has a default filter All (*) that adds all the card users to the report.
Doors
Doors specifies a filter to allow you to narrow the report to the access control
doors that you are interested in viewing events for.
To add a new filter, click the . To modify an existing filter, click the icon. To
remove a filter, click the icon.
Event Types
Event Types specifies a filter to allow you to narrow the report to the door and
card user events that you are interested in viewing.
To modify an existing filter, click the icon. The report has a default filter All (*)
that adds all the event types to the report.
Card Number
Card Number specifies the one card number that you are interested in viewing
events for.
Site Code
Site Code specifies the one site code that you are interested in viewing events for.
Limitations
The report is limited to 8000 events.
Report Parameters
Report Name
Report Name specifies the name of the link that appears in the Access Control
section of enteliWEB's left pane tree view under Door Activity, when you save your
report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Site
Site specifies the name of the enteliWEB site that the report includes information
about.
Report Orientation
Choose between landscape or portrait page orientation.
Date/Time Format
Date/Time Format specifies the format you want to use in the report to display
date and time information.
Date Range
Date Range specifies the time interval for events that you want to include in the
report.
Card Users
Card Users specifies a filter to allow you to narrow the report to the card users
that you are interested in viewing events for.
To add a new filter, click the icon. To remove a filter, click the icon. The
report has a default filter All (*) that adds all the card users to the report.
Doors
Doors specifies a filter to allow you to narrow the report to the access control
doors that you are interested in viewing events for.
To add a new filter, click the icon. To remove a filter, click the icon. The
report has a default filter All (*) that adds all the access control doors to the
report.
Event Types
Event Types specifies a filter to allow you to narrow the report to the door events
that you are interested in viewing.
To modify an existing filter, click the icon. The report has a default filter All (*)
that adds all the event types to the report.
Card Number
Card Number specifies the one card number that you are interested in viewing
events for.
Site Code
Site Code specifies the one site code that you are interested in viewing events for.
Limitations
The report is limited to 8000 events.
Report Parameters
Report Name
Report Name specifies the name of the link that appears in the Access Control
section of enteliWEB's left pane tree view under Transactions by Event Type, when
you save your report.
Report Name specifies the subject text of the email message when the report is
sent by email.
Report Title
Report Title specifies the text that appears as the title of the report.
Site
Site specifies the name of the enteliWEB site that the report includes information
about.
Report Orientation
Choose between landscape or portrait page orientation.
Date/Time Format
Date/Time Format specifies the format you want to use in the report to display
date and time information.
Date Range
Date Range specifies the time interval for events that you want to include in the
report.
Card Users
Card Users specifies a filter to allow you to narrow the report to the card users
that you are interested in viewing events for.
To add a new filter, click the icon. To remove a filter, click the icon. The
report has a default filter All (*) that adds all the card users to the report.
Doors
Doors specifies a filter to allow you to narrow the report to the access control
doors that you are interested in viewing events for.
To add a new filter, click the icon. To remove a filter, click the icon. The
report has a default filter All (*) that adds all the access control doors to the
report.
Event Types
Event Types specifies a filter to allow you to narrow the report to the access
control events that you are interested in viewing.
To modify an existing filter, click the icon. The report has a default filter All (*)
that adds all the event types to the report.
Card Number
Card Number specifies the one card number that you are interested in viewing
events for.
Site Code
Site Code specifies the one site code that you are interested in viewing events for.
An access control report is limited to 8001 events. When your report filter
returns more than 8000 events, only 8001 events are included in the
report. The report indicates that it is limited by a message in red text.
A report for access users that are selected by name includes events for
those access users only.
1. In the Find Access Users dialog, select Find and Select by Name.
2. Enter a partial access user name to narrow down the list of access users.
3. Select one or more access users from the list.
4. Click OK.
A report for access users that are identified by keyword includes events
for all access users with the keyword in their name. Any access user with
a name that matches the keyword is included in the report.
A report for doors that are identified by keyword includes events for all
doors with the keyword in their name. When you add a door with a name
that matches the keyword, it will be included in the report.