Академический Документы
Профессиональный Документы
Культура Документы
REPORTING
INTRODUCTION ............................................................................................. 6–9
Intended Audience ................................................................................. 6–9
INTRODUCTION TO HISTORIAN............................................................. 6–11
Features .............................................................................................. 6–11
System Requirements........................................................................... 6–12
Historian Database Growth and Management ................................... 6–12
MULTIPLE HISTORIANS SUPPORTED IN VERSION 3.40........................................ 6–13
HOW HISTORIAN WORKS ................................................................................... 6–13
How Does Historian Connect to the Network? ................................... 6–13
What is an Archive TL and How is it Created? ................................... 6–14
How are Archive TL's Named? ........................................................... 6–16
How Does Historian Gather Data for Archiving ................................ 6–17
What is Historian’s ODBC Database? ............................................... 6–17
INSTALLING HISTORIAN .......................................................................... 6–18
INSTALLATION ................................................................................................... 6–18
STOP OR RESTART HISTORIAN SERVICE ............................................................. 6–20
CHANGING HISTORIAN STARTUP BEHAVIOR ...................................................... 6–22
HISTORIAN SETTINGS (HS) ...................................................................... 6–24
CONFIGURING HISTORIAN .................................................................................. 6–24
Stats Tab ............................................................................................. 6–25
Troubleshooting Tab ........................................................................... 6–26
Setup Tab ............................................................................................ 6–27
Configuring DSN for Microsoft SQL Server ....................................... 6–28
Configuring DSN for MySQL .............................................................. 6–30
CHANGING THE DATABASE MANAGEMENT SYSTEM .......................................... 6–30
Installing MySQL ................................................................................ 6–31
Setting the MySQL DSN ...................................................................... 6–32
Connection Polling ............................................................................. 6–33
SECURING HISTORIAN’S DATABASE................................................................... 6–35
Changing Password for MS SQL Server 2005 Express/ SQL Server .. 6–35
VIEWING HISTORIAN’S STATUS ......................................................................... 6–36
Connection to Delta Server ................................................................. 6–36
Historian’s Status Modes .................................................................... 6–37
DOES HISTORIAN ARCHIVE EVENTS IN EVLS? ................................. 6–38
SETTING UP CONFIRMED EVENT AND ALARM TRANSMISSIONS TO HISTORIAN .. 6–38
1) Locate your Historian ..................................................................... 6–39
2) Choose a controller ........................................................................ 6–39
3) Setup Access Control Event (EVC7) ............................................... 6–39
4) Setup Access Control Alarm (EVC8) .............................................. 6–40
5) Save Database to Flash and/or File ............................................... 6–41
TREND LOG (TL) .......................................................................................... 6–42
ARCHIVE TREND LOGS....................................................................................... 6–42
CONFIGURING A TREND LOG.............................................................................. 6–43
Creating a Trend Log Object .............................................................. 6–43
INTRODUCTION
You can use Trend Logs, Multi-Trends and the Historian Device, to analyze,
view, record, investigate and maintain your ORCAview system data. There are
three main objects used to perform these functions: the Trend Log (TL), the Multi-
Trend (MT) and the Historian Settings (HS) object.
You can use the Reporting (RPT) object to generate commonly used technical
reports on your system. There are three types of reports generated by the RPT
object: Query reports, Tenant Billing reports and Access Configuration reports.
• Introduction to Historian what it is, why use it, and how to use it.
Starting 6–11.
• Installing Historian Starting 6–18
• Configuring HS Starting 6–24
• Basic Troubleshooting Starting 6–54
• Configuring TLs 6–42, Archived TLs and MTs 6–47.
• Maintaining Archived TLs. Starting 6–52.
• Improving Historian Performance Archived TLs. Starting 6–60.
• Troubleshooting Historian Archived TLs. Starting 6–62.
• Introduction to Reporting what it is, why use it, and how to use it.
Starting 6–80.
• Configuring Query, Tenant Billing and Access Configuration Reports.
Starting 6–82.
• Troubleshooting Reports. Starting.6–104.
Intended Audience
The intended audience for this section of the ORCAview Technical Reference
Manual is as follows:
• Facility Managers
• Application Engineers
• Service Personnel
• Supervisors
• Security Personnel
• Operations Staff
INTRODUCTION TO HISTORIAN
Historian is an archiving utility that stores data from Trend Logs (TL) for an
unrestricted period of time, and allows users to record a much larger set of data
than was previously possible. Historian provides an opportunity to analyze, view,
record, and investigate data in ways that are not possible using traditional TLs and
Multi-Trend Logs (MTs).
Archive TLs are presented as regular TLs to the other BACnet devices. As such,
they are accessible via any BACnet Operator Workstation (OWS) that supports
TLs as defined in the BACnet Standard (2001b or later). Historian will not work
with devices implementing trending as defined in versions of the standard prior to
2001b.
Features
• With Version 3.40, multiple Historians are supported.
• Historian allows multiple OWS systems, both local and remote, to view the
historical data.
• Historian supports Ethernet and BACnet/IP connections.
• Historian stores data in an Open DataBase Connectivity (ODBC) database.
• Historian’s data is available through a standard ODBC interface that permits
data to be imported into MS Excel, Crystal Reports, or other ODBC
compliant tools.
A detailed description of ODBC is included in the section entitled, What is
Historian’s ODBC database? starting on page 6–17.
System Requirements
To use Historian, ORCAview must be installed on the system. To run Historian
software, the minimum PC requirements are as follows:
The following table shows approximate database sizes based on different site
sizes. The values are approximate, and do not account for database transaction log
files which can be equivalent to, or larger than the database files. Microsoft SQL
Server 2000 and MSDE 2000 were used for these calculations.
The figures provided in the table are to be used only as an example and should be
treated as an approximation of space required.
Historian Trend Log Event Log Event Log DB Size DB Size DB Size
Level Objects
- HVAC / - Access Control (1 month) (6 months) (12
(1 data sample Lighting months)
per TL every 10 (entries per day (in MB) (in MB)
min. on avg.) (entries per day on avg.) (in MB)
on avg.)
TLs cannot be created directly on the Historian Device. In the right pane of
Navigator, right click on any source TL and click Add to Historian. Any polling or
buffer ready COV BACnet TL, on any controller (Protocol Version 1, Revision 3
or later), can be marked for archiving. .In V3.40, the Archived checkbox on the
Setup tab of a source TL is not editable due to the multiple Historian capability...
Previously in 3.33, it was possible to select the Archived checkbox to mark a TL
for archiving.
In V3.40, you must select a TL or group of TL's in the right pane of Navigator and
then right click. From the menu, select the Command option and click on Add to
Historian.
Note: V3.40 now supports multiple Historians on one site and as a result the
Archived checkbox on TL is not editable and is grayed out. To mark a trend or
groups of trends (regular TL's) for archiving in Version 3.40, you must select a TL
or group of TL's in the right pane of Navigator and then right click. From the
menu, select the Command option and click on Add to Historian.
4 If there are multiple Historians installed on the site, select the particular
Historian that you wish to archive the selected trend(s) to.
The previous dialog only appears if the site has more than one historian.
5 When the trend is marked as Archived, the Setup tab will show that it is being
archived.
In V3.40, the Archived checkbox cannot be edited from the Setup tab of the TL.
If this trend is being archived in multiple Historians, it will not list all Historical
trends here, only one. The V3.40 support for multiple historians is intended to
provide additional trending capacity on large sites. Although it is technically
possible to archive a trend to multiple historians in this configuration this is not
the intent, and is not supported in V3.40.
Additionally with multiple Historians, each historian must refer to its own SQL
database. You cannot have multiple historians that all reference the same SQL
database.
You can rename any source TL or Archived TL and Historian will continue to
function normally.
For Delta COV TL’s and third party COV TL’s that support Buffer Ready
Notifications, Historian will automatically configure TL’s to generate events when
they need to be archived. This approach allows for COV TL’s variable rates of
data collection. The intention is to avoid any loss of data.
Historian stores TL data and set up information in the ODBC database. Historian
is shipped with Microsoft SQL Server 2005 Express, and also supports MySQL.
INSTALLING HISTORIAN
Historian is included on the same CD-ROM as ORCAview. Version 3.40 supports
the installation of multiple Historians but each must have its own separate SQL
database.
If the default MS SQL Server Express is installed, the size of the database is
limited (Microsoft SQL Server 2005 Express, 4GB). For Large and Unlimited
Historian users, SQL Server 2005 Express may not be sufficient for large amounts
of trending and/or alarming. It may be better to immediately install My SQL or
purchase the full SQL Server. This avoids the inconvenience and effort required to
switch over to another SQL server product after starting with the default Microsoft
SQL Server 2005 Express, with its 4 GB database size limit.
For example, a site with 1000 trends with samples every 10 minutes, and 500
HVAC / lighting, and 1000 Access events a day - would use 5.3 GB per year. That
means the default of SQL Server 2005 would run out of database space in about 9
months. A site with 2500 trends would run out in more less than 4 months.
See the Historian Database Growth and Management section starting on page 6–
12 for a table that shows estimated hard drive usage.
Installation
With 3.40, ORCAview has a suite installer which provides a choice of six
applications to install. The Suite Installer handles multiple applications in one
installation process.
With the ORCA 3.40 Suite Installer, you do NOT need to install OWS first and
then log in over the desired network connection before beginning to install
Historian. This approach was necessary with 3.33R2.
Note: With the ORCA 3.40 Suite Installer, you do NOT need to install OWS first
and then log in over the desired network connection before beginning to install
Historian. This approach was necessary with 3.33R2.
1. If the autorun does not bring up the interface, use the My Computer icon or
the Explorer view to find the ORCA Suite Setup.exe file.
2. Double-click ORCA Suite Setup.exe file to start the Suite Installer.
3. Follow the instructions from the Welcome screen to complete the installation
process.
With Microsoft SQL Server 2005 Express, you need to define a strong password
which means that the password contains a variety of character types. A strong
password contains a combination of lowercase, uppercase, numbers and special
characters such as $ or # etc.
To stop or start the Historian service manually, you use the Services utility in the
Windows Administrative Tools. The Administrative Tools are accessible from the
Windows Settings | Control Panel | Administrative Tools | Services and provides a
way to Stop or Restart the Historian service.
4. From the Services dialog, scroll if necessary, and select Delta Historian in the
Name column.
5. If necessary, click the Extended tab in the lower left part of the dialog.
6. In the upper left area of the right pane, click Stop the service or Restart the
service.
3 Click OK.
Configuring Historian
To open the Historian Settings object:
• In the right-pane of the Navigator window, right-click the Historian Settings
icon, and then click Open.
For a detailed description of the HS object fields, please refer to Chapter 10:
Software Object Reference of the ORCAview Technical Reference manual.
The Current Time, Next Poll and Last Poll fields in the Header often helps in the
interpretation of the Stats and Troubleshooting tab information.
Current Time This field displays the current time of the Historian PC.
Next Poll This field indicates the next scheduled time at which the Historian
Device will archive samples from one or more TL’s. Historian may start to poll
before this time if a forced update is requested, or if a Buffer Ready Notification is
received from a TL.
Last Poll This field indicates the last time that any TLs were polled for new
samples.
Stats Tab
The Stats tab only shows statistics when viewed from the local Historian PC.
Note: For the Stats or Troubleshooting tabs to function, the DSN field in the
ODBC Info section must have the DB Name and connection information
configured on the Setup tab. During the initial installation, the ODBC Data
Source must be set up in Windows.
Historian Uptime This field refers to the Delta server uptime and so starting
ORCAview first will increment this uptime count.
Historical Trend Log Count This field displays the number of trends in the
Historian DB.
Processing Time These are the percentage of time that historian runs in each
state. They start keeping track of statistics at the time of the first added TL.
Troubleshooting Tab
The Troubleshooting tab has two lists that display High Usage Trend Logs and
Trend Logs with Insufficient Samples.
Refer to the Improving Historian Performance section starting on page 6–60. This
section discusses how to avoid missed samples and how to investigation
communication issues using the HistLog.txt file. The Troubleshooting Historian
Device section starting on page 6–62, contains examples of how to resolve issues
that arise when using the Historian device.
The High Usage Trend Log list displays the busiest Trend Logs. If a Trend Log is
on the High Usage list, it does NOT indicate a definite problem.
The Trend Logs with Insufficient Samples list displays Trend Logs that Historian
cannot avoid missed data samples. If a TL is on the Trend Logs with Insufficient
Samples list, it does indicate a definite problem.
Note: For the Stats or Troubleshooting tabs to function, the DSN field in the
ODBC Info section must have the DB Name and connection information
configured on the Setup tab. During the initial installation, the ODBC Source
must be set up in Windows.
High Usage Trend Logs This is a list of the ten fastest to fill trends (Poll or
COV). You may not need to do anything about these trends because this list
shows the TLs that use the most Historian resources.
Trend Logs with Insufficient Samples This is a list of the top ten trends
(Poll or COV) that Historian will miss data from with the current TL
configurations. If a Trend Log is on this list, it indicates a definite problem that
needs attention. These Trend Logs often do not have a large enough Max Samples
setting in the source Trend Log for Historian to be able to archive all new data at
the rate each Trend Log is storing data.
The typical solution involves increasing the size of the Max Samples field on the
source TL. However, this approach may not always be possible because of
constraints on available controller memory.
You can reconfigure a Trend Log with Insufficient Samples so that Historian can
archive all new data. You could either increase the Max Samples for each TL or
decrease the rate of data collection. For Poll Trend Logs you could increase the
Log Interval. For COV Trend logs you could increase the COV Increment of the
Monitored Object or switch to a Poll Trend Log if your application permits.
Setup Tab
The Setup tab contains the setup items for Historian’s auto logon, ODBC
connection, and TL polling. Users can configure Historian and change the default
settings by using the Setup tab in the HS object.
It is recommended to keep the Maximum Poll Interval at the default 24 hours. For
example, if this field was set to one hour, Historian would be extremely busy on a
large network with an increased risk of missing samples.
To specify the database name in the DSN for Microsoft SQL server:
1 Open Data Sources (ODBC)
For a 32 bit OS, open Control Panel | Administrator Tools.
For a 64 bit OS, you must use the 32 bit ODBC Data Source dialog (NOT 64
bit one). The Microsoft support site provides vital configuration information.
See http://support.microsoft.com/kb/942976
2 Select the System DSN tab. See HistorianDSN listed:
3 Click Configure.
4 Click Next.
5 Select the authenticity type to SQL Server Authentication. Be sure to use the
SQL Server authentication.
6 In Login field, type the UserID displayed on the HS object Setup tab. The
default UserID is sa.
7 In Password field, type password you entered during the SQL Server
installation.
8 Click Next.
9 Select the Change default database to checkbox.
10 Select HistorianDB from the Change default database to dropdown list.
If HistorianDB is not an option, leave the Default Database field blank and
finish this procedure. Start and stop Historian which causes the HistorianDB
to be created automatically. Use this procedure to define the Default Database
To ensure that the Stats and Troubleshooting tabs work on the HS, enter the
ODBC data source information on the Setup tab of HS.
11 Click Next.
12 Click Finish.
13 Click Test Data Source … See results similar to:
The configuration steps between the connector and the server are similar to the
previous Configuring DSN for Microsoft SQL Server section starting on page 6–
28. The HS dialog needs to reflect all the changes done with the ODBC data
source.
The following fields in the Historian Settings object Setup tab do not need to be
changed unless a different DBMS package is used, or user security needs to be
applied to the Historian database.
Installing MySQL
Before configuring MySQL server, you will need to download and then install the
MySQL Community Server and the MySQL Connector/ODBC Driver. These
download and installation instructions can be found on
http://dev.mysql.com/downloads.
In order for the Statistics and Troubleshooting information in to show in the HS object you
must specify the database name in the DSN.
Connection Polling
A connection pool is a shared set of established database connections that are
available for an ODBC application to reuse. Historian needs connection pooling
for it to work properly.
When using the connector/ODBC x.x with MySQL Database, you must have
Connection Pooling enabled.
2. Double-click to open the Historian Settings object, and then select the Setup
tab.
3. In the ODBC Info fields, enter the UserID ‘root’ and the Password assigned
to the root user. It is easy to use the root user as it is created by default and
avoids any complexity involved in creating new SQL users. To change the
root password, refer to the “Changing the Password for MySQL” section.
When you install MySQL, it will also automatically create a system administrator
account, with the username ‘root’ and it will prompt you for a password.
Remember to use a strong root password. A strong password contains a variety of
character types. A strong password contains a combination of lowercase,
uppercase, numbers and special characters such as $ or # etc.
These accounts are extremely powerful, and if left with a blank password, they are
completely unprotected. Passwords should be created or changed immediately
after installation.
Note: Do not forget the new password. If you cannot provide the correct
password, you must re-install either SQL Server or MySQL.
In MS SQL, you use the free Management Tool which includes a GUI interface to
edit users.
http://www.microsoft.com/downloadS/details.aspx?familyid=C243A5AE-4BD1-
4E3D-94B8-5A0F62BF7796&displaylang=en
In MySQL, you use the GUI tools free from their site to edit users.
http://dev.mysql.com/downloads/gui-tools/5.0.html
• On the Historian PC , right-click the Historian icon from the Windows system
tray,, and then click Status. The Historian Status dialog will show the
connection to the Delta Server, and the Historian Status.
Not Connected Historian has not logged onto the Delta Server yet, has failed
to log onto the server or has lost its connection due to an error. When Historian
loses its connection to the Delta Server, it periodically attempts to reconnect to
resume normal operations.
Archiving Historian is collecting data samples from one or more Trend Logs
that are being archived. Once the archiving is complete Historian goes into
sleeping mode.
Scheduling Historian is “calculating” which TLs it will poll during its next
archiving phase.
Fault Historian has detected an error in the Historian database, the ODBC
database connection or else the Delta Server is offline. Historian will periodically
attempt to recover from the fault condition by reconnecting.
In Fault mode, Historian does not archive TLs or Alarm/ Event Notifications to its
ODBC database. However, Alarm/ Event Notifications are logged in a separate
MS Access database that is created when Historian is in fault due to database, or
database connectivity problems.
When Historian is in fault due to Delta Server being down, Historian does not log
to the Access database file as it no longer receives Alarm/ Event Notifications.
The backup Access file is called HistorianFaultDB.mdb and is located in the
Historian install folder.
EVC objects on controllers can be configured to use the Retry and Confirm
functions which will ensure Historian will receive Event Notifications during a
brief network interruption. The Setting Up Confirmed Event and Alarm
Transmissions To Historian section starting on page 6–24, contains detailed
information on how to set up confirmed alarm and event transmissions to
Historian.
This section emphasizes the setup of confirmed transmission for Access Control
events and alarms focusing specifically on EVC7 and EVC8. Access events are
valuable in comparison to other events and it is important not to lose any of these.
To configure other EVC’s, you would repeat the process shown here but for other
EVC’s,
It is recommended that Historian be online during the setup but it is not necessary.
When Historian is online, the Archive checkbox is available on the source TL in
the controllers.
2) Choose a controller
Select a controller in Navigator that you wish to confirm all events and alarms are
sent to the historian. In the event of a network miscommunication or fault, events
will be saved to send to the historian at a later time automatically.
These steps described in this Sequence of Operation section should be repeated for
all controllers that use confirmed transmission.
Under the Device Address, double click on BROADCAST and enter the following:
• DEV#The address of your historian#
For example, in this case it would be DEV999999
Under the Device Address, double click on BROADCAST and enter the following:
• DEV#The address of your historian#.
For example, in this case it would be DEV999999
Polled TLs collect new data samples based on a time interval, which can be set by
the user. This time interval is called the Log Interval. By default, a new TL will
have a Log Interval of one minute, which means that a new data sample will be
taken every minute.
TLs display the collected information in two ways: graphically, with a line graph
that has the last 200 values plotted against time, or as a text display of all the data
collected.
Additionally, TLs can be started or stopped at a time specified by the user.
The Archival Buffer Notification Setup enables a notification to occur each time a
set threshold of samples has been recorded. This functionality is used by Historian
for automated archival of trend data to prevent data loss.
Archive TLs are presented as regular TLs to other BACnet devices. As such, they
are accessible via any BACnet Operator Workstation (OWS) that supports TLs as
defined in BACnet 2001b. Once a TL has been selected for archiving, Historian
automatically creates an Archive TL that displays the data.
Archive TLs cannot be removed from the Historian Device without using database
management tools.
2. In the Create Object dialog, enter a name for the new TL.
3. From the Type Of Object drop-down menu, select Trend Log (TL), and then
click OK.
4. Click the Setup tab, and then do one of the following:
• Enter a descriptor name or object reference into the Monitored Object
box.
• Drag and drop the object that you want to monitor from Navigator into
the Monitored Object box.
5. Click Apply or OK.
Polling Records data at specified time intervals as defined in the Log Interval
field. A typical Log Interval value is 15 minutes.
COV Records data when the monitored value changes by a specified amount.
This type of TL uses the COV Minimum Increment value defined in the
monitored object and only retrieves a new sample when the monitored object
value changes by the Minimum Increment or more.
With an Archive TL, purging the buffer of a source TL using the Reset Samples
button or the Reset command in Navigator will cause the loss of any data in the
TL that is not yet archived.
With Historian, many solutions to problems involve increasing the size of the Max
Samples field on the source TL. Sometimes, this is not possible due to limitation
on the amount of memory available on a controller.
MULTI-TREND (MT)
The Multi-Trend (MT) object graphs the data samples from Trend Logs (TL). Up
to eight TLs can be graphed simultaneously in one MT object. The graph will plot
new samples as the TLs collect them.
The MT object allows users to drag-and-drop TLs onto the Multi-Trend dialog.
The MT object starts graphing the data when the TLs are added. This feature
makes it easy to graph a variety of Trend Logs quickly, in order to compare them.
For a detailed description of the Multi-Trend object, and all of its features, please
refer to Chapter 10, of this Technical Reference Manual. The following is a figure
of the Multi-Trend object dialog.
Note: By creating a Multi-Trend Log containing TLs and their associated Archive
TLs, users are able to view both controller data and historical data
simultaneously. An Archive TL can be added to the MT object using the same
drag-and-drop feature currently used for regular TLs.
When you open an MT on a Historian PC monitoring HTL’s, the latest data may
not display depending on when Historian last polled the controller’s TL data. An
MT with HTLs might display information that is a day old.
Configuring a Multi-Trend
The Multi-Trend object is a useful way to graph information simultaneously from
more than one TL.
Once the MT object is created, and the TLs are added, any information is
automatically graphed within the one MT object. To minimize network traffic, the
MT object will initially retrieve chunks of data from each TL, a small amount at a
time, until the entire databuffer of each TL is graphed. Following this, the MT will
receive new TL samples at a fixed rate, which defaults to once every 10 seconds.
2. In the Create Object dialog, click the Type of Object drop-down menu, and
then select Multiple Trend (MT).
3. In the Name field, enter a name for the new Multi-Trend, and then click OK.
4. Drag-and-drop one or more Trend Logs from Navigator into the open Multi-
Trend dialog window. The Multi-Trend will start graphing the Trend Logs
automatically.
Note: When Trend Logs are added to the MT in the Main window, using the drag
and drop function, the correct axes are automatically assigned. When using the
Line Properties dialog axes must be assigned manually by the user.
Viewing a Multi-Trend
A Multi-Trend defaults to Moving Frame (Range) mode with a time span of eight
hours, which means that the MT will display the last eight hours of TL data.
To change the interval at which new TL data samples are retrieved by an MT:
1. On the Multi-Trend toolbar, click the Settings button.
2. In the General Properties dialog, set the Polling Interval to the new value.
Set the new value from 10 to 60 seconds.
3. To save the changes, click Apply or OK.
When the Archive TL is enabled, the data from the source TL is archived
according to its polling schedule and buffer ready notifications.
When the Archive TL is disabled, the data from the source TL is not archived.
To update the data samples from the source TL in the Archive TL:
1. From the Navigator window, click to open the Archive TL for updating.
2. In the header of the Archive TL, click the Update button.
Refer to the Improving Historian Performance section starting on page 6–60. This
section discusses how to avoid missed samples and how to investigation
communication issues using the HistLog.txt file. The Troubleshooting Historian
Device section starting on page 6–62, contains examples of how to resolve issues
that arise when using the Historian device.
With a simple problem, it is easy to interpret appropriate data that helps to isolate
a reproducible cause and make suitable changes to prevent recurrence while not
introducing new problems.
With a complex problem, the nature of the problem itself is often unclear and may
also involve dynamic effects such as events that are not predictable. Some of the
most difficult troubleshooting issues arise from symptoms which are intermittent.
Your solution needs to prevent recurrence but also must not introduce further
problems within the overall system. After implementing a solution, you need to
observe and collect data to ensure its continued effectiveness.
Troubleshooting Tab
The Troubleshooting tab has two lists that display High Usage Trend Logs and
Trend Logs with Insufficient Samples.
The High Usage Trend Log list displays the busiest Trend Logs. If a Trend Log is
on the High Usage list, it does not indicate a definite problem.
The Trend Logs with Insufficient Samples list displays Trend Logs that Historian
cannot avoid missed data samples. If a TL is on the Trend Logs with Insufficient
Samples list, it does indicate a definite problem.
Note: For the Stats or Troubleshooting tabs to function, the DSN field in the
ODBC Info section must have the DB Name and connection information
configured on the Setup tab. During the initial installation, the ODBC Data
Source must be set up in Windows.
For example, the High Usage list may contain a Trend Log that collects large
amounts of data at frequent intervals. Everything may be fine as you need to
collect this data. Alternatively, the sample rate may be much too high for this
particular variable. It is also possible that the characteristics of the monitored
object value do not match expectations and indicate a possible problem within the
site. You may be using much more Historian resources than intended or needed
for a High Usage TL.
All Archive Trend Logs can be configured so that Historian can archive all Trends
without missing samples. To make sure this is the case on your site, use the
information in this High Usage table and in the Histlog.txt to verify the Trend
Logs in the High Usage list are configured correctly. The Histlog.txt can be
searched to make sure none of these Trend Logs have missed samples reported
and the information in the High Usage Trend Logs table should be reviewed.
Refer to the Improving Historian Performance section starting on page 6–60. This
section discusses how to avoid missed samples and how to investigation
communication issues using the HistLog.txt file. The Troubleshooting Historian
Device section starting on page 6–62, contains examples of how to resolve issues
that arise when using the Historian device.
The following table explains the information included with a High Usage Trend
Log list item. Each TL entry is followed by two numbers.
8000.TL1 - 3240, 1
Historian will be able to keep up with this trend.
(Samples per
minute)
The following table provides general guidelines for interpreting the information
included with a possible High Usage Trend Logs list item.
The following table provides some examples of possible High Usage Trend Logs
List Items with interpretation of the example.
The typical solution involves increasing the size of the Max Samples field on the
source TL. However, this approach may not always be possible because of
constraints on available controller memory.
You can reconfigure a Trend Log with Insufficient Samples so that Historian can
archive all new data. You could either increase the Max Samples for each TL or
decrease the rate of data collection. For Poll Trend Logs you could increase the
Log Interval. For COV Trend logs you could increase the COV Increment of the
Monitored Object or switch to a Poll Trend Log if your application permits.
Generally, you would increase the size of the buffer for the Trend Logs which
provide the most important data. A balance exists between the demands of data
collection, the memory available on a controller and the relative importance of the
data.
For example, a list item might be:
8000.TL1
8353.TL6
If 8000.TL1 is a Poll Trend Log with a Log Interval of one second and a Max
Samples (buffer size) of 100, then Historian cannot archive all the data. Historian
will miss many samples as Historian data collection is restricted to a maximum
interval of 120 seconds for a single Trend Log. This deliberate constraint prevents
a single poorly configured Trend Log from dominating Historian’s resources.
A solution might be to increase the Max Samples and/ or to increase the Poll
Interval. You could increase the Max Samples buffer size assuming that memory
is available on the controller. You could also reduce the data collection rate by
increasing the Poll Interval as it is probably not necessary to collect new data
every second.
If 8353.TL6 was a COV trend log, a typical solution would be to evaluate the
COV Increment of the Monitored Object to make sure that it is reasonable for the
point being measured and then change the COV increment and/or increase the
Max Samples for the TL as appropriate.
In the case of an intermittent problem, you can run a query on the ScheduleInfo
table looking at the MaxPeakRate. The MaxPeakRate provides the highest number
of samples per minute ever recorded in the past.
The following query will help identify trends that have problems due to
intermittent periods of high data samples:
When the trends with intermittent high data rates are identified, you can increase
their MaxSamples, decrease their COV rate number or decrease the samples rate.
The extra HistLog info also lists this information.
The following recommendations will decrease the time the Historian is using
network bandwidth for archiving, ease the workload on the CPU and hard drive,
and lengthen the time interval before database maintenance (purge or backup) is
required.
• Use COV where practical - Binary objects, and Setpoints, etc.
• Polling - Use reasonable polling intervals. 15 minute sample intervals for
example.
• Only archive those trends that require Historical data storage.
The following sequence of three HistLog .txt entries shows a situation where
Device 700 is offline resulting in 62 missed entries. Device 700 comes back
online and the trends are schedule normally.
09:23:00.19, 07-Jul-2009, Status = COMM TIMEOUT, Device 700 is offline. All trends will be scheduled out
09:25:58.02, 07-Jul-2009, Status = ERROR, 62 Missed Entries: HTL1
09:26:21.14, 07-Jul-2009, Status = RESUME, Device 700 is back online. All trends will be scheduled normally
Archiving Historian is collecting data samples from one or more Trend Logs
that are being archived. Once the archiving is complete Historian goes into
sleeping mode.
Scheduling Historian is calculating which TLs it will poll during its next
archiving phase.
Fault Historian has detected an error in the Historian database or the ODBC
database connection when the Delta Server is offline. When in this mode,
Historian will not archive TLs, nor log Alarm/Event notifications.
Historian Connection
If the Historian Device is not visible in the ORCAview Navigator tree, or the
Archive checkbox of a Source TL is shaded out, you need to determine if
Historian is connected to the Delta Server.
• Not Connected: Historian has not logged onto the Delta Server yet, has
failed to log onto the server or has lost its connection due to an error.
The Historian Status dialog also contains information on the connection to the
Delta Server and Historian’s current mode of operation.
3. The Value column will display the status of the Archive TL.
• In the left pane of Navigator, right click on the controller and click Query
Panel. Query the controller with the source TL. If this does not remove the
Fault state, you can do a forced update to get the TL going. Sometimes, this
direct approach may correct the problem.
• Query the Historian database.
This query would return a list of the HTLs that are in fault and the reason. In
the Last Failure Reason column, review the error code.
The table below contains an explanation of error codes in the Last Failure Reason
column.
Basic
Error
Descriptio Detailed Description Suggestions
Code
n
Remote
The remote device is not Check to ensure the remote
-25 device
available on the network. device is functioning.
failure
The remote device did
Remote not respond in the
Check to ensure the remote
-27 device desired time – it may not
device is functioning.
timeout be available on the
network.
Investigate your networking
issues and look for something
Invalid This error might result
-84 that might be corrupting
packet from bad wiring.
packets like bad wiring or a
non functional Hub/Switch.
Look at the controller TL and
confirm it is present. If not,
recreate it and it will
automatically make a new
The source TL has been Archived TL and detach your
deleted on the controller old one. Make sure you are
Source TL
-127 and the Archive TL not losing data here.
deleted
cannot collect any more
data. If you make a new TL with the
same settings as before then
the HTL will relink with your
new source TL with the same
settings.
Timeout while waiting for
Database Ensure that Historian is
-165 a database read/write
timeout connected, and is not in fault.
lock.
Attempt to query your
Error Check with specific OS
-166 Historian and make sure it is
unknown for more information.
working. Call support.
Attempt to query your
Error Service/ function was
-190 Historian and make sure it is
aborted aborted.
working. Call support.
Create the source TL on a
The remote device does
Network device that supports the
not support the services
-380 service not BACnet Read-Range service
needed to perform the
supported (e.g., Delta Controls DCU, or
archiving of the TL.
DSC device).
When Historian is run, the TLs that have been created on "Historian's" PC are
erased. This ensures that the Historian Device is gathering archived data only.
Here are two main cases when this may occur:
• The first case may occur when an existing OWS has been running for a long
time. When the user installs and runs Historian, any TLs currently on that PC
are removed without warning.
• A second case may occur when Historian is stopped for some length of time
on the Historian PC. If that PC is then used as a work station, the user can
create TLs, but these TLs are deleted when Historian is re-started.
The following is a complete list of all Historian’s data tables with Column Name,
Data Type and additional information for each entry.
ACEvent
The ACEvent table stores information on all events generated with the Access
Control Event class.
DevOff
The DevOff table stores information on devices (controllers) that .are offline.
Enum_BAC_AC_Event
The Enum_BAC_AC_Event table contains the mappings for Access Control event
type (numbers to text values).
EVL
The EVL table stores information about the Event Log objects in Historian’s
database.
EVLData
The EVLData table the information on Events that Historian logs. Each table contains one row per Event.
EventRefInstance Number
EventRefProperty Number
EventRefArrayIndex Number
Category Number Event category of this entry
Notes Text Debug information.
MonitoredRefSiteNo Number Monitored object reference for this
event. The name of the monitored object
MonitoredRefDeviceNo Number is found in the RefNames table by
MonitoredRefObjectType Text matching the SiteNo, DeviceNo,
ObjectType and Instance.
MonitoredRefInstance Number
MonitoredRefProperty Number
MonitoredRefArrayIndex Number
Priority Number Priority of this Event entry
InfoType Number Information type for this event
0 = Event, 1 = Ack, 2 = Error
InfoEventTimestampType Number Event Timestamp type: 0 = Time, 1 =
Sequence Number, 2 = DateTime
InfoEventTimestampTime Datetime Event time – present if
InfoEventTimestampType = 0
InfoEventTimestampSequenceNumber Number Event sequence number - present if
InfoEventTimestampType = 1
InfoEventTimestampDateTime Datetime Event date/time - present if
InfoEventTimestampType = 2
InfoEventText Text Event text
InfoEventFromState Number Previous state of event: 0 = normal, 1 =
fault, 2 = off normal, 3 = high limit, 4 =
low limit, 5 = life safety, 6 = unknown, 7
= off alarm, 8 = on alarm, 9 = trouble, 10
= security, 11 = fire
InfoEventToState Number New state of event: 0 = normal, 1 = fault,
2 = off normal, 3 = high limit, 4 = low
limit, 5 = life safety, 6 = unknown, 7 = off
alarm, 8 = on alarm, 9 = trouble, 10 =
security, 11 = fire
InfoEventFlags Number Debug information.
EVLFilters Table
The EVLFilters table contains a list of filters used by EVL objects in Historian.
Historian
The Historian table lists information about the Historian Settings object.
HistorianDebug
The HistorianDebug table stores information on devices (controllers) that .are
offline.
ObjectMap
The ObjectMap table provides the mapping from the archived objects in Historian
to the source objects within the devices.
Ops
The Ops table stores information on how long Historian was in each of five states.
This information is used to calculate statistics.
Sleeping Number
Fault Number
Refnames
The Refnames tables contain the mappings from the object references to their
object names.
ScheduleInfo
The ScheduleInfo table provides scheduling information for TLs archived by
Historian. There is one row for each archived TL.
Stats
The Stats table provides the names and data values for fields on the Stats tab of
the HS dialog.
TL
The TL table lists information about the TL objects within Historian.
TLData
The TLData table contains all the Trend Log data gathered by Historian. There is
one row for each TL entry retrieved from the remote devices.
Error Basic
Detailed Description Suggestions
Code Description
Remote Check to ensure the
The remote device is not
-25 device remote device is
available on the network.
failure functioning.
The remote device did not
Remote Check to ensure the
respond in the desired time
-27 device remote device is
– it may not be available on
timeout functioning.
the network.
Invalid This error might result from
-84 Debug information.
packet bad wiring.
The source TL has been
Source TL deleted on the controller
-127 Debug information.
deleted and the Archive TL cannot
collect any more data.
Ensure that Historian
Database Timeout while waiting for a
-165 is connected, and is
timeout database read/write lock.
not in fault.
Error Check with specific OS for
-166 Debug information.
unknown more information.
Error Service/ function was
-190 Debug information.
aborted aborted.
Create the source TL
The remote device does not on a device that
Network
support the services needed supports the BACnet
-380 service not
to perform the archiving of Read-Range service
supported
the TL. (e.g., Delta Controls
DCU, or DSC device).
For a detailed description of the fields and tabs in the RPT object, refer to
Chapter 10: Software Objects.
Features
The Reports feature:
Query Generates a report listing the objects, based on user-defined criteria. For
example:
• Calendar Configuration
• Schedule Configuration
CAL and SCH objects are used with other objects besides Access Controls ones. It
helps the building owners to know Calendar and Schedule setups in other control
devices.
Controller Reports Generates reports for Input (IP) and Output (OP) objects
only.
GENERATING REPORTS
The following section covers how to create, configure and choose outputs and
formats. Report (RPT) objects are found in the Report folder that appears in the
left-pane of the Navigator window.
2. Click New, and the RPT object opens automatically to configure the report.
3. From the Report Type drop-down menu, select the desired report.
1. From the Report Type drop-down menu, select Query. The new report
displays as shown in the following figure.
Selecting Devices
The next step is to select which devices are included in the object filter criteria.
There are three options presented: All Devices, Area Devices (Area, System and
Subnet), or Specific devices.
Note: The area drop-down menu is disabled if there are no area devices on the
network.
Note: A single device address can also be combined with a range of addresses,
e.g., 10000, 20000 - 30000, 40000.
Objects can be filtered for in the following ways: by object name, object type,
object instance or by property values. The following table provides examples of
filtering criteria.
Note: By selecting the Group by Device checkbox, objects are sorted into groups
by device, with a device name heading on each group. The list of devices is sorted
in ascending order based on the device address. If the checkbox is cleared, then
all objects are displayed in one inclusive list.
AO Object BO Object
Name Name
Description Description
Value Value
StatusFlags StatusFlags
Units CommissionFlag
CommissionFlag Reliability
Reliability DeviceTypeRef
DeviceTypeRef DeviceType
DeviceType Polarity
CurrentPriority InactiveText
DefaultValue ActiveText
COVIncrement ChangeOfStateTime
Polarity ChangeOfStateCount
DAValue MinimumOffTime
OutputVolt MinimumOnTime
ModuleType CurrentPriority
HandsOffAuto DefaultValue
FBackValue DAValue
ManualOverride OutputVolt
HALFlags ModuleType
CriticalControl HandsOffAuto
StartDelayTime
FBackValue
ManualOverride
HALFlags
FlickWarnEnable
FlickWarnTime
FlickWarnTimer
FlickWarnActive
FlickWarnPAEnable
CriticalControl
AT Object BT Object
Name Name
Description Description
Value Value
Units StatusFlags
StatusFlags OutOfService
OutOfService StartTime
COVIncrement ActiveStateChanges
StartTime COVIncrement
ConversionUnits ManualOverride
ConversionRate HALFlags
ManualOverride InputRef
InputRef RunSeconds
TL Object EV Object
Name Name
Description Description
Value Value
StatusFlags StatusFlags
OutOfService OutOfService
StartTime Algorithm
StopTime InputRef
LogInterval EventEnable
LogEnable AckedTransitions
IsHistorical NotificationClass
ManualOverride EnableAutoText
HALFlags ManualOverride
InputRef HALFlags
BufferSize EnableRef
EventClassRef
Editing a Column
To edit a column:
1. Right-click the column header and click Edit Column.
2. In the Edit Column dialog, enter an object property, or select one from the
drop-down menu.
3. Enter a column name.
4. Click OK to save the changes.
2. Select an option (e.g., #.## displays 2 decimal places), and then click Apply
to save the changes.
2. Select the Text option, and then click Apply to save the changes.
The Invoice field is used to enter the invoice number that appears on the Tenant
Billing report. Each time a new report is automatically generated, the invoice
number is incremented by one.
Note: For automatic report generation users should select either Previous Month
or Current Month from the Period drop-down menu, otherwise the billing reports
will be generated for the same month over and over.
Note: Users can choose a new invoice number, and then the report numbers
increase automatically from that point forward.
3. In the Trend Logs field, select the TLs for the report. To select multiple TLs,
hold down the CTRL key.
4. In the Rate ($/hr) field enter the numerical value.
Note: This rate will be applied to all the selected TLs.
5. Click OK to save the changes.
Note: A V2 TL could contain up to four series of data. All the series will be used
in the report.
4. Click OK.
Note: The value entered is removed as soon as the RPT object is closed.
5. Print or export the report.
Click the Minimum charge field, and enter a custom value (e.g., 45 min.)
Click the Roundup to the nearest field, and enter a custom value (e.g., 35
min.)
The following procedures cover selecting and configuring, and then entering
object filter criteria for the report.
4. In the Devices field, select the appropriate device(s). This is done in the same
way as Query reports.
5. In the Object Filter field, enter the filtering criteria.
Note: If a wildcard is entered (*) all appropriate objects are shown in the report.
This is based on the report type selected and the filter criteria.
For example, if the Card User Configuration report is chosen, and A* is entered,
all card users with a first name beginning with A are shown.
Configuring Layout/Destination
This section covers procedures for customizing report titles, notes and footnotes,
assigning a Triggered By object, and how to configure the report destinations.
Customizing Reports
Information is added to a report by using the fields within the Layout/Destination
tab.
• Name.
• Object instance.
• Object instance with a specific property.
• Object instance with the device number.
• Object instance with the prefix V2, and the device number.
4. Click OK.
3. In the File name field, enter a file name for the report.
4. From the Save as type menu, select the file format, and then click Save.
5. In the Destinations dialog, click OK.
6. The Destinations field now displays the report location and format.
Note: For files generated automatically, a suffix needs to be added to the report
name to prevent any previous reports from being overwritten. When entering a file
name the following notations can be used. These notations add specific
information to each file name. Multiple notations can be added to file names (see
Add the Time), and they can be used in any order.
3. In the Destinations dialog, fill in the appropriate fields. Use a semi-colon (;)
to separate addresses if sending to multiple recipients.
4. From the Format drop-down menu, select the format, and then click OK.
Note: A SMTP server is required to send reports by email. The SMTP server
address should be specified in the email tab of the Device object dialog for the
local operator workstation. See the following figure.
TROUBLESHOOTING REPORTS
The following section provides some examples of issues that may arise when
using the RPT object, and how to deal with these issues to maintain your reports.
• Limit the criteria by name, or by object type. For example, replace "* > 23"
with "(ai, ao, av) > 23" or Temperature* > 23.
• Reduce the number of columns in the report.
• Reduce the number of devices involved. For example, specify a smaller
device range, or specify devices within a single System instead of in the
whole Area.
The Historian Settings object (HS) provides access to the setup options and status
information for the Historian device. The HS object is automatically created when
Historian is started and is accessible from any Operator Workstation (OWS) on
the network.
Header
Object Mode
The Historian’s current mode of operation is displayed at the top of the header.
Historian’s five modes of operation are as follows:
Initializing Historian is establishing connections to its ODBC database and to
Delta Server and is initializing its schedule.
Archiving Historian is collecting data samples from one or more source TLs
that are being archived. Once the archiving is complete Historian goes into
sleeping mode.
Sleeping Historian is “waiting” for one of three events to occur, it will then
transition into Scheduling mode. Historian enters scheduling mode when any of
the following three events occur:
When the next scheduled polling time is reached.
When a COV buffer ready notification from a TL is received.
When a Forced Update for a Historical TL is requested by the user.
Scheduling Historian is “calculating” which TLs it will poll during its next
archiving phase.
Fault Historian has detected an error in the Historian database, the ODBC
database connection or else the Delta Server is offline. Historian will periodically
attempt to recover from the fault condition by reconnecting.
In Fault mode, Historian does not archive TLs or Alarm/ Event Notifications to its
ODBC database. However, Alarm/ Event Notifications are logged in a separate
MS Access database that is created when Historian is in fault due to database, or
database connectivity problems.
When Historian is in fault due to Delta Server being down, Historian does not log
to the Access database file as it no longer receives Alarm/ Event Notifications.
The backup Access file is called HistorianFaultDB.mdb and is located in the
Historian install folder.
Current Time This field displays the current time of the Historian PC.
Next Poll This field indicates the next scheduled time at which the Historian
Device will archive samples from one or more TL’s. Historian may start to poll
before this time if a forced update is requested, or if a Buffer Ready Notification is
received from a TL.
Last Poll This field indicates the last time that any TLs were polled for new
samples.
Stats
The Stats tab only shows statistics when viewed from the local Historian PC.
Note: For the Stats or Troubleshooting tabs to function, the DSN field in the
ODBC Info section must have the DB Name and connection information
configured on the Setup tab. During the initial installation, the ODBC Source
must be set up in Windows.
Historian Uptime
Indicates how long the Delta Server has been running on the Historian PC. It
displays the length of time in Days/ Hours/ Minutes/ Second.
Processing Time
Provides a relative indication of the status of Historian over time. The fields
display the percentage of total time which is spent in Archiving, Sleeping,
Scheduling, Initializing and Fault states. It tracks the percentage of time that
Historian is in each state and begins when the first TL is added.
To specify the database name in the DSN for Microsoft SQL server:
1 Open Data Sources (ODBC)
For a 32 bit OS, open Control Panel | Administrator Tools.
For a 64 bit OS, you must still use the 32 bit ODBC Data Source dialog (NOT
64 bit one). The Microsoft support provides vital configuration information.
See http://support.microsoft.com/kb/942976
2 Select the System DSN tab. See HistorianDSN listed:
3 Click Configure.
4 Click Next.
5 Select the authenticity type to SQL Server Authentication. Be sure to use the
SQL Server authentication.
6 In Login field, type the UserID displayed on the HS object Setup tab. The
default UserID is sa.
7 In Password field, type password you entered during the SQL Server
installation.
8 Click Next.
9 Select the Change default database to checkbox.
The configuration steps between the connector and the server are similar to the
previous Configuring DSN for Microsoft SQL Server section of this chapter. The
HS dialog needs to reflect all the changes done with the ODBC data source.
Troubleshooting
Troubleshooting is often difficult and demands many higher-order skills combined
with experience to solve problems in an efficient and effective manner. The
solution to a simple problem can be direct but often with complex systems, it is
difficult to resolve a problem. In many cases, a problem may have multiple
causes. With many components such as systems, equipment, controllers, software,
sensors and transducers, a complex system has a greater possibility of problems
due to multiple causes.
With a simple problem, it is easy to interpret appropriate data that helps to isolate
a reproducible cause and make suitable changes to prevent recurrence while not
introducing new problems.
With a complex problem, the nature of the problem itself is often unclear and may
also involve dynamic effects such as events that are not predictable. Some of the
most difficult troubleshooting issues arise from symptoms which are intermittent.
Your solution needs to prevent recurrence but also must not introduce further
problems within the overall system. After implementing a solution, you need to
observe and collect data to ensure its continued effectiveness.
Troubleshooting Tab
The Troubleshooting tab has two lists that display High Usage Trend Logs and
Trend Logs with Insufficient Samples.
The High Usage Trend Log list displays the busiest Trend Logs. If a Trend Log is
on the High Usage list, it does NOT indicate a definite problem.
The Trend Logs with Insufficient Samples list displays Trend Logs that Historian
cannot avoid missed data samples. If a TL is on the Trend Logs with Insufficient
Samples list, it does indicate a definite problem.
Note: For the Stats or Troubleshooting tabs to function, the DSN field in the
ODBC Info section must have the DB Name and connection information
configured on the Setup tab. During the initial installation, the ODBC Source
must be set up in Windows.
High Usage Trend Logs This is a list of the ten fastest to fill trends (Poll or
COV). You may not need to do anything about these trends because this list
shows the TLs that use the most Historian resources.
For example, the High Usage list may contain a Trend Log that collects large
amounts of data at frequent intervals. Everything may be fine as you need to
collect this data. Alternatively, the sample rate may be much too high for this
particular variable. It is also possible that the characteristics of the monitored
object value do not match expectations and indicate a possible problem within the
site. You may be using much more Historian resources than intended or needed
for a High Usage TL.
All Archive Trend Logs can be configured so that Historian can archive all Trends
without missing samples. To make sure this is the case on your site, use the
information in this High Usage table and in the Histlog.txt to verify the Trend
Logs in the High Usage list are configured correctly. The Histlog.txt can be
searched to make sure none of these Trend Logs have missed samples reported
and the information in the High Usage Trend Logs table should be reviewed.
The following table explains the information included with a High Usage Trend
Log list item. Each TL entry is followed by two numbers.
8000.TL1 - 3240, 1
Historian will be able to keep up with this trend.
First #: The number of seconds Historian waits between
(PollInterval) successive Trend Log data collection operations. This
is the PollInterval from the ScheduleInfo table in the
3240 database.
(Seconds between TL Historian cannot archive a single Trend Log more
Archives) than once every 120 seconds. This deliberate
constraint prevents a single poorly configured Trend
Log from dominating Historian’s resources.
The following table provides general guidelines for interpreting the information
included with a possible High Usage Trend Logs list item.
Second #:
(PeakRate) Lower 0.125 < 0.4 <1 >6 60
(Number of
Samples per
minute)
The following table provides some examples of possible High Usage Trend Logs
List Items with interpretation of the example.
8000.TL1 - 8100, 0.4 Good: Historian can keep up with this trend.
8000.TL1 - 86400, 0.125 Better: Historian can definitely keep up with this
trend.
Trend Logs with Insufficient Samples This is a list of the top ten trends
(Poll or COV) that Historian will miss data from with the current TL
configurations. If a Trend Log is on this list, it indicates a definite problem that
needs attention. These Trend Logs often do not have a large enough Max Samples
setting in the source Trend Log for Historian to be able to archive all new data at
the rate each Trend Log is storing data.
The typical solution involves increasing the size of the Max Samples field on the
source TL. However, this approach may not always be possible because of
constraints on available controller memory.
You can reconfigure a Trend Log with Insufficient Samples so that Historian can
archive all new data. You could either increase the Max Samples for each TL or
decrease the rate of data collection. For Poll Trend Logs you could increase the
Log Interval. For COV Trend logs you could increase the COV Increment of the
Monitored Object or switch to a Poll Trend Log if your application permits.
Generally, you would increase the size of the buffer for the Trend Logs which
provide the most important data. There is a balance between the demands of data
collection, the memory available on a controller and the relative importance of the
data.
For example, a list item might be:
8000.TL1
8353.TL6
If 8000.TL1 is a Poll Trend Log with a Log Interval of one second and a Max
Samples (buffer size) of 100, then Historian cannot archive all the data. Historian
A solution might be to increase the Max Samples and/ or to increase the Poll
Interval. You could increase the Max Samples buffer size assuming that memory
is available on the controller. You could also reduce the data collection rate by
increasing the Poll Interval as it is probably not necessary to collect new data
every second.
If 8353.TL6 was a COV trend log, a typical solution would be to evaluate the
COV Increment of the Monitored Object to make sure that it is reasonable for the
point being measured and then change the COV increment and/or increase the
Max Samples for the TL as appropriate.
In the case of an intermittent problem, you can run a query on the ScheduleInfo
table looking at the MaxPeakRate. The MaxPeakRate provides the highest number
of samples per minute ever recorded in the past.
The following query will help identify trends that have problems due to
intermittent periods of high data samples:
Select * FROM ScheduleInfo ORDER BY MaxPeakRate DESC
When the trends with intermittent high data rates are identified, you can increase
their MaxSamples, decrease their COV rate number or decrease the samples rate.
The extra HistLog info also lists this information.
Setup
The Setup tab contains the setup items for Historian’s auto logon, ODBC
connection, TL polling and error logging.
Auto Logon
UserName This field specifies the name that the Historian Device uses when it
logs onto the Delta Server.
Password This field specifies the password that the Historian Device uses
when it logs onto the Delta Server.
The UserName and Password must match those of a System User Access (SUA)
object in the local database, or in the security panel. For information on changing
the password see Chapter 6: Trending, Archiving and Reporting.
ODBC Info
Historian is installed with a default Database Management System (DBMS), and
the settings are displayed in this section. Most users will not need to change the
following fields unless they choose a different DBMS package or if they need to
apply user security to the Historian database. Users who choose a different DBMS
will need to set these fields up appropriately. For more information on ODBC see
Chapter 6: Trending, Archiving and Reporting.
Driver The Driver field indicates the type of ODBC DBMS that Historian is
configured to use.
UserID The UserID field specifies the name that Historian uses to connect to
the database. The UserID and Password for the database are configured when the
DBMS package is installed. There is no relationship between this UserID and the
user name that the Historian will use to log onto the Delta Server.
DSN The Data Source Name (DSN) field specifies the ODBC DBMS source
that Historian is using. To use an alternate DBMS source, it must first be set up
through the appropriate ODBC Data Source Administrator dialog. Use the 32 or
64 bit version based on your OS..
Password The Password field specifies the password that Historian uses to
connect to the database. UserID’s and Passwords for this database are set up using
the installed DBMS package.
DB Name The DB Name field specifies the database that will store the
archived information. If a database name is not specified then Historian uses the
default database assigned to the selected DSN.
Archive TLs are presented as regular TLs to the other BACnet devices. As such,
they are accessible via any BACnet Operator Workstation (OWS) that supports
TLs as defined in the BACnet Standard (2001b or later). Historian will not work
with devices implementing trending as defined in versions of the standard prior to
2001b.
Once TLs are archived, the Archived TL’s cannot be removed without using a
database management tool.
Note: To mark a trend or groups of trends (regular TL's) for archiving in Version
3.40, follow the procedure in the Archived checkbox field of the TL Setup Tab:
Log Interval l section. V3.40 now supports multiple Historians on one site and as
a result the Archived checkbox on TL is not editable and is greyed out. In V 3.40,
you must select a TL or group of TL's in the right pane of Navigator and then
right click. From the menu, select the Command option and click on Add to
Historian.
Header
In the previous figure, the first section of the header shows the Historical TL’s
operating mode.
Samples
The Samples field displays the number of data samples that are currently stored in
the ODBC database for this TL.
Update Button
The Update button allows users to instruct the Historian Device to immediately
archive any new samples in the source TL.
Graph
The Graph tab contains a visual representation of the monitored object’s values
within a specific time frame.
The graph plots the object’s value on the Y-axis, against the time, which is on the
X-axis. These two axes are automatically scaled to best fit the available data.
Only the 200 most recent samples are graphed. To view the full set of TL data
graphically, create a Multi-Trend (MT).
Setup
All the fields within the Setup tab are read-only, with the exception of the Name
field.
Name
The Name field displays the name of the Archive TL. In the previous figure, the
Name text box shows the default naming convention for Archive TL’s. The Name
field can contain up to 255 characters. The Archive TL is named in this way: the
TL controller number, the TL name and then Archive. For example, an archived
TL for Temperature, on controller 100 would look like this: 100_Temperature
Archive.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security.
When a checkbox is selected, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Monitored Object
The read-only Monitored Object field displays the name of the source TL’s
monitored object. If the source TL’s monitored object is changed, the Historian
Device will detach from the TL and a new TL is created for the new monitored
object.
Log Type
The read-only Log Type field displays whether the source TL is in Polling mode,
or in Change of Value (COV) mode. Depending on the how the TL is configured,
Historian gathers the data in the following ways:
Log Interval
The read-only Log Interval field is only shown when the source TL has a Polling
Log type. The log interval is the amount of time between polled samples of the
source TL. The value in this field is taken from the Log Interval field of the source
TL.
When changes are applied to this field in the source TL, the field is also updated
in the corresponding Archive TL.
Max Samples
The read-only Max Samples field displays the maximum number of samples that
can be stored in the TL. In an Archive TL, this field is set to ‘unlimited’.
Total Samples
The read-only Total Samples field displays the total number of samples that the
archived TL has collected since it was created.
Start Trend At
This field shows the value of the Start Trend At field from the source TL. This
value does not affect the functioning of the archived TL.
Stop Trend At
This field shows the value of the Stop Trend At field from the source TL. This
value does not affect the functioning of the archived TL.
Data
The Data tab contains a text listing of all the data stored in the Archive TL. Each
entry shows the time and date at which the sample was collected, and is presented
with the newest data at the top of the list.
The Value column shows the value of the sample, which is displayed as 1 or 0 for
Binary values. An “Active” state is indicated by 1, and an “Inactive” state is
indicated by 0.
The Value column also displays error and status messages. This helps with
troubleshooting because these error and status messages do not show up in the
graph.
Some of the system messages that are shown in the Data tab include:
• Time Change: the time on the controller changed.
• Log Enabled: the source TL was enabled.
• Log Disabled: the source TL was disabled.
• Missed Sample: Historian missed a sample from the source TL.
• Buffer Purged: the source TL’s buffer was cleared.
• Archive Disabled: the archived TL has been disabled.
• Archive Enabled: the archived TL has been enabled.
If an archived TL is disabled, the log may have an Archive Disabled entry. If the
Archive TL is re-enabled and Historian finds that no samples have been missed,
the Archive Disabled entry in the Data tab is removed.
If, however, samples have been missed, Historian leaves the Archive Disabled
data entry in the Data tab and inserts an Archive Enable entry after the missed
sample entries.
With an Archive TL, purging the buffer of a source TL using the Reset Samples
button or the Reset command in Navigator will cause the loss of any data in the
TL that is not yet archived.
Description
The Description tab provides the standard BACnet description field. It can be used
for any comments the user may have. It has no bearing on the execution of this
object. The Description field can contain up to 2000 printable characters.
The Trend Log (TL) object stores data for one monitored object. The TL can be
set to collect data in two ways:
• Change of Value
• Polled
Change of Value TLs use the monitored object’s Change of Value (COV)
minimum increment to determine when to take a new sample. When the
monitored object’s value changes by more than the COV minimum increment, a
new data sample will be collected in the TL. All objects default to a COV
minimum increment of 1.0, but this can be changed on an object-by-object basis.
Polled TLs collect new data samples based on a time interval, which can be set by
the user. This time interval is called the Log Interval. By default, a new TL will
have a Log Interval of one minute, which means that a new data sample will be
taken every minute.
The Archival Buffer Notification Setup enables a notification to occur once a set
threshold of samples has been recorded. This functionality can be used to perform
automated archival of trend data to prevent data loss.
Historian Note: V3.40 now supports multiple Historians on one site and as a
result this Archived checkbox is not editable and is grayed out. The Archived
checkbox was available in 3.33. In V 3.40, you must select a TL or group of TL’s
from a selected controller in the right pane of Navigator and then right click.
From the menu, select the Command option and click on Add to Historian.
Header
While a Trend Log is in “Enabled” mode, the object collects data samples and the
current date is between the Started Trend At date and the Stop Trend At date.
When a Trend Log is in “Disabled” mode, the object goes into auto shutdown.
This prevents existing data samples from being overwritten. When in Disabled
mode, the user must manually set the object to “Enabled” to start trending again.
Started Trend At
If the TL is set up to start archiving at some time in the future, this field is visible
and shows the scheduled start time.
Stop Trend At
If the TL is archiving and is set up to stop archiving at some time in the future,
this field is visible and shows the scheduled stop time.
Samples
This field displays the current number of data samples stored in Historian’s data
buffer.
Graph
The Graph tab contains a visual representation of the monitored object.
The graph plots the object’s value on the Y-axis, against time, which is on the X-
axis. The two axes are automatically scaled to best fit the available data. The
graph provides a fixed, 200 sample width. Only the most recent 200 samples are
graphed, regardless of how many samples the Trend Log is capable of storing. In
order to see the full set of data, use the Multi-Trend (MT) object.
Setup
Name
Name is a descriptive label given to an Object. Typically, a name is less than 20
characters in length. The length of a name is from 1 to 255 characters on a DCU
or an OWS and 1 to 67 characters on a DAC. The name must be unique among the
objects located on the same controller.
operators for the HVAC and Access applications. It is possible for each operator
to only see the objects related to their application.
Note: For more information on how to set up and administer Object Application
Restrictions, see Chapter 7- Security.
When a checkbox is selected, an indicator icon appears at the top of the dialog.
The three application domains are:
Application Icon
HVAC (Red)
Access (Blue)
Lighting (Green)
Monitored Object
The Monitored Object is the object that is being trended. Any analog or binary
value can be trended. By default, the value property of the monitored object is
trended. If a property name is specified, then that property is monitored. For
example, 9100.AI1 Commissioned, would trend the commissioned flag of this
analog input object.
Historian Note: Detached Trend Logs — If the source TL (of an Archive TL) is
deleted, or the monitored object is changed, or the archived checkbox is cleared,
the associated Archive TL becomes detached. Detached TL’s are set to
“Disabled” and do not collect new data, but they do keep all the data they have
accumulated.
Log Type
Change of Value Change of Value TLs use the monitored object’s Change of
Value (COV) minimum increment to determine when a new sample should be
taken. When the monitored object’s value changes by more than the COV
minimum increment, a new data sample will be collected in the TL. All objects
default to a COV minimum increment of 1.0, but this can be changed on an
object-by-object basis.
Polled Polled TLs collect new data samples based on a time interval, which can
be set by the user. This time interval is called the Log Interval. By default, a new
TL will have a Log Interval of one minute, which means that a new data sample
will be taken every minute.
Historian Note: Changing the Log Type field in a TL that is being archived may
cause Historian to change the manner in which it archives the TL’s data samples.
See the following table for details.
Log Interval
This is the amount of time between polled samples. The log interval can be set
from a minimum of one second, to a maximum of 23:59:59 hours.
If a TL is polling a remote object, then the time should not be set to less than 30
seconds as remote data exchange cannot achieve intervals faster than once every
30 seconds.
Historian Note: When the Log Interval is altered in a TL that is being archived,
the change affects how frequently Historian archives data samples from the
source TL.
Daily Checkbox
When the Daily checkbox is enabled, samples are taken once per day at a
specified time. The Daily sample time is determined by the Start Trend At
spinbox.
Max Samples
The Max Samples field is the maximum number of data samples that can be stored
in the TL’s data buffer. The range of this value is between one and 6000, with the
default being 100. The larger this number is, the more memory used by the
controller. As a rough guide, each sample takes about 10 bytes. Thus, a 100
sample TL would require 1000 bytes of memory. Obviously, not very many 6000
sample TLs (each occupying about 60,000 bytes) can be created in one controller.
Historian Note: Changing the Max Samples field affects the frequency at which
the Historian gathers samples if the TL is being archived. Increasing the Max
Samples value will improve Historian performance and help ensure the safety of
the data.
Total Samples
This number is the total number of samples that the TL has collected since it was
created. This field is read-only and cannot be reset.
Start Trend At
This field is used to specify the time and date at which the TL will start sampling.
When the checkbox is cleared, “No Start Date” will be displayed in the field and
the TL will start sampling immediately. When the checkbox is selected, enter the
desired start time into the field. The time format is HH:MM:SS.
When a new TL is created, the Start Trend At Date defaults to 00:00:00 Jan 2000
which is the base time. The Trend At date is enabled with no Stop Trend At Date.
When the start date is enabled, sample times are calculated using the Time Start
when Polling is used. The object calculates time interval on even periods if the
entered Start Trend At Time is divisible by 60 for minutes and seconds, or
divisible by 24 for hours. The Log Interval spin box allows a max of 23:59:59. If
you need to use a daily sample rate, you can enable the Daily checkbox beside the
Log Interval spin box.
The following examples show the behavior of the sampling for different entries:
• 00:00:00 15 min polling samples on hour, 15 minutes past, ½ past, and 45
minutes past hour.
• 00:00:10 15 min polling samples at 10 after hours, 25 minutes past, 40
minutes past, and 55 minutes past hour
• 00:00:00 1 Hour polling sample every hours on the hour
• 00:00:30 1 hours polling sample every hour at ½ past the hour
• 17:00:00 24 Hours polling sample every day at 17:00:00
• 00:00:00 2 hours polling sample at 0, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22
• 01:00:00 2 hour polling sample at 1, 3, 5, 7, 9, 11, 13, 15, 17, 19, 21, 23
If the sample time does not follow the rules of divisibility, then it is polled based
on the Trend Log start time or reset and simply counts the time period from this
start time. On Reset or DST/Time change, the new algorithm does not sample
immediately. It calculates the projected time for the next sample and then samples
at this time but cannot maintain the interval.
For example, a controller is reset at 12:30:30 and interval is 11 seconds. Then the
first sample will be at 12:30:41 the next and + 11 seconds so 12:30:52 instead of
being lined up on even intervals.
When the Start Trend At time is disabled, the Trend Log works in the standard
way. It begins taking samples on Reset/ Time Change/ creation of new TL and
then after the Polling Interval.
Stop Trend At
This field is used to specify the time and date at which the TL will stop sampling.
When the checkbox is cleared, “No End Date” will be displayed in the field and
the TL will never stop sampling. When the checkbox is selected, enter the desired
end time into the field. The time format is HH:MM:SS.
4 If there are multiple Historians installed on the site, select the particular
Historian that you wish to archive the selected trend(s) to.
The previous dialog only appears if the site has more than one historian.
5 When the trend is marked as Archived, the Setup tab will show that it is being
archived.
The Archived checkbox cannot be edited from the Setup tab of the TL.
The Reporting checkbox can now be disabled for DAC and DSC controllers.
Event Class The Event Class drop-down menu is used to select the
notification’s event class. The choices available will reflect the EVCs that are set
up in the controller.
Threshold The Threshold field is where the number of log entries recorded
before an event occurs is set. When the number of records has been exceeded, the
threshold count will be reset and an event will occur again once the number of
records exceeds the threshold value.
Records Since Last Notification The Records Since Last Notification field
displays the total of new records acquired by the TL since the last time an
Archival Buffer Notification was sent to Historian. This can be polling or COV
TLs.
Data
The Data tab is a text listing of the data in the TL’s buffer. Each entry shows the
time and date at which the sample was collected. The data is presented with the
newest data at the top of the list.
The Value column shows the value of the sample, which is displayed as a binary
value, 1 indicates On, and 0 indicates Off. Error and status messages are also
displayed in the dataview. These are to aid with troubleshooting and will not show
up in the graph.
With an Archive TL, purging the buffer of a source TL using the Reset Samples
button or the Reset command in Navigator will cause the loss of any data in the
TL that is not yet archived.
Note: A Trend Log object will trend a maximum period of around 490 days or the
date-time information for the old data is lost. Any trended data or error/event data
that is older than 490 days is automatically removed from the TL on a weekly
basis. This does not apply to Archive TL’s.
Description
The description tab contains the standard BACnet description field. It can be used
for any comments the user may have. It has no bearing on the execution of this
object. The Description field can contain up to 2000 printable characters.
The Multi-Trend (MT) is an ORCAview application that graphs the data samples
in Trend Logs (TL). Up to eight TLs can be graphed simultaneously in one MT
Object. The graph will plot new samples as the TLs collect them.
One of the MT object’s most useful features is the ability to drag-and-drop a TL
onto the MT dialog and have the MT start graphing the TL automatically. This
feature makes it possible to graph different TLs at any time and instantly compare
them.
Multi-Trend Components
This section explains how the Multi-Trend object presents information. A Multi-
Trend object has these main components:
• Graph Area
• Dataview
• Slider Bar
• Axes
• Graph Legend (Colored Squares)
• Toolbar
Graph Area
The graph area is where Trend Log data is plotted and displayed. Analog data is
graphed along the top section, and the digital, or binary data, is graphed along the
bottom. The view can be scrolled from side to side to view all the data that the MT
has in its data buffer.
Dataview
The lower portion of the MT object contains the Dataview area. This area displays
information about each monitored object.
Dataview
Monitored Object This column lists each monitored object being plotted. To
the left of the monitored object name are two icons. The first is a checkbox that
shows or hides each line graph. The second icon shows the monitored object’s
corresponding line color on the graph.
Value This column shows either the last sample taken or the sample at the
intersection of the Slider Bar line and each graph.
Min / Last Off and Max / Last On These columns show the minimum and
maximum values for analog Trend Logs and the last on and last off times for
binary Trend Logs.
Average / On Time This column is the calculated average value for analog
Trend Logs, and the time spent in an ON state for binary Trend Logs.
Units This column shows the unit used for the data in each Trend Log.
Slider Bar
The slider bar at the top of the graph area is used to show the value of individual
samples for a specific time. When the slider bar is moved back and forth along the
length of the graph window, the slider caption will change to reflect the time that
the slider bar is positioned at, on the time axis. Where the slider line intercepts the
TL graphs, the value of the graph at that point will be shown at the bottom of the
MT window in the dataview section, under the Value column.
In order to move the slider bar back and forth, position the mouse cursor over the
slider caption area, press and hold the left mouse button, and then move the cursor
to the left or right.
Slider bar
Axes
Trended objects can be graphed against three axes: the Y1-axis (left-hand side),
and Y2-axis (right-hand side) are used to graph analog data. The X-Axis is used
for time and appears underneath the graph area.
Binary Trend Logs graphed in the Multi-Trend will have their own binary axis
created. The binary data appears at the bottom of the graph when needed.
There can be colored squares on both sides of the Multi-Trend graph area. The
color of the squares corresponds to the color of the graph lines. If the square is on
the left, then that graph is being plotted against the Y1-axis. If the square is on the
right, then the graph is being plotted against the Y2-axis.
Toolbar Components
The Toolbar is used to configure the Multi-Trend object.
The following section describes, from left to right, each of the toolbar buttons, and
the related functions.
TL Setup
This button opens the Line Properties dialog to set each TL up. There are eight
tabs, one for each TL, for a maximum of eight TLs that can be graphed at one
time.
Trend The Trend field is where the TL object name or object reference is
entered.
Axis Assignment These option buttons are where the axis for the Trend Log
is selected. Analog TL’s can be set to use either the Y1-axis or Y2-axis. Binary
TL’s should automatically be set to use the digital (binary) axis.
Graph Properties This drop-down menu is where the color of the Trend Log
graph is selected. For good printing results, select colors that are easy to
distinguish if using a black and white printer.
Remove Trend Button This button is used to remove the Trend Log from the
Multi-Trend. When the Remove Trend button is clicked, the user must click
Apply or OK to remove the TL.
Axis
The Axis button on the Multi-Trend toolbar opens the Axis Properties dialog that
sets the axis properties for Time (X-axis) and Value (Y1-axis, Y2-axis).
X-Axis Tab
These are the fields displayed in the X tab of the Axis Properties dialog.
Start Time This is the time at which the graph started plotting. This time is
displayed as the left-most value along the X-axis. If the Automatic checkbox is
selected, then the Start Time of the graph is automatically configured to show the
oldest Trend Log sample. If the Automatic checkbox is cleared, then time and date
fields are enabled. These fields are used to specify the time at which the graph will
start plotting.
Time Span This is the time span that the graph area will show. If the
Automatic checkbox is selected, then the graph will show all of the Trend Log
samples from the Start Time onwards. If the Automatic checkbox is cleared, then
the time span must be specified. The default value is eight hours.
Scale & Grid Interval This section sets the time interval for the X-axis and
grid lines (if displayed). If the Automatic checkbox is selected, then an interval
time will be calculated. If the Automatic checkbox is cleared, the time interval
may be set by the user.
Show Grid This checkbox enables and disables the X-axis grid lines.
The following fields are displayed in on the Y1, and the Y2 tabs of the Axis
Properties dialog. Both tabs contain the same fields.
Minimum Value This is the lowest value on the Y-axis scale. If the Automatic
checkbox is selected, the minimum value is determined based on the data to be
shown. If the Automatic checkbox is cleared, then the lower end of the Y-axis can
be set manually.
Maximum Value This is the highest value on the Y-axis scale. If the
Automatic checkbox is selected, the maximum value is determined based on the
data to be shown. If the Automatic checkbox is cleared, then the higher end of the
Y-axis can be set manually.
Scale & Grid Interval Selecting this checkbox sets the grid interval for the Y-
axis and grid lines (if displayed). If the Automatic checkbox is selected, then an
interval is calculated. If the Automatic checkbox is cleared, then the grid interval
may be set by the user.
Axis Precision Selecting this checkbox sets the number of decimal places that
are displayed on the Y-axis. If the Automatic checkbox is selected, then an
appropriate Axis Precision will be calculated. If the Automatic checkbox is
cleared, then the Axis Precision may be set by the user.
Axis Title This field displays the title that is shown on the graph.
Show Grid Selecting this checkbox enables Y-axis grid lines. When this
checkbox is cleared the grid lines are disabled.
Settings
The Settings button opens a dialog that sets some general MT properties.
Show Graph Values When this checkbox is selected, the MT displays the
actual Y-axis value for each data sample on the graph.
Note: The Show Graph Symbols must be selected first to enable the Show Graph
Values checkbox.
Polling Intervals This value is the amount of time the MT waits before
retrieving any new data samples that are stored in the TLs. The default MT polling
time is now 1 minute from the previous 10 seconds so as to improve the
performance of the Multi Trend and reduce the CPU usage.
Setting this value lower will speed up the responsiveness of the MT, but at a cost
in terms of network traffic. The minimum value for polling intervals is 10
seconds. If the MT seems sluggish, it is recommended that this value be increased
as necessary. MTs containing eight TLs, with a large number of samples (more
than 1000 each), should have this value increased to more than one minute.
Pause
This button prevents any automatic display updates. The MT keeps graphing and
only freezes the frame so the X axis (time scale) does not resize itself or pan when
the graph reaches the right. This is done so that when using the Back / Fwd and
Zoom In / Zoom Out functions, the display is not changed on the next polling
interval.
Print
This button prints the currently viewed MT. Note that if the connected printer is
capable of color, then the MT printout will be in color. It is also possible to select
the Print to File option on a Windows print driver and click OK. Then, you enter
the file path and name. A Postscript file is created and it is readable by a printer.
Save
This button saves the selected MT’s data, and writes it to a comma-delimited text
file with the default name MT.txt. The Username, Date/Time, and Workstation
name are included at the top of the file. This data can then be imported into a
spreadsheet or another application. All of the MT's data will only be written to the
file if the MT is in Auto mode showing the entire data. If the graph is only
showing a subset of the data, for example zoomed in with Setstart or Range mode,
only the viewable data points will be written to the file
Report Setup
The Report Setup tab is used to select and configure the Query, Tenant Billing,
Access Configuration, Access, Controller Configuration, and Controller reports.
When a new RPT is created the Setup tab defaults to Query report. The overall
layout of this tab changes based on which report type is selected.
Query Generates a report listing the objects, based on user-defined criteria. For
example:
• Calendar Configuration
• Schedule Configuration
CAL and SCH objects are used with other objects besides Access Controls ones. It
helps the building owners to know Calendar and Schedule setups in other control
devices.
Controller Reports Generates reports for Input and Output objects only.
The following sections describe the Setup tab for each report. This tab changes
based on the report type selected. The Destination/Layout tab and the Description
tab are the same for all six report types.
Query Setup
The following section describes all the fields and dialogs in the Setup tab when a
Query report is selected.
Devices
The Devices section of the Setup dialog contains three options for selecting object
filter criteria for individual devices or a range of devices.
All Devices Selecting All Devices filters for criteria related to all Version 2,
and all BACnet devices. If All Devices is selected, the query report displays
results from all devices that meet the object filter criteria.
Area Selecting this option enables the Area, System, and Subnet drop-down
menus, and allows the selection of devices based on the Area-System-Subnet
(DNA) architecture. Only BACnet devices are listed in these menus.
When an Area device is selected, the System drop-down menu shows all the
System devices under that area. Selecting All Devices from the System drop-down
menu generates reports on all devices in that Area.
If a specific System device is selected, the report is generated on all devices under
that system.
When a System device is selected, the Subnet drop-down menu contains all the
Subnet devices under that System. Users can generate a report on a single subnet
device by selecting a device in the subnet drop-down menu.
Note: If there are no applicable devices for the drop-down menu, that specific
drop-down menu is disabled.
Specific Selecting Specific filters for specific devices or device ranges. Some
examples of acceptable entries are:
• 23000
• 23000 - 40000
• 40000
• 23000, 30000 - 45000, 60000
Object Filter
The Object Filter box is used to enter specific search criteria in the same way
information is entered into the Navigator Filter Bar in ORCAview. The Object
Filter box limits which objects are displayed in the report. Objects can be filtered
in the following ways: by object name, object type, object instance, or by property
values. The following table provides examples of filtering criteria that can be
used.
Report Format
The Report Format section is used to configure how each column of the report
information is displayed.
Clicking the column headers sorts contents in ascending or descending order. The
columns and cells within each section can be modified in a variety of ways. The
right-click function is used to Add, Remove and Edit columns based on the report
information required.
Once modified, any report changes can be viewed by clicking the Preview button
on the lower left corner of the Setup dialog.
Property The Property cells define the object property shown in the report.
Using the cursor, click the cell, and select one of the predefined properties (as
shown in the following figure), or enter an object property that is relevant to a
specific object type.
Alignment The Alignment cells define the text alignment (left, center, right)
within that column. Click the cell to change the alignment.
Format The Format cells define how the properties are displayed, which can be
either text or decimal values. For example, if the object property is True/False and
"Text" is selected as the Format, then "True/False" is displayed in the column. If
the number signs (#.#####) are selected as the Format, then "1.00000/0.00000" is
displayed in the column.
Add, Edit & Remove The Add, Edit and Remove functionality becomes
available by right-clicking in the dataview area of the Report Format section.
Add Column This dialog contains two fields for adding new columns to a
report, the Property field and the Column Name field.
• The Property field defines the object property that is shown in the column. It
contains a drop-down menu of predefined properties or a desired property can
be entered.
• The Column Name field defaults to the predefined property chosen. This field
can be customized by typing in a chosen name. This name then appears as the
column header.
Edit Column This dialog is used to edit any columns by changing either the
Property field, or the Column Name field.
Remove Column This feature removes columns from the Report Format
dataview and from the report. Using the right-click function within a column,
click Remove Column to delete it.
Period
The Period drop-down menu is used to define the range of data used to calculate
the billing time period.
The options available are Previous Month, Current Month, or any of the 12
calendar months (January through December). When one of these calendar
months is selected, the Year box is enabled.
Invoice #
The Invoice field is used to enter the invoice number that appears on the Tenant
Billing report. Each time a new report is auto-generated, the invoice number is
incremented automatically. A new invoice number can be chosen, and then the
report numbers increase incrementally from that point forward.
Trend Logs
The Trend Logs dataview displays a list of the TLs used to calculate the tenant
billing amount. The Trend Logs dataview contains the following four columns:
Rate Displays the amount charged per hour for each TL entry.
+/- Displays any temporary adjustments made for that specific TL entry.
Because this value is temporary, the information is deleted when the RPT dialog is
closed.
Add Button
The Add button opens the Add Trend Log dialog, so that single or multiple TLs
can be added to the Trend Logs dataview.
Trend Logs The Trend Logs area displays a list of all TLs found in the
selected devices.
Rate The Rate field is for setting the hourly dollar rate that is used to calculate
the overall transaction cost for that specific TL. This field only accepts positive
numbers. By highlighting multiple TLs, the rate is applied to all of those selected.
Edit Button
The Edit button opens the Edit Trend Log dialog to modify the Description, Rate,
or the Temporary Adjustment value of a selected entry in the Trend Logs
dataview.
Trend Log Displays the TL name and the TL object reference (for example,
2000.TL2).
Rate ($/hr.) This field is used to set the hourly rate for the TL.
Remove Button
The Remove button deletes any highlighted entry from the Trend Log dataview.
Minimum Charge The Minimum Charge drop-down menu sets the minimum
time charge for transactions. This menu has the options 0, 5, 10, 15, 30, or 60
minutes, or enter a value of 0 - 6000. These amounts are displayed in the Tenant
Billing Report. For example:
Note: Access Configuration Report templates show how specific objects are
configured. Instead of going to a specific object or group of objects to see the
configuration, a report can be generated for that object or group of objects.
Devices
The Devices section contains three options for selecting object filter criteria for
individual devices or a range of devices. These fields are the same as the fields in
the Query report Setup tab.
All Devices Selecting All Devices filters for criteria related to all Version 2,
and all BACnet devices. If All Devices is selected, the query report displays
results from all devices that meet the object filter criteria.
Area Selecting this option enables the Area, System, and Subnet drop-down
menus, and allows the selection of devices based on the Area-System-Subnet
(DNA) architecture. Only BACnet devices are listed in these menus.
When an Area device is selected, the System drop-down menu shows all the
System devices under that area. Selecting All Devices from the System drop-down
menu generates reports on all devices in that Area.
If a specific System device is selected, the report is generated on all devices under
that system.
When a System device is selected, the Subnet drop-down menu contains all the
Subnet devices under that System. Users can generate a report on a single subnet
device by selecting a device in the subnet drop-down menu.
Note: If there are no applicable devices for the drop-down menu, that specific
drop-down menu is disabled.
Specific Selecting Specific filters for specific devices or device ranges. Some
examples of acceptable entries are:
• 23000
• 23000 - 40000
• 40000
• 23000, 30000 - 45000, 60000
Object Filter
The Access Configuration report template selected limits what information can be
entered into the Object Filter field. For Example, if the report style selected is
Schedule Configuration, then the object filter only applies to the SCH object (e.g.,
*=ON shows only the SCH objects that have an ON state).
Layout/Destination
The Layout/Destination Tab is used to customize report templates, configure
automated report generating schedules, and to choose report destinations.
Name
The Name field displays the name of the monitored object.
Title
The Title field is used to include descriptive information about the report. This
field only applies to Query Reports and Access Reports. When creating a new
RPT object, the RPT object name is filled into the Title field by default.
Notes
The Notes field is used to enter descriptive text into the heading area of a Query or
an Access Configuration report. For Tenant Billing reports, the text appears in the
Notes box. The maximum number of characters that can be entered is 254.
Footnote
The Footnote field is used to enter descriptive text at the end of a Query, Tenant
Billing, or Access Configuration Report. The maximum number of characters that
can be entered is 254.
Triggered By
The Triggered By field is used to enter an object reference, which can then
generate reports automatically. When the referenced object transitions from a
False state to a True state, a report is generated and sent to the chosen
destinations.
Destinations
The Destinations area is used to select where and how a report is sent. The Add
and Edit buttons are used to select and modify the destinations for the reports. The
Remove button is used to remove any of the report destinations no longer needed.
Add
The Add button is used to add a new destination. When selected, the destination is
displayed in the Destinations list area.
The Type drop-down menu contains three options: Printer, File, and Email.
Selecting these options determines which fields are available.
Printer When Printer is selected as the destination, the dialog shows all
available printers connected to the system.
File When File is selected as the destination, the dialog displays a Save As
button which is used to select the desired file format and storage location. The
default is “C:\Programs\Delta Controls\3.30\Sites\[Site Name]. When entering the
filename, the correct file extension must be used (pdf, rpt, csv, tsv, xls, htm, doc,
xml) or an error dialog appears.
Note: For files generated automatically, a suffix needs to be added to the report
name to prevent any previous reports from being overwritten. To create the suffix
a notation is used. These notations add specific information to each file name.
Multiple notations can be added to file names (see Add the Time), and these
notations can be used in any order. The Add an Invoice Number is used for Tenant
Billing only. When entering a file name the following notations are used.
Email When Email is selected as the destination, the dialog displays the address
fields and a Format field, as shown in the following figure. Format choices
include: Acrobat, Crystal Reports, Comma Separated Values, Tab Separated
Values, Excel, Word Document, HTML Document, or XML.
Edit
The Edit button is used to make changes to any selected destinations. Once a
destination is selected, click Edit to open the current destination settings and make
any required changes.
Remove
The Remove button is used to select, and then remove a report destination.
Description
The Description tab provides the standard BACnet description field. It can be used
for any comments the user may have. It has no bearing on the execution of this
object. The Description field can contain up to 2000 printable characters.