Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this Page

Table of Contents
maxLevel2
excludeAdditional Resources|Related Links|Related Information

args

DescriptionA map containing the Pipeline parameters
Syntax


Code Block
pipe.args[args]


Example

Expression: pipe.args

Result: Name/value pairs of all pipeline parameters


Expression: pipe.args["user"]

Result: Returns the value for the Pipeline parameter "user".

...

DescriptionIndicates whether this is a normal execution or a Pipeline validation in Designer.
Syntax


Code Block
pipe.flags.is_suggest


Example

Expression: pipe.flags.is_suggest

Result: true

hostname

DescriptionThe hostname of the host running the Pipeline.
Syntax


Code Block
pipe.hostname


Example

Expression: pipe.hostname

Result: The hostname where the Snaplex is running the Pipeline.

instanceId

DescriptionThe UUID of the Pipeline.
Syntax


Code Block
pipe.instanceId


Example

Expression: pipe.instanceId

Result: The alphanumeric ID for the Pipeline in the form of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, such as 1df92262-6d8a-4be9-bd0f-904e3d54f091

...

DescriptionThe runtime Universal Unique Identifier of the Pipeline.
Syntax


Code Block
pipe.ruuid


Example

Expression: pipe.ruuid

Result: The Pipeline runtime ID is 61 characters in length.

startTime

DescriptionThe start time of the Pipeline.
Syntax


Code Block
pipe.startTime


Example

Expression: pipe.startTime

Result: 2017-02-22T20:56:54.142 UTC


Anchor
taskstart
taskstart
task.start

Description

The start time for a Scheduled Task, Triggered Task, and Ultra Pipeline Task. You enter this expression in the Expression field of a Snap, and the result is displayed on the Extra Details tab of the Pipeline Execution Statistics window. If you manually initiate the Task in Designer, then the task.start result is the starting time of the Pipeline, and the task.end result is an arbitrary date far in the future: (for example, 2999-12-31:11:59).

Syntax


Code Block
task.start


Example

Expression: task.start

Result: Returns the start time and date for the Task: 2019-11-09T11:00:00


Anchor
taskend
taskend
task.end

Description

The end time and date for a Scheduled Task. You enter this expression in the Expression field of a Snap, and the result is displayed on the Extra Details tab of the Pipeline Execution Statistics window.

Info
titleEnd Dates for Triggered Tasks and Ultra Pipeline Tasks

For Triggered Tasks and Tasks created from Ultra Pipelines, this expression generates a result, but the end date is always some future date, since with both of these Task types the end date is undefinable.


Syntax


Code Block
task.end


Example

Expression: task.end

Result: Returns the end time and date for the Task: 2019-11-09T12:00:00


...