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 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 Pipeline parameter "user".

flags.is_suggest

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 pipelinePipeline.
Syntax


Code Block
pipe.hostname


Example

Expression: pipe.hostname

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

instanceId

DescriptionThe UUID of the pipelinePipeline.
Syntax


Code Block
pipe.instanceId


Example

Expression: pipe.instanceId

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

...

DescriptionThe label of the pipelinePipeline. If used in a child pipelineChild Pipeline, it will return the child pipeline Child Pipeline information, not the parent level.
Syntax  


Code Block
pipe.label


Example

Expression: pipe.label

Result: Returns the name of the Pipeline

Note

The pipe.label expression does not utilize the user-defined execution label specified in the snap's configuration while executing the Pipeline Execute Snap. Instead, it returns the actual label of the child pipeline being executed.


parentRuuid

DescriptionThe runtime UUID of the parent pipelinePipeline. In a Child Pipeline execution, the parent ruuid refers to the ruuid of the Parent Pipeline execution.
Syntax


Code Block
pipe.parentRuuid


Example

Expression: pipe.parentRuuid

Result:

  • If no parent, it returns null.
  • If the pipeline Pipeline was started by a ForEach SnapPipeline Execute Snap, it returns the runtime uuid
    of the parent pipeline.the Parent Pipeline.

pipe.tmpDir

Description

A file URI 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. Ensure 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


Code Block
pipe.tmpDir


Example

Expression: pipe.tmpDir

Result: ://yourdiskspace


plexPath

Description

The path of the Snaplex. Select the pipe.plexpath to get the path of current Snaplex.

Syntax


Code Block
pipe.plexPath


Example

Expression: pipe.plexPath

Result: /snaplogic/shared/cloud-dev

...

DescriptionThe path to the pipelinePipeline's project in SLFS.
Syntax


Code Block
pipe.projectPath


Example

Expression: pipe.projectPath

Result: /orgname/projects/projectname


rootRuuid

DescriptionThe 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


Code Block
pipe.rootRuuid


Example

Expression: pipe.rootRuuid

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


ruuid

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 pipelinePipeline.
Syntax


Code Block
pipe.startTime


Example

Expression: pipe.startTime

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

...

DescriptionThe ID of the user that executed the Pipeline.
Syntax


Code Block
pipe.user


Example

Expression: pipe.user

Result: user@example.com

flags.is_suggest

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

See Also

...