> For the complete documentation index, see [llms.txt](https://docs.work-relay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.work-relay.com/automations/functions-and-formulas/functions-library/text-functions.md).
# Text functions
SPECIALSYMBOLS
Allows using of special symbols within the formula.
**Usage**:
`{QUOTE}` for single quote (`'`)\
`{DBL_QUOTE}` for double quote (`"`)\
`{OPEN_BKT}` for opening bracket (`(`)\
`{CLOSE_BKT}` for closing bracket (`)`)\
`{OPEN_SQR_BKT}` for opening square bracket (`[`)\
`{CLOSE_SQR_BKT}` for closing square bracket (`]`)\
`{TAB}` for tabulation\
`{BACK_SL}` for backslash (`)`\
`{BR} for line break`\
`{RET} for carriage return`
*Use any of the expressions above whenever you need formula to contain special symbol(s).*
**Example**:
{% code overflow="wrap" %}
```apex
IF(STARTS({Request__c.Name}, 'RFQ'), '{OPEN_SQR_BKT}Request for Quote{CLOSE_SQR_BKT}', '{OPEN_SQR_BKT}Service{CLOSE_SQR_BKT}')
```
{% endcode %}
Returns **'\[Request for Quote]'** if request name starts with 'RFQ', and '**\[Service]'** if it doesn't.
CONTAINS
Compares two arguments of text and returns true if the first argument contains the second argument. If not, returns false.
**Usage**:
{% code overflow="wrap" %}
```apex
CONTAINS(source_string, search_string)
```
{% endcode %}
*Replace* *`source_string`* *with the text that should be searched for a value of search\_string.*
**Example**:
{% code overflow="wrap" %}
```apex
IF(CONTAINS({Opportunity.Product_Type__c}, 'part'), 'Parts', 'Service')
```
{% endcode %}
Returns '**Parts**' for any Opportunity Product with the word 'part' in it's Type field. Otherwise, it returns '**Service**'.
STARTS
Determines whether a string begins with the characters of another string, returning true if it does. If not, returns false.
**Usage**:
{% code overflow="wrap" %}
```apex
STARTS(source_string, search_string)
```
{% endcode %}
*Replace* *`source_string`* *with the text that should be checked for starting from the value of* *`search_string`.*
**Example**:
{% code overflow="wrap" %}
```apex
IF(STARTS({Request__c.Name}, 'RFQ'), 'Request for Quote', 'Service')
```
{% endcode %}
Returns '**Request for Quote**' for any request name starting with 'RFQ'. Otherwise, it returns '**Service**'.
{% hint style="info" %}
Note: values are case sensitive.
{% endhint %}
POS
Gets the position of a string within another string and returns it as a number.
**Usage**:
{% code overflow="wrap" %}
```apex
POS(source_string, search_string)
```
{% endcode %}
*Replace:*
* *`source_string`* *with the field or expression you want to search in*
* *`search_string`* *with the string you want to find*
**Example**:
{% code overflow="wrap" %}
```apex
POS({Contact.Email}, '@')
```
{% endcode %}
Returns position of the '@' symbol in a person's email address.
ENDS
Determines whether a string ends with the characters of another string, returning **true** if it does. If not, returns **false**.
**Usage:**
{% code overflow="wrap" %}
```apex
ENDS(source_string, search_string)
```
{% endcode %}
*Replace* *`source_string`* *with the text that should be checked for ending with the value of* *`search_string`.*
**Example:**
{% code overflow="wrap" %}
```apex
IF(ENDS({Company__c.Name}, 'TM'), 'Trademark', 'Service mark')
```
{% endcode %}
Returns '**Trademark**' for any item ending with 'TM'. Otherwise, it returns '**Service mark**'.
{% hint style="warning" %}
Note: values are case sensitive.
{% endhint %}
SUBSTR
Returns a new string that begins with the character at the specified zero-based `start_index` position and extends until the character at `end_index` position.
**Usage:**
{% code overflow="wrap" %}
```apex
SUBSTR(source_string, start_index, end_index)
```
{% endcode %}
*Replace:*
* *`source_string`* *with the string, field or expression where you want to get a substring from*
* *`start_index`* *with position which substring begins from*
* *`end_index`* *with position which substring ends before*
**Example:**
{% code overflow="wrap" %}
```apex
SUBSTR({Contact.Name}, 4, 8)
```
{% endcode %}
Returns '**erso**' when Contact.Name equals 'Jefferson'.
{% hint style="info" %}
Function returns a substring starting FROM `start_index` position UNTIL `end_index` (starting with a symbol at `start_index` position, and ending with `end_index - 1` position).
Indexes are counted from 0.
{% endhint %}
REPLACE
Replaces a sequence of characters in a string with another set of characters, and returns a resulting string.
**Usage**:
{% code overflow="wrap" %}
```apex
REPLACE(source_string, from_string, to_string, regex_boolean_optional)
```
{% endcode %}
*Replace:*
* *`source_string`* *with string to be changed*
* *`from_string`* *with characters to be replaced in source\_string*
* *`to_string`* *with the replacement set of characters*
**Example 1:**
{% code overflow="wrap" %}
```apex
REPLACE({Opportunity.Unique_ID__c}, '3a', '2b')
```
{% endcode %}
Returns: in this example the `Unique_ID__c` will now contain new value with the '**3a**' replaced with '**2b**'.
**Example 2:**
User can pass regular expression as a `from_string` argument as well. In this case user should add 'true' as an optional `regex_boolean_optional` argument.
{% code overflow="wrap" %}
```apex
REPLACE('a3f45qq456', '[^0-9]', '', true)
```
{% endcode %}
Returns **345456**.
REMOVE
Removes one or more substrings from a source string.
**Usage:**
{% code overflow="wrap" %}
```apex
REMOVE(source_string, string_parameter1, string_parameter2, ...)
```
{% endcode %}
*Replace:*
* *`source_string`* *with the text field or expression you want to remove substrings from*
* *`string_parameter1`,* *`string_parameter2`, etc with substrings to be removed from the* *`source string`*
**Example:**
{% code overflow="wrap" %}
```apex
REMOVE('(555) 555-6789 ', ' ', '(', ')', '-')
```
{% endcode %}
Returns '**5555556789**'.
LEN
Returns the number of characters in a specified text string (string length).
**Usage:**
{% code overflow="wrap" %}
```apex
LEN(string)
```
{% endcode %}
*Replace* *`string`* *with the field or expression which length you want get.*
**Example:**
{% code overflow="wrap" %}
```apex
LEN({Product__с.Code__c})
```
{% endcode %}
Returns the length of a Product.Code field.
SPLIT
Returns an array (a list) that contains each substring of the source stringthat is split on `split_by_string` parameter. Substrings are placed in the array in the order in which they occur in the source string.
**Usage:**
```apex
SPLIT(source_string, separator_string)
```
*Replace:*
* *`source_string`* *with the text field or expression to be split*
* *`separator_string`* *with a substring to split on*
**Example:**
```apex
SPLIT('AL, AK, AZ, AR', ', ')
```
Returns an array that of elements of string type.
JOIN
Joins the elements of an array into a single string separated by the specified separator.
**Usage:**
```apex
JOIN(array, separator_string, left_string_optional, right_string_optional)
```
*Replace:*
* *`array`* *with an array you want to join to a string*
* *`separator_string`* *with the separator. Use the optional arguments to add text around each element*
**Example:**
Let `String__c` field on `Stub__c` object stores following string: 'Cars, Plains, Ships'.
```
{OPEN_SQR_BKT} + JOIN(SPLIT({Stub__c.String__c}, ','), ',', '{DBL_QUOTE}', '{DBL_QUOTE}') + {CLOSE_SQR_BKT}
```
Returns: **'\["Cars", "Plains", "Ships"]'** (this formula will split field value to an array and then transform it to a string).
LOWER
Converts all of the characters in the string to lowercase.
**Usage:**
```apex
LOWER(string)
```
*Replace* *`string`* *with the value to convert to lowercase.*
**Example:**
```apex
LOWER({Account.Name})
```
Returns account name value in lowercase.
UPPER
Converts all of the characters in the string to uppercase.
**Usage:**
```apex
UPPER(string)
```
*Replace* *`string`* *with the value to convert to uppercase.*
**Example:**
```apex
UPPER({Account.Name})
```
Returns account name value in uppercase.
ESCAPE
Returns a string whose characters are escaped using specified rule.
**Usage:**
{% code overflow="wrap" %}
```apex
ESCAPE(string,JAVA|JSON|HTML|CSV|XML|UNICODE|QUOTE)
```
{% endcode %}
*Pass* *`string`* *to be escaped and one of the allowed escape rules as arguments.*
**Examples:**
Let `Stub__c.String__c` value is 'Please, fill in "Name"'.\
\
`ESCAPE({Stub__c.String__c}, 'HTML')` will return **'Please, fill in quot;Namequot;**'\
\
`ESCAPE({Stub__c.String__c}, 'JAVA')` will return '**Please, fill in "Name"**'\
\
`ESCAPE({Stub__c.String__c}, 'CSV')` will return '**"Please, fill in ""Name"""**'\
\
`ESCAPE({Stub__c.String__c}, 'XML')` will return '**Please, fill in quot;Namequot;**'
\ Let `Stub__c.String__c` value is 'De onde você é?'
`ESCAPE({Stub__c.String__c}, 'UNICODE')` will return '**De onde voc\u00EA \u00E9?**'
Let `Stub__c.String__c` value is 'De onde você é?'
`ESCAPE({Stub__c.String__c}, 'UNICODE')` will return '**De onde voc\u00EA \u00E9?**'
UNESCAPE
Returns a string whose characters are unescaped using specified rule.
**Usage:**
{% code overflow="wrap" %}
```apex
UNESCAPE(string,JAVA|JSON|HTML|CSV|XML|UNICODE|QUOTE)
```
{% endcode %}
*Pass* *`string`* *to be unescaped and one of the allowed unescape rules as arguments.*
**Examples:**
`UNESCAPE('Please, fill in quot;Namequot;', 'HTML')` will return '**Please, fill in "Name"**'\
\
`UNESCAPE('Please, fill in "Name"', 'JAVA')` will return '**Please, fill in "Name"**'\
\
`UNESCAPE('"Please, fill in ""Name"""', 'CSV')` will return '**Please, fill in "Name"**'\
\
`UNESCAPE('Please, fill in quot;Namequot;', 'XML')` will return '**Please, fill in "Name"**'\
\
`UNESCAPE('De onde voc\u00EA \u00E9?', 'UNICODE')` will return '**De onde você é?**'
BR
Adds `
` (line break) HTML tag when used.
**Usage**:
Add `BR()` to other functions or output text values wherever you need a line break.
**Example:**
Let `Account.Account_Multy__c` value is \[A, B, C] (these options had been checked).
{% code overflow="wrap" %}
```apex
JOIN(SPLIT({Account.Account_Multy__c}, ';'), BR())
```
{% endcode %}
Returns HTML string with line breaks (this formula will first split field value to an array and then transform it to a following text):
```apex
A
B
C
```
TEXT
Converts any data type into text.
**Usage:**
```apex
TEXT(parameter)
```
*Replace* *`parameter`* *with the field or expression to convert to text.*
**Example:**
```apex
IF(TEXT({Stub__c.Number__c}) = {Stub__c.Text__c}, true, false)
```
Returns **true** when `Stub.Number` is 25 and `Stub.Text` is '25'.
{% hint style="success" icon="lightbulb-on" %}
This can be useful, e.g., it allows to compare numeric and string values.
{% endhint %}
BLOB
Casts the specified string to a [BLOB](https://en.wikipedia.org/wiki/Binary_large_object).
**Usage:**
```apex
BLOB(string)
```
*Replace* *`string`* *with the value to cast to BLOB.*
**Example:**
```apex
BLOB({Account.LongTextField__c})
```
Returns the field value as BLOB content.
TOBASE64
Converts a BLOB to an unencoded String representing its normal form.
**Usage:**
```apex
TOBASE64(blob_parameter)
```
*Replace* *`blob_parameter`* *with the BLOB content to convert to Base64.*
**Example:**
```apex
TOBASE64(BLOB({$Account.Name}))
```
Returns '**TWFyeSBBbm4=**' when `Account.Name` is 'Mary Ann'.
FROMBASE64
Converts a Base64-encoded string to a BLOB representing its normal form.
**Usage:**
```apex
FROMBASE64(string_parameter)
```
*Replace* *`string_parameter`* *with a Base64-encoded string.*
**Example:**
```apex
FROMBASE64('TWFyeSBBbm4=')
```
Returns the BLOB content of 'Mary Ann'.
TOHEX
Returns a hexadecimal (base 16) representation of the string.
**Usage:**
```apex
TOHEX(string_parameter)
```
*Replace* *`string_parameter`* *with the string to convert to hexadecimal.*
**Example:**
```apex
TOHEX({Account.Name})
```
Returns '**4d61727920416e6e**' when `Account.Name` is 'Mary Ann'.
FROMHEX
Converts the specified hexadecimal (base 16) value to text. Returns string.
**Usage:**
```apex
FROMHEX(string_parameter)
```
*Replace* *`string_parameter`* *with the hexadecimal string to convert to text.*
**Example:**
```apex
FROMHEX('4d61727920416e6e')
```
Returns '**Mary Ann**'.
URLENCODE
Encodes or decodes a string in application/x-www-form-urlencoded format using a specific encoding scheme.
**Usage:**
```apex
URLENCODE(string_to_encode, format_optional, boolean_encode_optional)
```
*Replace* *`string_to_encode`* *with the value to encode or decode.*\
*The* `format_optional` *defaults to* *`UTF-8`.*\
*Pass* *`false`* *for* *`boolean_encode_optional`* *to decode.*
**Example 1:**
{% code overflow="wrap" %}
```apex
URLENCODE({Stub__c.String__c})
```
{% endcode %}
Returns '**Test+%2F+me**' when given String value is **'Test/me**'.
**Example 2:**
{% code overflow="wrap" %}
```apex
URLENCODE({Stub__c.String__c}, 'UTF-8', false)
```
{% endcode %}
Returns '**Test/me**' when given String value is '**Test+%2F+me**'.
TOTEXTDURATION
Сonverts integer amount of minutes (numeric value) into string in the `XXXh YYm` or `ZZZd XXh YYm` format.
**Usage:**
{% code overflow="wrap" %}
```apex
TOTEXTDURATION(integer_minutes_parameter, hours_in_day_optional)
```
{% endcode %}
*Replace* *`integer_minutes_parameter`* *with integer representing number of minutes to get duration in hours and minutes.*\
*Add optional* *`hours_in_day_optional`* *argument to get duration in working days, hours and minutes.*
**Example 1:** `TOTEXTDURATION(6067)` will return '**101h 7m**'.\
\
**Example 2:** `TOTEXTDURATION(6067,8)` will return '**12d 5h 7m**', where each day has 8 hours (useful to calculate how many business days will take some process).\
\
**Example 3:** `TOTEXTDURATION(6067,24)` will return '**4d 5h 7m**' where each day has 24 hours (in this case you will get duration in full days).
FROMTEXTDURATION
Converts string in the `XXXh YYm` or `ZZZd XXh YYm` format to integer representing number of minutes. Returns numeric value.
**Usage:**
{% code overflow="wrap" %}
```apex
FROMTEXTDURATION(string_parameter, hours_in_day_optional)
```
{% endcode %}
*Replace* *`string_parameter`* *with a string to be converted.*
*Add optional* *`hours_in_day_optional`* *argument to specify how many work hours one working day consists of.*
**Example 1:** `FROMTEXTDURATION('62h 34m')` returns **3754** (62\*60 + 34).\
\
**Example 2:** `FROMTEXTDURATION('3d 2h 34m')` returns **4474** (3\*24\*60 +2\*60 + 34).\
\
**Example 3:** `FROMTEXTDURATION('3d 2h 34m',8)` returns **1594** (3\*8\*60 +2\*60 + 34).
MATCH
Searches a string for a match against a regular expression, and returns the matches in an array.
**Usage:**
{% code overflow="wrap" %}
```apex
MATCH(regex_string, data_string)
```
{% endcode %}
*Replace:*
* *`regex_string`* *with a regular expression*
* *`data_string`* *with the string to compare to regular expression*
**Example:**
Let Duration\_\_c value is '8d'.
{% code overflow="wrap" %}
```apex
MATCH('[^abc]', {Stub__c.Duration__c})
```
{% endcode %}
Returns the following array: **(8, d)**.