Template:Plugin Basics

Requirements

FileMaker 7 or higher, Java Virtual Machine (JVM) 1.5 or higher, Windows or Mac OS X 10.4. Rosetta on Intel Macs not supported.

Installation

To install the plug-in, copy the plug-in to the correct directory:

FileMaker Pro: FileMaker / Extensions
Web Publishing Engine: FileMaker Server/Web Publishing/publishing-engine/wpc/Plugins *
Custom Web Publishing: FileMaker Server/Web Publishing/publishing-engine/cwpc/Plugins *
Mac FileMaker Server: /Library/FileMaker Server/Database Server/Extensions *
Windows FileMaker Server: C:\Program Files\FileMaker\FileMaker Server\Database Server\Extensions *
* (Requires Enterprise license)

Create the wpc folder if it doesn't exits. Make sure to restart FileMaker Pro / Server / WPE. Enable the plug-in in FileMaker Server Admin console for server installations.

Uninstalling the plug-in

Uninstall the plug-in by quitting FileMaker Pro or stopping FileMaker Server and removing the plug-in file from your Extensions directory.

Demo mode and registering the plug-in

Plug-ins will run in a fully featured demo mode until they are registered. While running in demo mode, the product will run for 2 hours every time you launch FileMaker / FileMaker Server / FileMaker Web Publishing Engine until restarted. Enter the license information in FileMaker Preferences, or by using a script.

Error Handling/Reporting

When something unexpected happens, a plug-in function returns a result of "ERROR". This makes it easy to check for errors. If a plug-in function returns "ERROR", call the CCLastError function to get a detailed description of what went wrong. For example:

Set Variable [ $result = MyPluginFunction("x" ; "y" ; "z") ]
If [ $result = "ERROR" ]
Show Custom Dialog [ "An error occurred: " & CCLastError ]
End If

If a plug-in is not installed correctly, calls to a plug-in function will return "?"

More Information

For more information on how to correctly install and work with plug-ins, check out the Plugins 101 documentation.