MS-ADVGRF-0 Code No. LIT-12011525 Software Release 9.0 Issued August 2017 Refer to the QuickLIT website for the most up-to-date version of this document. Document Introduction...2 Summary of Changes...2 Advanced Graphics Application Overview...2 Microsoft Visio Professional or Standard Software...2 Scalable Vector Graphics (SVG)...2 System Requirements...2 Graphics Creation...2 Graphics Viewing...3 Installation Sequence...3 Licensing...3 Detailed Procedures...3 Installing the Advanced Graphics Application...3 Troubleshooting...10 Creating a New User with Windows Login Authentication for SCT Standalone Computer...12 Related Documentation...12 Technical Specifications...13 1
Document Introduction This document describes how to install or upgrade the Advanced Graphics Application (AGA). For information on configuring and using the Advanced Graphics Application to create system graphics for the Metasys system, refer to the Advanced Graphics Application Help (LIT-1201850). Summary of Changes The following information is new or revised: Updated Table 3 and Table 4 for new operating system support. Note: Although the installation wizard images are not updated, the steps included in this document do apply to the Release 9.0 software installation. Advanced Graphics Application Overview The Advanced Graphics Application is an enhanced graphics creation package that provides dynamic graphic capabilities such as animation, color changing, and flashing for the Metasys system. The package includes a dynamic example stencil library and serves as an add-on to Microsoft Visio 2003, 2007, or 2010 Professional or Standard edition software (32-bit version only). With a more comprehensive representation of facility support systems, building operators can easily monitor the health of the system on a more intuitive interface. After you create advanced graphics using the Advanced Graphics Application, you view them from within the Site Management Portal (SMP) UI. Microsoft Visio Professional or Standard Software Important: When using the Windows 8.1 Pro or Enterprise (64-bit) operating system (OS) or the Windows 7 Professional, Enterprise, or Ultimate Edition (32-bit or 64-bit) OS, run Microsoft Visio software as an administrator so that the Advanced Graphics Application add-on is visible in the Visio add-on menu. The Advanced Graphics Application, which is designed to work with Microsoft Visio 2003, 2007, or 2010 Professional or Standard edition software (32-bit only), includes a stencil sheet mechanism that allows you to create stencil libraries. The Advanced Graphics Application includes the Graphics Example stencil, a library of dynamic HVAC components. Important: The Advanced Graphics Application is not supported on either Microsoft Visio 2013 or Visio for Office 365. Scalable Vector Graphics (SVG) The SVG file format is an XML-based web standard and is viewable and editable in any text editor, much like HTML documents. The World Wide Web Consortium (www.w3.org) maintains the SVG specification. The Advanced Graphics Application complies with the SVG specification for dynamic SVG graphics. Important: When saving scalable vector graphics for Metasys systems, use the Save Advanced Graphics option rather than the Save As option. System Requirements To create advanced graphics, you need the Advanced Graphics Application software and other prerequisites, depending on your configuration. See Graphics Creation. To view advanced graphics, you need access to the System Configuration Tool (SCT) UI or Application and Data Server/Extended Application and Data Server (ADS/ADX) computer. See Graphics Viewing. Graphics Creation Graphics creation requires that you first meet the system requirements defined in Table 3. These software prerequisites and associated system requirements are necessary when you install the Advanced Graphics Application on any computer regardless of whether or not it has SCT or ADS/ADX software already installed on it. 2
See the Installation Sequence section for information on the installation order of the required software. Graphics Viewing Advanced graphics viewing takes place in the SMP UI, which means you can view AGA graphics on any client computer that has access to the SMP UI. See Graphics Creation for the system requirements necessary to create graphics. Installation Sequence On a stand-alone computer, install the prerequisite software and the Advanced Graphics Application in the following order: 1. A supported Microsoft Windows operating system. See the Technical Specifications section for a list of supported Windows operating systems. 2. Microsoft.NET Framework Version 3.5 Service Pack (SP) 1 (included on the Advanced Graphics Application product disk). 3. Microsoft Visio 2003, 2007, or 2010 Professional or Standard edition software (32-bit version only; order separately). 4. Advanced Graphics Application (included on the Advanced Graphics Application product disk and the ADS/ADX product disk). On computers with SCT or ADS/ADX software, the operating system and Microsoft.NET Framework are already installed according to the installation sequence defined for the ADS/ADX or SCT. Install the remaining prerequisite software and the Advanced Graphics Application in the following order: 1. Microsoft Visio 2003, 2007, or 2010 Professional or Standard edition software (32-bit version only; order separately). 2. Advanced Graphics Application (included on the Advanced Graphics Application product disk and the ADS/ADX product disk). Licensing Activate the Advanced Graphics Application license using the instructions in the Software License Activator Technical Bulletin (LIT-1201654). You must activate the Advanced Graphics Application license with its own Site Key. You must license the Advanced Graphics Application immediately after installation. Detailed Procedures Installing the Advanced Graphics Application Note: If you try to upgrade the Advanced Graphics Application on a computer with older ADS or ADX software installed, you are required to upgrade the ADS/ADX software to the same release level as the AGA software. If you upgrade the Advanced Graphics Application on a computer that does not have ADS/ADX software, you can perform the update but may need to relicense the Advanced Graphics Application software after the upgrade is complete. The installation software installs the Advanced Graphics Application and a library of sample symbols (Graphics Example stencil). To install the Advanced Graphics Application: 1. Verify that the computer meets the requirements described in the Technical Specifications section, and make sure all prerequisite software is installed according to the Installation Sequence section. 3
Note: If Microsoft Visio 2003, 2007, or 2010 Professional or Standard edition (32-bit version only) software is not installed on the computer, install it according to the Installation Sequence section before proceeding. 2. Insert the Advanced Graphics Application product disk or ADS/ADX product disk. Navigate to and double-click Setup.exe. 3. If this is a new installation, the Metasys AGA Welcome screen appears. Click Next to continue. Figure 1: Metasys AGA Welcome Screen (New Installation) If this is a major upgrade, a dialog box appears (Figure 2) asking whether you would like to remove all Metasys system license keys or cancel the upgrade. Click Yes. Figure 2: Metasys AGA Major Upgrade Question Note: AGA software requires you to remove the keys and relicense during major upgrades only. The Metasys AGA major upgrade dialog box (Figure 2) does not appear for minor upgrades. You must license Metasys software after a new installation. For details, refer to the Software License Activator Technical Bulletin (LIT-1201654). To delete the license keys and continue with the upgrade, click Yes. You then must relicense all Metasys software after the upgrade is complete. Go to Step 1. To cancel the upgrade and preserve the license keys, click No. The upgrade stops and the InstallShield Wizard Completed screen appears (Figure 11). Click Finish. 4. The InstallShield Wizard checks for the prerequisite software that is listed in the Technical Specifications section. If Microsoft Visio 2003 or higher Professional or Standard edition software is installed and the ADS/ADX 4
software check passes, the License Agreement screen appears (Figure 3). Read the license agreement and click I accept the terms of the license agreement, click Next, and continue to Step 5. Figure 3: License Agreement Screen If Microsoft Visio 2003 or higher Professional or Standard edition software is not installed, or if the InstallShield Wizard detects Visio 2013 on the computer, an error screen appears (Figure 4). An additional message appears in the error screen if you have ADS/ADX software installed on your computer that is a different version than the AGA software. Click Next. Figure 4: Error Message Visio Not Installed The InstallShield Wizard Completed screen appears (Figure 5) indicating that the wizard was interrupted. Click Finish, install Microsoft Visio 2003, 2007, or 2010 Standard or Professional software, and then upgrade the ADS/ADX software if required. Return to this section to restart the Advanced Graphics Application installation. 5
Figure 5: InstallShield Wizard Completed Screen Wizard Interrupted If an older version of Visio is installed on your computer, an alert appears regarding Visio upgrades. Click Yes to proceed with the installation using your current version of Visio. Click No if you wish to cancel setup and upgrade your version of Visio. If you choose to continue the installation with your current version of Visio, the License Agreement screen appears (Figure 3). Note: To upgrade Visio later, you need to uninstall AGA, upgrade Visio, and then run the Metasys AGA setup again. Visio 2013 and Visio for Office 365 are not supported. 5. The Custom Setup screen appears (Figure 6). Select AGA Generation and click Next. Figure 6: Custom Setup Screen 6. The Destination Folder screen appears (Figure 7). Click Change to choose a different location or click Next to accept the current location. 6
Note: AGA Generation includes the Advanced Graphics generation add-on and Graphics Example stencil. Figure 7: Destination Folder Screen 7. The Ready to Install the Program screen appears. Figure 8: Ready to Install the Program Screen Click Install. The Installation Progress screen appears. 7
Figure 9: Installation Progress Screen If this is a minor upgrade, a dialog box appears (Figure 10) asking whether you want to remove all Metasys system license keys. Figure 10: Metasys AGA Minor Upgrade Question To delete the license keys and relicense, click Yes. You then must relicense all Metasys software after the upgrade is complete. Go to Step 1. To continue with the upgrade and preserve the license keys, click No. 8. Click Finish on the Installation Completed screen. 8
Figure 11: Installation Completed Screen Click Yes at the prompt to restart your computer, or click No if you wish to restart your computer later. Figure 12: Restart Computer Prompt Important: If you have completed a new installation or have upgraded to a major release, you must license the Advanced Graphics Application software. See the Licensing section for details. The Advanced Graphics Application installation is complete. You can now create a new symbol or create and edit a graphic. Refer to the Advanced Graphics Application Help (LIT-1201850) for procedures. 9
Troubleshooting Table 1 lists the problems you may encounter when installing the Advanced Graphics Application and possible solutions. Table 1: Installation Troubleshooting Message Solution AGA Instance is running. Please close them to proceed! Do you want to uninstall the License Activator and all license keys? Clicking Yes will remove license keys for ALL installed Metasys products. Do you want to completely remove the selected Application and all of its features? Appears when you attempt to install or uninstall the Advanced Graphics Application while it is running or while the Metasys Database Manager is running. Click OK and close the Advanced Graphics Application or exit the Metasys Database Manager. Then, restart the installation or removal process. Appears when you are uninstalling Metasys AGA. Click Yes to remove the License Activator software and license keys for all installed Metasys software products. Click No to remove just the Metasys AGA license key. Appears when you uninstall the Advanced Graphics Application. Click Yes to remove the application. 10
Table 1: Installation Troubleshooting Message Solution Error while creating Save Advanced Graphics Menu. The Advanced Graphics Application is not licensed. Please contact JCI Support group for further details. Visio Instance(s) are running and will be closed by the Metasys AGA setup. Please save your changes, if any. Please refer to C:\Users\[Username]\AppData\ Roaming\AGAInstallLog.htm for more information. Appears when the required version of the office file (a.dll file) is missing on your computer and the AGASetupMenu add-on cannot access the version required to create the Save Advanced Graphics menu option. This error occurs when the Visio 2003, 2007, or 2010 software is installed before the.net Framework. Click OK. One solution is to uninstall the Advanced Graphics Application, the Visio software, and the.net Framework, and then install them in the order specified in the Installation Sequence section. Note: A valid software installation key is required to reinstall Visio 2003, 2007, or 2010 software. A second solution requires that you install the required version of the office.dll file. To install this file: For Visio 2003: 1. Shut down the Visio 2003 application on your computer. 2. Insert a Visio 2003 CD in your computer and browse to the PA561401.cab directory on the CD. 3. In the PA561401.cab directory, copy (or drag) the office.dll file and paste (or drop) the file in the C:\windows\assembly directory. 4. Start the Visio 2003 application. For Visio 2007: 1. Shut down the Visio 2007 application on your computer. 2. Insert a Visio 2007 CD in your computer and browse to the VisPro.WW directory on the CD. 3. In the VisPro.WW directory, open the contents of the VisProWW.cab file and locate the office.dll file. Copy (or drag) the office.dll file and paste (or drop) the file in the C:\windows\assembly directory. 4. Start the Visio 2007 application. For Visio 2010: 1. Shut down the Visio 2010 application on your computer. 2. Insert a Visio 2010 CD in your computer and browse to the Visior.WW directory on the CD. 3. In the Visior.WW directory, open the contents of the VisiorWW.cab file and locate the office.dll file. Copy (or drag) the office.dll file and paste (or drop) the file in the C:\windows\assembly directory. 4. Start the Visio 2010 application. The required file is installed and AGA should operate as intended. The product requires a license and Site Key. Contact your local Johnson Controls representative. Appears when you attempt to install or uninstall the Advanced Graphics Application while Visio software is running. Go to Visio and save your file, then click OK to allow the installer to close the Visio software and continue with Metasys AGA installation or uninstallation. If you do not save your file, Visio prompts you to save changes before continuing. 11
Creating a New User with Windows Login Authentication for SCT Standalone Computer When the Release 8.1 version of AGA is installed on an SCT computer with SCT version 11.1, AGA cannot access the SCT archive database when you select Actions > Show Attributes in the AGA Binder. This issue is due to the default Metasys user name having a dynamic and encrypted password at SCT version 11.1. To workaround this issue, add a new user with Windows login authentication to the SCT archive database. 1. On the SCT computer, open SQL Management Studio, and connect to the SCT computer. Or, use Remote Desktop Connection and access the SCT computer to open and connect to the SCT computer. 2. In the Object Explorer, expand the Database folder and then expand the SCT archive database folder. 3. Right-click the Security folder and select New > User. 4. In the Database User - New window, select Windows user from the User type drop-down menu. The Select User or Group dialog box appears. 5. Type in the username in the Enter the objects name to select field. Click Check Names. 6. Click OK. 7. Enter the same username in the Login name field. 8. For the Default schema field, click the browse button. The Select Schema dialog box appears. 9. Click the Browse button next to the Enter the object names to select field. The Browse for Objects dialog box appears. 10. Select the db_owner option and click OK. 11. Click OK in the Database User - New window. Related Documentation Table 2: Related Information For Information On See Document Metasys System Metasys System Terms and Acronyms How to Install or Upgrade an ADS/ADX How to Install or Upgrade SCT How to Activate the Advanced Graphics Application License How to Configure and Use the Advanced Graphics Application How to Use the User Graphics Tool Metasys System Configuration Guide (LIT-12011832) Metasys System Extended Architecture Glossary Technical Bulletin (LIT-1201612) Metasys Server Installation and Upgrade Instructions Wizard (LIT-12012162) SCT Installation and Upgrade Instructions (LIT-12012067) Software License Activator Technical Bulletin (LIT-1201654) Advanced Graphics Application Help (LIT-1201850) User Graphics Tool (UGT) section of the Metasys SMP Help (LIT-1201793) 1 This LIT number represents a printer-friendly version of the Help. 12
Technical Specifications Table 3: Advanced Graphics Application System Requirements (Graphics Generation) Recommended Computer/Server Platform 1 Stand-Alone Computer Platform 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 SCT or ADS/ADX Computer Platform 2.8 GHz Pentium 4 processor with 80 GB hard disk (2.0 GHz Pentium 4 processor with 40 GB hard disk minimum) 20 GB free space on the hard disk (C: drive) after installing all prerequisite software and before installing the ADS software DVD drive Prerequisite software includes the supported OS, database software,.net Framework, and any other software or Service Packs required for your ADS configuration. Supported Operating Systems 2 Windows 8.1 Pro and Enterprise Editions with Update 1 (64-bit) Windows 7 Professional, Enterprise, and Ultimate Editions with SP1 (64-bit) or Windows 7 Professional, Enterprise, and Ultimate Editions with SP1 (32-bit) Windows Server 2012 R2 with Update 1 (64-bit) Windows Server 2012 (64-bit) Other Required Software Software Included on the Advanced Graphics Application Product Disk Microsoft Visio 2003, 2007, or 2010 Standard or Professional Edition (32-bit only; purchased separately) Advanced Graphics Application Microsoft.NET Framework Version 3.5 SP1 Note: Windows 8.1, Windows 7, Windows Server 2012 R2, and Windows Server 2012 have the.net Framework built into the operating system. You do not have to install it separately. 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. 2 Advanced Graphics Application does not support installation on a Windows 10 Enterprise and Pro Editions (64-bit) computer. 13
Table 4: Advanced Graphics Application Client Requirements (Graphics Viewing) Metasys Supported Operating Systems Windows 10 Pro and Enterprise Editions with Anniversary Update (version 1607) (64-bit) Note: The Windows 10 Anniversary Update (version 1607) is required for any Windows 10 computer that runs Metasys software, including the ADS/ADX/ODS. Verify this update is installed before installing or upgrading Metasys software. From the Start menu, type Winver in the Windows search bar. Click Winver to open About Windows. If you are upgrading Metasys software before installing this update, you must do the following: 1. uninstall the previous versions of all Metasys software 2. install the Windows 10 Anniversary Update (version 1607) 3. install the latest Metasys software Windows Server 2016 (64-bit) Windows 8.1 Pro and Enterprise Editions with Update 1 (64-bit) Windows 7 Professional, Enterprise, and Ultimate Editions with SP1 (64-bit) or 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) 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 14