8.18/6/2018

Run Script

Run Script tasks are used to run scripts that typically perform some kind of processing on the job file received by the task. Scripts are often simpler to write than programs added with the External Program action (see External Program). However, they can be slower to execute.

The Run Script action task can be used either as an action or a condition. When dragging and dropping a Run Script action task on a given process, you select whether to use this task as an action or a condition from a contextual menu.

For more information on scripts, what languages are supported and how to write scripts and conditions, please see the related chapter, Using Scripts.

Input

Any data file, in any format.

Processing

The script is executed. The script can modify anything such as the data file, job infos, metadata, or even other files on the operating system.

Output

Whatever file the Run Script action generates, metadata it modifies or creates, etc.

Note about conditions: When using Run Script as a condition, the output of the task can be within the branch or on the main trunk. To control the output, use the Script.ReturnValue variable in your script.

Run Script action task properties are as follows:

The Script Editor menu options are as followed:

The other options of the window are:

With the Run Script action, the On Error tab is accessible by right-clicking on the action in your process and clicking Advanced Properties.

The On Error tab will be triggered if your script has an execution error (such as syntax error, etc) as well as when raising an error from wtihin your script. For more information, see

On Error Tab

By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors.

If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.

Common Errors

Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc.

Comments Tab

The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane.