automation
Returns a ScriptableAutomation object encapsulating the properties of the PlanetPress Workflow process that triggered the current operation.
This automation
object is available in all script types and with all file types.
Note: The automation
object available in Designer scripts is not of the same type. It has different properties.
Properties
The following table lists the properties of the automation
object. All properties are read-only.
Property | Description |
---|---|
jobInfo | Returns a ScriptableAutomation object containing Job Info 1 to 9 values from PlanetPress Workflow (see Fixed automation properties, and Job Info variables in the Workflow Online Help). |
properties | Returns a ScriptableAutomation object containing additional information (ProcessName , OriginalFilename and TaskIndex ) from PlanetPress Workflow (see Fixed automation properties). |
parameters |
Returns a ScriptableAutomation object containing the custom runtime parameters defined in the data mapping configuration (see Properties and runtime parameters). At runtime this object also contains any local and global variables defined by the user in PlanetPress Workflow, to ensure compatibility with previous versions. |
variables | Deprecated; use automation.parameters instead. Both properties contain the same list of elements, but the variables property is kept for backward compatibility and may eventually be removed. |
Examples
To access JobInfo 1 to 9 defined in Workflow (see Job Info variables):
automation.jobInfo.JobInfo1;
To access ProcessName, OriginalFilename or TaskIndex from Workflow:
automation.properties.OriginalFilename;
To access Workflow variables (see Properties and runtime parameters):
automation.parameters.runtimeparametername;