Metasys Advanced Reporting System and Energy Essentials Help

Transcription

1 Metasys Advanced Reporting System and Energy Essentials Help Code No. LIT Software Release 9.0 Issued August 2017 Refer to the QuickLIT website for the most up-to-date version of this document. Metasys Advanced Reporting System Overview...3 Summary of Changes...3 Concepts...3 ADX/ODS and SCT Interaction...3 Microsoft SQL Server Reporting Services...5 Security Administration...5 Advanced Reporting System Access...6 Advanced Reporting System Log in Details...7 Energy Essentials Overview...7 Energy Essentials Workflow...7 Energy Essentials Setup Considerations...9 User Interface...21 Web Browser Tools...23 Toolbar...23 Tabs...24 Panel Area...24 Standard and Predefined Reports...28 Report Selection Folder Organization Strategy...28 Report Screen...29 Report Toolbar...31 Report Types...32 Configuration Setup Review Reports...33 System Behavior Reports...33 Energy Essentials Reports...37 Export Options...39 Selection Persistence...40 Timeout Period...40 Error Handling...40 Example Report Sequence Scenarios...40 Energy Data Rollups...41 Detailed Procedures...42 Logging in to the Metasys Advanced Reporting System...42 Setting up Energy Essentials...43 Creating an Energy Essentials User View...43 Mapping Energy Essentials Points...44 Configuring Energy Essentials Report Information...44 Creating Predefined Reports...46 Creating Folders...46 Deleting User-Created Folders and Predefined Reports...47 Running a Report...47 Viewing a Report...48 Canceling a Report...48 Searching for Data in a Report...49 Exporting/Saving a Report

2 Printing a Report...49 Exiting a Report...49 Logging out of the Metasys Advanced Reporting System...50 Refreshing the Metasys Advanced Reporting System Data Manually...50 Screens and Tabs...50 Login Screen...50 Reports Tab Content...50 Report Selection Panel Content...53 Predefined Report Properties Panel Content...53 Folder Properties Panel Content...54 Select Objects Panel Content...54 Select Date Range Panel Content...54 Other Filters Panel Content...56 Energy Filters Panel Content...58 Energy Setup Tab/Panel Content...59 Energy Folders View Content...60 Billing Period View Content...61 Billing Rate View Content...62 Energy/Utility Meter View Content...64 Equipment View Content...69 Weather Data View Content...70 Other Data View Content...71 Report Screen Content...72 Configuration Setup Review Report Content...72 System Behavior Report Content...77 Energy Essentials Report Content...89 Troubleshooting...97 Metasys Advanced Reporting System Troubleshooting...97 Energy Essentials Troubleshooting Energy Essentials Advanced Configuration Questions Quick Reference - Energy Essentials Related Documentation Index Help 2

3 Metasys Advanced Reporting System Overview Welcome to the Metasys Advanced Reporting System and Energy Essentials Help. The Metasys Advanced Reporting System provides historical and configuration data reporting capabilities to the Metasys system. This system allows facility managers, Building Automation System (BAS) operators, building maintenance staff, and others to run reports to review the configuration and performance of their Metasys system. The Metasys Advanced Reporting System allows authorized users to generate and view reports. Standard Access users are authorized using the Advanced Reporting option in the Security Administrator System. See the Security Administration section for details. The Metasys Advanced Reporting SystemUser Interface allows you to easily run reports and immediately view them in a web browser. The Metasys Advanced Reporting System provides two main categories of reports: Configuration Setup Review and System Behavior. If you install Energy Essentials, a third category of energy reports is available. For information on the two main report categories, see the Configuration Setup Review Reports and System Behavior Reports sections. For information on Energy Essentials reports, see Energy Essentials Reports. You can export a report and save it in a variety of formats, such as Microsoft Excel or Adobe PDF. You can use Windows Explorer or File Explorer and other tools to browse to and open a saved report. See the Report Toolbar section for details on this feature and other report functionality. Summary of Changes The following information is new or revised: Updated document throughout for support of Windows Server Removed SQL Server 2008 R2 because the Metasys system software no longer supports this platform. Metasys Advanced Reporting supports installation on a computer with SQL Server 2016 computer. However, Energy Essentials reports does not support installation on a computer with SQL Server Updated Related Documentation table to indicate correct reference to the Metasys Server software installation instructions. Concepts ADX/ODS and SCT Interaction The Metasys Advanced Reporting System runs on either a unified or split Extended Application and Data Server (ADX) or an Open Data Server (ODS). For the split ADX, install the Metasys Advanced Reporting System on the web/application server computer. The ODS does not support split applications. You can install only one instance of the reporting system on an ADX or ODS. The Site Director can be the ADX or ODS in which the Metasys Advanced Reporting System is installed; however, the Site Director can be a different ADX or ODS instead. The reporting system determines user privileges from the Site Director ADX or ODS. Note: The Metasys Advanced Reporting System does not run on the Application and Data Server (ADS) or ADS-Lite. The SCT computer must have supported version of SQL Server software installed. We highly recommend that you use the same versions of SQL Server software on the SCT computer and ADX or ODS computer, but you can use different editions (for example, SQL Server 2014 Express on the SCT and SQL Server 2014 Standard on the ADX or ODS). The reporting system retrieves historical information from the ADX or ODS historical database and gathers configuration information from the System Configuration Tool (SCT) archive database (see Figure 1). The ADX or ODS JCIHistorianDB database provides trend data values for Trend Summary, Trend Details, and Energy Essentials reports. The JCIEvents database provides information for the Event Summary, Event Details, Controller Offline Summary, and Controller Offline Details reports. The JCIEvents and JCIAuditTrails databases provide information for the Event and Audit Details report. If you remove these databases or purge the content from these databases, you remove all data or portions of data included in reporting system reports. 3

4 The SCT database provides the All Items and User View trees for the reporting system as well as the data for the Alarm and Trend configuration reports. The installation process allows you to specify the ADX or ODS historical database and SCT archive database that are used by the reporting system. For information on the ADX and SCT installation process, refer to the Metasys Server Installation and Upgrade Instructions Wizard (LIT ) and SCT Installation and Upgrade Instructions (LIT ). For information on the ODS installation process, refer to the ODS Installation and Upgrade Instructions Wizard (LIT ). The Metasys Advanced Reporting System is not connected directly to supervisory devices to gather historical data. Although the Metasys Advanced Reporting System does not prevent additional ADXs or ODSs from running on the same site, the reports do not integrate information from multiple machines. Reports do not include events forwarded from another site. The computer with the SCT database must be online and accessible to the ADX or ODS where you installed the reporting system because the reporting system relies on the SCT database. The reporting system supports only one SCT archive database and the database must contain only one site. Data could be mismatched between the two databases, because configuration data is not read from the online system. To avoid this possibility, make sure that the SCT database and the online database are synchronized. For example, every time you add a device or point online, upload the online database to the SCT. Do not run the Metasys Advanced Reporting System during the SCT download, upload, or synchronization operation. For more information on loading databases, refer to the Metasys SCT Help (LIT ). 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 or ODS 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 Populate on the Energy Folders view of the Energy Setup tab in the reporting system user interface. Remember that these points may require manual setup to prepare them for reporting as defined in Configuring Energy Essentials Report Information. Additionally, when you discover third-party BACnet devices or objects whose states text does not match an existing Johnson Controls standard set, resulting in the creation of a new user-defined enumeration set, the Metasys Advanced Reporting System user interface does not synchronize with new data until a data refresh occurs (system or administrator). 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) 4

5 Microsoft SQL Server Reporting Services The Metasys Advanced Reporting System uses SQL Server Reporting Services, depending on your version of SQL Server, to create and view reports. For information on Reporting Services and how to configure it to work with the reporting system, refer to the SQL Server Software Installation and Upgrade Instructions (LIT ). 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 or ODS database. You also can log in 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 in 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 ). Figure 2: Security Administrator System - System Privileges 5

6 Figure 3: Security Administrator System - Properties Advanced Reporting System Access You can access the Metasys Advanced Reporting System from the Tools > Advanced Reporting menu option in the Metasys SMP UI. You also can enter the URL of the reporting system ( in a web browser to reach the Login Screen. The reporting system supports the Windows Internet Explorer web browser. Note: If you cannot access the Reporting system using the URL described here, see the entry in the Metasys Advanced Reporting System Troubleshooting section. Use the Launcher application instead of a web browser to reach the login screen for the Site Management Portal UI. If the Launcher is not already installed on your machine, you are prompted to install it after you attempt to log in using the web browser. Refer to the Launcher Installation Instructions (LIT ). The Launcher is installed on each client computer and lets you access any Metasys server or supervisory engine on the building network, regardless of its software version. For details, refer to the Launcher Help (LIT ). 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 operating system (OS). 6

7 Advanced Reporting System Log in Details When you access the Metasys Advanced Reporting System, the Login screen appears. See the Login Screen section. There is no separate user name and password for the reporting system. The Login screen accepts your Metasys system user name and password. After clicking Login, the system authenticates your user name and password, and checks if you have proper Security Administration. Note: Microsoft Active Directory service is not available with Metasys Advanced Reporting System. If you have authorization to access the reporting system, the Report Selection screen appears. This screen is described in the User Interface section. A message indicating Invalid name or password entered appears if you do not have authorization to access the Metasys Advanced Reporting System. See Security Administration. See Logging in to the Metasys Advanced Reporting System. Energy Essentials Overview Energy Essentials is an add-on to the Metasys Advanced Reporting System that focuses on the energy and utility use of your facility. After you install Energy Essentials, the following items appear in the Metasys Advanced Reporting System user interface: seven new report types. See Energy Essentials Reports. Energy Setup tab. See Tabs. Before you can run an Energy Essentials report for the first time, you must set up Energy Essentials. See Energy Essentials Workflow and Energy Essentials Setup Considerations. Energy Essentials Workflow Figure 4 shows the overall workflow for Energy Essentials and the documentation that contains more information on each step. Steps 1 through 8 are required for initial setup only, after which Step 9 can be done at any time. Complete workflow Steps 1 and 2 before following the steps in this document. This document contains workflow Steps 3 through 9. To start, see Creating an Energy Essentials User View or click the step you need. Note: To log in to the Metasys Advanced Reporting System, you must first log in to the Site Management Portal UI and accept the license agreement. You also must have the Advanced Reporting privilege and your access type must have Standard Access in the Metasys Security Administrator System. See Security Administration. 7

8 Figure 4: Overview of Energy Essentials Workflow and Documentation 8

9 Energy Essentials Setup Considerations When using Energy Essentials, a well laid-out site reduces setup time and improves report usefulness and accuracy. Consider the following sections when preparing a site for Energy Essentials. Information Needed for Setup Before setting up Energy Essentials, gather the following information from site professionals: the types of meters on the site the billing periods for the site the billing rates for the site available outside weather information (temperature, humidity, and enthalpy) size of the area served by each meter meter usage trend intervals used for meter points the type of building service provided by each meter the equipment points that are monitoring equipment run status occupancy schedules that can be associated with equipment Site Layout Carefully examine the layout of your site. Possible problem areas include: units that do not match the type of point For example, an outdoor air sensor should not be assigned kbtu for units. See Units Compatible with Energy Essentials for tables that list which units should be used for particular points. overlapping measurement areas or duplicate measurements For example, each meter should measure one area and not a portion of another meter s area; otherwise, the accuracy of Energy Intensity calculations is degraded. improperly configured trends or missing trends Energy Essentials uses trend data to populate reports. These trends must be configured properly to be useful in reports. See Trending Requirements for specific information. layouts that lend themselves to double-counting For example, if you have a meter that collects data for several Variable Frequency Drives (VFDs), you do not want to report on the meter and the VFDs in the same report. Instead, you should include either the meter or the VFDs in the report, but not both. This method prevents reports from inflating the energy use or cost for the system. See Figure 5. Figure 5: Possible Meter Configurations 9

10 User View Folder Content Energy Essentials creates energy reports based on associations with Metasys objects in a user view. If you do not have one user view that contains energy points for meters and equipment, this procedure is covered in the first step of Energy Essentials setup. See Creating an Energy Essentials User View. In this Energy User View, we recommend you create four specific folders and group points under these folders. Points should have Trend extensions and be trended properly. See Trending Requirements. The following are tips for which points to add to which folder: Energy/Utility folder: In this folder, place all energy and meter objects. Six of the seven Energy Essentials reports allow you to include detailed information on meters used to create the report if the meters are electrical. If the meters are not electrical, four reports incorporate this information. The reports require that you have at least one meter mapped to Energy Essentials. Equipment folder: In this folder, place equipment points on the site whose runtime you wish to report. This folder populates the Equipment Setup view. Weather Data folder: In this folder, place points related to the outdoor air temperature, humidity, and enthalpy. Other Data folder: In this folder, place occupancy schedule points, power factor points (electrical energy), and reactive power points (electrical energy). Note: You can use subfolders to help organize points within the main folders. Also, use subfolders when the number of points in a folder is greater than 100. This practice makes all points available when you create Tailored Summaries for configuring trends. Use Global Search or a manual search to identify points related to meters, equipment, weather conditions, or other points of interest. These points must be trended. Change point labels in the user view as needed to make sure it is clear which points exist in the view. When using Global Search, commonly named points in your system may be found using the following conventions: *SF-S* (Supply Fan Status), *RF-S* (Return Fan Status), *MTR* (Meter), *CH* (Chiller), and *BLR* (Boiler). Weather points may be named *OA-T* (Outdoor Air Temperature), *OA-H* (Outdoor Air Humidity), and *OA-E* (Outdoor Air Enthalpy). You can select results from a Global Search and drag and drop them into a user view folder to populate it quickly. Tailored Summaries (Figure 6) allow you to validate point configurations for Energy Essentials use. We recommend using the Configuration Trends - Summary Definition to verify four attributes for each object listed: Present Value: check that enumerations and units are configured and supported for each object shown. For a list of supported list of enumerations and units, refer to the Metasys SMP Help (LIT ) or Metasys SCT Help (LIT ). If any definition is incorrect or not defined, right-click the object and select View. Add or modify units in the Focus view (Advanced). Log Enable: verify this attribute is set to True. If not, right-click and command the trend extension to Enabled. Repository Enabled: verify this attribute is set to True. If not, right-click and modify to True. Sample Interval: verify this attribute is 0 for Change of Value (COV) for equipment objects. Keep in mind that missing samples cannot be calculated for COVs. For accuracy, we recommend a maximum value of 900 seconds (15 minutes) for meter objects. Right-click and modify to change. Notice in Figure 6 that none of the object attributes have lines (---) in their fields. If this marking appears, this line indicates that either no trend extension exists for this object or the trend extension name is not compatible with the summary definition. To resolve these markings, either right-click the item in the first column, select Show Extensions, and use the Extension Wizard to add the trend; or, right-click, select View, then click the Trend tab and modify the reference name of the Trend Extension to include the word Trend. 10

11 Note: If you are upgrading from a site prior to 5.0, add the word Trend to all of your trend extensions in order for the points to show in the Summary Definition trend search window. You can make this change manually in the Trend tab. Another option is to add *Present Value* as a filter to the Child Items in the summary definition. This option makes the existing trend extension names compatible if the default name of Present Value was used. Finally, another recommended option is to perform a global search while selecting Trends for the Object type. Perform a Global Modify to rename the Name attribute to Trend - Present Value on the results of the search. This option brings consistency with other trends defined after Release 5.0 using the default name. The Configuration Trends - Summary Definition also helps you verify that engineering units are assigned to analog objects. See Units Compatible with Energy Essentials. For more details on Tailored Summaries, refer to the Metasys SMP Help (LIT ) or Metasys SCT Help (LIT ). Figure 6: Tailored Summary Example Note: Verify that all attributes (for example, Log Enable, Repository Enabled, and Sample Interval) have attributes defined (that is, none of the --- markings remain). Trending Requirements Energy Essentials uses trend data as the basis for reports. Refer to the Metasys SMP Help (LIT ) 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 or ODS when the buffer is full. To configure the Trend extension, set the Repository Enabled attribute 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. 11

12 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 the COV trend, 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). Metasys objects that are not trended correctly appear with a warning icon (yellow triangle with exclamation point) in the Energy Setup panel views. To verify proper trending, you also can log in to the Metasys Advanced Reporting System and run the Trend Log Definition report on the points in the user view to detect points that are not trended or are not trended properly. Units Compatible with Energy Essentials The tables in this section show the units that are compatible with Energy Essentials. Default units are in bold. Default units are used when multiple points with different units are selected on the report. For example, if you run an Electrical Energy report against meter 1 (W) and meter 2 (kw), the report shows values in default (kw) when aggregating the two meters. If you configure meters and equipment in the Metasys system with units other than the ones shown in this section, the contents of Energy Essentials reports become unpredictable. You can also change the defaults configured for the units. See Energy Essentials Advanced Configuration Questions. Table 1: Energy Units Energy Source Energy Energy Intensity - Source Energy Energy Intensity - Area Imperial Units Btu, kbtu, MBtu Btu, kbtu, MBtu sq ft Metric Units J (Joules), cal (calories), kj, MJ, GJ, kcal, kwh J (Joules), cal (calories), kj, MJ, GJ, kcal, kwh sq meter Table 2: Electricity Utility Meter Units Electric Utility Meter Type Imperial and Metric Units Aggregated as Consumption 1 Aggregated as Peak Demand 2 Electrical Demand W, kw, MW, GW Wh, kwh, MWh, GWh Electrical Consumption Wh, kwh, MWh, GWh W, kw, MW, GW 1 This value indicates the calculated consumption based on the demand rate. 2 This value indicates the calculated demand based on the measured consumption. 12

13 Table 3: Units for Electrical Utility Associated Objects Electrical Utility Meter Type Imperial and Metric Units Notes Reactive Power Power Factor VAR, kvar PF, % Degree phase is not supported. Negative values are not supported. Table 4: Units for Utility Associated Objects Utility Meter Type Imperial Units Metric Units Natural Gas Consumption Liquefied Petroleum Gas (LPG) Consumption Steam Consumption Oil Consumption Coal Consumption Water - Distribution Water Consumption thrm, dekatherm, cu ft, ccf Gal, imp Gal, tons lbm, klb, Mlb, thrm (therms) Gal, imp Gal tons Btu, kbtu, MBtu Gal, imp Gal, cu ft, ccf Nm3 Nm3, kg, tonne (metric) kg L, cu meter tonne J (Joules), cal (calories), kj, MJ, GJ, kcal L, cu meter Table 5: Flow Rates Supported for Meters that Measure Flow (Demand) 1 Demand or Rate Rolls Up to This as a Consumption Value cu m/min cu meter/h kg/h L/h L/s L/min lbm/h Ncu meter cu meter kg L L L lbm 1 These typically are used in measuring steam and water consumption. Also, values from these meters cannot be converted to energy or source energy. Table 6: Units for Weather Associated Objects Weather Data Imperial Units Metric Units Temperature Humidity Enthalpy Degree Days deg F %RH, % Btu/lb, Btu/lb dry air Degree days F deg C, K %RH, % J/kg, kj/kg, kj/kg dry air Degree days C Table 7: Other Units Measurement Area Imperial Units sq ft Metric Units sq meter 13

14 Comparable Utility/Energy Types Table 8 lists common utility groups/energy types and the utility types that appear in Energy Essentials reports/views. For example, the Big Picture Energy report normalizes energy using multipliers based on utility type. Also, see Table 16. Table 8: Utility Group/Energy Type to Utility Type Mapping Utility Group/Energy Type Utility Type Water Distribution Water Consumption Coal/Coke LP Gas Oil Steam Electricity Natural Gas Other Hot Water, Chilled Water Water Bituminous Coal, Subituminous Coal, Anthracite Coal, Coke LPG, Propane Diesel, Gasoline, Kerosene, #1 Fuel Oil, #2 Fuel Oil, #3 Fuel Oil, #4 Fuel Oil, #5 Fuel Oil Steam Electricity Natural Gas Other Reports and charts that contain single or multiple utility types present values in source energy. Source energy is a representation of the total amount of fuel required to operate a building. Source energy takes into account all transmission, delivery, and production losses, thereby providing a complete assessment of energy efficiency in a building. For more background on source energy and the Source-Site ratios used to convert a utility type into source energy (for example, a ratio of 3.34 for electricity), download the technical document called ENERGY STAR Performance Ratings Methodology for Incorporating Source Energy Use. This document is available from the following Energy Star website: For information on how Energy Essentials uses multipliers to normalize energy use, see Table 16. Supported Objects for Energy Essential Reports Table 9 lists the objects per data type that Energy Essentials supports. Table 9: Supported Object Types Type of Data Meter Equipment Weather Other Supported Objects analog input (AI), analog output (AO), analog value (AV), Accumulator, and Pulse Counter binary input (BI), binary output (BO), binary value (BV), multistate input (MI), multistate output (MO), multistate value (MV) AI, AO, AV AI, AO, AV, BI, BO, BV, MI, MO, MV, Program (Control System), and Schedule Chart and Table Intervals The chart interval rules that Energy Essentials applies to reports are described in Table 10. For example, if you select a report for one day, the chart shows one data point for each hour and displays the data using the short date time format. 14

15 Table 10: Chart Interval Rules Report Duration (Range) Interval Display Format Format Example 1 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/ Months < Report Duration <= 24 Months 1 Month month/year May, Months < Report Duration Years year 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 11. 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. Table 11: Table Interval Rules Report Duration (RD, range) Row Limit Test Interval Primary When Format Format Example 1 Secondary When Format Format Example 1 RD < 1 Month #items * #hrs < limit 1 Hour short date 5/16/2011 short time 9:01 A.M. RD < 1 Month #items * #days < limit 1 Day month/year May, 2011 day 11 RD < 1 Month #items * #days >= limit ERROR 2 1 Month <= RD < 12 Months #items * #days < limit 1 Day month/year May, 2011 day 11 1 Month <= RD < 12 Months #items * #days >= limit ERROR 2 12 Months <= RD < 36 Months #items * #months < limit 1 Month year 2011 month name May 12 Months <= RD < 36 Months #items * #years < limit 1 Year year 2011 year Months <= RD < 36 Months #items * #years >= limit ERROR 2 15

16 Table 11: Table Interval Rules Report Duration (RD, range) Row Limit Test Interval Primary When Format Format Example 1 Secondary When Format Format Example 1 36 Months <= RD #items * #years < limit 1 Year year 2011 year Months <= RD #items * #years >= limit ERROR 2 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. 2 The report has exceeded the maximum number of records allowed. Table 11 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: Table 12: Row Limit Test Example Selected Report Duration Number of Selected Items Maximum Row Limit Configured Report Selects an Interval Report Selects a Different Interval Final Analysis 01/01/ /30/2010 (35 months or 3 years) 285 meters 10,000 Energy Essentials attempts to use the smallest interval possible. Because the duration for this example is between 12 and 36 months, the report first tries to use an interval of months:286 items (meters) * 35 months = 10,010 total items The total item count exceeds the row limit, so the report now tries a year interval:286 items (meters) * 3 years = 858 total items The total item count is within the row limit, so the report uses years for the table interval. If the total item count still exceeded the row limit, an error is shown in the report. See Figure 8 for an example of a report that exceeded the row limit. Interval: the lowest level of granularity in the table. Primary When Format: the highest level of granularity for the date and time. See Figure 7. Secondary When Format: the lowest level of granularity for the date and time. See Figure 7. 16

17 Figure 7: Example of Partial Consumption Report 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 ) or to the ODS Commissioning Guide (LIT ). 17

18 Figure 8: Report That Exceeded Maximum Record Count How Billing Period Selection Affects Reporting When you select a Simple Energy Cost, Consumption, Electrical Energy, or Production report, you select from a list of billing periods. The three choices for Billing Period are: Not Included, Aggregate on Billing Period End Date, and Distribute Aggregation Over Billing Period. The base charge for a billing rate appears in the Simple Energy Cost report, in one of two ways, depending on the chosen billing period option. If you select the Billing Period option Not Included, the entire base cost is applied to the meter once, in an even distribution across the requested report period. If you select either of the other Billing Period options (Aggregate on Billing Period End Date, and Distribute Aggregation Over Billing Period), the base cost appears in the Simple Energy Cost report once per billing period. Not Included This selection does not allow the associated billing period to affect the report content. In other words, billing periods are ignored. When calculating utility cost: Base is distributed over the specified date range. Consumption is actual over the specified date range. Peak Demand is the maximum value over the specified date range. The Demand Cost is reported on the actual date of the peak. 18

19 Aggregate on Billing Period End Date This selection aggregates values over a billing period object s cycle or a series of cycles, and then displays the aggregated value at the end of the cycle or series of cycles. A cycle is the period of time from one effective date to the next effective date. When calculating utility cost: Base is aggregated on the billing cycle end date. Consumption is aggregated on the billing cycle end date. Peak Demand is the maximum value over a billing cycle. The Demand Cost is aggregated on the billing cycle end date. This selection is a good option if you are running the Simple Energy Cost Report to show multiple energy costs on a monthly basis. Total cost is displayed on the Billing Period End Date. Figure 9 is an example of this type of report. Figure 9: Report Example: Aggregate on Billing Period End Date (asked for 7/1/2009 to 8/31/2009) Distribute Aggregation Over Billing Period This selection aggregates values over the determined interval period object s cycle or a series of cycles and then displays the value based on the interval. When calculating utility cost: Base is distributed over a billing cycle. Consumption is actual over the report date range. Peak Demand is the maximum value over the billing cycle. The Demand Cost is reported on actual date of the peak. To display an accurate distribution for entire billing periods, the report extends the duration of the report as necessary. Multiple meters are totaled in the charts. Figure 10 is an example of this type of report. 19

20 Figure 10: Report Example: Distribute Aggregation Over Billing Period (asked for 6/15/2009 to 8/14/2009) Example of Calculating a Billing Period To help you understand how Energy Essentials calculates the billing period, consider an example. In this example, you can select either the Aggregate on Billing Period End Date or the Distribute Aggregation Over Billing Period billing option under the Select Date Range filter. Energy Essentials uses the entire billing period, rather than a partial billing period, and the report duration is calculated based on the example shown by Figure 11 and Table 13. First, Energy Essentials determines how many billing period end dates fall within the Select Date Range filter. In this example, the report is generated on 9/15/2009 and you select This Month for the period in the Select Date Range filter. Three billing period end dates are found (as indicated by the blue dots). Next, Energy Essentials calculates the Start Date for the report duration. If you select Aggregate on Billing Period End Date, Energy Essentials uses the Start Date of 9/1/09, as the report only needs to show information on the End Date. If you selected Distribute Aggregation Over Billing Period, Energy Essentials determines the Start Date by the earliest billing period Start Date of the billing periods found. In this example, since the Water Company Start Date of 6/4/2009 is the earliest, Energy Essentials uses 6/4/2009 for the report duration Start Date. Finally, Energy Essentials calculates the End Date of the report duration. For Aggregate on End Date, the End Date is the same as the End Date of the Select Date Range filter. For Distribute, the report ends on the latest Billing Period End Date. So, although you asked for the current month in the Select Date Range filter, the report generated delivers the appropriate amount of information for the Billing Period based on your selections. 20

21 Figure 11: Energy Report Filtering Based on Billing Period Table 13: Billing Period Example Period Select Date Range Start Date End Date Last Month 8/1/2009 8/31/2009 Last Month 8/1/2009 8/31/2009 This Month 9/1/2009 9/30/2009 This Month 9/1/2009 9/30/2009 Billing Period Type Selected Aggregate on Billing Period End Date Distribute Aggregation Over Billing Period Aggregate on Billing Period End Date Distribute Aggregation Over Billing Period Billing Period(s) Found Report Duration 8/1/2009-8/31/2009 7/15/2009-8/15/2009 9/1/2009-9/30/2009 6/4/2009-9/26/2009 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 out of 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. 21

22 Figure 12: Reports Tab Layout 22

23 Figure 13: Energy Setup Tab Layout Web Browser Tools The Metasys Advanced Reporting System runs in the Windows Internet Explorer web browser. When you open the reporting system, you have access to all of the browser tools such as the menu bar, toolbars, address bar, and more. You remain logged in to the reporting system until you close the window, click Logout on the user interface, or your session times out. The F11 key shows and hides the web browser toolbar. If you navigate to another website and return to the Metasys Advanced Reporting System UI, the page indicates it is expired. You can reload the user interface using the Refresh button in the browser. In this case, you only need to log in to the reporting system again if a timeout occurred. The browser's Stop button does not cancel a pending report. If you decide that you do not want to view a report, you can close the report window at any time. If you close this window before the report content appears, the software continues to gather all data in the background but does not display the final report. Toolbar The Metasys Advanced Reporting System toolbar contains the items in Table

24 Table 14: Metasys Advanced Reporting System Toolbar Toolbar Item Textual Functional Metasys Button Help Button Logout Button Opens the Metasys Site Management Portal UI in a separate web browser window. This hyperlink points to Opens the Metasys Advanced Reporting System Help in a separate web browser window. Log out of the Metasys Advanced Reporting System. The Login screen reappears. 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. Report Selection Panel Found on the Reports tab, the Report Selection panel contains a navigation tree that allows you to select a report type. You can select a single item in the tree. The type of report you select determines which panels appear to configure that report and the content of those panels. For information on the types of reports, see Report Types in the Concepts section. See Report Selection Panel Content in the Screens and Tabs section. 24

25 Predefined Report Properties Panel Found on the Reports tab, this panel appears only when you click New Report in the Report Selection panel or when you select a predefined report. A predefined report allows you to create copies of a standard report with saved filters for reuse. This panel allows you to enter a name and description for a new predefined report. You can also select a destination if you are using folders to organize your predefined reports. See Predefined Report Properties Panel Content in the Screens and Tabs section for descriptions of the contents of this panel. Folder Properties Panel Found on the Reports tab, this panel appears only when you click New Folder in the Report Selection panel or when you select a folder that you created. This panel allows you to enter a name and description for a new folder. See Folder Properties Panel Content in the Screens and Tabs section for descriptions of the contents of this panel. Select Objects Panel Found on the Reports tab, the Select Objects panel allows you to select the items to include in the report. Depending on the type of report you select, this panel displays the All Items tree, user views, or a subset of user views on your site. For example, after you complete setup steps, Energy Essentials reports show either a Meter tree or Equipment tree that is broken down by type. You can expand and collapse items in the tree using the and buttons. Single-click to select an item. 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 or ODS. 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. 25

26 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 or ODS. 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 or ODS in another time zone, be aware that the date and time are different from your location s time zone. The time format (00:00:00 to 23:59:59 or 12:00:00 A.M. to 11:59:59 P.M.) is based on the locale of the logged-in user. For Energy Essentials, all start times must be at the start of the hour (for example, 11:00:00) and all end times must be at the end of the hour (for example, 9:59:59). This panel does not appear in reports that do not search for data based on date and time such as the Configuration Setup Review reports. Date and Time Period Rules All intervals are optional. If you omit any fields listed here, the following conventions apply: Start Date: The starting time is ignored, and the report includes all records that have a time stamp before the ending date/time. Start Time: The starting time is 00:00:00/12:00:00 A.M. of the starting date. End Date: The ending time is ignored, and the report includes all records that have a time stamp after the starting date/time. End Time: The ending time is 23:59:59/11:59:59 P.M. of the ending date. Billing Period Panel Found on the Reports tab, the Billing Period panel allows you to filter based on three selections. 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. Other Filters Panel Found on the Reports tab, the Other Filters panel allows you to filter the items included in a report. The filter choices in this panel allow you to focus on a particular set of data on which to report. The filters include item name, item type, attribute, user, and more. For example, selecting Field Devices in the Item Type filter gathers data only from field devices. Depending on the report type selected, the contents of this panel may be different. This panel does not appear for Energy Essentials reports. Obsolete items do not appear in reports when filtering on Item Type. Obsolete items are items that may have generated events but they no longer exist in the SCT archive database and have fully qualified references that begin with the site name of the SCT archive database. 26

27 Any items defined for Energy Essentials reports with trend data continue to exist as selectable items in reports, even after you delete them from the SCT archive. These items are marked as deleted. These items also have a black X next to them in the views of the Energy Setup tab. See Energy Setup Tab/Panel Content. See the Selection Persistence section for details on how the Metasys Advanced Reporting System remembers selections made in these panels. See Other Filters Panel Content in the Screens and Tabs section for descriptions of the contents of this panel. Energy Filters Panel Found on the Reports tab, the Energy Filters panel allows you to filter the items included in an Energy Essentials report. You can filter on energy type and other criteria, or choose to add additional data to the report such as prior year data and weather data. See Energy Filters Panel Content in the Screens and Tabs section for descriptions of the contents of this panel. Energy Setup Panel Found on the Energy Setup tab, the Energy Setup panel appears only after you install Energy Essentials. Using seven views, this panel allows you to configure details such as billing information, equipment data, weather data, and other information used in Energy Essentials reports. This panel also allows you to map Metasys system points to your Energy Essentials reports. See Setting up Energy Essentials for how you must use this panel before you attempt to run an Energy Essentials report. See Energy Setup Tab/Panel Content for descriptions of the content of each view in this panel. 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. A warning icon (yellow triangle with exclamation point) in an Energy Setup panel view indicates that a point is not trended (no Trend extension exists). The different views in the Energy Setup panel are: Energy Folders: This view allows you to map folders from your user views to Energy Essentials. The items in those mapped folders and subfolders become the rows found in four other views: the meters present in the Energy/Utility Meter view, the equipment in the Equipment view, the weather data points in the Weather Data view, and data points that appear in the Other Data view. Furthermore, the view includes the Populate button, which is necessary to map over newly added points to the existing user view folders. See Report Screen Content for details on this view. Billing Period: Billing periods are custom user-defined time ranges that typically coincide with their utility billing dates. Once you create a billing period, it maintains a history of dates to be used by Energy Essentials reports. If you add a billing period to a report and do not associate a billing period with a meter, that meter uses the period of the first to the last day of the month. This view allows you to enter billing period information that can be incorporated into the Energy Essentials reports. Information in this view includes the name you define for the billing period and a start date. This view is useful if your utility billing periods do not coincide with whole month periods. See Billing Period View Content for details on this view. Billing Rate: Billing rates are used only by the Simple Energy Cost report. See Simple Energy Cost Reports. These reports give a high level view of energy costs on your Metasys site. Utility companies tend to have very complex rate structures, requiring you to configure the available rates appropriately to attain a satisfactory level of accuracy. Energy Essentials simplifies data entry by requesting only three configurable rates that feed the Simple Cost Report. 27

28 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. See Equipment View Content for details on this view. Weather Data: This view contains the weather data used for Energy Essentials reports. Weather data information available in this view includes a user-configurable description of the data and the Metasys system source information. The weather data that appears in this view must reside in the folder you map to the Weather Data category in the Energy Folders view. No additional configuration is necessary for weather data, and you can exclude this information from the reports if desired. See Weather Data View Content for details on this view. Other Data: This view contains data such as Schedule objects (optional for Equipment Runtime reports) and Power Factor/Reactive Power (optional for Electrical Energy reports). This view also includes a user-defined description of the data and Metasys system source information. The data that appears in this view must reside in the folder you map to the Other Data category in the Energy Folders view. No additional configuration is necessary for other data, and you can exclude this information from the reports if desired. See Other Data View Content for details on this view. Standard and Predefined Reports Both standard and predefined reports are available in the Metasys Advanced Reporting System UI: Standard reports appear by default when you log in to the system. If you configure these reports, the selections you make persist and appear each time you return to the report. To create another version of a standard report with specific selections, use a predefined report. Predefined reports allow you to create and save versions of the standard reports. Predefined reports must reside under the standard report on which they are based. See Creating Predefined Reports. Note: When you click Run to request a standard or predefined report, or when you switch to another report, the current report selections are validated and autosaved, so that the next time you run the report, your previous selections are retained. Report Selection Folder Organization Strategy Before you populate the Report Selection panel with folders and reports, define a strategy to organize the folders to allow efficient use of the system. Create a strategy as you see fit based on how you plan to use the reporting system. 28

29 Keep in mind that folders appear in alphanumeric order. If you want to force the folders to appear in a certain order, number the folders (for example, see Figure 14). We recommend organizing folders in one of the three following ways; however, you may use any strategy you wish. The strategies described here are common ways to organize the folders and reports in the Report Selection panel. By Timeframe: Create folders that contain reports for the current week, month, or year, and are then organized by site. Figure 14: Report Folder Strategy Example - By Timeframe 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. 29

30 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. Figure 17: Report Screen Example 30

31 Figure 18: Energy Essentials Report Screen Example 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 15 describes the toolbar options. 31

32 Table 15: Report Toolbar Toolbar Item Name First Page Functional Goes to the first page of the report. Previous Page Goes to the previous page of the report. Current Page/Go to Page Next Page Indicates the current page being displayed and allows you to enter a specific page of the report to which you want to jump. Goes to the next page of the report. Last Page Goes to the last page of the report. Go Back to the Parent Report Zoom Level Goes back to the parent report when viewing a subreport. Allows you to select or type a zoom level for viewing the report. Find/Search Export/Save Report 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. 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 Print Refreshes the data in the report by running the report again in the same window using the selected configuration parameters. 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. 32

33 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. Alarm Definition Report Alarm definition reports contain the parameters of the alarms configured for the points in the selected context. This report also includes subreports that list the devices with disabled alarming and points without alarm extensions configured. The report contains only alarm extensions and does not include the intrinsic or Event Enrollment alarming configurations. Fields that are not applicable, such as Normal State for Analog Alarms or Low/High Alarm Limit for Multistate Alarms, are marked with N/A. Due to its width, this report prints on 11x17-in. paper in landscape mode by default (A3 in Europe). Subreports print on Letter size paper in landscape mode by default (A4 in Europe). See the Printing a Report section. See Alarm Definition Report Content in the Screens and Tabs section for details on the contents of this report. Trend Log Definition Report Trend Log Definition reports contain the trend configuration values for points that have trends configured. When selected, this report also includes a subreport, which lists the points with no trend extensions configured. This report prints on Letter size paper in landscape mode by default (A4 in Europe). Subreports print on Letter size paper in Portrait mode by default (A4 in Europe). See the Printing a Report section. See Trend Log Definition Report Content in the Screens and Tabs section for details on the contents of this report. System Behavior Reports Use System Behavior reports to monitor the behavior of the Metasys system during a specified time period. Behavior, performance, and diagnostic information originates from historical data stored on the ADX or ODS. See the Example Report Sequence Scenarios section for workflow examples and guidelines on running reports. Event Reports Event reports include the Event Summary report, which lists the total count of events grouped by event type; and the Event Details report, which lists events and the time those events occurred. Event Summary Reports The Event Summary report provides a quick overview of the system. We recommend running this report before the Event Details report. The report comprises the report header and footer, Total Events Chart, and the table of event data. Figure 17 shows an example of this report. This report prints on Letter size paper in landscape mode by default (A4 in Europe). See the Printing a Report section. See Event Summary Report Content in the Screens and Tabs section for details on the contents of this report. See the Example Report Sequence Scenarios section for workflow examples and guidelines on running reports. Event Details Reports The Event Details report provides a detailed view of the system. We recommend running this report after the Event Summary report. From the summary report, you can determine a particular set of items, type of event, and time interval on which to focus. Then, you can create an Event Details report to view or troubleshoot the potential problem. The report comprises the report header and footer and the table of event data. This report prints on Letter size paper in landscape mode by default (A4 in Europe). See the Printing a Report section. See Event Details Report Content in the Screens and Tabs section for details on the contents of this report. See the Example Report Sequence Scenarios section for workflow examples and guidelines on running reports. 33

34 Controller Offline Reports Controller Offline reports include the Controller Offline Summary report, which lists the offline controllers by trunk; and the Controller Offline Details report, which lists the offline controllers by device. The Controller Offline reports provide benchmarking statistics to determine whether your site is running smoothly or whether it needs improvements. You can gather benchmarking statistics using the Percent column because it indicates the percentage of time the devices were offline in the selected time period. Controllers with Automatic Alarming disabled are not counted in the Controller Offline reports. This situation occurs even though the controllers have an Offline status because the Metasys system does not create a record for the controllers in the Events database. Controller Offline Summary Reports The Controller Offline Summary report allows you to quickly evaluate network issues at a high level. We recommend running this report before the Controller Offline Details report. The report comprises the report header and footer, Controller Offline By Trunks Chart, and the table of data. Figure 19 shows an example of this report. This report prints on Letter size paper in landscape mode by default (A4 in Europe). See the Printing a Report section. See Controller Offline Summary Report Content in the Screens and Tabs section for details on the contents of this report. Also, see the Example Report Sequence Scenarios section for workflow examples and guidelines on running reports. 34

35 Figure 19: Controller Offline Summary Report 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 Three devices were offline in Week 2, and seven devices were offline in Week 4, which equals the total of 10 devices offline. Controller Offline Details Reports The Controller Offline Details report provides a detailed view of the offline controllers. We recommend running this report after the summary report. From the summary report, you can identify a particular set of controllers and a time interval in which to focus. Then, you can create an Controller Offline Details report to view or troubleshoot the potential problem. The report comprises the report header and footer and the table of data. The report prints on Letter size paper in landscape mode by default (A4 in Europe). See the Printing a Report section. 35

36 See Controller Offline Details Report Content in the Screens and Tabs section for details on the contents of this report. Also, see the Example Report Sequence Scenarios section for workflow examples and guidelines on running reports. Event and Audit Details Reports The Event and Audit Details report is intended as a diagnostic report, providing time and event correlation to system behavior. The report displays a list of system events and user actions, enabling you to determine the sequence of actions that lead to a specific event (for example, changing a setpoint may cause an alarm to go off). This report contains primarily events and audits, including annotations and signatures, as applicable. Annotations and signatures appear in the report following their respective parent event or annotation. In the cells of the table where data is not applicable or expected, N/A appears. Not Specified appears in the cells of the table where data is expected but not available. This report comprises the report header and footer and the table of data. This report prints on 11x17-in. size paper in landscape mode by default (A3 in Europe). See the Printing a Report section. See Event and Audit Details Report Content in the Screens and Tabs section for details on the contents of this report. See the Example Report Sequence Scenarios section for workflow examples and guidelines on running reports. Trend Reports Trend reports include the Trend Summary report and the Trend Details report. Unlike the other System Behavior and Configuration Setup Review reports, Trend reports do not include the All Items tree in the Select Objects panel. Instead, User Views allow you to run reports based on groups of related trend items such as all zone temperatures in the system. The term point refers to a data collection point such as a room s temperature or the status of a field device. Trend points deleted from the SCT archive database are considered obsolete items and do not appear in the report. Renamed points appear in the report with their current name (that is, the old point name is lost). Trend Summary Reports The Trend Summary report aggregates trends by time intervals (hours, days, weeks, and so on); calculates the minimum, maximum, and average of the trended values during each interval; and calculates the Mean Kinetic Temperature (MKT) when the values are temperatures. The Trend Summary report provides a quick overview of the system. We recommend running this report before the Trend Details report. The report includes only reliable sample values in its calculations. Calculations do not include unreliable points (for example, points with a bad status or duplicate timestamps). The Trend Summary report includes only analog data. Use the Trend Details report to see unreliable points and binary or multistate data. See the Trend Details Reports section. This report comprises the report header and footer and the table of trend data. You cannot sort the data in this report; instead, the report is organized alphabetically by Point Full Reference and chronologically by time. This report prints on 11x17-in. size paper in landscape mode by default (A3 in Europe). See the Printing a Report section. See Trend Summary Report Content in the Screens and Tabs section for details on the contents of this report. See the Example Report Sequence Scenarios section for workflow examples and guidelines on running reports. 36

37 Trend Details Reports The Trend Details report lists all trended values for the selected items without aggregation or calculations. We recommend running this report after the Trend Summary report. From the Trend Summary report, you can determine a particular trend point and time interval on which to focus. Then, you can create a Trend Details report to view or troubleshoot the potential problem (for example, if the MKT value shown in the Trend Summary report is not the expected value). This report comprises the report header and footer, Trend Log Detailed Graph, and the table of trend data. The data table is limited to a maximum of 10,000 rows. This number is configurable only by the Metasys Advanced Reporting System ADX or ODS administrator using information in the ADS/ADX Commissioning Guide (LIT ) or in the ODS Commissioning Guide (LIT ). As a best practice, run a report with a maximum of 10 trend points. You cannot sort the data in this report; instead, the report is organized alphabetically by Point Full Reference and chronologically by time. Note: Because of an error in the SQL rendering engine, the browser may not show page breaks in a long report. However, the report is correctly paginated when it is exported or printed. This report prints on Letter size paper in landscape mode by default (A4 in Europe). See the Printing a Report section. See Trend Details Report Content in the Screens and Tabs section for details on the contents of this report. Also, see the Example Report Sequence Scenarios section for workflow examples and guidelines on running reports. Energy Essentials Reports Note: Energy Essentials reports are available only after you install Energy Essentials. Big Picture Energy Reports The Big Picture report shows all energy usage for the Metasys site for all types of energy. This report converts all energy values to kbtu and then normalizes energy into source energy. The normalization takes into account energy extraction, conversion, and distribution losses. Normalization of energy information allows you to compare across energy types effectively. You can use both consumption and production meters in the Big Picture report. If you include production meters, the value of the meter is subtracted from all aggregations. If any aggregated value is negative, this value is included in the table but not in the charts. Energy Essentials uses the multipliers in Table 16 to normalize energy use. See Table 8 for how Energy Essentials converts utility groups/energy types to utility types. Table 16: Energy Essentials Normalization Multipliers Utility Type Multiplier Other Electric Natural Gas Steam Hot Water Chilled Water Coal Propane Gas

38 Table 16: Energy Essentials Normalization Multipliers Utility Type Multiplier Oil Diesel As an example of how Energy Essentials uses the Electric multiplier, consider the following: Meter Reading Meter Reading kwh to kbtu Conversion Normalization Multiplier Total kbtu Reported on Big Picture Energy Report 2082 kwh * * 3.34 = 23, 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. 38

39 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. See Equipment Runtime Report Content for details on the contents of this report. Electrical Energy Reports The Electrical Energy Usage report compiles electrical energy consumption and demand, including demand peaks and supporting electrical information. This report covers only electrical meters. If you mapped power factor and reactive power, you can view additional electrical information that is sometimes used by utilities in their billing schemes. See the Printing a Report section. See Electrical Energy Report Content for details on the contents of this report. Production Reports The Production report shows the energy being produced by your facility, by type. This report is similar to the consumption report, but it also offers details on the efficiency of equipment at your site, such as generators. For example, if you are using a natural gas generator to create electrical energy, this report allows you to examine the efficiency of this process. See the Printing a Report section. See Electrical Energy Report Content for details on the contents of this report. Export Options You can export (save) a generated report to a file in the formats listed in Table 17. The export feature is available by using the Report toolbar in the browser window where report results appear. Table 17: Export Format Options Format Extension PDF Excel TIFF file Word.pdf.xlsx.tif.docx Saves the report as an Adobe Acrobat PDF file. Saves the report as a Microsoft Excel spreadsheet. This option formats the data using Excel advanced grouping functionality. Saves the report as a TIFF image file. Saves the report as a Microsoft Word document. 39

40 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 user interface, 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 or ODS administrator using information in the ADS/ADX Commissioning Guide (LIT ) or in the ODS Commissioning Guide (LIT ). When a timeout occurs, you are logged out of the system and a timeout message appears. You must log back in 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 in 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 in to the system. To limit data entry errors, the user interface uses tooltips, drop-down lists, list boxes, and check boxes and disables (dims) items that do not apply to the current context. Also, the user interface displays a line of red text at the top of the Report Selection panel when a date is invalid, stating Invalid start date or time, Start date is greater than end date, and so on. If you attempt to save details that are invalid, such as duplicate start date or duplicate name, a red X with a circle around it appears. If the combination of date and filters do not return any results for the report type and objects you selected, the following message appears in red text just below the report header in the report window: No records were found matching your criteria. Please modify your parameters and try again. For an Energy Essentials report, this message reads slightly different, indicating the number of rows that were exceeded in the report. For an example, see Figure 8. The Metasys Advanced Reporting System indicates if the report being generated has more rows than the default, which is 10,000. This number is configurable only by the Metasys Advanced Reporting System ADX or ODS administrator using information in the ADS/ADX Commissioning Guide (LIT ) or in the ODS Commissioning Guide (LIT ). This scenario typically occurs in a detailed report with a large number of objects selected and a lengthy time range. You can decrease the number of records returned by selecting fewer objects or a shorter time interval. Example Report Sequence Scenarios We recommend creating a summary report first. Then, based on the contents of that report (that is, if you notice a problem or a particular pattern that requires attention), create a detailed report, specifying the particular time period on which to focus. The following scenarios provide workflow examples for using the reporting system. Scenario 1: Checking Controller Offline Status To check whether devices on your site went offline during a particular time period and investigate why the devices went offline: Note: Use the All Items tab to set the context for this report scenario. 40

41 1. Run a Controller Offline Summary report on the desired time period. Review the report and look for specific dates with many offline devices. 2. Run a Controller Offline Details report using the date range you identified after running the previous report. Review the report and check if a particular device caused the offline status. If necessary, check the device to see if it is running properly. 3. To find out why the device went offline, take one of the following steps: Run an Event Details report and filter on the device name. Review the report and check if one or more events correspond to the offline conditions. Run an Event and Audit Details report and filter on the device name, time period, and any other data gathered from the previous reports. Review the report and check if a particular operator is associated with the events corresponding to the offline conditions. For example, if John Smith acknowledged the Alarms, you can check with him for background information. From this investigation you may find, for example, that the devices went offline due to some maintenance being performed during that time period. Scenario 2: Checking Alarm Status To check whether alarms occurred during a particular time period and investigate why the alarms happened: Note: Use either the All Items tab or the User Views tab to set the context for this report scenario. 1. Run an Event Summary report on the desired time period. Review the report and look for specific dates with many alarms. For example, if you ran the report for last week, identify the day with many alarms. 2. Run an Event Details report using the time period you identified after running the previous report (for example, a particular day). Review the report and check if a device caused the alarm. 3. Run an Alarm Definition report for the items in question to make sure the alarm limits are set up correctly. From this investigation you may find, for example, that the device went offline and caused the alarms. If necessary, run more reports (such as the Offline or Event and Audit Details reports) or check the device to see if it is running properly. Scenario 3: Viewing This Month s Equipment Runtime to Same Month Last Year To compare equipment runtime from this month to the same month last year: 1. Run an Equipment Runtime report using the date range of This Month. Select the Include Previous Year's Data option. Also, select the Include Weather Data option and appropriately select either the Outdoor Air Temperature High or Low, depending on the season. 2. In the bar graph, review the total runtime for each equipment type. 3. In the table, review 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. From this report, you can see whether equipment was running unnecessarily during unoccupied times, how long the same equipment was running the previous year, and how the weather may have affected excessive runtime. Energy Data Rollups System performance of the reporting system can become an issue as the complexity of the reports increase and the amount of data that needs to be processed increases. Energy Essentials uses an aggregation process, based on the units of a point and sample interval, to reduce the amount of data that needs to be processed each time a report is executed. Each point in the rolled up data represents a designated time interval over a period of time. For example, a rollup value of 15 minutes, with a 1-minute sample interval, aggregates 15 samples for over a 15-minute period into one data point representing that period of time. 41

42 Energy Essentials aggregates raw data (from both demand and consumption meters) when a report is generated. At report execution, Energy Essentials determines if the data has already been aggregated, and if it has not, initiates the rollup for the missing time period. This sometimes causes a report to execute for a longer period of time the first time a specific period of data is reported against. Subsequent executions of reports against the same data should take significantly less time to execute as the entire rollup process does not need to be executed again. The aggregation algorithms depend on a combination of the units and sample interval of the object or point being reported on. If the units change, Energy Essentials destroys the previously aggregated data, and new data is generated if the raw data for the point has not been purged from the database. Essentially, a rollup represents raw data in a continuous range of dates. There can be no gaps in the range over which the rollups calculate. Continuous means that every raw data value that exists over a time range is accounted for in the rollup. If the raw data has gaps, the rollup may have gaps as well, but is still considered continuous because it reflects the underlying lack of data. Detailed Procedures Logging in 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 in to the Metasys Advanced Reporting System for the first time, log in to the Metasys system ADX or ODS and accept the license agreement. If you attempt to log in to the reporting system before performing this action, the login fails with a message prompting you to log in to the ADX or ODS and accept the license agreement. Note: To log in to the Metasys Advanced Reporting system, you must have the Advanced Reporting privilege, and your access type must have Standard Access in the Metasys Security Administrator System. See Security Administration. 2. Access the Login screen using one of the following methods: In the Metasys system User Interface, select Tools > Advanced Reporting. Enter the Metasys Advanced Reporting System address in a web browser: Note: Starting at Release 6.0, you use the Launcher instead of a web browser to reach the login screen for the Site Management Portal user interface. Refer to the Launcher Installation Instructions (LIT ). The Login screen appears. Note: If you cannot access the Reporting system using the method described here, see the entry in Metasys Advanced Reporting System Troubleshooting. 3. Type your Metasys system user name and password. 4. Click Login. The system authenticates your user name and password and checks if you have proper authorization. If you have proper authorization, the Reports tab appears. Notes: A message appears if you do not have authorization to access the reporting system. If you are in the system and a timeout message appears, you must log back in to the system to create and view reports. 42

43 Setting up Energy Essentials You must set up an Energy Essentials user view in Metasys SMP, map points in those user views to the reporting system, and configure report data before you run a report. You can perform all set up steps at once, or you can create the user view and add only the folders/points that you need for specific reports, as time permits. See Energy Essentials Workflow for details on the complete list of steps related to installing and setting up Energy Essentials. See Energy Essentials Setup Considerations for details on site configuration changes and point adjustments you may have to make before using Energy Essentials effectively. To set up Energy Essentials, start with Creating an Energy Essentials User View. Creating an Energy Essentials User View Energy Essentials relies on Metasys system user view data for report content. We recommend you create a new user view solely for Energy Essentials; but if you have existing user views that contain the required data, you can use the existing user views. This section explains the recommended procedure for creating a user view exclusively used for Energy Essentials. See Energy Essentials Workflow for details on the complete list of steps related to installing and setting up Energy Essentials. See Energy Essentials Setup Considerations for details on site configuration changes and point adjustments you may have to make before using Energy Essentials effectively. Note: This procedure assumes that you create user views online and then upload the changes to the SCT. You can create user views offline using SCT, but Global Search and Tailored Summaries are not available in SCT and can be useful when working with user views. If you create the user view using SCT, wait for the default reporting system refresh at 3:15 A.M. or see Refreshing the Metasys Advanced Reporting System Data Manually to force a manual refresh. A download to the ADX or ODS is recommended but not required to use Energy Essentials. To create an Energy Essentials user view: 1. Make sure you installed or upgraded your Metasys Advanced Reporting System ADX or ODS and installed Energy Essentials at the same release. See Energy Essentials Workflow. 2. In the Site Management Portal UI of your Site Director ADX or ODS, on the Insert menu, click User View. The Create New User View wizard appears. Refer to the Metasys SCT Help (LIT ) for details on using this wizard. Figure 20: Energy Essentials User View 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 SCT Help (LIT ) 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. 43