| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
Component: Plugin
Central plugin management functions.
| Version | macOS | Windows | Linux | Server | iOS SDK |
| 1.0 / 15.5 | ✅ Yes | ✅ 98% | ✅ 99% | ✅ 98% | ✅ 99% |
| Item | Details | Server |
|---|---|---|
| AddToErrorLog Adds log entry to current error log. | All 12.3 |
✅ Server |
| ClearErrors Clears error counter. | All 12.2 |
✅ Server |
| ClearRegistration Clears registration details stored with StoreRegistration. | All 3.0 |
✅ Server |
| CompileDate Returns the date the plug-in was compiled. | All 1.0 |
✅ Server |
| CompileTime The time of day that the plug-in was compiled. | All 1.0 |
✅ Server |
| ErrorLog Queries error log. | All 12.3 |
✅ Server |
| HadErrors Queries error counter. | All 12.2 |
✅ Server |
| Is64bit Checks if platform is 64bit or 32bit. | All 5.0 |
✅ Server |
| IsClient Checks if plugin is running on a client. | All 4.3 |
✅ Server |
| IsError Checks whether last plugin function returned error. | All 3.4 |
✅ Server |
| IsIOS Whether we run on iOS. | All 6.1 |
✅ Server |
| IsIOSDevice Queries whether run on iOS device. | All 8.0 |
✅ Server |
| IsIOSSimulator Queries whether run on iOS simulator. | All 8.0 |
✅ Server |
| IsLinux Whether we run on Linux. | All 6.1 |
✅ Server |
| IsMacOS Whether we run on Mac. | All 6.1 |
✅ Server |
| IsMobile Whether plugin runs on a mobile target. | All 7.2 |
✅ Server |
| IsRegistered Queries if plugin is registered with Complete key. | All 3.0 |
✅ Server |
| IsRuntime Checks if plugin is running on a runtime. | All 4.3 |
✅ Server |
| IsServer Checks if plugin is running on a server. | All 4.3 |
✅ Server |
| IsWindows Whether we run on Windows. | All 6.1 |
✅ Server |
| Platform Returns what platform the plugin is running on. | All 3.0 |
✅ Server |
| Plugin.BuildNumber Queries the build number of the plugin. | All 5.0 |
✅ Server |
| Plugin.CallCounter Queries call counter. | All 9.3 |
✅ Server |
| Plugin.CallErrorScriptTrigger Triggers error script. | All 8.5 |
❌ Server |
| Plugin.CompileDate Queries compile date as FileMaker date. | All 10.0 |
✅ Server |
| Plugin.CustomFunctionIDs New in 15.5 Queries the list of registered function ids. | All 15.5 |
✅ Server |
| Plugin.CustomFunctionNames Queries list of function names. | All 15.3 |
✅ Server |
| Plugin.CustomFunctionParameter Queries custom function parameter with given index. | All 15.3 |
✅ Server |
| Plugin.CustomFunctionParameterCount Queries number of parameters to the current custom function. | All 15.3 |
✅ Server |
| Plugin.CustomFunctions New in 15.5 Queries details on all registered custom functions. | All 15.5 |
✅ Server |
| Plugin.DisableFunction Disables a plugin function. | All 2.8 |
✅ Server |
| Plugin.FunctionCount Queries number of functions available. | All 7.2 |
✅ Server |
| Plugin.Functions Returns a list of all the functions in the plugin. | All 1.0 |
✅ Server |
| Plugin.GetFunctionParameters Queries the function metadata for parameter list. | All 12.1 |
✅ Server |
| Plugin.GetFunctionPlatforms Queries the function metadata for platform support. | All 10.5 |
✅ Server |
| Plugin.GetSuccessReturn Queries current OK return. | All 5.1 |
✅ Server |
| Plugin.InstallSignalHandlers Installs signal handlers. | Mac/Linux/iOS 9.3 |
✅ Server |
| Plugin.IsLicenseKeyHidden Queries whether to hide license key. | All 14.3 |
✅ Server |
| Plugin.IsMaintenanceExpired Queries whether maintenance is expired. | All 13.1 |
✅ Server |
| Plugin.IsPrerelease Queries whether this is a MBS Plugin beta version. | All 10.0 |
✅ Server |
| Plugin.JasperVersion Queries version string for Jasper library. | All 9.0 |
✅ Server |
| Plugin.LibExpatVersion Queries the version of the expat library. | All 15.0 |
✅ Server |
| Plugin.LibSSHVersion Queries the SSH library version used. | All 6.2 |
✅ Server |
| Plugin.LicenseeName Queries licensee name. | All 8.3 |
✅ Server |
| Plugin.LimitFunction Limits a function. | All 5.4 |
✅ Server |
| Plugin.LimitToFile Sets which files are allowed to use our plugin. | All 15.1 |
✅ Server |
| Plugin.LoadIconvLibrary Loads the iconv library. | All 10.4 |
✅ Server |
| Plugin.LockFunction Locks a function with a password. | All 5.4 |
✅ Server |
| Plugin.LockedFunctions Lists the locked functions. | All 14.3 |
✅ Server |
| Plugin.ObjectCounts Returns JSON with object counts. | All 13.5 |
✅ Server |
| Plugin.OpenSSLVersion Queries OpenSSL Version. | All 6.2 |
✅ Server |
| Plugin.PNGVersion Queries PNG version. | All 7.3 |
✅ Server |
| Plugin.Path Queries the native file path to the plugin. | All 3.3 |
✅ Server |
| Plugin.RegisterFunction Registers a custom function with FileMaker or JavaScript code. | All 15.3 |
✅ Server |
| Plugin.RegisterScriptStep Registers a script step dynamically. | All 15.3 |
✅ Server |
| Plugin.ScriptStepParameter Queries script step parameter with given index. | All 7.2 |
✅ Server |
| Plugin.ScriptStepParameterCount Queries number of parameters to the current script step. | All 7.2 |
✅ Server |
| Plugin.Seats Queries the internal seats value. | All 1.6 |
✅ Server |
| Plugin.SetErrorScriptTrigger Sets script to trigger if plugin call returns an error. | All 8.5 |
❌ Server |
| Plugin.SetFunctions Sets the function list the plugin has. | All 5.1 |
✅ Server |
| Plugin.SetLicenseKeyHidden Sets whether to hide license key. | All 14.3 |
✅ Server |
| Plugin.SetPreviewSize Sets which size plugin uses for preview images. | All 5.1 |
✅ Server |
| Plugin.SetSuccessReturn Sets what the plugin returns on success. | All 5.1 |
✅ Server |
| Plugin.StartTimeStamp Queries time the plugin was loaded. | All 9.5 |
✅ Server |
| Plugin.State Queries plugin state. | All 13.1 |
✅ Server |
| Plugin.TiffVersion Queries version string for TIFF library. | All 9.0 |
✅ Server |
| Plugin.UnlockFunction Unlocks a locked function. | All 5.4 |
✅ Server |
| Plugin.UnregisterFunction Unregister a function. | All 15.4 |
✅ Server |
| Plugin.UnregisterScriptStep Unregister a script step. | All 15.4 |
✅ Server |
| Plugin.UsedFunctionCounts Queries plugin function usage counts. | All 13.5 |
✅ Server |
| Plugin.UsedFunctions Queries used functions. | All 8.3 |
✅ Server |
| Plugin.WebPVersion Returns version of WebP library. | All 13.2 |
✅ Server |
| Plugin.ZLibVersion Queries zlib version number. | All 8.1 |
✅ Server |
| Plugin.isDebug Checks whether this is debug version of MBS Plugin. | All 7.1 |
✅ Server |
| Register This function is used to register the Plugin. | All 1.0 |
✅ Server |
| Registration Returns a list of the currently registered components. | All 1.0 |
✅ Server |
| StoreRegistration Stores registration on Mac in preferences file of FileMaker so the plugin can auto register itself on startup of FileMaker. | All 3.0 |
✅ Server |
| Unregister Unregisters the plugin license. | All 1.6 |
✅ Server |
| Version Useful for doing auto-updates from server and version checking. | All 1.0 |
✅ Server |
| VersionAutoUpdate Returns the version in the auto update format. e.g. 02040028 | All 2.4 |
✅ Server |
80 functions shown.
Release notes
- Version 15.5
- Added flag 8 for Plugin.RegisterFunction function to secure a function and prevent unregister or replacement.
- Added Plugin.CustomFunctionIDs function to query IDs of custom functions.
- Added Plugin.CustomFunctions function to query JSON with details about custom functions.
- Fixed Plugin.CustomFunctionIDs function to return correct IDs.
- Fixed Plugin.RegisterFunction to handle optional parameters better and create temporary variables for the calculations.
- Version 15.4
- Added flags for Plugin.RegisterFunctionand Plugin.RegisterScriptStep functions, so you can turn on JavaScript.
- Added Plugin.UnregisterFunction and Plugin.UnregisterScriptStep functions.
- Improved custom functions with Plugin.RegisterFunction to handle optional parameters better. Use {} in the parameters to declare optional ones.
- Improved custom functions with Plugin.RegisterFunction to properly pass through errors, so Get(LastError) can see it.
- Version 15.3
- Added Plugin.CustomFunctionNames to list custom functions.
- Added Plugin.CustomFunctionParameter and Plugin.CustomFunctionParameterCount to query parameters for the custom function.
- Added Plugin.RegisterFunction function to register custom functions on the fly. These show up in calculation dialogs just like regular custom functions.
- Added Plugin.RegisterScriptStep function.
- Improved Plugin.RegisterFunction to pass parameters as they appear in prototype.
- Version 15.1
- Added Plugin.LimitToFile function.
- Version 15.0
- Added FileNames parameter for Plugin.LimitFunction function.
- Added Plugin.LibExpatVersion function.
- Version 14.3
- Added Plugin.LockedFunctions function.
- Added Plugin.SetLicenseKeyHidden and Plugin.IsLicenseKeyHidden functions.
- Version 13.5
- Added Plugin.ObjectCounts and Plugin.UsedFunctionCounts function.
- Version 13.2
- Added Plugin.WebPVersion function.
- Version 13.1
- Added Plugin.IsMaintenanceExpired function.
- Added Plugin.State function.
Blog Entries
FileMaker Magazin
- Ausgabe 2/2025, Seite 23
- Ausgabe 1/2025, Seite 25
- Ausgabe 6/2024, Seite 37
- Ausgabe 1/2023, Seite 30
- Ausgabe 5/2022, Seite 26 bis 27
- Ausgabe 2/2022, Seite 29
- Ausgabe 1/2022, Seite 28
- Ausgabe 1/2022, Seite 21 bis 22
- Ausgabe 6/2021, Seite 23
- Ausgabe 6/2021, Seite 21
Example Databases
- CURL/SFTP/CURL sFTP Upload File
- DynaPDF/Create Text as PDFA
- DynaPDF/Report
- DynaPDF/Tables
- Registration/Debugging and Registration
- SmartCard/Belgian EID Reader
- Utility functions/FileMaker Custom Functions
- Utility functions/Install Plugin Update if needed
- Utility functions/MBS Plugin Install
- Utility functions/Trigger Script on Plugin Error
