| Вид документа | Інструкція з монтажу |
|---|---|
| Виробник | JCI |
| Код документа | metasys-export-utility-installation-instructions |
| Група обладнання | Metasys Export Utility |
| Сторінок | 14 |
| Мова документа | англійська |
| Розмір файлу | 1.1 МБ |
Текст документа
Metasys® Export Utility Installation Instructions
Code No. LIT-12011527
Software Release 9.0
Issued August 2017
Introduction................................................................................................................................2
Summary of Changes................................................................................................................2
Metasys Help Files.....................................................................................................................2
Concepts.....................................................................................................................................2
Overview..............................................................................................................................................2
System Requirements...........................................................................................................................2
User Interface........................................................................................................................................2
Supported File Formats........................................................................................................................2
Export Utility Authentication..................................................................................................................3
Licensing...............................................................................................................................................3
Detailed Procedures..................................................................................................................4
Installing Export Utility.......................................................................................................................4
Upgrading Export Utility.....................................................................................................................7
Deleting Leftover Microsoft Excel Files (Upgrade Only).................................................................9
Activating the Export Utility License..............................................................................................10
Starting Export Utility.......................................................................................................................10
Troubleshooting.......................................................................................................................10
Specifying the Set Service Login Properties.................................................................................10
Related Documentation...........................................................................................................12
Technical Specifications.........................................................................................................13
Metasys® Export Utility Installation Instructions 1
Introduction
This document describes how to install and upgrade the Export Utility application for use with the Metasys® system.
Summary of Changes
Supported programs and servers were updated in Table 6.
Metasys Help Files
The Metasys Help files provide shared system information and individualized mode-dependent information for the
Metasys Site Management Portal (SMP) or the System Configuration Tool (SCT). The Metasys® SMP Help
(LIT-1201793) provides information about alarming, commanding, auditing live data values, and other online features.
The Metasys® SCT Help (LIT-12011964) provides information about offline operations such as managing archives,
creating spaces, simulating systems, and establishing equipment and serving relationships.
In either SMP or SCT mode, the Metasys Help menu provides Help files in PDF format.
Concepts
Overview
The Export Utility is based on the Windows® operating system (OS) that uses Web Services to extract data from
the Metasys system. It runs from an Application and Data Server/Extended Application and Data Server (ADS/ADX),
an Open Data Server (ODS), or from a stand-alone computer on the same network.
The Metasys system Export Utility extracts historical trend, alarm, and audit data from the Network Automation
Engine (NAE)/Network Integration Engine (NIE)/Network Control Engine (NCE), ADS/ADX, or ODS. This data is
then provided in several file formats, such as Microsoft Excel® spreadsheet and Access database, as selected by
the user. The user can instantly extract the selected data or schedule an extraction at a convenient time or interval.
Note: If you encounter an out-of-memory exception as you export data, select a smaller data set, or increase RAM.
System Requirements
See the Technical Specifications section for details.
All Metasys system devices from which you are extracting data must be at Release 2.0 or later.
User Interface
The Export Utility provides a user-friendly wizard that allows the user to enter data-filtering criteria and scheduling
intervals to extract trend, alarm, audit data, and output file types.
Supported File Formats
The Export Utility extracts user-defined data to any of the following file formats:
• Microsoft Excel (.xls)
• Tab-delimited text (.txt)
• Comma-separated value (.csv)
• Microsoft Access (.mdb)
• HTML (.htm)
• XML version 1.0 (.xml)
Metasys® Export Utility Installation Instructions 2
Note: • If you change the extension on the Advanced tab of the Export Output Selection dialog box, the Export
Utility only creates output reports using the supported extension types. For example, if you rename a
.htm file extension with a .html extension on the Advanced tab, Export Utility creates the file with a .htm
extension.
• Scheduled Export using the Excel format (.xls) is not supported on Windows Server® 2016, Windows
Server® 2012 R2, or Windows Server® 2012. Microsoft Excel reports generation on a Windows 8.1 64-bit
machine running on a virtual machine (VM) using the MSEASchedulerService is not supported. All other
export formats are supported. We recommend using .csv format for the Scheduled Export and then
manually importing the .csv file into Excel and saving it in Excel format.
• Windows Server 2016, Windows Server 2012 R2, and Windows Server 2012 support On Demand Export
using Excel format.
Export Utility Authentication
The user must have login credentials with the Site Director and have login credentials and permissions to view the
data to be extracted with the Export Utility. The user must know the IP address or the host name of the Site Director.
The Export Utility follows Metasys system 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.
Licensing
The Export Utility can be purchased with the ADS/ADX, with the ADS-Lite or ODS, or as a separate program, so
there are two ways to activate the license. Use the instructions in the Software License Activator Technical Bulletin
(LIT-1201654) in either case.
We recommend that you license Metasys software immediately after installation. For complete licensing details,
refer to the Software License Activator Technical Bulletin (LIT-1201654).
Export Utility licenses are sold per computer (not per site). For more information on Export Utility licensing, refer to
the Metasys® Export Utility Product Bulletin (LIT-1201800).
Export Utility with an ADS/ADX or ODS
If you purchase the Export Utility with an ADS/ADX or ODS, use one Site Key to license all software programs
together.
Export Utility on Stand-Alone Computer
On a stand-alone computer (not on the computer that has the ADS/ADX or ODS installed), activate the Export Utility
license with its own Site Key.
Metasys® Export Utility Installation Instructions 3
Detailed Procedures
Installing Export Utility
Note: To upgrade the Export Utility, see Upgrading Export Utility.
Table 1: Export Utility Software Installation Steps
1. Start Microsoft Message Queue (MSMQ) installation is required
before the Export Utility may be installed.
1. Open the Control Panel window.
2. Click Programs and Features. The Uninstall or change
a program window appears.
3. Click Turn Windows features on or off. The Windows
Features dialog box appears.
4. Select Microsoft Message Queue (MSMQ) Server.
5. Click Ok.
Now that MSMQ is installed, Export Utility may be installed.
Insert the Export Utility product disk.
Using Microsoft Windows Explorer, browse to the Export
Utility folder.
Double-click setup.exe.
2. Figure 1: Welcome Screen Click Next.
3. Figure 2: License Agreement Click the option to accept the license agreement.
Note: If you do not accept, the Next button remains
disabled, and you must click Cancel.
Click Next.
Metasys® Export Utility Installation Instructions 4
Table 1: Export Utility Software Installation Steps
4. Figure 3: Destination Folder Screen If you do not want to use the default folder for installation of
the Export Utility files:
1. Click Change.
2. Browse to the desired path.
3. Click OK.
Click Next.
5. Figure 4: Database Folder Screen If you do not want to use the default destination folder for
the Export Utility definition files or reports:
1. Click Change.
2. Browse to the desired path.
3. Click OK.
Click Next.
6. Figure 5: Custom Setup Screen Select whether to install the Metasys Export Utility Scheduler
feature.
Click Next.
Metasys® Export Utility Installation Instructions 5
Table 1: Export Utility Software Installation Steps
7. Figure 6: Ready to Install the Program Screen Click Install.
The Metasys Export Utility installation screen indicates the
status of the installation.
Note: The Export Utility looks for the .NET Framework,
Version 3.5 SP1, which is included on the Metasys
Export Utility installation media.
8. Figure 7: InstallShield Wizard Complete Screen Click Finish.
Restart the computer.
An Export Utility shortcut automatically appears on the
desktop, and a Scheduler icon appears in the system tray.
Note: Metasys Release 3.1 and later Export Utility
installations automatically register the
MetasysExportUtility.dll for use with custom
programming. The batch file is included as well in
case of installation failure.
9. Done The installation is complete.
If you are upgrading Export Utility, see Deleting Leftover
Microsoft Excel Files (Upgrade Only). Otherwise, go to
Activating the Export Utility License, and then refer to the
Export Utility Help for information on using Export Utility to
create and schedule data extracts to software applications.
Metasys® Export Utility Installation Instructions 6
Upgrading Export Utility
Note: To upgrade the Export Utility, you must uninstall the current version of the software and then install the new
version.
Table 2: Export Utility Software Upgrade Steps
1. Start If the Metasys Export Utility Schedule Controller icon is
visible in the Windows taskbar, right-click the icon and
click Exit.
2. Figure 8: Add or Remove Programs Uninstall Export Utility using the Control Panel > Programs
and Features feature.
1. Click Metasys Export Utility in the Uninstall or change
a program list.
2. Click Uninstall.
Note: Alternatively, you can uninstall Export Utility by
inserting the Export Utility product disk.
To uninstall Export Utility using the product disk, insert the
disk and follow these steps:
1. Using Microsoft Windows Explorer, browse to the Export
Utility folder.
2. Double-click setup.exe.
3. Follow the prompts to remove Export Utility from your
computer.
Note: You receive the same question boxes as in Step
5 through Step 8 in this table. Follow the same
instructions as in Step 5 through Step 8 to
uninstall Export Utility properly for upgrading.
3. Figure 9: Confirmation Dialog Box Click Yes.
4. Figure 10: Uninstallation Progress Indicator A Windows progress indicator displays progress during the
uninstall process. The progress indicator remains until the
Export Utility is removed.
Metasys® Export Utility Installation Instructions 7
Table 2: Export Utility Software Upgrade Steps
5. Figure 11: Files In Use Screen Several question boxes appear, depending on your
configuration.
Click Automatically close applications and attempt to
restart after setup is complete.
Click OK.
Note: Following this step, a series of dialog boxes appears.
Any of these dialog boxes may appear behind the
uninstallation progress indicator. If this happens,
move the progress indicator to make a selection in
the dialog box. If you do not move the progress bar
so that you can make a selection, you cannot
continue uninstalling.
6. Figure 12: Definitions Folder Dialog Box A dialog box to delete the definitions folder appears.
Click No.
7. Figure 13: License Activator and License Keys Dialog A dialog box to uninstall the License Activator appears.
Box
Click No.
8. Figure 14: ScheduleInfo File Dialog Box A dialog box to delete the ScheduleInfo file appears.
Click No.
Metasys® Export Utility Installation Instructions 8
Table 2: Export Utility Software Upgrade Steps
9. The progress indicator disappears when the uninstallation
is complete.
Note: You do not receive a confirmation that the
uninstallation was successful. However, the Export
Utility icons and shortcuts disappear from your
desktop and startup menu.
10. Done Restart the computer.
The Export Utility is now uninstalled.
Go to Installing Export Utility and install the new version of
the software.
Deleting Leftover Microsoft Excel Files (Upgrade Only)
If you have Microsoft Excel installed and you upgrade Export Utility, complete the following steps after upgrading
the Export Utility software:
1. Use Windows Explorer to browse to each of the folders in the left column of Table 3 and delete the files that
appear in the right column.
Table 3: Files To Delete
In this Folder:
1 Delete these Files:
In 64-bit operating systems: • ErrorHandler.dll
• C:\Program Files (x86)\Microsoft Office\Office • ErrorHandler.tlb
• C:\Program Files (x86)\Microsoft Office\Office9 • ExportUtility.Common.dll
• C:\Program Files (x86)\Microsoft Office\OFFICE10 • ExportUtility.Common.tlb
• C:\Program Files (x86)\Microsoft Office\OFFICE11 • JCIExtMetasysOS.dll
• C:\Program Files (x86)\Microsoft Office\OFFICE12 • JCIExtMetasysOS.tlb
• C:\Program Files (x86)\Microsoft Office\OFFICE14 • MetasysMessaging.dll
• C:\Program Files (x86)\Microsoft Office\OFFICE15 • MetasysMessaging.tlb
• MSEAExportDLL.dll
In 32-bit operating systems:
• MSEAExportDLL.tlb
• C:\Program Files\Microsoft Office\Office
• Subsystems.Common.dll
• C:\Program Files\Microsoft Office\Office9
• Subsystems.Common.tlb
• C:\Program Files\Microsoft Office\OFFICE10
• WebServices.Common.dll
• C:\Program Files\Microsoft Office\OFFICE11
• WebServices.Common.tlb
• C:\Program Files\Microsoft Office\OFFICE12
• C:\Program Files\Microsoft Office\OFFICE14
• C:\Program Files\Microsoft Office\OFFICE15
1 The path may be different if you installed Microsoft Office in an alternate location. All or none of these folders may exist.
If other folders exist with similar names, delete the files in the right column from those folders, too.
2. In 64-bit operating systems, delete the folder: C:\Program Files (x86)\Microsoft Office\xml.
In 32-bit operating systems, delete the folder: C:\Program Files\Microsoft Office\xml.
3. Go to Activating the Export Utility License, and then refer to the Export Utility Help for information on using Export
Utility to create and schedule data extracts to software applications.
Metasys® Export Utility Installation Instructions 9
Activating the Export Utility License
To activate the license, see Licensing, and refer to the Software License Activator Technical Bulletin (LIT-1201654).
Starting Export Utility
To start Export Utility, double-click the Export Utility icon on your desktop; or from the Start menu, click Programs
> Johnson Controls > Metasys > Metasys Export Utility. The Metasys Export Utility - Log In dialog box appears
(Figure 15).
Figure 15: Metasys Export Utility - Log In Dialog Box
Note: Press F1, or click Help in the Help menu, to access Metasys Export Utility Help for details on logging in to
and using Metasys Export Utility.
Troubleshooting
See Table 4 and the following section for troubleshooting information.
Table 4: Troubleshooting
Problem Solution
An error message appears stating that the application failed In this case, Microsoft Excel cannot open or save any more
to create the Excel output file. documents because there is not enough available memory or
disk space. This scenario occurs when using a virtual machine
setup. To work around this issue, use On Demand Export
instead of MSEASchedulerService. You can also free up
memory and disk space by doing the following:
• To make more memory available, close workbooks or
programs you no longer need.
• To free disk space, delete files you no longer need from the
disk to which you are saving Excel reports.
Specifying the Set Service Login Properties
You can activate the Set Service Login feature by adjusting the parameters of the Windows OS service called
MSEASchedulerService.
To specify the Set Service Login properties:
1. In Control Panel, double-click Administrative Tools.
2. Double-click Services. The Services screen appears.
3. In the Name column, right-click MSEASchedulerService and then click Stop.
Metasys® Export Utility Installation Instructions 10
Note: To see the user under which the service is currently running, look in the right-most column (Log On As).
Local System, Local Service, and Network System are standard Windows OS accounts.
4. Double-click MSEASchedulerService. The MSEASchedulerService Properties dialog box appears (Figure 16).
5. On the Log On tab, click to select This Account.
6. Enter your Windows operating system user name.
Note: If the Network directory is located on a different domain, enter the domain name followed by your Windows
operating system user name (for example, Workgroup\Admin).
7. Enter and confirm your Windows operating system password.
8. Click OK and close the Services screen.
Figure 16: MSEASchedulerService Properties Dialog Box
9. Right-click MSEASchedulerService and then click Start in the pop-up menu.
Metasys® Export Utility Installation Instructions 11
Related Documentation
The following table lists documentation related to the Export Utility.
Table 5: Related Documentation
For Information On See Document
Metasys System Requirements Metasys® System Configuration Guide (LIT-12011832)
ADS/ADX Installation Metasys® Server Installation and Upgrade Instructions Wizard
(LIT-12012162)
SCT Installation SCT Installation and Upgrade Instructions (LIT-12012067)
ADS-Lite Installation Metasys® Server Lite Installation and Upgrade Instructions Wizard
(LIT-12012258)
Open Data Server System (ODS) ODS Installation and Upgrade Instructions Wizard (LIT-12011945)
Installation
Trends Trend Extensions section of the Metasys® SMP Help (LIT-1201793)
Alarms Alarm and Event Management section of the Metasys® SMP Help
(LIT-1201793)
Audits Audit Trail section of the Metasys® SMP Help (LIT-1201793)
How to Extract Data in Multiple Formats Metasys® Export Utility Help (LIT-1201952)
Software License Activation Software License Activator Technical Bulletin (LIT-1201654)
Metasys® Export Utility Installation Instructions 12
Technical Specifications
Table 6: Export Utility System Requirements
Product Code MS-EXPORT-0
Recommended Intel® Core® 2 Duo E6700 or better (Intel Core 2 Duo E4300 minimum)
Computer/Server
1 20 GB free hard disk space available (600 MB minimum)
Platform
DVD drive
When Export Utility is installed on an ADS/ADX or ODS, follow the requirements for an ADS/ADX.
Refer to the Application and Data Server (ADS) and Extended Application and Data Server (ADX)
Product Bulletin (LIT-1201525), the Application and Data Server (ADS) Lite-E Product Bulletin
(LIT-12011690), or the Application and Data Server (ADS) Lite-A Product Bulletin (LIT-12011694).
When Export Utility is installed on an Open Data Server (ODS), follow the requirements for an
ODS. Refer to the Open Data Server Product Bulletin (LIT-12011943).
Recommended Memory
1 Computer Platforms: 2 GB RAM (1 GB RAM minimum)
Server Platforms: 4 GB RAM (2 GB RAM minimum)
Supported Operating Windows® 10 Pro and Enterprise Editions with Anniversary Update (version 1607) (64-bit)
Systems
Note: The Windows 10 Anniversary Update (version 1607) is required for any Windows 10
computer that runs Metasys software, including the ADS/ADX/ODS. Verify this update is
installed before installing or upgrading Metasys software. From the Start Menu, type Winver
in the Windows search bar. Click Winver to open About Windows.
If you are upgrading Metasys software before installing this update, you must do the
following:
1. uninstall the previous versions of all Metasys software
2. install the Windows 10 Anniversary Update (version 1607)
3. install the latest Metasys software
Windows® 8.1 Pro and Enterprise Editions with Update 1 (64-bit)
Windows® 7 Professional, Enterprise, and Ultimate Editions with SP1 (64-bit)
Windows® 7 Professional, Enterprise, and Ultimate Editions with SP1 (32-bit)
Windows® Server® 2016 (64-bit)
Windows® Server® 2012 R2 with Update 1 (64-bit)
Windows® Server® 2012 (64-bit)
Additional Software Microsoft .NET Framework version 3.5 SP1
Included on the Product
For steps on installing .NET Framework, refer to the Metasys® Server Installation and Upgrade
Disks
Instructions Wizard (LIT-12012162), Metasys® Server Lite Installation and Upgrade Instructions
Wizard (LIT-12012258), or the ODS Installation and Upgrade Instructions Wizard (LIT-12011945).
Note: The Windows 10, Windows 8.1, Windows 7, Windows Server 2016, Windows Server 2012
R2 with Update 1, and Windows Server 2012 operating systems include Microsoft .NET
Framework version 3.5/3.5.1. These applications are built into the operating system (no
separate software installation is necessary). We recommend you also install Microsoft
.NET Framework version 4.5 if you are using Windows 8.1, Windows Server 2012 R2, or
Windows Server 2012 and Microsoft .NET Framework version 4.6 if you are using Windows
10.
Additional Requirements Microsoft Office Professional 2013, Microsoft Office 365®, Microsoft Office Professional 2007, or
(Order Separately) Microsoft Office Professional 2010 software to generate reports
Note: To extract data to Microsoft Excel or Microsoft Access software, you must have the software
installed on the computer that is running the Export Utility.
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 Technical Bulletin (LIT-12011279) for more information regarding computer or server
recommendations.
Metasys® Export Utility Installation Instructions 13
Building Technologies & Solutions
507 E. Michigan Street, Milwaukee, WI 53202
Metasys® and Johnson Controls® are registered trademarks of Johnson Controls.
All other marks herein are the marks of their respective owners.© 2017 Johnson Controls
Published in U.S.A. www.johnsoncontrols.com
Metasys® Export Utility Installation Instructions 14Позиції каталогу з цим документом
Документ виробника, опублікований як довідковий матеріал на обладнання, яке ми постачаємо. Правовласник може попросити прибрати його — приберемо.