How can we help?

Update vSEC:CMS Components

Anthony - Versasec Support
Anthony - Versasec Support
  • Updated

Introduction

This article will describe the procedure to update the vSEC:CMS components from earlier versions.

When you download the latest version of vSEC:CMS you will find the different installation packages that make up the vSEC:CMS. It may be that all of the installation packages are not required for your specific setup, therefore only deploy the updated installation packages required for your specific environment. From version 6.0 the different installation packages are:

  • vSECCMS_Setup_X.X.X.exe
  • vSECCMS_Client64bit_MSI_X.X.X.msi

Where X.X.X is the specific product version number.

Important
Any client-side component that is updated should be at least the same version of the server. If you install client components that are versions ahead of the server then you may face issues when using the client.
Important
From version 6.0 and above Microsoft .NET Framework 4.8 should be installed. If you are on a server that does not have internet access then download .NET and update on the server before attempting to update vSEC:CMS.
Tip
You can validate what version of Microsoft .NET Framework is installed on your host by running the Powershell command to see the Full version information:
Command
Get-ChildItem 'HKLM:\SOFTWARE\Microsoft\NET Framework Setup\NDP' -Recurse | Get-ItemProperty -Name version -EA 0 | Where { $_.PSChildName -Match '^(?!S)\p{L}'} | Select PSChildName, version

Updating on Server Side

Important
On the server, it is recommended to make a backup copy of the current installed version of the vSEC:CMS before performing the update. Copy the folder that the current version is installed in. For example, if the current version is installed in C:\Program Files (x86)\Versasec\vSEC_CMS S-Series (for 32-bit version) OR C:\Program Files\Versasec\vSEC_CMS S-Series (for 64-bit version) stop the vSEC:CMS Windows service (named vSEC:CMS Service) and make a backup copy of this folder on your system. It may be necessary to change the permissions on the dat folder, which is located in the root of the currently installed version, to allow the currently logged on Windows user access to this folder.
Important
If the vSEC:CMS is configured to use MS-SQL it is important to make a backup of the current SQL table on your SQL server before performing any updates.

1. Download the latest installer from here.

Important
Only persons with valid Support and Maintenance contracts will be able to access the download site. You will need to log in with your Support and Maintenance account.

Additionally you will need to generate a Maintenance Code (MC). In order to generate this MC you need to enter the license ID for your system. You can get this from the Home page of the vSEC:CMS console as in example below. Click the license name and ID link to open a detailed license information dialog.

Important
You will need to generate a new MC every time you update a major version. A major version will be Y, where release number is X.Y.Z, for example, if you are updating from 5.8.1 to 5.9.0 this is considered a major version update and will require a new MC. The MC will be valid for any point release within a major release, so an MC generated for 5.8.1, for example, will remain valid for all point releases within 5.8.Z.

Important
If the generation of the MC fails please open a support ticket here. This will need to be resolved before you can continue with the update.

Go to the downloads page (you need to be logged into the support portal here) and copy the License Id value into the field provided and click REQUEST MAINTENANCE CODE button. Make a copy of the MC as you will need this later when performing the actual update on the server.

2. Start the installer on the server where the current version resides;

Important
The vSEC:CMS Service needs to be running in order to perform an update.

3. Depending on the version that you are updating to different flows will be available.

Important
If you are updating to a version 6.X or later from a version prior to 6.X then jump to the section below Migrate Database and follow the instructions in that section to perform server-side update.

Click I Agree to proceed;

4. The installer will determine that a version currently resides on the server and will prompt you to perform an update. Click the Update button to perform the upgrade;

You will be prompted to enter the MC generated in step 2 above. You will need to enter this to continue with the upgrade.

5. On completion of the upgrade click Close. You can now use the updated vSEC:CMS to perform operations as necessary.

Migrate Database

From version 6.X the internal proprietary database should be migrated to use SQLite. This will need to be done if you are updating your vSEC:CMS from a version prior to 6.X. For example, if you are updating from 5.8 to 6.X then you need to perform this migration.

Important
This step should be performed regardless of whether you are currently using MS SQL as your database.

1. When starting the installer it will detect that your system needs to be migrated. A dialog like below will appear.

Click Yes to proceed.

Important
Please be aware that depending on the size of your current database the migration process may take several minutes to hours so important to schedule enough time when planning this update.

2. The installer will determine that a version currently resides on the server and will prompt you to perform an update. Click the Update button to perform the upgrade;

You will be prompted to enter the MC code. You will need to enter this to continue with the upgrade.

3. On completion of the upgrade click Close. You will be prompted to log onto the console at this time. On logging on the database migration will start. A dialog similar to below will appear.

Click Start to begin the migration process. Depending on the size of your database it may take some time to complete this process. A summary dialog will appear similar to below once the migration is complete.

Your system will now be updated and fully migrated to SQLite.

If during this migration you get an error similar to below informing you that the migration failed then follow these instructions below. Migration errors usually occur because the data in the old database schema is not used and/or required in the new database schema and therefore these can be ignored.

Untitled.png

  • Close the vSEC:CMS console;
  • Restart the vSEC:CMS service;
  • Log onto the vSEC:CMS console;
  • After logon you will be prompted with a dialog similar to below:

Untitled.png

  • When you see the dialog above hold down the Ctrl + Shift key and click Ok button at the same time. You will now see a checkbox Ignore migration errors. You should enable this checkbox and click Start.

Untitled.png

  • Once the migration finishes you will see a similar dialog to below. Important to click on the blue link For detailed information about this issue click here and save the details and open a support case with us here. Click Ok to close.

Untitled.png

Updating on Client Side

If performing an update on this component, it is necessary to perform the update on any client where the vSEC:CMS Operator Console (OC) application is installed.

1. Download the latest installer as provided from your vendor;

2. Start the installer on the client where the current version resides;

3. Click I Agree to proceed;

4. The installer will determine that a version currently resides on the client and will prompt you to perform an update. Click the Update button to perform the upgrade;

5. On completion of the upgrade click Close. You can now use the updated OC to perform operations as necessary.

Updating vSEC:CMS Client

From version 5.7 the vSEC:CMS Client components, vSEC:CMS USS, vSEC:CMS RSDM and vSEC:CMS VSC, are packaged as an MSI installer. Please refer to the article Installing the vSEC:CMS MSI Client for instructions on updating the client components.

Important
If you are updating to 6.0 or later from a version prior to 6.0 then in this case the client components will all be updated to 64-bit versions automatically.