Script (system object)
The script system object is available in both PlanetPress Design and PlanetPress Suite Workflow Tools scripting environments. It contains properties describing the current external script.
&script is not used within PlanetPress Design and is not a PlanetPress Talk variable. It is a variable used within scripts in JScript, VBScript, Perl or Python called from PlanetPress Talk in a PlanetPress Design Document, using the ExecScriptFile (function) command.
Syntax
- &script.filename
string - &script.paramstring string
- &script.returnvalue string
Properties
filename
Read-only string value containing the fully qualified path and filename of the current script.
paramstring
Read-only string containing additional information passed by the document to the script.
returnvalue
Read-write integer containing a coded value for the result of the ExecScriptFile (function) command.
Accessing custom PlanetPress Suite Workflow Tools variables from a currently running script within PlanetPress Design will yield unknown results, simply because PlanetPress Design does not have any access to the PlanetPress Suite Workflow Tools custom variables. Users should therefore be careful to use conditional statements within the script if needing to access custom variables.