Foxit has tested and supports the installation of Foxit PDF Editor using the command line. You can use command line methods to install software in many ways, such as typing commands at a command prompt, in a batch script or with any application that supports Windows Installers (msi).
Audience:
Organizations looking to deploy Foxit PDF Editor to their knowledge workers.
In this article:
- Supported MSI properties
- Unsupported MSI properties
- MSI switches
- Sample Command-line deployment scripts
- Troubleshooting msiexec
Supported MSI Properties
ADDLOCAL<list of features>The value of the ADDLOCAL property is a comma delimited list of features which the installation of Foxit PDF Editor will make available locally. Foxit PDF Editor installer defines the following features:
Property | Description |
---|---|
FX_PDFVIEWER | Foxit PDF Viewer and its components |
FX_FIREFOXPLUGIN |
Plugin which is used for opening PDF files in Internet Explorer web browser. This feature requires FX_PDFVIEWER feature to be installed. |
FX_EALS | Module which is used for displaying Eastern Asian Languages. Eastern Asian Languages can't be displayed properly without it. This feature requires FX_PDFVIEWER feature to be installed. |
FX_SPELLCHECK | Spell check tool which is used for finding any misspelled words in typewriter or form filler mode and suggest the correct spelling. This feature requires FX_PDFVIEWER feature to be installed. |
FX_PDFA | Module which is used for verifying compliance with PDF/A-1a and PDF/A-1b. This feature requires FX_PDFVIEWER feature to be installed. |
FX_OCR | Module which is used for making scanned or image-based PDF documents selectable and searchable. This feature requires FX_PDFVIEWER feature to be installed. |
FX_CREATOR |
Foxit PDF Editor Creator installs a virtual printer on your system. You can use Creator to convert any printable documents into high-quality PDFs conveniently and efficiently. This feature requires FX_PDFVIEWER feature to be installed. |
FX_CONVERTEXT |
Shell extension which is used for converting PDF or combining supported files from right click menu. This feature requires FX_CREATOR to be installed. |
FX_CREATORWORDADDIN | MS word toolbar addin to create PDF with one click. This feature requires FX_CREATOR feature to be installed. |
FX_CREATOREXCELADDIN | MS Excel toolbar addin to create PDF with one click . This feature requires FX_CREATOR feature to be installed. |
FX_CREATORPPTADDIN | MS PPT toolbar addin to create PDF with one click . This feature requires FX_CREATOR feature to be installed. |
FX_CREATOROUTLOOKADDIN | MS Outlook toolbar addin to create PDF with one click . This feature requires FX_CREATOR feature to be installed. |
FX_SE |
Plugins for Windows Explorer and Windows shell. These extensions allow PDF thumbnails to be viewed in Windows Explorer, and PDF files to be previewed in Windows OS and Office 2007 (or a later version). This feature requires FX_PDFVIEWER to be installed. |
FX_IFILTER | Foxit IFilter is a plug-in for Windows search engines and it can help do search PDF document. |
FX_BROWSERADDIN | The web browser plugin used for converting web pages to PDFs. |
INSTALLLOCATION |
Specifies the folder where products will be installed. |
MAKEDEFAULT | Default value of "1", Foxit PDF Editor will be set as default application for PDF files. |
VIEW_IN_BROWSER |
Default value of "1", Foxit PDF Editor will be configured to open PDF files inside browsers. |
DESKTOP_SHORTCUT | Default value of "1", installer will place shortcut for installed application on Desktop. To manually delete this shortcut will ask for administrator right. |
USERS_DESKTOP |
It only has a value of "1", installer will place a shortcut for the installed application on desktop. To manually delete this shortcut will not ask for administrator right. This parameter is appliable to V11.1 or later. |
STARTMENU_SHORTCUT | Default value of "1", installer will create program menu group for installed application and their components. |
SETDEFAULTPRINTER |
Default value of "1", installer will install Foxit PDF Editor Printer as the system default printer. |
LAUNCHCHECKDEFAULT |
Default value of "1", Foxit PDF Editor will check if the PDF Editor is the default reader when launching. |
INTERNET_DISABLE | Disables all features that require Internet connection by setting the value to “1”. |
LIVEPUS_DISABLE |
Dock the floating Foxit Assistant to the status bar or to the right side of the application window if the status bar is hidden with the value of "1". |
AUTO_UPDATE |
Default value of "1", Foxit PDF Editor will automatically download updates and let you choose when to install them. With value of “0”, Foxit PDF Editor will not download or install updates automatically. With value of “2”, Foxit PDF Editor will automatically download and install updates. |
KEYPATH |
Specify a license key file and save it to the PDF Editor installation folder |
REMOVENEWVERSION |
Force an installation to overwrite the higher version of Foxit PDF Editor with the value of “1”. |
CLEAN |
Uninstall Foxit PDF Editor and remove all of its settings completely with the value of “1”. |
NOTINSTALLUPDATE |
Does not install updates by setting the value to “1”. This will prevent Foxit PDF Editor from being updated from within the software |
READ_MODE |
pens PDF file in Read Mode by default in web browsers by setting the value to “1” |
KEYCODE |
Use the key code to activate Foxit PDF Editor. |
EMBEDDED_PDF_INOFFICE |
With the value of “1”, opens embedded PDF files in Microsoft Office with Foxit PDF Editor if Acrobat and Foxit Reader is not installed. (For the EXE installation package, inputs the commandline /displayadobeindoc.) |
Unsupported MSI Properties
CPDF_DISABLE - Disable ConnectedPDF functions with the value of “1”.
This function was discontinued.
EDITION - Choose which Foxit PDF Editor edition to install with the value of “Standard”, “Business” or “Education”.
The license now controls the Edition of the software.
MSI Switches
For Microsoft documentation, see https://msdn.microsoft.com/en-us/library/Aa367988.
Command |
Description |
---|---|
{ /?| /h} |
Displays the Windows Installer version and copyright information. |
/a |
Applies the administrative installation option. |
/f |
For product repair. Enables one or more of the command-line options below:
|
/g |
Identifies the language. Syntax: /g LanguageID |
/i |
Installs or configures a product. |
/j |
Advertises a product. If you want to install the application with elevated privileges, use /jm. Syntax:
|
/L |
Specifies the path to the log file. To include the v option in a log file using the wildcard flag, type /L*v at the command prompt. The Windows Installer log file options can also be used with the uninstall and repair processes. For example, use /L*v to set verbose logging.
|
/p |
Applies an update. |
/q |
Sets the user interface level. The modal box is not displayed if the user cancels the installation.
|
/t |
Applies transform to advertised package. Syntax: /t TransformList |
/x |
Uninstalls a product. |
/y |
Calls the system API DllRegisterServer to self-register modules passed on the command line. |
/z |
Calls the system API DllUnRegisterServer to unregister modules passed on the command line. |
Package Code |
Specifies the globally unique identifier of the Windows Installer package. For Acrobat products, this is the GUID. |
Package |
Not supported. Specifies the name of the Windows Installer package file |
/sAll |
Run installer in silent mode. |
/sPB |
Silent mode with minimum UI: show the progress bar only. |
/rs |
Reboot Suppress. Setup.exe will not initiate reboot even if it is required. |
/rps |
Reboot Prompt Suppress. If reboot is required, the system restarts without warning. |
/ini “PATH” |
Relative or absolute path to an alternative (different) Bootstrapper INI file. The CmdLine of alternative INI will be ignored. |
/sl “LANG_ID” |
Set Language, where LANG_ID is the decimal code of the destination installation language. Use it only for the multilingual installer, and make sure that the corresponding language transform file exist in the setup directory. If /sl “LANG_ID” is not set and you are running the multilingual installer interactively (not silently), ‘Choose Setup Language’ dialog will be displayed. |
/msi[Command line] |
Identifies the portion of CmdLine for additional MSIEXEC command line parameters. Everything following /msi is passed to MSIEXEC without analyzing and without any changes. |
Command-line Examples:
Use a Transforms (MST file)
msiexec /i "Foxit PDF Editor.msi" TRANSFORMS="xxx.mst"
Create a log file
msiexec /i "Foxit PDF Editor.msi" /log c:\debug.txt
Note: the path to the logfile location must already exist (For example, output the debug.txt log file into C:\ drive while installation Foxit PDF Editor)
Install the application in quiet mode (no user interaction)
msiexec /i "Foxit PDF Editor.msi" /quiet INSTALLLOCATION="C:\Program Files\ Foxit Software "
Use the license key file saved in disk C to activate the application when running the setup.
msiexec /i "Foxit PDF Editor.msi" KEYPATH="C:\fpmkey.txt"
No installation of Foxit PDF Printer.
msiexec /i "Foxit PDF Editor.msi" ADDLOCAL=ALL, ADVERTISE="FX_CREATOR" /qn
Use the key code to activate the program.
msiexec /i "Foxit PDF Editor.msi" keycode="97000-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"
Use the key code to activate the program silently after installation (Applicable for Version 9.x and later)
<The full path of Activation.exe> -cmdquietactive XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
E.g. C:\Program Files (x86)\Foxit Software\Foxit PDF Editor\Activation.exe -cmdquietactive XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
Force an installation to overwrite the same or higher version of Foxit PDF Editor:
msiexec /i "Foxit PDF Editor.msi" REMOVENEWVERSION="1"
Perform a Clean uninstall
msiexec /x "Foxit PDF Editor.msi" /quiet CLEAN="1"
Troubleshooting msiexec
When using msiexec, if you receive an “Incorrect command line parameters” error message, verify that:
- Your syntax is correct.
- There is a space before the log file name if you use the syntax for writing a log file.
- You have not placed a /qn switch between the /i switch and the name of the MSI file.
Foxit does not troubleshoot "incorrect command line parameters" issues, please contact Microsoft directly.
Note: For more information about msiexec options, refer to https://technet.microsoft.com/en-us/library/cc759262(WS.10).aspx#BKMK_Install.