Page History
Learn more about text functions CONCATENATE, JOIN, MATCH, FIND, FIRST, LAST, LENGTH, UPPERCASE, LOWERCASE, CAPITALIZE, TRIM, INDEXOF, LASTINDEXOF, SUBSTRING, SUBSTRING BEFORE, SUBSTRING AFTER, SPLIT, REPLACE, EQUALS.
Overview
Function | Description |
---|
Table of Contents | ||
---|---|---|
|
...
CONCATENATE | Use the '+ ' (plus) operator to concatenate strings or a combination of strings and other type values to produce a single |
...
Syntax
Code Block |
---|
string1 + string2 + ... + value1 + ... |
...
string |
...
...
value |
...
Return type
- string
Examples
...
. |
...
...
Suppose
Person.FirstName = "Carl"
Person.LastName =
then Person.FirstName + Person.LastName
...
UI Text Box | ||
---|---|---|
| ||
Note the correct use of parenthesis in combination with concatenation, see UPPERCASE and LOWERCASE syntax. |
UI Text Box | ||
---|---|---|
| ||
There exists a |
Joins |
...
bgColor | white |
---|
JOIN
...
a series of values into one string, separated with a character of your choice |
...
Syntax
Code Block |
---|
JOIN ( argument1 , argument2 , ... , separator ) |
- argument1, argument2 - Attributes or expressions that contain the values that will be joint to a single string. JOIN works for all base types, even multivalued.
- separator - A string value that will be used as separator symbol.
Return type
- string
UI Text Box | ||
---|---|---|
| ||
an UNKNOWN value will be represented as an empty entry in the result string. |
UI Text Box | ||
---|---|---|
| ||
The |
Examples
Suppose you have a model containing the following attributes.
...
. |
...
...
MATCH | Compares |
...
bgColor | white |
---|
MATCH
...
a string pattern to another string and returns TRUE if the string exactly matches the pattern, and otherwise FALSE. The MATCH function is case-sensitive |
...
Syntax
Code Block |
---|
MATCH ( pattern , string ) |
- pattern - An attribute of base type string or a string value. String must be a valid regular expression. The regular expressions used in several Blueriq Studio functions are common Java 1.4 expressions. For a complete documentation we refer to the online java documentation.
- string - String value, attribute of base type string or an expression that results in a string value.
Return type
- boolean
Examples
...
. |
...
...
FIND | Looks |
...
bgColor | white |
---|
FIND
...
for a string pattern within another string and returns the first matching characters. The function is case-sensitive |
...
Syntax
Code Block |
---|
FIND ( pattern , string )
FIND ( pattern , string , startIndex ) |
- pattern - An attribute of base type string or a string value. String must be a valid regular expression. The regular expressions used in several Blueriq Studio functions are common Java 1.4 expressions. For a complete documentation we refer to the online java documentation.
- string - An attribute of base type string or an expression that results in a string.
- startIndex - A positive integer value indicating at which character of the string the search should start (inclusive). This can be either an attribute of base type integer, an expression that results in an integer or a constant integer value. The first character starts at index 0.
Return type
- string
Examples
...
. |
...
...
bgColor | white |
---|
...
Returns the first character(s) of a string, based on the number of characters you specify |
...
Syntax
Code Block |
---|
FIRST integer CHARACTERS OF string
FIRST CHARACTER OF string |
- integer - A positive integer value. This can be either an attribute of base type integer, an expression that results in an integer or a constant integer value. FIRST CHARACTER OF can be used to retrieve only the first character of the string.
- string - An attribute of base type string, an expression that results in a string or a constant string value.
Return type
- string
...
type | note |
---|
...
. |
...
Examples
...
bgColor | white |
---|
LAST
...
LAST | Returns the last character(s) of a string, based on the number of characters you specify. |
Syntax
Code Block |
---|
LAST integer CHARACTERS OF string
LAST CHARACTER OF string |
- integer - A positive integer value. This can be either an attribute of base type integer, an expression that results in an integer or a constant integer value. LAST CHARACTER OF can be used to retrieve only the last character of the string.
- string - An attribute of base type string, an expression that results in a string or a constant string value.
Return type
- string
UI Text Box | ||
---|---|---|
| ||
If you prefer a functional syntax, you can use the STR_BACK ( string, integer ) function. Example: STR_BACK("Blueriq", 3) = "riq" |
Examples
...
bgColor | white |
---|
LENGTH
LENGTH
returns the length of a string
Syntax
Code Block |
---|
LENGTH ( string ) |
- string - An attribute of base type string, an expression that results in a string or a constant string value.
Return type
- integer
UI Text Box | ||
---|---|---|
| ||
Spaces at the start of the end of the string are counted as well, the string is not trimmed. |
Example
...
bgColor | white |
---|
UPPERCASE
...
a string with all characters in uppercase |
...
Syntax
Code Block |
---|
UPPERCASE string |
- string - An attribute of base type string, an expression that results in a string or a constant string value.
UI Text Box | ||
---|---|---|
| ||
UPPERCASE does not have a functional syntax. This can have unexpected effects on concatenation. UPPERCASE ( "hello" ) + LOWERCASE ( " WORLD" ) is equivalent to UPPERCASE ( ( "hello" ) + LOWERCASE ( " WORLD" ) ). Use ( UPPERCASE string ) syntax to avoid this behaviour. |
Return type
- string
Example
...
bgColor | white |
---|
LOWERCASE
. | |
LOWERCASE | Returns |
...
a string with all characters in lowercase |
...
Syntax
Code Block |
---|
LOWERCASE string
|
- string - An attribute of base type string, an expression that results in a string or a constant string value.
UI Text Box | ||
---|---|---|
| ||
LOWERCASE does not have a functional syntax. This can have unexpected effects on concatenation. LOWERCASE ( "HELLO" ) + UPPERCASE ( " world" ) is equivalent to LOWERCASE ( ( "HELLO" ) + UPPERCASE ( " world" ) ). Use ( LOWERCASE string ) syntax to avoid this behaviour. |
Return type
- string
Example
. | |
CAPITALIZE | Returns |
...
bgColor | white |
---|
CAPITALIZE
...
a string with the first character uppercased |
...
Syntax
Code Block |
---|
CAPITALIZE string
CAPITALIZE ( string, lowerTheRest ) |
...
...
. |
...
Return type
- string
Example
...
...
...
...
bgColor | white |
---|
TRIM
Strips |
...
the leading and trailing spaces from a |
...
Syntax
Code Block |
---|
TRIM string |
...
string |
...
. |
...
Return type
- string
Example
...
...
...
bgColor | white |
---|
INDEXOF | Returns |
INDEXOF
...
the index of the first occurrence of a specified substring in a string. |
Syntax
Code Block |
---|
INDEXOF ( string , substring )
INDEXOF ( string , substring , startIndex ) |
- string - An attribute of base type string, an expression that results in a string or a constant string value.
- substring - An attribute of base type string, an expression that results in a string or a constant string value.
- startIndex - A (positive) integer value indicating at which character the search for the substring should start (inclusive). This can be either an attribute of base type integer, an expression that results in an integer or a constant integer value.
The first character starts at index 0.
Return type
- integer - the index of the first occurrence of the specified substring or -1 if it is not found
Example
...
LASTINDEXOF | Returns |
UI Text Box | ||
---|---|---|
| ||
There is no restriction on the value of startIndex. If it is negative, it has the same effect as if it were zero: this entire string may be searched. If it is greater than the length of this string, it has the same effect as if it were equal to the length of this string: -1 is returned. |
...
bgColor | white |
---|
LASTINDEXOF
...
the index of the last occurrence of a specified substring |
...
Syntax
Code Block |
---|
LASTINDEXOF ( string , substring )
LASTINDEXOF ( string , substring , startIndex ) |
...
in a string |
...
. |
...
...
Return type
- integer - the index of the last occurrence of the specified substring or -1 if it is not found
Example
...
...
UI Text Box | ||
---|---|---|
| ||
There is no restriction on the value of startIndex. If it is negative, it has the same effect as if it were zero: -1 is returned since there are no characters before character 0. If startIndex is greater than the length of this string, it has the same effect as if it were equal to the length of this string, so the whole string is searched. |
...
bgColor | white |
---|
SUBSTRING | Returns |
SUBSTRING
...
the substring of a given string starting from the index provided and ending at the end index if provided, or the end of the string |
...
Syntax
Code Block |
---|
SUBSTRING ( string , startIndex )
SUBSTRING ( string , startIndex , endIndex ) |
- string - An attribute of base type string, an expression that results in a string or a constant string value.
- startIndex - A positive integer value indicating at which character the substring should start (inclusive). This can be either an attribute of base type integer, an expression that results in an integer or a constant integer value. The first character starts at index 0.
- endIndex - A positive integer value indicating at which character the substring should end (exclusive). This can be either an attribute of base type integer, an expression that results in an integer or a constant integer value. The
endIndex
cannot exceed the length of the string and should be larger than the startIndex.
Return type
- string
Example
. | |
SUBSTRING BEFORE | Returns |
...
bgColor | white |
---|
SUBSTRING BEFORE
...
the start of a given string before the first occurrence of substring, or an empty string if substring is not found |
...
Syntax
Code Block |
---|
SUBSTRING BEFORE substring IN string
SUBSTRING_BEFORE ( string , substring ) |
...
. |
...
...
Return type
- string
Example
...
SUBSTRING_BEFORE ( "hello:world:all" , ":" )
...
...
bgColor | white |
---|
...
Returns the end of a given string after the first occurrence of substring, or an empty string if substring is not found |
...
Syntax
Code Block |
---|
SUBSTRING AFTER substring IN string
SUBSTRING_AFTER ( string , substring ) |
...
...
. |
...
Return type
- string
Example
...
...
...
SPLIT | Returns a multivalued string |
...
bgColor | white |
---|
SPLIT
...
attribute containing every substring that is delimited by the given pattern |
...
Syntax
Code Block |
---|
SPLIT string ON pattern
SPLIT ( string , pattern ) |
...
. |
...
...
Return type
- string (multivalued)
Example
...
...
UI Text Box | ||
---|---|---|
| ||
If you use the |
...
bgColor | white |
---|
REPLACE
...
REPLACE | Replaces every occurrence of a string pattern within another string with a provided replacement string. The function is case-sensitive. |
Syntax
Code Block |
---|
REPLACE pattern IN string WITH replacement
REPLACE ( pattern , string , replacement ) |
- pattern - An attribute of base type string or a string value. String must be a valid regular expression. The regular expressions used in several Blueriq Studio functions are common Java 1.4 expressions. For a complete documentation we refer to the online java documentation.
- string - An attribute of base type string or an expression that results in a string.
- replacement - An attribute of base type string or an expression that results in a string.
Return type
- string. If the pattern is not found, the original string is returned.
Examples
...
UI Text Box | ||
---|---|---|
| ||
The first argument is a pattern (regular expression) and can therefore contain specials like \s for a space. The second and third arguments are strings or expressions, so \s will result in \s. |
EQUALS | Compares two strings and returns TRUE if and only if they are equal. This function is case sensitive. |
Go here for more info on the Text Substitution Language (TSL) documentation.
Functions
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
...
bgColor | white |
---|
EQUALS
EQUALS
compares two strings and returns TRUE if and only if they are equal. This function is case sensitive.
UI Text Box | ||
---|---|---|
| ||
Only use this function if you need a case sensitive comparison of two strings. If you want to compare strings case insensitive, use the '=' operator instead. |
Syntax
Code Block |
---|
string1 EQUALS string2
EQUALS ( string1 , string2 ) |
- string1 - An attribute of base type string, an expression that results in a string or a constant string value.
- string2 - An attribute of base type string, an expression that results in a string or a constant string value.
Return type
- boolean
Example
...