PRODUCT_LINE: BCM ============================================ Software Name: Patch Support Wizard 2.5 Applicable Hardware Platforms: BCM 1000, BCM 400, BCM 200, SRG200 1.0, SRG400 1.0 Applicable Software Platforms: BCM 3.6, BCM3.7, SRG 1.0 based on BCM 3.6, SRG 1.0 based on BCM 3.7 Category: Tool Dependencies: None Product Dependencies: None Size: ~1.67Mb PATCH SUPPORT WIZARD OVERVIEW The Patch Support Wizard is a tool designed to facilitate the installation of multiple patches. The downloadable file is the install wizard which will install the Patch Support Wizard application and all other necessary files that goes with the application. FEATURE SUMMARY The Patch Support Wizard tool can be used to apply multiple patches to a BCM 1000/200/400 and SRG 1.0 based on BCM 3.6/3.7 system while minimizing the number of reboots with the ability to recognize the version of an individual patch and apply it if applicable. The tool improves the patch application process time and helps to reduce effort when patching the BCM system. CHANGES IN THIS DEVELOPMENT 1. Installation Location The wizard will no longer be installed in the system32 folder. The tool will be installed in its own local folder "Patch Support Wizard" inside the Program Files folder. CR: Q01418985 2. Upload Manager Splash Screen Text The text that appears above the list window component on the Upload Manager window has been rephrased. CR: Q01491976 3. Invalid Source Folder A proper dialog message will be shown that no applicable patches are found from the provided source folder if it is invalid. An invalid source folder in this sense would mean a source folder that does not contain any applicable patch exe files. CR: Q01639987 4. Screen Focus In older versions, the tool window would fall behind other active windows after the tool unzips the first set of patches before the Upload Manager window appears. This has been solved by first showing the Upload Manager window. The user will now need to click on the "Browse... " button first to select the source folder. CR: None 5. GUI Refresh During BCM Reboot The tool GUI refreshes properly now when the BCM is rebooting during a system recovery after a patch install error or a patch install cancellation. CR: None 6. Upload Manager Back Button An issue with the Back button from the Upload Manager window has been solved. In previous versions the Back button, after being pressed, will cause patches with double components to be duplicated on the updated list of patches on the Upload Manager window. CR: Q01624381 7. Upload Manager Window Title Renamed the window that was called "Proceeding to upload patches to BCM: " to "Upload Manager". CR: None 8. Patch ReadMe Question Rephrased The question asking if the user would like to view the patch ReadMe files has been rephrased. CR: None 9. Patch Error Notification The dialog message notifying the user that a patch error has occurred has been rephrased. This message appears after the BCM has performed a reboot that is part of the system recovery procedure when a patch installation error has occurred. CR: None 10. Time Gap Added a time gap of 29 seconds between patch installations to allow the BCM time to recover from the previous patch installation. CR: None 11. "Not Applied Patches" Column & Patch Errors When an error occurs during a patch installation it will be placed in the "Not Applied Patches" column on the Status Report window. The wizard will reset services to auto and reboot the BCM. The user can either restart the patch application from the Connection Manager window or exit the program. CR: None 12. Multiple Instances Application will notify the user that multiple instances of the application cannot be run. The application will prevent another instance from running if attempted. Only one instance of the application can be run at a time. CR: None 13. Work Folder Cleanup Fixed an issue were files in the work folder were not removed when the application was terminated. CR: Q01420808 Q01558457 14. FTP Configuration Wait Time Fixed a FTP configuration issue by changing the wait time between the end of the FTP configuration and the next set of instructions to a maximum of 90 seconds. Set a maximum of 39 seconds during each patch upload to the BCM. CR: Q01558327 15. Post-Cancellation Procedure When the user presses the Cancel button on the Status Report window the application will set services to auto if necessary and reboot the BCM to restore normal operation. CR: None 16. Splash Screen Next Button The next button from the splash screen has been removed. CR: None 17. "Applying Patch" Window Cancel Button The cancel button from the "Applying Patch" window has been moved to the Status Report window. Pressing the cancel button will not terminate the current patch installation but will prevent the remaining patches in queue from being installed. CR: None 18. Default Behavior of the "Applying Patch" Window The Applying Patch window will be shown on the first time by default. The user may press the button "<< Hide Details" on the Status Report window to hide the window. CR: None 19. Main Window The Connection Manager is now the main window and will stay in the background. CR: None 20. Naming Convention in Add/Remove Programs The software will be listed as "Nortel Patch Support Wizard xxx" in the "Add or Remove Programs" in the Window's Control Panel. The "xxx" is the version number of the software. CR: None 21. Column Name Change The following name changes appear in the Status Report window: "Failed Patches" has been changed to "Patches Not Applied" "Successfully Applied Patches" has been changed to "Patches Successfully Applied". CR: None 22. Health Check Failure BCM patches that were not successfully applied due to health check failures will be listed under the column "Patches Not Applied" in the Status Report window. CR: None 23. "Patch Progress" Bar The "Patch Progress" bar on the Applying Patch window now updates properly and changes accordingly to the status of the patch installation. CR: Q01507423 24. New Button on the "Status Report" Window A "Show Details >>" button has been implemented on the Status Report window. The Applying Patch window will not appear unless the user presses the "Show Details >>" button. Each Applying Patch window will stay visible for each patch installation until the user presses the "<< Hide Details" button on the Status Report window. A small text message will appear on the Status Report window above the "OK" and "Cancel" button to tell the user which patch is being applied. The Applying Patch window will appear on the top-right hand corner of the user's Screen to avoid covering the Status Report window. CR: Q01507431 Q01491989 25. ReadMe File Display Issue Fixed an issue where readme files were displayed for older patch versions. CR: Q01544281 26. Discrectionary Patch List The discretionary patch list has been removed. CR: Q01544260 27. User's Guide Changes Several changes to the User's Guide were completed. CR: Q01547948 28. Proper Installation The software will be installed in the Program Files folder under the Nortel/Patch Support Wizard folder. The application will be listed in the Start Menu under Nortel/Patch Support Wizard. CR: Q01418985 Q01504784 29. Incorrect Connection Information Resolved an issue that prevented the user from connecting to the BCM after an incorrect password was entered. CR: Q01420747 30. Excluded Patches Added a routine to handle excluded patches properly. CR: None 31. Patch Unzipping Patch unzipping issue resolved. CR: Q01499788 Q01481554 32. Start Menu Shortcut In Window's Start Menu, the Patch Support Wizard application shortcuts will reside in the start menu folder under \Nortel\Patch Support Wizard. CR: None 33. Work Folder An independent work folder has been created in the Application Data folder. Patch names will not be changed in the source folder. CR: Q01507391 34. Undeleted Folders The undeleted folders that are left will not concern the user anymore since a work folder has been created for the tool's own use and the tool will not tamper with the contents in the source folder. CR: Q01420808 35. Renaming Filenames Filenames for patch executables in the source folder will not be changed. CR: Q01516782 Q01507391 36. Cancel Button Issue Fixed a known issue with the cancel button on the Applying Patch window. Once the user cancels the current patch installation the active Patch Progress window will still be shown so that the user can continue to observe the installation activity. Once the current patch installation is successful the patch will be listed under the Successfully Applied Patches list in the Status Report window and the tool will cease to install the remaining patches. CR: Q01533498 37. Log File Log file was created for diagnosing application errors and is located in the Patch Support Wizard installation folder. The filename of the log file will be psw_xxx.log where xxx represents the version number of the tool. CR: Q01507410 38. System32 Folder The program will no longer be installed in the C:\WINNT\system32 folder. The installer will automatically install the tool in the Program Files\Nortel\Patch Support Wizard folder. CR: Q01418985 39. PDF Document Converted user manual from Word document to PDF file format. CR: Q01507528 40. Revision of Documents Documentation and readme files for the tool were revised. CR: Q01504725 41. Firewall Instructions Added firewall instructions to the User Guide. CR: Q01504725 42. File Removal Readme file removed since both the Release Notes and the Readme files are identical. CR: None 43. Cancel Button Added A Cancel button was added to the Patch Progress window. When the user presses the cancel button the application will prevent remaining patches from being installed after the active patch completes. CR: Q01507449 44. Start Time Added A start time has been added to the Applying Patch window. CR: Q01507399 45. Help Document Updated Help document was updated to add patch readme file viewing instructions and unzip problem warning messages. CR: Q01491961 46. Viewing Patch ReadMe Files The user can now choose to view the readme files for each patch to be applied. CR: Q01456217 47. Core Patches In this version all core patches will be applied last. The core patch will have an additional two reboots. CR: Q01449851 48. Unzip Check A check was added to make sure patches are unzipped properly. If a patch is not unzipped properly the user is notified that this patch will not be included in the final patch list. CR: Q01456158 49. Browse For Folder Cancel Button Fixed an issue with the Cancel button in the Browse for Folder dialog window. CR: Q01420767 50. BIOS and SU Patches BIOS and Service Update patches are not supported and will not be applied by the application. CR: Q01422467 Q01516770 Q01422369 PATCH SUPPORT WIZARD TOOL INSTALLATION Run the patch tool installation wizard, PSWInstall_25.exe, to install the application on a PC. The tool will install as an application on the target PC and can be accessed from the start menu shortcut. The tool will also install the Release Notes, the User Guide, and an uninstaller, in which each of those items are also available from the start menu shortcut. Program files from older versions of the Patch Support Wizard will be overwritten by the files from this newer version after the installation. To uninstall the previous version, go to the folder Nortel/Patch Support Wizard in the Start Menu and click on the Uninstaller. If you decide to uninstall the older version, you will be prompted to decide whether you want to keep the log file from the previous version or not. In addition, if the installer of this version detects any older log files that exist in the application's program folder then it will prompt you whether the file should be deleted or not. The Patch Support Wizard has the following system requirements: - Operating System: Windows 98 SE, Windows 2000, Windows XP - Memory: At least 15.5 MB free TOOL USAGE To start the tool, go to Start Menu and go to the folder Nortel/Patch Support Wizard and click on "Patch Support Wizard". The technician downloads any/all applicable patches to a folder on the PC. Recommended hierarchy would be to store all BCM 3.6 and BCM 3.7 patches in separate source folders. When the tool is started, it presents a splash screen followed by a dialog window allowing the technician to connect to the target BCM. The window provides a prompt for the technician to enter the user name and the password to connect to the BCM system. The tool will detect the BCM system software version and present a dialog window to allow the technician to select the source folder where patches are stored on the PC. Note: The tool will only apply patches applicable to the software version of the target BCM system. LIMITATIONS The tool is not intended for use with any of the following: - NCM, - Pre 3.6 systems, - Linux Based BCM systems; e.g.. BCM50 or BCM4.0, - Cumulative or Service Update patches, - BIOS patches, - Security patches, - OS2 patches, - WIN/WINDOWS patches. If you receive the following error "There is insufficient disk space on the BCM drive F:\ " please install BCM370.192-OS2 patch or later before attempting to apply patches with the patch Support Wizard. This patch will free up sufficient drive space on the F: partition so you can continue patching the BCM. The OS2 patch can not be installed by the Patch Support Wizard and must be installed individually. All patches in the source folder will be unzipped to the work folder regardless of the patch version. For example all 3.6 and 3.7 patches will be unzipped but the correct software version will be selected by the wizard . The best way to avoid this is to put all 3.6 patches in one source folder and all 3.7 patches in another separate source folder. If there is not enough disk space to unzip a patch to the work folder the user will be asked whether or not they want to continue. Regardless of whether the user answers 'Yes' or 'No', the patch will continue to be unzipped. Once the application completes the unzip process an error message will appear indicating the patch was not unzipped correctly. The patch will not appear in the patch list of patches to be applied. The user should clean up the C: drive so the patch can be unzipped correctly.