Switches for MSI Installers

<< Click to Display Table of Contents >>

Navigation:  Installation >

Switches for MSI Installers


 

Editor-Icon Switches for MSI Installers

 


 

The most useful options for msiexec are detailed below. Please note that parameters are case sensitive. All available options are detailed here.

 

The command line for installation is: msiexec /Option <Required Parameter> [Optional Parameter] [PROPERTY=PropertyValue]

 


 

Install Options

 


 

/package or /i

 

This switch installs or configures the product specified.

 

Syntax

 

<Product.msi>

 


 

/a

 

This switch installs the product specified on the network as an administrative install.

 

Syntax

 

<Product.msi>

 


 

/j<u|m>

 

This switch advertises the specified product. "u" advertises to the current user, "m" advertises to all users.

 

Syntax

 

<Product.msi>

 

Parameters

 

[/t <Transform List>]

[/g <Language ID>]

 


 

/uninstall | /x

 

This switch uninstalls the product specified.

 

Syntax

 

<Product.msi>

 

Parameters

 

The parameter for this switch can be either an .msi file or the relevant product code.

 


 

Display Options

 


 

/quiet

 

This switch installs the application without user interaction.

 


 

/passive

 

This switch installs the application in unattended mode. The user will see only the progress bar.

 


 

/q[n|b|r|f]

 

This switch sets the user interface level. "b" installs a basic UI, "f" installs a full UI and is the default setting, "n" means that no UI is installed, "r" installs a reduced UI.

 


 

Restart Options

 


 

/norestart

 

This switch disables the automatic system restart when installation is complete. (Please note that many Tracker Software products require a restart to function properly).

 


 

/promptrestart

 

This switch prompts the user for a restart when it is necessary.

 


 

/forcerestart

 

This switch forces a system restart when installation is complete.

 


 

Logging Options

 


 

/l

 

This switch defines the logging level for installation.

 

Syntax

 

<Logfile>

 

Modifiers

 

a - start up of actions.

 

c - initial UI parameters.

 

e - all error messages.

 

i - status messages.

 

m - out of memory or fatal exit information.

 

o - out of disk space messages.

 

p - terminal properties.

 

r - action-specific records.

 

u - user requests.

 

v - verbose output.

 

w - nonfatal warnings.

 

x - extra debugging information.

 

+ - append to existing file.

 

! - flush each line to the log.

 

* - log all information except for verbose output and extra debugging information.

 


 

/log

 

This switch is the equivalent for /l* <LogFile>.

 

Syntax

 

<LogFile>

 


 

Repair Options

 


 

/f

 

This switch repairs the product specified.

 

Syntax

 

<Product>

 

Parameters

 

The parameter for this switch can be either an .msi file or the relevant product code.

 

Modifiers

 

a - forces the reinstallation of all files.

 

c - if a file is missing or checksum does not match the calculated value.

 

d - if a file is missing or a different version is installed.

 

e - if a file is missing or an equal or older version is installed.

 

m - all required computer-specific registry entries. This is a default setting.

 

o - if a file is missing or an older version is installed. This is a default setting.

 

p - only if a file is missing.

 

s - all existing shortcuts. This is a default setting.

 

u - all required user-specific registry entries. This is a default setting.

 

v - runs from source and re-caches the local package.

 


 

Standard Properties

 


 

ADDLOCAL

 

The value of the ADDLOCAL property is a list of features, delimited with commas, that install locally. If it is not used then all available options will be installed. If it is used then all required features must be specified.

 

Syntax

 

ADDLOCAL=<list of features>

 

Features

 

F_ViewerPDF-XChange Editor and its components.

F_Plugins – The plugins module for PDF-XChange Editor. (This requires F_Viewer).

F_Plugin_SP – the spell-checker plugin. (This requires F_Plugins).

F_FileOpenPlugin – the security plugin that handles FileOpen DRM. (This requires F_Plugins).

F_ReadOutLoudPlugin – the plugin that provides read-out-loud functionality. (This requires F_Plugins).

F_OCRPlugin – the plugin that allows the OCR of image-based PDF files in the software. (This requires F_Plugins).

F_OptimizerPlugin – the plugin that optimizes PDF files. (This requires F_Plugins).

F_BookmarksPlugin – the plugin that facilitates the inclusion of advanced functionality for bookmarks. (This requires F_Plugins).

F_PDFAPlugin – the plugin that converts PDF files into PDF/A format. (This requires F_Plugins).

F_SPPlugin  the plugin that allows the software to work with files located on Sharepoint/Office 365 servers. (This requires F_Plugins).

F_GDPlugin  the plugin that allows the software to work with files located on Google Drive cloud storage. (This requires F_Plugins).

F_OFCPlugin  the plugin that allows the conversion of documents into MS Office formats. (This requires F_Plugins). 

F_DBPlugin – the plugin that enables the software to work in conjunction with files located on the Dropbox cloud. (This requires F_Plugins).

F_MDPlugin  the plugin that enables the conversion of Markdown files into PDF documents. (This requires F_Plugins).

F_ODPlugin - the plugin that enables working with files located on Microsoft OneDrive. (This requires F_Plugins).

F_BoxPlugin - the plugin that enables working with files located on Box.com. (This requires F_Plugins).

F_3DPlugin - the plugin that enables the viewing of embedded 3D content in PDF documents. (This requires F_Plugins).

F_BrowserPlugins – the plugin for web browsers (Explorer, FireFox, Opera, Safari and Chrome) that facilitate browser-based PDF file viewing. (This requires F_Viewer, as well as F_IEPlugin and/or F_NPPlugin).

F_NPPlugin – the plugin for Firefox, Chrome, Safari and Opera. (This requires F_BrowserPlugins and F_Viewer).

F_IEPlugin – the IE plugin. (This requires F_BrowserPlugins and F_Viewer).

F_VLangs – the language localization files for the software (requires F_Viewer).

F_Lite – the PDF-XChange Lite V7 printer and its components.

F_Langs_Lite – the files that allow the language localization of the PDF-XChange Lite V7 print driver and its components.

F_ShellExt  the Windows Explorer and Windows shell extensions. This has multiple features including the viewing of thumbnails, properties, previews and the inclusion of the IFilter component. 

F_Updater  the updater for Tracker Software Products. The updater checks automatically for updates to the software.

F_KeyInstaller  the key installer for Tracker Software applications.

 

A comprehensive list of properties defined by the Windows installer is available here.

 


 

Product Specific Properties

 


 

INSTALLLOCATION

 

This property specifies the installation folder.

 

Syntax

 

INSTALLLOCATION=<installation folder>

 


 

SET_AS_DEFAULT

 

If this property is unspecified, or specified with value of "1", then PDF-XChange Editor will be set as the default application for PDF files.

 

Syntax

 

SET_AS_DEFAULT="0"

 


 

PNAME

 

This property specifies the printer name. The default value is "PDF-XChange Lite V7."

 

Syntax

 

PNAME=<printer name>

 


 

SET_LITE_AS_DEFAULT

 

If this property is unspecified, or specified with a value of "1", then the PDF-XChange Lite V7 printer will be set as the default system printer.

 

Syntax

 

SET_LITE_AS_DEFAULT="0"

 


 

VIEW_IN_BROWSERS

 

If this property is unspecified, or specified with a value of "1", then PDF-XChange Editor will be configured to open PDF files inside browsers.

 

Syntax

 

VIEW_IN_BROWSERS ="0"

 


 

DESKTOP_SHORTCUTS

 

If this property is unspecified, or specified with a value of "1", then the installer will place shortcuts for installed applications on the desktop.

 

Syntax

 

DESKTOP_SHORTCUTS="0"

 


 

PROGRAMSMENU_SHORTCUTS

 

If this property is unspecified, or specified with a value of "1", then the installer will create a program menu group for installed applications and their components.

 

Syntax

 

PROGRAMSMENU_SHORTCUTS="0"

 


 

USERNAME

 

This property specifies the username to which applications will be registered.

 

Syntax

 

USERNAME=<username>

 


 

ORGANIZATION

 

This property specifies the organization name to which applications will be registered.

 

Syntax

 

ORGANIZATION=<organization name>

 


 

USERMAIL

 

This property specifies the user email.

 

Syntax

 

USERMAIL=<user email>

 


KEYFILE

 

This property specifies the UNC location of the license vault file <filename>.xcvault. See here for further information.

 

Syntax

 

KEYFILE=<path to xcvault file>

 


 

KEYDATA

 

This property specifies the registration key.

 

Syntax

 

KEYDATA=<registration key>

 


 

APP_LANG

 

This property specifies a language for PDF-XChange Editor and the PDF-XChange Lite printer. (This requires F_Vlangs in order to operate for PDF-XChange Editor and F_Langs_Lite to operate for PDF-XChange Lite). This property uses the "language culture name" to define languages. For example German is "de-DE". The <id> for target languages is available here. The parameters "Auto", "Builtin" and "None" can also be used instead of a language culture name. Auto uses the system locale language, Builtin uses US English and None retains the existing language in cases where the software is being upgraded, or operates in the same manner as Auto if the software is being installed for the first time.

 

Syntax

 

APP_LANG=<id>

 


 

NOUPDATER

 

If this property is unspecified, or specified with a value of "0", then the Tracker Updater will be installed.  If specified with a value of "1" then the updater will not be installed. (Available from build 310).

 

Syntax

 

NOUPDATER=<0>

 


 

SCHEDULEUPDATER

 

If this property is unspecified, or specified with a value of "1", then the installer will add a task to the task scheduler to check for software updates.

 

Syntax

 

SCHEDULEUPDATER=<0>

 


 

MSI Installer Examples

 


 

 

Install the software in quiet mode to the folder "C:\Program Files\My PDF Applications":

 
msiexec /i EditorV7.x64.msi /quiet INSTALLLOCATION="C:\Program Files\My PDF Applications"

 

Install the software in quiet mode to the default folder and specify the user license information:

 
msiexec /i EditorV7.x64.msi /quiet USERNAME="John Doe" USERMAIL="abc@a.b.c" KEYFILE="\\UNC\path\to\xcvaultfile"

 

Install only the software, in quiet mode, and the software updater:

 

msiexec /i EditorV7.x64.msi /quiet ADDLOCAL="F_Viewer,F_Updater"

 

Install the software with all features, German as the UI language and a 'basic' UI. (Please note that ADDLOCAL is not being used, therefore all components, including F_VLangs, are installed:

 
msiexec /i EditorV7.x64.msi /qb APP_LANG=de-DE

 

Install the software with specific features only: Editor, Spellcheck and OCR plugins are included. FileOpen and ReadAloud plugins are not included. The browser plugin for IE only is included. German is defined as the UI language. A 'basic' UI is also defined. ADDLOCAL is used, therefore only the features specified will be installed and F_VLangs must be specified separately:

 

msiexec /i EditorV7.x64.msi /qb ADDLOCAL="F_Viewer,F_Plugins,F_Plugin_SP,F_OCRPlugin,F_VLangs,F_BrowserPlugins,F_IEPlugin" APP_LANG=de-DE