Installing UEC via the Command Line

Owned by
Former user (Deleted)
Last updated: Feb 18, 2023 by
Stonebranch
5 min read

Introduction

This page describes how to install Universal Enterprise Controller (UEC) using the Windows Installer command line interface.

A command line installation is useful in situations where:

  • Several Universal Enterprise Controller installations must be deployed.
  • It is not practical or convenient to perform the graphical interface installation.
  • It is necessary to generate an installation log file.

Installing UEC

Step 1

Download the Universal Enterprise Controller for Windows product distribution file, sb-UECtlr-6.3.0.<level>-windows-i386.exe, to your work station.

Step 2

Execute the distribution file from the command line, and include all appropriate command line switches and parameters.
 
The installation process determines whether a Windows Installer update is needed. The process then extracts and saves a Windows installer package file (.msi) to this location.
 
After all files (including the .msi) are extracted from the distribution file, the installation process verifies that your machine meets the minimum installation requirements. If the requirements are met, the installation begins.

Command Line Syntax

The following illustrates the command line syntax used to install UEC:

sb-UECtlr-6.3.0.<level>-windows-i386.exe [/v"command line parameters"] [/s] [/w] [/x]

In this syntax:

  • <level> is the numeric package level.

The command line switches (/v, /s, /w, and /x) are processed directly by the distribution file to control behavior of the Windows Setup application.

The command line parameters are passed to the Windows Installer (msiexec) to control the extracted Windows installer package file (.msi) behavior during the install process.

Command Line Switches

The following table describes the command line switches available for a command line installation:
 

/v

Passes parameters to the Windows Installer (msiexec).
 
The list of parameters must be enclosed in double (") quotation marks. See #Command Line Parameters for available parameters.

/s

Suppresses the initialization and extraction dialogs displayed before the product install Welcome dialog."
 
If you are using the #/q command line parameter, use this switch additionally for a completely silent install.

/w

Instructs the Windows Setup application to wait until the installation completes.
 
Use this switch when launching the installation from a script file. Without it, the Setup application may return immediately after launching Windows Installer.

/x

Uninstalls UEC.

Command Line Parameters

The following table describes the parameters that are available for a command line installation.

The parameters can be specified in any order, with the following exceptions:

  • If the Repair (#/fom) or Remove (#/x) parameter is used, it must be specified before all other parameters.
  • If the Silent install (#/q) and/or Log file (#/L) parameters are used, they can be specified in any order, but they must be specified after all other parameters.

These parameters are preceded by the #/v command line switch and must be enclosed in double (") quotation marks.
 

Parameter

Description

Default

/fom

Repairs a Universal Enterprise Controller installation.
 
om (after the /f) are options used by the repair. There are other options available, but for behavior that matches the repair done from the graphical install, the om options must be used.
 
/fom cannot be used with the /x (remove) parameter.

n/a

/x

Removes Universal Enterprise Controller.
 
/x cannot be used with the /fom (repair) parameter.

n/a

INSTALLDIR=installdir

Sets the root installation directory to <installdir>. Each component will be installed under this directory.
 
INSTALLDIR is required if you want to install UEC under a directory different from the one specified by the PROGRAMFILES environment variable (typically C:\Program Files\Universal). If the directory contains spaces, you must use double ( " ) quotation marks around the path name.

(none)

UECTLR={yes|no}

Specification for whether or not to install the UEC Service component during new installs, upgrades, or maintenance.

  • If yes is specified, UEC Service will be installed.
  • If no is specified, UEC Service will not be installed. If UEC Service already is present on the system (via a previous installation), it will be removed.

Since, by default, each component's install state is preserved during an upgrade or maintenance, UEC Service is not required unless you want to change the current install state. UEC Service is ignored during an uninstall.
 
Setting this parameter has the same effect as selecting whether or not to install UEC Service on the Custom Setup dialog when installing UEC via the graphical interface.

yes

/q

Suppresses the product installation dialogs.
 
Use this parameter in addition to the #/s command line switch for a completely silent install.
 
See #Command Line Switches, #Command Line Installation Examples, and #Detecting the Completion of Silent Installs for additional information regarding silent installs.

n/a

/L*v

Instructs the installation process to create an installation log file named <logfilepath> (full path name). If <logfilepath> contains spaces, you must enclose it with double ( " ) quotation marks.
 
*v are flags used to specify the level of detail (verbose) contained in the log file. To reduce the amount of output generated, *v can be omitted. However, using these options is good practice; they can assist Stonebranch Customer Support with problem determination should any errors occur during installation.

n/a

Command Line Installation Examples

The following examples illustrate different ways that UEC can be installed from the command line.

Graphical User Interface Install, All Components

To install all UEC components via the graphical user interface, issue the following command:


Graphical User Interface Install, All Components, with Log File

To install all UEC components using the Windows Installer graphical user interface and write a log file to C:\temp\install.log during the installation, issue the following command:


Silent Install, Different Installation Directory

To install UEC under D:\Universal, which is a directory other than the one specified by the environment variable PROGRAMFILES, issue the following command:


Silent Install, All Components

To install all UEC components without using a graphical interface — that is, a silent install — issue the following command:


Detecting the Completion of Silent Installs

If the #/q switch is used to perform a silent install, no graphical interface or user interaction is required. One drawback to this is that no feedback is provided indicating when the Windows Installer process (install, uninstall, or repair) finishes.

One method that may be used to detect when the Windows Installer process ends is to execute it using the system's start command. Using available command line switches, the start command can be used to initiate the Windows Installer process and then wait for it to finish. When the start command returns control to its calling process (for example, the command prompt), the process will have ended.

For example, from the command prompt, issue the following command to start the Universal Enterprise Controller installation and wait for it to finish.

  • The /b switch prevents the start command from opening a new window.
  • The /wait parameter causes the start command to start the application, sb-UECtlr-6.3.0.0-windows-i386.exe, and then wait for it to finish.

The syntax above can also be used to execute the start command from within a script, such as a .bat file.

For more information on the start command, go to the Windows command prompt and enter: start /?.