/
PIPEFORCE URI

PIPEFORCE URI

Since Version 6.0

What is a PIPEFORCE URI?

Whenever you need to load data from some internal or external location inside an automation pipeline or a command, a form, list or report, you can use a URI to point to such a location. You do so already by using such URIs in your web browser, for example. Common URI types you might be familiar with, are:

  • https://www.google.com

  • ftp://smith:12345@ftp.host

  • file:/data/path/contract.docx

Besides such commonly known URI types, PIPEFORCE also supports custom URI types to simplify access to common resources used internally in PIPEFORCE. Such a custom URI is called a PIPEFORCE URI.

Custom PIPEFORCE URIs typically start with an additional prefix $uri: followed by the concrete uri scheme (type).

They typically have a format like this:

$uri:<name>:<path><params>

Whereas:

  • <name> must be replaced by the type name of the URI to be used such as drive, property, pipeline or similar for example (see below). It is the implementation type of the URI.

  • <path> must be replaced by the path or value which will be passed as input value to the URI implementation.

  • <params> is optional an can contain parameters in the format ?param1=value1&param2=value2.

In most locations where a URI is accepted as an argument, for example in commands or utils, you can apply such a PIPEFORCE URI.

Here are some examples of common PIPEFORCE URIs:

URI

Description

URI

Description

$uri:drive:/someFolder/myFile.txt

Loads a file from the drive data room.

$uri:property:global/app/myapp/template/text

Loads a property from the property store and returns the value of the property plus all metadata such as uuid and created time for example.

$uri:pipeline:global/app/myapp/pipeline/hello

Executes the persisted pipeline at given location and returns the final body content as result.

$uri:pipeline:global/app/myapp/pipeline/hello?firstName=Sam&lastName=Smith

Executes the persisted pipeline at given location, passes the given parameters firstName and lastName to it and returns the final body content as result. The parameters can be accessed via the vars scope inside the pipeline.

$uri:user:admin

Returns the information object of the given user with given username.

$uri:user:uuid=260e8400-e29b-11d4-a716

  • Returns the information object of the given user with given uuid.

Here is an example to apply a custom URI on a command:

pipeline: - mails.send: to: recipient@mail.tld subject: "Hello!" message: "Hello World!" attachments: $uri:property:global/app/myapp/resources/file

As you can see in this example, the attachments argument contains a PIPEFORCE URI pointing to a property in the property store. This property will be loaded and added as an attachment.

And in this example, a PIPEFORCE URI is used inside a PEL util instead: