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

Plugin.RegisterScriptStep

Registers a script step dynamically.

Component Version macOS Windows Linux Server iOS SDK
Plugin 15.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "Plugin.RegisterScriptStep"; functionId; Name; Definition; Expression; Description )   More

Parameters

Parameter Description Example
functionId The function ID.
Must be unique and 3 or higher.

MBS function is ID 1 and MBS script step is ID 2.
3
Name The name of the custom function. "Concat"
Definition An XML to define the script step.
Expression The expression to run. "1+2"
Description The description to show in the user interface.

Result

Returns OK or error.

Description

Registers a script step dynamically.
Allows you to define custom script steps for your solution.
Please register the same script step each time your solution opens with the same IDs. FileMaker usually finds script steps by ID.

See also Plugin.RegisterFunction for registering a function.

Examples

Register a script step:

MBS( "Plugin.RegisterScriptStep";
// internal ID. Must be unique
123;
// name of script step
"Concat";
// XML definition of parameters
"<PluginStep>
    <Parameter Type=\"target\" Label=\"Destination\" ShowInLine=\"true\"/>
    <Parameter Type=\"calc\" DataType=\"text\" ShowInline=\"true\" Label=\"FirstName\" ID=\"0\"/>
    <Parameter Type=\"calc\" DataType=\"text\" ShowInline=\"true\" Label=\"SecondName\" ID=\"1\"/>
</PluginStep>";
// calculation
"MBS(\"Plugin.ScriptStepParameter\"; 0) & MBS(\"Plugin.ScriptStepParameter\"; 1)";
// description
"Concat two texts" )

See also

Release notes

  • Version 15.3
    • Added Plugin.RegisterScriptStep function.

Blog Entries

This function checks for a license.

Created 27th June 2025, last changed 27th June 2025


Plugin.RegisterFunction - Plugin.ScriptStepParameter