Provides information about text values.
Name:
Text Supplier
Prefix:
text (optional)
Supported Content:
Text
Provided By:
Reporting Plugin
The following are the list of keys which this supplier will return a value for.
Key
Content Types
Return Type
Description
size Text Number The number of characters in the text value. trim Text Text Trims any white space (spaces, tabs, etc) from the text value. lower case Text Text Converts the text to lower case. upper case Text Text Converts the text to upper case. first [X] Text Text Trims the text to only include the first X characters. For example, "first 10". last [X] Text Text Trims the text to only include the last X characters. For example, "last 15". url encode Text Text URL-encodes the text value so it is safe to include in a URL. html escape Text Text Escapes any special HTML characters so they will display correctly in HTML content. xml escape Text Text Escapes any special XML characters so they will display correctly in XML content. equals [X] Text Boolean (Since 2.0.0) Tests if the text equals the 'X' value supplied. Eg. "equals Foo Bar". This is case-sensitive. starts with [X] Text Boolean (Since 2.0.0) Tests if the text starts with the 'X' value supplied. Eg. "starts with Foo". This is case-sensitive. ends with [X] Text Boolean (Since 2.0.0) Tests if the text ends with the 'X' value supplied. Eg. "ends with Bar". This is case-sensitive. match [X] Text Match (Since 3.1.0) Tries to match the current complete text value with the specified regular expression . If successful, a Match is returned. find [X] Text List of Matches (Since 3.1.0) Tries to match a subset of the current text value with the specified regular expression . If there is more than one match in the text value, each will be an item in the returned list. split with [X] Text List of Text (Since 3.2.0) Splits the text value into chunks, divided by sub-text that matches the specified regular expression . as number [X] Text Number (Since 3.2.0) Converts the text into a Number , using the provided format to parse it. If no format is provided it will try to parse it as a simple number. Eg:
Value
Keychain
Result
"123.45"
text:as number
123.45
"1,234.56
text:as number
null
"1,234.56"
text:as number #,##0.00
1234.56
"$1,234.56"
text:as number '$'#,##0.00
1234.56
as date [X] Text Date (Since 3.2.0) Tries to convert the text value into a Date based on the provided format. Eg:
Value
Keychain
Result
"04-Sep-2009"
text:as date dd-MMM-yyyy
Sep 4, 2009
"04-Sep-2009"
text:as date d-MMMM-yy
null
is empty Text Boolean (Since 3.2.0) Is true if the text value has no characters. is blank Text Boolean (Since 3.2.0) Is true if the text value is empty or all characters are white-space.
Labels parameters
Discussions