TLS 1.2 Interface Update Script User Guide

Transcription

1 TLS 1.2 Interface Update Script User Guide

2 Index Overview Preparation Requirements Installation Downloaded update package files Extract files TLS 1.2 Interface Update - Using Script TLS 1.2 Interface Update - Manual Rollback Procedure Troubleshooting Success Example: What to do when the Installation Fails Validation Steps Permissions Your error may look like: Checking the.net Framework Searching for Interface Upgrade Steps Stop the Service Create the Backup Update the Files Synch old Settings with new Interface Situational - Update the config file Document control Security level Company Department Author Public Amadeus IT Group SA R&D Rachel Petitto, Marvin Hernandez Version Date Change Comment By N/A Initial Document Rachel Petitto, Marvin Hernandez

3 Overview The purpose of the script is to update v4.x.x interfaces to the latest version which adds support for communication over TLS 1.2 with the HotSOS API as shown in the following diagram: Typical Interface Design - Communication over TLS 1.2 Preparation As with any systems used in production environments, users who rely on the systems should be made aware before maintenance is performed to set proper expectations should any challenges be identified during the update process that may lead to extended downtimes or the need to rollback. Extended downtimes are not expected when updating the interface with the script, as the average downtime is 3-10 seconds, however, should the script s execution be unsuccessful, the update may be performed manually, if there are challenges with the manual update, changes may be rolled back. Such process would require additional downtime (average of five minutes). This document provides instructions for these scenarios. With this in mind, alerting all users who may be impacted by downtime is strongly recommended. Instructions below assume the following: All requirements are met before proceeding TLS 1.2 is supported and enabled in OS environment The correct TLS 1.2 update package corresponding to the targeted interface has been downloaded to the interface host These steps will be performed by Hotel IT administrative staff, as the execution of the script requires administrator rights. Users following these instructions will get familiar with the outlined process before attempting to update interfaces Requirements Windows 7 (32/64-bit) or newer, Windows Server 2008 or newer.net v4.5.x or higher Administrator rights Existing v4.x.x interface Correct TLS 1.2 update package corresponding to the targeted interface

4 Installation IMPORTANT While images in this guide show references to the LMS interface, the steps apply to any supported v4.x.x interface for which you downloaded the update package files. 1. Downloaded update package files Downloaded files will look similar to ones below. It is important to ensure the version number referenced in the file names, match for both files 2. Extract files Create a folder that can easily be found (i.e. desktop\tls 1.2 Update\), and extract the contents of the INTERFACE_x.xx.x (mm-dd-yyyy).zip archive in it. Proceed to extract the run.bat and pms_upgrade.ps1 files from the INTERFACE_x.xx.x - Installer (mm-dd-yyyy).zip archive to the same folder, ensuring these two files are placed at the root of the directory where the contents from the first archive were extracted.

5 3. TLS 1.2 Interface Update - Using Script IMPORTANT In this example the update is applied to the LMS interface. However, these instructions apply to any v4.x.x interface. Before proceeding, please ensure the interface s installation directory or any file within it is not open (i.e. the C:\Program Files\MTech\Interface\PMS\LMS directory open via explorer.exe, or MTechInterface_LMS.exe.Config open by notepad.exe) to minimize running into challenges. If the extracted files look similar to the below, you may proceed (if not, please revisit step 2 above). From the folder containing the extracted files, right-click the run.bat and select the Run as administrator option. This may be done with the interface running. If a User Account Control (UAC) prompt appears click Yes to proceed The script will execute and run a validation before performing the update. Should the host not meet minimum requirements, the validation will fail Action for failure at each validation item: 1. Ensure you are logged on as an Administrator to run the script 2. Ensure.NET Framework 4.5 (or greater) is installed 3. Ensure you are using the correct TLS 1.2 interface update package for your interface and the interface is hosted on the server the script is being executed on

6 In unique cases where the interface service name is custom, the interface will show the message below in step 3. This allows for the script s user to type the service name exactly as it appears in Windows services (if the service name includes spaces, you must use quotations around the name (i.e. MTechInterface_LMS Hotel A ). Once the custom name is typed for the service, users may proceed by pressing the enter key. Once the validation ends, the physical upgrade will begin. The physical upgrade portion of the script consists of: 4. stopping the interface service 5. Backing up the existing installation, should there be a need to rollback (backup created by the script is saved in the same directory interface is installed) 6. Updating files in the existing installation directory 7. Applying the existing interface configuration and temporary data to updated files 8. Configuration is checked for missing configuration keys (implemented after initial interface deployment). If missing, keys will be added as inactive

7 After the physical upgrade completes, the interface s service will be started, and statistics showing total execution time will be displayed 4. TLS 1.2 Interface Update - Manual IMPORTANT In this example the update is applied to the LMS interface. However, these instructions apply to any v4.x.x interface. Before proceeding, please ensure no files within the interface s installation directory are not open (i.e. the C:\Program Files\MTech\Interface\PMS\LMS\MTechInterface_LMS.exe.Config open by notepad.exe), also close the Interface s UI (opens in Internet Explorer via desktop shortcut) to minimize running into challenges. Create Backup Stop the interface service Create a copy of your existing interface installation folder to serve as a backup should a rollback be needed IMPORTANT If a file fails to copy successfully, it is strongly recommended that you delete the new copy, ensure no files from within the installation directory are open, and reattempt creating a copy of the existing interface installation folder until it succeeds before proceeding. Rename copy to include Backup reference in the folder s name. This may prompt for Administrator permissions Once done, backup folder should be left in same directory as the existing installation directory. Update Interface From the extracted files open the INTERFACE_x.xx.x (mm-dd-yyyy) folder (done in step 2 above) to show it s contents and leave visible. This folder contains the latest interface build

8 Open the interface installation folder to show it s contents and leave visible as well IMPORTANT for the next step, do not copy the LocalBD.sdf or MTechInterface_INTERFACE.exe.Config files, as the existing files must be kept. Overwriting these files with ones from the new interface build folder will remove configuration and temporary data for the hotel. Should files be overwritten, copies of both files from the backup created earlier will need to be used. Copy all files from the new interface build folder to the interface installation folder When prompted to overwrite files in the destination folder, check the Do this for the next x conflicts box and select the Move and Replace option

9 When done, start the interface service Launch the Interface s UI (opens in Internet Explorer via desktop shortcut) and monitor activity for at least five minutes. Should errors related to the API agent occur, they will be highlighted with a red background. If errors continue to log consistently after at least three minutes, proceed to rollback. 5. Rollback Procedure Ensure the interface s service is stopped Delete the active interface installation folder (no backup reference in name) Rename the folder with backup reference in the name to exclude backup reference End result example When done, start the interface service The interface is back to a pre-update state.