Text Modifiers
A text token displays a value or string of text.
An example of a text modifier is the Last Edited text on the Incident form.
The following modifiers can be applied to text tokens.
As XML |
Returns text as an XML element. |
Contains |
Determines whether another string is contained within the source string. Example:
|
Ellipse Text |
Used to truncate a string if it is too long. If the string is longer than the specified length, then the value has an ellipsis (…) added to the end. Spaces are included in the character count for this modifier. Example:
|
Encode Text | Applies the selected encoding method to text.
You can choose from:
|
First Word |
Returns the first word in a string. Example:
|
Hash Text |
Applies cryptographic hashing algorithms to text strings. This enables you to create encrypted strings you can use to create tokens for APIs and to detect data changes. Available hash formats:
By default, converted strings are converted to hex format and use UTF-8 encoding. To shorten the strings, select the Base 64 check box. |
Hash MAC Text |
Applies cryptographic hashing algorithms with Message Authentication signing to text strings. Provide a Hash MAC (Message Authentication Code) Key for an extra level of security. By default, converted strings are converted to hex format and use UTF-8 encoding. To shorten the strings, select the Base 64 check box. |
Index of Text |
Returns the position of another string within the source string. The index is 0-based, so if the searched-for text is at the very beginning of the source, then the index is 0. If the string is not found, then the return value is -1. Example:
|
JSON Encode |
Converts a string into a value that can be used as JSON. Example:
|
Last Word |
Returns the last word in a string. Example:
|
Left |
Shows the left X-most characters from the original token, where X=6 in the example below. Spaces are included in the character count for this modifier. Example:
|
Length of Text |
Counts the number of characters in the string. Spaces are included in the character count for this modifier. Example:
|
Lowercase |
Converts any upper-case characters in the original token to lower-case. Example:
|
Pad Left |
Inserts a particular character(s) to the left of a value to force the value to be a particular length. Example:
|
Pad Right |
Inserts a particular character(s) to the right of a value to force the value to be a particular length. Example:
|
Remove |
Removes a particular value from the original token. Example:
|
Remove Line Breaks |
Removes line breaks to make the token fit on a single line. Example:
|
Remove White Space |
Removes any white space characters from the tokens: line breaks, spaces, tabs. Example:
|
Replace |
Replaces one value in the string with another on every occurrence. Example:
|
Right |
Shows the right X-most characters from the original token, where X=6 in the example below. Spaces are included in the character count for this modifier. Example:
|
Substring |
Shows a certain number of characters from the middle of the token. The start position for a text string is considered to be 0, so Substring (0,6) is the equivalent of Left (6). Spaces are included in the character count for this modifier. Example:
|
Text After |
Finds a value after a particular word or phrase inside of the token. There are several options to control how this modifier operates:
This modifier is often useful when parsing email messages. Example:
|
Text Before |
Finds a value before a particular word or phrase inside of the token. There are several options to control how this modifier operates:
|
Text Between |
Returns all of the text that appears between two values in a token. This modifier is often useful when parsing email messages. We recommend using the following markers:
Example:
We do not recommend using angle brackets (<>) as markers; the E-mail and Event Monitor reads HTML coding, and use of angle brackets as markers could cause unintended results. |
Text to Logical |
Converts a text value to a logical value. This is useful when reformatting a text value based on whether the text result is equal to True or False. The values True, T, Yes, and 1 are converted to True. Any other values are converted to False. |
Text to Number |
Converts the value in a text token to a number. Numeric Modifiers can then be applied to the result. See Numeric Modifiers. Example:
|
Trim End |
Trims specified characters from the end of a text string. Each character in the modifier is evaluated, regardless of order. Repeated characters are removed. The following example shows how to trim end characters from a string:
The following example shows how to trim repeated characters from the end of a string:
The following example shows how to trim characters from the end of a string, regardless of order:
|
Trim Start |
Trims specified characters from the start of a text string. Each character in the modifier is evaluated, regardless of order. Repeated characters are removed. The following example shows how to trim start characters from a string:
The following example shows how to trim repeated characters from the beginning of a string:
The following example shows how to trim characters from the beginning of a string, regardless of order:
|
Uppercase |
Converts any lower-case characters in the original token to upper-case. Example:
|
Uppercase First |
Converts only the first character to upper-case. This is often useful when working with names and proper nouns. Example:
|
URL Encode |
Converts a string into a value that can be legally used as a URL. Example:
|