Parameter

Description

setup.exe

This parameter instructs the Microsoft Installer Utility to install the application to your computer via a setup.exe file.

If the file is not in the current folder, you will need to provide the full path to the file, such as "C:\<foldername>\foldertarget\setup.exe".

When using a batch file to run the installation, the current directory is the location of the batch file.

/i

This parameter instructs the Microsoft Installer Utility to install the application to your computer via an .msi file. The .msi file to be used must also be specificed, enclosed in quotes.

If the file is not in the current folder, you will need to provide the full path to the file. When using a batch file to run the installation, the current directory is the location of the batch file.

• msiexec /i "CARIS Onboard 2.1 (x64).msi"

/x

This parameter instructs the utility to uninstall the application from your computer. It must be the first parameter specified in the command following the install method parameter.

• setup.exe /x /s /v"/qb"

• msiexec /x "CARIS Onboard 2.1 (x64).msi" /qb

/s

This parameter tells setup.exe to run in silent mode. It must be accompanied by the /qn or /qb parameters explained below.

• setup.exe /s /v"/qn"

/v

This parameter is used to pass parameters to msiexec when running a silent install from a setup.exe file. This allows the msiexec parameters to be used in addition to the setup.exe parameters. The parameter(s) to be passed to msiexec should be specified in quotes after this parameter, with no spaces between the parameter, the quote or the msiexec parameter.

• setup.exe /s /v"/l* logfile.log"

If using this parameter to submit msiexec parameters that require a file path, it is recommended that file paths not contain spaces.

/qn or /qb

The /qn parameter sets the install process to run entirely in the background with no user interface to indicate install progress.

The /qb parameter sets the install process so that a minimal user interface is shown, specifically, a dialog box with a progress bar.

As these are msiexec parameters, they must be enclosed in quotes with the /v parameter.

• setup.exe /s /v"/qn"

• msiexec /i "CARIS Onboard 2.1 (x64).msi" /qb

/debuglog

This parameter will generate a log of the operations run by the setup.exe. A file name must be provided for the resulting log file.

If msiexec actions also need to be logged, the msiexec /l parameter will also be required.

• setup.exe /s /debuglog"exelog.log"

/l*

This parameter creates a log file that records the actions performed by msiexec during install. A file name must be provided for the resulting log file.

Unless a path is specified for the log file, it is saved in the current directory. That is the directory of the batch file if a batch file is used.

As this is an msiexec parameter, it must be enclosed in quotes with the /v parameter.

• msiexec /i "CARIS Onboard 2.1 (x64).msi" /qb /l* msilog.log

INSTALLDIR

This parameter sets the installation path on your computer for the application. The path must be enclosed in quotation marks and the parameter must be entered using upper-case letters.

If the INSTALLDIR parameter is not used, then one of two possible paths is used:

• The default installation path for Onboard, which is C:\Program Files\CARIS\Onboard\<version>

• Update installs will automatically install to the same location as the base release.

As this is an msiexec parameter, it must be enclosed in quotes with the /v parameter.

• setup.exe /s /v"/qn INSTALLDIR=C:\CustomPath"

• msiexec /i "CARIS Onboard 2.1 (x64).msi" /qb INSTALLDIR="C:\CustomPath"

REBOOT

Force or suppress the restarting of the computer after installation is complete. By default, the computer does not restart after installation. This parameter has two possible values:

REBOOT="F" (force a restart)
REBOOT="R" (suppress restart)

As this is an msiexec parameter, it must be enclosed in quotes with the /v parameter.

• msiexec /i "CARIS Onboard 2.1 (x64).msi" /qb REBOOT="F"