Velocity Unattended Installation_v3.8.5

Owned by Anand Rajaraman
Last updated: Jun 20, 2024
5 min read

This section describes the general procedure that has to be followed for setting up an unattended Velocity Server/Client/Workstation installation.

Note: Before setting up an unattended installation make sure you configure firewall rules through your deployment tools.

The unattended Velocity installation and update for server/client/workstation are available from the Identiv Website. To set up an unattended installation, the user must complete these tasks:

  1. Download the “UnattendedInstall(build-3.8.5.694).zip”. 

  2. Extract the .zip file.

  3. Locate the "unattededInstall.xml" file from the extracted zip file.
    This UnattendedInstall(build-3.8.5.694).zip contains a configuration file named UnattendedInstall.xml that allows the user to define the options needed to be auto-selected during the installation without user intervention. The unattended installation is compatible with any deployment software.

    Each section in the UnattendedInstall XML configuration file mentioned below has three parts:

    • Description:  A message box that the user would see, or otherwise a description of the item being silenced. For example, the <Description> tag contains setting definitions and values for the type of installation (Server/Client/Workstation).

    • PossibleValues: A name/value pair of possible choices for the current item. For example, <PossibleValues> tag values are by default set to 0. To modify the answers, simply change the number between the <Value> tag.

    • Value: The chosen value that is either 0 or 1 that the Update will use if required by the update logic flow. The value is set to 0 for No and 1 for Yes.

    After making the necessary changes in the respective XML configuration files for unattended server, unattended client, and unattended workstation installations, the extracted folder is zipped.

  4. Compress the .zip file back to “UnattendedInstall(build-3.8.5.694).zip”.

To deploy the Velocity update using the deployment tool:

  1. Upload the “UnattendedInstall(build-3.8.5.694).zip” file as a package/application in the deployment tool. 
    Note: Make configurations to select the list of all client machines where an update needs to be applied.

  2. Configure such that the deployment application runs the Setup.exe file (this exe file will read all the configurations/options from the XML file and will install accordingly).

  3. Make configuration to run the Setup.exe as a (domain) Admin user.

When the deployment process starts, the deployment tool will automatically download the zip file to the server, extract the zip, and will run Setup.exe as Admin and the update will continue according to the options configured in the UnattendedInstall.xml file.

Note: For any information about errors that may occur during the unattended installation operation, refer to the Velocity_Install.txt log file in the “C:\Windows\Temp\Velocity.Installer” folder location.

Unattended Installation XML Configuration File

Unattended Server Installation - Existing SQL instance

Unattended Server Installation - new SQL instance

Unattended Client Installation

Unattended Workstation Installation

Unattended Workstation Installation - existing SQL instance

Unattended Installation XML Configuration File

Below is a sample of the UnattendedInstall.xml file that is contained within the “UnattendedInstall(build-3.8.5.694).zip” mentioned above.

<Configuration> <UnattendedMode> <Description>Specify one of the following: Normal=Unattended mode disabled, Wizard runs normally without these settings; Simple=Unattended mode enabled, the UI is Visible; Quiet=Unattended mode enabled, the UI is hidden completely </Description> <PossibleValues>Normal=0; Simple=1; Quiet=2</PossibleValues> <Value>0</Value> </UnattendedMode> <AppInstructions> If you plan to add an option to execute an application (IE Web Console) you need to add it to the file in a specific way. The XML node needs to match the title in the updatemanifest.ini file instruction. See                 The VelocityWebServicesClient as and an example of this. </AppInstructions> <InstallArchitecture> <Description>Type of install this is going to be. Maps to the Options for the Install Type screen.        </Description> <PossibleValues>Client=1; Server=2; Workstation=3</PossibleValues> <Value>3</Value> </InstallArchitecture>   <SQLServerLocation> <Description>Location of the SQL Server machine; or "Install SQL 2019 Express"</Description> <Value>Install SQL 2019 Express</Value> </SQLServerLocation> <VelocityServerLocation> <Description>Machine name where the Velocity server is located. If new install and local, put "Local Machine" without quotes </Description> <Value>Local Machine</Value> </VelocityServerLocation> <CustomGroupNames> <Description>Use custom group names</Description> <PossibleValues>No=0; Yes=1</PossibleValues> <Value>0</Value> </CustomGroupNames> <VelocityServicesAccount> <Description>The VelocityServices name. Append Domain in the format Domain\VelocityServices or local as VelocityServices</Description> <Value>VelocityServices</Value> </VelocityServicesAccount> <VelocityServicesGroup> <Description>The Velocity Services Group name</Description> <Value>Velocity Services</Value> </VelocityServicesGroup> <VelocityUsersGroup> <Description>The Velocity Users Group name</Description> <Value>Velocity Users</Value> </VelocityUsersGroup> <ServiceAccountPassword> <Description>The password to use for the service account</Description> <Value>12345</Value> </ServiceAccountPassword> <AppRolePassword> <Description>The App Role password to use</Description> <Value>12345</Value> </AppRolePassword> <SQLInstallPath> <Description>The path to install SQL to; Can also put "UseDefault" to put it where Windows would default </Description> <Value>UseDefault</Value> </SQLInstallPath> <InstallationDefaultPath> <Description>The path to install Velocity to; or "UseDefault"</Description> <Value>UseDefault</Value> </InstallationDefaultPath> <InstallSSMS> <Description>Install the SQL Server Management Studio software</Description> <PossibleValues>No=0; Yes=1</PossibleValues> <Value>0</Value> </InstallSSMS> <SQLInstanceName> <Description>The instance name of the SQL Server to use</Description> <Value>IDENTIV</Value> </SQLInstanceName> <SQLMDFPath> <Description>The path for the SQL Data (MDF) file location; or UseDefault</Description> <Value>UseDefault</Value> </SQLMDFPath> <SQLLDFPath> <Description>The path for the SQL Log (LDF) file location; or UseDefault</Description> <Value>UseDefault</Value> </SQLLDFPath> <SQLBackupPath> <Description>The path for the SQL Backup file location; or UseDefault</Description> <Value>UseDefault</Value> </SQLBackupPath> <Complete_AutoStartVelocity> <Description>Auto Start Velocity each time a user logs on to Windows</Description> <PossibleValues>Unchecked=0; Checked=1</PossibleValues> <Value>0</Value> </Complete_AutoStartVelocity> <Complete_VelocityIconOnDeskTop> <Description>Place an icon on the desktop for Velocity</Description> <PossibleValues>Unchecked=0; Checked=1</PossibleValues> <Value>1</Value> </Complete_VelocityIconOnDeskTop> <Complete_StartServices> <Description>Automatically start services when install is complete</Description> <PossibleValues>Unchecked=0; Checked=1</PossibleValues> <Value>1</Value> </Complete_StartServices> <Complete_NeverReUsePINCodes> <Description>Never re-use PIN codes</Description> <PossibleValues>Unchecked=0; Checked=1</PossibleValues> <Value>0</Value> </Complete_NeverReUsePINCodes> <Complete_ReUsePINOverride> <Description>Re-use PINs with operator override only</Description> <PossibleValues>Unchecked=0; Checked=1</PossibleValues> <Value>0</Value> </Complete_ReUsePINOverride> <Complete_NeverReUseMATCHCodes> <Description>Never re-use MATCH card codes</Description> <PossibleValues>Unchecked=0; Checked=1</PossibleValues> <Value>0</Value> </Complete_NeverReUseMATCHCodes> <Complete_ReUseMATCHOverride> <Description>Re-use MATCH with operator override only</Description> <PossibleValues>Unchecked=0; Checked=1</PossibleValues> <Value>0</Value> </Complete_ReUseMATCHOverride> </Configuration>

The next sections describe some common Velocity Server/Client/Workstation Installation use case scenarios and showcases the use of specific tags. Note that the entire XML file is required for installation.

Unattended Server Installation - Existing SQL instance

In the use case example below, the user indicates the SQL server machine name during the unattended installation.

Tag Names

Tag Value

Tag Description

<InstallArchitecture>

 

Server=2; 

Type of install this is going to be. Maps to the Options for the Install Type screen.

Note: If <Value> tag indicates  “2”, the silent installation type is Server.

<SQLServerLocation>

 

SERVER193831\IDENTIV

Location of the SQL Server machine; or "Install SQL 2019 Express"

Unattended Server Installation - new SQL instance

In this use case example below, the user indicates a new SQL instance

Tag Names

Tag Value

Tag Description

<InstallArchitecture>

 

Server=2; 



Type of install this is going to be. Maps to the Options for the Install Type screen.

Note: If <Value> tag indicates  “2”, the silent installation type is Server.

<SQLServerLocation>

Install SQL 2019 Express

Location of the SQL Server machine; or "Install SQL 2019 Express"

Unattended Client Installation

Note: Before the unattended client installation, the Velocity server should be installed.

In this use case example below, the user indicates the type of installation and Velocity service account information during the Client installation.

Tag Names

Tag Value

Tag Description

<InstallArchitecture>

 

Client=1; 



Type of install this is going to be. Maps to the Options for the Install Type screen.

Note: If tag Value indicates  “1”, this is considered to be a silent client installation

<VelocityServicesAccount>

newdomain\Velocityservices

The VelocityServices name. Append Domain in the format Domain\VelocityServices or local as VelocityServices

<VelocityServerLocation>

SERVER193831\IDENTIV

Machine name where the Velocity server is located. If new install and local, put "Local Machine" without quotes

<VelocityServicesGroup>

Velocity Services

The Velocity Services Group name

<VelocityUsersGroup>

Velocity Users

The Velocity Users Group name

<ServiceAccountPassword>

12345

The password to use for the service account

<AppRolePassword>

12345

The App Role password to use

Unattended Workstation Installation

In this use case example, the user indicates the type of installation for Workstation using the default installation paths for SQL and Velocity services, specify an SQL instance name and installs MS SQL Server Management Studio.

Tag Names

Tag Value

Tag Description

<InstallArchitecture>

 

Workstation=3; 



Type of install this is going to be. Maps to the Options for the Install Type screen.

Note: If tag  Value indicates  “3”, this is considered to be a silent workstation installation

<SQLInstallPath>

UseDefault

The path to install SQL to; Can also put "UseDefault" to put it where SQL would default to

<InstallationDefaultPath>

UseDefault

The path to install Velocity to; or "UseDefault"

<InstallSSMS>

 

No=0;

Install the SQL Server Management Studio software

Note: The value is set to 0 for “No” and 1 for “Yes”

<SQLInstanceName>

IDENTIV

The instance name of the SQL Server to use

<SQLMDFPath>

UseDefault

The path for the SQL Data (MDF) file location; or UseDefault

<SQLLDFPath>

Usedefault

The path for the SQL Log (LDF) file location; or UseDefault

<SQLBackupPath>

Usedefault

The path for the SQL Backup file location; or UseDefault


Unattended Workstation Installation - existing SQL instance

In this use case example, the user indicates the type of installation, installation path, and SQL instance name.

In this use case example, the user indicates the type of installation,  an existing XML SQL instance 

Tag Names

Tag Value

Tag Description

<InstallArchitecture>

 

Workstation=3; 



Type of install this is going to be. Maps to the Options for the Install Type screen.

Note: If <Value> tag indicates  “3”, the silent installation type is Workstation.

<SQLServerLocation>

TESTSERVER\MSSQL

Location of the SQL Server machine; or "Install SQL 2019 Express"

<VelocityServerLocation>

TESTSERVER\MSSQL



.

Machine name where the Velocity server is located. If new install and local, put "Local Machine" without quotes

Note: The TESTSERVER is the workstation name and MSSQL is the SQL instance name