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


Sets the script to run when new data arrived.

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


Parameter Description Example
ShellRef The reference number from the shell. $shell
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 run when new data arrived.
Please call Shell.ReadOutputText and Shell.ReadErrorText in the trigger script.
The script parameter passed with the script call is the reference number of the shell object.

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.

See also

Release notes

Example Databases

Blog Entries

This function is free to use.

Created 17th November 2019, last changed 9th November 2021

Shell.SetDataAvailableEvaluate - Shell.SetDomain