Skip to main content

Built-In Functions Reference

Reference documentation of Built-In Pipeline Expression Language (PEL) Functions.

Example usage of the @date function inside a PEL expression :

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

Use the online workbench to get auto-completion for Pipeline Functions:

@calc


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

sum(list)

Does a "nice" sum the values of the given list with high precision. If an item in the given list is a string, it will be tried to convert it to a number. If the value is null or cannot be converted it will be excluded from the summary but no exception is thrown -> be nice.

Returns

bigdecimal - The sum of the given list.

Parameters

NameTypeDescription
listobjectThe list of numbers to sum-up.

Example

@calc.sum(list)  

avg(list)

Calculates the average on the value of given list with a precision of two decimal points.

Returns

bigdecimal - The calculated AVG.

Parameters

NameTypeDescription
listobjectThe list of numbers.

Example

@calc.avg(list)  

round(value,scale,mode)

Rounds input to scale number of digits. Multiple rounding strategies can be applied.

Returns

bigdecimal - The rounded value as BigDecimal.

Parameters

NameTypeDescription
valueobjectThe value to round. BigDecimal, double, float, integer and long are supported.
scaleintegerThe scale to round to. Positive value scales in fraction part, negative in integer.
modestringOne of UP, DOWN, CEILING, FLOOR, HALF_UP, HALF_DOWN, HALF_EVEN, UNNECESSARY can be used. For details see https://docs.oracle.com/javase/7/docs/api/java/math/RoundingMode.html

Example

@calc.round(value,scale,mode)  

roundUp(value,scale)

Rounds input to scale number of digits up. See also {@link CalcFunctions#round(Object, Integer, String)} for more options.

Returns

bigdecimal - The rounded value as BigDecimal.

Parameters

NameTypeDescription
valueobjectThe value to round. BigDecimal, double, float, integer and long are supported.
scaleintegerThe scale to round to. Positive value scales in fraction part, negative in integer.

Example

@calc.roundUp(value,scale)  

roundDown(value,scale)

Rounds input to scale number of digits down. See also {@link CalcFunctions#round(Object, Integer, String)} for more options.

Returns

bigdecimal - The rounded value as BigDecimal.

Parameters

NameTypeDescription
valueobjectThe value to round. BigDecimal, double, float, integer and long are supported.
scaleintegerThe scale to round to. Positive value scales in fraction part, negative in integer.

Example

@calc.roundDown(value,scale)  

@content


Provides utility functions inside a pipeline expression for creation and managing of content objects.
You can access the functions declared here in the PEL using @content

newCollection(uris)

Creates a new content collection and initializes it with given uris.

Returns

contentcollection - A content collection with given uris.

Parameters

NameTypeDescription
urisstringThe list of content uris to add to the new collection.

Example

@content.newCollection(uris)  

newCollection()

Creates a new, empty content collection at given location.

Returns

contentcollection - The new, empty content collection.

Example

@content.newCollection()  

newContent(uri)

Creates a new uri content object and returns it.

Returns

icontent - The new content object.

Parameters

NameTypeDescription
uristringThe uri to be used for the content object

Example

@content.newContent(uri)  

@convert


Provides utility functions inside a pipeline expression for simple conversion and encoding tasks.
You can access the functions declared here in the PEL using @convert

toBase64(value)

Encodes the given value to base64. If value is not a text, it will be converted to a text before conversion.

Returns

string - The encoded string.

Parameters

NameTypeDescription
valueobjectThe value to encode.

Example

@convert.toBase64(value)  

fromBase64(base64String)

Decodes the given base64 encoded string.

Returns

string - The decoded string.

Parameters

NameTypeDescription
base64StringstringThe base64 encoded string.

Example

@convert.fromBase64(base64String)  

fromBase64ToBytes(base64String)

Decodes the given base64 encoded string.

Returns

byte[] - The decoded string as byte array.

Parameters

NameTypeDescription
base64StringstringThe base64 encoded string.

Example

@convert.fromBase64ToBytes(base64String)  

toJson(object)

Converts a given object structure to JSON.

Returns

jsonnode - The resulting JSON.

Parameters

NameTypeDescription
objectobjectThe object to convert.

Example

@convert.toJson(object)  

toXMLString(object)

Converts a given object to an XML string.

Returns

string - The resulting XML string.

Parameters

NameTypeDescription
objectobjectThe object to convert.

Example

@convert.toXMLString(object)  

toDOM(object)

Converts a given object to an XML DOM representation.

Returns

document - The resulting DOM tree.

Parameters

NameTypeDescription
objectobjectThe object to convert.

Example

@convert.toDOM(object)  

toMap(object)

Converts the given object to a map structure.

Returns

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

Parameters

NameTypeDescription
objectobjectThe object to convert to a map structure.

Example

@convert.toMap(object)  

toMapOrList(o)

Converts the given object to a map or list structure depending on which is more appropriate.

Returns

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

Parameters

NameTypeDescription
oobjectThe object to convert to a map or list structure.

Example

@convert.toMapOrList(o)  

lazy(uri)

Converts all supported uri variants to LazyUriMap

Returns

object - The lazy uri map.

Parameters

NameTypeDescription
uristringThe uri to load from.

Example

@convert.lazy(uri)  

toLong(value)

Converts the given value to a long value. If input value is the boolean true or false, 1 or 0 as long is returned. If input is the string "true" or "false, 1 or 0 as long is returned. If input is empty string "", 0 is returned.

Returns

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

Parameters

NameTypeDescription
valueobjectThe value object to convert to long.

Example

@convert.toLong(value)  

toInteger(value)

Converts the given value to a long value. If input value is the boolean true or false, 1 or 0 as int is returned. If input is the string "true" or "false, 1 or 0 as int is returned. If input is empty string "", 0 is returned.

Returns

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

Parameters

NameTypeDescription
valueobjectThe value object to convert to integer.

Example

@convert.toInteger(value)  

toBoolean(value)

Converts the given value to a boolean value. If input is the string "true" or "false, true or false as boolean is returned. If input is empty string "", false is returned. If input is null, false is returned. Any numeric value > 0, true is returned. Any numeric value <= 0, false is returned.

Returns

boolean - The converted boolean value.

Parameters

NameTypeDescription
valueobjectThe value object to convert to boolean.

Example

@convert.toBoolean(value)  

toDecimal(value)

Converts the given value into a big decimal with given precision.

Returns

double - The decimal number as double.

Parameters

NameTypeDescription
valueobjectThe value to convert.

Example

@convert.toDecimal(value)  

toDecimal(value,decimalSymbol)

Converts the given value to a decimal number.

Returns

bigdecimal - The value as decimal number ready for calculations.

Parameters

NameTypeDescription
valueobjectThe value to convert to decimal.
decimalSymbolstringThe decimal symbol to be used. Can be a comma , a dot . or a locale tag like de, en, fr for example. If null or empty, the locale tag of the currently logged-in user is used. If this is null, locale tag de is used as default.

Example

@convert.toDecimal(value,decimalSymbol)  

toDecimal(value,pattern,decimalSymbol)

Converts the given value to a decimal number by applying the given pattern and locale.

Returns

bigdecimal - The value as decimal number ready for calculations.

Parameters

NameTypeDescription
valueobjectThe value to convert to decimal.
patternstringThe decimal pattern to apply. For example: #.###
decimalSymbolstringThe decimal symbol to be used. Can be a comma , a dot . or a locale tag like de, en, fr for example. If null or empty, the locale tag of the currently logged-in user is used. If this is null, locale tag de is used as default.

Example

@convert.toDecimal(value,pattern,decimalSymbol)  

toDecimalString(value,pattern,decimalSymbol)

Formats a given number to a decimal string using the given decimal pattern and locale tag like de, en, fr aso.

Returns

string - The decimal string.

Parameters

NameTypeDescription
valueobjectThe decimal number to format to a string.
patternstringThe decimal pattern like #.## for example.
decimalSymbolstringThe decimal symbol to be used. Can be a comma , a dot . or a locale tag like de, en, fr for example. If null or empty, the locale tag of the currently logged-in user is used. If this is null, locale tag de is used as default.

Example

@convert.toDecimalString(value,pattern,decimalSymbol)  

toDecimalString(value,decimalSymbol)

Formats a given number to a decimal string using the given locale tag like de, en, fr aso.

Returns

string - The decimal string.

Parameters

NameTypeDescription
valueobjectThe decimal number to format to a string.
decimalSymbolstringThe decimal symbol to be used. Can be a comma , a dot . or a locale tag like de, en, fr for example. If null or empty, the locale tag of the currently logged-in user is used. If this is null, locale tag de is used as default.

Example

@convert.toDecimalString(value,decimalSymbol)  

@data


Provides utility functions inside a pipeline expression for simple CRUD and transformation data operations.
You can access the functions declared here in the PEL using @data

set(data,path,value)

Sets the given value on the given data object at the given element path where every item is separated by a dot. If an item at the given path doesnt exist, it will be created automatically (is supported by given object). For example to create a new entry person.name inside a given map, you could use:

set(someMap, "person.name", "Some Name"). This will create the nested map person with an entry of type name in it.

Returns

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

Parameters

NameTypeDescription
dataobjectThe data object.
pathstringThe path inside the data object to set the value.
valueobjectThe value to set.

Example

@data.set(data,path,value)  

put(map,key,value)

Expects the given data to be map-like structure and puts the given value under given key to it. Overwrites any existing entry under this key.

Returns

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

Parameters

NameTypeDescription
mapobjectThe map-like data structure.
keyobjectThe key to add the value under.
valueobjectThe value to add.

Example

@data.put(map,key,value)  

select(input,selections)

Applies the given selection string on the given input object in order to extract data from the input object. If there is more than one selection string, puts the result of each string into a new map entry whereas the key is the selection string or the name from the "AS NAME" suffix (note the upper case AS). Examples of selection strings:

  • 'person.firstName' = Extracts the firstName from the input object and returns the result as a entry in the mapping using the key 'person.firstName'. If it is the only selection string, returns the value directly.
  • 'person.firstName AS name' = Extracts the firstName from the input object and returns the result as a entry in the mapping using the key 'name'
  • 'person.hobbies.size()' = Extracts the number of hobbies from the input object and returns the result as a entry in the mapping using the key 'person.hobbies.size()'. If it is the only selection string, returns the value directly.
  • 'person.hobbies.size() AS numOfHobbies' = Extracts the number of hobbies from the input object and returns the result as an entry in the mapping using the key 'numOfHobbies'

Returns

object - The extracted data.

Parameters

NameTypeDescription
inputobjectThe input to apply the selection strings on. May not be null.
selectionsstringOne or more selection strings. If null or empty, returns an empty map.

Example

@data.select(input,selections)  

integerList(startInt,endInt)

Creates a new list and fills it with integers from startIndex up to endIndex. For example a call of createListWithIntegers(2, 5) would return a list with these entries: [2,3,4,5].

Returns

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

Parameters

NameTypeDescription
startIntintThe start index to fill the list.
endIntintThe end index to fill the list up to.

Example

@data.integerList(startInt,endInt)  

size(value)

Calculates the size of the given value regardless of the type it is.

Returns

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

Parameters

NameTypeDescription
valueobjectThe value to count for size.

Example

@data.size(value)  

isEmpty(data)

Checks if given data structure is null or empty. For example:

  • If it is a list, returns true in case the list contains no entry or is null.
  • If it is a map, returns true in case the map contains no entry or is null.
  • If it is a node, returns true in case the node contains no entry or is null.
  • If it is a string, returns true in case the string contains no chars or is null.

Returns

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

Parameters

NameTypeDescription
dataobjectThe data structure to check.

Example

@data.isEmpty(data)  

has(data,attribute)

Checks whether given data object has an attribute, member or getter with given name.

Returns

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

Parameters

NameTypeDescription
dataobjectThe data object to scan for attribute.
attributestringThe attribute name to search for.

Example

@data.has(data,attribute)  

@date


Provides utility functions inside a pipeline expression for simple date and time handling.
You can access the functions declared here in the PEL using @date

now()

Returns the current time at server side formatted using the preferred zone and locale of the currently logged-in user.

Returns

string - A formatted date time string.

Example

@date.now()  

nowIso8601()

Returns the current time at server side formatted using the ISO8601 time format.

Returns

string - Current date and time formatted as ISO8601. For example: 2021-05-30T17:30:00+02:00

Example

@date.nowIso8601()  

now(format)

Returns the current time at server side formatted using the preferred zone and locale of the currently logged-in user.

Returns

string - A formatted date time string.

Parameters

NameTypeDescription
formatstringThe format pattern like dd.MM.YY HH:mm:ss for example.

Example

@date.now(format)  

now(zoneId,locale)

Returns the current time for the given zone and formats it using the default format of the given locale.

Returns

string - The formatted date time string.

Parameters

NameTypeDescription
zoneIdstringThe zoneId to be used. See http://www.iana.org/time-zones for official reference of these names.
localestringThe locale to be used.

Example

@date.now(zoneId,locale)  

guessAndFormat(dateTimeString,outputFormat)

Tries to guess the given date time string format, converts it internally to a date-time object and formats it finally to a string output using the given output format pattern.

Returns

string - The formatted date time string.

Parameters

NameTypeDescription
dateTimeStringstringThe date-time string as input.
outputFormatstringThe output format pattern.

Example

@date.guessAndFormat(dateTimeString,outputFormat)  

format(inputDate,inputFormat,outputFormat)

Converts a given date string using the given inputFormat and converts it to the given outputFormat.

Returns

string - The formatted date time string.

Parameters

NameTypeDescription
inputDatestringThe input date string.
inputFormatstringThe input format pattern.
outputFormatstringThe output format pattern.

Example

@date.format(inputDate,inputFormat,outputFormat)  

format(iso8601Date,format)

Converts a given ISO-8061 date string to a different format and returns it. For example: An input date of "2030-01-10T20:00:00Z" with format of "dd.MM.yyyy" would result in "01.10.2030".

Returns

string - The formatted date time string.

Parameters

NameTypeDescription
iso8601DatestringThe ISO-8061 formatted date to convert.
formatstringThe format pattern.

Example

@date.format(iso8601Date,format)  

format(timestamp,format)

Converts a given unix timestamp to a formatted date time string and returns it.

Returns

string - The formatted date time string.

Parameters

NameTypeDescription
timestamplongThe unix timestamp in millis to format.
formatstringThe format pattern.

Example

@date.format(timestamp,format)  

year(dateString)

Tries to guess and extract the year of the given date string. This is not always working 100% since the date formats can vary a lot.

Returns

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

Parameters

NameTypeDescription
dateStringstringA date string like 31.02.2012, 31.02.12, 2012/01/31, 31-01-12, 31-01-2012, 2012-01-31 23:59:59, or 2001-07-04T12:08:56.235-0700.

Example

@date.year(dateString)  

timestamp()

Returns the current unix timestamp in millis.

Returns

long - The current timestamp in millis.

Example

@date.timestamp()  

isExpired(iso8601Start,iso8601End,expiredInPercents)

Returns true, if the given amount of time is already expired. Lets see this example: Given is a starttime of 1st January, 2020 an endttime of 11th January, 2020 and an expiredInPercents of 0,7 (70%). In this case the method would return true on 9th of January, 2020 but false on 3rd of January, 2020. Also see {@link DateTimeUtil#isExpired(Instant, Instant, float)}.

Returns

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

Parameters

NameTypeDescription
iso8601StartobjectThe start time for the time range in ISO-8601 format.
iso8601EndobjectThe endtime for the time range in ISO-8601 format.
expiredInPercentsfloatThe percentage as float (e.g. 0,9 = 90%), the range is already expired.

Example

@date.isExpired(iso8601Start,iso8601End,expiredInPercents)  

isExpired(iso8601Start,iso8601End,expiredInPercents,currentDate)

Returns true, if the given amount of time is already expired. Lets see this example: Given is a starttime of 1st January, 2020 an endttime of 11th January, 2020 and an expiredInPercents of 0,7 (70%). In this case the method would return true on 9th of January, 2020 but false on 3rd of January, 2020. Also see {@link DateTimeUtil#isExpired(Instant, Instant, float)}.

Returns

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

Parameters

NameTypeDescription
iso8601StartobjectThe start time for the time range in ISO-8601 format.
iso8601EndobjectThe endtime for the time range in ISO-8601 format.
expiredInPercentsfloatThe percentage as float (e.g. 0,9 = 90%), the range is already expired.
currentDateobjectThe current date, the calculation must use.

Example

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

isOverdue(dueDate,currentDate)

Returns true in case if dueDate > currentDate.

Returns

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

Parameters

NameTypeDescription
dueDateobjectThe due after overdue is true.
currentDateobjectThe current date.

Example

@date.isOverdue(dueDate,currentDate)  

isOverdue(dueDate)

Returns true in case if dueDate > currentDate. For currentDate the current date and time from the system is used.

Returns

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

Parameters

NameTypeDescription
dueDateobjectThe due after overdue is true.

Example

@date.isOverdue(dueDate)  

parseToInstant(dateTime)

Parses the given date time object to an instant date time object.

Returns

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

Parameters

NameTypeDescription
dateTimeobjectThe date time object to be parsed.

Example

@date.parseToInstant(dateTime)  

beginOfYear(yearOffset)

Returns the epoch timestamp in millis of the beginning of the year relative to current year with respect of the user's preference for time zone. For example to get the timestamp of the beginning of the current year, you would set yearOffset=0. To get the beginning timestamp of last year, you would set yearOffset=-1. To get the beginning timestamp of next year, you would set yearOffset=1.

Returns

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

Parameters

NameTypeDescription
yearOffsetintThe years to be added (positive value) or subtracted (negative value) from current year.

Example

@date.beginOfYear(yearOffset)  

beginOfYear(timestamp,yearOffset)

Returns the epoch timestamp in millis of the beginning of the year relative to given timestamp with respect of the user's preference for time zone. For example to get the timestamp of the beginning of the current year, you would set timestamp=null, yearOffset=0. To get the beginning timestamp of last year, you would set timestamp=null, yearOffset=-1. To get the beginning timestamp of next year, you would set timestamp=null, yearOffset=1.

Returns

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

Parameters

NameTypeDescription
timestamplongThe epoch millis to calculate the beginning of the year from. If null, the current timestamp will be used.
yearOffsetintThe years to be added (positive value) or subtracted (negative value) from given year.

Example

@date.beginOfYear(timestamp,yearOffset)  

beginOfMonth(monthOffset)

Returns the epoch timestamp in millis of the beginning of the month relative to current month with respect of the user's preference for time zone. For example to get the timestamp of the beginning of the current month, you would set monthOffset=0. To get the beginning timestamp of last month, you would set monthOffset=-1. To get the beginning timestamp of next month, you would set monthOffset=1.

Returns

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

Parameters

NameTypeDescription
monthOffsetintThe months to be added (positive value) or subtracted (negative value) from current month.

Example

@date.beginOfMonth(monthOffset)  

beginOfMonth(timestamp,monthOffset)

Returns the epoch timestamp in millis of the beginning of the month relative to given timestamp with respect of the user's preference for time zone. For example to get the timestamp of the beginning of the current month, you would set timestamp=null, monthOffset=0. To get the beginning timestamp of last month, you would set timestamp=null, monthOffset=-1. To get the beginning timestamp of next month, you would set timestamp=null, monthOffset=1.

Returns

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

Parameters

NameTypeDescription
timestamplongThe epoch millis to calculate the beginning of the month from. If null, the current timestamp will be used.
monthOffsetintThe months to be added (positive value) or subtracted (negative value) from given month.

Example

@date.beginOfMonth(timestamp,monthOffset)  

beginOfWeek(weekStartDay,weekOffset)

Returns the epoch timestamp in millis of the beginning of the week relative to current week with respect of the user's preference for time zone. For example to get the timestamp of the beginning of the current week with Monday as start day, you would set weekStartDay=1, weekOffset=0. To get the beginning timestamp of last week, you would set weekStartDay=1, weekOffset=-1. To get the beginning timestamp of next week, you would set weekStartDay=1, weekOffset=1.

Returns

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

Parameters

NameTypeDescription
weekStartDayintegerThe start day of the week as int from Monday(1) to Sunday(7). If null or negative, Monday(1) is used.
weekOffsetintThe weeks to be added (positive value) or subtracted (negative value) from current week.

Example

@date.beginOfWeek(weekStartDay,weekOffset)  

beginOfWeek(timestamp,weekStartDay,weekOffset)

Returns the epoch timestamp in millis of the beginning of the week relative to given timestamp with respect of the user's preference for time zone. For example to get the timestamp of the beginning of the current week with Monday as start day, you would set timestamp=null, weekStartDay=null, weekOffset=0. To get the beginning timestamp of last week, you would set timestamp=null, weekStartDay=null, weekOffset=-1. To get the beginning timestamp of next week, you would set timestamp=null, weekStartDay=null, weekOffset=1.

Returns

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

Parameters

NameTypeDescription
timestamplongThe epoch millis to calculate the beginning of the week from. If null, the current timestamp will be used.
weekStartDayintegerThe start day of the week as int from Monday(1) to Sunday(7). If null or negative, Monday(1) is used.
weekOffsetintThe weeks to be added (positive value) or subtracted (negative value) from given week. If you would like to know the start date of the week before for example, you would set this to -1. And for two weeks before you would set it to -2, aso. And to detect the beginning of the week of the given timestamp, you would set it to 0.

Example

@date.beginOfWeek(timestamp,weekStartDay,weekOffset)  

beginOfDay(dayOffset)

Returns the epoch timestamp in millis of the beginning of the day relative to current day with respect of the user's preference for time zone. For example to get the timestamp of the beginning of the current day, you would set dayOffset=0. To get the beginning timestamp of yesterday, you would set dayOffset=-1. To get the beginning timestamp of tomorrow, you would set dayOffset=1.

Returns

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

Parameters

NameTypeDescription
dayOffsetintThe days to be added (positive value) or subtracted (negative value) from current day.

Example

@date.beginOfDay(dayOffset)  

beginOfDay(timestamp,dayOffset)

Returns the epoch timestamp in millis of the beginning of the day relative to given timestamp with respect of the user's preference for time zone. For example to get the timestamp of the beginning of the current day, you would set timestamp=null, dayOffset=0. To get the beginning timestamp of yesterday, you would set timestamp=null, dayOffset=-1. To get the beginning timestamp of tomorrow, you would set timestamp=null, dayOffset=1.

Returns

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

Parameters

NameTypeDescription
timestamplongThe epoch millis to calculate the beginning of the day from. If null, the current timestamp will be used.
dayOffsetintThe days to be added (positive value) or subtracted (negative value) from given day.

Example

@date.beginOfDay(timestamp,dayOffset)  

@hash


Provides utility functions inside a pipeline expression for simple hash handling.
You can access the functions declared here in the PEL using @hash

sha256(input)

Creates the SHA-256 hash from given input and returns it as hex string.

Returns

string - The hash as hex string

Parameters

NameTypeDescription
inputobjectThe input data to create a hash from. Can be a string, a byte array or a collection of strings.

Example

@hash.sha256(input)  

sha256Concat(separator,text)

Concatenates the given list of strings using the given separator and then calculates the hash SHA-256 of the concatenated string.

Returns

string - The hash as hex string

Parameters

NameTypeDescription
separatorstringThe separator to be used to concat the string. If null, empty string will be used.
textstringThe text (list) to concat into a string.

Example

@hash.sha256Concat(separator,text)  

sha256Concat(separator,text)

Concatenates the given list of strings using the given separator and then calculates the hash SHA-256 of the concatenated string.

Returns

string - The hash as hex string

Parameters

NameTypeDescription
separatorstringThe separator to be used to concat the string. If null, empty string will be used.
textcollectionThe text (list) to concat into a string.

Example

@hash.sha256Concat(separator,text)  

md5(input)

Creates the MD5 hash from given input and returns it as hex string.

Returns

string - The hash as hex string

Parameters

NameTypeDescription
inputobjectThe input data to create a hash from. Can be a string, a byte array or a collection of strings.

Example

@hash.md5(input)  

md5Concat(separator,text)

Concatenates the given list of strings using the given separator and then calculates the hash MD5 of the concatenated string.

Returns

string - The hash as hex string

Parameters

NameTypeDescription
separatorstringThe separator to be used to concat the string. If null, empty string will be used.
textstringThe text (list) to concat into a string.

Example

@hash.md5Concat(separator,text)  

md5Concat(separator,text)

Concatenates the given list of strings using the given separator and then calculates the hash MD5 of the concatenated string.

Returns

string - The hash as hex string

Parameters

NameTypeDescription
separatorstringThe separator to be used to concat the string. If null, empty string will be used.
textcollectionThe text (list) to concat into a string.

Example

@hash.md5Concat(separator,text)  

sha512(input)

Creates the SHA-512 hash from given input and returns it as hex string.

Returns

string - The hash as hex string

Parameters

NameTypeDescription
inputobjectThe input data to create a hash from. Can be a string, a byte array or a collection of strings.

Example

@hash.sha512(input)  

sha512Concat(separator,text)

Concatenates the given list of strings using the given separator and then calculates the hash SHA-512 of the concatenated string.

Returns

string - The hash as hex string

Parameters

NameTypeDescription
separatorstringThe separator to be used to concat the string. If null, empty string will be used.
textstringThe text (list) to concat into a string.

Example

@hash.sha512Concat(separator,text)  

sha512Concat(separator,text)

Concatenates the given list of strings using the given separator and then calculates the hash SHA-512 of the concatenated string.

Returns

string - The hash as hex string

Parameters

NameTypeDescription
separatorstringThe separator to be used to concat the string. If null, empty string will be used.
textcollectionThe text (list) to concat into a string.

Example

@hash.sha512Concat(separator,text)  

@iam


Provides utility functions inside a pipeline expression for accessing IAM information.
You can access the functions declared here in the PEL using @iam

userByUuid(userUuid)

Returns the user by given uuid or null in case no such user exists.

Returns

user - The user with given uuid or null.

Parameters

NameTypeDescription
userUuidstringThe uuid of the user.

Example

@iam.userByUuid(userUuid)  

userByUsername(username)

Returns the user by given username or null in case no such user exists.

Returns

user - The user with given username or null.

Parameters

NameTypeDescription
usernamestringThe username of the user.

Example

@iam.userByUsername(username)  

userByEmail(email)

Returns the user by given email or null in case no such user exists.

Returns

user - The user with given email or null.

Parameters

NameTypeDescription
emailstringThe email of the user.

Example

@iam.userByEmail(email)  

@instance


Provides utility functions inside a pipeline expression to return information about the current instance.
You can access the functions declared here in the PEL using @instance

domain()

Returns the domain, this hub instance is currently running in. For example: pipeforce.net

Returns

string - The domain name of this instance.

Example

@instance.domain()  

namespace()

Returns the namespace, this hub instance is currently running in. For example: latest

Returns

string - The namespace of this instance.

Example

@instance.namespace()  

url(serviceName)

Returns the full url for a given service in the current namespace. For example: a call with 'workflow' could return 'http://workflow-myamespace.pipeforce.net' depending on the namespace and domain configured for this instance.

Returns

string - The full url of the service.

Parameters

NameTypeDescription
serviceNamestringThe PIPEFORCE service name.

Example

@instance.url(serviceName)  

url()

Returns the base url of the instance. For example: https://acme.pipeforce.net.

Returns

string - The base url of this instance.

Example

@instance.url()  

profiles()

The active profiles this instance is tagged with to run as.

Returns

list<string> - The active profiles as a list or empty list. Never null.

Example

@instance.profiles()  

hasProfile(profiles)

Checks if this instance contains at least one profile from the given list.

Returns

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

Parameters

NameTypeDescription
profilesobjectAn array or comma separated list of profiles to check.

Example

@instance.hasProfile(profiles)  

stage()

Returns the stage the instance is running in.

Returns

string - The stage. Usually this is one of local, dev, qa, prod.

Example

@instance.stage()  

version()

Returns the version number of this instance.

Returns

string - The version number.

Example

@instance.version()  

build()

Returns the build ID of this instance.

Returns

string - The build ID.

Example

@instance.build()  

edition()

Returns edition of this instance.

Returns

string - The edition name.

Example

@instance.edition()  

storage()

Returns the storage info reserved for this instance (hub service).

Returns

string - The storage for the hub service.

Example

@instance.storage()  

tag()

Returns the full build tag of this instance.

Returns

string - The full build tag.

Example

@instance.tag()  

uptime()

Returns the uptime of this instance. Note: Since PIPEFORCE is a clustered environment, update of a single hub service and the cluster could differ.

Returns

long - The timestamp, when this instance was started (hub service).

Example

@instance.uptime()  

defaultImageRepo(image)

Prefixes the given image by the path of the default container image repository. When running inside GKE this is typically: gcr.io/pipeforce/[image]

Returns

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

Parameters

NameTypeDescription
imagestringThe image name to be prefixed by the repo.

Example

@instance.defaultImageRepo(image)  

@json


Provides functions inside a pipeline expression in order to read and change JSON documents.
You can access the functions declared here in the PEL using @json

load(source)

Loads the given source and converts it into a JSONful data object.

Returns

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

Parameters

NameTypeDescription
sourceobjectThe JSON source to load.

Example

@json.load(source)  

path(json,query)

Applies a given JsonPath query to the given json object and returns the result. Learn more about the JsonPath syntax: https://goessner.net/articles/JsonPath/

Returns

object - The result from the JsonPath query.

Parameters

NameTypeDescription
jsonobjectThe JSON object to apply the query to.
querystringThe query to be applied.

Example

@json.path(json,query)  

stringify(json)

Converts the given JSON or map object into a JSON string.

Returns

string - The JSON string.

Parameters

NameTypeDescription
jsonobjectThe JSON object to be converted to a string.

Example

@json.stringify(json)  

@list


Provides utility functions inside a pipeline expression for simple lists handling.
You can access the functions declared here in the PEL using @list

first(value)

Returns the first element in list.

Returns

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

Parameters

NameTypeDescription
valueobjectAny supported list object.

Example

@list.first(value)  

last(value)

Returns the last element in list.

Returns

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

Parameters

NameTypeDescription
valueobjectAny supported list object.

Example

@list.last(value)  

size(list)

Returns the size of the given list. DEPRECATED. Use @data.size(...) instead.

Returns

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

Parameters

NameTypeDescription
listobjectThe list.

Example

@list.size(list)  

empty(list)

Checks if given list is null or empty. DEPRECATED. Use @data.isEmpty(...) instead.

Returns

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

Parameters

NameTypeDescription
listobjectThe list to check.

Example

@list.empty(list)  

sublist(value,expression)

Utility to get a subset from a list using a list expression. Examples:

  • last - Returns the last element in the list.
  • first - Returns the first element in the list.
  • START:END - Returns all elements as a sublist from START (inclusive) up to the given END (inclusive).
  • INDEX: - Returns all elements as a sublist from INDEX (inclusive) up to the end of the list.
  • :INDEX - Returns all elements as a sublist from 0 up to INDEX (inclusive).

Returns

object - The sublist.

Parameters

NameTypeDescription
valueobjectAny list object.
expressionstringThe list expression.

Example

@list.sublist(value,expression)  

add(list,element)

Appends the given element to the end of the given list. This method is useful in case the list implementation is not clear since this method can detect it (for example whether it is a collection or a JSON array). By default doesn't add null items.

Returns

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

Parameters

NameTypeDescription
listobjectThe list to append to.
elementobjectThe element to append.

Example

@list.add(list,element)  

add(list,element,ignoreNulls)

Appends the given element to the end of the given list. This method is useful in case the list implementation is not clear since this method can detect it (for example whether it is a collection or a JSON array).

Returns

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

Parameters

NameTypeDescription
listobjectThe list to append to.
elementobjectThe element to append.
ignoreNullsbooleanIf true, null items will not be added.

Example

@list.add(list,element,ignoreNulls)  

contains(list,needles)

Searches the given list for the given needle.

Returns

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

Parameters

NameTypeDescription
listobjectThe list to search in.
needlesobjectThe items to search for. Can also be a list of items.

Example

@list.contains(list,needles)  

create()

Creates a new empty list.

Returns

list - A new, empty, modifiable list.

Example

@list.create()  

@path


Provides utility functions inside a pipeline expression for simple path calculations.
You can access the functions declared here in the PEL using @path

join(pathItems)

Concats all given items to a single path. Also see {@link PathUtil#path(Object...)}.

Returns

string - The joined path items as a path string.

Parameters

NameTypeDescription
pathItemsobjectThe path items to join as list.

Example

@path.join(pathItems)  

extension(path)

Returns the extension of a given filename (path).

Returns

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

Parameters

NameTypeDescription
pathstringThe path string.

Example

@path.extension(path)  

basename(path)

Returns the base name of a file without the extension. Also strips-off any ID form the filename. For example: "/folder/invoice.pdf" would return "invoice" and "/folder/invoice_ID-3fgh343.pdf" would return "invoice"

Returns

string - The base name of the path.

Parameters

NameTypeDescription
pathstringThe path string.

Example

@path.basename(path)  

@property


Provides functions inside a pipeline expression in order to read properties from the property store.
You can access the functions declared here in the PEL using @property

value(key)

Returns the property value by given key from the property store.

Returns

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

Parameters

NameTypeDescription
keystringThe property key

Example

@property.value(key)  

values(pattern)

Returns the values of all properties matching the given key pattern.

Returns

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

Parameters

NameTypeDescription
patternstringThe property key pattern to match.

Example

@property.values(pattern)  

updateValue(key,value)

Updates the value of a property under given key.

Returns

void

Parameters

NameTypeDescription
keystringThe key of the property to update.
valueobjectThe value of the property to update.

Example

@property.updateValue(key,value)  

get(key)

Returns the property with given key as object.

Returns

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

Parameters

NameTypeDescription
keystringThe property key.

Example

@property.get(key)  

lazy(key)

Returns the value of the property as a {@link LazyUriMap} map in case the result is a JSON document or its fragment. If uri fragment references leaf, primitive value is returned. In all other cases an exception is thrown. Fragment part of uri is evaluated as a SPEL against property value.

Returns

object - The lazy map.

Parameters

NameTypeDescription
keystringThe property key with optional fragment reference in form 'global/pathsegment1/pathsegment...#fragment'

Example

@property.lazy(key)  

@text


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

upperCase(text)

Converts the given text value to upper case.

Returns

string - The upper case text.

Parameters

NameTypeDescription
textobjectThe text to convert.

Example

@text.upperCase(text)  

lastIndexOf(text,needle,offset)

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

NameTypeDescription
textobjectThe text to search for occurrence.
needleobjectThe text to search for.
offsetintThe index to start search from.

Example

@text.lastIndexOf(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

NameTypeDescription
textobjectThe text to search for occurrence.
needleobjectThe text to search for.

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

NameTypeDescription
textobjectThe text to search for occurrence.
needleobjectThe text to search for.
offsetintThe index to start search from.

Example

@text.indexOf(text,needle,offset)  

prefix(text,stop)

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

NameTypeDescription
textobjectThe text.
stopobjectThe stop word.

Example

@text.prefix(text,stop)  

suffix(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

NameTypeDescription
textobjectThe text.
stopobjectThe stop word.

Example

@text.suffix(text,stop)  

lowerCase(text)

Converts the given text value to lower case.

Returns

string - The lower case text.

Parameters

NameTypeDescription
textobjectThe text.

Example

@text.lowerCase(text)  

isEmpty(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

NameTypeDescription
textobjectThe text.

Example

@text.isEmpty(text)  

shorten(text,length)

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

Returns

string - The shortened text.

Parameters

NameTypeDescription
textobjectThe text to shorten.
lengthintThe length.

Example

@text.shorten(text,length)  

length(text)

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

Returns

int - The length of the text.

Parameters

NameTypeDescription
textobjectThe text.

Example

@text.length(text)  

contains(text,needles)

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

NameTypeDescription
textobjectThe text to search in.
needlesstringA comma separated list of needles to search inside text.

Example

@text.contains(text,needles)  

lang(text)

Tries to detect the language of given text.

Returns

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

Parameters

NameTypeDescription
textobjectThe text to detect the language for.

Example

@text.lang(text)  

random(size)

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

NameTypeDescription
sizeintThe length of the random string.

Example

@text.random(size)  

uuid()

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

NameTypeDescription
textobjectThe text to convert to HTML.

Example

@text.toHtml(text)  

append(basetext,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

NameTypeDescription
basetextobjectThe base text to append to.
textobjectThe text to append.

Example

@text.append(basetext,text)  

concat(separator,collection)

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

Returns

string - The concatenated items as a string.

Parameters

NameTypeDescription
separatorstringThe separator.
collectionobjectThe collection of items to concat.

Example

@text.concat(separator,collection)  

concat(separator,items)

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

NameTypeDescription
separatorstringThe separator between the items.
itemsobjectThe collection of items.

Example

@text.concat(separator,items)  

commajoin(collection)

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

Returns

string - The comma separated string of concatenated items.

Parameters

NameTypeDescription
collectionobjectThe collection of items to concatenate.

Example

@text.commajoin(collection)  

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

NameTypeDescription
separatorstringThe separator.
collectionobjectThe collection of items to concatenate.
pelstringThe pipeline expression without wrapping #{ and }

Example

@text.concatAndFormat(separator,collection,pel)  

startsWith(text,prefix)

Tests the given text whether it starts with given prefix.

Returns

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

Parameters

NameTypeDescription
textstringThe text
prefixstringThe prefix to test

Example

@text.startsWith(text,prefix)  

replaceAll(text,needle,replacement)

Replace all occurrences of a needle text with replacement text.

Returns

string - The text with replacements applied.

Parameters

NameTypeDescription
textobjectThe text to apply replacements.
needlestringThe needle text matching all replacement sources.
replacementstringThe string to be substituted for each match.

Example

@text.replaceAll(text,needle,replacement)  

substring(text,beginIndex)

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

NameTypeDescription
textobjectThe text to return substring from.
beginIndexintThe 0-based index to start the substring (inclusive).

Example

@text.substring(text,beginIndex)  

substring(text,beginIndex,endIndex)

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

NameTypeDescription
textobjectThe text to return substring from.
beginIndexintThe 0-based index to start the substring (inclusive).
endIndexintThe 0-based index to end the substring (exclusive).

Example

@text.substring(text,beginIndex,endIndex)  

trim(text)

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

NameTypeDescription
textobjectThe text to remove any whitespaces from.

Example

@text.trim(text)  

isAllEmpty(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

NameTypeDescription
textobjectThe list of text items to check.

Example

@text.isAllEmpty(text)  

toAlphaNumeric(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

NameTypeDescription
textobjectThe text to convert.

Example

@text.toAlphaNumeric(text)  

firstCharUpper(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

NameTypeDescription
textobjectThe text to change.

Example

@text.firstCharUpper(text)  

firstCharLower(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

NameTypeDescription
textobjectThe text to change.

Example

@text.firstCharLower(text)  

split(text,token)

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

NameTypeDescription
textobjectThe text to split to tokens.
tokenobjectThe token to split the text with.

Example

@text.split(text,token)  

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

NameTypeDescription
textstringto search for matches
regexpstringregular expression to use

Example

@text.matches(text,regexp)  

escapeCsvValue(value)

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

NameTypeDescription
valuestringinput text to escape

Example

@text.escapeCsvValue(value)  

@uri


Provides utility functions inside a pipeline expression for simple uri resolving.
You can access the functions declared here in the PEL using @uri

resolve(uri)

Resolves the given uri to its object representation. Supported uri schemes:

  • uri:user:Resolves to an user object.
  • uri:pipeline:Resolves the given path, pointing to a persisted pipeline, executes it and returns the body result.
  • uri:property: Resolves the given property key path and returns it from the storage.

Returns

object - The object representation of the uri.

Parameters

NameTypeDescription
uristringThe uri to be resolved.

Example

@uri.resolve(uri)  

@user


Provides utility functions inside a pipeline expression for simple handling of the currently logged-in user.
You can access the functions declared here in the PEL using @user

username()

Returns the username of the currently logged-in user.

Returns

string - The username of the user.

Example

@user.username()  

uuid()

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

NameTypeDescription
permissionKeysstringA list of permission keys (roles) to check for.

Example

@user.hasPermission(permissionKeys)  

displayName()

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()  

emailAndDisplayName(object)

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

NameTypeDescription
objectobjectThe user object to extract email and displayName from.

Example

@user.emailAndDisplayName(object)  

emailAndDisplayName()

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()  

displayName(object)

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

NameTypeDescription
objectobjectThe user object.

Example

@user.displayName(object)  

email()

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

NameTypeDescription
objectobjectAn object like a user or a JSON containing an email property.

Example

@user.email(object)  

locale()

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()  

lastName()

Returns the last name of the logged in user

Returns

string - The last name.

Example

@user.lastName()  

loggedIn()

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

Returns

boolean - true, in case authenticated.

Example

@user.loggedIn()  

zone()

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


Provides functions inside a pipeline expression in order to read and change XML documents.
You can access the functions declared here in the PEL using @xml

xpath(document,xpath)

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

NameTypeDescription
documentobjectThe document to be applied. Can be a DOM or an XML string.
xpathstringThe expression to be applied.

Example

@xml.xpath(document,xpath)  

xpathAsText(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

NameTypeDescription
documentobjectThe document to be applied. Can be a DOM or an XML string.
xpathstringThe expression to be applied.

Example

@xml.xpathAsText(document,xpath)  

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!