Runs an executable script.
In order to aid script writers in writing more general scripts, this action also adds
a set of environmental variables to the environment under which the script is executed.
These extra environmental variables correspond to the arguments passed to the
prep method. The environmental variables are:
PIPELINE_JOB_ID
The unique job identifier of the job running this action.
PIPELINE_NODE_NAME
The fully resolved name of the target node.
PIPELINE_NODE_AUTHOR
The name of the user which owns the target node.
PIPELINE_NODE_VIEW
The name of the user's working area view which contains the target node.
PIPELINE_PRIMARY_TARGET
A colon seperated list of files which make up the primary file sequence to generate.
PIPELINE_NUM_SECONDARY_TARGETS
The number of secondary file sequences to generate.
PIPELINE_SECONDARY_TARGET_#
A colon seperated list of files which make up a secondary file sequences to generate,
where (#) is replaced by the index of the of the secondary file sequence. The index
will be in the range [0,$PIPELINE_NUM_SECONDARY_TARGETS).
PIPELINE_NUM_SOURCES
The number of upstream source nodes.
PIPELINE_SOURCE_#
The fully resolved node name of a source node, where (#) is replaced by the index
of the source. The index will be in the range [0,$PIPELINE_NUM_SOURCES).
PIPELINE_PRIMARY_SOURCE_#
A colon seperated list of files which make up the primary file sequence of a source
node, where (#) is replaced by the index of the source. The index will be
in the range [0,$PIPELINE_NUM_SOURCES).
PIPELINE_NUM_SECONDARY_SOURCES_#
The number of secondary file sequences associated with each source node, where
(#) is replaced by the index of the source.
PIPELINE_SECONDARY_SOURCE_#_#
A colon seperated list of files which make up the secondary file sequence of a
source node, where the first (#) is replaced by the index of the source and the
second (#) is replaced by the index of the secondary file sequence. The first index
will be in the range [0,$PIPELINE_NUM_SOURCES). The second index will be in the
range [0,$PIPELINE_NUM_SECONDARY_SOURCES_#).
Note that some of these variables may not be defined if there are no secondary file
sequences or node dependencies.
For new development, we would recommend using the Python Action
instead of this Action for the best multi-platform support. Although you could provide
a Python script to this Action as its Script source node, passing job prep information
through the environment is less elegant than the dynamic module approach used by the
Python Action plugin.
us.temerity.pipeline.Named