Introduction

These instructions cover any requirements or preparation required when upgrading from older to newer versions of ClearWay™. We strongly recommend that you check these instructions and review the relevant ClearWay™ Release Notes before starting any upgrade.

All upgrades should be performed by running the installer from the latest version and selecting the Upgrade option when prompted.

Contents

Upgrading to 4.12.4.1108 from 4.12.3.1105 (MongoDb V7.0)

Database Upgrade

This version has no new features and is intended only to upgrade the database version from V6.0 to V7.0.

Upgrading to 4.12.3.1105 from 4.12.2.1101 (MongoDb V6.0)

Database Upgrade

This version has no new features and is intended only to upgrade the database version from V5.0 to V6.0.

Upgrading to 4.12.2.1101 from 4.12.1.1099 (MongoDb V5.0)

Database Upgrade

This version has no new features and is intended only to upgrade the database version from V4.4 to V5.0.

Upgrading to 4.12.1.1099 (Mongo V4.4)

Prerequisites

This release includes version 4.4 of the MongoDb database server. This version requires the Visual Studio C++ 2019 x64 redistributable library. Technically this has been part of the Witness pre-requisites since the release of 4.11, however we recommend this is checked before installing Build 1099. Please see Software Prerequisites for more information.

.NET 8 Upgrade

This version is built on the latest Microsoft .NET technology stack. All necessary support files are shipped with the product so additional action is required, however be aware that .NET 8 is only supported on the following versions of Windows:

• Windows 10 Build 1607 and newer.

• Windows 11 Build 22000 and newer.

• Windows Server 2012 and newer.

Database Authentication

Database authentication is supported in this release. If you need to implement it then please refer to Database Authentication. All configuration associated with the database authentication is done after installation.

Log Rotate

This version now automatically installs a Windows Scheduler Task to rotate the MongoDb logs every 24 hours. It is strongly recommended that any existing logs associated with older methods of log rotation are deleted before the task first runs to avoid any potential conflicts and confusion.

Upgrading to 4.12.0.1073

Code Signing Certificate

Version 4.12.0.1073 and above use a new code signing certificate because the old one expired. If the target systems for these versions have an internet connection then everything will work as expected. However if the systems do not have a standard internet connection then the code signing check may fail because it won’t be able to verify the digital certificate embedded in the application files against the root certificate. To resolve this issue you need to install the root certificate on all systems running any part of the Witness software, excluding stand alone database servers. The process for installing the certificate is:

1. Copy this certificate onto the targets servers / PCs:
   
   
   
   

2. Once copied, right click on the file and select Install Certificate.

3. Select Local Machine for the store location and click Next:
   
   

   Open

   

4. Select the option Place all certificates in the following store and select Browse.
   
   

   Open

   

5. Select the Trusted Root Certificate Authorities and select OK:
   
   

6. Select Next and then Finish.

Upgrading to 4.12.0.x from 4.11.0.x

Pre-requisites

Version 4.12 is developed using the .NET 6 development stack which is now a mandatory pre-requisite for the entire software suite.

Traffic Analysis

Despite the new TA features, all existing behaviour should remain the same, however, we recommend checking the size measurement setting. This will remain as average for upgrades but will default to minimum for new installation.

False Alarm Filtering

Due to the changes in the FA filters for direction change and times we recommend that the FA models are re-created after upgrade. Be aware that the real time FA scores may give slightly different results based on the improved models.

Area Status

Following the change to honour the enabled state of areas used for queue and alarm suppression, all areas should be checked to ensure the Enabled setting matches the desired state.

Upgrading to 4.11.0.983

Auto Queue Settings

This version added validation to the settings for the Auto Queue feature. Prior to this fix all the default settings for the Auto Queue feature were 0 (zero) which are invalid. However, now this validation has been added, it will prevent the carriageway from being saved with older configurations. To work around this, these settings needs to be updated first. They should be set to these default settings even if you are not using Auto Queue:

• Auto Queue Detection Window: 3

• Auto Queue Section Count: 1

See to find where these settings are and what they do.

Upgrading from V4.8.0.x to 4.8.0.711

Carriageway Rules

This version fixes a bug where ClearWay™ rules created manually (i.e. not created as part of the Carriageway Wizard) could not be edited after creation. However the original rules that we were created in older versions must be deleted and recreated before you will be allowed to edit them.

VMS Integration Plugins

Due to improvements made in the camera mapping logic in the Milestone, Genetec and BVMS integration plugins, existing configurations will be automatically updated when upgrading to this version. However we recommend that these mappings are checked once the upgrade is complete.

Upgrading from V4.7.0.x to 4.8.0.x

User Interface Panel Layout

Due to the change to store the panel layout in each user’s settings any existing panel arrangements will be lost and will need to be recreated. If at any stage you need to reset the layout to ensure correct operation please use the Reset View option from the system menu.

Licencing

All V4.8 deployments will require a new licence when migrating from V4.7.

Upgrading from V4.6.0.x to 4.7.0.x

Open Street Map Tile Cache

With the introduction of live Google Maps tiles into the Helvellyn user interface, the folder structure associated with caching tiles on disk has changed. If Open Street Map was being used in an offline mode (i.e. no internet connectivity, cached tiles only), then the old tiles need to be moved to a new location. If the client has internet access then no action is required, although we would recommend the old tiles are deleted.

To move an existing Open Street Map (OSM) tile cache with no internet access:

1. Ensure the system has been fully upgraded including all client applications.

2. Move the map tiles from the existing folder to the new one. If the new folder does not exist you should create it:
   a. Old OSM Cache Folder - C:\ProgramData\Navtech\MapCache
   b. New OSM Cache Folder - C:\ProgramData\Navtech\MapCache\OpenStreeMap
   
   

    

3. All the old folders will be numbered as illustrated in the image. The Google and OpenStreetMap folders are part of the new structure.

4. Start the client application and ensure the cached tiles are loading as expected.

To re-create the Open Street Map (OSM) tile cache with temporary internet access:

1. Ensure the PC running the client has temporary internet access.

2. Start the client application and then pan and zoom as required across the site to ensure the relevant tiles are saves to the correct cache location.

3. Delete the old folders inside MapCache, be careful to leave the new OpenStreetMap folder.

Upgrading to V4.3.0.530

Although this is a significant upgrade there are no major considerations other than ensuring that you have reset the views for both non-configuration and the new configuration modes.

Reset Views

From V4.3.0.530 onwards, the configuration tab has been replaced with a configuration button. This button shows the appropriate panels for making changes and also enables the edit control buttons. The user interface has a normal view and edit view for the Live tab and these need to be reset after the upgrade.

To reset the views:

1. Ensure you are on the Live tab and not in configuration mode.

2. Select Reset View from the system menu.

3. Remain on the Live tab and enable configuration mode by selecting the configuration button.

4. Select Reset View from the system menu again.

5. Once this process is complete you can adjust these views to suit your needs.

Upgrading from V4.0.x to V4.1.0.366

Although this is a significant upgrade there are no major considerations other than ensuring that you have the correct NTP option set. V4.1 introduced the option to ignore the NTP time on the radar in case it was not configured correctly. This is the recommended default until you are confident that the radars have been configured correctly with a proper NTP server. Please refer to System Settings for more information.

Points of Interest (POI)

From V4.1.0.366 onwards, it is now possible to set the colour of the text on a POI. Because this option did not exist before, the labels may "disappear" after the upgrade. In fact they have not disappeared, they are simply a transparent colour. To resolve this:

1. Open a POI group's settings.

2. Select all the POIs and using the multi-edit feature edit the colour for all the items. Ensure you set a sensible opacity level ("A" on the colour picker).

3. Repeat this for all POI groups.

Upgrading from V4.1.0.366

Upgrading

Due to a change in the installer it is essential to run a Repair after upgrading from V4.1.0.366. The procedure for this upgrade is:

1. Run the new installer and upgrade all installations on all servers as normal.

2. Repeat step 1, but this time select Repair. You will notice that the upgrade option is no longer available.

Licencing

This version fixed a bug in the licensing system and therefore requires a new licence file. Only Navtech can create a licence so you should request a new file through Customer Support.

Distance Travelled

Due to the improvement of the distance travelled settings in the rules, the travelled distance setting is now always positive. Prior to this update the distance was negative (-ve) to indicate a reverse distance and positive (+ve) for a forward direction. With the improvement, the value will now always be positive (+ve). So if you previously had a negative value this must be updated to the positive equivalent.

Upgrading from  V4.1.0.371 

Configuration

Due to changes in the way in which the Situational Awareness (SA) clutter map is generated it is necessary to update the Clutter Map Time Constant in the SA settings. This should be set to 100%.

Upgrading from  V4.1.0.372

Configuration

Due to changes in the default parameters on the debris channel we recommend you update older installations with the following settings:

1. Threshold Window Size: 25m

2. Coast Extended Time:10s

3. Coast Age Min: 6

4. Coast Scans: 6

Improvements in the alarm description tags has meant the meaning of the lane tag has changed. In order to maintain the same syntax for sections and carriageways, the following changes were made:

• {LANE} - used to insert the Lane Id - now inserts the Lane Name.

• {LANEID} - new tag - this will insert the Lane Id.

So if you have used {LANE} in any alarm description and you wish to continue using the Lane Id then change all these tags to {LANEID}.

Related Information