Skip to main content

Built-In Functions

Since Version: 3.0

Inside a Pipeline Expression you can access a huge library of functions, which can additionaly simplify your integration and automation tasks. Such utility functions are called Built-In Functions. See the reference docs for a full list of all available functions. If you're missing a function there, please drop a note.

Usage

Such a function is always embedded inside a Pipeline Expression and has a structure like this:

@group.function(args...)

Whereas you need to replace group by the util group name, function by the function method name and args by the optional arguments to the function you would like to execute.

Examples for @date

Here is an example to return the current date using such a function without any argument:

@date.now()

And here a fully working example, embedded inside a Pipeline Expression:

pipeline:  
- log:
message: "The current date is: #{@date.now()}"

Examples for @list

vars:
cities: "Munich, Bratislava, New York"
pipeline:
- log:
message: "#{@list.size(vars.cities)}"

Output:

3

Examples for @text

pipeline:
- log:
message: "#{@text.lang('Hallo, Herr Meier!')}"

Output:

GERMAN

Auto-completion

In case you're working with the Online Workbench you can get auto-completion of all Pipeline Functions out-of-the-box:

Report an Issue

Your help is needed!

In case you're missing something on this page, you found an error or you have an idea for improvement, please click here to create a new issue. Another way to contribute is, to click Edit this page below and directly add your changes in GitHub. Many thanks for your contribution in order to improve PIPEFORCE!