Text and string functions

TOLOWERCASE / TOLOWER

String

Convert to lowercase

{{ 'ABC'.toLower }}
Result: 'abc'

TOUPPERCASE / TOUPPER

String

Convert to uppercase

{{ 'abc'.toUpper }}
Result: 'ABC'

TOTITLECASE / TOTITLE

String

Convert to title case

{{ 'the strangeness'.toTitleCase }}
Result: 'The Strangeness'

TRIM

String

Trim leading/trailing whitespace

{{ ' text '.trim }}
Result: 'text'

SANITISE / SIMPLIFYWHITESPACE

String

Removes surrounding whitespace and converts any instances of multiple whitespace to a single space character

{{ ' hello world '.sanitise }}
Result: 'hello world'

LEFT

String

Left N characters

{{ 'IPE'.left(2) }}
Result: 'IP'

LENGTH / LEN

Int

Length of string

{{ 'text'.length }}
Result: 4

SUBSTRING

String

Extract substring

{{ 'hello'.substring(3,10) }}
Result: 'llo'

LEADINGDIGITS

String

Leading numeric digits

{{ '110FT100'.leadingDigits }}
Result: '110'

TRAILINGDIGITS

String

Trailing numeric digits

{{ '110FT100'.trailingDigits }}
Result: '100'

TRAILINGLETTERS

String

Returns trailing letters from some text

'ABC110FT100-TX'.trailingLetters => 'TX'

LEADINGLETTERS

String

Leading letters

{{ 'ABC110'.leadingLetters }}
Result: 'ABC'

EXTRACTDIGITS

String

Extract all digits

{{ '1ce 8 t1me'.extractDigits }}
Result: '181'

PADLEFT / LPAD

String

Left-pad to length

{{ 'Hi'.padLeft(' ,5) }}\u003C/span\u003E\u003Cbr\u003E\u003Cspan class=\"codeblue\"\u003EResult: '$$Hi'\u003C/span\u003E\u003C/p\u003E\n \u003C/td\u003E\n \u003C/tr\u003E\u003Ctr style=\"page-break-inside: auto;\"\u003E\n \u003Ctd data-width=\"162.87px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003EPADRIGHT / RPAD\u003C/p\u003E\n \u003C/td\u003E\n \u003Ctd data-width=\"75.6px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003EString\u003C/p\u003E\n \u003C/td\u003E\n \u003Ctd data-width=\"189px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003ERight-pad to length\u003C/p\u003E\n \u003C/td\u003E\n \u003Ctd data-width=\"226.8px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003E\u003Cspan class=\"codeblue\"\u003E{{ 'Hi'.padRight(' ; var digitalData={"pageInfo":{"pageName": "AVEVA Documentation", "URL": "https://docs.aveva.com/"}, "category": {"pageType": "Documents"}}; if (!zdWebClientConfig.environment) { zdWebClientConfig.environment = "production"; } } catch (err) { console.error("Configuration was not injected properly") }

PADRIGHT / RPAD

String

Right-pad to length

{{ 'Hi'.padRight(' ,5) }}\u003C/span\u003E\u003Cbr\u003E\u003Cspan class=\"codeblue\"\u003EResult: '$$Hi'\u003C/span\u003E\u003C/p\u003E\n \u003C/td\u003E\n \u003C/tr\u003E\u003Ctr style=\"page-break-inside: auto;\"\u003E\n \u003Ctd data-width=\"162.87px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003EPADRIGHT / RPAD\u003C/p\u003E\n \u003C/td\u003E\n \u003Ctd data-width=\"75.6px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003EString\u003C/p\u003E\n \u003C/td\u003E\n \u003Ctd data-width=\"189px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003ERight-pad to length\u003C/p\u003E\n \u003C/td\u003E\n \u003Ctd data-width=\"226.8px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003E\u003Cspan class=\"codeblue\"\u003E{{ 'Hi'.padRight(' ; var digitalData={"pageInfo":{"pageName": "AVEVA Documentation", "URL": "https://docs.aveva.com/"}, "category": {"pageType": "Documents"}}; if (!zdWebClientConfig.environment) { zdWebClientConfig.environment = "production"; } } catch (err) { console.error("Configuration was not injected properly") }

PADNUMBERS

String

Pad numeric segments

{{ 'He11o'.padNumbers(5) }}
Result: 'He00011o'

PREFIX / PREPEND

String

Prepend text

{{ 'world'.prefix('hello ') }}
Result: 'hello world'

SUFFIX / APPEND

String

Append text

{{ 'hello '.append('world') }}
Result: 'hello world'

HYPHENATE

String

Add hyphens on boundaries

{{ '110FT100'.hyphenate }}
Result: '110-FT-100'

SLICE

String

Extract N slices by separator

{{ 'IPE|DOC|79580'.slice('|',1) }}
Result: 'IPE'

SLICEOFF

String

Remove N slices

{{ 'IPE|DOC|79580'.sliceOff('|',1) }}
Result: 'DOC|79580'

SPLIT

Array

Split into array

{{ 'A;B;C'.split(';') }}
Result: ['A','B','C']

SPLITANY

Array

Split by any separator

{{ 'A;B,C'.splitAny(';,') }}
Result: ['A','B','C']

COUNTSLICES

Int

Count slices

{{ 'IPE|J-9002A'.countSlices('|') }}
Result: 2

REPLACE (text)

String

Replace substring

{{ 'He11o'.replace('1','l') }}
Result: 'Hello'

REPLACE (regex)

String

Replace via regex

{{'He11o'.replace(/[1]{1,2}/,'l$1') }}
Result: 'Hel11o'

REPLACEORBLANK

String

Replace or return blank

{{@[Field].replaceOrBlank(/^PREFIX-(.+)$/,'$1') }}
Result: Captured group or blank

GETMATCHES

Array

All regex matches

{{ 'P-101 J-9002'.getMatches(/[A-Z]-\d{3,4}/) }}
Result: ['P-101','J-9002']

MATCHORBLANK

String

Returns the input text if it matches a regex, or blank:

{{'P-101'.matchOrBlank(/[A-Z]-\d{3,4}/) }}
Result: 'P-101' if matches

TAB

String

A <TAB> character

LF

String

A <LF> (line feed) character

CR

String

A <CR> (carriage return) character

CRLF

String

Carriage Return + Line feed

SQUOTE / SINGLEQUOTE

String

Single quote (')

'Hello World'.wrap(SQUOTE)

Result: 'Hello World'

DQUOTE / DOUBLEQUOTE

String

Double quote (")

'Hello World'.wrap(DQUOTE) Result: "Hello World"

BEFOREWHITESPACE

String

Returns text up to the first whitespace

'Hello World'.BeforeWhitespace => 'Hello'

CONTAINSANY

Boolean

Indicates if text contains any of the provided characters

'Hello-World'.containsany('-') => true

COUNTCHAR

Number

Count occurrences of some text

'c:\temp\my\stuff'.countchar('\') => 3

DECODEXMLNAME

String

Decodes text from an XML tag to normal text

ENCODEXMLNAME / ESCAPEXMLNAME

String

Encodes text so it is suitable for an XML tag

ENSURELASTWORD

String

Ensures text ends in a word

'Hello World'.EnsureLastWord('World') => 'Hello World'

ENSURENOTPREFIXED / ENSURENOPREFIX

String

Ensures some text does not start with some specified text

ENSURENOTSUFFIXED / ENSURENOSUFFIX

String

Ensures some text does not end with some specified text

ENSURESUFFIX / ENSURESUFFIXED

String

Ensures text has a suffix

'Hello'.EnsureSuffix('World') => 'HelloWorld'

ESCAPEANNOTATIONNAME

String

Escapes text so to reference in an ISM annotation extension

ESCAPEANNOTATIONPATH

String

Escapes a path to text so to reference in an ISM annotation extension

ESCAPETEXT

String

Escapes text by converting a single quote to two single quotes

@someText = my 'text'

@someText.escapeText => my ''text''

ESCAPEURLPARAMETER / ESCAPEURIPARAMETER

String

Escapes some text so it is suitable to inject as a URL parameter

FIRSTLETTERSEQUENCE / FIRSTLETTERS

String

Returns first letter sequence from text

'110FT100-TX'.FirstLetters => 'FT'

GUID / GETGUID

String

Returns a GUID (no hyphens)

GetGuid => '2d291669ff314436a57ad1f03e547686'

GUIDWITHHYPHENS / GETGUIDWITHHYPHENS

String

Returns a GUID with hyphens

GetGuid => '2d291669-ff31-4436-a57a-d1f03e547686'

HASHCODE

Number

Returns the (.NET) Hash code

HEX / TOHEX

String

Returns the Hex value of the specified text

INDEXOFANY

Number

Indicates 0-based position of any of provided characters, or -1 if not found

'c:\temp\my\stuff'.indexOfAny(':ms') => 1

ISABSOLUTEURI / ISABSOLUTEWEBLINK

Boolean

Tests if some text is a valid absolute URI

ISRELATIVEURI / ISRELATIVEWEBLINK

Boolean

Tests if some text is a valid relative URI

ISURI / ISWEBLINK

Boolean

Tests if some text is a valid URI

ISVALIDREGEX / ISREGEX

Boolean

Tests if some text is a valid Regular Expression

LASTWORD

String

Ensures some text is suffixed with a final space then word

'hello'.lastword('world') => 'hello world'

MD5HASH / MD5

String

Returns the MD5 hash of a string

MD5('Hello World')

Result: MD5 Hash

NORMALISETOFORM / NORMALIZETOFORM / UNICODENORMALIZETOFORM

String

Normalises unicode to a specified normalisation form, or formC if unset

NOTNULL / EMPTYIFNULL

Boolean

Converts a null value to empty text

REMOVEEMPTYSLICES

String

Removes any empty slices from some text

'IPE||ONE'.RemoveEmptySlices('|') => 'IPE|ONE'

REMOVEINVALIDXMLCHARACTERS / REMOVEINVALIDXMLCHARS

String

Removes any invalid characters for use in XML

REMOVELEFT

String

Remove a number of characters from the left of some text

'text'.RemoveLeft(2) => 'xt'

REMOVERIGHT

String

Remove a number of characters from the right of some text

'text'.RemoveRight(2) => 'te'

REVERSE

String

Reverses some text

'ABC'.reverse => 'CBA'

SIMPLIFYMARKUP

String

Simplifies HTML/SGML/XML markup into readable text

'<b>Hello</b>’.simplifyMarkup => Hello

SLICEINDEX

Int

Returns the index number of a slice of text

'IPE|PRJ|ONE'.SliceIndex('PRJ') => 2

SLICEOUT

String

Using a separator, slices out a range from some text

'IPE|DOC|WIP|79580'.sliceOut('|', 2, -2) => 'DOC|WIP'

SPLITBYWHITESPACE

String[]

Splits some text by any whitespace

'Hello world'.SPLITBYWHITESPACE

Result: Hello;world

TEXTAFTER

String

Returns text after specified text

'\fee\fie\foe\fum'.textAfter('fie') => '\foe\fum'

TEXTBEFORE

String

Returns text before specified text

'\fee\fie\foe\fum'.textBefore('fie') => '\fee\'

TOASCII

String

Converts text to ASCII via Unicode FormD normalisation, removing non-ASCII characters

TRIMCHARS

String

Trim specified characters from both sides

'@$ text $ ,5) }}\u003C/span\u003E\u003Cbr\u003E\u003Cspan class=\"codeblue\"\u003EResult: '$$Hi'\u003C/span\u003E\u003C/p\u003E\n \u003C/td\u003E\n \u003C/tr\u003E\u003Ctr style=\"page-break-inside: auto;\"\u003E\n \u003Ctd data-width=\"162.87px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003EPADRIGHT / RPAD\u003C/p\u003E\n \u003C/td\u003E\n \u003Ctd data-width=\"75.6px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003EString\u003C/p\u003E\n \u003C/td\u003E\n \u003Ctd data-width=\"189px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003ERight-pad to length\u003C/p\u003E\n \u003C/td\u003E\n \u003Ctd data-width=\"226.8px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003E\u003Cspan class=\"codeblue\"\u003E{{ 'Hi'.padRight(' ; var digitalData={"pageInfo":{"pageName": "AVEVA Documentation", "URL": "https://docs.aveva.com/"}, "category": {"pageType": "Documents"}}; if (!zdWebClientConfig.environment) { zdWebClientConfig.environment = "production"; } } catch (err) { console.error("Configuration was not injected properly") }

TRIMCHARSLEFT / LTRIMCHARS

String

Trim specified characters from the left

'@$ text $ ,5) }}\u003C/span\u003E\u003Cbr\u003E\u003Cspan class=\"codeblue\"\u003EResult: '$$Hi'\u003C/span\u003E\u003C/p\u003E\n \u003C/td\u003E\n \u003C/tr\u003E\u003Ctr style=\"page-break-inside: auto;\"\u003E\n \u003Ctd data-width=\"162.87px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003EPADRIGHT / RPAD\u003C/p\u003E\n \u003C/td\u003E\n \u003Ctd data-width=\"75.6px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003EString\u003C/p\u003E\n \u003C/td\u003E\n \u003Ctd data-width=\"189px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003ERight-pad to length\u003C/p\u003E\n \u003C/td\u003E\n \u003Ctd data-width=\"226.8px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003E\u003Cspan class=\"codeblue\"\u003E{{ 'Hi'.padRight(' ; var digitalData={"pageInfo":{"pageName": "AVEVA Documentation", "URL": "https://docs.aveva.com/"}, "category": {"pageType": "Documents"}}; if (!zdWebClientConfig.environment) { zdWebClientConfig.environment = "production"; } } catch (err) { console.error("Configuration was not injected properly") }

TRIMCHARSRIGHT / RTRIMCHARS

String

Trim specified characters from the right

'@$ text $ ,5) }}\u003C/span\u003E\u003Cbr\u003E\u003Cspan class=\"codeblue\"\u003EResult: '$$Hi'\u003C/span\u003E\u003C/p\u003E\n \u003C/td\u003E\n \u003C/tr\u003E\u003Ctr style=\"page-break-inside: auto;\"\u003E\n \u003Ctd data-width=\"162.87px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003EPADRIGHT / RPAD\u003C/p\u003E\n \u003C/td\u003E\n \u003Ctd data-width=\"75.6px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003EString\u003C/p\u003E\n \u003C/td\u003E\n \u003Ctd data-width=\"189px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003ERight-pad to length\u003C/p\u003E\n \u003C/td\u003E\n \u003Ctd data-width=\"226.8px\" style=\"border-style: solid; border-width:0.4pt;border-color:#010101;\"\u003E\n \u003Cp class=\"tableparagraph\"\u003E\u003Cspan class=\"codeblue\"\u003E{{ 'Hi'.padRight(' ; var digitalData={"pageInfo":{"pageName": "AVEVA Documentation", "URL": "https://docs.aveva.com/"}, "category": {"pageType": "Documents"}}; if (!zdWebClientConfig.environment) { zdWebClientConfig.environment = "production"; } } catch (err) { console.error("Configuration was not injected properly") }

TRIMLEFT / LTRIM

String

Trim whitespace from the left

' text '.TrimLeft() => 'text '

TRIMRIGHT / RTRIM

String

Trim whitespace from the right

' text '.TrimRight => ' text'

WRAP

String

Wraps the passed text with specified wrapping text

'text'.wrap(DQUOTE) => "text"