Metasys® Export Utility Online Help PDF

MS-EXPORT-0 Code No. LIT-1201952

Software Release 6.0
Issued January 30, 2013
Supersedes May 13, 2011
Refer to the QuickLIT website for the most up-to-date version of this document.

Export Utility Help......................................................................................................................2

Export Utility Overview..............................................................................................................2
Concepts.....................................................................................................................................2
Export Utility Related Documentation..............................................................................................2
Export Utility System Requirements.................................................................................................2
Export Utility Technical Specifications.............................................................................................3
Export Utility User Interface...............................................................................................................3
Export Utility Supported File Formats..............................................................................................4
Export Utility Authentication.............................................................................................................4
Export Utility Definition File...............................................................................................................4
Scheduler.............................................................................................................................................4
Performance Considerations.............................................................................................................5
Recommendations................................................................................................................................5
Custom Report Capabilities...............................................................................................................5
Billing Example File...............................................................................................................................5
DLLR Example Files.............................................................................................................................6
System Tray Icon.................................................................................................................................8
Detailed Procedures..................................................................................................................8
Logging on to the Metasys System through Export Utility.............................................................8
Creating a New Export Utility Definition.........................................................................................10
Selecting Trend Data..........................................................................................................................12
Selecting Alarm and/or Audit Data......................................................................................................16
Example Expressions.........................................................................................................................30
Selecting File Formats for Output.......................................................................................................30
Creating a New Schedule.................................................................................................................33
Export Scheduling Options.................................................................................................................33
Scheduler............................................................................................................................................35
Modifying an Existing Export Utility Definition..............................................................................36
Modifying an Existing Schedule......................................................................................................36
Creating Custom Reports Using the Component Interface..........................................................37
Referencing the DLL File from a VBA Project.....................................................................................37
Using the Billing Report Example File.................................................................................................42
Using the DLLR Example Files...........................................................................................................42
Using the Scheduler Service from the System Tray......................................................................61
Displaying the Help File, About Screen, or Exiting Export Utility................................................62
Troubleshooting.......................................................................................................................62
Error Messages, Problems, and the Error Log..............................................................................62
Index .........................................................................................................................................66

Metasys Export Utility Online Help PDF 1

Export Utility Help
Welcome to the Release 6.0 Metasys® Export Utility Help.
This Help system 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), or Application and Data Server
(ADS)/Extended Application and Data Server (ADX).
Note: In this Help, unless otherwise noted, the term engine refers to all NAE, NIE, and NCE models. Server refers
to all ADS and ADX models.

Export Utility Overview

Export Utility is a Microsoft® Windows® Operating System (OS) based application that uses Web Services to extract
the data from the Metasys system. The application runs from an ADS/ADX, ADS-Lite, or from a stand-alone computer
on the same network.
Export Utility extracts historical trend, alarm, and audit data from the NAE/NIE/NCE or ADS/ADX. This data is then
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 LIT Number
Metasys System Requirements Metasys System Extended Architecture Overview LIT-1201527
Technical Bulletin
Demand Limiting Load Rolling (DLLR) DLLR Technical Bulletin LIT-12011288
ADS/ADX Installation ADS, ADX, and SCT Installation and Upgrade LIT-12011521
1
Instructions Wizard
ADS-Lite Installation ADS-Lite Installation and Upgrade Wizard
1 LIT-12011688

Trends Trend Extensions section of the Metasys system LIT-1201793

2

Help
Alarms Alarm and Event Management section of the LIT-1201793
2

Metasys system Help

Audits Audit Trail section of the Metasys system Help LIT-1201793
2

How to Extract Data in Multiple Formats Metasys Export Utility Help LIT-1201952
2

Export Utility License Activation Software License Activator Technical Bulletin LIT-1201654
Metasys Advanced Reporting System Metasys Advanced Reporting System Help 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.

Export Utility System Requirements

All Metasys system devices from which you are extracting data must be at Release 2.0 or later. See Table 2 for
details.

Metasys Export Utility Online Help PDF 2

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 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).
1 Computer Platforms: 2 GB RAM (1 GB RAM minimum)
Recommended Memory
Server Platforms: 4 GB RAM (2 GB RAM minimum)
Supported Operating Systems Windows 7 OS Professional, Enterprise, and Ultimate Editions (32-bit and 64-bit) with
SP1
(Includes Microsoft Internet Information Services (IIS) Version 7.5)
Windows XP® OS Professional Edition (32-bit) with SP3
(Includes Microsoft IIS Version 5.1)
Windows Server® 2008 R2 OS (64-bit)
(Includes Microsoft IIS Version 7.5)
Windows Server 2008 OS (32-bit) with SP2
(Includes Microsoft IIS Version 7.0)
Windows Server 2003 R2 OS (32-bit) with SP2
(Includes Microsoft IIS Version 6.0)
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 ADS, ADX, and SCT
Installation and Upgrade Instructions Wizard Content (LIT-12011331) or the ADS-Lite
Installation and Upgrade Instructions Wizard Content (LIT-12011689).
Note: The Microsoft Windows 7 OS and Windows Server 2008 R2 OS include Microsoft
.NET Framework Version 3.5.1, which is built into the operating system (no separate
software installation is necessary).
Additional Requirements (Order Microsoft Office Professional 2007 or Microsoft Office Professional 2010 software to generate
Separately) reports
Note: To extract data to Microsoft Excel or Microsoft Access software, you must have the
respective software installed on the computer running Export Utility.
Note: Export Utility can extract data to Microsoft Office 32-bit and 64-bit versions. However,
the dynamic-link library (DLL) file and example files used to create custom reports
are compatible with Microsoft Office 32-bit version only.

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/server recommendations.

Export Utility User Interface

Export Utility's 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 UI allows you to select one or many output file formats.

Metasys Export Utility Online Help PDF 3

Many screens 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)
• Hypertext Markup Language (HTML) (.htm)
• Extensible Markup Language (XML) (.xml), Version 1.0
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.
Note: Scheduled Export using the Excel format (.xls) is not supported on Microsoft Windows Server 2008 R2 OS
or Microsoft Windows Server 2008 OS. 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.
Note: Microsoft Windows Server 2008 R2 OS and Microsoft Windows Server 2008 OS support On Demand Export
using Excel format.

Export Utility Authentication

You must have logon credentials with the Site Director and have logon credentials and 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 logon 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 logon credentials used to create the EUD file must persist. If the user
logon 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.

Metasys Export Utility Online Help PDF 4

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 XP Professional OS
• CPU Type: Pentium® 4 processor, 2 GHz
• Memory: 512 MB RAM
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 on 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 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
For the Windows XP OS and Windows Server 2003 R2 OS, the Billing Report Example.xls is located in:
C:\Documents and Settings\All Users\Application Data\Johnson Controls\MetasysIII\MEU\DLL Examples
For the Windows 7 OS, Windows Server 2008 R2 OS, and Windows Server 2008 OS, the Billing Report Example.xls
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.

Metasys Export Utility Online Help PDF 5

This report is not intended to be used as is, but rather serves as a template or starting point for less experienced
developers on 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
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/modify the file to meet your needs.
In Windows XP OS and Windows Server 2003 R2 OS, the DLLR example files are located in:
C:\Documents and Settings\All Users\Application Data\Johnson Controls\MetasysIII\MEU\DLL Examples
In Windows 7 OS, Windows Server 2008 R2 OS, and Windows Server 2008 OS, 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/chart 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
The DLLR example files output a DLLR energy report similar to the one shown in Figure 1.

Metasys Export Utility Online Help PDF 6

 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. For each column, with the exception of the Date
column, the cells with the highest value are red.
For each row, if no entry in the Date column exists, the rest of the row is black.
Note: For Excel 97-2003, only the Date column is black because these Excel software versions do not support
multiple conditional formatting.
Configuration Cell Verification
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.

Metasys Export Utility Online Help PDF 7

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

From 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.

Detailed Procedures
Logging on to the Metasys System through Export Utility
This procedure allows you to open Export Utility and log on to the Metasys system to access data.
Figure 4 displays two pieces of important information in the bottom bar on the screen: result of the logon attempt
appears on the left side, and the privileges assigned to the user currently logged on appears on the right side. If a
logon attempt fails, contact your Metasys system administrator. See Table 4 for details.

Metasys Export Utility Online Help PDF 8

To log on 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 screen appears (Figure 4).
Figure 4: Log In Screen

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 synchronization with the server by more than 5 minutes, you cannot
log on 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 system 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 screen, see Table 4.
Table 4: Access - User Privileges
User Privilege Meaning
Access You need to enter the Site Director and logon information, then click Log In.
Access Denied Your logon 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 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 screen appears.

Metasys Export Utility Online Help PDF 9

 Figure 5: Export Definition Selection Screen

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. From the Export Definition Selection screen, click New Definition (Figure 5).
2. Click Next. The Export Time Duration - Basic tab appears (Figure 6).
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.

Metasys Export Utility Online Help PDF 10

 Table 5: Frequently Used Intervals
1 Result
Interval
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 UI 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
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.

Metasys Export Utility Online Help PDF 11

 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 screen 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/or audit data.
8. Proceed to one of the following sections:
Selecting Trend Data
Example Expressions
Selecting Trend Data
The Select Trend Data screen 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.
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 screen, click the devices and/or points in the
left pane for which you wish to have the data exported and click Add (Figure 8). The selected devices/points
appear in the right pane.

Metasys Export Utility Online Help PDF 12

 Figure 8: Export Summary and Save Definition File Screen

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 Online Help PDF 13

 Figure 9: Trend Example

Metasys Export Utility Online Help PDF 14

 Figure 10: Trend Output File in Excel

Figure 11: Trend Chart Output File in Excel

Metasys Export Utility Online Help PDF 15

 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
1 Display together in the first column of the output file.
Date
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])
1 Displays the numeric values of the trend objects.
Value
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 Screen 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 screen has three main options for extracting data: Alarm, Audit, and Both.

Metasys Export Utility Online Help PDF 16

• 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, you choose HTML as the output
file type; the result is an Alarm report with a 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.
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 screen appears. Proceed to Selecting File Formats for Output.

Metasys Export Utility Online Help PDF 17

Selecting Alarm Data
Figure 12: Alarm/Audit Data Selection - Basic and Point Selection Tabs

1. Click Alarm.
2. If desired, click Get All Alarms 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 and/or points in the Alarm Point
Selection pane for which you wish to have the data exported, and click Add. The devices/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 Online Help PDF 18

 Figure 13: Alarm/Audit Data Selection - Basic and Alarm Selection Tabs

Table 7: Alarm Selection Tab

Item Meaning
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.
High Warn Includes all alarms with an alarm type of High Warning.
Low Warn Includes all alarms with an alarm type of Low Warning.

Metasys Export Utility Online Help PDF 19

 Table 7: Alarm Selection Tab
Item Meaning
Online Includes all alarms with an alarm type of Online.
Offline Includes all alarms with an alarm type of Offline.
Alarm Priority Allows the user to select the operator from the drop-down menu and the alarm value.
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 here from the drop-down menu and type
*critical* in the Value field to extract data with that text in the alarms.

Metasys Export Utility Online Help PDF 20

 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 in this case 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 Online Help PDF 21

 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
1 Displays the unique reference name for the alarm object that is the full path name of
Name Path Reference
the Metasys system All Items View.
For example, WeCare4U:AC1/N2 Trunk 1.UNT-1.DA-T.Present Value
1 Displays the alarm object names.
Object Name
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 Online Help PDF 22

 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.
2 Displays the alarm annotations one after the other in the following format: Date/Time:
Annotation
<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, ... appears at the end of the cell.

11. Click Next. The Output Selection screen 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 on to the Site Director (from the Log In screen). If you are logged on 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 onto.

Metasys Export Utility Online Help PDF 23

 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: Choose at least one action type on the Audit Selection tab (Figure 17) or output files do not contain any
data.

Metasys Export Utility Online Help PDF 24

 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 an 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.
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.

Metasys Export Utility Online Help PDF 25

 Table 11: Audit Selection
Audit Selection Type Description
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 on 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 typed 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 Online Help PDF 26

 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 place ADS* in the Value field to extract data on
all items that begin with ADS.
User Select this option to filter on user names.
For example, in the Metasys system, define users as follows, N<user name> and D<user
name> for night and day operators, respectively. Then, select User, and type N* in the
Value field to extract data for all night shift operators.
Audit Description Select this option to filter on audit descriptions.
For example, select Audit Description, and place *acknowledged* in the Value field to
extract data for all audit entries that have acknowledged alarms.
Previous Value Select this option to filter on previous values. The relational operand enables, and you
can filter on a numeric previous value.
For example, select Previous Value > and place 80 in the Value field to extract audit
entries with a previous value greater than 80.
Post Value Select this option to filter on post values. The relational operand enables, and you can
filter on a numeric post value.
For example, select Post Value <= and place 10 in the Value field to extract audit entries
with a post value of less than or equal to 10.
Status Select this option to filter on the audit status entry.
For example, select Status and type OK in the Value field to extract successful audits.

7. Specify the filtering criteria for each reference point for the corresponding value field.
Note: The value field supports wildcards (*).
8. Add a new filter row by entering a value for the last filter. (Click Remove Filter to remove the current row of
filtering.)
9. Add the following relational operators to narrow the filtering criteria in the expression: AND, OR, NOT. (Relational
operators appear only for Previous and Post Values.)
Note: Audit Filter Example 1 represents an advanced audit filter that extracts data for all audit entries from
Extended Application and Data Servers (ADXs) (ADX must be part of the Item Name), for all nighttime
operators (assuming each nighttime operator’s username began with an N), with acknowledged alarms.

Metasys Export Utility Online Help PDF 27

 Figure 18: Audit Filter Example 1

Note: Audit Filter Example 2 is an advanced audit filter that extracts data for all audit entries with an Audit
Description of Sample Interval, for trends that previously had values less than or equal to 300 seconds,
and were changed to a value of less than 300 seconds. You could set up this filter to ensure that
employees changed the trend samples above 5 minutes as instructed. If the output file did not extract
any data, the employees followed the instructions.

Metasys Export Utility Online Help PDF 28

 Figure 19: Audit Filter Example 2

10. After you complete filters on the Advanced tab, click OK. The Basic tab appears with the filter results in the
Export Data for the following users pane.
11. Select the desired Audit Export attributes using the information in Table 13. These attributes appear as column
headings for the output files. The default column headings are Date, Time, and Value.
Table 13: Audit Export Attributes
Attribute Meaning
Audit Type Displays the audit types which correspond with the Class Level column in the Metasys
system Audit Viewer. For example, User Action and Critical System Event.
Audit Type App Displays the audit type application which corresponds with the Origin Application column
in the Metasys system Audit Viewer. For example, Device Manager, MCE, and System
Security.
User Displays the Metasys system users.
Action Type Displays the action types. For example, Command, Write, and Subsystem.
Audit Description Displays the audit descriptions which are defined by the Metasys system. For example,
User Login Successful, Download, and Operator Override.
Status Displays the audit entry status (for example, OK).
Previous Value Displays the previous values. For example, if a user changes the name of an engine
from NAE to NAE-1, NAE appears in this column.

Metasys Export Utility Online Help PDF 29

 Table 13: Audit Export Attributes
Attribute Meaning
Post Value Displays the post values. For example, if a user changes the name of an engine from
NAE to NAE-1, NAE-1 appears in this column.
1 Displays the audit annotations one after the other in the following format: Date/Time:
Annotation
<user>:<annotation>
Note: Selecting the Annotation option may take up to five times longer to export audit
messages with annotations than without annotations.

1 For Microsoft Access output files, text entries are limited to 255 characters. If the number of characters is greater than
255, ... appears at the end of the cell. See the Performance Considerations section.

12. Click Next. The Output Selection screen appears. Proceed to Selecting File Formats for Output.
Example Expressions
Alarm
The following are example expressions for filtering alarms:
1. First row of criteria: ‘Alarm Object (Name Path Reference)’ and ‘Floor*’

Relational operator: NOT

Second row of criteria: ‘Alarm Object (Name Path Reference)’ and ‘Floor1’
Result: All points under devices with names starting with Floor, with the exception of Floor1.
2. ‘Alarm Object (Name Path Reference)’ and ‘Floor*’
AND
‘Alarm Value’ ‘=’ ‘200’ in the Value field
Result: All points under devices starting with Floor with an alarm value of 200.
3. ‘Alarm Object (Name Path Reference)’ and ‘Floor*’
OR
‘Alarm Value’ ‘200’ in the Value field
Result: All points under the devices starting with Floor and all points (can be in all devices, not only those starting
with Floor) having an alarm value of 200.
Selecting File Formats for Output
1. On the Export Output Selection - Basic Tab screen (Figure 20), enter the following:
a. Define a common filename - Enter a file name for the output file(s). Only alphanumeric characters and
spaces are allowed. By default, all output files have this name.
b. Define a common directory - Click Browse to select a valid path in which to create the output file(s). Shared
network drives are supported. By default, all output files are created in this directory.

Metasys Export Utility Online Help PDF 30

 Figure 20: Export Output Selection - Basic Tab

2. Select all of the desired file format types using the information in Table 14.
Note: If you do not have Microsoft Excel or Microsoft Access software installed, these selections are unavailable
and appear dimmed.
Table 14: File Format Output Types
Type Extension Description
Tab Delimited Text File .txt Data is presented in a text document separated by tabs and
carriage returns.
1 .xls Data is presented in columns and rows.
Microsoft Excel
Hypertext Markup Language .htm Data is presented in columns and rows.
Comma Separated Value .csv Data is presented in a text document separated by commas
and carriage returns. The document can be viewed in Microsoft
Excel.
2 .mdb Data is presented in record sets in a table of a database.
Microsoft Access
Extensible Markup Language .xml Data is presented as separate tags.

1 Do not have the Microsoft Excel application running while exporting data to this file format. Doing so may cause errors. If
you do not have Microsoft Excel software installed, this selection is unavailable and appears dimmed.
2 For Microsoft Access output files, text entries are limited to 255 characters; if greater than 255 characters, then ... appears
at the end of the cell. See the Performance Considerations section. If you do not have Microsoft Access software installed,
this selection is unavailable and appears dimmed.

3. If desired, click the Advanced tab to select different destinations and/or file names for each selected output file
format. Click OK to save and return to the Basic tab.
For example, to save all files on the local hard disk, except for the HTML file, click the corresponding Browse
button, and select the desired network drive with the name Trends.html instead of the common file name Monthly
Trend Report.
Note: It is not necessary to change anything on the Advanced tab.

Metasys Export Utility Online Help PDF 31

 Figure 21: Export Output Selection - Advanced Tab

Note: The directory path, including the file name, is limited to a maximum of 260 characters for an export to be
successful. For Microsoft Excel, this path is limited to 218 characters. If the path exceeds these limits,
the report does not export.
4. Click Next. The Export Summary and Save Definition File screen (Figure 22) appears with all of the selected
information for the Export Utility Definition file.
Figure 22: Export Summary and Save Definition File Screen

5. Review your selections. (To edit any selections, click Back.)

Metasys Export Utility Online Help PDF 32

 Note: With the Point Names row selected, next to the heading Point Names, place your pointer over the Value
field to enable a ... button. Click the ... button to display all point names.
6. If you wish to save the Export Utility Definition file in a different location from the default, click Save As.
7. Click Next. The Data To Export screen appears. (If the definition file already exists, a dialog box appears to ask
if you wish to overwrite the existing file.) The Export Utility Definition is defined and saved.
Note: The default name for the definition file is that of the common file name defined in the Export Output
Selection screen. It also stores the definition in the directory defined during the installation process.
In Microsoft Windows XP OS and Windows Server 2003 R2 OS, the default location is:
C:\Documents and Settings\All Users\Application Data\Johnson Controls\MetasysIII\MEU\Definitions
In Windows 7 OS, Windows Server 2008 R2 OS, and Windows Server 2008 OS, the default location is:
C:\ProgramData\Johnson Controls\MetasysIII\MEU\Definitions
8. Click the appropriate option button to export the data now or to schedule the export at a later date or time, and
click Next.
Note: If you do not want to create an output file at this time, click the X in the upper-right corner to close the
application. Your definition file has already been saved.
If you wish to schedule the export, proceed to Creating a New Schedule.
Tip: To ensure that your selections are correct before you schedule an export, click Export Now to view the
output of an Export Utility definition file. Then, modify any selections and schedule the export.

Creating a New Schedule

To ensure the best schedule performance, avoid scheduling extractions at times when the Metasys system is busy.
For instance, do not schedule an extraction at the same time a supervisory device has a scheduled ADS Delivery
Time or when many users are accessing the Site Director simultaneously.
The time the schedule runs is based on the system clock of the computer on which Export Utility is running. This
time may not be synchronized with the Metasys system. The Export Utility computer does not have to be synchronized
with the Metasys system, but check that it is extracting the data appropriately.
Export Scheduling Options
To create a new schedule:
1. On the Export Scheduler screen, click Browse and select the Export Utility definition file to be scheduled. If you
just created a definition, this field automatically populates.

Metasys Export Utility Online Help PDF 33

 Figure 23: Export Scheduler

2. Type a unique Schedule Name to identify this schedule in the Export Utility Scheduler. The Scheduler does not
allow two different schedules with the same name or two identical schedules with different names.
3. Select the schedule intervals for how often you wish to have the data exported using the information in Table
15. Select days and times from the drop-down menus for which the schedule runs. Options change on the screen
depending on the interval you choose.
Table 15: Schedule Intervals
Interval Description
One Time This type of schedule runs only once as you have defined.
Daily Selections range from every day to every 31st day.
Weekly Selections range from every week to every 52nd week. You can select the day the schedule
runs that week.
Monthly By Date Selections range from every month to every 12th month. You can select the day the schedule
runs from day 1 to day 31 of the month.
Monthly By Day Selections range from every month to every 12th month. You can select the day the schedule
runs from the first day type of the month until the 4th day type of the month. For example, the
user can select the schedule to run every month on the 2nd Friday of the month.
Yearly By Date Selections range from every year to every 12th year. You can select the month and day of
the year that the schedule runs.

4. In the File Creation section, click the appropriate option button.

• Append File continually adds the schedule to the same output file. For example, Excel adds new worksheets,
and Access adds new tables.
• Create File creates a new output file each time the schedule is run.
5. Click Prefix or Suffix, and select a date format from drop-down menu. The date is appended before or after the
common file.
Note: Choose Prefix or Suffix to organize your files. Prefix puts the date in the chosen date format before the
common file name (for example, 100818Trend Report.xls). Suffix places the date after the common file
name (for example, Trend Report100818.xls).
6. Click Save Schedule.
7. Click View Schedules. The Scheduler screen appears (Scheduler Screen).
Note: If you click View Schedules before you save the schedule, you return to the Export Scheduling Options
screen, losing the reference to the definition file, and you must browse to the definition file.

Metasys Export Utility Online Help PDF 34

 Note: View Schedules appears dimmed and is not accessible when the Scheduler service is not running. Start
the Scheduler service to activate this button.
Scheduler
To manage schedules:
1. Verify that the fields display the correct information for the new schedule. See explanations of the columns in
Table 16.
2. Make any changes and manage the schedules using the functionality described in Table 17.
Figure 24: Scheduler Screen

Table 16: Scheduler Columns

Column Heading Description
Status Contains one of two icons, a green circle or a red circle with an X through it. The green
circle indicates an active or running schedule, and the red indicates an inactive or stopped
schedule.
Schedule Name Displays the schedule name defined in the Export Scheduling Options screen.
Schedule Type Displays the schedule type defined in the Export Scheduling Options screen.
Run Time Displays the time the schedule is set to run defined in the Export Scheduling Options
screen.
Output Directory Displays the name of the directory where the file is stored.
Output File Name Displays the output file name(s) defined by the definition file that the schedule uses.
ID Displays an incremental number to easily identify the schedules.
EUD File Name Displays the name and path of the definition file that the schedule uses. This column
also indicates if an EUD file is missing or corrupt.

Table 17: Scheduler Functionality

Option Function
1 Takes you to the Export Time Duration screen to view or modify an existing Export Utility
View/Mod Def
definition.
1 Takes you to the Scheduler to view or modify an existing schedule.
View/Mod Sch...

Metasys Export Utility Online Help PDF 35

 Table 17: Scheduler Functionality
Option Function
1 Takes you to the Export Scheduling Options screen so that you can create a new
Add
schedule.
Start Begins or resumes a schedule.
Stop Stops or inactivates a schedule, but keeps the entry in the Scheduler for future use.
Remove Deletes the selected schedule.
Error Log Displays all errors that have occurred with all scheduled data exports.
Exit If you accessed the Scheduler from taskbar icon, this closes the Scheduler.
If you accessed the Scheduler from the View Schedules UI, this option returns you to
Export Scheduling Options.

1 If you access the Scheduler by right-clicking the Export Utility icon in the system tray, you cannot access this functionality.
See Figure 52 for the available options.

3. Click Exit.
Schedules are saved in the Scheduler queue. See Modifying an Existing Schedule to make changes to an existing
schedule.

Modifying an Existing Export Utility Definition

Use this procedure to modify an Export Utility Definition file (*.eud) that was created previously.
1. Browse to and log on to Export Utility. See Logging on to the Metasys System through Export Utility.

2. On the Export Definition Selection screen (Figure 25), click Edit Existing Definition and click OK. The second
Export Existing Definition screen appears.
Figure 25: Export Existing Definition Screen

3. Click Browse and open the Export Utility definition file. By default, the location appears that was chosen for
definition files during installation.
4. Click Modify Definition and click Next. The Export Time Duration screen appears with the existing values.
5. Modify the values according to Creating a New Export Utility Definition.
Note: You cannot change a Trend definition to an Alarm/Audit and vice versa.

Modifying an Existing Schedule

1. Browse to and log on to Export Utility. See Logging on to the Metasys System through Export Utility.

2. On the Export Definition Selection screen, click Edit Existing Definition and click OK. The Export Definition
Selection screen appears.
3. Click Browse and open the Export Utility definition file.
4. Click Export Data and click Next. The Data to Export screen appears.

Metasys Export Utility Online Help PDF 36

5. Click the appropriate option button to export the data immediately or click Schedule Export to change the existing
schedule. Click Next. See Creating a New Schedule.

Creating Custom Reports Using the Component Interface

See:
• Referencing the DLL File from a VBA Project for creating reports from scratch
• Using the Billing Report Example File for creating billing reports using the billing example file
• Using the DLLR Example Files for creating custom Demand Limiting/Load Rolling (DL/LR) energy reports using
the DLLR example files
Note: To create custom reports, you must have Microsoft Office 32-bit installed on the computer running Export
Utility. The DLL file and example files used to create custom reports are compatible with Microsoft Office
32-bit version only.
Referencing the DLL File from a VBA Project
See Sample Use of the Export Utility DLL in VBA for information on an example script.
1. In Microsoft Visual Basic, select References from the Tools menu. The References dialog box appears (Figure
26).
Figure 26: References Dialog Box

2. Select the MSEAExportDLL reference check box, and click OK. The MSEAExportDLL reference now appears
in the Object Browser (Figure 27), and it is available for use. For information on VBA classes, see Table 18.
Note: In the Classes pane, if you click MEUDataExtractor, the items in Table 19 appear in the Members pane
to the right.

Metasys Export Utility Online Help PDF 37

 Figure 27: Object Browser

Table 18: VBA Classes Menu Descriptions

Item Description Parameters
IDataExtractor The main interface of the Export Utility DLL. Examples:
MEUDataExtractor Object type that implements the MEUDataExtractor • Dim MyExtractor As
interface. MSEAExportDLL.IDataExtractor
• Set MyExtractor = New
MSEAExportDLL.MEUDataExtractor
TrendDataStruct This structure holds a trend record. It contains • .DateTime
parameters that correspond to the definition file • .NamePathReference
export attributes. See Table 6 for parameter
• .ObjectName
descriptions.
• .ObjectValue
• .ObjectUnits
• .Status

Metasys Export Utility Online Help PDF 38

Table 18: VBA Classes Menu Descriptions
Item Description Parameters
AlarmDataStruct This structure holds an alarm record. It contains • .DateTime
parameters that correspond with the definition file • .NamePathReference
export attributes. See Table 10 for parameter
• .ObjectName
descriptions.
• .ObjectValue
• .ObjectUnits
• .AckRequired
• .AckStatus
• .AlarmType
• .AlarmPriority
• .AlarmDescription
• .AlarmText
• .Annotation
• .IsDiscarded
AuditDataStruct This structure holds an audit record. It contains • .DateTime
parameters that correspond with the definition file • .NamePathReference
export attributes. See Table 13 for parameter
• .ObjectName
descriptions.
• .AuditType
• .ApplicationType
• .UserName
• .AuditActionType
• .AuditDescription
• .Status
• .PreviousValue
• .PostValue
• .Annotation

Metasys Export Utility Online Help PDF 39

Table 19: Method Descriptions
Method Description
MEULogin This method allows you to log on to the Metasys system. It returns an encrypted xml namespace as
a string.
Function MEULogin(hostName As String, userID As String, password As String)
As String
• Hostname: enter either the IP address or the name of the Metasys Site Directory that you want
to log on.
• userID: enter the Metasys system user name that you wish to log on as.
• password: enter the Metasys system password for the user.
Example:
result = MyExtractor.MEULogin("localhost", "MetasysSysAgent", "[default
password]")
Note: The method MEULogin_2 is exposed but required for other Export Utility purposes. It should
not be used and is therefore not supported.
MEUGetTrendData This method returns an array of trend records as defined by the following parameters.
Function MEUGetTrendData(eudFileName As String) As TrendDataStruct()
eudFileName: The full path reference of the Export Utility Definition that defines the time duration and
trend objects for which you wish to retrieve data. MEUGetTrendData only returns data for the export
attributes that are selected in the definition file. For example, if you do not select the Object Name
export attribute when defining the definition file, you do not return any data for the Object Name
parameter of the TrendDataStruct.
Windows XP OS Example:
Dim MyTrendData() As TrendDataStruct
MyTrendData = MyExtractor.MEUGetTrendData ("C:\Documents and Settings\All
Users\Application Data\Johnson Controls\MetasysIII\MEU\Definitions\Last
Months OAT.eud")
Windows 7 OS Example:
Dim MyTrendData() As TrendDataStruct
MyTrendData = MyExtractor.MEUGetTrendData ("C:\ProgramData\Johnson
Controls\MetasysIII\MEU\Definitions\Last Months OAT.eud")

Metasys Export Utility Online Help PDF 40

Table 19: Method Descriptions
Method Description
MEUGetAlarmData This method returns an array of alarm records as defined by the following parameters.
Function MEUGetAlarmData(eudFileName As String) As AlarmDataStruct()
eudFileName: The full path reference of the Export Utility Definition that defines the time duration and
alarm attributes for which you wish to retrieve data. MEUGetAlarmData returns data for the export
attributes that are selected in the definition file. For example, if you do not select the Object Name
export attribute when defining the definition file, you do not return any data for the Object Name
parameter of the AlarmDataStruct.
Windows XP OS Example:
Dim MyAlarmData() As AlarmDataStruct
MyAlarmData = MyExtractor.MEUGetAlarmData ("C:\Documents and Settings\All
Users\Application Data\Johnson Controls\MetasysIII\MEU\Definitions\Yesterdays
Alarms.eud")
Windows 7 OS Example:
Dim MyAlarmData() As AlarmDataStruct
MyAlarmData = MyExtractor.MEUGetAlarmData ("C:\ProgramData\Johnson
Controls\MetasysIII\MEU\Definitions\Yesterdays Alarms.eud")
MEUGetAuditData This method returns an array of audit records as defined by its parameters below.
Function MEUGetAuditData(eudFileName As String) As AuditDataStruct()
eudFileName: The full path reference of the Export Utility Definition that defines the time duration and
audit attributes for which you wish to retrieve data. MEUGetAuditData only returns data for the export
attributes that are selected in the definition file. For example, if you do not select the Audit Description
export attribute when defining the definition file, you do not return any data for the Audit Description
parameter of the AuditDataStruct.
Windows XP OS Example:
Dim MyAuditData() As AuditDataStruct
MyAuditData = MyExtractor.MEUGetAuditData ("C:\Documents and Settings\All
Users\Application Data\Johnson Controls\MetasysIII\MEU\Definitions\Last
Months Audits.eud")
Windows 7 OS Example:
Dim MyAuditData() As AuditDataStruct
MyAuditData = MyExtractor.MEUGetAuditData ("C:\ProgramData\Johnson
Controls\MetasysIII\MEU\Definitions\Last Months Audits.eud")
MEULogout This method logs you out of the Metasys system.
Example:
MyExtractor.MEULogout

Sample Use of the Export Utility DLL in VBA

Access the sample script from the following location:
C:\Program Files\Johnson Controls\Metasys Export Utility\Help\Module1.bas
C:\Program Files (x86)\Johnson Controls\Metasys Export Utility\Help\Module1.bas (Windows Server 2008 R2 OS,
64-bit)
Copy and paste the sample script text into your program, or import the Module1.bas file into your program.

Metasys Export Utility Online Help PDF 41

Using the Billing Report Example File
1. In Windows XP OS or Windows Server 2003 R2 OS, browse to C:\Documents and Settings\All Users\Application
Data\Johnson Controls\MetasysIII\MEU\DLL Examples and open Billing Report Example.xls.

In Windows 7 OS, Windows Server 2008 R2 OS, and Windows Server 2008 OS, browse to
C:\ProgramData\Johnson Controls\MetasysIII\MEU\DLL Examples and open Billing Report Example.xls.
2. Customize the report to meet your needs.
Using the DLLR Example Files
Use the DLLR example files in the following order:
1. Create DLLR trends in your Metasys system. See Creating DLLR Trends.
2. Create the Export Utility Definition file. See Creating the Export Utility Definition (EUD) File.
3. Configure the DLLR example file. See Configuring the DLLR Example Files.
4. Run the report. See Running DLLR Reports.
5. View the report. See Viewing DLLR Reports.
6. Schedule the reports, if desired. See Scheduling DLLR Energy Reports in Windows XP.
Creating DLLR Trends
The DLLR example files read and display data from these DLLR object trend extensions.
To create DLLR trends, in the Site Management Portal UI, add trend extensions to the following attributes of the
DLLR object (Figure 28):
• Energy Rate: energy rate that DLLR is currently reading. Use 1-minute intervals for the extension.
• Active Demand Limit: current target that DLLR is trying to maintain. Use Change of Value (COV) for the
extension, and the DLLR example files fill in any gaps in the data.
• Unc Interval Demand: uncontrolled demand that shows what the demand would have been had DLLR not shed
any loads. Use 1-minute intervals for the extension.
• Amount Shed: current amount of energy that DLLR is shedding. Use 1-minute intervals for the extension.

Metasys Export Utility Online Help PDF 42

 Figure 28: Trend Extensions on DLLR Object Attributes

Go to Creating the Export Utility Definition (EUD) File.

Creating the Export Utility Definition (EUD) File
The DLLR example files use the Export Utility Definition file to retrieve data from the DLLR object trend extensions.
1. Log on to the Site Management Portal UI through Export Utility and create a new definition file (Figure 29). See
Logging on to the Metasys System through Export Utility.
Figure 29: New Definition

2. Click Next. The Export Time Duration screen appears.

3. On the Export Time Duration Basic tab, in Frequently Used Intervals, select either Last Month or Choose Date
(Table 20).
Note: Other selections under Frequently Used Intervals are not valid. No edits are required for the Advanced
tab.

Metasys Export Utility Online Help PDF 43

 Table 20: Selections on the Basic Tab - Frequently Used Intervals
Selection Details
Yesterday Not supported
Last Week Not supported
Last Two Weeks Not supported
Last Month For a monthly DLLR energy report based on Day 1 to Day Last of the previous month, select
Last Month (Figure 30).
Figure 30: Last Month

Last Quarter Not supported

Last Year Not supported

Metasys Export Utility Online Help PDF 44

 Table 20: Selections on the Basic Tab - Frequently Used Intervals
Selection Details
Choose Date For a monthly DLLR energy report based on a range such as Month/Day # to Month+1/Day-1,
select Choose Date. For dates, select what would have been the last report date range. For
example, Start Date = 1/9/2007 and the End Date = 2/8/2007 (Figure 31).
Figure 31: Choose Date

All Available Not supported

4. Click Next.
5. In the Data Type Selection box, select Trend.
Figure 32: Data Type Selection Box

6. Click Next. The Export Summary and Save Definition File screen appears.

Metasys Export Utility Online Help PDF 45

7. Do the following in the Export Summary and Save Definition File screen (Figure 33):
• Select the four trend extensions (Energy Rate, Active Demand Limit, Unc. Interval Demand, and Amount
Shed), and click Add to move them to the Export Data for the following points list.
• Select the Object Name check box. The DLLR example files use this setting to display data in the appropriate
columns.
• Leave all other options at their defaults.
Figure 33: Export Summary and Save Definition File Screen

8. Click Next. The Export Output Selection screen appears.

9. Enter a common file name in Define a common filename and select the Microsoft Excel check box for file
format (Export Output Selection).
Note: Choosing a common file name, directory, and file format in this step is usually not necessary. It is
necessary only for the DLLR example files with regard to the definition file being complete; however,
these settings may be useful to make sure you are getting the appropriate data (by using Export Utility
to run its report).
Note: If you do not have Microsoft Excel or Microsoft Access software installed, these choices are unavailable
and appear dimmed.

Metasys Export Utility Online Help PDF 46

 Figure 34: Export Output Selection

10. Click Next. The Export Summary and Save Definition File screen appears.
11. Review your selections (Export Summary and Save Definition File Screen).
Figure 35: Export Summary and Save Definition File Screen

12. Click Next to save the definition file. The Data to Export screen appears.
13. Choose to Export Now (to ensure if you are retrieving the appropriate date) or close the application using the
X button.

Metasys Export Utility Online Help PDF 47

 Note: If you close the application using the X button, a message box appears and states Application will exit
without saving current selections. Because the definition file was already saved when you clicked
Next in Step 12, click Yes to close out the application.
Figure 36: Exit Without Saving Box

14. Go to Configuring the DLLR Example Files.

Configuring the DLLR Example Files
The Configuration sheet of the DLLR example files not only provides you with ways to enter Metasys system
information for data retrieval but also contains other automation options to have the DLLR energy report run, save,
and print by itself.
1. In Microsoft Windows XP OS or Windows Server 2003 R2 OS, browse to C:\Documents and Settings\All
Users\Application Data\Johnson Controls\MetasysIII\MEU\DLL Examples.
In Windows 7 OS, Windows Server 2008 R2 OS, and Windows Server 2008 OS, browse to
C:\ProgramData\Johnson Controls\MetasysIII\MEU\DLL Examples.
2. Open either DLLR_Excel 97-2003.xls (for Microsoft Excel 97 through Microsoft Excel 2003 software) or
DLLR_Excel 2007.xls (for Microsoft Excel 2007 software).
3. Click the Configuration sheet. See Figure 37.
Figure 37: DLLR_Excel 97-2003.xls

4. Enter values for each field:

Metasys Login Credentials
Enter the appropriate Metasys system Site Director, User (username), and Password. Export Utility DLL uses these
credentials to log on to the Metasys system UI.
Metasys Export Utility EUD file

Metasys Export Utility Online Help PDF 48

Use the Browse button to search for and select the definition file you created in Step 11 of Creating the Export Utility
Definition (EUD) File (Figure 35).
Note: The example file does not verify this path. If you edit the cell manually, make sure the path you enter is
correct.
Report Attributes
Use Table 21 for the Report Attributes section.
Table 21: Report Attributes Section
Field Description
1

Custom Dates Select FALSE from the drop-down list if you selected Last Month as your interval. Select
TRUE if you selected Choose Date as your interval.
Note: The DLLR example files support only the Last Month or Choose Date for
Frequently Used Intervals (see Creating the Export Utility Definition (EUD) File).
Note: When Custom Dates is set to TRUE and the DLLR energy report is run (either
automatically or via the Run Report button), the Export Utility Definition file is
modified by the software to reflect the Report Start and End Dates.
Auto Upgrade Custom Dates If Custom Dates is set to TRUE, you can choose to automatically update the Custom
Date ranges (Report Start Date and Report End Date).
If Auto Upgrade Custom Dates is set to TRUE, each time the DLLR example files are
opened, the Report End Date + 1 month + 1 day is compared to the current date. If the
current date is equal to or greater than the Report End Date + 1 month + 1 day, the Report
Start and End Dates are increased by the number of month's difference between the
Report End Date and the current date.
IF (Report End Date + 1 month + 1 day) <= (Today's Date) THEN
Report Start Date = Report Start Date + (Today's Month - Report
End Date's Month) month(s)
Report End Date = Report End Date + (Today's Month - Report End
Date's Month) month(s)
END IF
2 When Custom Dates is set to FALSE, the Report Start Date automatically displays the
Report Start Date
first day of the last month. When Custom Dates is set to TRUE, choose a date using the
button.

Note: Do not manually edit this field as a formula handles the automation.
2 When Custom Dates is set to FALSE, the Report End Date automatically displays the
Report End Date
last day of the last month. When Custom Dates is set to 'TRUE', choose a date using the
button.

Note: Do not manually edit this field because a formula handles the automation.
Initial Active Demand Limit The value entered here is used to fill any gaps in data resulting from a COV Trend sample
rate. For example, if three targets are used throughout the day, On-Peak, Off-Peak, and
Semi-Peak, the Initial Active Demand Limit would be used to fill in the target from the
previous day. So, for the first day, Initial Active Demand Limit appears for each minute
until the first sample was retrieved. This method is only necessary when using a COV
trend sample rate for the Active Demand Limit.

1 For descriptions that mention drop-down lists, click the cell where you would like to make a selection. The drop-down arrow
then appears to the left of the cell.
2 The Report Start Date and Report End Date fields use the Microsoft Calendar control. These instructions assume that this
control has been installed and registered already when you installed Microsoft Office software.

Metasys Export Utility Online Help PDF 49

Workbook Open Attributes
The DLLR example files allow you to use an application such as Windows Scheduled Tasks to run, save, and print
the DLLR energy report automatically. The attributes in Table 22 control how the DLLR energy report is handled
each time the DLLR example files open.

Table 22: Workbook Open Attributes Section

Field Description
Auto Run Report If you set this field to TRUE, each time the DLLR example files open, they do the following:
• Read the Configuration sheet parameters.
• Log on to the Site Management Portal UI via the Export Utility DLL.
• Modify the Export Utility Definition file with the Report Start and End Dates.
• Retrieve and write the data into the appropriate sheets.
This behavior is the same as when you click Run Report.
Auto Save Report If you set Auto Run Report to TRUE and Auto Save Report to TRUE, then each time the
DLLR example files open, a copy of the file is saved after the run report is complete. The
copy of the file is named yymmdd Energy Report.xls(m) where yy = year, mm = month,
and dd = day. The file is saved to the same location as the DLLR example file.
Auto Print Report If you set Auto Run Report to TRUE and Auto Print Report to TRUE, then each time the
DLLR example files open, both the Daily Data sheet and the Energy Report chart print
to the default Windows printer. Default printer settings should be set to print appropriately.
Auto Close Report If you set this field to TRUE and at least one of the following is also set to TRUE (Auto
Run Report, Auto Save Report, or Auto Print Report), then each time the DLLR example
files open, once any or all the above are complete, Microsoft Excel closes.
Note: When set to TRUE, if you wish to open the DLLR example files manually, you
must press the break key on your keyboard to stop the automation during its
progress. Otherwise, it closes the application.

Go to Running DLLR Reports.

Running DLLR Reports
Note: To schedule DLLR energy reports, see Scheduling DLLR Energy Reports in Windows XP.
1. Configure the DLLR energy report. See Configuring the DLLR Example Files.

2. On the Configuration sheet, click Run Report.

3. Go to Viewing DLLR Reports.
Viewing DLLR Reports
To view DLLR energy reports, click the Energy Report sheet.
Note: To see numerical representations of the data in the DLLR energy report, click the Daily Data and Data by
Minute sheets.
Scheduling DLLR Energy Reports in Windows XP
You can use the Windows Scheduled Task wizard along with the Workbook Open Attributes to run, save, and print
the DLLR energy report automatically.
Note: The steps in this section apply to Microsoft Windows XP OS only. For steps using Microsoft Windows 7, see
Scheduling DLLR Energy Reports in Windows 7. If you have a different OS, consult your Microsoft
documentation for information on the Task Scheduler for that particular OS.
To schedule DLLR energy reports:
1. Open the Windows Scheduled Task screen from the Start menu at Programs > Accessories > System Tools >
Scheduled Tasks. The Scheduled Tasks window appears.

Metasys Export Utility Online Help PDF 50

2. Double-click Add Scheduled Task to start the Scheduled Task Wizard. The Scheduled Task Wizard appears.
3. Click Next.
4. Choose the appropriate Excel software from the program list and click Next (Figure 38).
Figure 38: Program Selection

5. Give the task a meaningful name (for example, Monthly DLLR Energy Report), then select monthly for the
interval (Figure 39). Click Next.
Figure 39: Task Name and Timing

6. Select the time and day information as appropriate (Figure 40). For example, if your DLLR energy report is
based on a Custom Date range of mm/09/yy - mm/08/yy, then choose the task to run on Day 9. Click Next.

Metasys Export Utility Online Help PDF 51

 Figure 40: Time of Day and Months

7. Enter your Windows credentials and click Next (Figure 41).

Figure 41: Windows Authentication

8. Select Open advanced properties for this task when I click Finish (Figure 42). Click Finish.

Metasys Export Utility Online Help PDF 52

 Figure 42: Scheduling Success

9. When the Advanced Properties box appears (Figure 43), click the Task tab.
10. Modify the Run entry by adding the path and file name of the DLLR example, in quotations, after the link provided.
For example, when using Excel 2007 software with the DLLR_Excel 2007.xlsm file on a computer running the
Windows XP OS or Windows Server 2003 R2 OS, the Run statement should be the following, where the added
text is bold (Figure 43).
"C:\Documents and Settings\All Users\Start Menu\Programs\Microsoft Office\Microsoft
Office Excel 2007.lnk" "C:\Documents and Settings\All Users\Application Data\Johnson
Controls\MetasysIII\MEU\DLL Examples\DLLR_Excel 2007.xlsm"

Metasys Export Utility Online Help PDF 53

 Figure 43: Advanced Properties Box

11. Click OK.

Scheduling DLLR Energy Reports in Windows 7
Note: The steps in this section apply to Microsoft Windows 7 OS only. If you have a different OS, consult your
Microsoft documentation for information on the Task Scheduler for that particular OS.
To schedule DLLR energy reports in Windows 7:
1. Open the Windows Task Scheduler screen from the Start menu at All Programs > Accessories > System Tools
> Task Scheduler. The Task Scheduler window appears.
2. Click Create Basic Task… to start the Create Basic Task Wizard. The Create Basic Task Wizard appears
(Figure 44).
3. Give the task a meaningful name (for example, Monthly DLLR Energy Report). Click Next.

Metasys Export Utility Online Help PDF 54

 Figure 44: Create a Basic Task Wizard

4. The Trigger window appears (Figure 45). Select Monthly for the trigger. Click Next.

Metasys Export Utility Online Help PDF 55

 Figure 45: Create Basic Task Wizard - Task Trigger Window

5. The Monthly window appears (Figure 46). Select the time and day information as appropriate. For example, if
your DLLR energy report is based on a Custom Date range of mm/09/yy - mm/08/yy, then choose the task to
run on Day 9. Click Next.

Metasys Export Utility Online Help PDF 56

 Figure 46: Create Basic Task Wizard - Monthly Window

6. The Start a Program window appears (Figure 47). In the Program/script field, choose the directory path of the
appropriate Excel software from the file system. In the Add Arguments field, add the directory path of the DLLR
example in quotations. Click Next.

Metasys Export Utility Online Help PDF 57

 Figure 47: Create Basic Task Wizard - Start a Program Window

7. The Summary window appears (Figure 48). Verify the details of the task. Select Open the Properties dialog
for this task when I click Finish. Click Finish. The Properties dialog box appears (Figure 49).

Metasys Export Utility Online Help PDF 58

 Figure 48: Create a Basic Task Wizard - Summary Window

8. In the Properties dialog box, select Run whether the user is logged on or not. Click Change User or Group…
if you would like to run the task as a different user.

Metasys Export Utility Online Help PDF 59

 Figure 49: Properties Dialog Box

9. Select the user and click OK.

Figure 50: Select User or Group Window

10. A credentials window appears and prompts for the user's credentials. Enter your Windows credentials and click
OK.

Metasys Export Utility Online Help PDF 60

 Figure 51: Task Scheduler User Credentials Dialog Box

Using the Scheduler Service from the System Tray

1. Right-click the Export Utility icon in the system tray.
2. Select an option using the information in Table 23.
3. Manage schedules using the options in Table 17.
Note: Some functionality is not available in the Scheduler service from the system tray. To access all of the
functionality, log on to Export Utility (see Logging on to the Metasys System through Export Utility).
Note: If you are using Microsoft Windows 7 OS or Windows Server 2008 R2 OS, the Start Scheduler and Stop
Scheduler options are dimmed (not available). To enable these options, exit the Scheduler service and restart
the Metasys Export Utility Schedule Controller by selecting the Run as Administrator option. If the Scheduler
service is currently running, the Stop Scheduler option is available; if the Scheduler service is currently
stopped, the Start Scheduler option is available.
Table 23: Scheduler System Tray Menu
Menu Item Functionality
Start Scheduler Starts the Scheduler service. The system tray icon border is green.

Note: This option appears dimmed when the Scheduler service is already
running.
Stop Scheduler Stops the Scheduler service. The system tray icon border is red.

Note: This option appears dimmed and is not accessible when the
Scheduler service is not running.

Metasys Export Utility Online Help PDF 61

Table 23: Scheduler System Tray Menu
Menu Item Functionality
View Schedule Opens the Scheduler service with View Only access. See Figure 52.
Note: This option appears dimmed and is not accessible when the
Scheduler service is not running. Start the Scheduler service (Start
Scheduler) to activate this menu item.
Exit Makes the icon disappear from the system tray, and access is no longer
available. Before exiting, a dialog box appears asking if you want to exit the
Schedule Controller and warns that exiting stops all scheduling.
Note: To manually start and stop the Scheduler service, go to the Control
Panel > Administrative Tools > Services. Right-click
MSEASchedulerService and select Start or Stop as needed. (If you
are using Windows Server 2008 OS, go to Control Panel > System
and Maintenance > Administrative Tools > Services. For Windows 7
OS or Windows Server 2008 R2 OS, go to Control Panel > System
and Security > Administrative Tools > Services.)

Figure 52: Scheduler - View Only Access from System Tray Icon

Displaying the Help File, About Screen, or Exiting Export Utility

• Select Help > Help from the menu bar. The Help file for Export Utility appears. Click the X in the upper right
corner of the screen to close.
• Select Help > About... from the menu bar. The About Metasys Export Utility screen appears. This screen shows
the version of Export Utility. Click the X in the upper right corner of the screen to close.
• Select File > Exit from the menu bar. Export Utility closes.

Troubleshooting
Error Messages, Problems, and the Error Log
Error messages either appear as a dialog box when running the Export Now! portion of Export Utility or as entries
in the Error Log.
Tip: When using the Scheduler, check the Error Log regularly.

Metasys Export Utility Online Help PDF 62

Table 24: Error Messages/Problems
Error Message/Problem Description/Solution
A new schedule has been Appears when the Scheduler service is not running and you add a new schedule.
created. Start the Scheduler to Start the Scheduler service to run the schedule.
run the schedule.
Could not establish Appears when Export Utility cannot communicate with the Metasys system. Make
communication with the Metasys sure the Site Director and login credentials you specified are correct and that the Site
Site Director. Director is reachable over the network.
Could not locate the definition Appears when the definition file cannot be found. Make sure the file exists and is in
file, 'eud filename and path'. the expected location; if it is not, recreate the definition file.
Could not locate the schedule Appears when the schedule file, scheduleinfo.xml, cannot be found. The default
file, 'schedule filename and location in Windows XP OS and Windows Server 2003 R2 OS is C:\Documents and
path'. Settings\All Users\Application Data\Johnson Controls\MetasysIII\MEU\xml. The default
location in Windows 7 OS, Windows Server 2008 R2 OS, and Windows Server 2008
OS is C:\ProgramData\Johnson Controls\MetasysIII\MEU\xml.
If it is not found and schedules exist, the Scheduler automatically recreates this file.
If it is not copied automatically, copy and paste the scheduleinfo.xml file from the
installation product disk.
Could not read the definition Appears when the definition file becomes corrupt or is being used by another person
file, 'eud filename and path'. or program. Close the application that is using the *.eud file or recreate it.
Could not read the schedule Appears when the schedule file defined above becomes corrupted or is being used
file, 'schedule filename and by another person or program. Close the application that is using the scheduleinfo.xml
path'. file, or delete it so that the Scheduler can recreate it. If it is not copied automatically,
copy and paste the scheduleinfo.xml file from the installation product disk.
Error occurred in retrieving Appears when the time difference between the Export Utility computer and the Site
user properties. Director is more than 5 minutes. Adjust the time accordingly.
Failed to create 'File Type' Appears whenever Export Utility has failed to create an output file.
output file.
Failed to save 'File Type' Appears when Export Utility cannot save an output file.
output file. 'Reason'.
Reasons:
1. The Network drive not accessible. The output file cannot be written because the
shared network drive cannot be accessed. Check the connection to the shared
drive and try again.
2. The Windows user does not have sufficient rights. The Windows user does not
have rights to write to the shared drive. Log on to the Windows operating system
with the appropriate rights to write to the shared drive.
Log in to Metasys failed. Appears when your logon to the Metasys system has failed. Check that the user
name and password are correct and that you are logging into the correct Metasys
system supervisory device.
Error in exporting data. Appears when one or more Metasys devices that report to the Site Director are not
Incomplete Report. Reason: reachable. Make sure each device is online to the Site Director to ensure that you
While retrieving data, at least export a complete set of data.
one web method to the Metasys
system failed. The output file
is incomplete. You must make
sure that all devices within
the Metasys system are "Online"
and re-run the application to
retrieve all data. The
following devices could not be
reached: <Site Director Name:IP
Address>

Metasys Export Utility Online Help PDF 63

Table 24: Error Messages/Problems
Error Message/Problem Description/Solution
Logon failure: account Appears when the Metasys system account is disabled.
currently disabled.
Logon failure: account logon Appears when a restriction on login time is applied.
time restriction violation.
Logon failure: the specified Appears when the Metasys system account has expired.
account password has expired.
Logon failure: unknown user Appears when the wrong user name or password is entered.
name or bad password.
Please enter valid port number Appears when you enter an invalid port number after the address in the Site Director
where MSEA service is running. field of the Log In screen. Verify the port number and try again according to the steps
in Logging on to the Metasys System through Export Utility.
Retry attempt of web method Appears when an immediate second attempt is tried to extract data from the Metasys
call to Metasys failed. system has failed. You must try later manually.
Scheduler is already running. Appears when the Scheduler service is running and you attempt to start it again.
Scheduler is not installed. Appears when you log on to Export Utility or launch the Schedule Controller (system
Please install it. tray icon) and the Scheduler service is not installed because you manually uninstalled
the Scheduler or did not choose to install it during the installation process.
Scheduler is not running. Appears when the Scheduler service is stopped and you attempt to stop it again.
The referenced account is Appears when the Metasys system account is locked.
currently locked out and may
not be logged on to
Web method call to Metasys Appears when you are already communicating to the Metasys system and successfully
failed. logged on, but cannot retrieve data from the system. The Export Utility pauses and
tries again.
Class does not support Appears when you do the following:
automation or does not support
• Install Export Utility on a computer that already has Export Utility installed (as in
expected interface.
an upgrade).
• Do not take the proper steps as documented in the Export Utility Installation
Instructions (LIT-12011527).
• Attempt to load an example file and retrieve data.
To resolve this problem, use the Export Utility Installation Instructions (LIT-12011527)
to reinstall Export Utility.
Error in exporting data. Appears when:
Incomplete Report. Reason:
• The Ready Access Portal software is installed on a stand-alone computer, not
While retrieving data, at least
on an ADS/ADX. There is no ADS/ADX in the configuration.
one web method to the Metasys
system has failed. The output • The Site Director NxE is configured to report alarms to the Ready Access Portal
file is incomplete. You must computer.
make sure that all devices • Export Utility is used to browse to the NxE to gather trend data.
within the Metasys system are
With this configuration, the NxE attempts to communicate with a nonexistent Ready
“Online” and re-run the
Access Portal ADS/ADX computer. Because there is no ADS/ADX in this particular
application to retrieve all
scenario, you cannot use Export Utility to gather this report data.
data.

Metasys Export Utility Online Help PDF 64

Table 24: Error Messages/Problems
Error Message/Problem Description/Solution
Error in exporting data. Failed Appears when the directory path, including the file name, exceeds the defined
to create ‘Excel’ output file, character limit. The path is limited to a maximum of 260 characters for an export to
‘C:\Metasys Export Utility be successful. For Microsoft Excel, this path is limited to 218 characters.
Reports\...’. Reason: Exception
from HRESULT: 0x800A03EC
You cannot start or stop the Metasys Occurs in Windows 7 OS and Windows Server 2008 R2 OS if you are logged on with
Export Utility Scheduler from the a Windows user who does not have administrative rights. You have two options: (1)
taskbar icon. The start and stop options exit the Scheduler and restart the Metasys Export Utility Schedule Controller by
appear dimmed. selecting the Run as Administrator option or (2) control the MSEASchedulerService
from the Windows Services window.

Metasys Export Utility Online Help PDF 65

 Energy Reports..........................................................50
Index Scheduling............................................................50
A Error............................................................................62
About Screen..............................................................62 Error Log....................................................................62
Access..........................................................................8 EUD................................................................10, 36, 43
ADS Delivery Time......................................................33 Creating a New EUD File......................................43
Alarm Data..................................................................18 Creating New........................................................10
Alarms........................................................................18 Modify Existing......................................................36
Export Attributes..................................................18 EUD File........................................................................4
Filter Example......................................................18 Example Expressions..................................................30
Annotations Attribute....................................................5 Alarm....................................................................30
Audit Data..................................................................23 Exit Export Utility........................................................62
Audits..........................................................................23 Export Attributes..........................................................16
Export Attributes..................................................23 Alarm and/or Audit Data......................................16
Filter Example......................................................23 Export Output Selection..............................................30
Authentication..............................................................4 Export Scheduling Options..........................................33
B Export Utility Definition File (EUD)................................4
BAS File......................................................................41 Export Utiltiy DLL Component......................................6
Batch File....................................................................41 F
Billing Example File......................................................5 File Formats..................................................................4
Billing Report................................................................5 File Formats for Output..............................................30
Billing Report Example File..................................42, 48 Filtering................................................................18, 23
C Alarm Example....................................................18
Common Directory......................................................30 Audits....................................................................23
Common Filename......................................................30 Relational Operators............................................18
Configuration Sheet......................................................6 Frequently Used Intervals..........................................10
Configuring DLLR Example Files................................48 G
Creating a New EUD File............................................43 Get All Alarms............................................................18
Creating a New Schedule..........................................33 H
Custom Reports......................................................5, 37 Help File......................................................................62
D L
Daily Data Sheet..........................................................6 Literature......................................................................2
Data by Minute Sheet....................................................6 Logging On....................................................................8
Definition File................................................................4 Login............................................................................8
Demand Limiting Sliding Window..................................6 Logon............................................................................4
DLL.................................................................................. M
37, 41 Metasys Access............................................................4
Sample File for Use in VBA..................................41 Method Descriptions..................................................37
DLLR Example File......................................................7 Modify Existing Export Utility Definition File................36
Configuration Cell Verification................................7 Modify Existing Schedule............................................36
Daily Data Conditional Formatting..........................7 MSEAExportDLL........................................................37
Features..................................................................7 O
DLLR Example Files..............................................6, 48 Output Types and Descriptions..................................30
Configuring..........................................................48 Overview......................................................................2
Example Output......................................................6 P
DLLR Object................................................................42 Password..................................................................4, 8
DLLR Trends..............................................................42 Performance Considerations........................................5
Active Demand Limit............................................42 Permissions..................................................................4
Amount Shed........................................................42 R
Energy Rate..........................................................42 Recommendations........................................................5
Unc Interval Demand............................................42 Related Documentation................................................2
E S
Energy Report......................................................48, 50 Scheduler......................................................................4
Running................................................................50 Scheduler Queue........................................................35
Viewing................................................................50 Scheduler Service............................................4, 33, 61
Energy Report Sheet....................................................6 Scheduling Options....................................................33
Sheets in the DLLR Example Files..............................6
Metasys Export Utility Online Help PDF 66
Site Director........................................................4, 8, 33
Logon Credentials..................................................4
Software Requirements................................................3
System Requirements..................................................2
System Tray Icon....................................................8, 61
T
Technical Specifications................................................3
Third-Party Applications................................................5
Time Synchronization..................................................33
Trend Data..................................................................12
Example of Output................................................12
Export Attributes..................................................12
Trend..............................................................12
Export Data for the following points......................12
Trend Point Selection..........................................12
Troubleshooting..........................................................62
U
U I ..................................................................................3
User Interface................................................................3
User Name....................................................................8
Username......................................................................4
V
VBA......................................................................37, 41
Sample Script......................................................41
Visual Basic..................................................................5
W
Windows Schedule Task............................................50

Building Efficiency
507 E. Michigan Street, Milwaukee, WI 53202
Metasys® and Johnson Controls® are registered trademarks of Johnson Controls, Inc.
All other marks herein are the marks of their respective owners. © 2013 Johnson Controls, Inc.

Published in U.S.A. www.johnsoncontrols.com

Metasys Export Utility Online Help PDF 67