Metasys Export Utility Product Bulletin

Size: px

Start display at page:

Download "Metasys Export Utility Product Bulletin"

Stella Little
5 years ago
Views:

MS-EXPORT-0, MS-EXPORT-6 Code No. LIT-1201800 Software Release 8.1 Issued February 2017 Refer to the QuickLIT website for the most up-to-date version of this document.

1 MS-EXPORT-0, MS-EXPORT-6 Code No. LIT Software Release 8.1 Issued February 2017 Refer to the QuickLIT website for the most up-to-date version of this document. The Metasys system Export Utility makes it easy for a facility manager to efficiently manage daily operations. The Export Utility extracts historical trend, alarm, and audit data from the system and presents the historical data in a variety of formats. Using these flexible formats in programs such as Microsoft Excel and Access, you can easily sort, compare, and archive data in spreadsheets and databases. Export Utility is a valuable tool for effective historical data analysis. You can determine how to use the data to perform time studies and root cause analyses of system changes and mechanical equipment failure. The scheduling capability of Export Utility allows you to extract the selected data immediately, or to schedule an extraction at a convenient time or interval. When the base set of reports provided with Export Utility is insufficient, a feature is included that allows you to create a program to customize reports that fit your needs. Figure 1: Export Utility User Interface Features and Benefits Historical Data Retrieval Extracts alarm, trend, or audit data that is stored in the Metasys system. Flexible Filtering of Historical Data Extracts user-defined historical data by filtering on named items, time, date, and other parameters. Scheduled Collection of Historical Data Allows you to create convenient one-time or repeating schedules for data collection. Versatile Report Capabilities Allow you to choose output file formats from several programs such as Microsoft Excel, Access, and others. Custom Reporting Allows you to create custom reports using the power of the Export Utility in a third-party program. Dynamic Link Library (DLL) Examples Allow you to use Microsoft Excel example files and the Export Utility DLL to create custom billing and energy (based on demand limiting and load rolling [DLLR]) reports. Historical Data Backup Allows you to schedule data extraction to the customer s computer or computer server for backup purposes for smaller systems without an Application and Data Server/Extended Application and Data Server (ADS/ADX). 1

2 Export Utility User Interface Export Utility provides a user-friendly wizard that allows you to enter data-filtering criteria; schedule intervals to gather trend, alarm, and audit data; and output file types (Figure 1). 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 display only the objects relevant to the type of data you choose to extract. Supported File Formats Export Utility extracts user-defined data to any of the following file formats: Microsoft Excel (.xls) Tab-delimited text (.txt) Comma-separated value (.csv) Microsoft Access (.mdb) HTML (.htm) XML version 1.0 (.xml) Authentication Export Utility uses the Site Management Portal (SMP) UI authentication process, which allows you to maintain the security of your system. You must have login credentials with the Site Director and have login 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 SMP UI authentication, using the same user name and password. If login fails, contact your Metasys system administrator. Note: When creating an Export Utility Definition (EUD) file, the user login credentials used to create the EUD file must persist. If the user login credentials are deleted, the EUD file no longer works. Filtering Options Extract only the most useful historical data by using the basic or advanced filtering options. Pick a start and end date and time to collect data or to select a relative time frame (for example, yesterday or last month). Export trends, audits, or alarms. To further fine-tune data retrieval, Export Utility allows you to use logical operators and wildcard characters. For example, retrieve all temperature trends with the filter Object Name = *-T. Scheduler The Scheduler provides flexibility for the timing of data retrieval. Choices include immediate export, or you may schedule data collection at a predefined time or interval (for example, every day at 8:00 A.M.). System Tray Icon Right-click the icon in the system tray to quickly view all schedules without having to launch Export Utility. Microsoft Windows Service The Export Utility Scheduler functions as a service in the Windows operating system. It works even while a user is not logged on to Windows or the SMP UI. Custom Report Capability Export Utility provides a programming interface for you to develop programs that create custom reports. For example, you can write a program to collect Metasys system data for customized tenant billing reports. You can use Export Utility to import data directly into any third-party application that supports the Microsoft.NET framework, such as Microsoft Visual Basic, Excel, or Access. 2

DLL Examples You can use Microsoft Excel example files included with Export Utility with the Export Utility DLL to create custom billing and energy (DLLR) reports.

3 DLL Examples You can use Microsoft Excel example files included with Export Utility with the Export Utility DLL to create custom billing and energy (DLLR) reports. The billing report must be customized for your use. After setup, you can use the DLLR example files with or without customization. Note: Export Utility can extract data to 32-bit and 64-bit versions of Microsoft Office. However, the DLL file and example files used to create custom reports are compatible only with 32-bit versions of Microsoft Office. Note: Microsoft Excel 2010 and Microsoft Excel 2013 do not support DLLR report functionality. Figure 2: Export Utility DLL Example File Troubleshooting Export Utility generates long-term trend reports to examine and determine system degradation. Historical Data Repository Collect and store valuable data from the Metasys system for archiving and reference. Zone Analysis Collect historical data on an individual zone (for example, a laboratory or a classroom) without using the SMP UI. Custom Reports Create customer reports using data retrieved by Export Utility. For example, create a tenant billing report for a shared facility, or create a report to analyze energy use. Maintenance Collect trend data to help you decide when to schedule mechanical maintenance of an HVAC system. System Activity Reports Generate reports on the activity of specific personnel and transactions by filtering audits on operator name. Versatile Applications The following diagram illustrates some applications of the Export Utility. Figure 3: Export Utility Applications Backup Utility Back up data for a site that does not have an ADS/ADX or ODS. Export Utility makes data available in concise categories so that you can organize data for efficient, meaningful retrieval. Export Utility Documentation For information on how to install Export Utility, refer to the Metasys Export Utility Installation Instructions (LIT ). For information on how to use the Export Utility, refer to Metasys Export Utility Help (LIT ). For more information on ordering Export Utility, see Ordering Information. 3

4 Ordering Information Table 1: Export Utility Selection Charts Description Code Number 1 MS-EXPORT-0 MS-EXPORT-6 Export Utility new project software. Software and license for one computer (not per site). Export Utility upgrade software to current release version. Software and license for one computer (not per site). 1 Export Utility software is sold separately from Metasys software. However, some Metasys software packages include Export Utility software. For more information on Metasys software packages, refer to the Metasys System Software Purchase Options Product Bulletin (LIT ). Technical Specifications Table 2: Export Utility System Requirements Product Code Recommended Computer/Server Platform 1 MS-EXPORT-0, MS-EXPORT-6 Intel Core 2 Duo E6700 or better (Intel Core 2 Duo E4300 minimum) 20 GB free hard disk space available (600 MB minimum) DVD drive When Export Utility is installed on an Application and Data Server/Extended Application and Data Server (ADS/ADX) or Open Data Server (ODS), follow the requirements for an ADS/ADX or ODS. Refer to the Application and Data Server (ADS) and Extended Application and Data Server (ADX) Product Bulletin (LIT ), the Application and Data Server (ADS) Lite-E Product Bulletin (LIT ), the Application and Data Server (ADS) Lite-A Product Bulletin (LIT ), or the Open Data Server Product Bulletin (LIT ). Recommended Memory 1 Supported Operating Systems Computer platforms: 2 GB RAM (1 GB RAM minimum) Server platforms: 4 GB RAM (2 GB RAM minimum) Windows 10 Enterprise and Pro Editions with Anniversary Update (version 1607)(64-bit) Windows 8.1 Pro and Windows 8.1 Enterprise Editions with Update 1 (64-bit) Windows 7 Professional, Enterprise, and Ultimate Editions with SP1 (64-bit) Windows 7 Professional, Enterprise, and Ultimate Editions with SP1 (32-bit) Windows Server 2012 R2 wtih Update 1 Windows Server 2012 Windows Server 2008 R2 with SP1 4

5 Table 2: Export Utility System Requirements Additional Software Included on the Product Disks Additional Requirements (Order Separately) Microsoft.NET Framework version 3.5 SP1 or version 4.0 For steps on installing.net Framework version 3.5 SP1, refer to the Metasys Server Installation and Upgrade Instructions Wizard (LIT ), SCT Installation and Upgrade Instructions (LIT ), or the Metasys Server Lite Installation and Upgrade Instructions Wizard (LIT ). Note: The Windows 10, Windows 8.1, Windows 7, Windows Server 2012 R2, Windows Server 2012, and Windows Server 2008 R2 operating systems include Microsoft.NET Framework version 3.5/ (Use the Turn Windows features on or off option in Control Panel > Programs > Programs and Features to add this component.) We recommend you also install Microsoft.NET Framework version if you are using Windows 10, Windows 8.1, Windows Server 2012 R2, or Windows Server Microsoft Office Professional 2013, Microsoft Office Enterprise 365, Microsoft Office Professional 2010, or Microsoft Office Professional 2007 software to generate reports Notes: To extract data to Microsoft Excel or Microsoft Access software, you must have the respective software installed on the computer running Export Utility. Export Utility can extract data to 32-bit and 64-bit versions of Microsoft Office. However, the DLL file and example files used to create custom reports are compatible only with 32-bit versions of Microsoft Office. Microsoft Office Professional 2013 and Microsoft Office 2010 do not support custom DLL files. 1 Our computer platform and memory recommendations are not meant to imply that older or slower machines are not usable. Refer to the Metasys System Configuration Guide (LIT ) for more information regarding computer/server recommendations. Building Technologies & Solutions 507 E. Michigan Street, Milwaukee, WI Metasys and Johnson Controls are registered trademarks of Johnson Controls. All other marks herein are the marks of their respective owners Johnson Controls Published in U.S.A. 5

Metasys Export Utility Installation Instructions Code No. LIT Software Release 9.0 Issued August 2017

Metasys Export Utility Installation Instructions Code No. LIT Software Release 9.0 Issued August 2017 Code No. LIT-12011527 Software Release 9.0 Issued August 2017 Refer to the QuickLIT website for the most up-to-date version of this document. Introduction...2 Summary of Changes...2 Metasys Help Files...2