| Вид документа | Керівництво користувача |
|---|---|
| Виробник | JCI |
| Код документа | metasys-export-utility-help |
| Група обладнання | Metasys Export Utility |
| Сторінок | 73 |
| Мова документа | англійська |
| Розмір файлу | 3.8 МБ |
Текст документа
Metasys® Export Utility Help
MS-EXPORT-0 Code No. LIT-1201952
Software Release 9.0
Issued August 2017
Export Utility Help......................................................................................................................2
Summary of Changes................................................................................................................2
Export Utility Overview..............................................................................................................2
Concepts.....................................................................................................................................2
Export Utility Related Documentation..............................................................................................2
Export Utility System Requirements.................................................................................................3
Export Utility Technical Specifications.............................................................................................3
Export Utility User Interface...............................................................................................................4
Export Utility Supported File Formats..............................................................................................4
Export Utility Authentication.............................................................................................................5
Export Utility Definition File...............................................................................................................5
Scheduler.............................................................................................................................................5
Performance Considerations.............................................................................................................5
Recommendations................................................................................................................................6
Custom Report Capabilities...............................................................................................................6
Billing Example File...............................................................................................................................6
DLLR Example Files.............................................................................................................................6
System Tray Icon.................................................................................................................................9
Detailed Procedures................................................................................................................10
Logging in to the Metasys System through Export Utility............................................................10
Creating a New Export Utility Definition.........................................................................................11
Selecting Trend Data..........................................................................................................................13
Selecting Alarm and/or Audit Data......................................................................................................17
Example Expressions.........................................................................................................................31
Selecting File Formats for Output.......................................................................................................31
Creating a New Schedule.................................................................................................................34
Export Scheduling Options.................................................................................................................34
Scheduler............................................................................................................................................36
Modifying an Existing Export Utility Definition..............................................................................37
Modifying an Existing Schedule......................................................................................................38
Creating Custom Reports Using the Component Interface..........................................................38
Referencing the DLL File from a VBA Project.....................................................................................38
Using the Billing Report Example File.................................................................................................42
Using the DLLR Example Files...........................................................................................................42
Using the Scheduler Service from the System Tray......................................................................67
Displaying the Help File, About Window, or Exiting Export Utility..............................................68
Troubleshooting.......................................................................................................................68
Error Messages, Problems, and the Error Log..............................................................................68
Index..........................................................................................................................................72
Metasys® Export Utility Help 1
Export Utility Help
Welcome to the Metasys® Export Utility Help document.
This Help document describes how to use Metasys Export Utility to extract historical data for export to several
software file formats. This Help system does not contain any information on configuring or working with the Network
Automation Engine (NAE), Network Integration Engine (NIE), Network Control Engine (NCE), Application and Data
Server/Extended Application and Data Server (ADS/ADX), or Open Data Server (ODS).
Note: Unless otherwise noted, the term engine refers to all NAE, NIE, and NCE models. Server refers to all ADS,
ADX, and ODS models.
Summary of Changes
Supported programs and servers were updated in Table 2.
Export Utility Overview
Export Utility is a Microsoft® Windows® based application that uses Web Services to extract the data from the
Metasys system. The application runs from an ADS/ADX, ADS-Lite, ODS, or from a stand-alone computer on the
same network.
Export Utility extracts historical trend, alarm, and audit data from the NAE/NIE/NCE, ADS/ADX, or ODS. This data
is provided in several file formats, such as Microsoft Excel® spreadsheet (.xls) and Access database (.mdb). You
can instantly extract the selected data or schedule an extraction at a convenient time or interval.
Concepts
Export Utility Related Documentation
Table 1 lists documentation related to Export Utility.
Table 1: Export Utility Documentation
For Information On See Document
Metasys System Requirements Metasys® System Configuration Guide (LIT-12011832)
Demand Limiting Load Rolling (DLLR) DLLR Technical Bulletin (LIT-12011288)
ADS/ADX Installation Metasys® Server Installation and Upgrade Instructions Wizard
1
(LIT-12012162)
SCT Installation SCT Installation and Upgrade Instructions (LIT-12012067)
ADS-Lite Installation Metasys Server Lite Installation and Upgrade Instructions Wizard
1
(LIT-12012258)
Open Data Server System (ODS) Installation ODS Installation and Upgrade Instructions Wizard (LIT-12011945)
1
Trends Trend Extensions section of the Metasys® SMP Help (LIT-1201793)
2
Alarms Alarm and Event Management section of the Metasys® SMP Help
2
(LIT-1201793)
Audits Audit Trail section of the Metasys® SMP Help (LIT-1201793)
2
Export Utility License Activation Software License Activator Technical Bulletin (LIT-1201654)
Metasys Advanced Reporting System and Energy Metasys® Advanced Reporting System and Energy Essentials Help
Essentials (LIT-12011312)
2
1 Use the wizard to generate instructions specific to your system.
2 This LIT number represents a printer-friendly version of the Help.
Metasys® Export Utility Help 2
Export Utility System Requirements
All Metasys® system devices from which you are extracting data must be at Release 2.0 or later. See Export Utility
Technical Specifications for details.
Export Utility Technical Specifications
Table 2: Export Utility System Requirements
Product Code MS-EXPORT-0
Recommended Intel® Core™ 2 Duo E6700 or better (Intel Core 2 Duo E4300 minimum)
1
Computer/Server Platform 20 GB free hard disk space available (600 MB minimum)
DVD drive
When Export Utility is installed on an Application and Data Server/Extended Application and
Data Server (ADS/ADX), follow the requirements for an ADS/ADX. Refer to the Application
and Data Server (ADS/ADX) Product Bulletin (LIT-1201525), the Application and Data Server
(ADS) Lite for Europe (E) Product Bulletin (LIT-12011690), or the Application and Data Server
(ADS) Lite for Asia (A) System Product Bulletin (LIT-12011694).
When Export Utility is installed on an Open Data Server (ODS), follow the requirements for
an ODS. Refer to the Open Data Server (ODS) Product Bulletin (LIT-12011943).
Recommended Memory
1 Computer Platforms: 2 GB RAM (1 GB RAM minimum)
Server Platforms: 4 GB RAM (2 GB RAM minimum)
Supported Operating Systems Windows® 10 Pro and Enterprise Editions with Anniversary Update (version 1607) (64-bit)
Note: The Windows 10 Anniversary Update (version 1607) is required for any Windows 10
computer that runs Metasys software, including the ADS/ADX/ODS. Verify this update
is installed before installing or upgrading Metasys software. From the Start Menu,
type Winver in the Windows search bar. Click Winver to open About Windows.
If you are upgrading Metasys software before installing this update, you must do the
following:
1. uninstall the previous versions of all Metasys software
2. install the Windows 10 Anniversary Update (version 1607)
3. install the latest Metasys software
Windows® 8.1 Pro and Enterprise Editions with Update 1 (64-bit)
Windows® 7 Professional, Enterprise, and Ultimate Editions with SP1 (64-bit)
Windows® 7 Professional, Enterprise, and Ultimate Editions with SP1 (32-bit)
Windows® Server® 2016 (64-bit)
Windows® Server® 2012 R2 with Update 1 (64-bit)
Windows® Server® 2012 (64-bit)
Metasys® Export Utility Help 3
Table 2: Export Utility System Requirements
Additional Software Included Microsoft .NET Framework version 3.5 SP1
on the Product Disks
For steps on installing .NET Framework version 3.5 SP1, refer to the Metasys® Server
Installation and Upgrade Instructions Wizard (LIT-12012162), ADS-Lite Installation and
Upgrade Instructions Wizard (LIT-12011688), or the ODS and SCT Installation and Upgrade
Instructions Wizard (LIT-12011945).
Note: Windows 10, Windows 8.1, Windows 7, Windows Server 2016, Windows Server 2012
R2, and Windows Server 2012 include Microsoft .NET Framework version 3.5/3.5.1.
These applications are built into the operating system (no separate software
installation is necessary). We recommend you also install Microsoft .NET Framework
version 4.5 if you are using Windows 8.1, Windows Server 2012 R2, or Windows
Server 2012 and Microsoft .NET Framework version 4.6.1 if you are using Windows
10.
Additional Requirements (Order Microsoft Office Professional 2013, Microsoft Office Enterprise 365, Microsoft Office
Separately) Professional 2007, Microsoft Office Professional 2010 software to generate reports
Note: • To extract data to Microsoft Excel or Microsoft Access software, you must have
the Microsoft software installed on the computer that is running Export Utility.
• Export Utility can extract data to 32-bit and 64-bit versions of Microsoft Office.
However, the dynamic-link library (DLL) file and example files used to create
custom reports are compatible only with the 32-bit version of Microsoft Office.
1 Our computer platform and memory recommendations are not meant to imply that older or slower machines are not usable.
Refer to the Network and IT Guidance for the BAS Professional Technical Bulletin (LIT-12011279) for more information
regarding computer or server recommendations.
Export Utility User Interface
The Export Utility UI has a wizard-type format that allows the user to enter definition parameters, schedule information,
and provide a means for saving and exporting the definition. Filters allow you to quickly select the data you wish to
extract. The user interface allows you to select one or many output file formats.
Many windows contain two tabs: Basic and Advanced. In most cases, the Basic tab contains options to quickly select
basic data for extraction, and the Advanced tab provides additional, but not required, filtering options from which
you can narrow the data to export.
User view trees only display objects relevant to the type of data you choose to extract.
Export Utility Supported File Formats
Export Utility extracts user-defined data to any of the following file formats:
• Microsoft Excel (.xls)
• Tab-delimited text (.txt)
• Comma-separated value (.csv)
• Microsoft Access (.mdb)
• HTML (.htm)
• XML version 1.0 (.xml)
Metasys® Export Utility Help 4
Note: • If you change the extension on the Advanced tab of the Export Output Selection dialog box, Export Utility
only creates output reports using the supported extension types. For example, if you rename a .htm file
extension with a .html extension on the Advanced tab, Export Utility creates the file with a .htm extension.
• Scheduled Export using the Excel format (.xls) is not supported on server-class operating systems.
Scheduled Export using Excel format is also not supported on Windows 8.1 when running on a VM. All
other export formats are supported. We recommend using .csv format for the Scheduled Export and then
manually importing the .csv file into Excel and saving it in Excel format.
• Windows 10, Windows 8.1, Windows Server 2016, Windows Server 2012 R2, Windows Server 2012
support On Demand Export using Excel format.
Export Utility Authentication
You must have login credentials with the Site Director as well as permissions to view the data to be extracted with
Export Utility. You must know the IP address or the host name of the Site Director. Export Utility follows Metasys
system authentication, using the same user name and password. If login fails, contact your Metasys system
administrator.
Export Utility Definition File
All of the export selections, such as points, date/time range, and filters, are stored in an Export Utility Definition
(EUD) file. You can export data directly using this EUD file at any time or at a predefined schedule interval through
the Scheduler service. The Scheduler runs continuously to check for any executable schedules.
Definition files are also required when using the custom programming capabilities of Export Utility.
Note: When creating an EUD file, the user login credentials used to create the EUD file must persist. If the user
login credentials are deleted, the EUD file no longer works.
Scheduler
You may schedule data collection at a predefined time (for example, every day at 1:00 A.M.). The Scheduler
component maintains a schedule file with the following information: encrypted Web Services authentication details,
Export Utility definition file name, date, time, and interval. The Scheduler reads the Export Utility definition file
whenever a schedule is defined or an existing schedule is modified.
For scheduling, the computer must remain connected to the network while data is being extracted from the engine
or server.
Note: Export Utility does not support writing reports to network drives on Novell® client computers.
Performance Considerations
When extracting audit data from a Metasys system that has over 10,000 audits, Export Utility requires more time to
parse and extract the data. Also, when you select the Annotations export attribute, additional time is necessary.
When Export Utility extracts this data, the central processing unit (CPU) use of the server is high, which affects the
performance of a server; however, the Metasys system continues to run.
Note: These considerations are not an issue for engines because engines typically hold only 500 audit records.
In a lab environment with the following platform, we observed these audit extraction times (Table 3):
• Operating System: Windows® 7 Professional, Enterprise, and Ultimate Editions with SP1 (32-bit)
• CPU Type: Pentium® 4 processor, 2 GHz
• Memory: 1 GB RAM
Metasys® Export Utility Help 5
Table 3: Audit Extraction Times
Audit Extraction Type Total Time of Extraction
10,000 audit entries without annotations 22 minutes
10,000 audit entries with annotations 31 minutes
Recommendations
When you extract audit data:
• Use the scheduling service to extract the data at a time when the Metasys system is not busy (for example,
during off-peak hours when users are not logged in to the system).
• Do not schedule the extraction of data near the engine’s ADS Delivery Time because this time is when the engine
transfers its information to the server. By default, each engine’s ADS Delivery Time is 12:15 A.M.
• Choose the Annotations export attribute only when necessary, as this attribute requires additional time to retrieve
data.
Custom Report Capabilities
A programming interface to Export Utility is provided so that you can develop programs to create custom reports.
To help you get started, easily customized example files are included for billing reports and demand limiting load
rolling (DLLR) energy reports.
Export Utility can import data into third-party applications that support the Microsoft .NET Framework. This compatibility
allows you to write applications for Microsoft Visual Basic, Excel, or Access to extract Metasys system historical
data.
Note: Export Utility can extract data to Microsoft Office 32-bit and 64-bit versions. However, the DLL file and example
files used to create custom reports are compatible with Microsoft Office 32-bit version only.
See Creating Custom Reports Using the Component Interface.
Billing Example File
The Billing Report Example.xls file is located in:
C:\ProgramData\Johnson Controls\MetasysIII\MEU\DLL Examples
The billing example file provides an example of how the Export Utility DLL component can be used with VBA in
Microsoft Excel software to create a billing report.
This report is not intended to be used as is, but rather serves as a template or starting point for less experienced
developers and to show them how to use the Export Utility DLL. Use or modify Billing Report Example.xls and its
VBA code to meet your specific needs.
See Creating Custom Reports Using the Component Interface.
DLLR Example Files
Note: Microsoft Excel 2010 and Excel 2013 do not support the use of DLLR example files.
The DLLR example files are working examples of how the Export Utility DLL component can be used with Excel
software to provide an automated DLLR energy report. The report is based on historical information from the Metasys
DLLR object using a Demand Limiting Sliding Window algorithm.
The DLLR example files retrieve and display one month of data only. The files can be used easily without modification
but still allow you to adjust or modify the file to meet your needs.
Metasys® Export Utility Help 6
The DLLR example files are located in:
C:\ProgramData\Johnson Controls\MetasysIII\MEU\DLL Examples
The sample files are:
• DLLR_Excel 97-2003.xls: for use with Excel 97 through Excel 2003 software
• DLLR_Excel 2007.xlsm: for use with Excel 2007 software
For more information on DLLR, refer to the DLLR Technical Bulletin (LIT-12011288).
See Creating Custom Reports Using the Component Interface for information on using the example files.
Sheets in the DLLR Example Files
Important: Do not rename these sheets. Changing the names of the sheets breaks the references within the VBA
code. The example files do not work properly if these references are broken.
Each DLLR example files contain the following Excel sheets:
Energy Report
This sheet displays the DLLR energy report output in chart form after you run the report.
Daily Data
This sheet contains a numerical representation of the data displayed on the Energy Report sheet in 1-day increments.
Data by Minute
This sheet contains a numerical representation of the data displayed on the Energy Report sheet in 1-minute
increments.
Configuration
This sheet allows you to configure the DLLR energy report parameters. See Configuring the DLLR Example Files.
Example DLLR Energy Report Output
Note: Microsoft Excel 2010 and Excel 2013 do not support the use of DLLR example files.
The DLLR example files output a DLLR energy report similar to the one shown in Figure 1.
Metasys® Export Utility Help 7
Figure 1: Example DLLR Energy Report Chart
DLLR Energy Report Features
The DLLR energy report offers the following features:
Status Bar Indication
While running the DLLR energy report, the status bar of the Excel file indicates the current actions.
For example, the following status messages may appear:
• Logging into Metasys
• Login to Metasys successful
• Retrieving data
• Export of Data successful
Daily Data Conditional Formatting
The Daily Data sheet provides two types of conditional formatting. In each column, with the exception of the Date
column, the cells with the highest value are red.
In each row, if no entry in the Date column exists, the rest of the row is black.
Note: In Excel 97-2003, only the Date column is black, because these Excel software versions do not support
multiple conditional formatting.
Configuration Cell Verification
Metasys® Export Utility Help 8
The Report Start and End Dates cells contain validation to warn against entering dates manually (Figure 2). If dates
are entered manually, the formulas that provide automation for custom or non-custom dates are lost.
Note: The DLLR example files use the Microsoft Calendar control (mscal.ocx) that comes with and is registered
automatically by the Microsoft Access component of Microsoft Office software. If this control is not installed
and registered, the example files yield VBA missing reference errors.
Figure 2: Cell Verification
The example files offer visual indication if the DLLR energy report interval you request is more than one month. This
invalid report interval is identified by the Report End Date highlighted in red (Figure 3).
Figure 3: Invalid Report Interval
System Tray Icon
By using the system tray icon, you can view a schedule and start, stop, and exit the Scheduler service, but you
cannot modify or create new schedules or access any Export Utility definition files. The Export Utility system tray
icon border is green when the Scheduler service is running; otherwise, it appears red. See the Using the Scheduler
Service from the System Tray section for more information.
Metasys® Export Utility Help 9
Detailed Procedures
Logging in to the Metasys System through Export Utility
This procedure allows you to open Export Utility and log in to the Metasys system to access data.
The Log In window displays two pieces of important information in the bottom bar: the result of the login attempt
appears on the left side, and the privileges assigned to the user currently logged in appears on the right side. If a
login attempt fails, contact your Metasys system administrator. See Table 4 for details.
To log in to the Metasys system through Export Utility:
1. On the Windows Start Menu, browse to Programs > Johnson Controls > Metasys > Metasys Export Utility.
The Log In window appears (Figure 4).
Figure 4: Log In Window
2. Enter the name or IP address of the Site Director and the Metasys system user name and password. (Passwords
are case sensitive.)
Note: If your IT department uses a port other than Port 80 (default), enter a colon followed by the port number
after the Site Director IP address (for example, 172.17.13.233:8080). If you do not enter a port number,
the default port is used (Port 80).
Note: If the time on your computer is out of sync with the server by more than 5 minutes, you cannot log in to
Export Utility. Adjust the time to match the server and try again. For information on time synchronization,
refer to the Time Management section of the Metasys® SMP Help (LIT-1201793).
3. Click Log In. When the connection is successful, Continue becomes active. For information on the status bar
at the bottom of the Log In window, see Table 4.
Table 4: Access - User Privileges
User Privilege Meaning
Access You need to enter the Site Director and login information, then click Log In.
Access Denied Your login attempt fails for a reason other than those listed in this table and
the error message Log in to Metasys failed appears.
View Audit Only You can view audit data only.
Metasys Account Expired Your Metasys system account is expired and the error message Log in to
Metasys failed appears.
Metasys® Export Utility Help 10
Table 4: Access - User Privileges
User Privilege Meaning
Metasys Account Disabled Your Metasys system account is disabled and the error message Log in
to Metasys failed appears.
Metasys Account Locked Your Metasys system account is locked and the error message Log in to
Metasys failed appears.
View All You can view all Metasys system information and export all trend, alarm, and
audit data.
4. Click Continue. The Export Definition Selection window appears.
Figure 5: Export Definition Selection Window
5. Proceed to one of the following sections:
Creating a New Export Utility Definition
Modifying an Existing Export Utility Definition
Creating the Export Utility Definition (EUD) File (Step 2)
Creating a New Export Utility Definition
To extract the desired data from the Metasys system for export to a file, the first step is to create an Export Utility
definition file. This definition file specifies all of the information required to extract the data.
1. On the Export Definition Selection window, click New Definition (Figure 5).
2. Click Next. The Export Time Duration - Basic tab appears (Figure 6).
Metasys® Export Utility Help 11
Figure 6: Export Time Duration - Basic Tab
3. Select one of the frequently used intervals from the drop-down menu using information in Table 5.
Table 5: Frequently Used Intervals
Interval
1 Result
Today Extracts data for the day Export Utility is run.
Yesterday Extracts data for the calendar day before Export Utility is run.
Last Week Extracts data for the week before Export Utility is run.
Last Two Weeks Extracts data for the two weeks before Export Utility is run.
Last Month Extracts data for the calendar month before Export Utility is run.
Last Quarter Extracts data for the last quarter before Export Utility is run. Quarters are defined as follows:
• 1 = January 1 - March 31
• 2 = April 1 - June 30
• 3 = July 1 - September 30
• 4 = October 1 - December 31
Last Year Extracts data for the last calendar year before Export Utility is run.
Choose Date Extracts data for the dates you choose from the pop-up calendar. Click the calendar icon
to the right of the Start Date and End Date fields.
Note: This interval is the only interval that allows the user to input data into the Start
Date and End Date fields.
All Available Extracts data for the entire history of the device to the current day.
1 Frequently Used Intervals are relative. For instance, if you choose Last Month, the user interface shows the last month
relative to the current month. If scheduled, however, the Scheduler determines Last Month at runtime.
4. Click the Advanced tab (Figure 7) if you wish to narrow the date/time range chosen on the Basic tab. Select or
clear days of the week check boxes for which you wish to extract the data. Narrow the time for which Export
Utility extracts data using the drop-down menus for the Start and End Time fields (from 12:00 A.M. to the present
Metasys® Export Utility Help 12
time), as defined by the system clock of the computer running Export Utility. For example, if the computer uses
the 24-hour clock (military time), make sure you click the 24 Hrs field in the Time section of the Advanced tab.
Example: To extract data only for the operating hours of a building, change the Start Time to 8:00 A.M. and the
End Time to 5:00 P.M.
Figure 7: Export Time Duration - Advanced Tab (Default Selections)
5. Click OK on the Advanced tab to return to the Basic tab.
6. On the Basic tab, click Next. The Data Type Selection window appears.
7. Click the option button for the type of data that you wish to export, Trend or Alarm/Audit, and click Next. Trend
extracts trend data, and Alarm/Audit extracts alarm and audit data.
8. Proceed to one of the following sections:
Selecting Trend Data
Example Expressions
Selecting Trend Data
The Select Trend Data window has two tabs: Basic and Advanced. The Basic tab has two panes. The Trend Point
Selection pane displays the navigation views that are available to you, but they only display objects that have trend
extensions associated with them. The Export Data for the following points pane lists the trend objects that you
select, using either the Trend Point Selection view or the filtering applied from the Advanced tab. Export Utility
extracts data from these trend objects.
The Advanced tab provides additional, but not required, filtering options so that the user can narrow the data to
export.
Metasys® Export Utility Help 13
Note: If communication cannot be established to a trend object (for example, the engine is offline and you cannot
select its temperature trend), create the definition after communication is restored.
1. On the Basic tab of the Export Summary and Save Definition File window, click the devices or points in the left
pane for which you wish to have the data exported, and click Add (Figure 8). The selected devices and points
appear in the right pane.
Figure 8: Export Summary and Save Definition File Window
2. On the Advanced tab, select a desired attribute filtering option from the drop-down menu. The attributes are
based on the Metasys system Object Name.
3. Specify the filtering criteria for each reference point for the corresponding Value field.
Note: The value field supports wildcards (*). For example, set up a filter of Field Point = *-T to extract all trends
on temperature (-T) points.
4. Add a new filter row by entering a value for the last filter. (Click Remove Filter to remove the current row of
filtering.)
5. Add the following relational operators to narrow the filtering criteria in the expression: AND, OR, NOT.
Figure 9 shows filtering to return trend data for all objects on any NIE engine, on the N1 Migration1 trunk, and
on the UNT-004 controller that are trended on the Present Value attribute.
Metasys® Export Utility Help 14
Figure 9: Trend Example
Metasys® Export Utility Help 15
Figure 10: Trend Output File in Excel
Figure 11: Trend Chart Output File in Excel
Metasys® Export Utility Help 16
Note: The Excel output file for trends is unique. The Date/Time columns are combined, and there is a column
for each trend object. The column heading is the Name Path Reference with units in parentheses. Cells
with data with a status other than Reliable appear with a red fill. Cells with Reliable status have no fill.
Use the Excel Chart wizard to develop trend charts: highlight the appropriate cells, click Chart Wizard,
and follow the instructions.
6. To retrieve less data than what may be stored in the system, select the Export Interval check box to change the
sampling interval, and select the desired interval in hours and minutes from the drop-down menus.
For example, if a trend is sampled once a minute in Metasys system, but you only need data for every half hour,
select the Export Interval check box, and choose 30 minutes from the drop-down menu.
7. After you complete filters on the Advanced tab, click OK. The Basic tab appears with the filter results in the
Export Date for the following points pane.
8. Check the desired General and Trend attributes using Table 6.
Table 6: General and Trend Attributes
Attribute Meaning
Date
1 Display together in the first column of the output file.
1
Time
MM/DD/YYYY Drop-Down Menu Allows you to select the date format. For example, August 18, 2010, appears as:
MM/DD/YYYY 08/18/2010
MM/DD/YY 08/18/10
DD/MM/YY 18/08/10
YY/MM/DD 10/08/18
12 Hrs, 24 Hrs Selection Displays the time in 12-hour or 24-hour format. Select the same time format that is used
on the Site Director computer.
Name Path Reference Displays the unique reference name for the trend object as a full path of the object based
on the Metasys system All Items View. For example: WeCare4U:AC1/N2 Trunk
1.UNT-1.0A-%.Present Value
Note: Name Path Reference should not be confused with the Metasys system Fully
Qualified Reference.
Object Name Displays trend object names (for example, OA-T.Present Value [Trend1])
Value
1 Displays the numeric values of the trend objects.
Status Displays the status of the trend object at the time the sample is taken (for example,
Reliable or ???).
1 This option is always selected by default.
9. Click Next. The Export Output Selection window appears. Proceed to Selecting File Formats for Output.
Selecting Alarm and/or Audit Data
See Performance Considerations for extracting audit data before you begin.
The Alarm/Audit Data Selection window has three main options for extracting data: Alarm, Audit, and Both.
Metasys® Export Utility Help 17
• Alarm extracts alarm data only. Audit parameters are hidden. The Basic tab has two subtabs: Point Selection
and Alarm Selection.
• Audit extracts audit data only. Alarm parameters are hidden. The Basic tab has two subtabs: Audit Selection
and User Selection. The point selection device is disabled because audits are device-specific, not point-specific.
• Both extracts alarm and audit data. When you choose the Both option, the Basic tab displays all four tabs relating
to alarms and audits, Point Selection, Alarm Selection, Audit Selection, and User Selection. All parameters are
available, and extracted data appears in a single output file format. For example, if you choose HTML as the
output file type, the result is an Alarm report with an Audit report that follows.
Depending on which you select, some tabs disable (including the Advanced tab) because additional filtering is not
necessary. The Advanced tab provides additional, but not required, filtering options so that the user can narrow the
data to export.
Selecting Both Alarm and Audit Data
When you choose the Both option, the Basic tab displays all four tabs relating to alarms and audits: Point Selection,
Alarm Selection, Audit Selection, and User Selection. To select both alarm and audit data, follow these steps:
1. Click Both.
2. On the Basic tab, select options on the four tabs using the instructions in the following sections: Selecting Alarm
Data and Selecting Audit Data.
3. Click Next. The Output Selection window appears. Proceed to Selecting File Formats for Output.
Metasys® Export Utility Help 18
Selecting Alarm Data
Figure 12: Alarm/Audit Data Selection - Basic and Point Selection Tabs
1. Click Alarm.
2. If desired, select the Get All Alarms check box to extract data for all available alarms. (This disables all filtering
options.)
3. On the Basic tab, click the Point Selection tab. Click the individual devices or points in the Alarm Point Selection
pane for which you wish to have the data exported, and click Add. The devices or points that you select appear
in the Export Data for the following points pane.
Note: Choose at least one object on the Point Selection tab to ensure that output files contain some data.
4. On the Basic tab, click the Alarm Selection tab. Using Table 7, select one or more types of alarms whose data
you wish to export for the devices/points chosen on the Point Selection tab.
Note: Select at least one alarm data type on the Alarm Selection tab to ensure that output files contain some
data.
Metasys® Export Utility Help 19
Figure 13: Alarm/Audit Data Selection - Basic and Alarm Selection Tabs
Table 7: Alarm Selection Tab
Item Effect
Select All Selects all data types, except the Alarm Priority.
Clear All Deselects all data types.
Unacknowledged Alarms Includes all alarms that have not been acknowledged. These entries appear with white
fill in the Metasys system Event Viewer.
Acknowledged Alarms Includes all alarms that have been acknowledged. These entries appear with gray fill
in the Metasys system Event Viewer.
Discarded Alarm Includes all alarms that have been discarded. Entries no longer appear in the Metasys
system Event Viewer.
Alarm Includes all alarms with an alarm type of Alarm.
High Alarm Includes all alarms with an alarm type of High Alarm.
Low Alarm Includes all alarms with an alarm type of Low Alarm.
Normal Includes all alarms with an alarm type of Normal.
Metasys® Export Utility Help 20
Table 7: Alarm Selection Tab
Item Effect
High Warn Includes all alarms with an alarm type of High Warning.
Low Warn Includes all alarms with an alarm type of Low Warning.
Online Includes all alarms with an alarm type of Online.
Offline Includes all alarms with an alarm type of Offline.
Alarm Priority Includes all alarms in the set priority range.
Example: To extract alarm data for entries with an alarm priority greater than or equal
to 100, choose the >= operator and enter 100 in the value field.
5. Click the Advanced tab, and select a desired reference point filtering option from the drop-down menu using
Table 8.
Table 8: Alarm Attributes for Filtering
Attribute Description
Alarm Object Select this option to filter on the alarm object’s name path reference.
For example, select Alarm Object and type *ZN-T in the Value field to extract all data
on alarm objects that end with ZN-T, or zone temperatures.
Alarm Value Select this option to filter on the alarm value using the relational operand that becomes
enabled.
For example, select Alarm Value >= and place 80 in the Value field to extract data on
only those alarms greater than or equal to 80.
Alarm Text Select this option to filter on alarm text as defined in the Metasys system alarm
messages.
For example, in the Metasys system, place the word critical in the alarm text for your
most critical alarms, then select Alarm Text from the drop-down menu and type *critical*
in the Value field to extract data with that text in the alarms.
Metasys® Export Utility Help 21
Figure 14: Alarm/Audit Data Selection - Advanced Tab
6. Specify the filtering criteria for each reference point for the corresponding value field. See Example Expressions.
Note: The Value field supports wildcards (*).
7. Add a new filter row by entering a value for the last filter. (Click Remove Filter to remove the current row of
filtering.)
8. Add the following relational operators using Table 9 to narrow the filtering criteria in the expression: AND, OR,
NOT. (Relational operators only apply to Alarm Value.)
Table 9: Relational Operators
Relational Operator Meaning
= Equal to
!= Not equal to
>= Greater than or equal to
<= Less than or equal to
> Greater than
< Less than
Metasys® Export Utility Help 22
Figure 15: Alarm Filter Example
Note: This figure represents an advanced alarm filter that would return data for all alarm objects ending in -T
(all temperatures) that were in alarm at a value of 80 degrees or higher, but did not include the word
Non-Critical in its Alarm Text.
9. After you complete filters on the Advanced tab, click OK. The Basic tab appears with the filter results in the right
pane.
10. Select the desired Alarm Export attributes according to Table 10. These attributes appear as column headings
for the output files. The default column headings are Date, Time, and Value.
Table 10: Alarm Export Attributes
Attribute Meaning
Name Path Reference
1 Displays the unique reference name for the alarm object that is the full path name of
the Metasys system All Items View.
For example, WeCare4U:AC1/N2 Trunk 1.UNT-1.DA-T.Present Value
Object Name
1 Displays the alarm object names.
For example, DA-T.
Acknowledge Req Displays whether or not the alarms required acknowledgment (True/False).
Acknowledge Status Displays the status indicating if an alarm was acknowledged (True/False).
Object Value Displays the alarm object value (for example, 98).
Object Units Displays the alarm object value units of measure (for example, deg F).
Metasys® Export Utility Help 23
Table 10: Alarm Export Attributes
Attribute Meaning
Alarm Description Displays the alarm object description which is the Metasys system Description for the
alarm object.
For example, instead of choosing an object name column which displays ZN-T, you
can select this to display Zone Temperature.
Annotation
2 Displays the alarm annotations one after the other in the following format: Date/Time:
<user>:<annotation>
For example, 8/4/2010 8:37:27 AM : metasyssysagent : Determined the freezestat was
faulty 8/4/2010 8:37:45 AM : metasyssysagent : Replaced the freezestat
Note: Selecting the Annotation option may take up to five times longer to export
alarm/event messages with annotations than without annotations.
Alarm Type Displays the alarm types (for example, Online, Offline, Alarm, High Alarm).
Alarm Priority Displays the alarm priorities which are numbers defined in the Metasys system.
Alarm Text Displays the alarm text messages for each alarm that are defined in the Metasys system.
1 This option is always selected by default.
2 For Microsoft Access output files, text entries are limited to 255 characters. If the number of characters is greater than
255, an ellipsis appears at the end of the cell.
11. Click Next. The Output Selection window appears. Proceed to Selecting File Formats for Output.
Selecting Audit Data
For Audit selection, the Basic tab has two subtabs: Audit Selection and User Selection.
Consider the following when selecting users:
• Make sure that you are logged in to the Site Director (from the Log In window). If you are logged in to another
supervisory device, you may not be accessing the correct user list.
• The default Metasys system user name is MetasysSysAgent, and this user account cannot be deleted. This
account is typically used by a Johnson Controls® representative.
• IntraComputer is the default Metasys system user that supervisory devices use to communicate with the Site
Director. The most common audit entry for IntraComputer is User Password Changed when supervisory devices
change their internal passwords for Metasys system security. Check the Metasys system Audit Viewer for other
types of entries and select this user as necessary.
• The [Blank User Name] option can be selected for retrieving audit entries that were associated to no user. For
instance, audit entries related to a supervisory device resetting, such as Startup, are entered without a user
assigned. Check the Metasys system Audit Viewer for other types of these entries, and select this non-user as
necessary.
To select audit data:
1. Click Audit.
2. Click Get All Audits if you wish to extract data for all available audits. (This option disables all filtering options.)
3. Click the User Selection tab (Figure 16). All users that appear in the User Selection list box are the users defined
in the Metasys system of the supervisory device that you are logged into.
Metasys® Export Utility Help 24
Figure 16: User Selection Tab
4. Click users in the left pane, and click Add. The selected users appear in the Export Data for the following
users pane.
5. On the Basic tab, click the Audit Selection tab (Figure 17). Using information in Table 11, select one or more
of the check boxes to extract the desired audit data.
Note: You must choose at least one action type on the Audit Selection tab (Figure 17) for output files to contain
data.
Metasys® Export Utility Help 25
Figure 17: Audit Selection Tab
Table 11: Audit Selection
Audit Selection Type Description
General (Correspond with the Metasys system Audit Viewer, Origin Application, General, and MCE entries.)
Uploads Includes all audit entries with an Audit Viewer description of Upload.
Downloads Includes all audit entries with an Audit Viewer description of Download.
Archives Includes all audit entries where a supervisory controller has had its Random Access
Memory written to its flash memory.
For example, when a Logic Connector Tool (LCT) system is saved, an archive audit
entry is created.
Created Objects Includes all audit entries with an Audit Viewer description of Create.
Deleted Objects Includes all audit entries with an Audit Viewer description of Delete.
Metasys® Export Utility Help 26
Table 11: Audit Selection
Audit Selection Type Description
Commands Includes all audit entries with an Audit Viewer description of Command. Commands
normally relate to field points.
For example, select Commands to include all audit entries where a user commanded
a fan Off.
Overrides Includes all audit entries with an Audit Viewer description of Operator Override.
Release Overrides Includes all audit entries with an Audit Viewer description of Release Operator Override.
Write Includes all audit entries with an Audit Viewer description of Write. Write normally relates
to object parameters.
For example, select Write to include all audit entries where the local Site Director has
been changed for a supervisory device.
System Security (Correspond with the Metasys system Audit Viewer Origin Application, System Security entry.)
Log Ins Includes all entries when users logged in to the Metasys system where the Audit Viewer
description is User Login Successful.
Log Outs Includes all entries when users logged out of the Metasys system where the Audit Viewer
description is User Logout.
Failed Login Attempts Includes all entries of failed login attempts where the Audit Viewer description is User
Login Failed.
Note: If the user types in the wrong user name, it is not exported.
Password Changes Includes all entries of changed user passwords where the Audit Viewer description is
User Password Changed.
Alarm and Audit (Correspond with the Metasys system Audit Viewer, Origin Application, Alarm and Event entry.)
Discarded Alarms Includes all audit entries in the Audit Viewer that were discarded from the Event
Repository.
Discarded Audits Includes each entry in the Audit Viewer that indicates an audit was discarded from the
Audit Repository.
Include Detailed Audits Includes all audit entries in the Audit Viewer that were discarded from the Audit
Repository.
Trend (Correspond with the Metasys system Audit Viewer Origin Application, Trend entry.)
Unable to write to Repository Includes all audit entries where supervisory devices cannot transfer trend data to the
defined data repository.
Device Manager (Correspond with the Metasys system Audit Viewer Origin Application, Device Manager entry.)
Controller Reset Includes all audit entries of a controller reset, defined as the Audit Viewer description
of Reset.
Startup Includes all audit entries of a controller being started, defined as the Audit Viewer
description of Startup.
Critical System Events (Correspond with the Metasys system Audit Viewer Origin Application, Critical System
Event entry.)
Critical Events Includes all audit entries defined as the Critical System Event class level.
6. On the Advanced tab, select optional audit filtering options from the drop-down menu using the information in
Table 12.
Metasys® Export Utility Help 27
Table 12: Audit Filtering Options
Attribute Purpose
Audit Object Select this option to filter on the audit object’s name path reference.
For example, select Audit Object and type ADS* in the Value field to extract datПоказано початок документа. Повний текст — у PDF за посиланням вище.
Позиції каталогу з цим документом
Документ виробника, опублікований як довідковий матеріал на обладнання, яке ми постачаємо. Правовласник може попросити прибрати його — приберемо.