Perform a Silent Installation

This topic applies only to VoiceConsole On Prem deployment customers.

Prepare for a Silent Installation

To avoid any potential issues, Honeywell highly recommends against installing a VoiceConsole On Prem deployment from a shared network drive. The software distribution must be copied to local drive or portable media such as a USB drive prior to install.

  • Close all other applications before installing.
  • When you install this version of VoiceConsole On Prem deployment for the first time, the following two users are installed with the application with default passwords:
    UserDefault Password
    admin admin
    vocollectvoiceworks

A silent installation or upgrade is available by providing an .xml file with the information that would be provided during a user interface installation. The .xml file is provided as a command line argument to the installer executable, batch, or script file to perform the installation.

Notes on install file formatting

  • Line endings must match the requirements of the server operating system in use.
  • Property names are case sensitive.
  • Property values must not end in whitespace.
  • For VoiceConsole 6.2 and later, the License Server Configuration entries must be included in the xml file.

Generate an Install File

You have two options for generating an .xml file for a silent installation:

  1. Run the installer; choose all the options that you need, and then on the Installation Finished window (last window), click Generate script to generate the .xml file with your installation choices. See Install VoiceConsole On Prem Deployment for the First Time or Prepare to Upgrade VoiceConsole On Prem Deployment for instructions for installing or upgrading and generating the script.
  2. Manually create the .xml file. Below are some examples of .xml files.

    Standard Installation

    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <AutomatedInstallation langpack="eng">
    <ImagePanel id="UNKNOWN (ImagePanel)"/>
    <com.izforge.izpack.panels.HTMLLicencePanel id="licencepanel"/>
    <com.izforge.izpack.panels.UpgradePanel id="upgradepanel"/>
    <com.izforge.izpack.panels.TargetPanel id="targetpanel">
    <!-- This is the suggested installation path for Windows. -->
    <!-- <installpath>C:\Program Files (x86)\Vocollect\VoiceConsole</installpath> -->
    <!-- This is the suggested installation path for Unix-based operating systems. If using Linux, remove the Windows installation path above and uncomment this path. -->
    <!-- <installpath>/opt/Vocollect/VoiceConsole</installpath> -->
    <installpath>C:\Temp\6.2.1</installpath>
    </com.izforge.izpack.panels.TargetPanel>
    <com.izforge.izpack.panels.PacksPanel id="packspanel">
    <pack index="0" name="application" selected="true"/>
    <!-- This is the Windows Java Runtime Environment. -->
    <pack index="1" name="jreWindowsx86" selected="true"/>
    <!-- These are the other available Java Runtime Environment. If using Linux, remove the Windows Java Runtime Environment above and uncomment the appropriate pack below. -->
    <!-- <pack index="1" name="jreLinux86x" selected="true"/> -->
    </com.izforge.izpack.panels.PacksPanel>
    <com.izforge.izpack.panels.InstallPanel id="installpanel"/>
    <com.izforge.izpack.panels.LegacyUpgradePanel id="legacyupgradepanel"/>
    <com.izforge.izpack.panels.RemoteUpgradePanel id="remoteupgradepanel">
    <remoteUpgrade>false</remoteUpgrade>
    </com.izforge.izpack.panels.RemoteUpgradePanel>
    <com.izforge.izpack.panels.ClusterPanel id="clusterpanel">
    <clusteredInstall>false</clusteredInstall>
    <clusterSharePath/>
    </com.izforge.izpack.panels.ClusterPanel>
    <com.izforge.izpack.panels.configurator.ConfiguratorPanel id="configuratorPanel">
    <configuratorData>
    <!-- Configuration fields that need user specified values. -->
    <!-- ###EDIT THE CONFIGURATION FIELDS. SEE CHART FOR ALL POSSIBLE FIELDS.### -->
    <configuratorProperty configItemNameToModify="07sqlDatabaseSchema">dbo</configuratorProperty>
    <configuratorProperty configItemNameToModify="01voiceConsoleHostname">HOSTNAME</configuratorProperty>
    <configuratorProperty configItemNameToModify="01databaseServer">SQL Server</configuratorProperty>
    <configuratorProperty configItemNameToModify="05sqlDatabaseUsername">USERNAME</configuratorProperty>
    <configuratorProperty configItemNameToModify="01tomcatLogDirectory">C:\Temp\6.2.1\logs</configuratorProperty>
    <configuratorProperty configItemNameToModify="#date">Apr 8, 202510:11:42 AM</configuratorProperty>
    <configuratorProperty configItemNameToModify="testConnection">true</configuratorProperty>
    <configuratorProperty configItemNameToModify="06sqlDatabasePassword">PASSWORD</configuratorProperty>
    <configuratorProperty configItemNameToModify="04voiceConsoleStorageDirectory">C:\Temp\6.2.1</configuratorProperty>
    <configuratorProperty configItemNameToModify="03sqlDatabaseName">DATABASENAME</configuratorProperty>
    <configuratorProperty configItemNameToModify="01sqlDatabaseHostname">HOSTNAME</configuratorProperty>
    <configuratorProperty configItemNameToModify="06voiceConsoleSamlSSO">false</configuratorProperty>
    <configuratorProperty configItemNameToModify="04flexeraPassword">PASSWORD</configuratorProperty>
    <configuratorProperty configItemNameToModify="04oraDatabaseUsername">USERNAME</configuratorProperty>
    </configuratorData>
    </com.izforge.izpack.panels.configurator.ConfiguratorPanel>
    <com.izforge.izpack.panels.ShortcutPanel id="shortcutpanel">
    <!-- ###EDIT SHORTCUT SETTINGS.### -->
    <programGroup name="Vocollect\VoiceConsole"/>
    <shortcut KdeSubstUID="false" categories="" commandLine="start" createForAll="false" description="Go to VoiceConsole web application" encoding="" group="true" icon="C:\Temp\6.2.1\tools\vocollect_icon.ico" iconIndex="0" initialState="1" mimetype="" name="VoiceConsole" target="C:\Temp\6.2.1\bin\WebApplication.url" terminal="" terminalOptions="" tryexec="" type="1" url="" usertype="0" workingDirectory="C:\Temp\6.2.1\bin"/>
    </com.izforge.izpack.panels.ShortcutPanel>
    <com.izforge.izpack.panels.VocollectFinishPanel id="finishpanel"/>
    </AutomatedInstallation>

    Clustered Installation

    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <AutomatedInstallation langpack="eng">
    <ImagePanel id="UNKNOWN (ImagePanel)"/>
    <com.izforge.izpack.panels.HTMLLicencePanel id="licencepanel"/>
    <com.izforge.izpack.panels.UpgradePanel id="upgradepanel"/>
    <com.izforge.izpack.panels.TargetPanel id="targetpanel">
    <!-- Installation Directory -->
    <!-- ###EDIT THE INSTALLATION DIRECTORY PATH.### -->
    <installpath>C:\Temp\6.2.1</installpath>
    </com.izforge.izpack.panels.TargetPanel>
    <com.izforge.izpack.panels.PacksPanel id="packspanel">
    <pack index="0" name="application" selected="true"/>
    <pack index="1" name="jreWindowsx86" selected="true"/>
    </com.izforge.izpack.panels.PacksPanel>
    <com.izforge.izpack.panels.InstallPanel id="installpanel"/>
    <com.izforge.izpack.panels.LegacyUpgradePanel id="legacyupgradepanel"/>
    <com.izforge.izpack.panels.RemoteUpgradePanel id="remoteupgradepanel">
    <remoteUpgrade>false</remoteUpgrade>
    </com.izforge.izpack.panels.RemoteUpgradePanel>
    <com.izforge.izpack.panels.ClusterPanel id="clusterpanel">
    <clusteredInstall>true</clusteredInstall>
    <!-- Cluster settings -->
    <!-- ###EDIT CLUSTER SETTINGS.### -->
    <clusterSharePath>C:\Shared\Vocollect</clusterSharePath>
    </com.izforge.izpack.panels.ClusterPanel>
    <com.izforge.izpack.panels.configurator.ConfiguratorPanel id="configuratorPanel">
    <configuratorData>
    <!-- Configuration fields that need user specified values. -->
    <!-- ###EDIT THE CONFIGURATION FIELDS. SEE CHART IN NEXT SECTION FOR ALL POSSIBLE FIELDS.### -->
    <configuratorProperty configItemNameToModify="07sqlDatabaseSchema">dbo</configuratorProperty>
    <configuratorProperty configItemNameToModify="01voiceConsoleHostname">HOSTNAME</configuratorProperty>
    <configuratorProperty configItemNameToModify="01databaseServer">SQL Server</configuratorProperty>
    <configuratorProperty configItemNameToModify="05sqlDatabaseUsername">USERNAME</configuratorProperty>
    <configuratorProperty configItemNameToModify="01tomcatLogDirectory">C:\Shared\Vocollect\logs</configuratorProperty>
    <configuratorProperty configItemNameToModify="#date">Apr 8, 202510:11:42 AM</configuratorProperty>
    <configuratorProperty configItemNameToModify="testConnection">true</configuratorProperty>
    <configuratorProperty configItemNameToModify="06sqlDatabasePassword">PASSWORD</configuratorProperty>
    <configuratorProperty configItemNameToModify="04voiceConsoleStorageDirectory">C:\Shared\Vocollect</configuratorProperty>
    <configuratorProperty configItemNameToModify="03sqlDatabaseName">DATABASE</configuratorProperty>
    <configuratorProperty configItemNameToModify="01sqlDatabaseHostname">HOSTNAME</configuratorProperty>
    <configuratorProperty configItemNameToModify="06voiceConsoleSamlSSO">false</configuratorProperty>
    <configuratorProperty configItemNameToModify="04flexeraPassword">PASSWORD</configuratorProperty>
    <configuratorProperty configItemNameToModify="04oraDatabaseUsername">USERNAME</configuratorProperty>
    </configuratorData>
    </com.izforge.izpack.panels.configurator.ConfiguratorPanel>
    <com.izforge.izpack.panels.ShortcutPanel id="shortcutpanel">
    <!-- Start menu shortcut settings -->
    <!-- ###EDIT SHORTCUT SETTINGS.### -->
    <programGroup name="Vocollect\VoiceConsole"/>
    <shortcut KdeSubstUID="false" categories="" commandLine="start" createForAll="false" description="Go to VoiceConsole web application" encoding="" group="true" icon="C:\Temp\6.2.1\tools\vocollect_icon.ico" iconIndex="0" initialState="1" mimetype="" name="VoiceConsole" target="C:\Temp\6.2.1\bin\WebApplication.url" terminal="" terminalOptions="" tryexec="" type="1" url="" usertype="0" workingDirectory="C:\Temp\6.2.1\bin"/>
    </com.izforge.izpack.panels.ShortcutPanel>
    <com.izforge.izpack.panels.VocollectFinishPanel id="finishpanel"/>
    </AutomatedInstallation>

Initiate a Silent Installation

Once the properties file is created and saved in the appropriate location, the user can run the silent installer using one of the following commands.

You must run these commands with Administrator privileges.

  • To execute the silent installer on Windows, open the Command prompt, and use one of the following commands:

    install.exe <xmlFileName>.xml

    install.bat <xmlFileName>.xml

  • To execute the silent installer on Linux, run the command:

    install.sh <xmlFileName>.xml

Configuration Fields for Silent Installation

Tomcat Server Configuration

00tomcatAccount

Field Description

Type of Tomcat account.

If you want to use NT authentication for SQL Server databases for a Windows installation, you must use an existing account.

Values

  • tomcatExisting
  • tomcatLocalSystem (Windows) (default)
  • tomcatVocollectUser (Unix-based) (default)

Installation Type

All

01tomcatExistingUsername

Field Description

Existing account username.

Installation Type

Tomcat Existing User.

02tomcatExistingPassword

Field Description

Existing account password.

Installation Type

Tomcat Existing User.

01tomcatLogDirectory

Location where log files are stored.

Values

path

Installation Type

All

01tomcatListenPort

Field Description

HTTP Port.

Values

9090 (default)

Installation Type

All

02tomcatSSLPort

Field Description

HTTPS Port.

Values

9443 (default)

Installation Type

All

03tomcatAjpPort

Field Description

AJP Port.

Values

9011 (default)

Installation Type

All

04tomcatShutdownPort

Field Description

Shutdown Port.

Values

9006 (default)

Installation Type

All

Database Configuration

01databaseServer

Field Description

Type of database.

Values

  • SQL Server
  • Oracle

Installation Type

All.

02databaseSettingsMode

Field Description

Type of setting.

Values

  • Basic Settings
  • Advanced Settings

Installation Type

SQL / Oracle

01sqlDatabaseHostname

Field Description

DNS name or IP address of the machine hosting the database.

Installation Type

  • SQL Server / Oracle
  • Basic Settings

01oraDatabaseHostname

Field Description

DNS name or IP address of the machine hosting the database.

Installation Type

  • SQL Server / Oracle
  • Basic Settings

02sqlDatabasePort

Field Description

The port that the database uses.

Values

  • 1433 (SQL default)
  • 1521 (Oracle default)

Must be an integer between 1 and 65535.

Installation Type

  • SQL Server / Oracle
  • Basic Settings

02oraDatabasePort

Field Description

The port that the database uses.

Values

  • 1433 (SQL default)
  • 1521 (Oracle default)

Must be an integer between 1 and 65535.

Installation Type

  • SQL Server / Oracle
  • Basic Settings

03sqlDatabaseName

Field Description

The name of the database.

Installation Type

  • SQL Server / Oracle
  • Basic Settings

03oraDatabaseName

Field Description

The name of the database.

Installation Type

  • SQL Server / Oracle
  • Basic Settings

01sqlDatabaseJdbcUrl

Field Description

The JDBC URL for the database.

Values

  • jdbc:sqlserver://<host>:<port>; DatabaseName=<database name>
  • jdbc:oracle:thin:@<host>:<port>:<sid>

Installation Type

  • SQL Server / Oracle
  • Advanced Settings

01oraDatabaseJdbcUrl

Field Description

The JDBC URL for the database.

Values

  • jdbc:sqlserver://<host>:<port>; DatabaseName=<database name>
  • jdbc:oracle:thin:@<host>:<port>:<sid>

Installation Type

  • SQL Server / Oracle
  • Advanced Settings

04sqlDatabaseAuthMode

Field Description

The authentication type used to connect to the database.

Values

  • SQL Server Authentication
  • NT Authentication

Installation Type

  • SQL Server
  • Basic Settings

04adv_sqlDatabaseAuthMode

Field Description

The authentication type used to connect to the database.

Values

  • SQL Server Authentication
  • NT Authentication

Installation Type

  • SQL Server
  • Advanced Settings

05sqlDatabaseUsername

Field Description

The username that the application should use to log into the database. This is disabled if using NT Authentication.

Values

  • SQL Server Authentication
  • NT Authentication

Installation Type

  • SQL Server / Oracle
  • Basic Settings

04oraDatabaseUsername

Field Description

The username that the application should use to log into the database. This is disabled if using NT Authentication.

Values

  • SQL Server Authentication
  • NT Authentication

Installation Type

  • SQL Server / Oracle
  • Basic Settings

03adv_sqlDatabaseUsername

Field Description

The username that the application should use to log into the database. This is disabled if using NT Authentication.

Values

  • SQL Server Authentication
  • NT Authentication

Installation Type

  • SQL Server / Oracle
  • Advanced Settings

02adv_oraDatabaseUsername

Field Description

The username that the application should use to log into the database. This is disabled if using NT Authentication.

Values

  • SQL Server Authentication
  • NT Authentication

Installation Type

  • SQL Server / Oracle
  • Advanced Settings

06sqlDatabasePassword

Field Description

The password of the user that the application should use to log into the database. This is disabled if using NT Authentication.

Installation Type

  • SQL Server / Oracle
  • Basic Settings

05oraDatabasePassword

Field Description

The password of the user that the application should use to log into the database. This is disabled if using NT Authentication.

Installation Type

  • SQL Server / Oracle
  • Basic Settings

04adv_sqlDatabasePassword

Field Description

The password of the user that the application should use to log into the database. This is disabled if using NT Authentication.

Installation Type

  • SQL Server / Oracle
  • Advanced Settings

03adv_oraDatabasePassword

Field Description

The password of the user that the application should use to log into the database. This is disabled if using NT Authentication.

Installation Type

  • SQL Server / Oracle
  • Advanced Settings

07sqlDatabaseSchema

Field Description

The database schema that you are using.

Installation Type

  • SQL Server / Oracle
  • Basic Settings

07oraDatabaseSchema

Field Description

The database schema that you are using.

Installation Type

  • SQL Server / Oracle
  • Basic Settings

05adv_sqlDatabaseSchema

Field Description

The database schema that you are using.

Installation Type

  • SQL Server / Oracle
  • Advanced Settings

05adv_oraDatabaseSchema

Field Description

The database schema that you are using.

Installation Type

  • SQL Server / Oracle
  • Advanced Settings

VoiceConsole Configuration

01voiceConsoleHostname

Field Description

Hostname of the machine onto which you are installing.

Installation Type

All

02displayDialogPort

Field Description

Default port that the application server uses for the Display Dialog feature.

Values

9091 (default)

Installation Type

All

03voiceConsoleHTTPSOption

Field Description

Enable secure HTTPS on all pages of the VoiceConsole On Prem deployment. Certain pages are still secure if this check box is not set.

Values

  • true
  • false

Installation Type

All

04voiceConsoleStorageDirectory

Field Description

Specify where you would like to have application files stored.

Values

path

Installation Type

All

06voiceConsoleSamlSSO

Field Description

Enable SAML Single SignOn (SSO) as part of the VoiceConsole On Prem deployment.

Values

  • true
  • false (default)

Installation Type

All

SAML SSO cannot be enabled during an upgrade installation. It can only be enabled during a new installation.

License Server Configuration

02flexeraPort

Field Description

HTTPS port for the Local License Server

Values

  • 1443 (default)

Installation Type

All

04flexeraPassword

Field Description

Password for the Local License Server.

Installation Type

All