Reference
The following string formatters can be used when building URLs, or creating unique Sample IDs/names.
| | Name | Synonym | Input Type | Description | Example |
|---|
| General |
| defaultValue(string) | | any | Use the string argument value as the replacement value if the token is not present or is the empty string. | ${field:defaultValue('missing')} |
| passThrough | none | any | Don't perform any formatting. | ${field:passThrough} |
| URL Encoding |
| encodeURI | uri | string | URL encode all special characters except ',/?:@&=+$#' like JavaScript encodeURI() | ${field:encodeURI} |
| encodeURIComponent | uricomponent | string | URL uncode all special characters like JavaScript encodeURIComponent() | ${field:encodeURIComponent} |
| htmlEncode | html | string | HTML encode | ${field:htmlEncode} |
| jsString | | string | Escape carrage return, linefeed, and <>"' characters and surround with a single quotes | ${field:jsString} |
| urlEncode | path | string | URL encode each path part preserving path separator | ${field:urlEncode} |
| String |
| join(string) | | collection | Combine a collection of values together separated by the string argument | ${field:join('/'):encodeURI} |
| prefix(string) | | string, collection | Prepend a string argument if the value is non-null and non-empty | ${field:prefix('-')} |
| suffix(string) | | string, collection | Append a string argument if the value is non-null and non-empty | ${field:suffix('-')} |
| trim | | string | Remove any leading or trailing whitespace | ${field:trim} |
| Date |
| date(string) | | date | Format a date using a format string or one of the constants from Java's DateTimeFormatter. If no format value is provided, the default format is 'BASIC_ISO_DATE' | ${field:date}, ${field:date('yyyy-MM-dd')} |
| Number |
| format | | number | Format a number using Java's DecimalFormat | ${field:number('0000')} |
| Array |
| first | | collection | Take the first value from a collection | ${field:first:defaulValue('X')} |
| rest | | collection | Drop the first item from a collection | ${field:rest:join('_')} |
| last | | collection | Drop all items from the collection except the last | ${field:last:suffix('!')} |
Examples
| Function | Applied to... | Result |
| ${Column1:defaultValue('MissingValue')} | null | MissingValue |
| ${Array1:join('/')} | [apple, orange, pear] | apple/orange/pear |
| ${Array1:first} | [apple, orange, pear] | apple |
| ${Array1:first:defaultValue('X')} | [(null), orange, pear] | X |
