Code No. LIT-12011685 Software Release 1.3.1 Issued February 2017 Refer to the QuickLIT website for the most up-to-date version of this document. Introduction...2 Summary of Changes...2 Related Documentation...2 Prerequisites...2 Upgrade Considerations...3 Detailed Procedures...4 Installing Microsoft.NET Framework Version 4.0...4 Installing the Graphic Generation Tool...4 Upgrading the Graphic Generation Tool...8 Changing the Default Language for GGT...12 Troubleshooting...14 Technical Specifications...16 1
Introduction This document describes how to install or upgrade the Graphic Generation Tool (GGT) application for use with the Metasys system. The Graphic Generation Tool is used to create, open, save, customize, and configure Microsoft Silverlight based graphics. The Graphic Generation Tool provides a palette of graphic elements, known as the Graphic Enterprise Library (GEL), that lets you create detailed graphic representations of your building automation system. The tool also lets you communicate with Metasys hosts and child devices. In turn, this communication allows you to be more productive when creating, saving and modifying graphics because the graphics communicate directly with their Metasys system. Summary of Changes The following information is new or revised: Updated Table 1 for link to Microsoft Silverlight documentation. Updated Prerequisites to clarify that only Microsoft Silverlight is required for viewing Graphics+ graphics in the Site Management Portal UI, System Configuration Tool UI, and the Ready Access Portal UI. Updated Table 6 in Technical Specifications for Windows 10 operating system support. Updated to remove Windows Server 2008 and Windows Internet Explorer versions that are no longer supported. Related Documentation Table 1 lists documentation related to the Graphic Generation Tool. Table 1: Related Documentation For Information On Metasys System How to Install Microsoft Silverlight How to Use the Graphic Generation Tool and the Graphic Enterprise Library (GEL) Features Included in the Graphic Generation Tool How to Build Standard Johnson Controls Graphics See Document Metasys System Configuration Guide (LIT-12011832) Ready Access Portal Software Installation Instructions (LIT-12011523) or https://www.microsoft.com/silverlight/ Graphic Generation Tool Help (LIT-12011697) Graphics+ Product Bulletin (LIT-12011698) Graphics+ Style Guide Help (LIT-12011705) 1 Use the wizard to generate instructions specific to your system. Prerequisites The prerequisites for using the Graphic Generation Tool depend on whether you intend to use the tool to create graphics and use the Site Management Portal or Ready Access Portal to view graphics. Use of the GGT in a language other than English requires an additional prerequisite. If you need to create graphics only: verify the computer has Microsoft.NET Framework Version 4.0 software before you install the Graphic Generation Tool. To verify that Microsoft.NET Framework Version 4.0, go to Control Panel > All Control Panel Items > Programs and Features. This application is included on the Graphic Generation Tool product media. See Installing Microsoft.NET Framework Version 4.0 if you need to install this application. Note: The full version of Microsoft.NET Framework Version 4.0 software is included in the product media. If you do not have access to the product media, you can download the software from here: http://www.microsoft.com/en-us/download/details.aspx?id=24872. If you need to create and view graphics: verify the computer has Microsoft.NET Framework Version 4.0 software before you install the Graphic Generation Tool. To verify that Microsoft.NET Framework Version 4.0, go to Control Panel > All Control Panel Items > 2
Programs and Features. See Installing Microsoft.NET Framework Version 4.0 if you need to install this application. Note: The full version of Microsoft.NET Framework Version 4.0 software is included in the product media. If you do not have access to the product media, you can download the software from here: http://www.microsoft.com/en-us/download/details.aspx?id=24872. install Microsoft Silverlight 5.0 or later. To install Microsoft Silverlight, go to https://www.microsoft.com/getsilverlight/get-started/install/default.aspx. Note: Microsoft Silverlight 5.0 or later is required for viewing Graphics+ graphics in the Site Management Portal UI, System Configuration Tool UI, and the Ready Access Portal UI in Internet Explorer 11. When viewing Graphics+ graphics in the Metasys UI, Microsoft Silverlight 5.0 or later is not required. verify your site is at least at the latest patched version of Release 5.2. Note: You only need to install Metasys system patch 5.2.12 if you are working with Metasys Release 5.2. If you require the Graphic Generation Tool in a language other than English, you need to install the Language Installation Program (LIP) and apply the appropriate translated language pack on the same computer as the GGT. For details, refer to the Language Installation Program Installation Instructions (LIT-12011793). Upgrade Considerations If you are upgrading GGT, the upgrade process does not affect any existing Graphics+ objects in the Metasys system; it simply updates the Metasys Graphics package. The functionality of all existing graphics is retained. After you complete the upgrade, some new Version 1.3 features become available automatically, while others require user action. See Table 2. Table 2: Features and Enhancements Available After Upgrade Feature or Enhancement Available Automatically User Action Required Addition of any new graphic element to an existing graphic Addition of keyboard shortcuts for menu functions Add the new graphic element as desired. New elements are available under this library category: HVAC Air Coils (Gas Coil). User action depends on the function. For example, to use the Duplicate keyboard shortcut, select an element on the canvas and press CTRL+D. Changes to panels X (The Metasys Binding Panel is now two panels: the Metasys Host Tree panel and the Binding Properties panel) Ability to show or hide and lock or unlock elements in the Document Tree X Addition or modification of behaviors Addition of the Color property to the HVAC pipes and HVAC pumps Performance improvements for the graphics display in the Site Management Portal X The Behaviors panel is automatically available, but the addition of new behaviors requires manual configuration. Edit the HVAC Pipes or HVAC Water Pumps element to change the color to any desired color. User action is required to reduce the size of large dimension images within graphics that contain the Image element. Refer to the Image subsection of the Graphic Enterprise Library section of the Graphic Generation Tool Help (LIT-12011697). 3
Detailed Procedures Installing Microsoft.NET Framework Version 4.0 To install the full version of Microsoft.NET Framework Version 4.0 software: 1. Insert the Graphic Generation Tool product disc. 2. Browse to the.net Framework 4.0 folder on the product disc. 3. Double-click dotnetfx40_full_x86_x64.exe. 4. Follow the.net Framework Setup installation instructions until the installation is complete. Note: After installing.net Framework 4.0 on a computer running other Metasys software, you may need to restart the computer. For example, on an Application and Data Server (ADS), the Metasys III Device Manager service may stop while you are installing.net Framework 4.0. Normal operation of the System Configuration Tool (SCT) and Ready Access Portal may be disrupted as well. Note: We recommend that you do not install the GGT on an ADS or ADX directly. Installing the Graphic Generation Tool When you install the Graphic Generation Tool, the install program installs both the Graphic Generation Tool and the Metasys Graphics Package. You use the Graphic Generation Tool to create and modify graphics. You deploy the Metasys Graphics Package to a Metasys host during a host update that you can initiate through the tool. This package contains the graphics libraries that let you view the graphics using the Metasys Site Management Portal and Ready Access Portal. For more information on the Metasys Graphics Package, refer to the Deploying Graphics Package Updates section of the Graphic Generation Tool Help (LIT-12011697). Note: To upgrade the Graphic Generation Tool, see Upgrading the Graphic Generation Tool. 4
Table 3: Graphic Generation Tool Installation Steps 1. Start. Insert the Graphic Generation Tool product disc. 2. Figure 1: Welcome Screen Browse to the Graphic Generation Tool folder on the disc. Double-click Graphic_Generation_Tool_1.3.1.xxxx.exe (where xxxx represents the build number). Notes: In Windows 10, Windows 8.1, and Windows 7, a dialog box may appear asking you to verify whether you want to allow the installation to continue. Click Continue or Yes. The installation wizard extracts the installation files. During the extraction process, the installation wizard displays two progress indicator screens. These screens automatically close once the extraction completes. When the file extraction process finishes, the Welcome to the Setup Wizard for Johnson Controls - Graphic Generation Tool 1.3 screen appears. Click Next. 5
Table 3: Graphic Generation Tool Installation Steps 3. Figure 2: Destination Folder Screen The Destination Folder screen appears. If desired, click Change to install the Graphic Generation Tool in a location other than the default location. Click Next. 4. Figure 3: Associate XAML Files Screen The Associate XAML Files screen appears. If you want to register files with the XAML file extension as Graphic Generation Tool files, select the Associate files with.xaml extension to launch Graphic Generation Tool option. We recommend you select this option. With this option, you can open any XAML graphic by simply double-clicking the file. Click Next. 5. Figure 4: Ready to Install the Program Screen The Ready to Install the Program screen appears. Click Install. 6
Table 3: Graphic Generation Tool Installation Steps 6. Figure 5: InstallShield Wizard Completed Screen When the installation completes, the InstallShield Wizard Completed screen appears. Click Finish. 7. Figure 6: Update Metasys Host The InstallShield Wizard Completed screen closes. Start the GGT and update the Graphics+ package on each Metasys host and SCT using the File > Update Metasys Host option in the GGT. For details, see Figure 6 and refer to the Graphic Generation Tool Help (LIT-12011697). If the Metasys system has a Ready Access Portal server, the Ready Access Portal server updates within 15 minutes of the Site Director's update. 8. Done. If you need to use the Graphic Generation Tool with a language other than English, see Changing the Default Language for GGT. 7
Upgrading the Graphic Generation Tool If you need to upgrade the Graphic Generation Tool to a new version, you do not need to uninstall the existing version. The upgrade product media automatically overwrites the existing version. Before you begin the upgrade procedure, however, be sure that the Graphic Generation Tool is not running. Table 4: Graphic Generation Tool Upgrade Steps 1. Start. Insert the Graphic Generation Tool upgrade product disc. 2. Figure 7: Upgrade Dialog Box Browse to the Graphic Generation Tool folder on the disc. Double-click Graphic_Generation_Tool_1.3.0.xxxx.exe (where xxxx represents the build number). Notes: A dialog box may appear asking you to verify whether you want to allow the installation to continue. Click Continue or Yes. The installation wizard extracts the installation files. During the extraction process, the installation wizard displays two progress indicator screens. These screens automatically close once the extraction completes. When the file extraction process finishes, you are asked whether you want to upgrade the software. Click Yes. 8
Table 4: Graphic Generation Tool Upgrade Steps 3. Figure 8: Welcome Screen The Welcome to the Setup Wizard for Johnson Controls - Graphic Generation Tool 1.3 screen appears. Click Next. 4. Figure 9: Destination Folder Screen The Destination Folder screen appears. If desired, click Change to install the Graphic Generation Tool in a location other than the default location. Click Next. 9
Table 4: Graphic Generation Tool Upgrade Steps 5. Figure 10: Associate XAML Files Screen The Associate XAML Files screen appears. If you want to register files with the XAML file extension as Graphic Generation Tool files, select the Associate files with.xaml extension to launch Graphic Generation Tool option. We recommend you select this option. With this option, you can open any XAML graphic by simply double-clicking the file. Click Next. 10
Table 4: Graphic Generation Tool Upgrade Steps 6. Figure 11: Ready to Install the Program Screen The Ready to Install the Program screen appears. Click Install. Note: The installation wizard upgrades the Graphic Generation Tool 1.1 or 1.2 to Version 1.3. During the installation process, the installation wizard displays a progress indicator screen. This screen automatically closes once the installation completes. 7. Figure 12: InstallShield Wizard Completed Screen When the upgrade completes, the InstallShield Wizard Completed screen appears. Click Finish. 11
Table 4: Graphic Generation Tool Upgrade Steps 8. Figure 13: Update Metasys Host The InstallShield Wizard Completed screen closes. Start the GGT and update the Graphics+ package on each Metasys host and SCT using the File > Update Metasys Host option in the GGT. For details, see Figure 13 and refer to the Graphic Generation Tool Help (LIT-12011697). If the Metasys system has a Ready Access Portal server, the Ready Access Portal server updates within 15 minutes of the Site Director's update. 9. Done. If you need to use the Graphic Generation Tool with a language other than English, see Changing the Default Language for GGT. Changing the Default Language for GGT Note: Use the following procedure to change the language used for menus, messages, and tool tips in the Graphic Generation Tool. The LIP tool is required for these steps. 1. Using the LIP tool, add any languages you need to support. 2. Start GGT. 3. Click the View > Options menu item. The Options dialog box appears. Figure 14: Language Options Selection 4. Click the Language tab. 5. In the Display Language field, select your language. 6. Click Save, and then click OK in the Changing Language alert box.. 12
Figure 15: Language Change Confirmation 7. Restart the GGT for the language change to take effect. 13
Troubleshooting Table 5 provides troubleshooting information for the Graphic Generation Tool application. Table 5: Troubleshooting Problem When you install the Graphic Generation Tool, you see a message stating that an Admin user profile is required. When you install or upgrade the Graphic Generation Tool, the following error message appears: The Graphic Generation Tool must not be running when installing or upgrading. Please close the Graphic Generation Tool and click Retry or click Exit to end Setup. You are installing.net Framework 4.0 on a computer running other Metasys software, and the Metasys software stops running. Solution Exit the installation program and install the software using a computer account that has Administrator privileges. Note: The installation log includes information about error messages that you may encounter when you install the Graphic Generation Tool. This information may help you resolve an error message. You can find the installation log in the following locations. Windows 7 and Windows Server 2008 R2: C:\Users\<user name>\appdata\roaming \GraphicToolInstallLog.htm Save your work and close the Graphic Generation Tool application. Then, click Retry in the message box or start the installation program again. Follow the instructions in Upgrading the Graphic Generation Tool. Restart the computer. Note: If a disruption occurs on the SCT or on the Ready Access Portal, restart this device as well. 14
Table 5: Troubleshooting Problem Solution You are installing.net Framework 4.0 on a computer that already has this application installed. The following dialog box appears: Close this dialog box by clicking the X in the upper right corner of the screen. Continue installing. When you attempt to update the System Configuration Tool (SCT) or the Application and Data Server (ADS) with the latest Graphics+ Package via the Update Metasys Hosts command in the Graphic Generation Tool (GGT), you may receive an error at 99%. The Graphics+ Package does not update. This error occurs with the SCT or the ADS at Metasys Release 5.2 with a Graphics+ Package for Release 1.1 or 1.2. or You are a Metasys for Validated Environment (MVE) site and branch laptops or external storage devices cannot be connected to the SCT or ADS. To manually update the SCT or ADS with the latest Graphics+ Package: 1. Ensure that you have access to any installed GGT application so the ADS or the SCT can be manually updated. 2. Locate the MetasysGraphicsPackage.zip file. If you do not have access to any installed GGT application, contact your local Johnson Controls branch representative for the MetasysGraphicsPackage.zip file. For Windows 7, and Windows Server 2008 R2, the zip file is located here: C:\Program Files (x86)\johnson Controls\XAML Graphics Components\Metasys Graphics Package\V1\ 3. Extract the contents of MetasysGraphicsPackage.zip into the following location: For the computer on which SCT is installed: C:\Inetpub\wwwroot\MetasysIII\ToolUI Note: Accept any file overwrite prompts. Two files are replaced when you extract the contents of the zip file: C:\inetpub\wwwroot\MetasysIII\UI\ClientBin\Metasys.Graphics.Viewer.xap and C:\Inetpub\Wwwroot\MetasysIII\UI\com\jci\metasys\MetasysGraphicsPackage.properties. For the ADS: C:\Inetpub\wwwroot\MetasysIII\UI Note: Accept any file overwrite prompts. Two files are replaced when you extract the contents of the zip file: C:\Inetpub\wwwroot\MetasysIII\UI\Metasys.Graphics.Viewer.xap and C:\Inetpub\Wwwroot\MetasysIII\UI\com\jci\metasys\MetasysGraphicsPackage.properties. 4. In the GGT, verify the Graphics+ Package updated by selecting File > Update Metasys Hosts. The Update Metasys Host window appears. 5. In the GGT, select the Metasys Host (either the SCT or the Site Director) and select Connect. 6. In the GGT, the next window displays all the discovered Metasys Hosts. Ensure the correct Graphics+ Package version is listed in the Graphics Version column. If the correct version is listed, close the window. If the correct version is not listed, repeat the workaround. 15
Technical Specifications Table 6: Graphic Generation Tool Application Product Code Recommended Computer/Server Platform 1 Recommended Memory 1 Supported Operating Systems Additional Requirements Web Browser Support for Graphics+ Viewing Software Included on the Product Media MS-GGT-0 (new) MS-GGT-6 (upgrade) Intel Core 2 Duo E6700 or better (Intel Core 2 Duo E4300 minimum) 100 MB free hard disk space available DVD drive 4 GB RAM (2 GB RAM Minimum) Windows 10 Pro and Windows 10 Enterprise Editions with Anniversary Update (version 1607) (64-bit) Note: The Windows 10 Anniversary Update (version 1607) is required for any Windows 10 computer that runs Metasys, including the ADS, ODS, and any Metasys software application. Verify this update before installing Metasys software. If you are upgrading to Metasys software and do not have this update, you must uninstall the previous release of all Metasys software, apply the Windows 10 Anniversary Update (version 1607), then proceed with the Metasys software upgrade. Windows 8.1 and Windows 8.1 Pro Editions with Update 1 (64-bit) Windows 7 Professional, Enterprise, or Ultimate Editions with SP1 (32-bit and 64-bit) Windows Server 2012 R2 with Update 1 Windows Server 2012 Windows Server 2008 R2 with SP1 Microsoft.NET Framework 4.0 Note: We recommend you install the full version of Microsoft.NET Framework 4.0. Windows Internet Explorer Version 11 Notes: In Internet Explorer 11, select the Use Microsoft compatibility lists option, found under Tools > Compatibility View Settings, to ensure that websites appear and function correctly. Microsoft Silverlight 5.0 or later is required for viewing Graphics+ graphics in the Site Management Portal UI, System Configuration Tool UI, and the Ready Access Portal UI in Internet Explorer 11. When viewing Graphics+ graphics in the Metasys UI, Microsoft Silverlight 5.0 or later is not required. Google Chrome version 54 or later Apple Safari 10 or later Graphic Generation Tool 1.3.1 Metasys Graphics Package 1.3 Microsoft.NET Framework 4.0 1 Our computer platform and memory requirements 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. 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 16