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 |
---|
...
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
...
type | info |
---|
...
. |
...
...
Joins 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
...
type | note |
---|
...
. |
...
...
The CONCAT function is identical to the JOIN function.
Examples
Suppose a model containing the following 4 attributes.
...
...
MATCH
...
MATCH | Compares |
...
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) |
...
. |
...
Return type
- boolean
Examples
If the attribute File.name is of base type string and its value is “Thisfile_1.doc” then
- MATCH(“Thisfile_1.doc”, File.name) results in TRUE
- MATCH(File.name, ”Thisfile_1.doc”) results in TRUE
- MATCH(” Thisfile_1.doc”, File.name) results in FALSE
- MATCH(“thisfile_1.doc”, File.name) results in FALSE
- MATCH(“[A-Z]hisfile_1.doc”, File.name) results in TRUE
- MATCH(“[a-z]hisfile_1.doc”, File.name) results in FALSE
- MATCH(“Thisfile_[0-9].doc”, File.name) results in TRUE
- MATCH("..............", File.name) results in TRUE
- MATCH(".*", File.name) results in TRUE
- MATCH("**", "**") results in an error message, because "**" is not a valid regular expression
FIND
...
FIND | Looks for a string pattern within another string and returns the first matching characters. The function is case-sensitive |
...
Syntax
Code Block |
---|
FIND(pattern, attribute) |
- 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.
- attribute - An attribute of base type string or an expression that results in a string.
Return type
- string
Examples
If File.name is an attribute of base type string with value “Thisfile_1.doc”, then:
...
...
. |
...
...
...
...
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
UI Text Box | ||
---|---|---|
| ||
If you prefer a functional syntax, you can use the STR_FRONT( string, integer ) function. Example: STR_FRONT("Blueriq", 3) = "Blu" |
Examples
If File.name is an attribute of base type string with value “Thisfile_1.doc” and the integer attribute File.prefix has value 8 then:
- FIRST File.prefix CHARACTERS OF File.name results in “Thisfile”
- FIRST CHARACTER OF File.name results in “T”
Example
...
UI Text Box | ||
---|---|---|
| ||
use a combination of FIRST and LAST to retrieve a subset from inside a string. |
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
...
type | note |
---|
...
. |
...
Examples
If File.name is an attribute of base type string with value “Thisfile_1.doc” and the integer attribute File.extension has value 3 then:
- LAST File.extension CHARACTERS OF File.name results in “doc”
- LAST CHARACTER OF File.name results in “c”
Example
- FIRST 2 CHARACTERS OF (LAST 6 CHARACTERS OF “pieceofcake”) results in “of”
- LAST 3 CHARACTERS OF (FIRST 4 CHARACTERS OF “what's in a name”) results in “hat”
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
- LENGTH( "Blueriq" ) = 7
- LENGTH( " Blueriq " ) = 9
- LENGTH( ? ) = ?
UPPER
. | |
UPPERCASE | Returns |
...
a string with all characters in uppercase |
...
Syntax
Code Block |
---|
UPPER ( string ) |
...
. |
...
Return type
- string
Example
...
UPPER( "hello" ) = "HELLO"
...
...
UPPER( "hello world " ) = "HELLO WORLD "
...
UPPER( " hELLo " ) = " HELLO "
...
LOWERCASE | Returns |
LOWER
...
a string with all characters in lowercase |
...
. | |
CAPITALIZE | Returns |
Syntax
Code Block |
---|
LOWER ( string ) |
- string - An attribute of base type string, an expression that results in a string or a constant string value.
Return type
- string
Example
- LOWER( "hello" ) = "hello"
- LOWER( "WORLD" ) = "world"
- LOWER( "Hello World " ) = "hello world "
- LOWER( " hELLo " ) = " hello "
- LOWER( ? ) = ?
CAPITALIZE
...
a string with the first character uppercased |
...
Syntax
Code Block |
---|
CAPITALIZE ( string )
CAPITALIZE ( string, lowerTheRest ) |
- string - An attribute of base type string, an expression that results in a string or a constant string value.
- lowerTheRest - An attribute of base type boolean, an expression that results in a boolean or a constant boolean value, indicating that the other characters need to be lowercased. This parameter is optional and if it is not supplied, the other characters are left untouched.
Return type
- string
Example
...
...
CAPITALIZE( "WORLD" ) = "WORLD"
...
CAPITALIZE( "hello world " ) = "Hello world "
CAPITALIZE( " hELLo " ) = " hELLo "
...
type | note |
---|
...
. |
...
...
CAPITALIZE( "WORLD" , TRUE ) = "World"
...
...
...
CAPITALIZE( " hello " , TRUE ) = " hELLo "
UI Text Box | ||
---|---|---|
| ||
The input string is not trimmed, so in this case the first character is a space. |
...
TRIM | Strips |
TRIM
...
the leading and trailing spaces from |
...
Syntax
Code Block |
---|
TRIM ( string ) |
...
a |
...
string |
...
. |
...
Return type
- string
Example
...
...
...
...
Returns the index of the first occurrence of a specified |
...
Syntax
Code Block |
---|
INDEXOF ( string , substring )
INDEXOF ( string , substring , startIndex ) |
...
substring |
...
in a string |
...
. |
...
LASTINDEXOF | Returns |
Return type
- integer - the index of the first occurrence of the specified substring or -1 if it is not found
Example
- INDEXOF( "Hello world" , "o" ) = 4
- INDEXOF( "Hello world" , "o" , 5 ) = 7
- INDEXOF( "Hello world" , "a" ) = -1
- INDEXOF( "Hello world" , "o" , 8 ) = -1
LASTINDEXOF
...
the index of the last occurrence of a specified substring in a string |
...
Syntax
Code Block |
---|
LASTINDEXOF ( string , substring )
LASTINDEXOF ( string , substring , startIndex ) |
...
...
. |
...
...
Return type
- integer - the index of the last occurrence of the specified substring or -1 if it is not found
Example
...
...
...
...
Returns 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.
Return type
- string
Example
- SUBSTRING( "Hello world" , 1 ) = "ello world"
- SUBSTRING( "Hello world" , 1 , 5 ) = "ello"
- SUBSTRING( "Hello world" , 0 ) = "Hello world"
- SUBSTRING( "Hello world" , 0 , LENGTH( "Hello world" ) ) = "Hello world"
SPLIT
. | |
SUBSTRING BEFORE | Returns the start of a given string before the first occurrence of substring, or an empty string if substring is not found. |
SUBSTRING AFTER | Returns the end of a given string after the first occurrence of substring, or an empty string if substring is not found. |
SPLIT | Returns a multivalued string |
...
attribute containing every substring that is delimited by the given pattern. |
Syntax
Code Block |
---|
SPLIT ( string , pattern ) |
- string - An attribute of base type string, an expression that results in a string or a constant string value.
- 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.
Return type
- string (multivalue)
Example
...
...
...
REPLACE | Replaces every occurrence of a string pattern within another string with a provided replacement string. The function is case-sensitive. |
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 | ||||
---|---|---|---|---|
|