Switches for MSI Installers
The MSI Installation Switches detailed below are available with PDF-XChange PRO:
The command line for installation is: msiexec /Option <Required Parameter> [Optional Parameter] [PROPERTY=PropertyValue]
The available options for msiexec are detailed below. Please note that parameters are case sensitive.
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.
Properties
Public properties defined by PDF-XChange PRO installation can be specified, as well as standard MSI public properties. See here for a complete list of standard public properties. The most useful properties are detailed below:
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 the all available options will be installed.
Syntax
<list of features>
Features
•F_Viewer - PDF-XChange Editor and its main components.
•F_Plugins - plug-ins module for PDF-XChange Editor. This requires F_Viewer to operate.
•F_Plugin_SP - the spell-checker. This requires F_Plugins to operate.
•F_FileOpenPlugin - handles FileOpen DRM. This requires F_Plugins to operate.
•F_ReadOutLoudPlugin - provides 'read-out-loud' functionality. This requires F_Plugins to operate.
•F_OCRPlugin - allows the OCR of image-based PDF files in PDF-XChange Editor. This requires F_Plugins to operate.
•F_OptimizerPlugin - optimizes PDF files in order to reduce their file size.
•F_BookmarksPlugin - facilitates the inclusion of advanced functionality for bookmarks in PDF Files. This requires F_Plugins to operate.
•F_PDFAPlugin - converts PDF files into PDF/A format. This requires F_Plugins to operate.
•F_SPPlugin - the SharePoint plug-in, which facilitates the use of files located on SharePoint servers. This requires F_Plugins to operate.
•F_GDPlugin - facilitates the use of files located on Google Drive™. This requires F_Plugins to operate.
•F_OFCPlugin - to install the plugin that allows the conversion of documents into MS Office formats directly within the software. This requires F_Plugins to operate.
•F_DBPlugin - facilitates the use of files located on the DropBox™ cloud. This requires F_Plugins to operate.
•F_MDPlugin - to install the plugin that enables the conversion of Markdown files into PDF documents. This requires F_Plugins to operate.
•F_BrowserPlugins - the plug-in 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 to operate.
•F_NPPlugin - the plug-in for Firefox, Chrome, Safari and Opera. This requires F_BrowserPlugins and F_Viewer to operate.
•F_IEPlugin - the plug-in for Internet Explorer. This requires F_BrowserPlugins and F_Viewer to operate.
•F_VLangs - provides additional languages for the localization of PDF-XChange Editor. This requires F_Viewer to operate.
•F_Tools - the plug-in for PDF Tools and its components.
•F_Tools_Plugins - the plug-ins that extend the functionality of PDF Tools. This requires F_Tools to operate.
•F_TLangs - provides additional languages for the localization of PDF Tools. This requires F_Tools to operate.
•F_Drivers - PDF-XChange Standard Printer and related components.
•F_Office2PDF - Office to PDF, which facilitates the batch conversion of MS Office documents to PDF. This requires F_Drivers to operate.
•F_OfficeAddin - extended support for MS Office applications when converting documents to PDF. This requires F_Drivers to operate.
•F_IEAddin - the add-in for MS Internet Explorer that facilitates the conversion of web pages to PDF format.
•F_Langs_Drv - language localization files for the Driver, Office Addin and Office2PDF. This requires F-Drivers to operate.
•F_ShellExt - the plugins for Windows Explorer and Windows shell. These extensions enable the viewing of PDF thumbnails in Windows Explorer, display PDF file properties, handle the previewing of PDF files in Windows Vista and Office 2007 and provide the IFilter component, which allows the Windows Desktop Search to operate within PDF files.
•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 products.
A comprehensive list of available standard properties is available here.
Product Specific Properties
PNAME
This property specifies the name of the printer to be used. The default value is "PDF-XChange Standard V6."
Syntax
<name>
INSTALLLOCATION
This property specifies the installation folder.
SET_PRINTER_AS_DEFAULT
When specified with a value of "1" the PDF-XChange Standard printer will be set as the default printer after installation. If this property is not specified then the PDF-XChange Standard printer will not be set as the default printer.
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.
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>
EDITOR_LANGUAGE
Specifies a language for PDF-XChange Editor. (This requires the standard property F_Vlangs to operate).
Syntax
<id>*
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
Specifies a language for PDF Tools. (This requires the standard property F_Langs_Drv to operate). See here for a list of languages that should be entered in the place of <id> when specifying a language. 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>
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 application in quiet mode to the folder "C:\Program Files\My PDF Applications":
msiexec /i ProV6.x64.msi /quiet INSTALLLOCATION="C:\Program Files\My PDF Applications"
•Install the application in quiet mode to the default folder and specify the user license information with the key as a string:
msiexec /i ProV6.x64.msi /qb USERNAME="John Doe" USERMAIL="abc@a.b.c" KEYDATA="PVP60-….+XivqqLSozuRTqTCxnRv0sNR1i2UTPSA5AvAUl4Q="
•Install the application in quiet mode to the default folder and specify the user license information with the key as a vault file:
msiexec /i ProV6.x64.msi /qn USERNAME="John Doe" USERMAIL="abc@a.b.c" KEYFILE="\valid\\UNC\path\to\vault\file.xcvault"
•Install only PDF-XChange, Office Add-In and PDF Tools, and specify a new name for the printer:
msiexec /i ProV6.x64.msi /qb ADDLOCAL="F_Drivers,F_OfficeAddin,F_Tools" PNAME="My PDF Printer"
•Install all products with German as the application UI language. (If ADDLOCAL is not called then all features, including all languages, are available to the installer and the following properties can be used. If ADDLOCAL is used to specify components and an alternative language is to be used then corresponding language components (F_Vlangs, F_Langs_Drv and/or F_TLangs) must be explicitly called:
msiexec /i ProV6.x64.msi /quiet EDITOR_LANGUAGE=de-DE DDEFLANGID=1031 PDEFLAGID=1031