Install Plug-In File
Purpose
Installs or updates a plug-in file from a container field onto your computer.
See also
Format
Install Plug-In File[<table::field>]
Options
<table::field> allows you to specify the container field with the
plug-in that you want to install or update. If no field is specified, FileMaker Pro installs the plug-in in the current container field in the active table.
Compatibility
Where the script step runs | Supported |
FileMaker Pro | Yes |
FileMaker Server | Yes |
FileMaker Go | No |
Custom Web Publishing | Yes |
FileMaker WebDirect | Yes |
Runtime solution | Yes |
Originated in
FileMaker Pro 12.0
Description
You must insert the plug-in in a container field before you can install or update the plug-in. For more information, see
Insert File or
Installing plug-ins.
FileMaker Pro installs plug-ins in the following locations:
Operating system | Product | Plug-ins are installed in this folder |
Windows | FileMaker Pro | C:\users\user_name\AppData\Local\FileMaker\FileMaker Pro\15.0\Extensions\ |
FileMaker Pro Advanced | C:\users\user_name\AppData\Local\FileMaker\FileMaker Pro Advanced\15.0\Extensions\ |
OS X | FileMaker Pro | Macintosh HD/Users/user_name/Library/Application Support/FileMaker/FileMaker Pro/15.0/Extensions |
FileMaker Pro Advanced | Macintosh HD/Users/user_name/Library/Application Support/FileMaker/FileMaker Pro Advanced/15.0/Extensions |
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) or .fmx64 (64-bit FileMaker Pro). In OS X, 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 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 installs the update but does not enable the plug-in. See
Setting plug-in preferences.
For FileMaker Server-hosted files, the server administrator needs to allow the Install Plug-In File script step to update FileMaker Server plug-ins in the Server Admin Console. See
FileMaker Server Help.
Notes
•FileMaker Pro can only install plug-ins that match the FileMaker Pro application’s architecture. For example, the 64-bit version of FileMaker Pro 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 a volume license installation to disable plug-ins and prevent plug-in updates from installing in FileMaker Pro. See
FileMaker Pro Network Install Setup Guide.
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