Reference > Script steps reference > Miscellaneous script steps > Install Plug-In File

Install Plug-In File

Installs or updates a plug-in file from a container field onto your computer.

See also 


Specify target field specifies the container field with the plug-in that you want to install or update. If no field is specified, FileMaker Pro Advanced installs the plug-in in the current container field in the active table.





FileMaker Pro Advanced 


FileMaker Go 


FileMaker WebDirect 


FileMaker Server 


FileMaker Cloud products 


FileMaker Data API 


Custom Web Publishing 


Runtime solution 


Originated in 

FileMaker Pro 12.0


You must insert the plug-in in a container field before you can install or update the plug-in. See Insert File or Installing plug-ins.

Only FileMaker plug-in files can be installed. If a non-plug-in file is located in the target or active container field, no action takes place when the script runs. In Windows, plug-ins have the extension .fmx (32-bit FileMaker Pro Advanced) or .fmx64 (64-bit FileMaker Pro Advanced). In macOS, the plug-ins have the extension .fmplugin.

Compressed plug-in files in ZIP format or plug-in files in TAR format can't be installed.

You can use the Get(InstalledFMPlugins) function to identify the name, version, and enabled state of an installed plug-in. This function can help you determine whether the installed plug-in is newer or older than the plug-in required by the solution file. See Get(InstalledFMPlugins).

Plug-ins must be enabled in the plug-in preferences for FileMaker Pro Advanced to recognize them. If the Install Plug-In File script step installs a plug-in update but the plug-in is disabled in the plug-in preferences, FileMaker Pro Advanced installs the update but does not enable the plug-in. See Setting plug-in preferences.

For files hosted by FileMaker Server or FileMaker Cloud for AWS, the server administrator must enable the Install Plug-In File script step in Admin Console. See FileMaker Server Help or FileMaker Cloud product documentation in the Product Documentation Center.


FileMaker Pro Advanced can only install plug-ins that match the FileMaker Pro Advanced application's architecture. For example, the 64-bit version of FileMaker Pro Advanced can only install 64-bit plug-ins. Use the Get(ApplicationArchitecture) function to determine the current application's architecture.

The system administrator can use the personalization file during an installation on multiple computers to disable plug-ins and prevent plug-in updates from installing in FileMaker Pro Advanced. See FileMaker Pro Advanced Network Install Setup Guide.

This script step is not supported in server-side scripts performed by a FileMaker Cloud host.

Example 1 

Installs the Video plug-in.

Show Custom Dialog ["Do you want to install the latest version of the Video Plug-In?"]
If [Get ( LastMessageChoice ) = 1]
Install Plug-In File[Plugins::Video]
End If

Example 2 

Detects the application architecture, then installs the appropriate version of a plug-in.

If [ Get ( ApplicationArchitecture ) = "i386"]
Install Plug-In File [Plugins::32bit]
Else If ( Get ( ApplicationArchitecture ) = "x86_64"]
Install Plug-In File [Plugins::64bit]
End If

Related topics 

Script steps reference (alphabetical list)

Script steps reference (category list)