Pipeline Functions and Properties

Pipeline functions and properties that can be used in expressions to access pipeline metadata and runtime information.

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

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

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:

    • If no parent, it returns null.
    • If the Pipeline was started by a Pipeline Execute Snap, it returns the runtime uuid of 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:

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:

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

user

Description: The ID of the user that executed the Pipeline.

Syntax:

pipe.user

Example: