Formatting Your Data
Here is a list of available modifiers/helpers. These modifiers/helpers are added along with the tokens(merge field).
Modifier/Helper | Description | Example |
Uppercase | Convert all characters to uppercase | {{upper company_name}} |
Lowercase | Convert all characters to lowercase | {{lower client.name}} |
Capitalize | Capitalize the first letter | {{capitalize client_name}} |
Format Date/Time | Convert date and time to a specific format | {{format_date _date 'DD-MM-YY'}} |
Format Number | Change the format of a number (thousands and decimals) | {{format_number number "." "," "3"}} |
Abbreviation | Convert text to abbreviation (First letter of each word in caps) | {{abbreviate name "."}} |
Format Phone | Change the format of your phone number. It can also be used to format a number | {{format_phone landline "(%3) %3-%4"}} |
Number to words | Converts the input number in to words. | {{number_to_words input}} |
Number to Ordinal | Converts the input number to its ordinal form, in words. | {{number_to_ordinal input}} |
Join | Joins the input array of strings with given separator (defaults to | {{join items ", "}} {{join items ", " lookup="object.name"}} |
Replace | Replaces the match string from input with given replace string | {{replace str1 str2}{{replace content (regex "[0-9]" "g") "*"}} |
Regex | Return a RegExp class instance with given pattern and flags | ​ {{replace content (regex "(0-9)" "g") "*"}} |
Split | Splits input with given separator (defaults to | {{#each (split input ", ")}} ... {{/each}} |
Strip | Strips the input of given match characters (defaults to white space) from given position ( | {{strip input}} {{strip input "*" side="left"}} |
Sort | Sorts input in the given order ( | {{# list (sort items lookup="price" order="asc")}} ... {{/list}} {{#list (sort items order="asc")}} ... {{/list}} |
Var | Can be used to store and retrieve the data within the template | {{var "store" 500}} {{var "store"}} |
Pad | Appends or prepends a single character repeatedly to fill input to given width. | {{pad number 9}} {{pad input 5 pad_with='*' style='suffix'}} |
Concat | Appends text. | {{concat string1 string2}} |
Group by | Groups data by given lookup. | {{#each (group_by items lookup="company")}}..... {{/each}} |
URL encode | Encodes a URL replacing special characters with encoded text. | {{url_encode URL is_url=false}} {{url_encode URL is_url=true}} |
URL decode | Decodes the encoded URL | {{url_decode URL is_url=false}} {{url_decode URL is_url=true}} |
Syntax: {{format_date token_name "format" "language_code" "add/subtract time"}}
Name | Mandatory | Default Value | ​ |
1 | format | Yes | ​ |
2 | language code | No | en ​ English(United States) ​ |
3 | add/subtract time | No | ​ |
Example | Input | Output |
| 2019-05-25 | 25-05-19 |
| 2019-05-25 | mai 25 2019 |
| 2019-08-20 | August 20 2020 |
Example formats | Output |
DD-MM-YY | 21-11-18 |
ddd MMM DD HH:mm:ss | Wed Nov 21 14:08:25 |
MMMM DD YYYY HH:mm:ss | November 21 2018 14:08:25 |
MMMM DD YYYY | November 21 2018 |
MMM DD YYYY | Nov 21 2018 |
YYYY-MM-DD | 2018-11-21 |
MM-DD-YYYY | 01-22-2006 |
MM/DD/YYYY | 01/22/2006 |
MM/DD/YY | 01/22/06 |
DD-MM-YYYY | 22-01-2006 |
DD/MM/YYYY | 22/01/2006 |
DD/MM/YY | 22/01/06 |
X | 1542758400 |
​ | Token | Output |
Year | YYYY | 2000, 2001, 2002 ... 2012, 2013 |
​ | YY | 00, 01, 02 ... 12, 13 |
Month | MMMM | January, February, March ... |
​ | MMM | Jan, Feb, Mar ... |
​ | MM | 01, 02, 03 ... 11, 12 |
​ | M | 1, 2, 3 ... 11, 12 |
Day of Year | DDDD | 001, 002, 003 ... 364, 365 |
​ | DDD | 1, 2, 3 ... 364, 365 |
Day of Month | DD | 01, 02, 03 ... 30, 31 |
​ | D | 1, 2, 3 ... 30, 31 |
Day of Week | dddd | Monday, Tuesday, Wednesday ... |
​ | ddd | Mon, Tue, Wed ... |
​ | d | 1, 2, 3 ... 6, 7 |
Hour | HH | 00, 01, 02 ... 23, 24 |
​ | H | 0, 1, 2 ... 23, 24 |
​ | hh | 01, 02, 03 ... 11, 12 |
​ | h | 1, 2, 3 ... 11, 12 |
AM / PM | A | AM, PM |
​ | a | am, pm |
Minute | mm | 00, 01, 02 ... 58, 59 |
​ | m | 0, 1, 2 ... 58, 59 |
Second | ss | 00, 01, 02 ... 58, 59 |
​ | s | 0, 1, 2 ... 58, 59 |
Sub-second | SSS | 000, 001, 002 ... 998, 999 |
​ | SS | 00, 01, 02 ... 98, 99 |
​ | S | 0, 1, 2 ... 8, 9 |
Timestamp | X | 1381685817 |
Language code | Language & Country |
en-au | English (Australia) |
en-ca | English (Canada) |
en-ie | English (Ireland) |
en-il | English (Israel) |
en-nz | English (New Zealand) |
en-gb | English (United Kingdom) |
fr | French |
fr-ca | French (Canada) |
fr-ch | French (Switzerland) |
de | German |
de-at | German (Austria) |
de-ch | German (Switzerland) |
hu | Hungarian |
pt | Portuguese |
To adjust a date/time by a specific amount, you need to supply <+/-> <amount as a number> <unit>. Unit can be "years", "months", "weeks", "days", "hours", "minutes", or "seconds". Here are some examples:
+1hours-3days+5years+2months-3minutes+8h
Example | Input | Output |
| 2019-08-20 | August 20 2020 |
| 2019-08-20 | February 20, 2020 |
Syntax: {{format_number number thousand_sep decimal_sep number_of_decimal_places}}
Example | Input | Output |
| 123456 | 123.456 |
| 12345.12345 | 12.345,123 |
Syntax: {{abbreviate name suffix}}
The Suffix is not mandatory.
Example | Input | Output |
| John Doe | JD |
| John Doe | J.D |
Syntax: {{format_phone landline "format"}}
Example | Input | Output |
| 9878072739 | (987) 807-2739 |
| 9876543210 | +1-987-654-3210 |
| 1234567890123456 | 1234-5678-9012-3456 |
Format: {{number_to_words input ouput_format="in" suffix=" " decimal_suffix=" "}}
Example | Input | Output |
| 123456 | one hundred and twenty-three thousand four hundred and fifty-six |
| 800.658 | Eight hundred dollars six hundred and fifty-eight cents |
| 9893.567 | nine thousand eight hundred and ninety-three rupees five hundred and sixty-seven paise |
| 7000000 | seventy lakh rupees |
| 7000000 | seven million dollars |
Format: {{number_to_ordinal Number}}
Example
Input | Output | ​ |
| 800 | eight hundreth |
| 582 | Five hundred and eighty-second |
| 789.325 | seven hundred and eighty-ninth |
Syntax: {{join content separator lookup="lookup_key"}}
Example 1:
{{join input ","}}
Input | Output |
John Mary Paul | John,Mary,Paul |
Example 2:
{{join employees lookup="Name.Firstname"}}
Input | Output |
Firstname Lastname Peter Parker Tony Stark Steve Rogers | Peter,Tony,Steve |
Syntax: {{replace input match_str replace_str}} ( Here the match_str can be either a text or regex)
Example | Input | Output |
| Input to_replace replacer Mary Ross Ross Jane | Mary Jane |
| Ragax | Regex |
Syntax: {{regex pattern flags}} (No flags are set by default).
Example | Input | Output |
|
|
|
|
|
|
Syntax: {{strip input match_str side=side}}
Example | Input | Output |
|
|
|
|
|
Syntax: {{split input separator}} (separator can either be text or Regex)
Example | Input | Output |
| John,Doe,Cleveland |
|
| John12Doe34Cleveland | ​
|
Syntax: {{sort content order=order lookup="lookup_key"}}
Example 1:
{{#each (sort cost order="desc")}}
{{this}}
{{/each}}
Input | Output |
750 150 500 | 150 500 750 |
Example 2:
{{#each (sort items lookup="price" order="asc")}}
{{name}} is available at {{price}} per {{unit}}.
{{/each}}
Input | Output |
Name Price Unit Pen 20 5 Pencil 10 4 Book 25 3 | Pencil is available at 10 per 4. Pen is available at 20 per 5. Book is available at 25 per 3. |
Note : The helpers Split, Sort and Regex are Sub-Expression only helpers which can be used with loop helpers like each and list
Syntax: {{var "token" value}}
Example | Output |
| Here the token cost is assigned a value of 500. |
| Here the token price is assigned a value of 7599. |
| Here the value in token MRP is assigned to the token amount. |
Syntax: {{var "token"}}
Example | Output |
| 500 |
| 7599 |
Pad helper fills up the input to the desired width by adding a single character repeatedly either at the beginning or at the end.
Syntax: {{pad number output_width pad_with='character' style='prefix|suffix'}}
Example 1:
{{pad number 7}}
Input | Output |
123 | 0000123 |
Example 2:
{{pad number 9 pad_with='#' style='suffix'}}
Input | Output |
123456 | 123456### |
Syntax : {{concat string1 string2 ....}}
Example:
{{insert_image (concat "https:" url) 300 300}}
Input:
//raw.githubusercontent.com/tiholic/exif-orientation-examples/master/Portrait_0.jpg
Output:
Group by helper groups the data with the value of lookup key as grouping criteria.
Syntax: {{group_by items lookup="lookup_key"}}
Key and items can be accessed from inside the iterator(#each or #list). Key contains value of "lookup_key" for the current record, items contain the records which are present under current group.
Example 1:
{{#each (group_by employees lookup="role.code")}}
Number of employees in role {{key}}: {{items.length}} and they are {{join items ", " lookup="name.first"}}
{{/each}}
Input: (JSON)
{
"employees": [
{ "role":{ "code": "TL" }, "name": { "first": "Dave" } },
{ "role": { "code": "TL" }, "name": { "first": "Chris" } },
{ "role": { "code": "PM" }, "name": { "first": "Matt" } },
{ "role": { "code": "TL" }, "name": { "first": "Emma" } },
{ "role": { "code": "PM" }, "name": { "first": "Jenn" } }
]
}
Output :
Number of employees in role TL: 3 and they are Dave, Chris, Emma
Number of employees in role PM: 2 and they are Matt, Jenn
In the above example,
"TL" and "PM" are the group
keys.itemscorresponding to the key "TL" are :{ "role": { "code": "TL" }, "name": { "first": "Emma" } }{ "role": { "code": "TL" }, "name": { "first": "Chris" } }{ "role":{ "code": "TL" }, "name": { "first": "Dave" } }
itemscorresponding to the key "PM" are:{ "role": { "code": "PM" }, "name": { "first": "Jenn" } }{ "role": { "code": "PM" }, "name": { "first": "Matt" } }
Example 2:
{{#each (group_by places)}}
Number of branches in {{key}}: {{items.length}}
{{/each}}
Input: (JSON)
{
"places": [
"New York",
"Las Vegas",
"Chicago",
"New York",
"Las Vegas",
"New York"
]
}
Output:
Number of branches in New York: 3
Number of branches in Las Vegas: 2
Number of branches in Chicago: 1
In the above example,
"New York", "Las Vegas" and "Chicago" are the group
keys.Number of
itemscorresponding to the key "New York" are 3.Number of
itemscorresponding to the key "Las Vegas" are 3.Number of
itemscorresponding to the key "Chicago" is 1.
URL encode helper replaces special characters inside a URL with encoded text.
Syntax : {{url_encode URL is_url=true|false}}
Example1:
{{url_encode url is_url=true}}
Input : (JSON)
{
"url": "https://dummyimage.com/600x400/000/fff&text=hello world"
}
Output: https://dummyimage.com/600x400/000/fff&text=hello%20world
Example2:
{{url_encode url is_url=false}}
Input : (JSON)
{
"url": "https://dummyimage.com/600x400/000/fff&text=hello world"
}
Output: https%3A%2F%2Fdummyimage.com%2F600x400%2F000%2Ffff%26text%3Dhello%20world
URL decode helper decodes encoded URLs into pre-encoded forms.
Syntax : {{url_decode URL is_url=true|false}}
Example1:
{{url_decode url is_url=true}}
Input : (JSON)
{
"url": "https://dummyimage.com/600x400/000/fff&text=hello%20world"
}
Output: https://dummyimage.com/600x400/000/fff&text=hello world
Example2:
{{url_decode url is_url=false}}
Input : (JSON)
{
"url": "https%3A%2F%2Fdummyimage.com%2F600x400%2F000%2Ffff%26text%3Dhello%20world"
}
Output: https://dummyimage.com/600x400/000/fff&text=hello world
Encoding or decoding a url depends on the value of the parameter 'is_url'. If the value is true, only the query parameter part of the complete URL is encoded/decoded else, whole of the url is encoded/decoded. Default value of is_url is set as false.