How can we help?

Installing the vSEC:CMS User Application

Ellen Thoren - Versasec
Ellen Thoren - Versasec
  • Updated

Introduction

The vSEC:CMS Client MSI installs the vSEC:CMS Client Components of your choice.
The vSEC:CMS Client Components consist of:

  • vSEC:CMS User Application (USS)
  • vSEC:CMS Credential Provider (CP)
  • vSEC:CMS Remote Service Device Management (RSDM)
  • vSEC:CMS Virtual Smart Card (VSC)

Follow the instructions to install the vSEC:CMS Client MSI to suit your needs.

Important
Since version 5.6 the installers for the USS, CP and RSDM components have all been merged into a singular MSI installer. Before version 5.6 these components were installed using individual Nullsoft installers however these components are no longer supported in this format.
Important
Since version 5.7 the installer for VSC has also been merged into the singular MSI installer. It is no longer supported to install the VSC component via Nullsoft installer.
Important
Important: From version 6.0 the client components USS and RSDM will be 64-bit applications. That means these components will not be installed in the (typical) C:\Program Files (x86)\Versasec location. The components will instead be moved to C:\Program Files\Versasec. If you have any scripts or monitoring of these locations it is important to be aware of this change in location.

MSI Installation of the vSEC:CMS Client

Important
Important: You must choose to install the MSI which is relevant to your Operating System architecture. For example if you are using a 64bit Operating System, choose the 64bit MSI.
Important
It is required to run the vSEC:CMS Client MSI as an Administrator.
Important
It is important to have .NET 4.8 framework installed on the machine where you are installing the vSEC:CMS Client MSI.
Important
If you have Nullsoft installed Client components you can install the vSEC:CMS Client MSI and it will take care of all old Nullsoft files whilst retaining your important settings such as URL’s and card access settings. It is highly recommended to at least install all of the components that you had before.

MSI Graphical User Interface Installation Workflow

1. Start the MSI installer and click Next.

2. Click the I accept the terms in the Licence Agreement checkbox and then click Next.

3. Click the Components you want to install using the Icons from the file tree and then click Next.

4. Click Next, the installer will then install your chosen components.

5. When the installation is complete click Finish.

Important
After you have clicked Finish you will be prompted to reboot your client. It is recommended to do so.

MSI Silent Installation Workflow

If it is required to install the vSEC:CMS Client MSI silently, for example, if the client components are being pushed out centrally, then follow the instructions to perform such installations.

Important
The client machine will be automatically rebooted after running the vSEC:CMS Client MSI in silent mode.

Component Choice Parameter

You can configure which components you wish to install using the ADDLOCAL parameter.

  • The ADDLOCAL value for vSEC:CMS User Self-Service is USS
  • The ADDLOCAL value for vSEC:CMS Credential Provider is CP
  • The ADDLOCAL value for vSEC:CMS Remote Service Device Management is RSDM
  • The ADDLOCAL value for vSEC:CMS Virtual Smart Card is VSC

You can combine ADDLOCAL values with a comma , in many ways for example: ADDLOCAL=USS,CP,RSDM,VSC or ADDLOCAL=USS,RSDM etc.

Important
If you do not use the ADDLOCAL parameter then all components will be installed by default.

URL Configuration Parameters

Both the USS and RSDM components should be configured to connect to your vSEC:CMS Server. Follow the instructions below to do so.

You should first specify whether you are using a SOAP or GRPC connection as configured in your vSEC:CMS Server. This is done using the USSPCL and RSDMPCL parameters.

  • The USSPCL and RSDMPCL values for a Prefer SOAP connection is 1
  • The USSPCL and RSDMPCL values for a Prefer gRPC connection is 2
  • The USSPCL and RSDMPCL values for a Force SOAP connection is 3
  • The USSPCL and RSDMPCL values for a Force gRPC connection is 4

Once you have specified the parameter and value for your connection, you should then specify the URL for your vSEC:CMS Server. Follow the instructions below to do so.

  • If you want to connect your USS to the vSEC:CMS Server by SOAP use USSSOAP=”http://DemoURL:DemoPort/uss”
  • If you want to connect your USS to the vSEC:CMS Server by GRPC use USSGRPC=”http://DemoURL:DemoPort”
  • If you want to connect your RSDM to the vSEC:CMS Server by SOAP use RSDMSOAP=”http://DemoURL:DemoPort/rsdm”
  • If you want to connect your RSDM to the vSEC:CMS Server by GRPC use RSDMGRPC=”http://DemoURL:DemoPort”

Example Command Line

Basic Full Installation:

Command
> msiexec.exe /i "vSECCMS_Client64bit_MSI_5.8.0.msi" /q

/i is used for install.
/q is used to make the install silent.

Install just USS, CP and RSDM Components:

Command
> msiexec.exe /i "vSECCMS_Client64bit_MSI_5.8.0.msi" /q ADDLOCAL=USS,CP,RSDM

ADDLOCAL=USS,CP,RSDM is used to just install the USS, CP and RSDM components, the VSC component is not installed.
This command line is useful if you want to use USS and CP but do not want to use Versasec VSC.

Full Installation with passed in gRPC Connection:

Command
> msiexec.exe /i "vSECCMS_Client64bit_MSI_5.8.0.msi" /q ADDLOCAL=USS,CP,RSDM,VSC USSPCL=4 RSDMPCL=4 USSGRPC="http://DemoURL:DemoPort" RSDMGRPC="http://DemoURL:DemoPort" 

ADDLOCAL=USS,CP,RSDM,VSC is used to install all of the components
USSPCL=4 and RSDMPCL=4 specify that we are using a Force GRPC connection.
USSGRPC and RSDMGRPC specify the vSEC:CMS Server URL they are trying to connect to.
This command line is useful if you want to install all of the components silently and connect to the backend of the vSEC:CMS Server using a Force GRPC connection.

Full Installation with passed in SOAP Connection:

Command
> msiexec.exe /i "vSECCMS_Client64bit_MSI_5.8.0.msi" /q ADDLOCAL=USS,CP,RSDM,VSC USSPCL=3 RSDMPCL=3 USSSOAP="http://DemoURL:DemoPort/uss" RSDMSOAP="http://DemoURL:DemoPort/rsdm"

ADDLOCAL=USS,CP,RSDM,VSC is used to install all of the components
USSPCL=3 and RSDMPCL=3 specify that we are using a Force Soap connection.
USSSOAP and RSDMSOAP specify the vSEC:CMS Server URL they are trying to connect to.
This command line is useful if you want to install all of the components silently and connect to the backend of the vSEC:CMS Server using a Force Soap connection.

Note
It is important to append /uss and /rsdm when configuring SOAP URLs as in example above.