DynAMo Metrics & Reporting Installation Guide M&R120-IG R120.1 Oct 2015 Release 120.1 Notices and Trademarks Copyright 2010 by Honeywell International Sárl. Release 120.1 Oct 2015 While this information is presented in good faith and believed to be accurate, Honeywell disclaims the implied warranties of merchantability and fitness for a particular purpose and makes no express warranties except as may be stated in its written agreement with and for its customers. In no event is Honeywell liable to anyone for any indirect, special or consequential damages. The information and specifications in this document are subject to change without notice. Honeywell and Experion PKS are registered trademarks of Honeywell International Inc. Other brand or product names are trademarks of their respective owners. Honeywell Process Solutions 1860 W. Rose Garden Lane Phoenix, AZ 85027 USA 1-800 822-7673 ii DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 Preface About this document This document explains how to install and configure the DynAMo Metrics & Reporting application in your site. Contacting Honeywell Support For information on contacting Honeywell Support, visit https://www.honeywellprocess.com/enUS/contact-us/customer-support-contacts/Pages/default.aspx. Reporting a security vulnerability For the purpose of submission, a security vulnerability is defined as a software defect or weakness that can be exploited to reduce the operational or security capabilities of the software. Honeywell investigates all reports of security vulnerabilities affecting Honeywell products and services. To report a potential security vulnerability against any Honeywell product, follow the instructions at: https://honeywell.com/pages/vulnerabilityreporting.aspx. Submit the requested information to Honeywell using one of the following methods: • Send an email to security@honeywell.com. -OR- Contact your local Honeywell Technical Assistance Center (TAC). R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide iii Contents 1. INTRODUCTION ..........................................................................11 1.1 About DynAMo Metrics & Reporting ........................................................... 11 1.2 Components of Metrics & Reporting........................................................... 11 Overview ..............................................................................................................................11 Basic components ................................................................................................................11 Client components ...............................................................................................................12 Cross-domain components ..................................................................................................12 2. DEPLOYMENT METHODS ..........................................................15 2.1 Overview ........................................................................................................ 15 2.2 Standard deployment method ..................................................................... 15 Overview ..............................................................................................................................15 Sample topologies................................................................................................................16 2.3 Special deployment methods ...................................................................... 19 Overview ..............................................................................................................................19 Collector on Level 2 Network (L2) ........................................................................................19 Basic components in Demilitarized Zone (L3.5) ...................................................................20 3. SYSTEM REQUIREMENTS .........................................................21 3.1 Hardware requirements ................................................................................ 21 3.2 Software requirements ................................................................................. 23 3.3 Security certificate requirements ................................................................ 25 4. INSTALLING METRICS & REPORTING .....................................26 4.1 Overview ........................................................................................................ 26 4.2 Workflow for upgrade ................................................................................... 26 Upgrading on old hardware ..................................................................................................26 Upgrading with new hardware ..............................................................................................27 4.3 Installing prerequisites ................................................................................. 27 Installing SQL Server ...........................................................................................................27 4.4 Common pre-install steps for all components ........................................... 28 Turning off User Account Control .........................................................................................29 R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide v Contents Tables Disabling Windows Update ................................................................................................. 30 4.5 Pre-install steps for Core component .........................................................30 Installing security certificates ............................................................................................... 30 Creating a non-default website ............................................................................................ 31 Configuring Secure Socket Layer (SSL).............................................................................. 34 4.6 Installing Metrics & Reporting components ...............................................36 4.7 Post-install steps ...........................................................................................41 Verifying the Installation ...................................................................................................... 41 Configuring firewall to allow communication ........................................................................ 42 Removing the HPSInstall user account ............................................................................... 43 Configuring Metrics & Reporting on L3................................................................................ 43 5. SETTING UP CROSS-DOMAIN ACCESS .................................. 44 5.1 Overview .........................................................................................................44 5.2 Installing cross-domain components ..........................................................44 5.3 Configuring cross-domain access ...............................................................44 Overview ............................................................................................................................. 44 Enabling cross-domain access ............................................................................................ 45 Configuring access to plant-level data................................................................................. 47 Configuring Metrics & Reporting on L4................................................................................ 50 6. SETTING UP CLIENT COMPONENTS ....................................... 51 6.1 Configuring remote clients ...........................................................................51 Setting the screen resolution ............................................................................................... 51 Configuring Trusted Site settings ........................................................................................ 51 7. MIGRATING OLD DATA ............................................................. 53 7.1 Overview .........................................................................................................53 7.2 Pre-migration steps .......................................................................................53 Verifying the prerequisites ................................................................................................... 53 Stopping the new Metrics & Reporting services .................................................................. 53 7.3 Migration .........................................................................................................54 Migrating old data ................................................................................................................ 54 Migrating rules files and post-processing scripts ................................................................. 58 Swapping the Collectors...................................................................................................... 59 Performing delta migration .................................................................................................. 59 Configuring data collection .................................................................................................. 60 vi DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 Contents Tables Finalizing data migration ......................................................................................................60 7.4 Post-migration steps .................................................................................... 61 Restarting the new Metrics & Reporting services .................................................................61 Configuring asset hierarchy..................................................................................................61 Configuring data archival .....................................................................................................61 Updating cache data ............................................................................................................62 Recent changes in calculations ............................................................................................62 8. LOCALIZING METRICS & REPORTING .....................................64 8.1 Overview ........................................................................................................ 64 Localization source files .......................................................................................................64 Workflow for localization ......................................................................................................64 8.2 Localizing the Metrics & Reporting screens .............................................. 65 Prerequisites ........................................................................................................................65 Modifying the Localization Source File (TTP) .......................................................................65 Building the Resource File (DLL) .........................................................................................66 Deploying a Resource File (DLL) .........................................................................................68 8.3 Configuring remote clients .......................................................................... 69 Overview ..............................................................................................................................69 Configuring language settings in browser ............................................................................69 9. UNINSTALLING METRICS & REPORTING ................................71 9.1 Overview ........................................................................................................ 71 9.2 Uninstalling the Metrics & Reporting components ................................... 71 Removing the program files .................................................................................................71 Removing the registry entries...............................................................................................72 Deleting obsolete files ..........................................................................................................72 R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide vii Contents Tables Table 1: Table 2: Table 3: Table 4: Table 5: Table 6: Table 7: Table 8: Table 9: Table 10: viii Basic components of Metrics & Reporting .....................................................11 Client components of Metrics & Reporting ....................................................12 Cross-domain components of Metrics & Reporting .......................................14 Standard deployment method ........................................................................15 Deploying Collector on Level 2 Network (L2) ................................................19 Deploying basic components in Demilitarized Zone (L3.5) ...........................20 Hardware requirements for Metrics & Reporting ...........................................21 Software requirements for Metrics & Reporting .............................................23 SQL Server installation options .....................................................................28 New features added to the rules files ............................................................58 DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 Contents Figures Figures Figure 1: Figure 2: Figure 3: Figure 4: Figure 5: Figure 6: Figure 7: R120.1 Oct 2015 Network layers in an enterprise ..................................................................... 13 Single-server topology ................................................................................... 16 Two-server topology ...................................................................................... 17 Three-server topology ................................................................................... 18 Turning off User Account Control (UAC) ....................................................... 29 Disabling Windows Update ........................................................................... 30 Cross-domain access configuration .............................................................. 45 DynAMo Metrics & Reporting Installation Guide ix 1. Introduction 1.1 About DynAMo Metrics & Reporting Metrics & Reporting is a software application that collects alarm and event data from various data sources, and presents the data in the form of intuitive reports to help you gain valuable insight into your plant's performance. The application also helps you to visually compare your alarm metrics against industry standards, and identify the deviations in seconds. 1.2 Components of Metrics & Reporting Overview Metrics & Reporting is a collection of software components that work together as one application. The components of Metrics & Reporting are classified into: • Basic components – These components are just enough to provide the basic features of Metrics & Reporting. • Client components – These components are used by end-users to access the features provided by basic components. • Cross-domain components – These are optional components. They allow you to access and analyze plant-level alarm/event data from the enterprise-level Business Network (L4) across the firewall. Basic components These components provide the basic features of Metrics & Reporting. The basic components of Metrics & Reporting are: Table 1: Basic components of Metrics & Reporting Component Description Core Hosts the Metrics & Reporting application (as a website) on the Process Control Network (L3) Database Contains the configuration data and the event data. Archiver Parses collected data, post-processes parsed data, and archives it in a database Collector Collects alarm and event data from event data sources Note: You can install Metrics & Reporting Collector on L2 network also. R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 11 1. Introduction 1.2. Components of Metrics & Reporting The basic components are installed on the Process Control Network (L3) of each plant. The scope of alarm/event data that can be analyzed using these components is limited to the plant where they are installed. Users from that plant’s (Process Control) network can access: • The Metrics & Reporting application via web browsers • The live alarm and event messages via the Metrics & Reporting Viewer Depending on the volume of your alarm data, capacity of your hardware, and various other factors, you can install all the basic components on a single computer or across (two or more) computers. Client components These components are used by the end-users to access the Metrics & Reporting features. These client components are: Table 2: Client components of Metrics & Reporting Component -None(Web browser for remote cients) Description Since the Metrics & Reporting application is hosted on a web server, it can be accessed just like any other website. Authorized users can access the application using their web browsers (eg. Internet Explorer). Viewer Displays live (real-time) alarm & event data as they are collected Cross-domain components These are optional components. They allow you to access and analyze plant-level alarm/event data across firewall from the enterprise-level Business Network (L4). The following illustration shows the network layers critical to Metrics & Reporting in a typical enterprise. 12 DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 1. Introduction 1.2. Components of Metrics & Reporting Figure 1: Network layers in an enterprise Consider an enterprise with 3 plants – Plant 1, Plant 2, and Plant 3. Users from the Process Control Network (L3) of Plant 1 can use Metrics & Reporting to access and analyze Plant 1’s data only. Similarly, users from Plant 2 and Plant 3 can access the respective plant’s data only. However, users from the business network (L4) can access the alarm/event data corresponding to any of the three plants. Some components of Metrics & Reporting must be installed only on your enterprise-level Business Network (L4), to enable your Business Network users to access and analyze any of your plant’s (alarm and event) data. These components are called cross-domain components. ATTENTION: Cross-domain components are optional components. You must install them only if you need cross-domain access, that is, if you want to access plant-level data from your enterprise(L4) network. R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 13 1. Introduction 1.2. Components of Metrics & Reporting The cross-domain components are: Table 3: Cross-domain components of Metrics & Reporting Component Core Web & Core App Description Hosts the Metrics & Reporting application (as a website) on the Business Network (L4) Acts as a proxy for the Core server installed in any of your plants’ Process Control Network (L3). On receiving any request from the remote (web) clients, this server internally redirects the request to appropriate L3 Core Server, receives the response, and sends this response back to the remote client. ATTENTION: You must always install these two components on the same computer. Database Contains the configuration and scheduling data of Metrics & Reporting Similar to the basic components, you can install the cross-domain components on a single computer or across two computers depending on the volume of your alarm data, capacity of your hardware, and various other factors. 14 DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 2. Deployment methods 2.1. Overview 2. Deployment methods 2.1 Overview This section explains where you must install each component of Metrics & Reporting within your enterprise’s computer network. 2.2 Standard deployment method Overview The components of Metrics & Reporting are designed to support many deployment methods. This section explains the simplest deployment method, referred to as the standard deployment method. In this method, the Metrics & Reporting components are installed as follows: Table 4: Standard deployment method Nework Process Control Network (typically called L3) Business Network (typically called L4) R120.1 Oct 2015 Components to be installed • Core • Database • Collector • Archiver • Viewer • Core Web • Core App • Database Description These components can be installed either on the same computer or on different computers or in combinations. Refer to the sample topologies provided in the next section. These are optional components; they are required only you need cross-domain access. DynAMo Metrics & Reporting Installation Guide 15 2. Deployment methods 2.2. Standard deployment method Sample topologies This section provides examples of the possible topologies for deploying the basic Metrics & Reporting components. Single-server topology Figure 2: Single-server topology 16 DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 2. Deployment methods 2.2. Standard deployment method Two-server topology Figure 3: Two-server topology R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 17 2. Deployment methods 2.2. Standard deployment method Three-server topology Figure 4: Three-server topology 18 DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 2. Deployment methods 2.3. Special deployment methods 2.3 Special deployment methods Overview The standard deployment method may not be possible in all sites due to some sitespecific constraints like hardware restrictions and IT security policies. Some sites require special deployment methods as explained in this section. Collector on Level 2 Network (L2) Use the following deployment method if you want to install the Collector on the Level 2 network (L2): Table 5: Deploying Collector on Level 2 Network (L2) Nework Description L2 – Level 2 Network • Collector - L3 Process Control Network • Archiver • Database • Core On the L3 network, these components can be installed either on the same computer or on different computers or in combinations • Viewer • Core Web • Core App • Database L4 Business Network R120.1 Oct 2015 Components to be installed These are optional components; they are required only you need cross-domain access. You must install these components on a single computer on the L4 network. DynAMo Metrics & Reporting Installation Guide 19 2. Deployment methods 2.3. Special deployment methods Basic components in Demilitarized Zone (L3.5) Use this deployment method only if: • you are migrating from DynAMo Metrics & Reporting Release 110.x • you have already deployed Metrics & Reporing components in Demilitarized Zone (L3.5) Install the Metrics & Reporting components as follows: Table 6: Deploying basic components in Demilitarized Zone (L3.5) Nework Description L3 Process Control Network • Collector - L3.5 Demilitarized Zone • Archiver • Database • Core On the L3.5 network, these components can be installed either on the same computer or on different computers or in combinations • Viewer • Core Web • Core App • Database L4 Business Network 20 Components to be installed These are optional components; they are required only you need crossdomain access. You must install these components on a single computer on the L4 network. DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 3. System requirements 3.1. Hardware requirements 3. System requirements 3.1 Hardware requirements The hardware required for hosting the Metrics & Reporting components depends on three important factors: • Number of Tags • Average Event Rate • Number of concurrent users accessing the system Based on these 3 variables, sites can be categorized into three types: Small system Medium system Large system Number of tags 10,000 25,000 75,000 Avg Event Rate 15,000 45,000 75,000 10 20 40 (events per hour) Number of concurrent users The following table lists the minimum and recommended hardware specifications for installing Metrics & Reporting components. Table 7: Hardware requirements for Metrics & Reporting (for small system) R120.1 Oct 2015 Supported hardware Archiver + Core + Database Server 3 Quad Core 24GB 48GB 2GHz 2GHz DynAMo Metrics & Reporting Installation Guide Minimum 3 Quad Core 21 320GB Recommended Hard disk Recommended Box #1 RAM Minimum Processor Recommended Singlebox Metrics & Reporting Components Minimum Deploym ent method 500GB 3. System requirements 3.1. Hardware requirements Recommended 58GB 320GB 320GB 24GB 24GB 500GB 1TB 48GB 64GB 320GB 320GB 16GB 24GB 320GB 320GB 24GB 32GB 750GB 2TB 2GHz 3 Quad Core 3 Quad Core 2GHz 2GHz Box #1 4 Quad Core 4 Quad Core Archiver 2GHz 2GHz Box #2 2 Quad Core 4 Quad Core 2GHz 2GHz 3 Quad Core 4 Quad Core 2GHz 2GHz Archiver + Core Server Box #2 Database Server Core Server Box #3 Database Server Notes: Minimum requirements are for viewing up to 6 months’ data Recommended hardware requirements are for viewing 2 years’ data 22 DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 Minimum Minimum 36GB 2GHz (for medium system) Hard disk 4 Quad Core 3 Quad Core Box #1 (for large system) RAM Recommended Processor Two-box Threebox Supported hardware Recommended Metrics & Reporting Components Minimum Deploym ent method 3. System requirements 3.2. Software requirements 3.2 Software requirements Following are the software requirements for the Metrics & Reporting components: Table 8: Software requirements for Metrics & Reporting R120.1 Oct 2015 Core Web & Core App Database Viewer Remote client - Desktop Windows 2012 R2 Server Standard Edition x64 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ Windows 2012 Server Standard Edition x64 ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ Windows 2008 R2 Server Standard Edition x64 SP1 or later ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ Windows 8.1 Professional x86/x64 ✓ ✓ ✓ Windows 8 Professional x86/x64 ✓ ✓ ✓ Windows 7 x86/x64 SP1 ✓ ✓ ✓ SQL Server 2014 Standard Edition x64 ✓ ✓ SQL Server 2012 Standard Edition x64 ✓ ✓ SQL Server 2008 R2 ✓ ✓ DynAMo Metrics & Reporting Installation Guide Remote client – Mobile device Collector Client components Archiver Crossdomain components Database Basic components Core Supported sofware 23 3. System requirements 3.2. Software requirements Client components Database ✓ Core Web & Core App ✓ Collector Microsoft Excel 2010 SP1 x86 Archiver ✓ Database ✓ Core Microsoft Excel 2013 Remote client – Mobile device Crossdomain components Remote client - Desktop Basic components Viewer Supported sofware Standard Edition x64 SP2 ✓ IIS 7.5 / 8 / 8.5 ✓ .NET Framework 4.5 (restart the computer after installing .NET framework) ✓ ✓ ✓ ✓ ✓ ✓ ✓ .NET Framework 3.5 (restart the computer after installing .NET framework) ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ Internet Explorer 11 (32-bit) Microsoft Silverlight 5.5 ✓ ✓ Microsoft Data Access Components (MDAC) R2.8 ✓ ✓ VC++ Runtime (Redistributable) Release 2005 SP1 or R2008 SP1 ✓ ✓ MSXML Version 6.0 ✓ ✓ Apple iOS 8 24 DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 3. System requirements 3.3. Security certificate requirements 3.3 Remote client - Desktop Remote client – Mobile device Client components Viewer Database Crossdomain components Core Web & Core App Collector Archiver Database Basic components Core Supported sofware Google Chrome ✓ Safari web browser ✓ Security certificate requirements SSL certificates are part of the standard security technology for establishing encrypted links between servers and clients. These links ensure that all data passed between computers remain private and integral. For Metrics & Reporting, you can use an X.509 SSL certificate if you want to secure your event data by signing and encrypting the following communication channels: 1. Cross-domain communications – communications between Business Network (L4) and Process Control Networks (L3) ATTENTION: For cross-domain communication, you must install the security certificate on Core Metrics & Reporting server on L3. 2. Intra-domain communications – communications between the server and clients within a network (L3/L4). You can acquire a certificate from any third-party vendor, and install it before installing Metrics & Reporting. The certificate might require periodic renewal. Visit https://technet.microsoft.com/en-us/library/cc731576.aspx for instructions on installing SSL certificates. R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 25 4. Installing Metrics & Reporting 4.1. Overview 4. Installing Metrics & Reporting 4.1 Overview This chapter explains how to install the basic components of Metrics & Reporting. ATTENTION: Before installing any component of Metrics & Reporting, ensure that: • − Your user account: − Is a domain user − Has local admin privileges Has write access to the Windows TEMP folder − • • 4.2 Is a sysadmin for the database server You have installed the latest: − Windows updates − Java 1.8 update 60 or higher (only on the Archiver computer) You have disabled the following on your computer: − anti-virus software (if you need to restart your computer during the installation, remember to disable your anti-virus software again) − firewall Workflow for upgrade Upgrading on old hardware If you want install Metrics & Reporting R120 on the existing set of computers that contain the old Metrics & Reporting, follow the workflow below: ATTENTION: While you install Metrics & Reporting R120 on the old hardware, event data will not be collected. 26 1. Uninstall all old Metrics & Reporting components. 2. Delete the Honeywell.MES.DynAMo.DataModel.Core database. 3. Install Metrics & Reporting R120 as explained in the subsequent sections. 4. Migrate the old data to new format as explained in the chapter “Migrating old data”. 5. Migrate your old rules files and post-processing scripts to the new format as explained in the chapter “Migrating old data”. DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 4. Installing Metrics & Reporting 4.3. Installing prerequisites Upgrading with new hardware If you want install Metrics & Reporting R120 on a fresh set of computers, follow the workflow below: 1. Install Metrics & Reporting R120 on a fresh (set of) computer(s) as explained in the subsequent sections (without stopping or uninstalling old Metrics & Reporting). ATTENTION: Ensure that the following databases do not exist on new target SQL Server instance: • Honeywell.MES.DynAMo.DataModel.Core • Honeywell.MES.Core.Service.Security • Honeywell.MES.Core.DataModel.SystemCatalogs 2. Migrate the old data to new format as explained in the chapter “Migrating old data”. 3. Migrate your old rules files and post-processing scripts to the new format as explained in the chapter “Migrating old data”. 4. Uninstall the old Collector and Archiver components. 4.3 Installing prerequisites Installing SQL Server ATTENTION: if you have purchased SQL Server along with DynAMo Metrics & Reporting from Honeywell, ignore this section and proceed to the next section. On the computer where you plan to install the database components (of Metrics & Reporting), install Microsoft SQL Server by referring to the Microsoft documentation. Select the following features while installing SQL Server: R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 27 4. Installing Metrics & Reporting 4.4. Common pre-install steps for all components Table 9: SQL Server installation options Page in the SQL Server installation wizard Feature Selection Instance Configuration Tasks to be performed Select the following features: • Database Engine Services • Client Tools Connectivity • Client Tools Backwards Compatibility • Management Tools – Basic • Management Tools – Complete Click Default instance or Named instance. For named instance, type instance name and instance ID. Server Configuration To ensure that the SQL services start automatically whenever you restart the server, set the Startup Type to Automatic for the following SQL services: • SQL Server Database Engine • SQL Server Browser Click Use the Same account for SQL Server services to select the account name from the drop-down list and click OK. Database Engine Configuration 4.4 Choose any one of the authentication modes. Click Add Current User. Only this user has complete access to the database engine. Common pre-install steps for all components This section explains the procedures that you must perform before installing any of the components of Metrics & Reporting. 28 DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 4. Installing Metrics & Reporting 4.4. Common pre-install steps for all components Turning off User Account Control Browse to Control Panel > User Accounts > User Accounts > Change User Account Control Settings and move the slider to Never Notify as shown in the following figure: Figure 5: Turning off User Account Control (UAC) Restart the computer after turning off UAC. R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 29 4. Installing Metrics & Reporting 4.5. Pre-install steps for Core component Disabling Windows Update Browse to Control Panel > System and Security > Administrative Tools > Services, open the Properties window of the Windows Update service, and set the Startup Type to Disabled. Figure 6: Disabling Windows Update ATTENTION: 4.5 • If the Windows Update service is already running, stop it. • You can re-enable Windows Update after the completion of Metrics & Reporting installation. Pre-install steps for Core component This section explains the procedures that you must perform before installing the Core component of Metrics & Reporting. Installing security certificates If you want to use an SSL certificate to secure all communications between your Metrics & Reporting components, install your SSL certificate as explained in the section Security certificate requirements on page 25. 30 DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 4. Installing Metrics & Reporting 4.5. Pre-install steps for Core component Creating a non-default website By default, the Metrics & Reporting is hosted on the default website (that uses port 80) on your IIS web server. If your computer already hosts another web site or web application that uses the default port (80), then you must create a non-default website that runs on a port number other than 80. ATTENTION: If you want to host Metrics & Reporting on your default website (port 80), ignore this procedure and proceed to the next section. To create a non-default website: Step Action 1 Insert the DynAMo R120.1 - Metrics & Reporting Installation Media and browse to the root folder. 2 Run the Prerequisite Checker Utility that is present in the following location within the installation media: \PreInstallChecker\Honeywell.Intuition.PreInstallChecker.exe The utility validates whether the prerequisites are available on your computer. The Intuition Environment Setup window appears and reports whether each prerequisite is available or missing. If all prerequisites are available, close the Intuiton Environment Setup window and continue with the installation. -ORIf one or more prerequisites are missing: a) Click Repair All to fix the errors. b) Restart the computer. If the missing prerequisites cannot be installed/configured automatically, an error message appears. Close the installer, correct the errors manually before continuing with this procedure. 3 Choose Start > Administrative Tools > Internet Information Services (IIS) Manager. The Internet Information Services (IIS) Manager dialog box appears. 4 Expand the node that represents your computer. 5 Right-click Sites and choose Add Web Site. The Add Web Site dialog box appears. R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 31 4. Installing Metrics & Reporting 4.5. Pre-install steps for Core component Step Action 6 In the Site Name box, type a name for the non-default website. 7 In the Physical Path box, type the path to the folder where the files for the website must be stored. If the folder does not exist, create it. 8 In the Port box, type a port number for your website. The recommended port number is 8080. However, if you have already created another website that listens to port 8080, type a different port number. 9 Click OK to close the dialog box and return to the the Internet Information Services (IIS) Manager window The non-default website is created and listed under Sites. 10 32 Create a net.tcp binding as follows: a) Right-click the non-default website that you created, and click Edit Bindings. b) The Site Bindings dialog appears. DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 4. Installing Metrics & Reporting 4.5. Pre-install steps for Core component Step 11 R120.1 Oct 2015 Action c) Click Add. The Add Site Binding dialog box appears. d) In the Type drop-down list, select net.tcp. e) In the Binding Information box, type 908:*. f) Click OK. If you want to use the HTTPS protocol, create a binding for https protocol as follows: a) Right-click the non-default website that you created, and click Edit Bindings. b) The Site Bindings dialog appears. c) Click Add. The Add Site Binding dialog box appears. DynAMo Metrics & Reporting Installation Guide 33 4. Installing Metrics & Reporting 4.5. Pre-install steps for Core component Step Action d) In the Type drop-down list, click https. e) In the Port box, type 443. f) In the SSL certificate drop-down list, select your security certificate. g) Click OK. Configuring Secure Socket Layer (SSL) Restrict non-https access on your website as explained in the following procedure: ATTENTION: If you are not using an SSL certificate to secure the communication between the Metrics & Reporting components, ignore this procedure and proceed to the next section. Step Action 1 Choose Start > Administrative Tools > Internet Information Services (IIS) Manager. The Internet Information Services (IIS) Manager dialog box appears. 2 34 Expand the tree and click the website (default or non-default) that you plan to use for hosting the Metrics & Reporting application. DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 4. Installing Metrics & Reporting 4.5. Pre-install steps for Core component Step 3 Action In the Features View, double-click SSL Settings. The SSL Settings page appears. R120.1 Oct 2015 4 Select the Require SSL check box. 5 On the right pane, click Apply. DynAMo Metrics & Reporting Installation Guide 35 4. Installing Metrics & Reporting 4.6. Installing Metrics & Reporting components 4.6 Installing Metrics & Reporting components This section explains how to install the Metrics & Reporting components on your computer(s). This procedure covers the installation procedure for all Metrics & Reporting components. ATTENTION: • The installation wizard displays or hides some of its screens/pages depending on the features you choose to install. If one of the screens/pages do not appear as explained in the procedure, ignore that step and proceed with the next step. To install Metrics & Reporting components: Step Action 1 Insert the DynAMo Metrics & Reporting installation media and browse to the root folder. ATTENTION: To install the basic components, use the DynAMo R120.1 - Metrics & Reporting Installation Media. -ORTo install the cross-domain components, use the DynAMo R120.1 Metrics & Reporting Cross Domain Media. 2 Right-click the setup.exe file and choose Run as Administrator. The DynAMo Metrics & Reporting installation wizard appears. ATTENTION: If required, you can copy the contents of the Metrics & Reporting installation media to your local computer and install it. However, you cannot run Metrics & Reporting setup from a shared folder on another computer. 3 Click Next. The License Agreement page appears. 4 Click I accept the terms in the License agreement, and then click Next. The Deployment Features Selection page appears. 5 36 Select the components that you want to install and click Next. DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 4. Installing Metrics & Reporting 4.6. Installing Metrics & Reporting components Step Action ATTENTION The Database feature can only be installed remotely. So, you must select to install the Database feature along with the Core feature. This is applicable for Basic components as well as Cross-domain components. If you select Archiver components or Database components, the wizard displays the to Install SQL 2012 SP2 check box. • To install SQL Server, select this check box. • If you already have SQL Server installed on this computer or on a separate database server, do not select this check box. The Feature and Options selection page appears. 6 Under Installation Path, the Install DynAMo to box displays the default installation folder. To install to a different folder, click Browse and select the alternate installation folder. ATTENTION: If you have chosen to install SQL Server, the wizard always installs SQL Server at the default installation folder (C:\Program Files (x86)\Microsoft SQL Server\) even if you provide a different (custom) folder for installation. R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 37 4. Installing Metrics & Reporting 4.6. Installing Metrics & Reporting components Step Action 7 Under Data Files Path: 8 a) The Set Data Files path to box displays the default folder where DynAMo stores its working data files. To use a different folder for this purpose, click Browse and select the alternate data folder. b) The Set Application Log Files Path to box displays the default folder where DynAMo stores its log files. To use a different folder for this purpose, click Browse and select the alternate log file folder. Click Next. The installation wizard validates whether the prerequisites are available on your computer. The Intuition Environment Setup window appears and reports whether each prerequisite is available or missing. If all prerequisites are available, close the Intuiton Environment Setup window and continue with the installation. -ORIf one or more prerequisites are missing: c) Click Repair All to fix the errors. d) Restart the computer. e) Start the DynAMo Metrics & Reporting installation wizard again. If the missing prerequisites cannot be installed/configured automatically, an error message appears. Close the installer, correct the errors manually and try installing DynAMo Metrics & Reporting again. 9 The Restore Configuration files page appears. For a fresh installation of Metrics & Reporting, ignore this page and click Next. -OR 38 DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 4. Installing Metrics & Reporting 4.6. Installing Metrics & Reporting components Step Action If you are migrating from an earlier version of Metrics & Reporting: 10 a) Under Migration, click Browse and select the folder that contains your old configuration files. b) Click Next. The Account Information page appears. a) In the SQL Server Name drop-down list, click or type the host name of the SQL Server computer. b) In the Database Instance box, type the name of the database instance that you want to create. The default name is DynArchive. ATTENTION: The Database Instance box appears only when you install from the DynAMo R120.1 - Metrics & Reporting Installation Media. c) In the Domain\User Name and Account Password fields, type the user name and the password of the runtime user account. After installation, the components of Metrics & Reporting run using this runtime user account. R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 39 4. Installing Metrics & Reporting 4.6. Installing Metrics & Reporting components Step Action ATTENTION: During installation, the runtime user account must have interactive logon permission. However, if required, you can remove this permission after completing the installation. d) 11 Click Next. The Web Site Selection page appears. a) In the Website selection drop-down list, click the website (default or non-default) for hosting the Metrics & Reporting application. Wait till the Net.Tcp Binding Information box displays the correct net.tcp port configured for the selected website. b) 12 Click Next. The MES Email Dispatcher – Mail Configuration page appears. Specify the information required by DynAMo Metrics & Reporting for sending automated email notifications: a) In the Sender’s Email ID box, type the email ID that must be displayed as the sender’s email ID in email notification messages. b) In the Default Email ID box, type the email ID that must be displayed as the “reply to” email ID in email notification messages. c) In the Server Name box, type the name of the SMTP email server that you want to use for sending email notification. In the Port Number box, type the SMTP port number of the above server. 13 The Archiver and Web Server Information page appears. ATTENTION: This page appears only when you install using the DynAMo R120.1 - Metrics & Reporting Cross Domain Media. a) Under DynAMo Intuition Web Server details, type the host name of the L3 Core server and the port number of the website (default or nondefault) that hosts the Metrics & Reporting application. ATTENTION: If you are using HTTPS, you must type the fully qualified name of the DynAMo Core server, as configured in the SSL certificate. 40 DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 4. Installing Metrics & Reporting 4.7. Post-install steps Step Action b) 14 Under DynAMo Archiver details, type the port number the Archiver must use for collecting alarm and event data. The default port number is 9001. Do not use any other port number. The Summary page appears and displays the list of features you have selected for installation. If you have chosen to install SQL Server 2012, the wizard prompts for the SQL Server media. Insert the SQL Server 2012 media and click Next. The wizard installs SQL Server. 15 When the installation is completed, insert the Metrics & Reporting media once again and click Install. The wizard installs the Metrics & Reporting database components on your computer. When the installation completes, a confirmation message appears. 16 Click OK to close the installation wizard. ATTENTION: To ensure that Metrics & Reporting operates as expected: 4.7 • Access to application binaries and configuration should be restricted and no system administrator shall make any modifications directly or indirectly on it. • The database administrator should not perform any data manipulation directly on the application database. Post-install steps Verifying the Installation The installation of the Metrics & Reporting is complete. Validate the installation as explained in the following steps: Step Action 1 Open Microsoft Internet Explorer. 2 Browse to the http://<server_name>/Default.aspx web page where <server_name> is the host name of the Metrics & Reporting core server. Specify your Windows domain user name and password when prompted to logon. 3 R120.1 Oct 2015 Verify whether the Honeywell Applications page appears after you login. DynAMo Metrics & Reporting Installation Guide 41 4. Installing Metrics & Reporting 4.7. Post-install steps Configuring firewall to allow communication Configure your Windows firewalls to allow communication through the following ports: Server Core Port 80 (for http) Data Direction Inbound Description For hosting the Metrics & Reporting application When remote clients access any Metrics & Reporting screen from their browsers, this port receives the http request. 443 (for https) ATTENTION: 25 If you have hosted Metrics & Reporting on a non-default website that uses a different TCP port instead of port 80 (for http) or 443 (for https), you must configure firewall to allow communication through that port. • If you are using cross-domain access, you must also configure your physical firewall to allow cross-domain communications through this port. Outbound To communicate with the Email Server to send scheduled reports by email 449 or custom Outbound & inbound To communicate with core server on Business Network (L4) 449 (or custom) Outbound & inbound To communicate with core server(s) on each Process Control Network (L3) Collector 8541 Outbound & inbound To communicate with the Archiver computer Archiver 8540 Outbound & inbound To communicate with the Viewer computer(s) 8541 Outbound & inbound To communicate with the Collector computer Cross domain Core 42 • DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 4. Installing Metrics & Reporting 4.7. Post-install steps Server Viewer Email server (typically the same as Core server) Port Data Direction Description 8540 Outbound & inbound To communicate with the Archiver computer 8543 Outbound & inbound To communicate with the Health Monitor service 25 Outbound To communicate with the core server For instructions on configuring Windows Firewall, visit the following webpage: http://msdn.microsoft.com/en-us/library/hh168549(v=nav.70).aspx. Removing the HPSInstall user account During the installation, the installation wizard automatically creates a local Windows user account named HPSInstall. You can delete this user account. Configuring Metrics & Reporting on L3 From any computer on the Process Control Network (L3), perform the configuring tasks explained in the topic “Configuration tasks in Metrics & Reporting” in the Metrics & Reporting Help Center. You can access the help center by clicking the screen. R120.1 Oct 2015 icon from any Metrics & Reporting DynAMo Metrics & Reporting Installation Guide 43 5. Setting up cross-domain access 5.1. Overview 5. Setting up cross-domain access 5.1 Overview You must enable cross-domain access if you want to access plant-level data from your Business (L4) Network. This chapter explains how to enable cross-domain access in Metrics & Reporting. 5.2 Installing cross-domain components You can install all the three cross-domain components on one computer or across two computers depending on various factors such as the volume of data, hardware specifications used, and so on. On the Business Network, install the cross-domain components of Metrics & Reporting. The installation procedures for cross-domain components are similar to the procedures for the basic components explained in the previous chapter. 5.3 Configuring cross-domain access Overview Configuration of cross-domain access involves the following steps: Task to be performed 44 Computer on which to perform the task Network where the computer resides Enabling cross-domain access Core server Process Control Network (L3) of each plant Configuring access to plant level-data Any computer Business Network (L4) (accesses the Core Web server on the Business Network via web browser) DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 5. Setting up cross-domain access 5.3. Configuring cross-domain access The following illustration provides an overview of the cross-domain configuration: Figure 7: Cross-domain access configuration Enabling cross-domain access If you want to allow your Business Network (L4) users to access and analyze your plant’s alarm and event data, you must enable cross-domain access on the Core Metrics & Reporting server of that plant. ATTENTION: Execute this procedure on the Core server that you have deployed in the Process Control Network (L3) of each of your plants. R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 45 5. Setting up cross-domain access 5.3. Configuring cross-domain access To enable cross-domain access: Step 1 Action On the Core server, right-click Start > All Programs > Honeywell > DynAMo > Utils > Honeywell Cross Domain Config Utility and choose Run as Administrator. The Cross Domain Access Configuration dialog box appears. ATTENTION: On Windows 2012 Server, run the Honeywell Cross Domain Config Utility application. 2 Click Yes, Allow Access. ATTENTION: Any time in future, you can disable cross-domain access for this server by opening this Cross Domain Access Configuration dialog box, clicking No, Deny Access, and then clicking Apply Changes. 3 In the IIS Web Site Name box, type a new website name. When you run the utility, a new IIS website is created with this name. If you type the name of an existing IIS website, the utility deletes the website and creates a new website with the same name. 4 In the Port Number box, type the port number for accessing the website. The firewall on the Process Control Network (L3) of the plant must be configured to allow communications through that port. The communication 46 DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 5. Setting up cross-domain access 5.3. Configuring cross-domain access Step Action 5 In the L4 Server IP Address box, type the IP address of the DynAMo Business Network Core Server that you will set up on the Business Network (L4). Only this server can access the DynAMo Metrics & Reporting data from L4. 6 Under Security Mode, select one of the following options: • HTTP – enables cross-domain access without security • HTTPS – enables cross-domain access through Secure Socket Layer (SSL). All cross-domain communications are encrypted and transmitted through SSL. Click Select SSL Certificate and select the security certificate file that you installed earlier. 7 Click Apply Changes. The utility saves the configuration information you provided. Configuring access to plant-level data You must configure your Core server on the Business Network (L4), so that, it can recognize connect to and access data from the Core server in each of your plants (L3). To configure the access: Step 1 Action From any remote computer on your Business Network (L4), access the Metrics & Reporting application using the following URL: http://<L4_core_server>:<port_no>/default.aspx where: 2 • <L4_core_server> - host name DynAMo Business Network Core Server • <port_no> - port number of the website that hosts the DynAMo Business Network Core Web Servers In the Honeywell Applications page, click Metrics and Reporting. The Select DynAMo System page appears. R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 47 5. Setting up cross-domain access 5.3. Configuring cross-domain access Step 3 Action Click Add New System. The Add New DynAMo System page appears. 4 In the Display Name box, type a descriptive name to refer to the plant network that you want to connect to. 5 In the DynAMo Core Server Name box, type the fully qualified name of the L3 Core server on the plant network. Fully qualified name is the name of the computer in the following format: host_name.domain_name.com 6 48 In the Port Number box, type the port number on which the Core server is hosted on the plant (L3) network. DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 5. Setting up cross-domain access 5.3. Configuring cross-domain access Step Action 7 Under Transport Security, click the protocol to be used for all cross-domain communication (between L4 and L3 networks). The available options are HTTP or HTTPS. This selection must match the cross-domain configuration settings of that plant. (Cross-domain configuration is performed on each plant’s L3 network as explained in the section “Enabling cross-domain access” on page 45). 8 Click Save to save the information that you provided, and click Close to exit the Select Instance page. 9 Similarly, you can configure access to any number of plant networks. Henceforth, whenever you access Metrics & Reporting, all the plants that you configured are listed on the home page as shown in the following figure: Click one of the plants in the list to open the Metrics & Reporting dashboard and view that plants alarm data. • R120.1 Oct 2015 To return back to the Select DynAMo System screen, click the Select DynAMo System icon on the navigation pane. DynAMo Metrics & Reporting Installation Guide 49 5. Setting up cross-domain access 5.3. Configuring cross-domain access Step Action • You can modify or delete the configuration by clilcking the respective icons when your move your mouse over that system. Configuring Metrics & Reporting on L4 From any computer on the Business Network (L4), configuring the user accounts for your users as explained in the topic “Configuring user accounts” in the Metrics & Reporting Help Center. You can access the help center by clicking the screen. 50 icon from any Metrics & Reporting DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 6. Setting up client components 6.1. Configuring remote clients 6. Setting up client components 6.1 Configuring remote clients Setting the screen resolution Metrics & Reporting is designed to be viewed with a screen resolution of 1920 pixels x 1080 pixels. It is recommended that you set the screen resolution of your computer to match this. Configuring Trusted Site settings This section explains how to add the host name of the L3 Core server (for computers on L3) or L4 Core Web server (for computers on L4) to the list of trusted websites so that the security settings of your browser do not hinder the execution of the Metrics & Reporting scripts. Step Action 1 Open Microsoft Internet Explorer. 2 Click the Tools button, and choose Internet Options. The Internet Options dialog box appears. R120.1 Oct 2015 3 Click the Security tab, and then click Trusted sites. 4 Click Sites. DynAMo Metrics & Reporting Installation Guide 51 6. Setting up client components 6.1. Configuring remote clients Step Action The Trusted sites dialog box appears and displays the list of trusted sites. 5 6 52 Add your DynAMo server to the list as follows: a) In the Add this website to the zone box, type http://<App_Server>/ where <App_Server> is the fully-qualified name (FQN) of the L3 Core server or L4 Core Web server as applicable. a) Click Add to add the URL to the Websites list. Add about:blank to the trusted sites list as follows: a) In the Add this website to the zone box, type about:blank. b) Click Add to add the URL to the Websites list. 7 Click Close to close the Trusted sites dialog box. 8 Click OK to close the Internet Options dialog box. DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 7. Migrating old data 7.1. Overview 7. Migrating old data 7.1 Overview If you are migrating from an earlier release of DynAMo Metrics & Reporting, you must follow the procedures explained in this chapter to migrate your existing data to Metrics & Reporting R120. 7.2 Pre-migration steps Verifying the prerequisites Before you migrate your old data, ensure that: • The new Archiver computer has SQL Server client components installed (This is not required if SQL Server already exists on this computer) • Your old and new database servers have the same “Collation” setting • You have enough free hard disk space on the database server computer (typically, more than three times the size of your old Metrics & Reporting database). Stopping the new Metrics & Reporting services Stop the following Windows services on the Collector & Archiver computer(s): • Collector • Archiver • Archiver interface • Analyzer R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 53 7. Migrating old data 7.3. Migration 7.3 Migration Migrating old data This section explains how to migrate your old data to the new Metrics & Reporting database format. ATTENTION: • To migrate your old data, your Windows user account must have sysadmin privileges for both the old & new database servers. • Before migration, you must create a fresh database instance on the new database server. This database instances must have the same Collation settings as the old Metrics & Reporting database. • You can only migrate the event data that was collected during the last ten years. To migrate your old data: Step 1 Action On the Archiver computer, run the following application: <installation_path>\Honeywell\DynAMo\Utilities\DataBaseMigrationUtilit y\Honeywell.DynAMo.Migration.exe The Honeywell DynAMo Migration Utility wizard appears and displays the Select Action page. 2 Click Database Migration and click Next. The database connection page appears. 54 DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 7. Migrating old data 7.3. Migration Step 3 Action Connect to your database server as follows: a) In the Select or Enter DataBase Server name drop-down list, select your database server. b) Specify the authentication method by clicking Windows Authentication or SQL Server Authentication. c) In the Username and Password boxes, type the login details to connect to your database server. d) Click Test Connection. The wizard validates your user name and password. If the authentication fails, an error message appears. Type the correct user name and password and try again. 4 Select the Check Migration Data check box, if you want the wizard to report the number of records found in your old data before starting the migration. 5 In the Select the database on the server drop-down list, click the new Metrics & Reporting database instance. 6 Click Verify Data. If the user account you specified does not have the permission to access the database, an error message appears. Get the required permission from your database administrator and try again. If the Check Migration Data check box is selected, a message box appears R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 55 7. Migrating old data 7.3. Migration Step Action and reports the number of records found in your old data. If the value in the Total Combinations field is more than 600,000, check with Honeywell Support before proceeding with the migration. 7 Click Next. The Asset Mapping page appears. 8 Metrics & Reporting R120 allows to configure your asset hierarchy in the Enterprise > Site > Plant format, whereas the older versions of Metrics & Reporting supported only Plant configuration. The Asset Mapping page allows you to map the plants in your old configuration data against their parent sites in the new Metrics & Reporting database. The Plant column lists all the plant names available in your old data. Against each plant name, type the name of the site in the Site column. ATTENTION: When you configure sites later, remember to use the same site names as specified in the rules files. If you do not want to migrate any of the plants, clear the check box in the Include column for that plant. 9 Click OK. The Custom filter mapping page appears. 56 DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 7. Migrating old data 7.3. Migration Step 10 Action The custom filtering attributes that you created in the older versions of Metrics & Reporting are not supported anymore. Metrics & Reporting R120 supports only 8 attributes for the event messages - 3 filter attributes and 5 custom attributes. The Custom filter mapping page allows you to map your old custom attributes against the new pre-defined attributes. The Attribute name column lists all the custom attributes available in your old data. Against each custom attribute, click the corresponding new predefined attribute in the drop-down list under the Mapname column. If you do not specify the new mapping attribute for one or more custom attributes, the migration wizard ignores these custom attributes and does not migrate them to the new database. ATTENTION: The migration wizard deletes your old custom fields. Note down your old custom fieds if you want to refer to them in future. 11 Click Migrate. The wizard migrates your old data to the new database format, and reports the success or failure. The time taken for migration is proportional to the volume of your old data. While migration is in progress, you can continue to migrate your old rules files and post-processing scripts as explained in the next section. R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 57 7. Migrating old data 7.3. Migration Step Action ATTENTION: If migration fails, perform the following tasks and try again: • Set the Time out duration for SQL Server to a higher value. • Set the recovery model of your old DynArchive database to Simple. Migrating rules files and post-processing scripts In this release of Metrics & Reporting, following changes have been made to the rules files and the VBScript post-processing API: Table 10: New features added to the rules files In earlier releases … Assets were identified using 3 parameters: In the current release … • Plant name Assets are identified using just one parameter that contains the hierarchy path of the asset in the following format: • Area name <site>\<plant >\<area>\<unit> • Unit name (“\” is the separator) You can add up to 10 user fields in the rules files You can define rules for renaming the message columns Only 8 fields are supported • 3 filter attributes • 5 custom attributes You cannot define such rules To use your old rules files and post-processing scripts with the current release of Metrics & Reporting, you must migrate these files as follows: Step 58 Action 1 Open your old rules files in the old Rules Builder. 2 Remove the following mappings that are not supported in the current release: • User-defined fields (by choosing Tools > Map User Fields > Remove Named Field) • Mappings to custom attribute columns 6 to 10 • Area names • Unit names DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 7. Migrating old data 7.3. Migration Step Action 3 Copy the rules files and post-processing scripts from your old Archiver computer to the new Archiver computer. 4 On the (new) Archiver computer, update the copied rules file(s) (using the new Rules Builder) as follows: • Modify the asset mappings to the new <site>\<plant>\<area>\<unit> format. • Add mappings for the 3 filter attributes and 5 custom attributes as required. Refer to the topic “Configuring data collection” in the Metrics & Reporting help center. You can access the help center by clicking the Metrics & Reporting screen. 5 icon from any In the VBScript post-processing files, remove all references to Plant, Area, Unit, and User fields. Refer to the topic “Configuring data processing” in the Metrics & Reporting help center. Swapping the Collectors Stop/Start the following Windows services: • On the old Collector computer, stop the Collector service • On the new Collector computer, start the Collector service Performing delta migration When the data was migrated to the new database format, the old Collector was still collecting new event messages. You must migrate this delta data to the new Metrics & Reporting database format. To perform delta migration: Step 1 Action On the Archiver computer, run the following application: <installation_path>\Honeywell\DynAMo\Utilities\DataBaseMigrationUtilit y\Honeywell.DynAMo.Migration.exe. The Honeywell DynAMo Migration Utility wizard appears and displays the Select Action page. 2 Click Delta Migration and click Next. The Database Connection page appears. R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 59 7. Migrating old data 7.3. Migration Step Action 3 Provide the required inputs as explained in the previous procedure and click Migrate. The wizard migrates the delta old data to the new database format, and reports the success or failure. Configuring data collection Configure the data collection channels as explained in the section “Configuring data collection” in the Metrics & Reporting help center. You can access the help center by clicking the screen. icon from any Metrics & Reporting Finalizing data migration After migrating the data, finalize the migration by executing the following procedure: ATTENTION: After you execute this procedure, you cannot perform delta migration again. 60 DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 7. Migrating old data 7.4. Post-migration steps To finalize data migration: Step Action 1 On the Archiver computer, choose <installation_path>\Honeywell\DynAMo\Utilities\DataBaseMigrationUtilit y\Honeywell.DynAMo.Migration.exe. The Honeywell DynAMo Migration Utility wizard appears and displays the Select Action page. 2 Click Complete Migration and click Next. The Database Connection page appears. 3 Provide the required inputs as explained in the previous procedures and click Complete Migration. The wizard finalizes the migration and reports the success or failure. 7.4 Post-migration steps Restarting the new Metrics & Reporting services Start the following Windows services on the new Archiver computer: • Archiver • Archiver interface • Analyzer Configuring asset hierarchy Configure the following assets as explained in the section “Configuring Assets” in the Metrics & Reporting help center (you can access the help center by clicking the from any Metrics & Reporting screen.): icon • Event stores • Sites – Ensure that the site name matches the site name specified in the rules files. After you configure the sites, the plants associated with that site in the rules files appear automatically in the asset hierarchy. • Operator positions Configuring data archival Configure the rules, post-processing scripts, and archiver channels as explained in the section “Configuring data archival” in the Metrics & Reporting help center. You can access the help center by clicking the screen. R120.1 Oct 2015 icon from any Metrics & Reporting DynAMo Metrics & Reporting Installation Guide 61 7. Migrating old data 7.4. Post-migration steps Updating cache data Synchronize the statistics data in the cache using the Data Manager Studio utility. For instructions, refer to the Help (F1) file for the Data Manager Studio utility. This utility is present in the Archiver Computer at: <installation_path>\Honeywell\DynAMo\Utilities\Data Manager Studio\Honeywell.Dynamo.AnalyzerService.DataManagerConsole.exe Recent changes in calculations In Metrics & Reporting R120, the calculations of metrics and KPIs have undergone changes. Feature/KPI Dashboard (alarm performance category) Behavior in R110 - Behavior in R120 Calculation of performance categories has changed. PREDICTIVE is removed in R120. and API report Peak alarm rate (hour) The highest peak of the 10 mins is multiplied by 6. It is calculated based on Hourly peak values. Average standing alarm This is based on selected scope and is cumulative. This is calculated at Operator position level. Top 20 action percentage Calculated based on number of operators configured for the area. Calculated based on new operator position concept. Peak alarm rate (day) The highest peak of the 10 mins is multiplied by 144. It is calculated based on daily peak values. % time <1 action The KPIs are calculated for the selected scope which can plant, area or units and are the results are normalized for the number of operators configured for the scope. Calculated based on Operator positions. Operator count Displays the number of configured operators assigned to the area. This not applicable. Chattering alarms Shows the number of tags causing chattering alarms. Calculation is based on the asset selected. Shows the number of occurrences of the chattering alarms. Calculation is based on the operator position selected. % time 1-10 action % time >10 action % time <1 alarm % time 1-10 alarm % time >5 alarm 62 DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 7. Migrating old data 7.4. Post-migration steps Feature/KPI Behavior in R110 Behavior in R120 Alarm flood Calculation is based on the asset selected. Calculation is based on the operator position selected. Report - Standing alarm (at the moment) Enable active alarms feature was available. This feature is not available. Includes active alarms by default. Report Symptomatic analysis Applies the filters on the first 10,000 of the events available for the specified time range, and performs Symptomatic analysis on the filtered results. Applies the filters on the entire event data available for the specified time range, and performs Symptomatic analysis on the first 10,000 events in the filtered results. Report - Tree map Peak alarm rate is calculated for hour interval Interval for Peak alarm rate is based on the Time period selected by User. Top 20 action % Calculation is based on the asset selected. Calculation is based on the operator position selected. Considers only alarms annunciated within the requested time period. Considers all standing alarms within the requested time period. Top 20 alarm % Top 10 Bad actor % Report -Standing alarm over Time R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 63 8. Localizing Metrics & Reporting 8.1. Overview 8. Localizing Metrics & Reporting 8.1 Overview You can localize the text displayed in the Metrics & Reporting screens. The display names of the fields in the Metrics & Reporting screens are stored in resource files (DLL). During runtime, Metrics & Reporting dynamically reads the names from these resource files (DLL) and displays them in the screens. These resource files are created using the Honeywell Intuition Localization Tool. This tool allows you to to create/modify a localization source file (TTP). It also allows you to use this localization source file (TTP) to build a resource file (DLL). ATTENTION: You cannot localize the online help files. Localization source files Following are the localization source files (TTP) for the Metrics & Reporting screens: • <Installation_Path>\Honeywell\AMS\Localization\AMS.ttp • <Installation_Path>\Honeywell\AMS\Localization\DLM.ttp • <Installation_Path>\Honeywell\AMS\Localization\DLMTimeControl.ttp • <Installation_Path>\Honeywell\AMS\Localization\ShiftTime.ttp Workflow for localization To localize the display text strings present in the source (TTP) files, you must perform the following tasks for each file: 64 1. Modify the contents of the localization source (TTP) file 2. Build a resource (DLL) file 3. Deploy the resource (DLL) file on the Metrics & Reporting core server DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 8. Localizing Metrics & Reporting 8.2. Localizing the Metrics & Reporting screens 8.2 Localizing the Metrics & Reporting screens Prerequisites Before you begin, you must: • Install the Honeywell MES Localization Tool. The installation files are available in the Honeywell Intuition Localization Tool folder within the DynAMo R120.1 - Metrics & Reporting Installation Media. For installation instructions, refer to the Honeywell Intuition Localization Tool Installation Guide that is available in the Documents sub-folder. • Remove the Read-Only property of the localization source (TTP) files. Modifying the Localization Source File (TTP) This section explains how to modify the default text strings present in a localization source file. Step 1 Action Choose Start > All Programs > Honeywell > Localization Tool. The Localization Tool dialog box appears. 2 Choose File > Open. The Open dialog box appears. 4 Select the localization source file (TTP). 5 Click Open. The contents of the selected file are displayed in the Localization Tool dialog box. 6 Expand the tree view and click the youngest child node. The names of all the customizable Metrics & Reporting field names are listed in the grid along with their default display values. 7 Choose Language > Add Language. The Add Language dialog box appears. 8 Select the required language and click OK. In the tree, a new child node is created with the name of the selected language. 9 Click this new node. The following fields appear in the grid: R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 65 8. Localizing Metrics & Reporting 8.2. Localizing the Metrics & Reporting screens Step Action • Name – Displays the name of the text. • Default Value – Displays the default display name of the text • <selected_language> – Allows you to specify a different name to be displayed in the Metrics & Reporting screens instead of the default value. • Localized – Allows you to indicate whether you have changed the value of the field or not. 10 In the <selected_language> field of each row in the grid, specify the localized version of the text strings. 11 Choose File > Save As and specify a new location.. The modified localization source file (TTP) is saved along with its resource file (TTR) at the specified location. Building the Resource File (DLL) This section explains how to build a resource file (DLL) from a localization source file (TTP). Step Action 1 Open the localization tool by choosing Start > All Programs > Honeywell > Localization Tool. 2 Choose File > Open, select the localization source (TTP) file, and click Open. The Localization Tool dialog box displays the contents of the selected resource file. 3 Choose File > Build Output/Package. The Build Output/Package dialog box appears. 66 DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 8. Localizing Metrics & Reporting 8.2. Localizing the Metrics & Reporting screens Step 4 Action With the default selections unchanged, click Build. The resource file (DLL) is created in the <language_suffix> folder within the output directory. (The path of the output directory is displayed in the Output Directory field) <language_suffix> is a two-letter code for the language that you selected. (eg. de-DE for German, zh-CN for Simplified Chinese) R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 67 8. Localizing Metrics & Reporting 8.2. Localizing the Metrics & Reporting screens Deploying a Resource File (DLL) This section explains how to deploy a resource file (DLL) on the Metrics & Reporting core server, so that, Metrics & Reporting can dynamically read the new display names from the resource file (DLL) and display them in the screens. Step 1 3 Action Stop the web server as follows: a) Choose Start > Administrative Tools > Internet Information Services (IIS) Manager. The Internet Information Services (IIS) Manager dialog box appears. b) Right-click the root node and choose Stop. Copy the resource file (DLL) along with its parent directory (eg. de-DE for German, zh-CN for Simplified Chinese) to the appropriate deployment folder(s). The deployment folder differs for the resource files (DLL) generated from each source (TTP) file. • • For AMS.ttp, the deployment folders for the resource file are: − <Installation_Path>\Honeywell\AMS\UX\WebUI\bin − <Installation_Path>\Honeywell\AMS\UX\MetricsWebAPI\bin − <Installation_Path>\Honeywell\AMS\DLM\UX\WebUI\bin For DLM.ttp, the deployment folders for the resource file are: − • 68 <Installation_Path>\Honeywell\AMS\DLM\UX\WebUI\bin For DLMTimeControl.ttp, the deployment folders for the resource file are: DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 8. Localizing Metrics & Reporting 8.3. Configuring remote clients Step Action − • For ShiftTime.ttp, the deployment folders for the resource file are: − 4 8.3 <Installation_Path>\Honeywell\AMS\DLM\UX\WebUI\DLMTimeContr ol\bin <Installation_Path>\Honeywell\AMS\Service\ShiftTimeService\1.0\bin Start the web server again as follows: a) Switch to the Internet Information Services (IIS) Manager dialog box. b) Right-click the root node and choose Start. Configuring remote clients Overview Remote users accessing Metrics & Reporting via web browsers can view the localized version of Metrics & Reporting only if they configure the language settings in their browser. Configuring language settings in browser To configure the language settings in Internet Explorer: Step 1 Action In Interent Explorer, choose Tools > Internet Options. The Internet Options dialog box appears. 2 In the General tab, click Languages. The Language Preference dialog box appears. R120.1 Oct 2015 DynAMo Metrics & Reporting Installation Guide 69 8. Localizing Metrics & Reporting 8.3. Configuring remote clients Step 3 Action Click Add, select the required language, and click OK. The selected language is added to the Language Preference list. 4 70 Click the language and move it to the top of the list by clicking the Move Up button. DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 9. Uninstalling Metrics & Reporting 9.1. Overview 9. Uninstalling Metrics & Reporting 9.1 Overview This chapter explains how to uninstall the Metrics & Reporting components. 9.2 Uninstalling the Metrics & Reporting components Removing the program files To remove the Metrics & Reporting program files: Step 1 Action In the Windows Control Panel, click Uninstall a program. The Programs and Features dialog box appears. 2 Uninstall the Honeywell DynAMo Metrics & Reporting program as follows: a) Right-click Honeywell DynAMo Metrics & Reporting and click uninstall. The Honeywell DynAMo Metrics & Reporting Maintenance Tool dialog box appears. 3 R120.1 Oct 2015 b) In the Packages tab, click Uninstall All. c) The selected program is uninstalled. Similarly, uninstall the following programs: DynAMo Metrics & Reporting Installation Guide 71 9. Uninstalling Metrics & Reporting 9.2. Uninstalling the Metrics & Reporting components Step Action • Honeywell Intuition • Honeywell Intuition Data Access Service - DynAMoDASInstance • Honeywell Intuition Data Access Service - DynAMoDASInstance Routing Configuration • Honeywell Intuition Operations Shift • Honeywell ULM License Server • Honeywell ULM Admin Tools • UniformanceSentinalCore • ULM License Client ATTENTION: Depending on which Metrics & Reporting component you are uninstalling, one ore more of the above components may not be listed on your computer. Removing the registry entries Remove the obsolete Metrics & Reporting registry entries as follows: Step 1 Action Click Start > Run, type regedit, and click OK. The Registry Editor window appears. 2 Delete the following folder: Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Honey well\DynAMo Deleting obsolete files Delete the following obsolete Metrics & Reporting folders: • <installation_path>\Honeywell\DynAMo • Your Windows TEMP folder ATTENTION: Before deleting, backup the configuration files of Archiver, Collector, and Viewer. 72 DynAMo Metrics & Reporting Installation Guide R120.1 Oct 2015 Honeywell Process Solutions 1860 W. Rose Garden Lane Phoenix, AZ 85027 USA