Page 2
Important Notices
Copyright
Copyright 2014 - Integrated Research Limited (ABN 76 003 588 449). All rights reserved.
The information contained in this guide is protected by copyright. No part of this document may be reproduced in any form, including photocopying or translation into a foreign language. Reproducing or copying any part of this document or the computer software without authorization violates U.S. and international copyright laws. Date of Issue: 26 September 2014
Product Version: Prognosis UC Foundation Edition 10.1.5
Trademarks
Prognosis, IR and the IR design mark are registered trademarks of Integrated Research Limited.
Other product names mentioned in this manual may be trademarks, registered trademarks and/or service marks of their respective owners and may not be used for commercial purposes without express permission from their respective owners.
Third Party Software License Notices
Please refer to the Third Party Software License Guide on the Prognosis installation CD or in the Documentation folder of the Prognosis installation path for details of third party software license notices.
Disclaimer
The information in this guide is published as is and without warranties of any kind, expressed or implied, including those regarding the accuracy or completeness of the information, warranties of merchantability and fitness for a particular purpose, or those arising from a course of dealing, usage or trade practice.
Page 3
Contents
Installation ... 5 Introduction ... 6 General Information ... 7 CopSSH ... 8 Firewalls ...10 License File ...12 Port Requirements...13Software Security Recommendations...15
SSL Certificate ...16
System Requirements ...18
Important Notes ...19
Microsoft IIS Settings...21
Changing Port 6767...23 Security Recommendations ...24 New Installation ...25 Installation Checklist ...26 Installation Procedure ...28 Upgrade Installation ...36 Upgrade Information ...37 Upgrade Checklist ...38 Upgrade Process ...40 Upgrade Troubleshooting ...42
Backup/Rollback Previous Version ...45
Upgrade Procedure ...47
Uninstalling ...55
Using Windows Control Panel ...56
Using Manual Uninstall ...57
Manual Uninstall of CopSSH ...59
Configuration ...61
Configuration ...62
Page 6
Introduction
Prognosis UC Foundation Edition is a 'lite' version of the full Prognosis for Unified Communications product, it includes the Prognosis Web Application but does not include the Prognosis Windows Client. It includes multi-vendor support for monitoring Avaya Aura® , Cisco® and Microsoft Lync™ VoIP networks. For details of the various Prognosis for Unified Communications Editions and what they include, please refer to the UC Editions topic in the Prognosis for Unified Communications section of the Online Help System.
Prognosis for Unified Communications Foundation Edition provides a wide range of data metrics including; component availability, phone status, voice stream MOS levels, latency, jitter and packet loss details plus much more. To do this Prognosis collects data from the servers and databases in the VoIP environment, filters this data as required and then presents it in a 'user-friendly' format through a range of pre-packaged Displays, all in 'real-time'. An additional function allows for data to be used to generate email alerts and/or SNMP Traps when pre-defined Threshold conditions are met or exceeded.
In order to collect and present data, Prognosis must be installed on a dedicated MS Windows machine running Microsoft IIS, which is monitoring the devices in the VoIP environment. Prognosis for Unified Communications Foundation Edition is a Web based product which makes use of Microsoft IIS to serve data to operators through a Web browser connection. The number of Web browser connections simply depends upon how many operators need access to the data.
Prognosis comes with a wide range of pre-packaged tools that enable data collection and monitoring to start almost immediately upon installation. The data requesting tools are called 'documents' and these include:
• Displays - Display documents are designed to request specific data and then present the collected results in either a chart or table format.
• Thresholds - Threshold documents consist of a series of 'Conditions'. The Threshold will scan selected Prognosis data looking for instances of the pre-defined conditions being met or exceeded and will then generate an email alert advising of the situation.
Page 7
General Information
Before commencing the Prognosis installation please refer to the following topics for some important setup considerations:
• CopSSH (page 16)
• Firewalls (page 10)
• License File (page 12)
• Port Requirements (page 13)
• Software Security Recommendations (page 15)
• SSL Certificate (page 16)
Page 8
CopSSH
CopSSH is a third party software product that installs minimal Cygwin with OpenSSH, OpenSSL and Zlib packages on Windows, which provides SSH and SFTP server functionality. Prognosis for Unified
Communications uses this software to install and to setup an SFTP server/client in order to obtain CDR data from Cisco Unified Communications Manager 5+, Acme Packet Session Border Controller and Avaya Aura Session Manager.
CopSSH Installation
When installing the Prognosis Monitoring Server component with a Prognosis for Unified Communications product license, the installer will detect if a copy of CopSSH currently exists on the destination machine:
Copy of CopSSH doesnotexist
The installer will install the required version and make the necessary configuration settings.
Copy of CopSSH does exist
If the copy was installed by a previous Prognosis version, the installer will check the CopSSH version number. a) If the version number is 3.1.1 or later, then the installer will automatically configure Prognosis for Unified
Communications to use the existing CopSSH version.
b) If the version is lower than 3.1.1, the Prognosis installer will show a message asking that it be uninstalled and the Prognosis installation will terminate. In this case the old CopSSH version will need to be manually uninstalled and then the Prognosis installation can be started again which will automatically install the correct CopSSH version.
If the copy was not installed by a previous Prognosis version, then the installer will continue but will not install another version of CopSSH and will not configure Prognosis for Unified Communications for CopSSH. In this case the following manual procedure will need to be carried out after the installation has been completed. Step 1 Shutdown the Prognosis service.
Step 2 Uninstall the existing CopSSH version
a) Check that no Cygwin processes are running; the exception would be 'cygrunsrv.exe' and just one instance of the 'sshd.exe'. Any additional instances of sshd.exe or any instance of 'bash.exe' for example, may not allow a clean uninstall of CopSSH. In short, any running process that has its image path matching the cygwin bin folder installation should be stopped. The 'Process Explorer' from Sysinternals could be used to display running processes and their image path. b) De-activate all CopSSH users. Prognosis only has the user 'PrognosisCDR':
[COPSSH_PATH]\bin > copsshadm.exe -a deactivateuser -u [USER_NAME] c) Uninstall CopSSH:
[COPSSH_PATH] > uninstall.exe" Step 3 Install CopSSH version 3.1.1:
[CD_ROOT]\3rdparty\copssh\Copssh_3.1.1_Installer.exe" /D=[COPSSH_PATH] Step 4 Configure SFTP connectivity. See the Configuration section of the Prognosis for Unified
Communications - Cisco UCM 5+ User Guide for details.
Page 9
CopSSH Access Rights
The CopSSH service is set up to run under the local user account 'SvcCOPSSH' which requires the following rights to be assigned:
• 'Act as part of the operating system',
• 'Create a token object'
• 'Logon as a service'
Page 10
Firewalls
If Prognosis is being installed on a network that is configured to prevent connections between machines by the use of firewalls, then this may also prevent Prognosis from making connections between servers.
In situations where only the MS Windows firewall is being used, the Prognosis installer will automatically make the necessary settings. In other cases, the firewall settings will need to be made manually. The following section provides details.
Windows Firewall (Windows XP SP2)
• When the 'Windows Firewall/Internet Connection Sharing (ICS)' service is running, then the Prognosis installation will automatically make the following changes:
For Management/Monitoring Server installation, the following five programs will be added to the exception list in order to allow Prognosis connectivity and CDR delivery:
IR Prognosis - Server Connectivity (%PROGNOSIS_INSTALL%\Server\x64\irnetrtr.exe)
IR Prognosis - Avaya PBX CDR Delivery (%PROGNOSIS_INSTALL%\Server\x64\irAVAYA_PBX.exe) IR Prognosis - Avaya Legacy CDR Delivery
(%PROGNOSIS_INSTALL%\Server\x64\irAVAYA_Legacy.exe) IR Prognosis - Avaya Definity CDR Delivery
(%PROGNOSIS_INSTALL%\Server\x64\irAVAYA_DEFINITY.exe)
IR Prognosis - Avaya RTCP CDR Delivery (%PROGNOSIS_INSTALL%\Server\x64\irrtcpcol.exe) In addition, if a Management/Monitoring Server is selected and a Prognosis for Unified Communications license is used (with TMA, SBM, or TCE product codes), one port is added to the exception list to allow CDR delivery:
IR Prognosis - CDR Delivery (Port 22 with TCP protocol)
• If an exception is needed and 'Windows Firewall' is configured to not allow exceptions, then the Prognosis installer will override it.
• If "Windows Firewall/Internet Connection Sharing (ICS)" service is not started, then no changes will be made by the Prognosis installation.
Windows Firewall with Advanced Security (Windows Vista and above)
• When the “Windows Firewall” service is running, then the Prognosis installation will automatically make the following changes:
For Management/Monitoring Server installation, the following five firewall rules will be added in order to allow Prognosis connectivity and CDR delivery:
IR Prognosis - Server Connectivity (%PROGNOSIS_INSTALL%\Server\x64\irnetrtr.exe)
IR Prognosis - Avaya PBX CDR Delivery (%PROGNOSIS_INSTALL%\Server\x64\irAVAYA_PBX.exe) IR Prognosis - Avaya Legacy CDR Delivery
(%PROGNOSIS_INSTALL%\Server\x64\irAVAYA_Legacy.exe) IR Prognosis - Avaya Definity CDR Delivery
(%PROGNOSIS_INSTALL%\Server\x64\irAVAYA_DEFINITY.exe)
IR Prognosis - Avaya RTCP CDR Delivery (%PROGNOSIS_INSTALL%\Server\x64\irrtcpcol.exe) In addition, if a Management/Monitoring Server is selected and a Prognosis for Unified Communications license is used (with TMA, SBM, or TCE product codes), one firewall rule will be added to allow CDR delivery:
IR Prognosis - CDR Delivery (Port 22 with TCP protocol)
Page 11 IR Prognosis - Secure Web Site (Port 443 with TCP protocol)
If port 443 is not available the installer will check the availability of port 8080, if this is not available it will continue to search incrementing the port number by 1 each time (i.e. 8081, 8082 etc) until an available port is found.
• If the "Windows Firewall" service is not running, then no changes will be made by the Prognosis installation.
If there are any firewall rules that block port 22 or port 443 then Prognosis will disable them and add a new firewall rule that will allow these ports access.
Other MS Windows Firewall Applications
The firewall will need to be manually configured to provide access for the following application: Server Connectivity (%PROGNOSIS_INSTALL%\Server\x64\irnetrtr.exe)
In addition, for Prognosis for Unified Communications:
Avaya PBX CDR Delivery (%PROGNOSIS_INSTALL%\Server\x64\irAVAYA_PBX.exe) Avaya Legacy CDR Delivery (%PROGNOSIS_INSTALL%\Server\x64\irAVAYA_Legacy.exe) Avaya Definity CDR Delivery (%PROGNOSIS_INSTALL%\Server\x64\irAVAYA_DEFINITY.exe) Avaya RTCP CDR Delivery (%PROGNOSIS_INSTALL%\Server\x64\irrtcpcol.exe)
CDR Delivery (Port 22 with TCP protocol) Uninstall
Uninstallation of Prognosis will revert all firewall settings that have been made, except overriding "Don't allow exceptions" on Windows with old Windows Firewall.
Remove added rules/exceptions
Enable disabled rules
Page 12
License File
Licensing a New or Upgrade Installation
In most cases a Prognosis license will be sent by email as an attached text file. When received, it is recommended that the license file be saved to the same folder as the Prognosis installation files. The installation process will automatically search for a license file in this folder. However, if a valid license is not found an alternative location can be specified or browsed for.
Updated Licenses on an Existing Installation
Over time it may be necessary to upgrade the license file on an existing Prognosis installation. This can occur when additional Prognosis products have been purchased or when an existing product is renewed for an additional time period.
When this occurs, a new license file will be sent as an email attachment. When received carry out the following steps:
Step 1 Save the attached license file from the email to a convenient location.
Step 2 Copy the license file to the configuration directory of each applicable Prognosis installation. When copying, accept to overwrite the existing license file.
The default configuration directories are as follows:
MS Windows: <Install_path>\Prognosis\Server\Configuration
Page 13
Port Requirements
Prognosis requires the use of a number of Ports on each machine. This section details each of the 'Base' ports that are required and also any other ports that might be required in particular circumstances.
Base Ports
Prognosis reserves the use of a number of ports; starting from the port number specified in the NETWORK configuration, through to that port number plus six. The ports used are:
Port Protocol Executable Usage
<PortNumber>+0 Default 1960
TCP IRNETRTR By default this is the base port. This port is used for; router-to-router, local process to router and Windows Client to router communications where TCP/IP is used. All requests and data messages are sent via this port across nodes as well as to individual collectors that actually gather raw data.
<PortNumber>+1 Default 1961
TCP IRPROMGR Used for connections from child processes back to Process Manager in order to detect process failures and to instigate process restarts. It is used for local communications only.
<PortNumber>+2 Default 1962
UDP IRNETRTR Used to send and receive Auto-Discovery multicasts (UDP protocol) in order to discover other Prognosis Servers. This port is not used if Auto-Discovery is disabled (e.g. if Managing-Nodes are used).
Changing the Base Port
The default base port used by Prognosis is 1960 with the following six ports also reserved for its use. The installer will check the availability of port 1960 and if this is not available will switch to port 19600. If port 1960 is not available the installer will continue to search incrementing the port number by 10 each time.
The Base port number can be changed after installation by amending the port number in the TCPIP-PORT statement of the NETWORK Configuration; this will also reserve the following six ports for Prognosis use. Prognosis will need to be restarted after amending the NETWORK Configuration for the change to take effect.
Common Ports
The following 'Common' ports are applicable for inbound data to Prognosis and should be enabled where the specified service is to be used, e.g. LDAP authentication.
Port Protocol Usage
443 HTTPS Default IIS port between the Prognosis Web Application and the IIS Web Server. If not available, the installer will check the availability of port 8080, if this is not available it will continue to search incrementing the port number by 1 each time up to port 8089.
636 TCP LDAP secure access
Page 14
Ports for Unified Communications
The following vendor specific ports are also used in addition to the set of Prognosis base ports and any required Common ports.
Avaya Aura Communication Manager
Port Protocol Usage
161 UDP SNMP queries from the Monitoring Server.
5005 UDP Port for receiving RTCP packets from Avaya end points. 5022 TCP Common SSH port for the Avaya PBX to issue SAT commands. 5023 TCP Common Telnet port for the Avaya PBX to issue SAT commands.
Only needed for Avaya PBX if SSH is not supported. Cisco
Port Protocol Usage
161 UDP SNMP queries from the Monitoring Server to:
Cisco Clusters including CUCM 5+, Cisco Unity Connection, Cisco Unified Presence, Cisco Unified Contact Center Express
Cisco UCS B-Series - SNMP interface for UCS Manager Cisco H.323 and VG Gateways
Cisco Unified Border Element Cisco TelePresence Endpoint
443 or 8443 TCP Standard port on Cisco clusters for 3rd party applications, such as Prognosis, to retrieve data via SOAP AXL and SOAP Perfmon. This includes;
CUCM 5+,
Cisco Unity Connection, Cisco Unified Presence,
Cisco Unified Contact Center Express
Standard port on Cisco TelePresence Endpoints to retrieve call statistics.
Microsoft Lync
Port Protocol Usage
389 TCP LDAP Non-secure access
636 TCP LDAP secure access
135 and 49152 - 65535
TCP WMI – Dynamic port range used for WMI. This can be configured to use a fixed port with Windows Vista/Windows Server 2008 and higher operating systems for easier firewall traversal, for details please refer to the following link::
http://msdn.microsoft.com/en-us/library/windows/desktop/bb219447(v=vs.85).aspx
Page 15
Software Security Recommendations
Page 16
SSL Certificate
Initial use of the Prognosis Web application may cause certificate errors to be shown by way of message pop-up windows or warnings in the URL. These messages indicate that the HTTPS certificate is not signed by a trusted source.
To remove these certificate errors the following steps should be taken on the MS Windows machine that is hosting the Prognosis Web Application:
There are two parts to the process:
Part 1 – Obtain and install the certificate provided by organization. Note that different certificate types may require different installation steps. See steps 1 through 7.
Part 2 – Bind the certificate to the website. See steps 8 through 14.
Part 1 - Obtain the Certificate
Step 1 Obtain a trusted signed certificated for the Prognosis server name. The procedures for purchasing a real SSL certificate depend upon the specific provider.
Step 2 From the MS Windows Start screen, click or search for Internet Information Services (IIS) Manager and open it.
Step 3 In the panel on the left side, click on the server name.
Step 4 In the IIS section in the center panel, click on 'Server Certificates'. If you received a PFX certificate:
Step 5 Right-click in the central window and select 'Import...'.
Step 6 In the first field browse to the .pfx file that was provided. In the second field, enter the password associated with the certificate.
Step 7 When complete click the OK button. If you received a CER certificate:
Step 5 From the Actions menu in the panel on the right side, click on 'Complete Certificate Request...'. This will open the 'Complete Certificate Request' wizard.
Step 6 In the first field browse to the .cer file that was provided by the certificate vendor. In the second field enter a 'user friendly' name which can be used by the server administrator to easily distinguish the certificate.
Page 17
Part 2 - Bind the Certificate
Step 8 Once the SSL Certificate has been successfully installed to the server, it will be necessary to assign the certificate to the appropriate website using IIS.
Step 9 From the 'Connections' menu on the left side of the main Internet Information Services (IIS) Manager window, expand the name of the server to which the certificate was installed. Step 10 Under 'Sites' select 'IrPrognosisSite'.
Step 11 From the 'Actions' menu on the right, click on 'Bindings...'. This will open the 'Site Bindings' window.
Step 12 In the 'Site Bindings' window, select https and click 'Edit…'. This will open the 'Edit Site Binding' window.
Step 13 From the 'SSL certificate' field, select the certificate that has been added. Step 14 Click the OK button.
Page 18
System Requirements
The Prognosis Web Application must be installed together with a Prognosis MS Windows Server component. See the MS Windows Server topic for specific details of the system requirements.
Web Application Requirements
Platform Internet Information Services (IIS) version 7 or later Operating System: Microsoft Windows Server 2008 (64 bit) or later Supported Web Browsers: Microsoft Internet Explorer 9 +
Google Chrome 16 + Mozilla Firefox 9.0 + Safari 5.7+
Android 3+
iPhone 3GS + with at least iOS 5.1 iPad - all versions
Other iOS - version 5.1 +
Browser Support: For operation of the Web Application, the selected web browser must support:
- Javascript - CSS
Server Requirements
Component Minimum Requirements
Processor (CPU): Minimum:
- Intel® Xeon® Dual-Core processor 2.4GHz Recommended:
- Intel Xeon 3450 2.67GHz Quad Core processor System Memory (RAM): Minimum: 4 GB
Recommended: 8 GB
Installation Hard Drive Space: The installation requires the following minimum hard drive space. - Server + Web Application...760MB
Temp Files: A further 70 MB of free space is required for temporary files during the installation.
Plus:
700 MB free space on the c:\ drive regardless of the drive that Prognosis is being installed on.
Operating Hard Drive Space: After installation the Prognosis server requires the following amount of space for the storage of historical data.
The maximum database size for each vendor type is: - Avaya Aura Communication Manager....5.5GB - Cisco UCM 5+....3.0GB
Page 19
Important Notes
Before starting the initial installation please pay particular attention to the following requirements:
• Microsoft IIS
By default, the Prognosis installer will setup Internet Information Services (IIS) automatically to enable the minimum requirements for the Prognosis Web Application to function. This includes creating an
application pool "PrognosisAppPool" and a website "IrPrognosisSite", plus an application named "Prognosis" which will be created in IIS under "IrPrognosisSite" using "PrognosisAppPool". However, when installing the Prognosis Web Application on a Microsoft Windows Server 2008 SP2 platform, it will be necessary to manually ensure that a number of Microsoft IIS settings have been enabled before installation. Please refer to the Microsoft IIS Settings topic (page 21) for details. For Microsoft Windows Server 2008 SP1 machines the Web Application requires a 'hotfix' for IIS 7.0 to support .NET Framework 4.0. To download the 'hotfix' go to http://support.microsoft.com/kb/958854.
• Port Requirements
Port 443 is the default port that is used between the Web Browser and the Prognosis Web Application on the IIS Web Server. If the Prognosis installation detects that an existing website is listening to port 443 (https) then the installer will try to find an alternative port starting from 8080 and incrementing by 1 up to 8089. In this case the installer will show a dialog box with the selected port number, this can be manually changed if required. If no alternative port in the range 8080 to 8089 is found the installer will show a dialog box where a user specified port can be input.
When a secure website, that is using port 443 (https), is turned off and nothing is listening to this port, the Prognosis Web Application will proceed to use port 443. This will result in no Prognosis website being created (only the Prognosis application pool and Prognosis application); the Prognosis application will use the web site that is using port 443. When the installer has finished, the website has to be turned on in order for the Prognosis Web Application to function.
Port 6767 is the default port that is used between the Prognosis Web Application on the IIS Web Server and the Prognosis server. If it is not possible to use this port, please refer to the Changing Port 6767 topic
(page 23).
• Security Recommendations
See the Security Recommendations topic (page 24) for recommended firewall settings that can prevent potential external access to Prognosis data.
• SSL Certificate
Initial use of the Prognosis Web application may cause certificate errors to be shown by way of message pop-ups or warnings in the URL. These messages indicate that the HTTPS certificate is not signed by a trusted source. Please refer to the SSL Certificate topic (page 16) for details of how to setup a certificate.
• Windows Server 2008 R2
Page 20
• MS Windows Updates
Page 21
Microsoft IIS Settings
23 July 2014 - This topic has been updated to remove a number of items from the Minimum Web Server IIS Settings list that are no longer required.
When installing the Prognosis Web Application on a Microsoft Windows Server 2008 SP2 platform, it will be necessary to ensure that the following Microsoft IIS settings have been enabled before installation.
For Microsoft Windows Server 2008 R2, Windows 7 and Windows Server 2012 installations these settings will be automatically enabled by the Prognosis installation.
Minimum Web Server IIS Settings
The minimum Web Server IIS settings are:Web Server (on MS Windows Server) or World Wide Web Services (on MS Windows Workstation)
Common HTTP Features
Static Content (enabled)
Default Document (enabled)
HTTP Errors (enabled)
Application Development
.NET Extensibility 4.5 (enabled)
ASP.NET 4.5 (enabled) Microsoft IIS Manager 8
.NET Extensibility (enabled)
ASP.NET (enabled) Microsoft IIS Manager 7
ISAPI Extensions (enabled)
ISAPI Filters (enabled)
Health and Diagnostics
Request Monitor (enabled)
Security
Request Filtering (enabled)
Performance
Static Content Compression (enabled)
Dynamic Content Compression (enabled)
Management Tools
IIS Management Console (enabled)
Page 22
To enable any of these IIS settings use the following procedure.
Procedure
Step 1 From the Windows Start menu select:
Control Panel > Programs > Programs and Features > Turn Windows Features On or Off This will open the Windows 'Server Manager' window.
Step 2 In the 'Server Manager' window, move down to the 'Roles Summary' section:
If the 'Roles Summary' section already includes a Web Server (IIS) item, then proceed with the following 'Update an Existing Server Role' steps.
If the 'Roles Summary' section does not show an existing Web Server (IIS) item, then proceed with the 'New Server Role' steps.
Update an Existing Server Role
Step 3 Click on the Web Server (IIS) item. This will open the Web Server IIS page. Step 4 In the 'Role Services' section click on Add Role Services.
Step 5 From the list of Role services ensure that at least all of the items shown in the 'Minimum Web Server IIS settings (page 21)' list are checked.
Step 6 When complete, click the Next button. This will open the 'Confirm Installation Selections' page. Step 7 Check that all the required items have been selected and if everything is correct click on the Install
button.
Step 8 The Installation Result page will open verifying that the role services have been installed successfully.
New Server Role
Step 3 Click on the Add Roles option on the right side. This will open the 'Add Roles Wizard'.
Step 4 If the wizard opens at the 'Before you Begin' page, click the Next button to open the 'Select Server Roles' page. Otherwise the wizard will open directly to the 'Select Server Roles' page.
Step 5 From the 'Roles' list, select Web Server (IIS). This will display the 'Add features required for Web Server (IIS)' dialog box.
Step 6 On the dialog box click the Add Required Features button. This will return the 'Select Server Roles' page.
Step 7 From the Navigation panel on the left of the 'Select Server Roles' page, click on Role Services. Step 8 From the list of Role services ensure that at least all of the items shown in the 'Minimum Web
Server IIS settings (page 21)' list are checked.
Step 9 When complete, click the Next button. This will open the 'Confirm Installation Selections' page. Step 10 Check that all the required items have been selected and if everything is correct click on the Install
button.
Page 23
Changing Port 6767
By default the Prognosis Web Application is set to use port 6767 between the IIS Web Server and the Prognosis server, either locally or in a remote setup. If port 6767 cannot be used, the following procedure should be followed to configure an alternative port.
Procedure
Step 1 On the Prognosis server machine go to the following folder path and open the web.config file in a text editor.
/Prognosis/WebUI/IIS/web.config
Step 2 In the <appSettings> section add the following:
<add key="ServerPort" value="<PortNumber>" />
Where:
<PortNumber> Input the alternative port number to be used
Example:
<configuration> <appSettings> ...
<add key="ServerPort" value="3535" /> </appSettings>
Step 3 Save and close the configuration file.
Step 4 The following addition will also need to be made to the irpqlsrv.ini file. This file can be found in the following folder path of the Prognosis server.
/Prognosis/Server/Configuration/irpqlsrv.ini Add the following:
[PQL]
Port=<PortNumber>
Step 5 Save and close the configuration file.
Page 24
Security Recommendations
Prognosis makes use of port 6767 between the IIS Web Server and the Prognosis server.
The following security recommendations can prevent potential access to Prognosis data by external users: 1. For standard installations of the Prognosis Web Application, where the Management Server and Web Application are running on the same machine, it is recommended to block external access to port 6767 using Windows Firewall.
2. For customized split deployments (e.g. where the Web Application is running in a web farm connecting to a remote Prognosis Management Server) it is recommended to only allow access to Port 6767 from the remote IIS server(s).
Page 25
New Installation
The following topics will provide details for a new installation of the Prognosis server component on to an MS Windows machine.
• Installation Checklist (page 26)
• Installation Procedure (page 28) Additional information:
• CopSSH (page 8) (for Prognosis for Unified Communications)
Page 26
Installation Checklist
Checklist for installing the Prognosis server on an MS Windows machine. Before proceeding with the installation please go through the following checklist and ensure that all items have been addressed.
Installation Checklist - MS Windows
1. Release Notes
Before proceeding please take time to read the latest Release Notes for this Prognosis installation. The Release Notes document can contain important information relating to the installation process and the operation of Prognosis. This document can be downloaded from the Prognosis Online web site.
Go to: https://online.prognosis.com/products/download
2. Prognosis Installation Files
Ensure that you have the Prognosis for Windows installation file (Prognosis10.exe). This can be downloaded from the Prognosis Online web site and saved to a suitable drive/folder on the Windows server (where required the installation may also be provided on CD/DVD). Go to: https://online.prognosis.com/products/download
Windows XP - Ensure that the Prognosis.exe file is saved to a drive/folder that does not have encryption enabled. Encryption will lead to an error when trying to read the installation files. This applies to MS Windows XP only.
3. Has the Prognosis 10 license been received?
When received, it is recommended that the license file be saved to the same folder as the Prognosis installation files. If the license file has not been received, please contact your Prognosis account manager.
See: License File (page 12)
4. Check the Prognosis server requirements See: Server Requirements - MS Windows. 5. Pre-requisite software
The following software is required on the server. If the installer does not find this software on the destination machine it will be automatically installed.
• Microsoft Visual C++ 2010 SP1 Redistributable Package (x86) – needed to run 32-bit Prognosis code (on both 32-bit and 64-bit Windows)
• Microsoft Visual C++ 2010 SP1 Redistributable Package (x64) – needed to run 64-bit Prognosis code (on 64-bit Windows)
• Microsoft .NET Framework 4 full – needed to run .NET 4 Prognosis code (on both 32-bit and 64-32-bit Windows)
6. Ensure that the correct level logon is available (username/password)
Administrator privileges will be required for the system on which Prognosis will be installed. 7. Determine which disk drive and folder path Prognosis is to be installed on. The server installation cannot be made into any of the following folders:
- /Program Files - /Program Files (x86) - /Users
- /Documents and Settings - /WINDOWS
Page 27
Installation Checklist - MS Windows
8. Is SNMP installed?
If installed, the SNMP service enables Prognosis to monitor remote devices. Prognosis will still run without the SNMP service but some data will be unavailable. SNMP can be installed from the Add/Remove Programs Control Panel applet by selecting the Add/Remove Windows Components wizard and installing the Management and Monitoring Tools component.
9. Check if CopSSH version 3.1.1 or later installed. (Prognosis for Unified Communications)
Prognosis monitoring of Cisco UCM 5+, Acme Packet SBC and Avaya Aura Session Manager requires a specific version of CopSSH to be installed. Provided that no other version of CopSSH is found on the machine the Installation will install the correct version. However, if an existing copy of CopSSH is found a manual set up may be required. See: CopSSH (page 8).
10. Disable all virus checking software. (Prognosis for Unified Communications) It is preferable that all types of virus checking software be disabled on the destination machine. However, if this is not possible then the Prognosis directory should be added to the virus checking exclusion list.
If McAfee VirusScan 8.0i is being used on Cisco UCM (please refer to the Release Notes for the latest information)
The SFTP server component will not run under McAfee VirusScan 8.0i with the result that CDR files will not be downloaded from the Cisco Unified Communications Manager appliances. The workaround is to disable McAfee VirusScan 8.0i or switch off the 'Buffer Overflow Protection' option.
To switch off the 'Buffer Overflow' Protection option, open the Virus Scan Console (Network Associates) from the Start > Programs menu, then right click on the 'Buffer Overflow Protection' line then choose 'Properties'. On the 'Buffer Overflow Protection' tab, uncheck the box next to 'Enable Buffer Overflow Protection', click Apply then click OK.
Page 28
Installation Procedure
The following procedure is used to install the Prognosis Management and/or Monitoring Server components onto a machine running the MS Windows® operating system.
If required, the Windows Client and/or Web Application can also be installed with the server onto the same machine. To do this, select the required client components along with the server at Step 4.
Administrator rights are required for the machine onto which the Prognosis Server is being installed.
Procedure
Step 1 Place the Installation CD into the CD drive of the required machine. If Autorun is activated the CD will start the installation automatically. If the installation fails to start, go to Windows Explorer, select the CD drive, copy the Prognosis installer to a local drive and then run the Prognosis10.exe file. or
Download the Prognosis10 installer to a local hard disk and then run the Prognosis10.exe file. Prognosis10.exe is a self-extracting executable that will extract into a folder named 'Prognosis10'. On slow machines this may take a few minutes. Once extracted, the folder will contain:
- Prerequisites folder - Backup-restore folder - Prognosis10.msi - Setup.exe
Setup.exe will now run automatically and initially check for the required pre-requisite software (page 26).
a) If the pre-requisite software is not found on the destination machine, it will be automatically installed. This may result in some non-Prognosis dialog boxes being displayed, but normally it will only be necessary to 'click' through these until the software has been installed.
b) If the required pre-requisite software is found on the destination machine, or after it has been installed, the Prognosis Welcome dialog will open.
Page 29
Step 2 End-User License Agreement
The next step in the installation is the acceptance of the End-User License Agreement (EULA).
Carefully read the End User License agreement and then click the check box to accept the terms and conditions. The Next button will become active and can now be selected to continue with the installation.
Page 30
Step 3 License
The installation will now request the Prognosis license file (page 12) information.
In most cases the license information is sent by email as an attached text file. When received, it is recommended that the license file be saved to the same folder as the Prognosis installation files The License dialog box will default to the same folder path as the installation files, should the license be located elsewhere or should an invalid license be found, an alternative license location can be specified or browsed for.
The license field may be left blank, however this will only allow the Prognosis Windows Client to be installed. Please note that the Windows Client cannot be used with the UC Foundation Edition license.
Page 31
Step 4 Prognosis Components
Page 32
Step 5 Destination Folder
This dialog box is used to assign the folder path where this copy of Prognosis will be installed.
Check that the default path shown in the Destination Folder field is where you wish Prognosis to be installed. If not, click the Browse button where an alternative folder path can be specified. Please note the following:
• Prognosis cannot be installed into any of the following folders of an MS Windows machine: - /Program Files
- /Program Files (x86) - /Users
- /Documents and Settings - /WINDOWS
This is because Prognosis needs to
save/modify files in its installed location as the logged in user. In MS Windows problems can occur when trying to do this unless the user is an administrator, which may not be the case.
• Prognosis cannot be installed into an existing folder. A new folder must be created.
Absolute file name length cannot exceed 258 characters. As the relative path and field names of the Prognosis packaging can reach up to 210 characters, it is strongly recommended to limit the absolute path for the Prognosis home installation folder to 45 characters.
Page 33
Step 6 Prognosis Web Application Port
The following dialog box will only appear when the Web Application component has been selected and the default port 443 is already in use. When the default port is found to be in use, the Prognosis installer will try to find an alternative port starting with 8080 and incrementing by 1 up to 8089. When one of these port is found to be available, it will be shown in the input field on this dialog box, if none of these ports are found to be available, the input field will be empty.
If the installer nominated port number is acceptable, click the Next button to proceed.
Page 34
Step 7 Ready to Install Prognosis
This dialog box confirms that all the installation settings that have been made and that Prognosis will make any necessary Firewall (page 10) changes. If the Web Application component has been included it will confirm the port that has been configured.
If any changes are required click the Back button to return the required dialog and make the necessary adjustments.
Page 35
Step 8 When the installation is complete the final dialog box will be shown
Click the Finish button to complete the installation.
The Prognosis installation may include new drivers. These drivers may not become effective until after the next reboot of the Windows Server. If a reboot is required, a prompt will be shown advising that a reboot of the machine can be made now or later.
'PROGNOSIS' PASSWORDS Configuration entry
During installation on a MS Windows platform a 'PROGNOSIS' entry will be added to the Prognosis PASSWORDS Configuration. This entry is used by Analysts and Thresholds (and is used by the default Windows Analyst) to tell Prognosis to run commands with the Local System Account (NT
AUTHORITY/SYSTEM) and not the user that started the Analyst. As such, it is recommended that the SECURITY Configuration be modified to limit access to this PASSWORDS Configuration entry to specific users.
Configuration
After the installation has been completed there are a number of configuration steps that now need to be undertaken.
• Monitoring Server
Page 36
Upgrade Installation
With the release of Prognosis 10.1 an upgrade path is available from the previous Prognosis UC Foundation Edition v10.0. However, no other PVM products are supported with this upgrade.
Upgrading from v10 to v10.1
To carry out the upgrade it will first be necessary to obtain a new Prognosis UC Foundation Edition license by contacting your Prognosis Sales Office. Once the license has been obtained simply follow the Upgrade Procedure (page 47) as described for the Prognosis Windows Server. However, please note the following:
• Except for MS Lync, the upgrade will backup the Configuration files plus .ini files and these will be restored to the new version. However, databases will not be backed-up or restored for any vendor products. During the upgrade process the Configuration folder, service, CopSSH and start menu shortcut will be removed and once the Prognosis 10.1 installation has finished any remaining files and registry entries will be removed.
• For MS Lync please complete a new installation of Prognosis 10.1 and then carry out the MS Lync Configuration procedure for a new installation.
Upgrading from Foundation to Enterprise Edition
Page 37
Upgrade Information
What DOES happen on Upgrade?
• All documents (i.e. Displays, Thresholds etc.) in the 'My Displays & Configurations' folder of the Prognosis Windows Client will be maintained.
• All documents (i.e. Displays, Thresholds etc.) in the 'Knowledge' folder of the Prognosis Windows Client will be deleted and replaced with new files.
• irgui.ini will be restored.
• Static Configurations will be maintained.
• The following statistics will be reset; - Availability
- Dispatch Manager Logs - Problem Logs
- File Manager Logs
• Prognosis log file (wvlog.txt) is backed up but will not be restored.
• All .ini files will be merged on upgrade (old values are kept on upgrade).
• Software Inventory history will be maintained on upgrade (file SWINVDB).
• UDEFSREC will be merged with a new UDEFSREC (records are replaced with newer ones).
• If the Tomcat Web Server was previously installed by Prognosis then it will be completely removed. Please note that:
• The contents of the 'My Displays & Configurations' folder will not be upgraded.
• Windows Client security is not maintained during upgrade.
• Modifications to standard Displays, Thresholds, Analysts etc. are not kept.
• All Prognosis Configurations that were running at the time will be automatically started on upgrade.
Page 38
Upgrade Checklist
Checklist for upgrading the Prognosis server on an MS Windows machine. Before proceeding with the upgrade please go through the following checklist and ensure that all items have been addressed.
Upgrade Checklist - MS Windows
1. Release Notes
Before proceeding please take time to read the latest Release Notes for this Prognosis installation. The Release Notes document can contain important information relating to the installation process and the operation of Prognosis. This document can be downloaded from the Prognosis Online web site.
Go to: https://online.prognosis.com/products/download
2. Prognosis Installation Files
Ensure that you have the Prognosis for Windows installation file (Prognosis10.exe). This can be downloaded from the Prognosis Online web site and saved to a suitable drive/folder on the Windows server (where required the installation may also be provided on CD/DVD). Go to: https://online.prognosis.com/products/download
Windows XP - Ensure that the Prognosis.exe file is saved to a drive/folder that does not have encryption enabled. Encryption will lead to an error when trying to read the installation files. This applies to MS Windows XP only.
3. Has the Prognosis 10 license been received?
When received, it is recommended that the license file be saved to the same folder as the Prognosis installation files. If the license file has not been received, please contact your Prognosis account manager.
See: License File (page 12)
4. Carry out a backup of the previous Prognosis version. See: Backup Instructions (page 45).
5. Pre-requisite software
The following software is required on the server. If the installer does not find this software on the destination machine it will be automatically installed (for Unattended Installations, this software will need to be manually .installed first.)
• Microsoft Visual C++ 2010 SP1 Redistributable Package (x86) – needed to run 32-bit Prognosis code (on both 32-bit and 64-bit Windows)
• Microsoft Visual C++ 2010 SP1 Redistributable Package (x64) – needed to run 64-bit Prognosis code (on 64-bit Windows)
• Microsoft .NET Framework 4 full – needed to run .NET 4 Prognosis code (on both 32-bit and 64-32-bit Windows).
6. Ensure that the correct level logon available (username/password)
Page 39
Upgrade Checklist - MS Windows
7. Determine which disk drive and folder path Prognosis is to be installed on. The server installation cannot be made into any of the following folders:
- /Program Files - /Program Files (x86) - /Users
- /Documents and Settings - /WINDOWS
This is because Prognosis needs to save/modify files in its installed location as the logged in user. In MS Windows problems can occur when trying to do this in these folders unless the user is an administrator, which may not be the case.
8. Is SNMP installed?
If installed, the SNMP service enables Prognosis to monitor remote devices. Prognosis will still run without the SNMP service but some data will be unavailable. SNMP can be installed from the Add/Remove Programs Control Panel applet by selecting the Add/Remove Windows Components wizard and installing the Management and Monitoring Tools component.
9. Check if CopSSH version 3.1.1 or later installed. (Prognosis for Unified Communications)
Prognosis monitoring of Cisco UCM 5+, Acme Packet SBC and Avaya Aura Session Manager requires a specific version of CopSSH to be installed. Provided that no other version of CopSSH is found on the machine the Installation will install the correct version. However, if an existing copy of CopSSH is found a manual set up may be required. See: CopSSH (page 8).
10. Disable all virus checking software. (Prognosis for Unified Communications) It is preferable that all types of virus checking software be disabled on the destination machine. However, if this is not possible then the Prognosis directory should be added to the virus checking exclusion list.
If McAfee VirusScan 8.0i is being used on Cisco UCM (please refer to the Release Notes for the latest information)
The SFTP server component will not run under McAfee VirusScan 8.0i with the result that CDR files will not be downloaded from the Cisco Unified Communications Manager appliances. The workaround is to disable McAfee VirusScan 8.0i or switch off the 'Buffer Overflow Protection' option.
To switch off the 'Buffer Overflow' Protection option, open the Virus Scan Console (Network Associates) from the Start > Programs menu, then right click on the 'Buffer Overflow Protection' line then choose 'Properties'. On the 'Buffer Overflow Protection' tab, uncheck the box next to 'Enable Buffer Overflow Protection', click Apply then click OK. Once the checklist has been completed, proceed with the Prognosis installation. For details see, Upgrade Procedure (page 47).
Page 40
Upgrade Process
This topic describes the automatic backup/rollback procedure used by the Prognosis upgrade process. This is different to the manual backup, which is strongly recommended and described in the Backup/Rollback Previous Version topic (page 45).
Once the upgrade is started, the following four step process will take place:
Step 1 Automatic backup of the previous Prognosis configuration. A backup folder will be created on the root drive where the previous Prognosis version is installed in the following format:
\PrognosisBackup\PrognosisBackup-<MachineName>-yyyy-mm-ddThh.mm.ss e.g. C:\PrognosisBackup\PrognosisBackup-ServerA-2013-08-27T09.46.44
The following files will be backed-up:
Registry: HKLM/Software/Wow6432Node/IntegratedResearch/Prognosis Configurations: All enabled
Analysts: All running Analysts Thresholds: All running Thresholds
Databases: All running databases (including autosumm dbs, sqlite dbs)
.ext files none
.csv .pl, .pm, .bat none
Log files: Prognosis_Home\Install.log Prognosis_Home\Patches\audit.log
Prognosis_Home\Server\Configuration\wvlog.txt Prognosis_Home\Server\Configuration\Autosumm*.log .ini files Prognosis_Home\User Interface\irgui.ini
Prognosis_Home\Server\Configuration\*.ini Cisco *-config.ini files and discovered clusters dirs .txt files Prognosis_Home\Server\Configuration\Datastore.txt
Prognosis_Home\Server\Configuration\rollupscheduletable.txt files mentioned in 'rollupscheduletable.txt'
Prognosis_Home\Server\Configuration\rollup*.txt Prognosis_Home\Server\Configuration\*autosumm*.txt .xml files Prognosis_Home\User Interface\prompt.xml
Prognosis_Home\Server\Configuration\*\*.xml
Prognosis_Home\www\webserver\tomcat\webapps\ROOT\SipEntities.xml Prognosis_Home\www\webserver\tomcat\webapps\ROOT\EntitiesLink.xml Web Application Files
(Upgrading from Prognosis 10 and later) Prognosis_Home\WebUI\IIS\Dashboards\reportlistdata.xml Prognosis_Home\WebUI\IIS\Dashboards\Prognosis.owl Prognosis_Home\WebUI\IIS\Dashboards\search.xml Prognosis_Home\WebUI\IIS\Dashboards\prompt.xml Prognosis_Home\WebUI\IIS\Dashboards\persistviewsUI.xml
Dashboards and queries that are referenced in key displays and mashups navigation panel in the web UI interface
Page 41 Prognosis_Home\WebUI\IIS\Web.config
If the Web Application default port/certificate settings have been changed, these will not be backed up and therefore on restore will revert back to the default settings.
Other Prognosis_Home\User Inteface\My Documents And Configuration/* Prognosis_Home\Server\Configuration\defssrv Prognosis_Home\Server\Configuration\defscnf Prognosis_Home\Server\Configuration\udefssrv Prognosis_Home\Server\Configuration\udefsrec Prognosis_Home\Server\Configuration\udefserr Prognosis_Home\Server\Configuration\IPTM Alcatel 'ticket' dir if found
If the backup fails, the installation of the new Prognosis version will terminate and no changes will be made to the previous Prognosis installation.
Step 2 Uninstall the previous Prognosis version.
The Prognosis upgrade will uninstall the previous Prognosis version together with all its associated components, services, registry entries, start menu shortcuts, directories etc.
Step 3 Install the new Prognosis version
Step 4 Restore the previous Prognosis configurations to the new Prognosis installation.
The PrognosisBackup folder will be used to restore user configurations to the new installation. When upgrading from Prognosis 10 or later, the following Web Application features will be restored: Web Application Files
(Upgrading from Prognosis 10 and later)
Changes made to reportlistdata.xml will be saved to reportlistdata_user.xml (the new reportlistdata.xml will not be modified)
Changes made to search.xml will be saved to search_user.xml (the new search.xml will not be modified)
Changes made to persistviewsUI.xml will be saved to persistviewsUI _user.xml (the new persistviewsUI.xml will not be modified)
Saved dashboard files will be restored
Saved queries obtained from the dashboard files will be stored in persistviewsUI_user.xml
Prognosis.owl file will be merged
The web.config will be merged and changes to web.config in the latest version will be applied to the restored file
Upon successful restoration the PrognosisBackup directory will be automatically removed.
Page 42
Upgrade Troubleshooting
The following provides some details on how to address possible upgrade failures. If in doubt about any upgrade failure please contact Prognosis Technical Support.
• Upgrade fails during backup of the previous version (Upgrade process - Step 1 (page 40))
In this case the installer will rollback leaving the earlier version untouched. After checking the log file and attending to the issue that caused the failure, the upgrade may be attempted again. For details see the 'Troubleshooting Backup Issues (page 43)' and 'Previous Prognosis Control Panel Running (page 43)' sections that follow.
• Upgrade fails during uninstallation of the previous version (Upgrade Process - Step 2 (page 40)) In this case the installer will rollback with the backup process completed. However, the earlier Prognosis version may be fully or only partially uninstalled. A manual uninstall of the earlier version may be required (see the Installation Guide from the earlier version for instructions on how to carry this out). The Prognosis 10 installer can now be run again, this time it will run as a 'new' installation, not an upgrade. Once the installation is complete, the configuration from the earlier version may be restored by running the 'restore' utility. See the 'Running the Manual Restore Utility (page 42)' section below.
• Upgrade fails before running the restore process (Upgrade Process - Step 3 (page 40))
The previous version has been uninstalled at this stage, so the Prognosis 10 installer can now be run again, this time it will run as a 'new' installation, not an upgrade. Once the installation is complete, the configuration from the earlier version may be restored by running the 'restore' utility. See the 'Running the Restore Utility (page 42)' section below.
• Upgrade fails while running the restore process (Upgrade Process - Step 4 (page 40)) In this case the Prognosis 10.x configuration has been restored partially and encountered some unexpected errors. Since the PrognosisBackup folder is not removed, it may be restored manually by running the 'restore' utility, see the 'Running the Manual Restore Utility (page 42)' section below. However, before doing a manual restore it is recommended to check the restore log file to determine the cause of the error. For more details please see the 'Troubleshooting Restore Issues' (page 44) section that follows.
Running the Manual Restore Utility
Upgrade on the same drive as theprevious Prognosis version Backup folder
a) Install the new Prognosis version on the same drive as the PrognosisBackup folder
b) Go to the 'Backup_restore' folder of the new Prognosis installation, e.g. C:\Prognosis\Backup_restore c) Double click on 'PrognosisRestore.bat
Upgrade on a different drive to the previous Prognosis version Backup folder
a) Install the new Prognosis version on the required drive, e.g. E:\Prognosis
b) Go to the 'Backup_restore' folder of the new Prognosis installation, e.g. E:\Prognosis\Backup_restore
c) Open a command prompt with administrative privileges and run PrognosisRestore.bat specifying the location of the backup folder, e.g.
Page 43
Troubleshooting Backup Issues
When an error has occurred during the Prognosis backup, it will be necessary to fix the error manually before re-running the Prognosis installer. To do this proceed as follows:
Step 1 To determine the cause of the failure, open the backup log which resides in the following folder path:
<RootDrive>\PrognosisBackup\PrognosisBackup-<MachineName>-<DateTime>\Log\Backup.log where <RootDrive> is the drive where Prognosis 9 is installed.
Example:
C:\PrognosisBackup\PrognosisBackup-ServerA-2013-12-01T09.00.00\Log\Backup.log
Step 2 Search for the text ‘Error:’ in the log file. This will typically reveal what items have not been backed up successfully. These will usually be Analyst, Threshold or Database documents where the Prognosis SECURITY Configuration is preventing the installer from executing certain commands.
Example
Backing up Thresholds ---
No THRESHOLD detected in MyAlert listing. Error: No threshold data returned.
or
Copying Database Templates and Files to Backup Location. ---
Error reading 'Trouble_Shooting',error: Access denied to database Trouble Shooting.
Step 3 Open the previous Prognosis version make a backup copy of the SECURITY Configuration file. Copy this to a temporary location.
Step 4 In the original SECURITY Configuration replace the entire text content with: SUBSYS SECURITY
GRANT (*,*,*)
Step 5 The upgrade can now be run again. As the security has now been deactivated the upgrade should run without failure.
Step 6 Copy the backup SECURITY Configuration file from the temporary location into the new Prognosis installation.
Previous Prognosis Control Panel Running
If the old Prognosis Start/Stop Control Panel is still running, it may cause the upgrade to fail. This will be indicated by a message similar to the following the the 'install.log' (this is located in the same folder path as the 'backup.log - see above).
2013-11-25 14:00:37 running process off 'irstartstop.exe': 'E:\PROGNOSIS\Server\Configuration\IRStartStop.exe', PID=4936
2013-11-25 14:00:37 The Prognosis Service Control Panel is running. Please close the Prognosis Service Control Panel and press OK to continue.
2013-11-25 14:00:39 running process off 'irstartstop.exe': 'E:\PROGNOSIS\Server\Configuration\IRStartStop.exe', PID=4936
2013-11-25 14:00:39 The Prognosis Service Control Panel is still running. Please close the Prognosis Service Control Panel and run setup again. Setup incomplete. Action ended 14:00:41: InstallFinalize. Return value 3.
Page 44
Troubleshooting Restore Issues
When an error has occurred during the Prognosis restore, the Prognosis installer will log the error and continue. In this case, the backup folder will not be removed. The items which have not been successfully restored can usually be restored manually from the backup folder. To do this proceed as follows:
Step 1 To determine the cause of the failure, open the restore log which resides in the following folder path: <Prognosis10Folder>\Backup_restore\Restore-<MachineName>-<DateTime>.log
where <Prognosis10Folder> is the folder where the new Prognosis version is installed.
Example:
C:\Prognosis\Backup_restore\Restore-ServerA-2013-12-01T09.00.00.log
Step 2 Search for the text ‘Error:’ in the log file. This will typically reveal what items have not been restored successfully.
Step 3 Open the backup folder which can be found in the following folder path:
<RootDrive>\PrognosisBackup\PrognosisBackup-<MachineName>-<DateTime> where <RootDrive> is the drive where Prognosis 9 is installed.
Example:
C:\PrognosisBackup\PrognosisBackup- ServerA-2013-12-01T09.00.00 Step 4 Locate the missing item in the backup folder.
Step 5 Copy the item to the new Prognosis version into the Server/Configuration folder. Step 6 Open a command prompt with administrative privileges and change to the
Prognosis/Server/Configuration folder. Step 7 Run "..\ircmd" on the copied document.
Example
C:\Prognosis\Server\Configuration>..\ircmd myalerts_threshold.txt Example
The restore log indicates that there is an error in restoring Thresholds.
Resolution:
i. From the backup folder open the 'Threshold' sub-folder and locate the required Threshold template (.txt) file.
ii. Copy the Threshold file into the Prognosis\Server\Configuration folder of the new installation. iii. Open a command prompt with administrative privileges and change to the
Page 45
Backup/Rollback Previous Version
As the upgrade process will remove the earlier Prognosis version, it is recommended that a manual backup of the previous version be made prior to attempting the upgrade. This provides an opportunity to roll back to the previous version if necessary.
This procedure is a complete backup of the previous Prognosis version, it should not be confused with the automatic 'backup' which is carried out by the new Prognosis upgrade process which is only used to transfer configuration data to the new version and is then automatically deleted. See the Upgrade Process topic (page 40) for further details.
Backup
The following files, if installed, should be backed-up. The following examples are based on a default installation.
Step 1 Create a backup location outside of the existing Prognosis installation folder that can be used to store the backup items (e.g. C:\Prognosis-Backup).
Step 2 Back up the whole Prognosis installation folder (e.g. C:\Program Files\Prognosis). To do this simply 'zip' the whole Prognosis folder and copy to the backup location.
Step 3 Back up the Prognosis folder of the Windows Start Menu (e.g. C:\Users\All
Users\Microsoft\Windows\Start Menu\Programs\Prognosis). To do this, locate and then copy the Prognosis folder to the backup location.
Step 4 Back up the following Windows Registry keys. To do this open the Registry Editor (regedit), locate each key, click the File Menu and then select Export. In the Save box select the backup location and then click Save.
Back up the Registry Key (Old installation log data):
HKEY_LOCAL_MACHINE\Software\IntegratedResearch\PROGNOSIS\ServiceName
Example:
HKEY_LOCAL_MACHINE\Software\IntegratedResearch\PROGNOSIS\PROGNOSIS Back-up the Registry Key for the InstallShield uninstall settings.
HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Uninstall\<PRODUCT_GUI D> Example: HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Uninstall\{2B10CE30-4318-11DO-8640...} <PRODUCT_GUID>
Page 46
Rollback
After completing a backup, should it be necessary, it is then possible to roll back to the previous Prognosis installation.
If a complete or part Prognosis installation needs to be removed first, carry out these steps: Step 1 Stop all running Prognosis processes.
Step 2 Delete all files from the Prognosis folder (e.g. C:\Program Files\Prognosis). Step 3 Delete the Prognosis folder from the Windows Start Menu.
Step 4 Delete the newly created uninstall registry key, once again, checking the LogFile for the path of the correct PRODUCT_GUID (see Backup procedure):
HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Uninstall\<PRODUCT_GUI D>
To restore the previous version:
Step 5 Expand the backed-up Prognosis files into the required folder (e.g. C:\Program Files\Prognosis). Step 6 Restore the backed-up Prognosis Start Menu item to the Start Menu folder (e.g. C:\Users\All
Users\Microsoft\Windows\Start Menu\Programs).
Step 7 Restore the exported registry keys. Do this by locating the registry files (.reg) that were created as part of the Backup procedure and then double click on them.
There could be some locked files/folders - delete as much as possible. Locked files/folders are released by rebooting the machine.
Any steps involving the Registry Key’s should only be attempted by a qualified System Administrator with knowledge of these files. Incorrect actions could cause serious damage to the system. If in doubt please contact Prognosis Technical Support.
Page 47
Upgrade Procedure
Procedure
Step 1 Place the Installation CD into the CD drive of the required machine. If Autorun is activated the CD will start the installation automatically. If the installation fails to start, go to Windows Explorer, select the CD drive, copy the Prognosis installer to a local drive and then run the Prognosis10.exe file. or
Download the Prognosis10 installer to a local hard disk and then run the Prognosis10.exe file. Prognosis10.exe is a self-extracting executable that will extract into a folder named 'Prognosis10'. On slow machines this may take a few minutes. Once extracted, the folder will contain:
- Prerequisites folder - Backup-restore folder - Prognosis10.msi - Setup.exe
Setup.exe will now run automatically and initially check for the required pre-requisite software (page 26).
a) If the pre-requisite software is not found on the destination machine, it will be automatically installed. This may result in some non-Prognosis dialog boxes being displayed, but normally it will only be necessary to 'click' through these until the software has been installed.
b) If the required pre-requisite software is found on the destination machine, or after it has been installed, the Prognosis Welcome dialog will open.
Page 48
Step 2 End-User License Agreement
The next step in the installation is the acceptance of the End User License Agreement (EULA).
Carefully read the End User License agreement and then click the check box to accept the terms and conditions. The Next button will become active and can now be selected to continue with the installation.
Page 49
Step 3 Upgrade
Setup will now detect if a valid Prognosis version is available for upgrade:
The following message will be shown where a valid Prognosis version is detected..
Click the Next button to proceed with the upgrade.
Page 50
Step 4 License
The installation will now request the Prognosis license file (page 12) information.
In most cases the license information is sent by email as an attached text file. When received, it is recommended that the license file be saved to the same folder as the Prognosis installation files The License dialog box will default to the same folder path as the installation files, should the license be located elsewhere or should an invalid license be found, an alternative license location can be specified or browsed for.
The license field may be left blank, however this will only allow the Prognosis Windows Client to be installed. Please note that the Windows Client cannot be used with the UC Foundation Edition license.
Page 51
Step 5 Prognosis Components
