Switches for MSI Installers
The MSI switches detailed in the table below are available for installation with PDF-Tools.
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 PDF-XChange 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 recrods.
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.
Additional options and more detailed explanations are available at the Microsoft website.
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.
Syntax
<list of features>
Features
•F_Viewer - PDF-XChange Editor and its components;
•F_Plugins - The plugins module for PDF-XChange Editor. (This requires F_Viewer). If F_Plugins is specified, the following features can be used to install plugins:
•F_Plugin_SP - the SpellChecker plugin. (This requires F_Plugins).
•F_FileOpenPlugin - the plugin that provides support for files secured using "FileOpen". (This requires F_Plugins).
•F_ReadOutLoudPlugin - the plugin that provides read-out-loud functionality. (This requires F_Plugins).
•F_OCRPlugin - the plugin that allows OCR-image-based PDF files in the software. (This requires F_Plugins).
•F_OptimizerPlugin - the plugin optimizes PDF files to reduce their size. (This requires F_Plugins).
•F_BookmarksPlugin - the plugin that adds advanced features for editing 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 directly within the software. (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_MD Plugin - the plugin that enables the conversion of Markdown files into PDF documents. (This requires F_Plugins).
•F_BrowserPlugins - the plug-ins for web browsers (Internet Explorer, FireFox, Opera, Safari, and Chrome) that allow the viewing of PDF files inside these browsers. (This requires F_Viewer, as well as F_IEPlugin and/or F_NPPlugin).
•F_NPPlugin - the Firefox, Chrome, Safari and Opera plugin. (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_Tools - PDF-Tools and its components.
•F_Tools_Plugins - to install the collection of plugins that extend the functionality of PDF-Tools. (This requires F_Tools).
•F_TLangs - additional language files for localization in PDF-Tools. (This requires F_Tools).
•F_Lite - the PDF-XChange Lite V6 print driver and its related components.
•F_Langs_Lite - the files that allow the localization of languages in the PDF-XChange Lite V6 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 PDF-XChange products. The updater checks automatically for updates to the software.
•F_KeyInstaller - the key installer for PDF-XChange applications.
A comprehensive list of further available standard public properties is available here.
Product Specific Properties
INSTALLLOCATION
This property specifies the 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.
PNAME
This property specifies the printer name. The default value is "PDF-XChange Lite V6."
Syntax
<name>
SET_LITE_AS_DEFAULT
If this property is unspecified, or specified with a value of "1", then the PDF-XChange Lite V6 printer will be set as the default system printer.
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.
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.
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.
USERNAME
This property specifies the username to which applications will be registered.
ORGANIZATION
This property specifies the organization name to which applications will be registered.
Syntax
<oname>
USERMAIL
This property specifies the user email.
Syntax
<email>
KEYFILE
This property specifies the UNC location of the license vault file <filename>.xcvault.
Syntax
<xcvault file>
KEYDATA
This property specifies the registration key.
Syntax
<regkey>
DDEFLANGID
This property specifies a language for the print driver. (This requires the standard property F_Langs_Lite in order to operate). The <id> for target languages is available here. The “culture code” must be used for this property. This is a hexadecimal value and must be converted to decimal for use. For example German has the hexadecimal value 0x0407 and therefore the decimal 1031 must be used. A hexadecimal to decimal converter is available here.
Syntax
<id>
PDEFLANGID
This property specifies a language for PDF-Tools. (This requires the standard property F_TLangs in order to operate). The <id> for target languages is available here. The “culture code” must be used for this property. This is a hexadecimal value and must be converted to decimal for use. For example German has the hexadecimal value 0x0407 and therefore the decimal 1031 must be used. A hexadecimal to decimal converter is available here.
EDITOR_LANGUAGE
This property specifies a language for the software. (This requires the standard property F_Vlangs in order to operate). This property uses the "language culture name" to define languages. For example German is "de-DE". The <id> for target languages is available here.
Syntax
<id>
NOUPDATER
If this property is unspecified, or specified with a value of "0", then the updater will be installed. If specified with a value of "1" then the updater will not be installed. (Available from build 310).
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.
MSI Installer Examples
•Install the software in quiet mode, with a basic UI, to the folder "C:\Program Files\My PDF Applications":
msiexec /i ToolsV6.x86.msi /qb INSTALLLOCATION="C:\Program Files\My PDF Applications"
•Install the software in quiet mode, with a basic UI, to the default folder and specify the user license information:
msiexec /i ToolsV6.x86.msi /qb USERNAME="Dave" USERMAIL="abc@a.b.c" KEYFILE="\\UNC\path\to\xcvaultfile"
•Install the software with all features, German as the UI language, in quiet mode and with and a basic UI (Please note that ADDLOCAL is not being used, therefore all components, including F_VLangs, are installed:
msiexec /i ToolsV6.x86.msi /qb EDITOR_LANGUAGE="de-DE"
•Install the software in quiet mode, with a basic UI, 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 defined. ADDLOCAL is used, therefore only the features specified will be installed and F_VLangs must be specified separately:
msiexec/i ToolsV6.x86.msi /qb ADDLOCAL="F_Viewer,F_Plugins,F_Plugin_SP,F_OCRPlugin,F_VLangs,F_BrowserPlugins,F_IEPlugin" EDITOR_LANGUAGE="de-DE"