Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old


Sets the script to trigger when scan is done.

Component Version macOS Windows Linux Server iOS SDK
DocumentCameraScan 10.0 ❌ No ❌ No ❌ No ❌ No ✅ Yes
MBS( "DocumentCameraScan.SetScript"; Filename; ScriptName )   More


Parameter Description Example
Filename The database file name where the script is located. "test.fmp12"
ScriptName The script name. "MyScript"


Returns OK or error.


Sets the script to trigger when scan is done.
Parameter to the script is either Cancel, Error or Scan.
In case of error, please use DocumentCameraScan.ErrorMessage to query the error message to display.
When you get Scan as parameter, you may use DocumentCameraScan.PageCount function to query number of pages scanned.

With plugin version 6.0 or newer the script name can be a script ID number. In that case the plugin queries the script name for the given script ID. This allows to call scripts by ID and avoid problems if scripts are later renamed.

Notice: FileMaker 19.2 adds a fmplugin extended privileges. If you have such an extended privileges to allow the plugin to trigger scripts, you need to grant permissions for it. If such a privilege is not defined, the plugin is allowed to trigger scripts. See FileMaker product documentation for details.


Script may look like this:

Set Variable [ $param ; Value: Get(ScriptParameter) ]
If [ $param = "Error" ]
    Show Custom Dialog [ "Failed to scan" ; MBS( "DocumentCameraScan.ErrorMessage" ) ]
Else If [ $param = "Scan" ]
    Perform Script [ Specified: From list ; “Import” ; Parameter: ]
Else If [ $param = "Cancel" ]
    # do nothing
End If

See also

Example Databases

Blog Entries

This function checks for a license.

Created 6th January 2020, last changed 13th November 2021

DocumentCameraScan.Scan - DocumentCameraScan.Supported