FME Form Administrator's Guide: 2024.2
Installing FME Form from the Windows Command Prompt
We recommend installing FME Form using the installation wizard. However, installing from the command prompt may be useful when you want to perform a silent or remote installation.
About the Installer
The FME Form installer is a self-extracting executable from which you can directly call an installer package (MSI) in a single command. Alternatively, you can manually extract installation files, then call the MSI file to silently install.
Performing an Installation
Example Syntax
Extract the installer to C:\FME\installer and install with all default options
This examples assumes you are running a command line from a folder that contains an installer named fme-form-win-x64.exe.
fme-form-win-x64.exe -d"C:\FME\installer" -s -sp"/qb /norestart INSTALLLEVEL=3 ENABLE_POST_INSTALL_TASKS=no"
Extract the installer to C:\FME\installer and install to C:\Program Files\FME12345
This examples assumes you are running PowerShell from a folder that contains an installer named fme-form-win-x64.exe.
./fme-form-win-x64.exe -d"C:\FME\installer" -s -sp"/qb /norestart INSTALLLEVEL=3 ENABLE_POST_INSTALL_TASKS=no INSTALLDIR=""""""""""""""""C:\Program Files\FME12345"""""""""""""""""
Executable Parameters
-d<path>
Sets the destination folder for unpacked files.
-s, -s1, -s2
Silent mode. Switch -s is a brief form of -s1. Both -s and -s1 hide the main dialog and extraction progress. -s2 hides the start dialog, but extraction progress is displayed.
-sp<par>
Silent parameters to pass to the extracted MSI installer when it is run. For more information, see MSI-Specific Parameters.
Installing from the MSI
Use the following syntax to perform a silent installation from an MSI that was already extracted manually from the installer executable.
msiexec /i <path_to_installer> /qb INSTALLLEVEL=3 INSTALLDIR="<installdir>" ENABLE_POST_INSTALL_TASKS=no
msiexec /i fme_beta.msi /qb INSTALLLEVEL=3 INSTALLDIR="C:\Program Files\FME" ENABLE_POST_INSTALL_TASKS=no
MSI-Specific Parameters
/i <installFile.msi>
Installs the package specified by <installFile.msi> on your computer.
/q[n|b]
Quiet mode. If /qb
is specified, a dialog with a progress bar displays, but there is no user interaction. If /qn
is specified, no GUI displays.
When /qn is specified, the installer appears to return immediately; however, the installation process continues to run in the background. When installing silently, we recommend enabling logging (see below) so you can check for errors.
/x <installFile.msi>
Uninstalls <installFile.msi> if it is installed on your system.
/l*v <logfile>
Enables verbose logging of the installation to <logfile>.
Directives are specified after flags, in the following format:
<directive name>=<directive value>
INSTALLLEVEL
If installing with the /q
flag, the directive INSTALLLEVEL=3 must be specified for the installation to proceed correctly.
INSTALLDIR
Specifies the full path location of the main installation folder. If the folder does not exist, it is created. Spaces may be used with quotes.
The default path is C:\Program Files\FME on Windows XP, and C:\apps\FME on Windows Vista and later.
The following directives affect the installer's runtime behavior.
EXTRACTONLY
Extracts the .msi installation file, but does not run the installer. A C++ runtime package and MSSQL driver only are installed.
ENABLE_SOUNDEVENTS
Sets up sound events. Allowed values are yes and no (case-sensitive). Default is yes.
CHECK_ADMIN_RIGHTS
Checks to ensure that the user installing FME has admin privileges. Allowed values are yes and no (case-sensitive). Default is yes.
ENABLE_SHORTCUTS
Creates shortcuts in the Windows Start menu. Allowed values are yes and no (case-sensitive). Default is yes.
ENABLE_ALL_FILE_ASSOCIATIONS
To disable all file associations, specify no. Default is yes.
ENABLE_FILETYPE_REGISTRATION
To disable file associations with dataset files of formats, specify no. Default is yes.
ENABLE_FME_FILETYPE_REGISTRATION
To disable file associations with files that are specific to FME (for example, .fmw workspace, .fpkg package, .fmwt template files), specify no. Default is yes.
ENABLE_PATH_UPDATE
Allows the installer to update the PATH environment variable. Allowed values are yes and no (case-sensitive). Default is yes.
ENABLE_STANDARD_EXE_INSTALLATION
Installs all of the standard FME executables (FME Data Inspector, FME Workbench, etc). Allowed values are yes and no (case-sensitive). Default is yes.
ENABLE_LICENSE_COPY
Allows the installer to search for old license files, and copy them into the current installation folder if present. Allowed values are yes and no (case-sensitive). Default is yes.
ENABLE_POST_INSTALL_TASKS
Controls whether the license wizard is run after the installer has completed. See also FMEREG_CMDLINE (below). Allowed values are yes and no (case-sensitive). Default is yes.
FMEREG_CMDLINE
Passes values into the license wizard (fmelicensingassistant_cmd.exe) at install time to automate licensing, using syntax similar to Licensing FME Form from the Windows Command Prompt. For example, to license FME on floating license server named "license_server", specify FMEREG_CMDLINE="--floating license_server smallworld"
.
ENABLE_ZERO_SIDE_EFFECT
Sets the following options to "no":
ENABLE_SOUNDEVENTS, CHECK_ADMIN_RIGHTS,INSTALL_SYSTEM_DLLS, ENABLE_SHORTCUTS,ENABLE_FILETYPE_REGISTRATION, ENABLE_POST_INSTALL_TASKS,ENABLE_PATH_UPDATE,ENABLE_LICENSE_COPY
Allowed values are yes and no (case-sensitive). Default is no.
ENABLE_NAD83_NAD27_DATUMSHIFTS
Controls whether implicit NAD27 to NAD83 Datum Transformation is set to USA or CANADA. Allowed values are yes, no and none. Default is no, which sets this directive to USA. A yes setting specifies CANADA only. Specifying none disable the transformation, which causes workspaces to error when trying to use that shift.
REPORTSTATISTICS
Controls whether statistics about format and transformer use are sent to Safe Software.
Allowed values are yes and no (case-sensitive). Default is yes.
Some files that are installed by the installer can be omitted by these directives.
INSTALL_USER_DOCUMENTS
Installs directories to the user's 'Documents' folder, including a 'My FME Workspaces' folder. Default is yes.
INSTALL_SYSTEM_DLLS
Updates older system DLLs as needed, and run the Microsoft Visual Studio C++ Runtime Installer. Allowed values are yes and no (case-sensitive). Default is yes.
If set to no, the user is responsible for manually running the C++ Runtime installer, and ensuring that atl.dll and atl71.dll are installed on the target system. This option is not recommended, and may lead to non-functional FME installations.
INSTALL_THIRDPARTY
Installs application extenders. Allowed values are yes and no (case-sensitive). Default is yes.
Enabling application extenders is controlled by the FME Administrator.
INSTALL_FMEOBJECTS
Installs FME Objects DLLs and other components. Allowed values are yes and no (case-sensitive). Default is yes. For more information, see Installing the Software Development Kit for FME Form.
INSTALL_GALLERY
Installs the gallery folder. Allowed values are yes and no (case-sensitive). Default is yes.
INSTALL_HELP
Installs the help folder. Allowed values are yes and no (case-sensitive). Default is yes.
INSTALL_HELP_DLL
Installs the help DLLs. Allowed values are yes and no (case-sensitive). Default is yes.
INSTALL_METAFILE
Installs the metafile folder. Allowed values are yes and no (case-sensitive). Default is yes.
INSTALL_PLUGINBUILDER
Installs the pluginbuilder folder. Allowed values are yes and no (case-sensitive). Default is yes.
INSTALL_REPROJECT
Installs the Reproject folder. Allowed values are yes and no (case-sensitive). Default is yes.
INSTALL_TCL
Installs the tcl folder. Allowed values are yes and no (case-sensitive). Default is yes.
INSTALL_WORKBENCH_EXE
Installs the the FME Workbench application. Allowed values are yes and no (case-sensitive). Default is yes.
INSTALL_FME_EXE
Installs the fmeapplication. Allowed values are yes and no (case-sensitive). Default is yes.
INSTALL_FMEADMIN_EXE
Installs the FME Administrator application. Allowed values are yes and no (case-sensitive). Default is yes.
INSTALL_FMEVIEW_EXE
Installs the FME Universal Viewer application. Allowed values are yes and no (case-sensitive). Default is yes.
INSTALL_FMEGUI_EXE
Installs the FME Universal Translator application. Allowed values are yes and no (case-sensitive). Default is yes.
INSTALL_FMEREG_EXE
Installs the FME Licensing Assistant application. Allowed values are yes and no (case-sensitive). Default is yes.
INSTALL_WHATSNEW
Installs the what's new/great text files. Allowed values are yes and no (case-sensitive). Default is yes.
INSTALL_FMECOMUTIL_DLL
Installs the fmecomutil DLL. Allowed values are yes and no (case-sensitive). Default is yes.
INSTALL_FME_SHELLEXT_DLL
Installs the fme shell extension DLL. Allowed values are yes and no (case-sensitive). Default is yes.
INSTALL_SPATIAL_ASSISTANT_EXE
Installs spatialassistant.exe. Allowed values are yes and no (case-sensitive). Default is yes.
INSTALL_FMEGEOS_DLL
Installs geos_fme.dll. Allowed values are yes and no (case-sensitive). Default is yes.
Post-Install Tasks
Licensing FME Form from the Windows Command Prompt
You can activate an FME installation for a floating license using the following syntax:
fmelicensingassistant_cmd --floating <server>[:<port>] <license type>
fmelicensingassistant_cmd --floating testserver smallworld
To get the proper values for <license type>
, run:
fmelicensingassistant_cmd.exe --query <server>[:<port>]
fmelicensingassistant_cmd.exe --query testserver
MSSQL Formats Only
If you plan to run workspaces that reference Microsoft SQL Server and Azure SQL Database (MSSQL_*) readers and writers, you must manually install the OLE DB Driver for SQL Server and Microsoft System CLR Types for SQL Server. To install, navigate to the [INSTALLDIR] and run:
msiexec /i msoledbsql.msi /qb IACCEPTMSOLEDBSQLLICENSETERMS=YES
msiexec /i SQLSysClrTypes.msi /qb