Professional Documents
Culture Documents
MetasysAdvancedReportingSystem Help LIT12011312
MetasysAdvancedReportingSystem Help LIT12011312
Interface
Using the System Configuration Tool SCT Technical Bulletin LIT-1201534
(SCT)
Installing and Configuring the Metasys ADS, ADX, and SCT Installation and Upgrade Instructions LIT-12011521
Advanced Reporting System Wizard
2
Reporting Database
Changing the Timeout Period ADS/ADX Commissioning Guide LIT-1201645
Setting up User Accounts and Security Administrator System Technical Bulletin LIT-1201528
Authorization for the Reporting System
in the Security Administration System
Installing the Launcher Application Launcher Installation Instructions LIT-12011783
Using the Launcher Launcher Help LIT-12011742
Important: When you make changes to the SCT archive database, the data does not synchronize with the data
in the Select Objects panel in the reporting system until a data refresh occurs at the default time (3:15
A.M.) or the Metasys Advanced Reporting System ADX administrator manually refreshes the data. For
information on this administration activity, see Refreshing the Metasys Advanced Reporting System
Data Manually.
If you are using Energy Essentials, you must take an additional step to make sure energy configuration
changes appear in your energy reports. Energy configuration changes include the addition of new
meters, equipment, or supporting objects (weather, power factor, and so on) to the Energy Essentials
user view. After the default reporting system refresh or the manual refresh, click the Populate button
on the Energy Folders view of the Energy Setup tab in the reporting system UI. Remember that these
points may require manual setup to prepare them for reporting as defined in Configuring Energy
Essentials Report Information.
Important: For optimal performance, we recommend that an Advanced Reporting site contain a maximum of
750,000 objects.
Figure 1: Data Flow to the Reporting System (and Energy Essentials)
Security Administration
If you are granted the Advanced Reporting option in the Security Administrator System, you are authorized to
generate reports from the entire ADX database. You also can log on to the Metasys system; however, any other
privileges defined in the Security Administrator System apply (for example, you may not be allowed to clear the Audit
history or change values to unauthorized object categories). The Advanced Reporting option is available on the
System Privileges screen of the Security Administrator System, as shown in Figure 2. The Advanced Reporting
privilege is available only if Metasys Advanced Reporting System is installed.
In addition, your Access Type must be Standard Access to use the Metasys Advanced Reporting System. Access
Type is defined in the Properties screen of the Security Administrator System, as shown in Figure 3. A user with
Basic Access cannot log on to the Metasys Advanced Reporting System.
For details on how to set up user accounts and authorization, refer to the Security Administrator System Technical
Bulletin (LIT-1201528).
Figure 2: Security Administrator System - System Privileges
Note: Verify that all attributes (for example, Log Enable, Repository Enabled, and Sample Interval) have attributes
defined (that is, none have --- markings).
Trending Requirements
Energy Essentials uses trend data as the basis for reports. Refer to the Metasys system Help (LIT-1201793) for
details on Trend extensions.
The criteria for proper trending is:
• The point must have at least one Trend extension with the following:
- The Trend extension Log Enabled attribute must be set to True.
- The Trend extension is configured to forward its content to the ADX when the buffer is full. To do this, the
Trend extension Repository Enabled attribute must be set to True.
- The Present Value attribute of the object must be trended.
- To simplify the calculation of the Energy Essentials Energy Essentials Expected Sample Interval (minutes)
value later, we recommend that you use only one Trend extension.
Note: When a meter object contains more than one Trend extension, you must calculate and enter the Expected
Sample Interval in the Energy/Utility Meter view’s Energy/Utility Meter Details box of the Energy Setup
tab for each meter based on the sample period of each Trend extension. See the remaining Trend
extension Sample Interval considerations listed in this section, then see the Expected Sample Interval
(minutes) calculation information in the Energy/Utility Meter View Content section.
• The units for the point must be defined and match units available in Energy Essentials. See Units Compatible
with Energy Essentials.
• Trend extension Sample Interval considerations are the following:
- Equipment and Schedule objects require a Change of Value (COV) trend. To capture this, set the Sample
Interval to 0. All other objects require sample based trends. For these objects, we recommend that the Sample
Interval be set to a maximum of 900 seconds (15 minutes).
- To provide the best opportunity for detecting the peak electric demand value, we recommend that the Sample
Interval be 60 seconds.
- If consumption values for meters are periodically reset, use the recommended Sample Interval of 900 seconds.
- Energy Essentials ignores any trended consumption value less than the previous value and those that are
negative.
- To simplify the calculation of the Energy Essentials Expected Sample Interval (minutes) value later, we
recommend that you do not configure trending to capture values at irregular intervals (such as more frequent
trending for points in alarm).
1 This value indicates the calculated consumption based on the demand rate.
2 This value indicates the calculated demand based on the measured consumption.
1 These typically are used in measuring steam and water consumption. Also, values from these meters cannot be converted to
energy or source energy.
Report Duration <= 1 Day 1 Hour short date time 5/16/2011 9:01 A.M.
1 Day(s) < Report Duration <= 2 Months 1 Day short date 5/16/2011
2 Months < Report Duration <= 24 Months 1 Month month/year May, 2011
24 Months < Report Duration Years year 2011
1 This particular example is for English-United States locale. The reports match the locale setting configured for the user who is
currently logged in.
The table interval rules that Energy Essentials applies to reports are described in Table 12. For example, if you
select a report for 3 months, the report shows one data point for each day and displays month/year under the primary
When column and day under the secondary When column.
(RD,
range)
RD < 1 #items * #hrs < limit 1 Hour short date 5/16/2011 short time 9:01 A.M.
Month
RD < 1 #items * #days < limit 1 Day month/year May, 2011 day 11
Month
(RD,
range)
RD < 1 #items * #days >= limit ERROR2 — — — —
Month
1 Month #items * #days < limit 1 Day month/year May, 2011 day 11
<= RD <
12
Months
1 Month #items * #days >= limit ERROR 2 — — — —
<= RD <
12
Months
12 #items * #months < limit 1 Month year 2011 month name May
Months
<= RD <
36
Months
12 #items * #years < limit 1 Year year 2011 year 2011
Months
<= RD <
36
Months
12 #items * #years >= limit ERROR 2 — — — —
Months
<= RD <
36
Months
36 #items * #years < limit 1 Year year 2011 year 2011
Months
<= RD
36 #items * #years >= limit ERROR 2 — — — —
Months
<= RD
1 This particular example is for English-United States locale. The reports match the locale setting configured for the user who is
currently logged on.
2 The report has exceeded the maximum number of records allowed.
Table 12 contains the following information:
• Report Duration: length of time applied to the report based on the Start Date and End Date selections.
• Row Limit Test: the equation Energy Essentials uses to determine if the report is within the record limit. The
number of items is determined by what you select under the Select Objects panel. The limit is the maximum
number of rows configured for the Metasys Advanced Reporting System. Consider this example:
If a report is generated that exceeds the maximum row count allowed, a message in red text appears on the bottom
of the report. Figure 8 shows an example. If this message appears, either try to increase the amount of rows supported
(at reduced performance) or limit the filters and selections to yield an amount that fits the report. For increasing the
row limit, refer to the ADS/ADX Commissioning Guide (LIT-1201645).
User Interface
The user interface of the Metasys Advanced Reporting System is divided into three sections:
• A toolbar allows you to open the Help system, access the Metasys Site Management Portal UI, and log off from
the reporting system.
• Tabs allow you to switch between the Reports tab and Energy Setup tab.
Note: The Energy Setup tab appears only when you install Energy Essentials.
• A panel area contains information related to the tab you select.
See Figure 12 and Figure 13 for examples of layout on each tab.
Tabs
The Metasys Advanced Reporting System contains the Reports tab and Energy Setup tab. The panel area of each
tab is different, depending on the selected tab.
Note: The Energy Setup tab is available only if you install Energy Essentials.
Reports Tab
The Reports tab contains the Report Selection panel for report selection. It also contains panels used to configure
the parameters of your reports. The Run button ( ) resides on the top right of the Report Selection panel area.
This button is disabled when you select a user-created folder in the Report Selection panel.
See Panel Area for details on all panels present on the Reports tab. See Figure 12 for an example of the Reports
tab layout.
See Reports Tab Content for a detailed description of tab content.
Energy Setup Tab
The Energy Setup tab contains the Energy Setup panel for use with Energy Essentials. Use this tab and its seven
selectable views to perform point mapping and additional configuration that is required before you run Energy
Essentials reports. This tab allows you to enter information that cannot be entered directly into the Metasys Site
Management Portal UI such as utility type, billing information, and so on. See Energy Setup Panel for details. See
Figure 13 for an example of the Energy Setup tab layout.
See Energy Setup Tab/Panel Content for a detailed description of tab content.
Panel Area
The panel area contains several panels, depending on the tab and report type you select.
Note: The Run button ( ) resides on the top right of the panel area when the Reports tab is selected.
You can expand and collapse items in the tree using the and buttons. Single-click an item to select it. You
can also select multiple items in a single navigation tree using the Ctrl or Shift keys. If you select nothing, the report
includes all items in the tree, subject to the report and filters you choose.
Important: For optimal performance, we recommend that an Advanced Reporting site contain a maximum of
750,000 objects.
If the report you select offers a tree of user views, this list includes all user views available in the Site Director ADX.
You can create user views exclusively for the purposes of outputting reports. If you plan to run reports against certain
points often, group those key points in a user view to customize, speed up, and make the reporting process easier.
For example, create user views for critical temperatures, space temperatures, or Air Handling Units (AHUs). In
addition, user views allow you to group a site by spaces such as buildings, floors, and other areas.
See the Selection Persistence section for details on how the Metasys Advanced Reporting System remembers
selections made in these panels.
See Select Objects Panel Content in the Screens and Tabs section for descriptions of the contents of this panel.
Select Date Range Panel
Found on the Reports tab, the Select Date Range panel allows you to select a pre-set or custom date range/time
period against which to run the report. You also can select a relative time such as yesterday, last week, last month,
this year, and many others.
See the Selection Persistence section for details on how the Metasys Advanced Reporting System remembers
selections made in these panels.
See Select Date Range Panel Content in the Screens and Tabs section for descriptions of the contents of this panel.
Example
For example, make the following selections to report on events that occurred from October 1, 2012 to November 1,
2012:
• Start Date: 10/1/2012
• Start Time: 12:00:00 A.M.
• End Date: 11/1/2012
• End Time: 11:59:59 P.M.
All times are based on the time zone of the ADX. Date and time formats are based on the locale of the logged-in
user as set in the Metasys Security Administrator Tool. If you browse into the Metasys Advanced Reporting System
running on an ADX in another time zone, be aware that the date and time are different from your location’s time
zone.
Important: Billing rates and the Simple Energy Cost reports are not intended for billing validation purposes.
Do not use billing rates or the Simple Energy Cost reports in an attempt to validate your utility bill.
This view allows you to enter billing rate information such as a name and a values/start times for the base,
consumption, and demand rates. After you define a billing rate, you can associate the rate with a meter. See
Billing Rate View Content for details on this view.
• Energy/Utility Meter: This view contains the meters used to measure energy and utility consumption/generation.
Meter information available in this view includes physical location information, outdoor air associations, and area
served settings. The meters that appear in this view must all reside in the folder or subfolder you map to the
Energy/Utility Meters category in the Energy Folders view. See Energy/Utility Meter View Content for details on
this view.
• Equipment: This view contains the equipment used for Equipment Runtime report. Equipment information
available in this view includes physical location information and occupancy associations. The equipment that
appears in this view must all reside in the folder or subfolder you map to the Equipment category in the Energy
Folders view.
For equipment that has more than On and Off as possible occupancy states, any state that is not Off is considered
On.
• By Site: Create folders that contain reports by site, and are then organized by timeframe.
Figure 15: Report Folder Strategy Example - By Site
• By User: Create folders for each user. The users can then organize the contents of their folders as they wish.
This method may be particularly helpful when multiple users use the reporting system.
Figure 16: Report Folder Strategy Example - By User
Report Screen
When you run a report, the Report screen opens in a separate Web browser window to display the report results.
Figure 17 shows the different parts of a typical Report screen. Energy Essentials reports have a unified and unique
layout. See Figure 18 for an overview of an Energy Essentials report.
Note: For each report you run, a new Web browser window opens. You must manually close these browser windows
per report.
For an overview of each report, see Report Types.
For detailed information on the Report screen content for each type of report, see Report Screen Content.
Report Toolbar
The report toolbar appears at the top of the Report screen and allows you to navigate the report pages, print,
export/save, and so on. Table 16 describes the toolbar options.
Current Page/Go to Page Indicates the current page being displayed and allows you
to enter a specific page of the report to which you want to
jump.
Next Page Goes to the next page of the report.
Go Back to the Parent Goes back to the parent report when viewing a subreport.
Report
Zoom Level Allows you to select or type a zoom level for viewing the
report.
Find/Search Allows you to search for a text string in the report. Click
Find to locate the first item, and click Next to find the next
occurrence of the item.
Export/Save Report Allows you to export/save the report by selecting the desired
format from the drop-down menu. The Export Options
section describes the supported formats.
Refresh Refreshes the data in the report by running the report again
in the same window using the selected configuration
parameters.
Print Prints the report on a printer installed on the client computer.
See the Printing a Report section for details.
Report Types
The Metasys Advanced Reporting System contains two main categories of reports that are divided into subcategories.
If you install Energy Essentials, a third category of energy reports becomes available. For information on each
category and its reports, see the following sections.
See the Example Report Sequence Scenarios section for workflow examples and guidelines on running reports.
Configuration Setup Review Reports
Use Configuration Setup Review reports to verify the setup of the Metasys system, including alarm and trend
configurations. This data originates from the SCT database.
Each row in the report table indicates the offline totals by breaking down the data in the following order: supervisory
device, trunk/integration, month, week, and day. This hierarchy allows you to drill down to investigate potential
problems on your site.
In Figure 19, for example, devices on the N2-1 trunk of the 507NAE4502-B1F5 supervisory device were offline. Ten
devices out of a total of sixty-four devices on the trunk were offline during the selected time period. The system
reported 10 online-to-offline transitions. The devices on the trunk were offline for a total of 4 days, 4 hours, 54
minutes, and 5 seconds. The devices were offline 0.11% of the time.
In this particular time period, the devices were offline only in February 2005. Three devices were offline in Week 2,
and seven devices were offline in Week 4, which equals the total of 10 devices offline.
Meter Reading Meter Reading Normalization Multiplier Total kBtu Reported on Big
kWh to kBtu Conversion Picture Energy Report
2082 kWh * 3.41214163 * 3.34 = 23,727.623
Any meter that is configured with a unit that is not valid for the utility type is excluded in any source energy aggregation.
This exclusion includes all meters configured with the default utility type of Other. Also, since water consumption
cannot be converted to energy, these meters are excluded in any aggregation or pie chart using source energy.
Minimal requirements for running a Big Picture Energy report: you must have a meter defined in the Energy/Utility
folder and the meter must be trended properly.
See the Printing a Report section.
See Big Picture Energy Report Content for details on the contents of this report.
Load Profile Reports
The Load Profile report allows you to examine your energy demand from day to day (not date to date). This Energy
Essentials report, the only one available in landscape orientation, provides demand profiles in a calendar view. The
overview chart for this report allows you to see the average load profile over a week’s time.
If you compare with the previous year, the report compares the demand from the previous year on a day to day
basis. For example, the values on a Wednesday would be compared to the closest Wednesday the year prior.
The Load Profile report includes only electric consumption meters that are configured with a demand interval.
See the Printing a Report section.
See Load Profile Report Content for details on the contents of this report.
Simple Energy Cost Reports
The Simple Energy Cost report is a high-level look at your energy costs by utility type and meter. This report is useful
for an overall picture of your energy costs that highlights unusual trends in cost. If the Simple Energy Cost report
indicates problem areas or contains unusual data, you may find it useful to run the Consumption report (or another
relevant report) to diagnose any potential issues.
Important: Do not use this report to validate your utility bill. This report is not intended for use in a billing validation
application.
See the Printing a Report section.
See Simple Energy Cost Report Content for details on the contents of this report.
Consumption Reports
The Consumption report is similar to the Big Picture Energy Overview report with two notable exceptions. First, the
units reported on the Consumption report may be normalized. When the report contains multiple utility types, data
is normalized to Source energy; when it contains a single utility type that uses multiple units, data is normalized to
the default units for the utility type; and when it contains utility types that have the same units, data is not normalized
but shown in common units.
Second, information presented later in the report is more detailed and allows you to see consumption for each energy
type by each type’s respective units.
See the Printing a Report section.
See Consumption Report Content for details on the contents of this report.
Equipment Runtime Reports
The Equipment Runtime report shows the total equipment runtime information for your site, including total runtime
hours, occupied/unoccupied runtime hours, and number of equipment starts.
See the Printing a Report section.
Export Options
You can export (save) a generated report to a file in the formats listed in Table 18. The export feature is available
via the Report toolbar in the browser window where report results appear.
Table 18: Export Format Options
Format Extension Description
TIFF file .tif Saves the report as a TIFF image file.
Acrobat (PDF) file .pdf Saves the report as an Adobe Acrobat® PDF file.
Excel .xls Saves the report as a Microsoft Excel spreadsheet. This option formats the data
using Excel advanced grouping functionality.
Selection Persistence
The Metasys Advanced Reporting System remembers the choices made in the panels for each report during the
current session. When you return to an item in the UI, such as a user view or the panels of a report, the previous
selections appear. The system maintains the preferences separately for each report type (for example, if you have
an item filter for an event report and another one for a controller offline report). Previous selections are saved for
both standard and predefined reports.
If you expand a node in the Select Objects panel without selecting any child nodes, the node appears collapsed the
next time you open that particular report; however, if you select a child node, the system remembers the expansion.
Timeout Period
If you keep the Metasys Advanced Reporting System open but do not interact with it for the defined period of time,
a timeout occurs. The default timeout period is 20 minutes and is configurable only by the Metasys Advanced
Reporting System ADX administrator using information in the ADS/ADX Commissioning Guide (LIT-1201645). When
a timeout occurs, you are logged off from the system and a timeout message appears. You must log back on to the
system to create and view reports.
Note: The system does not close any open report windows. When you try to use a report, the Login screen appears.
After logging on to the reporting system, you can run the report again, if necessary.
Error Handling
The Metasys Advanced Reporting System provides feedback when an error occurs, including possible solutions
when applicable. For example, Not authorized to view reports appears on the Login screen when a user without
proper authorization attempts to log on to the system.
Detailed Procedures
Logging on to the Metasys Advanced Reporting System
Note: We strongly advise that you do not browse to the Metasys Site Management Portal UI from a computer
running a server-class operating system. By default, Windows Internet Explorer Enhanced Security
Configuration is enabled on server-class operating systems, and may block the Launcher download page
from which you install the Launcher application for access to the Site Management Portal. Open the Site
Management Portal UI from a computer that is not running a server-class OS.
1. Before you log on to the Metasys Advanced Reporting System for the first time, log on to the Metasys system
ADX and accept the license agreement. If you attempt to log on to the reporting system before performing this
action, the login fails with a message prompting you to log on to the ADX and accept the license agreement.
3. On the Identifier screen, name the user view. We recommend naming the view Energy Essentials (Figure 20).
4. Click Last, then click Finish to save the empty Energy Essentials user view.
5. Drag the Energy Essentials user view into an open panel. The user view opens for editing.
6. Add four folders to the user view (Figure 20). We recommend naming the folders Energy / Utility Meters,
Equipment, Other Data, and Weather Data. These four folders represent the four types of system points used
by Energy Essentials.
Refer to the Metasys system Help (LIT-1201793) for details on using user views.
7. Add energy-related points from your site to the appropriate folder. See Energy Essentials Setup Considerations
for more information on which points to include with each folder. Be sure to use Global Search to quickly populate
each user view.
Note: We strongly recommend limiting the content of the user view and folders to items necessary for Energy
Essentials. Including other items may make Energy Essentials configuration in the Energy Setup tab
confusing.
Note: If desired, you can add some points now and others later. But, you must add required points to the
appropriate folders in the user view and wait for the default reporting system refresh at 3:15 A.M. or
force a manual refresh. (See Refreshing the Metasys Advanced Reporting System Data Manually.) You
then must click the Populate button before you run Energy Essentials reports.
Note: Since we recommend using Tailored Summaries to quickly set up point trending, limit the points to 100
per folder. You may use subfolders within the folders.
8. Add the Configuration – Trends Summary Definition object to each folder to help identify and modify trended
points for Energy Essentials. You can use it later to verify that all points meet the trend extension requirement.
Note: The Configuration - Trends Summary Definition object is pre-built for you and is available on the Johnson
Controls® Branch Purchase Package (BPP). Refer to the Metasys system Help (LIT-1201793) for details.
9. Save the user view.
Note: If you decide to add/delete points at a later date, display the user view and click Edit. Be sure to upload
changes to SCT, perform a manual Metasys Advanced Reporting System refresh, and click the Populate
button in Energy Essentials after you make changes to the Energy Essentials user view. Remember
that these points may require manual setup to prepare them for reporting as defined in Configuring
Energy Essentials Report Information.
10. Use Tailored Summaries to help configure trends. Each object in an Energy Essentials report must have its
Present Value attribute trended.
11. Using SCT, upload the ADX to the SCT archive database.
The Metasys Advanced Reporting System and Energy Essentials use the SCT as a source for reports, so these
changes must reside in SCT. See ADX and SCT Interaction.
1. On the Reports tab, in the Report Selection panel, select a standard report ( ) or folder that you created ( ).
See Creating Folders.
2. Click New Report. The new predefined report appears in the Report Selection panel tree with the default name.
The Predefined Report Properties panel appears. The new predefined report defaults to the configuration of the
standard report.
3. Click the Save button. The new predefined report is prefixed with the same name as the standard report and
assigned a unique sequence number as a suffix (for example, Electric Energy 1).
4. In the Predefined Report Properties panel, enter a name of the report (required). No restrictions exist for characters
used in the name.
5. If desired, add a description and select an alternative destination. No restrictions exist for characters used in the
description.
6. Configure the report using the other panels and the Reports Tab Content section.
7. Click the Save As button. A new predefined report appears in the Report Selection panel.
Note: If you click another item in the UI, your changes save (autosave) even if you do not click the Save button.
Note: See Table 21 for more information on the Save and Save As buttons.
To create predefined reports based on an existing predefined report:
1. On the Reports tab, in the Report Selection panel, select a predefined report ( ).
2. Make changes as desired to the name, destination, and configuration settings. For information on selections for
each report type, see Reports Tab Content section.
3. Click the Save As button. A new predefined report appears in the Report Selection panel.
Note: See Table 21 Save for more information on the Save and Save As buttons.
Creating Folders
You can create folders for organizing predefined reports. See Creating Predefined Reports and Report Selection
Folder Organization Strategy.
To create folders:
Note: You also can create new folders under folders that you created ( ).
2. Click New Folder. The new folder appears in the Report Selection panel tree with the default name. The Folder
Properties panel appears.
3. In the Folder Properties panel, change the name of the report and add a description.
4. Click the Save button. The folder name updates in the view.
Note: If you click another item in the UI, your changes save even if you do not click the Save button.
Note: See Table 21 for more information on the Save and Save As buttons.
Note: If you delete a folder, the system also deletes all content inside that folder, including any subfolders and
predefined reports.
Running a Report
Note: Before running an Energy Essentials report for the first time, you must perform the tasks found in the Setting
up Energy Essentials section.
Note: Be sure to turn off the pop-up blocker in your Web browser software before running a report.
To run a report:
1. On the Reports tab, select a report from the Report Selection panel tree. To create a new report, see Creating
Predefined Reports.
See User Interface and Report Types for information on the tab, panel, and report types. Depending on the
report type you select, various panels appear that allow you to configure the report. See Table 22 for details.
Note: If your screen does not properly refresh to show filtering options in the Other Filters Panel, make sure
you are using http, not https, in the URL. Https only works if your system is properly configured per the
Network and IT Guidance for the BAS Professional Technical Bulletin (LIT-12011279).
2. From the Select Objects Panel, select All Items or User Views from the drop-down list box, if available.
Important: For optimal performance, we recommend that an Advanced Reporting site contain a maximum of
750,000 objects.
Note: The Select Objects panel of Trend reports does not show the All Items tree. Use the available user views
to run reports based on groups of related trend items. An item may have more than one trend point. When
running a Trend Details report, limit the number of trend points to a maximum of 10 points.
Note: Energy Essentials Reports use a different selection for the Select Object panel. Depending on the report
you select, a Meters or Equipment tree appears and presents information in folders organized by meter
or equipment type.
3. Click an item in the tree or select multiple items in the tree using the Ctrl or Shift keys.
Note: When you select a node in the All Items tree, all children and their children are considered selected.
Note: See Selection Persistence for details on how the system remembers report selections during the current
session.
4. From the Select Date Range Panel, select a period, start date and time, and end date and time.
5. From the Other Filters Panel or Energy Filters Panel, configure the filtering options, if desired.
6. On the right side of the Reports tab, click the Run button ( ). The Report Screen opens in a separate Web
browser window or tab, the report generates, and the results appear.
Viewing a Report
To view a report:
1. Run a report. See Running a Report.
2. When the report results appear in the Report Screen, you can view the contents of the report to identify problem
areas or to check your system for consistency (for example, naming and descriptions).
You also can perform the following actions in the Report screen:
• Navigate through the report pages using the toolbar. See Report Toolbar section.
• Adjust the zoom level of the report using the toolbar.
• Refresh the report data using the toolbar.
• Print the report using the toolbar.
• Search for items in the report. See Searching for Data in a Report.
• Export the report to a supported format (.tiff, .pdf, or .xls) to save the report and perform other actions in that
program. See Exporting/Saving a Report.
• View the chart, when applicable.
• Expand ( ) and collapse ( ) items in the table to show/hide details.
The level to which you expand is the level that is displayed in exported files.
• Sort the data in the table columns using the ascending/descending sort arrows, .
You cannot sort the data in the Trend reports. These reports are organized alphabetically by Point Full Reference
and chronologically by time. You cannot sort columns in Energy Essentials reports.
• Cancel a pending report. See Canceling a Report.
• Exit the report. See Exiting a Report.
For information on the contents of each report type, see the following Screens and Tabs sections:
• Alarm Definition Report Content
• Trend Log Definition Report Content
• Event Summary Report Content
• Event Details Report Content
• Controller Offline Summary Report Content
• Controller Offline Details Report Content
• Event and Audit Details Report Content
• Trend Log Definition Report Content
• Big Picture Energy Report Content
• Load Profile Report Content
• Simple Energy Cost Report Content
Canceling a Report
To cancel a report, close the Report screen Web browser window.
See the Exiting a Report section.
Exporting/Saving a Report
1. On the Report screen, click the export/save icon to show the drop-down menu options. See Report Toolbar and
Export Options for more information.
Note: Expand the report content so that all content you wish to export is visible.
2. Select a format from the drop-down menu. The File Download dialog box appears, asking whether you want to
open or save the file.
3. Perform one of the following actions:
• Click Open to open the report in a program that supports the specified format. Work with the file as desired,
and use that program to save the file.
• Click Save to save the file. The Save As dialog box appears. Indicate the location, name, and type of report.
Click Save. The Download Complete dialog box appears. Select to open the file, open the folder, or close
the dialog box.
Printing a Report
You can print a report to any printer installed on the client computer.
1. Click located in the upper-right corner of the Report screen. The Print dialog box appears. See Report Toolbar
for details.
2. Select the desired printer and any other printing options.
Note: Each report has a default page size setting for printing the contents of the report in the best possible
format. You can change this setting to another size, if desired.
3. Click OK.
Note: If the print function does not work correctly on your system, see Metasys Advanced Reporting System
Troubleshooting for details.
Change the Name Replaces the report/folder with newly Creates a new additional report with the new name.
named one.
3 Moves the report/folder to the new Creates a new additional report with the same name
Enter a New Destination
location. in the new location.
Note: You now have two reports with the same
4
name in two locations.
Change Both the Name and Replaces the report/folder with the Creates a new additional report with the new name
3 newly named one and moves it to the in the new location.
Destination
new location.
Change Configuration Settings Updates the report/folder with the Initiates an error message that appears at the top of
Other than Name or Destination change you made. the tab. You must do one of the following:
• Change the name or change the location and
click Save As.
• Click Save.
1 If you create a new report/folder and click another item in the UI, the new report/folder saves (autosaves) even if you do not
click the Save or Save As button.
2 The Save As button does not appear when you are working with user-created folders.
3 You must save the report/folder to a location under the report type or in a folder that resides under the report type.
4 Two or more reports/folders with the same name can exist if they are in different locations.
Event Details 1
Yes Yes
2 Yes Yes Yes No
Controller Offline 1
Yes Yes
2 Yes Yes Yes No
Summary
Controller Offline Yes
1
Yes
2 Yes Yes Yes No
Details
Event and Audit Yes
1
Yes
2 Yes Yes Yes No
Details
Trend Summary Yes
1
Yes
2 Yes Yes Yes No
1 Appears only when you click the New Report button or work with a predefined report.
2 Appears only when you click the New Folder button or work with a user-created folder.
3 Available only after you install Energy Essentials.
(Standard Report) This icon identifies a default report provided by the reporting system.
(User-Created Folder) This icon identifies a folder created by a user. See Creating Folders.
(Predefined Report) This icon identifies a predefined report created by a user. See Creating Predefined
Reports.
(Calendar Opens the Select Date calendar control to choose the start date or end date. Use the previous and next
arrows to navigate to the desired month and year. Clicking a day link closes the calendar and populates
Control)
the Start Date/End Date field with the selected date in short format.
Billing Periods Appears only in the Simple Energy Cost, Consumption, Electrical Energy, and Production reports. This
drop-down list box allows you to select from the following:
• Not Included: This selection does not allow the associated billing period to affect the report content.
• Aggregate on Billing Period End Date: This selection shows any usage or cost within the requested
report period on the last day of the billing period associated with each item in the report. Data for billing
periods that end within the selected report interval also is included.
• Distribute Aggregation Over Billing Period: This selection may extend the start of the report period to
include the start of any billing period that is associated with the chosen items. It may also shorten the
end of the report period to show only complete billing periods that end within the requested report
period.
1 Week Numbering: The first week of a month is the week that starts on the first day of the month, and ends on the last day of
the same week. The last week of the month is the week that starts on the first week day immediately before the end of the
month, and ends on the last day of the month. This provides consistency across weeks and months; however, weeks are not
always 7 days.
For example, the following figure illustrates that the month of July 2011 has 6 weeks. The first day of the month falls on a Friday
and is the first week of the month. The next 4 weeks (weeks 2, 3, 4, and 5) are full weeks running from Sunday through Saturday.
The 31st is the last day of the month and falls on a Sunday, which is the last week of the month. As a result, a report including
this month has 6 weeks of data.
2 Daylight Saving Time (DST): Reports consider the day and time shifts due to the change in the Daylight Saving Time policy.
During the transitions between Standard Time and Daylight Saving Time, the intervals (hours in a day) vary. The date and time
of records that span transitions are displayed according to the Daylight Saving Time policy at the time of the report execution.
The data is stored on the ADX in Universal Time Coordinated (UTC) format, which is locale independent. The Metasys Advanced
Reporting System relies on the Operating System (OS) to convert the time to the local time. Reports generated at different
times may have date/time discrepancies because newer Microsoft Windows OSs do not preserve past years' algorithms and
apply the same, current algorithm to old dates and times.
3 The first day of the week is determined by the ADX locale. For example, the first day of the week can be Sunday, Monday, or
any other specified day. The same method applies to the last day of the week.
4 Quarters are January-March, April-June, July-September, and October-December.
Important: Do not use this report to validate your utility bill. This report is not intended for use in a billing validation
application.
You can sort each column by clicking the name of the column. When a column is sorted, a triangle appears next to
the column name.
Note that in this example the trends have overlapping samples (non-overlapping samples are
indicated by blue circles). Energy Essentials reports calculate the expected sample interval, as
shown in Figure 21.
This value allows Energy Essentials reports to calculate if any data is missing when using the
Sample Data filter.
In the Energy/Utility Meters Details box, you can enter a new value for the interval.
See Trending Requirements for details on trending recommendations.
Meter Type Indicates whether a meter measures the production or consumption of an energy or utility.
In the Energy/Utility Meters Details box, the choices in the drop-down selection list are Consumption
(energy used) or Production (energy produced). The default value is Consumption. When you
change this value to production, the Consumption Meter field is enabled for use.
For example, if you have a natural gas fed generator producing electricity, the meter on the natural
gas side is consumption whereas the meter on the electric side is be production.
Consumption Meter Indicates the meter associated with energy production.
This field is available only when you set Meter Type to production. Although a consumption meter
is not required to run a Production report, the association to a consumption meter allows the report
to calculate efficiency.
For example, if you have a natural gas fed generator that is producing electricity, a meter on the
natural gas side (MTR-1) would be consumption whereas the meter on the electric side (MTR-2)
would be production. MTR-1 would be entered in the Consumption Meter field.
In the Energy/Utility Meters Details box, you can select the appropriate meter from the drop-down
selection list. The list of meters originates from the Energy/Utility Meter view.
Expand/Collapse Expands (shows) or collapses (hides) only that node level. These icons appear next to
items in the table to show/hide the details.
Supervisory Device Name Indicates the name of the supervisory device to which the trunk belongs:
• For items selected from the All Items tree, the name comes from the Name attribute.
• For items selected from the User View tree, the name is the user-defined label
designating the item in the user view.
Full Indicates the fully qualified reference of the device.
Reference
Trunk or Integration Indicates the name of the trunk or integration.
Field Device Name Indicates the name of the offline field device:
• For items selected from the All Items tree, the name comes from the Name attribute.
• For items selected from the User View tree, the name is the user-defined label
designating the item in the user view.
Full Indicates the fully qualified reference of the field device.
Reference
Description Provides a description of the controller according to the Description attribute.
Day Indicates the day when the controllers on the trunk were offline.
where
ΔH = activation energy (83.14472kJ/mol for solids and liquids,
resulting in a ΔH/R constant of 10,000)
R = universal gas constant (8.314472 J/mol-K)
T1...n= highest and lowest temperatures recorded during each time
period (Method C). The MKT is generally calculated for a whole
year, in which case one time period is a week. Because the Trend
Summary report allows you to specify smaller intervals, the time
period used in this equation is adjusted as necessary. (For example,
if the report range is greater than a year, the MKT time period is a
week. If the range is between a month and a year, the time period
is a day. Finally, if the range is less than a month, the time interval
is an hour.)
n = number of samples (For example, the value is 104 for a year
because the number of time periods [weeks] is multiplied by 2 [one
for minimum and another for maximum], 60 to 730 for a month to a
year [average numbers], and 2 to 1,440 for up to a month.)
Note: Due to the method used to define a week, there are 4 to 6
weeks in each month. As a result, the sample range for a
report with a one-year duration is 104 (52 x 2) to 144 (12 x
2 x 6). For information on week numbering, see Select Date
Range Panel Content in the Screens and Tabs section.
ln is the natural logarithm.
e is the natural log base (2.718281...).
1 In the Equipment Runtime report, the Total Sample Count is the total number of pieces of equipment and their associated
occupancy samples. The % Unreliable is the percentage of the Total Sample Count that is unreliable for each piece of equipment.
For example, assume you have 2 pieces of equipment, each with 2 samples. Each piece of equipment is associated to the
same occupancy point that has 2 trend samples. The Total Sample Count is 8 (2 pieces of equipment + 4 samples + 2 occupancy
Important: This report is not intended for billing validation. Do not use this report for that application.
For information on the header content of this report, see Energy Essentials Report Header Content.
Table 52: Simple Energy Cost Report
Field
Header
See Energy Essentials Report Header Content.
Cost by Energy Type ($) (Chart)
Shows the total cost by utility type in a pie chart. The default cost units are dollars and are defined during Energy Essentials
setup.
Simple Energy Cost (Table)
Shows cost information for fixed monthly cost, consumption, and demand by location and meter in a table.
Rate (s) (Table)
Shows the individual values for each billing rate included and indicates time frames where rates may have changed. For details,
see Table 53.
Cost by Energy Type (Chart)
Shows energy cost by energy type in a bar graph.
Table 53 further explains the Rate(s) field in the Simple Energy Cost Report.
Table 53: List of Rates Example
Rate Date Base Consumption Demand
Identifier Rate ($) Rate ($) Units Rate ($) Units
Electric Rate 11/01/2008 1.00 1.50000 $/kWh 1.50000 $/kW
Gas Rate 11/01/2008 55.42 .0436 $/Btu 5.02 $/Btu
Electric Rate 04/12/2009 1.15 1.50000 $/kWh 1.55000 $/kW
Electric Rate 11/01/2009 1.20 1.50000 $/kWh 1.55000 $/kW
Electric Rate 11/25/2009 1.20 1.60000 $/kWh 1.65000 $/kW
• Rate Identifier: Name of the billing rate as defined in the Energy Setup Billing Rate View.
• Date: The date on which a set of rates starts within the report. This date is later in time than the configured
effective start date of the rate whenever the report’s start date is after the rate went into effect.
• Base Rate: The fixed base charge per billing period. This charge is applied even if there is zero usage during
the report duration.
• Consumption Rate: The consumption rate that starts on Date. If this value is the last row in the table, these
rates continue through the end of the report duration.
• Demand Rate: The demand rate that starts on Date. If this value is the last row in the table, these rates continue
through the end of the report duration.
• Demand Units/Consumption Units: The units associated with the corresponding rate. Units do not have start-on
dates; therefore, changing the rate at any time in the energy configuration screen applies to the whole rate
table/report.
When the Rate Table is prepared for each report, multiple scenarios may affect the Date:
• The earliest date in the Rate Table is the start date of the Report. If you include previous year data, the start
date is equal to the previous year’s start date. For example, the report has a report duration of 11/01/2010 to
12/01/2010. The earliest date in the Date column is 11/01/2009. If you included the previous year, the earliest
date is 11/01/2009.
• When including the previous year’s data, you receive all rate changes that occurred between the previous year’s
Start Date and the report’s End Date. In the previous example, any rate change in the range of 11/01/2009 to
12/01/2010 appears in the Rate Table.
• The Starting On date for rate changes in the Energy Setup Billing Rate View is used only when a rate change
occurs between the Start Date and End Date of the report. When the reporting period is before or after Energy
Setup Billing Rate View changed dates, the report shows and uses the first or last rate change, respectively. In
other words, the rate is pulled forward to start on the Start Date or extend the last rate change through the report
end date.
• It does not matter if Base, Consumption, Demand, or any combination of the three rates change; the rate table
displays all three values in every row.
Note: If there are missing data (gaps) for any given day, the Consumption report displays the gaps as a blank or
zero value for that time period.
Equipment Runtime Report Content
See Equipment Runtime Reports in the Concepts section for more details. This report does not allow you to add
meter data.
For information on the header content of this report, see Energy Essentials Report Header Content.
Table 55: Equipment Runtime Report
Field
Header
See Energy Essentials Report Header Content.
Equipment Runtime (Chart)
Shows the total runtime for each equipment type in a bar graph.
Equipment Runtime (Table)
Shows runtime by equipment type, location, equipment name, and date. The table also contains the number of unoccupied and
occupied runtime hours when a schedule is associated with the equipment and the total number equipment starts.
[Equipment Type] (Chart)
Shows the occupied and unoccupied runtime for each piece of equipment in a bar graph. If no Occupancy Schedules are
associated, this chart is blank.
[Equipment Type] (Table)
Shows the total runtime for the equipment over time.
Troubleshooting
Metasys Advanced Reporting System Troubleshooting
Also see Energy Essentials Troubleshooting and Energy Essentials Advanced Configuration Questions.
Wait for the default reporting system refresh (3:15 A.M.) or perform
a manual refresh.
In the reporting system UI, on the Energy Setup tab Energy Folders Mapping Energy Essentials Points
view, map folders in the Energy Essentials view.
Click the Populate button.
Building Efficiency
507 E. Michigan Street, Milwaukee, WI 53202
Metasys® and Johnson Controls® are registered trademarks of Johnson Controls, Inc.
All other marks herein are the marks of their respective owners. © 2013 Johnson Controls, Inc.