The StartMacro function will run a named macro (which must be defined). Note that Inventu Viewer+ macros require that the active screen be the first screen that the macro is expecting to work with. Inventu Viewer+ macros are not "blind" to the active screen and utilized simple recognition to ensure the correct screen is displayed and ready for the macro input. In the FVParent.html sample, the StartMacro is run when the Signon screen is displayed.
Parameter |
Description |
macroName |
Name of the macro as stored by the macro's author |
isPub |
true = this is a public macro. It is expected that a scripted call to StartMacro would usually involve a public macro. When this is false, it means a macro defined in the user's private macro space. |
atServer |
Optional Boolean true=run a server macro instead of a client-side macro |
callData |
Optional call data object with any optional parameters as named properties of the object |
fnComplete |
Optional Completion function call-back with two parameters: (returnData, errorMessage) -- errorMessage==null means no error. |
Return Value |
Description |
true |
The session is active so the macro was started |
false |
The session is not active--macro was not started |
