Bosch Video Management System Patch Setup

Transcription

1 Bosch Video Management System Patch Setup en Technical Service Note

2

3 Bosch Video Management System Table of contents en 3 Table of contents 1 Introduction 4 2 Deliverables The.msp File The ReadMe.txt File 7 3 Patch Deployment Sequence 8 4 Uninstallation of Patches 13 5 Bosch VMS Diagnostics for Bosch VMS Patches Control Panel DLLs in Folder bin Registry ConfigCollection File Listing Registry Settings Patch Setup Log File 19 6 Bosch VMS Patching Special Cases Cumulative Patches Patch installation Patch uninstallation (oldest patch first) Patch uninstallation (latest patch first) Installing Bosch VMS Features on Patched Systems 21 7 Bosch VMS Patch Setup FAQ 23 Bosch Sicherheitssysteme GmbH Technical Service Note V1 DOC

4 4 en Introduction Bosch Video Management System 1 Introduction This document informs about the changed procedure for deploying Bosch VMS hotfixes. Hotfixes for Bosch VMS version and later will no longer be shipped as individual batch files and DLL files, but as setup files. The underlying setup technology is the same as for Microsoft patches. The motivation for changing Bosch VMS hotfix deployment was to improve the user experience and to avoid common mistakes when applying patches. To be consistent with Microsoft terminology, all future Bosch VMS hotfixes will be called patches. The term hotfix will no longer be used. For those cases where experimental or diagnostic patches must be shipped, the deliverable will be called experimental patch or diagnostic patch. For all other cases the term Bosch VMS patch indicates that the deliverable was fully tested by QA i.e. the functionality of the patch was ensured on a test system V1 DOC Technical Service Note Bosch Sicherheitssysteme GmbH

5 Bosch Video Management System Deliverables en 5 2 Deliverables Every Bosch VMS patch deliverable consists of a folder that contains two files: an.msp file and a ReadMe.txt file. Figure 2.1: Patch folder contents:.msp file and ReadMe.txt file The patch folder name indicates the Bosch VMS target version of the patch, a short title of the patch and the unique identifier. In the example above the target version is Bosch VMS , the short title is CameoSDK and the unique identifier is The.msp file is the setup executable that must be started to install the patch. The ReadMe.txt file contains detailed information about the patch. Both files the.msp file and the ReadMe.txt file are shipped together since the setup references the ReadMe.txt files. Note: Files InstallerInfo.txt and CustomerInfo.txt, which were formerly shipped with every Bosch VMS hotfix, are no longer required. Note: Starting with Bosch VMS Version 5.5.1, the patch setup dialog offers a Show the readme file button that opens the file ReadMe.txt. This button is not yet supported for Bosch VMS patches. As a consequence, for Bosch VMS patches the user must manually open file ReadMe.txt to get more information about the patch. 2.1 The.msp File The.msp file is a setup file which can be started like any other executable. The.msp file should be started on all Bosch VMS machines that are affected by the patch. Please refer to ReadMe.txt for details on which machines are affected by a patch. The.msp file name indicates the Bosch VMS target version of the patch, a short title of the patch and the unique identifier. Example.msp file name: BVMSPatch_ _PTZDomeIssues_ msp The file name indicates, that the patch is applicable for systems running Bosch VMS version has a short title PTZDomeIssues i.e. it has something to do with PTZ and dome issues resolves TFS bug Note: If a Bosch VMS patch fixes multiple issues, then the unique identifier of the patch consists of multiple, comma separated TFS bug IDs, e.g , Bosch Sicherheitssysteme GmbH Technical Service Note V1 DOC

6 6 en Deliverables Bosch Video Management System Important Note: It is no longer required to manually stop services before applying a Bosch VMS patch. The patch setup will automatically detect if services must be stopped before applying the patch. In this case, the setup program will prompt the user whether services should be automatically stopped and started. It is possible to abort the setup installation at this point. This gives the user the chance to apply the patch at a later time e.g. at a time when a short Bosch VMS server downtime is acceptable. Figure 2.1: Setup dialog informing about required service stop Note: The Bosch VMS patch setup can safely be started on Bosch VMS installations that are not affected by the patch. In this case, the setup will run through all installation stages without modifying any dlls on the system. Note: The Bosch VMS patch setup can safely be started on Bosch VMS machines with a not matching Bosch VMS version. In this case the following error dialog will pop up patch installation will be aborted after clicking OK V1 DOC Technical Service Note Bosch Sicherheitssysteme GmbH

7 Bosch Video Management System Deliverables en 7 Figure 2.2: Error dialog when running a Bosch VMS patch setup on a system with a wrong Bosch VMS version. Note: It is no longer possible to accidentally patch a Bosch VMS machine with a patch for a different Bosch VMS version. 2.2 The ReadMe.txt File The ReadMe.txt file contains detailed information about the Bosch VMS patch: patch identifier (bug ID and short title) problem details (details on the problem that is fixed by the patch) affected Bosch VMS components (Bosch VMS machines where the patch must be applied) list of replaced files (files that are replaced by the patch) The ReadMe.txt file replaces the formerly used file CustomerInfo.txt. The ReadMe.txt file does not contain detailed instructions on how to manually apply the patch, because these steps are automatically carried out by the patch setup functionality. Important note: Always make sure that the.msp file is shipped together with the corresponding ReadMe.txt file. If the ReadMe.txt file is missing, then there is no detailed information about the Bosch VMS patch. Note: If the ReadMe.txt file is missing when running the patch setup, then a click Show the readme file opens an empty Notepad file. To avoid this, always make sure that both, the.msp file and the ReadMe.txt file are delivered and are located in the same directory. Bosch Sicherheitssysteme GmbH Technical Service Note V1 DOC

8 8 en Patch Deployment Sequence Bosch Video Management System 3 Patch Deployment Sequence Bosch VMS patches cannot detect which Bosch VMS features (Management Server, Operator Client, Configuration Client, ) are installed on a system. Therefore it is required to apply the patches to all affected system of a Bosch VMS installation. For a list of affected systems, please refer to the ReadMe.txt file that comes with every Bosch VMS patch. To apply a patch, simply start the.msp file like any other executable. Note: It is not required to manually stop services before applying a patch: see below for details on what happens if the patch setup detects that services must be stopped. In the first phase of the Setup, the required space is calculated. This process might take a while. Figure 3.1: Space calculation dialog In the next setup step, details about the patch are displayed. The setup dialog indicates the ID of the patch, the short title and a summary of the problem details V1 DOC Technical Service Note Bosch Sicherheitssysteme GmbH

9 Bosch Video Management System Patch Deployment Sequence en 9 Figure 3.2: Patch details dialog with short patch description and Show the readme file button. Note that you can get all details about the patch by clicking the Show the readme file button. File ReadMe.txt is opened in Notepad when clicking this button. Bosch Sicherheitssysteme GmbH Technical Service Note V1 DOC

10 10 en Patch Deployment Sequence Bosch Video Management System Figure 3.3: Opened ReadMe.txt file The Bosch VMS patch details consist of The name of the patch Details on the problem being fixed by the patch A list of Bosch VMS components that are affected by the patch this list indicates on which Bosch VMS systems the patch must be installed (e.g. Management Server, Operator Client, Configuration Client, ) A list of files being replaced by the patch The installation of the Bosch VMS patch can be started by clicking Update >. If the patch requires replacing files that are used by one of the Bosch VMS services, then a dialog will prompt the user for permission to stop and restart these services. Note that patch deployment can be aborted in this case. When clicking Cancel, the patch setup will terminate without stopping services and without deploying patch files V1 DOC Technical Service Note Bosch Sicherheitssysteme GmbH

11 Bosch Video Management System Patch Deployment Sequence en 11 Figure 3.4: Setup dialog informing about required service stop If patch deployment was confirmed, then a progress dialog will show up while the patch is installed. Figure 3.5: Patch installation progress This final dialog will be displayed after the patch was installed: Bosch Sicherheitssysteme GmbH Technical Service Note V1 DOC

12 12 en Patch Deployment Sequence Bosch Video Management System Figure 3.6: Final Patch dialog V1 DOC Technical Service Note Bosch Sicherheitssysteme GmbH

13 Bosch Video Management System Uninstallation of Patches en 13 4 Uninstallation of Patches Every Bosch VMS patch can easily be uninstalled via the Control Panel. Start Control Panel, navigate to Programs / Programs and Features and click View Installed Updates. Figure 4.1: Programs and Features dialog On patched Bosch VMS systems, the list of installed updates contains one or more Bosch VMS patch entries. Bosch Sicherheitssysteme GmbH Technical Service Note V1 DOC

14 14 en Uninstallation of Patches Bosch Video Management System Figure 4.2: List of installed updates To uninstall a Bosch VMS patch, find the entry of the Bosch VMS Patch that you want to uninstall and right-click it to open the context menu. Select Uninstall in the context menu and confirm with Yes. Figure 4.3: Context menu entry Uninstall The Bosch VMS patch setup program now performs the patch uninstallation process V1 DOC Technical Service Note Bosch Sicherheitssysteme GmbH

15 Bosch Video Management System Uninstallation of Patches en 15 Important note: Bosch VMS services will be automatically stopped and restarted if the patch uninstallation requires stopping the services. The user will not be prompted to confirm automatic service stop/start! As soon as the uninstallation is finished, the Bosch VMS patch entry will disappear from the Programs and Features / Installed Updates dialog. The result of a patch uninstallation is that all files that were replaced by the patch are rolled back to their preceding state. Bosch Sicherheitssysteme GmbH Technical Service Note V1 DOC

16 16 en Bosch VMS Diagnostics for Bosch VMS Patches Bosch Video Management System 5 Bosch VMS Diagnostics for Bosch VMS Patches For problem investigation on Bosch VMS systems, it is important to know whether a system is patched or not. Here are a number of hints how to check whether a Bosch VMS system was patched or not. 5.1 Control Panel To find out whether a Bosch VMS system was patched, simply launch Control Panel. Then navigate to Programs / Programs and Features and click View Installed Updates on the left side of the dialog. Bosch VMS patches are indicated by entries below the Bosch Video Management System section. The name of Bosch VMS patches starts with Bosch VMS Patch. Figure 5.1: List of installed updates Note that Bosch VMS patches do not indicate information in the Version and Publisher columns of the Installed Updates dialog. Providing this information is not possible for technical reasons. 5.2 DLLs in Folder bin To find out whether a Bosch VMS system was patched, you can also check the Bosch VMS installation directory. In explorer, navigate to the <install-root-dir>\bosch\vms\bin directory and sort the files by date. Note that the file date of patched DLL files differs from the file dates of all other DLL files. Also note that the file version of patched DLL files differs: the build number part of the file version string is bigger than the build number of the original DLL files V1 DOC Technical Service Note Bosch Sicherheitssysteme GmbH

17 Bosch Video Management System Bosch VMS Diagnostics for Bosch VMS Patches en 17 Figure 5.1: Patched dll with differing file date and file version 5.3 Registry To find out whether a Bosch VMS system was patched, you can also check the registry. Run regedit from the command shell to open the registry editor. Navigate to registry hive HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Installer\UserData \S \Products. Then run a search on registry key Products for string Bosch VMS Patch. Bosch Sicherheitssysteme GmbH Technical Service Note V1 DOC

18 18 en Bosch VMS Diagnostics for Bosch VMS Patches Bosch Video Management System Figure 5.1: Registry with Bosch VMS patch 5.4 ConfigCollection File Listing It is also possible to find out the patching status of a Bosch VMS system by analyzing the file listing in a Bosch VMS ConfigCollection. Extract the ConfigCollection zip and navigate to folder \BvmsConfigCollection\Bvms\Bin. Open file FileInfo.txt and check the file dates and the file versions of the Bosch VMS DLLs. Note that the file date and file version of patched Bosch VMS files differ V1 DOC Technical Service Note Bosch Sicherheitssysteme GmbH

19 Bosch Video Management System Bosch VMS Diagnostics for Bosch VMS Patches en 19 Figure 5.1: Contents of ConfigCollection file FileInfo.txt (folder Bin) Registry Settings The patching status of a Bosch VMS system can also be found out by analyzing the collected registry hive in a Bosch VMS ConfigCollection. Extract the ConfigCollection zip and navigate to folder \BvmsConfigCollection\Bvms\Registry. Open file HKLM_SOFTWARE_Microsoft_Windows_CurrentVersion_Installer_UserData_S _Products.t xt and search for Bosch VMS Patch Patch Setup Log File You can also find out whether a Bosch VMS machine was patched by searching for patch setup log files. While the Bosch VMS patch setup is running, the patch setup log file is created in folder %tmp % (i.e. Folder C:\users\<user name>\appdata\local\temp). The original name of the log file is MSI*.LOG, where * stands for a random temporary string. On patch setup completion, the patch setup log file is copied to C:\Program Data\Bosch\VMS \Log and renamed to <.msp file name>.log. Example: the log file name of Bosch VMS patch setup BVMSPatch_ _PTZDomeIssues_ msp will be BVMSPatch_ _PTZDomeIssues_ log Since the patch setup log file is copied to the standard log file folder, it will also be collected by the ConfigCollector. To search for patch setup log files, extract the ConfigCollection zip and navigate to folder \BvmsConfigCollection\Bvms\Log. If the Log directory contains files named BVMSPatch_*.log, then the Bosch VMS patch setup was executed on the system. Bosch Sicherheitssysteme GmbH Technical Service Note V1 DOC

20 20 en Bosch VMS Diagnostics for Bosch VMS Patches Bosch Video Management System Note that the existence of a patch setup log file does not necessarily mean that a system is still patched. When removing the patch, the log file will still remain in the log folder V1 DOC Technical Service Note Bosch Sicherheitssysteme GmbH

21 Bosch Video Management System Bosch VMS Patching Special Cases en 21 6 Bosch VMS Patching Special Cases 6.1 Cumulative Patches It is sometimes required to merge two individual patches into one patch. This section describes the different installation and uninstallation cases when working with cumulative patches. Consider this example: Bosch VMS patch patches file A.dll (file version 001) Bosch VMS patch patches files A.dll and B.dll (file version 002) Patch installation Assume that Bosch VMS patch was already installed on a Bosch VMS system. When installing Bosch VMS patch on top of Bosch VMS patch 12345, the following changes can be observed on the patched system: Patch file A.dll (file version 001) is replaced by file patch A.dll (file version 002) Original file B.dll is replaced by patch file B.dll (version 002) A new patch entry is added to Programs / Programs and Features/Installed Updates. Note that patch entry will still be listed in Programs / Programs and Features/Installed Updates Patch uninstallation (oldest patch first) Assume that Bosch VMS patches and were installed on a Bosch VMS system. When uninstalling patch 12345, the following changes can be observed on the patched system: Patch file A.dll (file version 002) remains unchanged Patch entry is removed from Programs / Programs and Features/Installed Updates. Note that patch entry will still be listed in Programs / Programs and Features/Installed Updates Patch uninstallation (latest patch first) Assume that Bosch VMS patches and were installed on a Bosch VMS system. When uninstalling patch 54321, the following changes can be observed on the patched system: Patch file A.dll (file version 002) is replaced by patch file A.dll (file version 001) Patch entry is removed from Programs / Programs and Features/Installed Updates. Note that patch entry will still be listed in Programs / Programs and Features/Installed Updates. 6.2 Installing Bosch VMS Features on Patched Systems Assume that Bosch VMS patch consists only of dlls that affect Bosch VMS Operator Clients. When installing patch on a Bosch VMS Management Server no dlls is deployed, because there is no Bosch VMS Operator Client feature to be patched. You will still notice in this case, that patch entry is listed in Programs / Programs and Features/Installed Updates despite no dlls were deployed. Assume that you run the Bosch VMS installer again on the patched Management Server machine and assume that you install the Bosch VMS Operator Client feature. Bosch Sicherheitssysteme GmbH Technical Service Note V1 DOC

22 22 en Bosch VMS Patching Special Cases Bosch Video Management System You will notice in this case, that the Bosch VMS Operator Client is installed, and that patch is properly applied. I.e. the end result is that the dlls of patch are deployed on the machine V1 DOC Technical Service Note Bosch Sicherheitssysteme GmbH

23 Bosch Video Management System Bosch VMS Patch Setup FAQ en 23 7 Bosch VMS Patch Setup FAQ Q: What happens if you try to install the same Bosch VMS patch setup multiple times? A: Nothing happens. When running the setup for a second time, no patch files will be deployed. Q: What happens to the Bosch VMS patches if a patched system is upgraded? A: All patched DLLs and the patch entries in Programs and Features will be removed during the upgrade process. Example: if you upgrade a patched Bosch VMS system to Bosch VMS version 5.5.1, then you will get a clean Bosch VMS installation without patch DLLs and without Bosch VMS patch entries in Programs and Features. Q: What happens to the Bosch VMS patches if a patched system is downgraded? A: All patched DLLs and the patch entries in Programs and Features will be removed when uninstalling the Bosch VMS major version. Example: if you uninstall a patched Bosch VMS system, all Bosch VMS patches will automatically be uninstalled. If you install Bosch VMS version 5.0 on a previously uninstalled system, then you will get a clean Bosch VMS 5.0 installation without patch DLLs and without Bosch VMS patch entries in Programs and Features. Q: What happens to patches when running a repair installation of the currently installed Bosch VMS major version? A: All patches will be preserved when running a repair installation i.e. a repair installation does not roll back patches. Q: What is the expected downtime when applying a Bosch VMS patch? A: The patch process takes only a couple of minutes. The actual downtime for a Bosch VMS management server patch is only a couple of seconds longer than the time required for stopping/starting the Bosch VMS server service. Bosch Sicherheitssysteme GmbH Technical Service Note V1 DOC

24

25 Bosch Sicherheitssysteme GmbH Robert-Bosch-Ring Grasbrunn Germany Bosch Sicherheitssysteme GmbH, 2015