Versions Compared

Old Version 11

changes.mady.by.user Geert Graat

Saved on

compared with

New Version Current

changes.mady.by.user Unknown User (a.jansen)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

FunctionDescription

...

CONCATENATEUse 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 + ...

...

string1 - The first string that you want to concatenate.

...

string

...

value

...

Return type

  • string

Examples

  • 12 + " kilometers" = "12 kilometers"
  • "This statement is " + TRUE + "." = "This statement is true."
  • "I was born on " + Me.birthDateAndTime + "."  (Me.birthDateAndTime = 01-12-1970 23:00:45) = "I was born on Tue Dec 01 23:00:45 CET 1970."

...

typeinfo

...

.

 

JOIN

...

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
UI Text Box
typenote
an UNKNOWN value will be represented as an empty entry in the result string.
UI Text Box
typenote

The CONCAT function is identical to the JOIN function.

Examples

Suppose you have a model containing the following attributes.

 

...

 

...

.

...

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

If the attribute File.name is of base type string and its value is "Thisfile_1.doc" then

...

MATCH( "Thisfile_1.doc" , File.name ) = TRUE

...

MATCH( File.name , "Thisfile_1.doc" ) = TRUE

...

MATCH( " Thisfile_1.doc" , File.name ) = FALSE

...

MATCH( "thisfile_1.doc" , File.name ) = FALSE

...

MATCH( "[a-z]hisfile_1.doc" , File.name ) = FALSE

...

.

...

...

FIND

...

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

...

.

...

...

string - 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:

  • FIND( "_[1-5]" , File.name ) = "_1"
  • FIND( "File" , File.name ) = UNKNOWN
  • FIND( "el" , "Hello" ) = "el"
  • FIND( "el" , "Hello" , 2 ) = UNKNOWN
  • FIND( "eo" , "Hello" ) = UNKNOWN
  • FIND( "\s[a-zA-Z]+" , "Hello world example" ) = "world"
  • FIND( "\s[a-zA-Z]+" , "Hello world example" , 6 ) = "example"

FIRST

...

FIRSTReturns 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
typenote

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 CHARACTER OF File.name = "T"

...

FIRST 5 CHARACTERS OF "pieceofcake" = "piece"
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

...

.

...

string - An attribute of base type string, an expression that results in a string or a constant string value.

Return type

...

UI Text Box
typenote

If you prefer a functional syntax, you can use the STR_BACK ( string, integer ) function. Example: STR_BACK("Blueriq", 3) = "riq"

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 = "doc"
  • LAST CHARACTER OF File.name = "c"
  • LAST 4 CHARACTERS OF "pieceofcake" = "cake"

LENGTH

LENGTHReturns

...

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
typenote

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

...

. 
UPPERCASEReturns 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 "

...

LOWERCASEReturns

LOWER

...

a string with all characters in lowercase

...

. 
CAPITALIZEReturns

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( "hello" ) = "Hello"

...

CAPITALIZE( "WORLD" ) = "WORLD"

...

CAPITALIZE( "hello world " ) = "Hello world "

CAPITALIZE( " hELLo " ) = " hELLo "

...

typenote

...

.

...

CAPITALIZE( "hello" , TRUE ) = "Hello"

...

CAPITALIZE( "WORLD" , TRUE ) = "World"

...

CAPITALIZE( "hello world " , TRUE ) = "Hello world "

...

 

...

UI Text Box
typenote

The input string is not trimmed, so in this case the first character is a space.

...

TRIMStrips

TRIM

...

the leading and trailing spaces from

...

Syntax

Code Block
TRIM ( string )

...

a

...

string

...

.

...

Return type

  • string

Example

...

TRIM( "Hello" ) = "Hello"

...

 

...

...

INDEXOF

...

Returns the index of the first occurrence of a specified

...

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

...

in

...

a

...

string

...

.

...

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" , "a" ) =  -1

...

LASTINDEXOFReturns

LASTINDEXOF

...

the index of the last occurrence of a specified

...

Syntax

...

substring

...

string - An attribute of base type string, an expression that results in a string or a constant string value.

...

in

...

a

...

string

...

.

...

Return type

  • integer - the index of the last occurrence of the specified substring or -1 if it is not found

Example

...

LASTINDEXOF( "Hello world" , "o" ) = 7

...

LASTINDEXOF( "Hello world" , "a" ) =  -1

...

 

...

SUBSTRING

...

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

...

. 
SUBSTRING BEFOREReturns

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"

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 ( string , substring )

...

.

...

 

...

Return type

  • string

...

SUBSTRING

...

AFTERReturns

SUBSTRING-AFTER

...

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 ( string , substring )

...

.

...

 

...

Return type

...

Example

  • SUBSTRING-AFTER( "hello:world" , ":" ) = "world"
  • SUBSTRING-AFTER( "hello:world:all" , ":" ) = "world:all"
  • SUBSTRING-AFTER( "hello:world" , "a" ) = ""

SPLIT

...

SPLITReturns 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.

...

.

...

Return type

  • string (multivalue)

Example

...

SPLIT( "Hello world" , "o" ) =  [ "Hell" , "w" , "rld" ]

...

 

...

SPLIT( "Hello" , "o" ) =  [ "Hell" , "" ]

...

...

REPLACE

...

REPLACEReplaces every occurrence of a string pattern within another string with a provided replacement string. The function is case-sensitive

...

Syntax

Code Block
REPLACE( pattern , string , replacement )

...

.

...

...

string - 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

  • REPLACE( ":", "hello:world:example" , " " ) = "hello world example"
  • REPLACE( "o" , "hello world" , "a" ) = "hella warld"
  • REPLACE( "O" , "hello world" , "a" ) = "hello world"

  • REPLACE( "\s" , "hello world example" , "" ) = "helloworldexample"

  • REPLACE( "\d{2}" , "hello1 world22 example333" , "@" ) = "hello1 world@ example@3"

EQUALS

...

EQUALSCompares 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
Text function CONCATENATE
Text function CONCATENATE


Include Page
Text function JOIN
Text function JOIN


Include Page
Text function MATCH
Text function MATCH


Include Page
Text function FIND
Text function FIND


Include Page
Text function FIRST
Text function FIRST


Include Page
Text function LAST
Text function LAST


Include Page
Text function LENGTH
Text function LENGTH


Include Page
Text function UPPERCASE
Text function UPPERCASE


Include Page
Text function LOWERCASE
Text function LOWERCASE


Include Page
Text function CAPITALIZE
Text function CAPITALIZE


Include Page
Text function TRIM
Text function TRIM


Include Page
Text function INDEXOF
Text function INDEXOF


Include Page
Text function LASTINDEXOF
Text function LASTINDEXOF


Include Page
Text function SUBSTRING
Text function SUBSTRING


Include Page
Text function SUBSTRING BEFORE
Text function SUBSTRING BEFORE


Include Page
Text function SUBSTRING AFTER
Text function SUBSTRING AFTER


Include Page
Text function SPLIT
Text function SPLIT


Include Page
Text function REPLACE
Text function REPLACE


Include Page
Text function EQUALS
Text function EQUALS

UI Text Box
typewarning

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

...

EQUALS( "hello" , "hello" ) = TRUE

...

EQUALS( "hello" , "Hello" ) = FALSE

 

UI Text Box
typenote

Note that "hello" = "Hello" will return TRUE because it is case insensitive

...