5G support tool V4.5 Installation Guide

Transcription

1 5G support tool V4.5 Installation Guide Date: 16/12/2014 Jeroen Jacobs

2 1 Administration 1.1 Document Identification Title 5G support tool V4.5 Project - Subject Installation Guide File(s) Company 5g support tool v4.5 installation guide 1.0.docx fifthplay 1.2 History Last modification: 26/07/ :55:00 Version Date Status Author Comments /12/2014 Released Jeroen Jacobs Initial version 1.3 Reviewers Reviewer Version Date Comments 1.4 Approvers Approver Version Date Company & Role Signature Jeroen Jacobs /12/2014 Fifthplay Project Manager Page 2 of 15

3 2 Introduction 2.1 Purpose & Goal This document defines the installation requirements for the renewed support tool functionality for 5G complexes (5G Support tool edition 2014, aka the 5G Support tool Version 4.5 ), available for the support departments. Via this tool, online complexes can be accessed e.g. for investigation and restoration of the correct operation. In comparison with the previous version of the documentation, it is split-up into 2 documents: one document will handle the installation procedure / installation requirements of the tool, the second one describes the tools functionalities in more details. This document is the first of the two documents and will describe the installation part of the support tool. 2.2 Abbreviations and naming Term 5G Aka AMP Apt Mb PC R&D SSH Description 5th Generation (of building automation system of Niko Projects) Also Known As Asset Management Portal Apartment Megabytes Personal Computer Research & Development Secure SHell Vx (e.g. V1, V2, V3) Version x (Version 1, Version 2, Version 3) 2.3 References List of additional documents and source material: Title Version Date Author Description 5G Installer Web Interface Quick Guide V /09/2011 Jeroen Jacobs Installer Web I/F User Guide V1 5G support tool V4.5 User Guide V1.2 (not known yet at date of publication) Jeroen Jacobs 5G support tool functional description and user guide Page 3 of 15

4 2.4 Table Of Contents Contents 1 Administration Document Identification History Reviewers Approvers Introduction Purpose & Goal Abbreviations and naming References Table Of Contents Requirements OS Browser NET PuTTY Free Disk Space User Rights Installing the tool First installation Upgrade from a previous version Login Page 4 of 15

5 4 Requirements 4.1 OS The 5G support tool V4.5 is suitable for installation on machines using the following operating systems: - Microsoft Windows Vista - Microsoft Windows 7 - Microsoft Windows 8 (*) Both 32-bit and 64-bit versions of those OS are supported. Other operating systems (e.g. Microsoft Windows XP, Mac OS, ) are NOT supported. For proper installation, administrator rights are mandatory. (*) not verified yet, but no problems are expected. 4.2 Browser On the PC, also one or more of the following browsers should be available: - Internet Explorer 9 or higher (mandatory) - Mozilla Firefox 6 or higher (recommended) - Opera 10 or higher - Google Chrome 13 or higher (recommended) - Safari 5 or higher To be able to install the tool, ONLY INTERNET EXPLORER IS ALLOWED. If you try to install the tool using another type of browser, the installation will FAIL and a MANUAL CLEANUP of temporary files generated during installation will ALWAYS be necessary, before a new installation attempt with Internet Explorer will be successful afterwards. Once the 5G support tool is installed, the use of Firefox or Chrome is recommended, as some functions may not be available or may not always react properly when using one of the other browsers. 4.3.NET Before installation of the tool, be sure Microsoft.NET Framework 4.5 (x86 and/or x64) or higher is installed on the PC. The use of Windows installer 4.5 is also mandatory. Otherwise the installation of the tool will also fail. 4.4 PuTTY To be able to take over a touch screen remotely, PuTTY should be installed on your system to open an SSH tunnel towards the screen. The installation of PuTTY version 0.62 or higher is recommended. Normally, PuTTY is already installed on your PC. 4.5 Free Disk Space The 5G support tool is a ClickOnce application for simplified installation. Approximately 30 Mb of space will be needed. Page 5 of 15

6 4.6 User Rights For a successful use of the tool, the necessary rights to synchronize to one or more of the AMP environments should be granted as well as the explicit use of the tool. Otherwise, no login into the tool will be possible. This is done for security reasons. Both rights have to be granted by the fifthplay R&D team. An account is strictly personal and should only be used by the person who was granted to use the tool. Abuse, use of the account by other persons or use without prior and profound knowledge of the 5G system (at embedded side as well as at core / AMP side) may harm the installed base = the systems installed in the complexes. It can disrupt the 5G functionalities and used databases as well as cripple the IP of fifthplay at core side (business logic used by fifthplay services included) and is strictly forbidden. Notice that the use of the tool may be logged or monitored by fifthplay. Abuse can result in withdrawing access to the systems. Use of the software implicitly means the user acknowledges to have sufficient knowledge of the 5G system and is totally aware of the risks involved with his actions. Using the tool also means the user accepts all of the above made statements. Page 6 of 15

7 5 Installing the tool 5.1 First installation The support tool installation is rather easy to be done, if the necessary precautions are taken and the steps are done exactly as described. Important notice: If you install the tool for the first time on your computer, you can proceed directly with the steps described below. If an older version of the tool is already installed on the computer, please uninstall the previous version(s) of the 5G support tool before proceeding. The necessary steps to do so can be found in the next paragraph, named Upgrade from a previous version. Installation steps when installing the tool: 1. Browse to the installation page using Internet Explorer. This 5G support tool installation page can be found on the following internet address: The following page will be displayed in your browser: Page 7 of 15

8 2. Click the Launch Installation button. The installer will then verify all necessary components and minimum hardware is available: If this is okay, the installation should then proceed. A new window is displayed then: Choose Install in this Application Install Security warning dialog. The tool will now be downloaded. A window with a progress bar is displayed: When the download is completed, the tool is automatically installed without need for any user interference and will also directly be launched for first usage. Page 8 of 15

9 Important remarks concerning your PC s.net environment: 1. It is possible that, during installation, the setup tool will ask for the upgrade of.net to a more recent version. This will only be the case if the version already found on the PC is older than stated in the paragraph Requirements. In this case, accept the installation of the newer version, as it is mandatory for the proper working of the 5G support tool. 2. As also mentioned as footnote in the Installation Complete closing window during the installation process (which gives the message that, even if the.net framework was estimated to be recent enough by the installation program), it is highly recommended to check for all critical updates and to install them all. Updating the.net framework to the latest edition available will result in an increased safety and security of your system during the use of the 5G support tool. Page 9 of 15

10 5.2 Upgrade from a previous version When a user tries to install the tool as described in paragraph First Installation, but an older version of the tool is still installed on the computer, the setup program will display the following error message: Press OK. The installation then will be terminated. If you try to install the 5G tool when another version was still active, then also an error will be thrown. If one of those errors occurs, the user has to do the following: 1. Close the 5G tool AND any tool windows that are still open. If you don t do this, the installation of the new tool will fail. 2. Verify ALL putty sessions are closed. This can be done by hitting <CTRL> + <ALT> + <DEL> at the same time, select the option to open the TASK MANAGER. Within the task manager, select the processes tab and see if any putty session is still open. If so, please select the putty session and press the end process button. Repeat this process until you have closed ALL putty sessions and none are found in the processes list anymore. If a putty session still exists when trying to install the new 5G support tool, it will also fail. 3. Open Windows Control Panel. Select the software (un)install or Add / Remove Program option. E.g. in Window 7 this can be found here (Programs > Uninstall a program): Page 10 of 15

11 4. A list of installed programs is displayed. Select the old version of the tool from the list and select uninstall. 5. A popup will appear to be sure you want to uninstall the old version of the tool. Confirm you want to uninstall the tool. Note: the pop-up text displayed may differ from the one shown in this document. It is possible a few options will be available (e.g. repair the installed tool etc.). If so, please select a removal of the tool and press OK to proceed with the uninstallation) 6. Normally, the program will now be uninstalled. Some popup windows may appear stating Windows is preparing to remove the tool, information is gathered and the tool is being configured and removed. Page 11 of 15

12 7. In case the older version of the tool was still open when trying to uninstall it, a popup will appear, asking if the tool may be closed. In this case, select automatically close applications and confirm by pushing the OK button. The tool will then be closed and removed from the computer. 8. After removal, the program will disappear from the list of all installed programs. Note that it s possible that the programs details are still visualized at the bottom of the control panel window. This is a normal behavior of some Microsoft Windows control panel versions and has not to be taken into account. The uninstall operation was completed successfully if the program disappeared from the installed program list as stated. 9. Then install the new version of the tool as described in paragraph First Installation. Page 12 of 15

13 6 Login The tool is named 5G tool and can be recognised by the following icon: The 5G support tool can be launched via the Windows home button and the direct link (if available) or can be found via the Windows home button, All programs under Fifthplay nv. Page 13 of 15

14 When the program is started, a login window is displayed. Fill in user name and password in the corresponding fields. Select the correct environment to be used (*): o Staging (test walls at fifthplay) o Demo o Production (deployed complexes to be used by Niko) Push the Login button to proceed. If the login is successful, the main window of the tool is displayed. If the login failed, an error message will be showed at the bottom of the login window, guiding the user what the cause of the problem is. Correct the problem(s) to proceed. (*) Real estate 5G complexes can be found in the Production environment. Test walls at fifthplay premises can normally be found in the Staging environment. The Development environment is strictly foreseen for 5G R&D during the development cycle. The Demo environment is currently for fifthplay services R&D usage only and isn t used at the 5G side. Notes: - A login will only succeed if the user has the appropriate rights to access the selected environment (see paragraph Requirements ) - At the next startup of the tool, the user name will already be prefilled (if the last login attempt was successful). - As the tool needs access to the selected AMP environment, a link with AMP has to be available during the session. If AMP isn t found, the login attempt will fail and display an authentication failed error window: This condition typically occurs during downtime of the fifthplay core (e.g. while upgrading the platform with the next released version). - Information for using the tool cannot be found in this document. it can be found in the 5G Support tool User Guide (see list of reference documents). Page 14 of 15

15 END OF DOCUMENT Page 15 of 15