Pipeline Functions and Properties
In this Page
args
| Description | A map containing the Pipeline parameters |
|---|---|
| Syntax | 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". |
flags.is_suggest
| Description | Indicates whether this is a normal execution or a Pipeline validation in Designer. |
|---|---|
| Syntax | pipe.flags.is_suggest |
| Example | Expression: pipe.flags.is_suggest Result: true |
hostname
| Description | The hostname of the host running the Pipeline. |
|---|---|
| Syntax | pipe.hostname |
| Example | Expression: pipe.hostname Result: The hostname where the Snaplex is running the Pipeline. |
instanceId
| Description | The UUID of the Pipeline. |
|---|---|
| Syntax | 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 |
label
| Description | The label of the Pipeline. If used in a Child Pipeline, it will return the Child Pipeline information, not the parent level. |
|---|---|
| Syntax | pipe.label |
| Example | Expression: pipe.label Result: Returns the name of the Pipeline |
parentRuuid
| Description | The runtime UUID of the parent Pipeline. In a Child Pipeline execution, the parent ruuid refers to the ruuid of the Parent Pipeline execution. |
|---|---|
| Syntax | pipe.parentRuuid |
| Example | Expression: pipe.parentRuuid Result:
|
pipe.tmpDir
| Description | A file URI that refers to the temporary directory on the local disk that can be used to store temporary files needed for a Pipeline run. The directory can be accessed using Snaps that accept a URI, like a FileWriter or FileReader, but is not created by default. Make sure that any Snaps used to write files are configured to create intermediate directories. After the Pipeline execution is complete, the contents written to the directory are deleted. |
|---|---|
| Syntax | pipe.tmpDir |
| Example | Expression: pipe.tmpDir Result: |
plexPath
| Description | The path of the Snaplex. Select the pipe.plexpath to get the path of current Snaplex. |
|---|---|
| Syntax | pipe.plexPath |
| Example | Expression: pipe.plexPath Result: /snaplogic/shared/cloud-dev |
projectPath
| Description | The path to the Pipeline's project in SLFS. |
|---|---|
| Syntax | pipe.projectPath |
| Example | Expression: pipe.projectPath Result: /orgname/projects/projectname |
rootRuuid
| Description | The root runtime UUID refers to the top-level execution that is started by a Task or by a user in Designer. It is available in all descendant executions if you need a single ID that is globally available. Use the Pipeline Execute Snap to invoke Child Pipelines. |
|---|---|
| Syntax | pipe.rootRuuid |
| Example | Expression: pipe.rootRuuid Result: The Pipeline runtime ID is 61 characters in length. |
ruuid
| Description | The runtime Universal Unique Identifier of the Pipeline. |
|---|---|
| Syntax | pipe.ruuid |
| Example | Expression: pipe.ruuid Result: The Pipeline runtime ID is 61 characters in length. |
startTime
| Description | The start time of the Pipeline. |
|---|---|
| Syntax | pipe.startTime |
| Example | Expression: pipe.startTime Result: 2017-02-22T20:56:54.142 UTC |
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 | task.start |
| Example | Expression: task.start Result: Returns the start time and date for the Task: |
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. End 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 | task.end |
| Example | Expression: task.end Result: Returns the end time and date for the Task: |
user
| Description | The ID of the user that executed the Pipeline. |
|---|---|
| Syntax | pipe.user |
| Example | Expression: pipe.user Result: user@example.com |