Page Comparison

...

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

@calc

...

Provides utility functions inside a pipeline expression for simple calculations of lists.
You can access the functions declared here in the PEL using <code>@calc</code>
Note: This is a public interface. Methods exposed here can be accessed by external developers in the pipelines!

...

bigdecimal - The sum of the given list.

Parameters

Example

@calc.sum(list)  

...

bigdecimal - The calculated AVG.

Parameters

Example

@calc.avg(list)  

...

bigdecimal - The rounded value as BigDecimal.

Parameters

Example

@calc.round(value,scale,mode)  

...

bigdecimal - The rounded value as BigDecimal.

Parameters

Example

@calc.roundUp(value,scale)  

...

bigdecimal - The rounded value as BigDecimal.

Parameters

Example

@calc.roundDown(value,scale)  

...

contentcollection - A content collection with given uris.

Parameters

Example

@content.newCollection(uris)  

...

icontent - The new content object.

Parameters

Example

@content.newContent(uri)  

...

icontent - The content object.

Parameters

Example

@content.fromBase64(base64String)  

...

icontent - The content object.

Parameters

Example

@content.fromBase64(base64String,name)  

...

icontent - The content object.

Parameters

Example

@content.fromBase64(base64String,name,contentType)  

...

icontent - The content object.

Parameters

Example

@content.from(object,contentType,contentEncoding,name)  

...

icontent - The content object.

Parameters

Example

@content.from(object,name)  

...

icontent - The content object.

Parameters

Example

@content.from(object)  

...

string - The encoded string.

Parameters

Example

@convert.toBase64(value)  

...

string - The decoded string.

Parameters

Example

@convert.fromBase64(base64String)  

...

byte[] - The decoded string as byte array.

Parameters

Example

@convert.fromBase64ToBytes(base64String)  

...

jsonnode - The resulting JSON.

Parameters

Example

@convert.toJson(object)  

...

string - The resulting XML string.

Parameters

Example

@convert.toXMLString(object)  

...

document - The resulting DOM tree.

Parameters

Example

@convert.toDOM(object)  

...

map - The converted map structure or null in case input was null.

Parameters

Example

@convert.toMap(object)  

...

object - The converted map or list structure or null in case input was null.

Parameters

Example

@convert.toMapOrList(o)  

...

object - The lazy uri map.

Parameters

Example

@convert.lazy(uri)  

...

long - The converted long value or null in case the input was null.

Parameters

Example

@convert.toLong(value)  

...

integer - The converted integer value or null in case the input was null.

Parameters

Example

@convert.toInteger(value)  

...

boolean - The converted boolean value.

Parameters

Example

@convert.toBoolean(value)  

...

double - The decimal number as double.

Parameters

Example

@convert.toDecimal(value)  

...

bigdecimal - The value as decimal number ready for calculations.

Parameters

Example

@convert.toDecimal(value,decimalSymbol)  

...

bigdecimal - The value as decimal number ready for calculations.

Parameters

Example

@convert.toDecimal(value,pattern,decimalSymbol)  

...

string - The decimal string.

Parameters

Example

@convert.toDecimalString(value,pattern,decimalSymbol)  

...

string - The decimal string.

Parameters

Example

@convert.toDecimalString(value,decimalSymbol)  

...

byte[] - The byte array.

Parameters

Example

@convert.toByteArray(object)  

...

object - The data object with value set at the specific path.

Parameters

Example

@data.set(data,path,value)  

...

object - The map like data structure with the new entry added.

Parameters

Example

@data.put(map,key,value)  

...

object - The extracted data.

Parameters

Example

@data.select(input,selections)  

...

list<integer> - A list of given size filled-up with digits.

Parameters

Example

@data.integerList(startInt,endInt)  

...

long - The size of the value. Returns a size of 0 in case the input value is null or cannot be counted.

Parameters

Example

@data.size(value)  

...

boolean - true in case the given list is null or empty.

Parameters

Example

@data.isEmpty(data)  

...

boolean - true in case the data object has given attribute.

Parameters

Example

@data.has(data,attribute)  

...

object - The value from given data with given attribute name.

Parameters

Example

@data.get(data,attribute)  

...

list<string> - The list of key of this object.

Parameters

Example

@data.keys(data)  

...

string - The type of the data. Never null.

Parameters

Example

@data.type(data)  

...

boolean - True in case the given data is of given type.

Parameters

Example

@data.isType(data,type)  

...

boolean - true, if data is an array.

Parameters

Example

@data.isArray(data)  

...

boolean - true, if data is a boolean.

Parameters

Example

@data.isBoolean(data)  

...

boolean - true, if data is a number.

Parameters

Example

@data.isNumber(data)  

...

boolean - true, if data is an object.

Parameters

Example

@data.isObject(data)  

...

boolean - true, if data is a string.

Parameters

Example

@data.isString(data)  

...

boolean - true, if data is null.

Parameters

Example

@data.isNull(data)  

...

string - A formatted date time string.

Parameters

Example

@date.now(format)  

...

string - The formatted date time string.

Parameters

Example

@date.now(zoneId,locale)  

...

string - The formatted date time string.

Parameters

Example

@date.guessAndFormat(dateTimeString,outputFormat)  

...

string - The formatted date time string.

Parameters

Example

@date.format(inputDate,inputFormat,outputFormat)  

...

string - The formatted date time string.

Parameters

Example

@date.format(iso8601Date,format)  

...

string - The formatted date time string.

Parameters

Example

@date.format(timestamp,format)  

...

string - The guessed year from the given string like 2012 for example.

Parameters

Example

@date.year(dateString)  

...

boolean - true, if the given amount of time is already expired.

Parameters

Example

@date.isExpired(iso8601Start,iso8601End,expiredInPercents)  

...

boolean - true, if the given amount of time is already expired.

Parameters

Example

@date.isExpired(iso8601Start,iso8601End,expiredInPercents,currentDate)  

...

boolean - true in case the give current date is overdue.

Parameters

Example

@date.isOverdue(dueDate,currentDate)  

...

boolean - true in case the give current date is overdue.

Parameters

Example

@date.isOverdue(dueDate)  

...

instant - The instant parsed from the given date time object.

Parameters

Example

@date.parseToInstant(dateTime)  

...

long - The beginning of the year relative to current year as epoch millis,
with hours, minutes, seconds and millis reset to 0.

Parameters

Example

@date.beginOfYear(yearOffset)  

...

long - The beginning of the year relative to given timestamp as epoch millis,
with hours, minutes, seconds and millis reset to 0.

Parameters

Example

@date.beginOfYear(timestamp,yearOffset)  

...

long - The beginning of the month relative to current month as epoch millis,
with hours, minutes, seconds and millis reset to 0.

Parameters

Example

@date.beginOfMonth(monthOffset)  

...

long - The beginning of the month relative to given timestamp as epoch millis,
with hours, minutes, seconds and millis reset to 0.

Parameters

Example

@date.beginOfMonth(timestamp,monthOffset)  

...

long - The beginning of the week relative to current week as epoch millis,
with hours, seconds and millis reset to 0.

Parameters

Example

@date.beginOfWeek(weekStartDay,weekOffset)  

...

long - The beginning of the week relative to given timestamp as epoch millis, with hours, seconds
and millis reset to 0.

Parameters

Example

@date.beginOfWeek(timestamp,weekStartDay,weekOffset)  

...

long - The beginning of the day relative to given current day as epoch millis,
with hours, seconds and millis reset to 0.

Parameters

Example

@date.beginOfDay(dayOffset)  

...

long - The beginning of the day relative to given timestamp as epoch millis,
with hours, seconds and millis reset to 0.

Parameters

Example

@date.beginOfDay(timestamp,dayOffset)  

...

jsonnode - The result of the function in PIPEFORCE result format.

Parameters

Example

@function.run(name,args)  

...

string - The hash as hex string

Parameters

Example

@hash.sha256(input)  

...

string - The hash as hex string

Parameters

Example

@hash.sha256Concat(separator,text)  

...

string - The hash as hex string

Parameters

Example

@hash.sha256Concat(separator,text)  

...

string - The hash as hex string

Parameters

Example

@hash.md5(input)  

...

string - The hash as hex string

Parameters

Example

@hash.md5Concat(separator,text)  

...

string - The hash as hex string

Parameters

Example

@hash.md5Concat(separator,text)  

...

string - The hash as hex string

Parameters

Example

@hash.sha512(input)  

...

string - The hash as hex string

Parameters

Example

@hash.sha512Concat(separator,text)  

...

string - The hash as hex string

Parameters

Example

@hash.sha512Concat(separator,text)  

...

user - The user with given uuid or null.

Parameters

Example

@iam.userByUuid(userUuid)  

...

user - The user with given username or null.

Parameters

Example

@iam.userByUsername(username)  

...

user - The user with given email or null.

Parameters

Example

@iam.userByEmail(email)  

...

string - The value of the environment variable or null in case it doesn't exist or is not allowed to be accessed.

Parameters

Example

@instance.env(name)  

...

string - The full url of the service.

Parameters

Example

@instance.url(serviceName)  

...

boolean - true, in case at least one profile name from given list matches with a profile of the instance.

Parameters

Example

@instance.hasProfile(profiles)  

...

string - The given image name prefixed with the default repo.
Or the default repo prefix alone in case no image arg was given.

Parameters

Example

@instance.defaultImageRepo(image)  

...

jsonnode - The content data behind the source, converted to a JSONful data object.

Parameters

Example

@json.load(source)  

...

object - The result from the JsonPath query.

Parameters

Example

@json.path(json,query)  

...

string - The JSON string.

Parameters

Example

@json.stringify(json)  

...

object - The first element from list or null in case list is null or empty.

Parameters

Example

@list.first(value)  

...

object - The last element from list or null in case list is null or empty.

Parameters

Example

@list.last(value)  

...

int - The size of the list. 0 in case list is null or unknown type.

Parameters

Example

@list.size(list)  

...

boolean - true in case the given list is null or empty.

Parameters

Example

@list.empty(list)  

...

object - The sublist.

Parameters

Example

@list.sublist(value,expression)  

...

collection - The input list with new element or a new list in case the input list was unmodifiable.

Parameters

Example

@list.add(list,element)  

...

collection - The input list with new element or a new list in case the input list was unmodifiable.

Parameters

Example

@list.add(list,element,ignoreNulls)  

...

boolean - True if list contains at least one of needle items.

Parameters

Example

@list.contains(list,needles)  

...

list - A new, modifiable list with items copied over from given list.

Parameters

Example

@list.copy(list)  

...

string - The joined path items as a path string.

Parameters

Example

@path.join(pathItems)  

...

string - The extension of the path without period (for example: txt)

Parameters

Example

@path.extension(path)  

...

string - The base name of the path.

Parameters

Example

@path.basename(path)  

...

object - The value of the property with given key or null in case property doesnt exist or has null value.

Parameters

Example

@property.value(key)  

...

list<object> - A list of values of all properties matching the given key pattern.

Parameters

Example

@property.values(pattern)  

...

Updates the value of a property under given key.

Returns

void

Parameters

Example

@property.updateValue(key,value)  

...

property - The property with given key or null in case no such property has been found.

Parameters

Example

@property.get(key)  

...

object - The lazy map.

Parameters

Example

@property.lazy(key)  

...

object - The object representation of the uri.

Parameters

Example

@resolve.uri(uri)  

...

@script

...

Provides utility functions inside a pipeline expression for simple calculations of listsexecute inline scripts.
You can access the functions declared here in the PEL using <code>@calc<<code>@script</code>

...

groovy(

...

script,args)

Converts Evaluates the given text value to upper casegroovy script.

Returns

string object - The upper case textevaluation result.

Parameters

Example

@text@script.upperCasegroovy(textscript,args)  

...

groovy(

...

script)

Returns the index of last occurrence of needle in Evaluates the given textgroovy script.

Returns

int - The index of needle inside text or -1 in case it was not found or input was nullobject - The evaluation result.

Parameters

Example

@script.groovy(script)  

@text

...

Provides utility functions inside a pipeline expression for simple calculations of lists.
You can access the functions declared here in the PEL using <code>@calc</code>

upperCase(text)

Converts the given text value to upper case.

Returns

string - The upper case text.

Parameters

Example

@text.lastIndexOfupperCase(text,needle)  

lastIndexOf(text,needle

...

)

Returns the index of last occurrence of needle in the given text.

Returns

int - The index of needle inside text or -1 in case it was not found or input was null.

Parameters

Example

@text.lastIndexOf(text,needle,offset)  

...

lastIndexOf(text,needle,offset)

Returns the index of the first last occurrence of needle in the given text.

Returns

int - The index of first occurrence of needle inside text or -1 in case it was not found or input was null.

Parameters

Example

@text.indexOflastIndexOf(text,needle,offset)  

indexOf(text,needle

...

)

Returns the index of the first occurrence of needle in the given text.

Returns

int - The index of first occurrence of needle inside text or -1 in case it was not found or input was null.

Parameters

Example

@text.indexOf(text,needle)  

indexOf(text,needle,offset)

Returns the index of the first occurrence of needle in the given text.

Returns

int - The index of first occurrence of needle inside text or -1 in case it was not found or input was null.

Parameters

Example

@text.indexOf(text,needle,offset)  

...

Returns the part from the beginning of the given text up to the stop word.
For example "Foo Bar" with stop word of " " would return "Foo" as prefix.

Returns

string - The part of text up to the first occurrence of the stop word.

Parameters

Example

@text.prefix(text,stop)  

...

Returns the part from the stop word of the given text up to the end of the word.
For example "Foo Bar" with stop word of " " would return "Bar" as suffix.

Returns

string - The part of text from stop word up to end of the text.

Parameters

Example

@text.suffix(text,stop)  

...

Converts the given text value to lower case.

Returns

string - The lower case text.

Parameters

Example

@text.lowerCase(text)  

...

Returns true if given text is empty or null.

Returns

boolean - true, in case the given text is an empty string or null.

Parameters

Example

@text.isEmpty(text)  

...

Shorts the given string and adds ... at the end.

Returns

string - The shortened text.

Parameters

Example

@text.shorten(text,length)  

...

Returns the len of the given text. In case the text is null, 0 is returned.

Returns

int - The length of the text.

Parameters

Example

@text.length(text)  

...

Checks whether given text contains at least one of given needle texts, ignoring case.
Also value and text can be null.

Returns

boolean - true in case text contains needle.

Parameters

Example

@text.contains(text,needles)  

...

Tries to detect the language of given text.

Returns

string - The detected language, one of: GERMAN, ENGLISH, FRENCH, UNKNOWN.

Parameters

Example

@text.lang(text)  

...

Creates a random alphanumeric string of given size. Characters will be used from
a set of Latin alphabetic characters (a-z, A-Z) and the digits 0-9. No special chars.

Returns

string - The random string.

Parameters

Example

@text.random(size)  

...

Creates a new uuid with 32 digits and returns it as hexadecimal string.
For example: 66a637cc-19fc-4145-98c5-1a1b0bf010be
See RFC for specification: https://datatracker.ietf.org/doc/html/rfc4122

Returns

string - The new random uuid.

Example

@text.uuid()  

toHtml(text)

Converts the given text to an HTML fragment. Replaces &, gt and lt signs, keeps line breaks
and converts links to href elements.

Returns

string - The HTML result.

Parameters

Example

@text.toHtml(text)  

...

Appends the given text to the given base text.
If one of the parts is null or empty, returns the other part only, without "null" concatenation.

Returns

string - basetext + text

Parameters

Example

@text.append(basetext,text)  

...

Concatenates the given list of objects using the given separator.
Ignores null items.

Returns

string - The concatenated items as a string.

Parameters

Example

@text.concat(separator,collection)  

...

Treats the given items as a list of texts and concats these items using the given separator.
Ignores null items.

Returns

string - The concatenated items as a string.

Parameters

Example

@text.concat(separator,items)  

...

Same as #concat(separator, items) but with comma as default separator.

Returns

string - The comma separated string of concatenated items.

Parameters

Example

@text.commajoin(collection)  

format(pattern,args)

Formats the given text using the given pattern and input args.

Returns

string - The formatted string.

Parameters

Example

@text.format(pattern,args)  

leftPad(text,size)

Left pad a text with spaces (' ').
The text is padded to the size of size.
StringUtils.leftPad(null, *) = null
StringUtils.leftPad("", 3) = " "
StringUtils.leftPad("bat", 3) = "bat"
StringUtils.leftPad("bat", 5) = " bat"
StringUtils.leftPad("bat", 1) = "bat"
StringUtils.leftPad("bat", -1) = "bat"

Returns

string - The padded string.

Parameters

Example

@text.leftPad(text,size)  

leftPad(text,size,padChar)

Left pad a text with a specified character.
Pad to a size of size.
StringUtils.leftPad(null, *, *) = null
StringUtils.leftPad("", 3, 'z') = "zzz"
StringUtils.leftPad("bat", 3, 'z') = "bat"
StringUtils.leftPad("bat", 5, 'z') = "zzbat"
StringUtils.leftPad("bat", 1, 'z') = "bat"
StringUtils.leftPad("bat", -1, 'z') = "bat"

Returns

string - The padded string.

Parameters

Example

@text.leftPad(text,size,padChar)  

rightPad(text,size)

Right pad a text with spaces (' ').
The test is padded to the size of size.
StringUtils.rightPad(null, *) = null
StringUtils.rightPad("", 3) = " "
StringUtils.rightPad("bat", 3) = "bat"
StringUtils.rightPad("bat", 5) = "bat "
StringUtils.rightPad("bat", 1) = "bat"
StringUtils.rightPad("bat", -1) = "bat"

Returns

string - The padded string.

Parameters

Example

@text.rightPad(text,size)  

rightPad(text,size,padChar)

Right pad a text with a specified character.
The text is padded to the size of size.
StringUtils.rightPad(null, *, *) = null
StringUtils.rightPad("", 3, 'z') = "zzz"
StringUtils.rightPad("bat", 3, 'z') = "bat"
StringUtils.rightPad("bat", 5, 'z') = "batzz"
StringUtils.rightPad("bat", 1, 'z') = "bat"
StringUtils.rightPad("bat", -1, 'z') = "bat"

Returns

string - The padded string.

Parameters

Example

@text.commajoin(collectionrightPad(text,size,padChar)  

concatAndFormat(separator,collection,pel)

Similar to #concat(text1, Object...) but additionally applies the given PEL expression on
each list entry before it gets concatenated. This is useful for example to convert each entry in
the list before adding it to the resulting string. For example to remove whitespaces on each entry.

Returns

string - The concatenated string.

Parameters

Example

@text.concatAndFormat(separator,collection,pel)  

...

Tests the given text whether it starts with given prefix.

Returns

boolean - true if given text starts with the second parameter provided

Parameters

Example

@text.startsWith(text,prefix)  

...

Replace all occurrences of a needle text with replacement text.

Returns

string - The text with replacements applied.

Parameters

Example

@text.replaceAll(text,needle,replacement)  

...

Returns a substring from the given text,
starting at beginIndex up to the end of the text.

Returns

string - The substring from given text, null in case text is null or empty string in
case text contains no such substring range.

Parameters

Example

@text.substring(text,beginIndex)  

...

Returns a substring from the given text,
starting at beginIndex up to endIndex.

Returns

string - The substring from given text or empty string in case text contains no such substring range.

Parameters

Example

@text.substring(text,beginIndex,endIndex)  

...

Removes any leading and ending whitespaces.

Returns

string - The text with leading and ending whitespaces removed.
If input text was null, null is returned here.

Parameters

Example

@text.trim(text)  

...

Returns true, if all of the given string values is empty: Is null, contains no characters or whitespaces only.
If at least one of it is not empty, returns false.

Returns

boolean - True, if all are empty.

Parameters

Example

@text.isAllEmpty(text)  

...

Converts the given text string into a string which contains only the
chars 0-9,a-z,A-Z and _. The conversion rule is:
Umlauts will become their non-umlaut representation. For example ä
becomes ae.
Any other special characters become underscore. For example ? becomes
_.

Returns

string - The converted text or null in case input was null.

Parameters

Example

@text.toAlphaNumeric(text)  

...

Makes the first char of the given text to upper case.

Returns

string - The text with first char to upper case or null in case input was null.

Parameters

Example

@text.firstCharUpper(text)  

...

Makes the first char of the given text to lower case.

Returns

string - The text with first char to lower case or null in case input was null.

Parameters

Example

@text.firstCharLower(text)  

...

Splits the given text into a list of items by given split token.

Returns

list<string> - A list of split items or empty list in case input text or input token is null or empty.

Parameters

Example

@text.split(text,token)  

replaceCharAt(text,pos,c)

Replaces the character at given position in the text and returns the new text.

Returns

string - The new text with replaced char.

Parameters

Example

@text.replaceCharAt(text,pos,c)  

matches(text,regexp)

Searches text for first regexp match.

Returns

list<string> - On success, list with at least one item is returned. At index 0 the whole matched string is placed, and
then from index 1, all regexp capturing groups are listed.
An empty list is returned when no match.

Parameters

Example

@text.matches(text,regexp)  

...

Returns a String value for a CSV column enclosed in double quotes, if required.
If the value contains a comma, newline or double quote, then the String value is returned enclosed in double quotes.
Any double quote characters in the value are escaped with another double quote.
If the value does not contain a comma, newline or double quote, then the String value is returned unchanged.

Returns

string - value embeddable into csv column

Parameters

Example

@text.escapeCsvValue(value)  

...

Note: This function is deprecated. Use @resolve.uri instead.

Returns

object - The object representation of the uri.

Parameters

Example

@uri.resolve(uri)  

...

Returns the username of the currently logged-in user.

Returns

string - The username of the user.

Example

@user.username()  

...

Returns the uuid of the logged-in user.

Returns

string - The uuid of the user.

Example

@user.uuid()  

hasPermission(permissionKeys)

Returns true in case the logged-in user has at least one of the listed permission.

Returns

boolean - true in case the currently logged-in user has the permisson.

Parameters

Example

@user.hasPermission(permissionKeys)  

...

Returns the default display name of the logged-in user which is the first non-empty value of:
firstName lastName, email, uuid. Note: Doesn't return the username for security reasons.

Returns

string - The display name.

Example

@user.displayName()  

...

Returns the email and default display name of the given user object or empty string if
no such value exists.

Returns

string - The email and display name in the format email@domain.tld (FirstName LastName).

Parameters

Example

@user.emailAndDisplayName(object)  

...

Returns the email and default display name of the currently logged-in user object or empty string if
no such value exists.

Returns

string - The email and display name in the format email@domain.tld (FirstName LastName).

Example

@user.emailAndDisplayName()  

...

Tries to dynamically create a meaningful display name out of the given user object.
This user object can be of different format. The method tries to
automatically detect it and creates the displayName from it. If this
was not possible for some reason, an empty string is returned.

Returns

string - The display name.

Parameters

Example

@user.displayName(object)  

...

Returns the primary email address of the currently logged-in user.

Returns

string - The email address as string.

Example

@user.email()  

email(object)

Tries to detect the email from the given object.

Returns

string - The email address as string.

Parameters

Example

@user.email(object)  

...

Returns the locale of the logged in user or null in case not set or could not be determined.

Returns

string - The lower case locale (for example: de, en, fr, ...)

Example

@user.locale()  

firstName()

Returns the first name of the logged in user.

Returns

string - The first name.

Example

@user.firstName()  

...

Returns the last name of the logged in user

Returns

string - The last name.

Example

@user.lastName()  

...

Returns true in case the current user is authenticated (logged-in).

Returns

boolean - true, in case authenticated.

Example

@user.loggedIn()  

...

Returns the preferred zoneId of the currently logged-in user or null in case none was set.
The preferred zone is usually set in the users profile or by the client in use (e.g. the browser).
See {@link ZoneId#getAvailableZoneIds()} and here: http://www.iana.org/time-zones

Returns

string - The zone as string.

Example

@user.zone()  

@xml

...

Evaluates given XPath expression of given document and returns the result as a list of DOM nodes.

Returns

list - The result of the applied expression as a list of DOM nodes.

Parameters

Example

@xml.xpath(document,xpath)  

...

Evaluates given XPath expression of given document and returns the result as a text value.

Returns

string - The result of the applied expression as text.

Parameters

Example

@xml.xpathAsText(document,xpath)  

...