The vSEC:CMS uses its own internal database which stores information about smart cards registered and managed by the vSEC:CMS along with configuration settings. This is a proprietary database.
However, if it is required to use a third-party database, it is possible to configure the vSEC:CMS to connect to an MS SQL database which can be used to store data for the application.
Note: Currently the vSEC:CMS will only support the MS SQL database. If it is required to support other SQL database vendors please contact Versasec.
Note: It is required to have the MS SQL native client version provider installed on the host on which the vSEC:CMS is installed. Version information is provided below.
SQL Native Client Version: 11.0 (SQLNCLI11).
MS SQL Server Version: 2012, 2014, 2016, 2017, 2019, Azure SQL.
It is possible to check what SQL native client (if any) is installed on your server. Open the ODBC Data Source Administrator console and from the Drivers tab you can see the available native clients installed.
A fully functional MS SQL server with a database needs to be available to the vSEC:CMS. The vSEC:CMS will not create the database.
Note: As recommended by MS, the MS SQL database should be encrypted. Please consult your MS SQL database documentation for further information on this.
Setup and Migration
From Options - Connections click the Add button and select SQL Database.
Enter a template name and from the drop-down list select vSEC:CMS SQL Database (SQL-DB).
Select the provider from the Database provider drop-down list and manually enter the database name or click Browse if it is possible to browse and find the database from your environment.
It is recommended to use a dedicated SQL user for the connection credential. In that case enable Use SQL server authentication mode checkbox. Enter the name and password into the available fields.
Note: If a dedicated Windows account is to be used for the connection credential then it will be required to follow the instructions as described in the article Configure Dedicated Windows Service Account.
Manually enter the database name in the Name field or click the Get Databases button if it is possible to find the database in your environment.
Uncheck Use read only access for report queries checkbox as this is not required here.
If all settings are configured correctly then click the Test button to test the connection end-to-end. You should see a success dialog as below if the connection is successful.
Click the Save button which will trigger the migration flow to MS SQL. You will see a dialog with a summary of what will be migrated and an estimate of the time it will take to migrate in full. Click Start to begin the migration.
Note: vSEC:CMS needs to have read/write permissions on the MS SQL database. Below is an example of what permissions the SQL user would need.
The current implementation of the MS SQL database support has some limitations which are important to note. These are:
- If, on startup of the vSEC:CMS, the MS SQL database is unreachable the application will not start;
- It will only be possible to add one SQL connection of this type on any one installation of the vSEC:CMS;
- Once the MS SQL connection is setup and in use it will not be possible to roll-back to the internal database.