Things you need to know:

Jinja filters can be used to perform a number of useful tasks, for example, formatting text that is output.

Some commonly useful filters include:

{{ product.n|lower }}<!--Product Name-->

{{ product.n|title }}<!--Product Name-->

{{ product.n|escape}}<!--Product Name-->

For example, limit the maximum number of products shown in a browse abandonment email.

{% for product in products|limit(4) %}{{ product.n }}{% endfor %}

For example, sort products from highest to lowest price. Sorts ascending by default, specify reverse=True to sort descending.

{% for product in products|sort(attribute='uv',reverse=True) %}{{ product.n }}{% endfor %}

Combine with a limit filter:

{% for product in products|sort(attribute='uv',reverse=True)|limit(3) %}{{ product.n }}{% endfor %}

{{ product.n|trim}}<!--Product Name-->

In a cart layout:

{{ product.n[0:4] }}

In a SmartBlock layout:

{{ product.n.substring(0,4) }}

Both of the above examples display the first four characters of the product name field.

In a Cart layout:

{% set myString = 'A||B||C' %} {{ myString.split('||') }} Output: ['A','B','C']

In a SmartBlock layout or SmartBlock filter:

{% set myString = 'A||B||C' %} {{ myString|split('||') }} Output: ['A','B','C']

Each item of the array can then be accessed in a {% for %} loop. Alternatively, further Jinja filters can be applied to the array.

In a Cart layout, SmartBlock layout or SmartBlock filter:

{% set myArray = ['A','B','C'] %} {{ myArray|join('||') }} Output: 'A||B||C'

This is useful for gathering product field values such as categories into a string and injecting into a Recommendations SmartBlock.

{{ product.up|format_currency('£',2)}}<!--Product Price-->

The default currency symbol is only used if no symbol can be extracted from a text value, or if the input is a number. The default currency can be a symbol, or a supported currency code

Examples

{{ product.up|format_currency('USD',2)}}<!--Product Price-->

{{ product.up|format_currency(product.curr,2)}}<!--Product Price-->

Currently supported ISO 4217 codes are:

{{ product.up|format_currency('£',3)}}<!--Product Price-->

{{ product.up|format_currency('£',2,1)}}<!--Product Price-->

{{ product.uv|format_currency(product.curr,2,1, currency_separator=' ')}}<!--Product Price-->

{{ product.up|format_currency('£',2,0)}}<!--Product Price-->

{{ product.up|format_currency('£',2,0,',')}}<!--Product Price-->

{{ product.up|format_currency('£',2,1,',','.')}}<!--Product Price-->

{{ product.uv|format_currency(product.curr,2,0,decimal_separator=',',thousands='.', currency_separator=' ')}}<!--Product Price-->

{{ product.uv|format_currency(product.curr,2,1,decimal_separator='',thousands='.', currency_separator=' ') + ' '}}<!--Product Price-->

{{ product.opt.start_date|date }} Output: 2014-01-01

{{ product.opt.start_date|datetime }} Output: 2014-01-01 18:35

{{ signal.fdt | datetime_w3c }} Formats the datetime in w3c format, e.g. '2018-02-22T13:23:03.123221+00:00'. This format only available in Firehose field mappings. 2018-02-22T13:23:03.123221+00:00

{{ product.u|set_tracking(tmcv='3', tmcs='3kgnzlx') }}

If the product URL was https://www.mysite.com/product/1234/ , the resulting link might then look like:

<a href="https://www.mysite.com/product/1234/?tmcv=3&tmcs=3kgnzlx" />

{{ product.u|set_ga_tracking(utm_campaign='fr-cart-1', utm_medium='email', utm_source='fr') }}

If the product URL was https://www.mysite.com/product/1234/ , the resulting link might then look like:

<a href="https://www.mysite.com/product/1234/?utm_campaign=fr-cart-1&utm_medium=email&utm_source=fr&tmty=b&tmti=1&tmcv=3&tmtk=n8ogq5j&tmcs=hq6c15k" />

set_ga_tracking works for most links, but may re-order any existing query collection parameters for the link the function is applied to. If your website requires the existing parameters to appear first, you can append the GA tracking parameters to the end of the URL using the get_ga_tracking function:

{{ product.u }}{{ get_ga_tracking( utm_campaign=ga_campaign_code, utm_medium='email', utm_source='fr' ) }}

This function returns only the new system and GA tracking codes to be added. For example, the above call to get_ga_tracking returns something like this:

utm_campaign=fr-cart-1&tmcv=1&tmcs=mdpn6d0&tmty=b&utm_source=fr&utm_medium=email&tmti=1

{{ product.u|set_query_parameter('utm_campaign', 'campaign123') }}

If, in this example, the product URL is http://www.example.com/products?id=12345, the output would be http://www.example.com/products?id=12345&utm_campaign=campaign123.

{{ product.u|set_query_parameter('mailid', '{~mailID~}', false) }}

There is an optional parameter to both set_query_parameter and set_query_parameters which allows you to specify that any added parameters are not to be URL encoded. This is useful if you need to add in a merge code that is replaced by the ESP, for example, to merge in an ID.

If, in this example, the product URL is http://www.example.com/products?id=12345, the output would be http://www.example.com/products?id=12345&mailid={~mailID~}.

{{ product.u|set_query_parameters({'utm_campaign': 'campaign123', 'other': 'value'}) }}

If, in this example, the product URL is http://www.example.com/products?id=12345, the output would be http://www.example.com/products?id=12345&utm_campaign=campaign123&other=value.

{% set show_column = cart|should_show_regular_prices %}

This method looks at the cart and decides if it is sensible to show a regular price column. It returns true if all of the products have a unit price (up) less than the regular unit price (rup). You can then use the variable to show an extra column: {% if show_column %}{{ product.rup }}

{% set item_count = cart|get_cart_quantity %}

{% set is_in_category = product|is_in_categories(['photography', 'computers']) %}

This is set to True if the product belongs to either photography or cameras. Otherwise, it’s False.

{% set is_in_category = product|is_in_categories(['photography', 'lenses'], True) %}

This is set to True if the product belongs to both the photography and lenses categories. Otherwise, it‘s False.

{% set is_in_category = product|is_not_in_categories(['photography', 'lenses']) %}

This is set to False if the product belongs to either the photography or lenses categories. Otherwise, it‘s True.

{% set prods_in_categories = products|products_in_categories(['photography', 'lenses']) %}

This is set to the number of products that match either photography or lenses, to only return products that match both photography and lenses, and a true parameter on the end.

{% set prods_in_attribute = products|products_match('sku',['test_camera', 'test_lense']) %}

This is set to the number of products that have an SKU of either test_camera, or test_lense. This can be used for extra and optional product data by simply adding ex. or opt. at the start.

{% set carted_categories = products|get_categories('||') %}

This is set to a string of all categories in the cart, separated by the parameter you define.

{% set carted_product_ids = products|get_prids('||') %}

This is set to a string of all product IDs in the cart, separated by the parameter you define.

{% set carted_skus = products|get_attributes('sku','||') %}

This is set to a string of all the values of the attribute defined, in this case SKU, in the cart, separated by the parameter you define.

{{ currentProduct.uv }}

For example brand (if captured):

{{ currentProduct.ex.brand }}

{{ currentProduct.stock }}

{{ 'SoMe! cateGory '|catid }}

Output: some-category

This method allows you to slugify a tag value (category ID).

Output: 'some-group:some-category'

This method allows you to slugify a category ID and add a tag group.

{{ ['SoMe !cateGory', 'some Group:Some Category',]|catid('Some Group') }}

Output: ['some-group:some-category', 'some-group:some-category']

This method allows you to format and sanitize multiple tag values (category IDs), also allows you to add a tag value (category) to any or all of the inputs.

{{ 'Some Group:SoMe! cateGory'|catid('Different Group') }}

Output: 'different-group:some-category'

Replaces tag group, and slugifys output.

For: product.cat = [{'gid': 'shoe-size', 'n': '11' },{'gid': 'shoe-size', 'n': '14'}] {{ product|getCategoryValueFromProduct('shoe-size') }}}

Output: [11, 14]

Retrieves an array of values from tags (categories) that match the given gid.

For: product.cat = [{'gid': 'shoe-size', 'n': '11' },{'gid': 'shoe-size', 'n': '14'}] {% set example = product.cat|filterGroup('Shoe Size')%}{{example[0].n}}

Output: '11'

Filters categories by group name and returns an array of matching categories.

Allows you to prefix merged in values, for example with a tag group name. Useful in a Recommendations SmartBlock tag value (Category) filter.

Output: shoe-size:5||shoe-size:7

For a given product or list of product, exclude categories by tag value (category name - parameter 1), or by group name (parameter 2)

Output: 'brand:marvel'

Output: 'toys-and-games'

Output: 'shoes'

For a given product or list of products, only return tag values (categories) by name (parameter 1), or by tag (group) name (parameter 2)

Output: 'toys-and-games'

Output: 'brand:marvel'

Output: 'toys-and-games||books||brand:marvel||gender:boys'

Given a list of tags (categories), return them joined by a delimiter:

Output: 'toys-and-games||brand:marvel'

Output: ['Marvel']

Output: ['cornwall', 'uk']

For example, for merging into tracked links:

{{ meta.q.tmsb }}

{% if meta and meta.primary == true %}{% endif %}

{% if meta and (meta.fallback == 2 or meta.fallback == 3) %}{% endif %}

{% if product.meta and product.meta.fallback != true %}{% endif %}

{% if product.meta and product.meta.fallback == true %}{% endif %}

{% if product.meta and product.meta.fbn == 1 %}{% endif %}

{{ product.reviews.rating }}

{{ product.reviews.ratingCount }}

Converts any date string of a specified syntax into a JavaScript Date object

{{parseDate('Dec. 25. 2020', 'MMM. DD. YYYY')}}

Output: 'Fri Dec 25 2020 00:00:00 GMT+0000 (GMT)'

Tokens show how the date string is formatted:

Examples

07.03.2016 = 'DD.MM.YYYY'

March, 10th 2020 = 'MMMM, Do YYYY'

Converts any ISO formatted date string into a Date object.

{{ getDate('2017-03-09')}}

Output: '2017-03-09 00:00:00'

Can be used on various fields including product, cart and person data:

{{ getDate(product.ex.presentation_date) }}

getDate is especially useful for returning the current date and time:

{{ getDate() }}

Combining both of the above allows you to compare if a particular field is before or after today: {% if getDate(product.ex.presentation_date) > getDate() %}

The output of getDate can also be reformatted, by combining it with the date filter:

{{ getDate(product.ex.presentation_date)|date('%d %m %Y') }}

Output: '10 03 2017'

Add a specified number of days to a date by combining with getDate().

For example, add a specified number of days to today:

{{ getDate()|addDays(7) }}

Alternatively, subtract days or apply to a product date field:

{{ getDate(product.ex.presentation_date)|addDays(-7) }}

Check if all the items in a list contain a given field. Useful for checking, for example, if all products contain review data.

{% set SortValue = "reviews.rating" if products|all_items_contain_field("reviews.rating", True) else "uv" %}

The first parameter is the field to look for. The second parameter, if set to True, checks if all the items are the same type, for example, numbers.

Function to get the type of a particular item. Operates the same for SmartBlocks and Cart layouts.

{% set type_of_item = type_of(item) %}

This returns:

This is a Jinja2 filter that extracts all the products that a person has previously browsed or abandoned, based on their signal history, from their person record. The filter returns a list of product dictionaries containing all of the product's details.

Using the default parameters:

{{ person | get_products_from_signals }}

Explicitly specifying parameters:

{{ person | get_products_from_signals(1440, 'ba', True) }}

Definitions of each parameter:

{{ person | get_products_from_signals(numMin, signalType, ignoreLastSignal) }}

You could then apply more filters to extract the parameters you are interested in and store it in a variable to use later:

{% set previous_prids = person | get_products_from_signals | get_prids %}

Returns the person's best tag values (categories) from best to worst, matching the supplied options.

Takes the form:

{{ person|bestCategory(options) }}

Example

To return up to 10 best tag values (categories) over the last 7 days in array format, falling back to electronics if no tag values (categories) are found, and excluding gifts:

{{ person|bestCategory({days:7, max:10, format:'array', fallback:['electronics'], excludeCategories:['gifts']}) }}

For a person that had browsed two computers tag values (categories) and one gifts tag value (category), the output is: [computers,gifts] .

Full list of options:

The data for each SKU's variant is stored in an object in product.variants, where the key of the object is the variant ID. This object can be processed manually but there are some Jinja filters designed to make it easier to handle SKU-level variants.

The function getVariantIdsFromProduct returns an array of the variant IDs that the supplied product includes. If the supplied product does not contain any SKU-level variants, an empty list is returned.

{{ product | getVariantIdsFromProduct }}

Example result:

["SKU1001", "SKU1002"]

To get the full SKU-level variant object you need to combine the special variant data from product.variants with the base product fields.

To simplify this process there is a Jinja filter called getVariantFromProduct that you can use.

Supply this filter a product and the variant ID (vid) that you want to use and it combines all the data and returns the full variant object for that vid. If that variant doesn't exist for the given product then it returns null.

{{ product | getVariantFromProduct("SKU1001") }}

To get an array of all of the variants of a product, use the getAllVariantsFromProduct helper.

This is the same as using the getVariantFromProduct helper to make each variant in turn.

If the product contains no variants then an empty array is returned.

{{ product | getAllVariantsFromProduct }}

Returns a secure SHA-1 hash message digest from the value provided.

{{ 'Hello World'|sha1 }}

{{ person.email|sha1 }}

{{ person.mobile|sha1 }}

Returns a URL-safe Base64 encoded version of the value provided.

{{ 'Hello World'|base64 }}

{{ person.email|base64 }}

{{ person.mobile|base64 }}

To strip equals signs, pass True as the first parameter:

{{ 'Hello World'|base64(True) }}

Returns an RSA encrypted version of the provided string. RSA keys must have been previously set up.

An optional role value can be passed to choose the key role to use.

{{ 'Hello World'|rsa_encrypt }}

{{ person.email|rsa_encrypt }}

{{ person.mobile|rsa_encrypt }}

In some situations it might be preferable to use shortened URLs in cart layouts. This is particularly useful in SMS messages.

This can be done using the shorten_url helper:

{{ product.u | shorten_url }}

This can also be combined with other functions such as the set_ga_tracking function:

{{ product.u | set_ga_tracking(utm_campaign=ga_campaign_code,utm_medium='email',utm_source='targeting') | shorten_url }}

If you don’t want the https:// protocol to be included in the short URL, you can specify this by passing false into the function:

{{ product.u | shorten_url(false) }}

In order for the popover reporting to function correctly, we need to use special functions to indicate when a popover has been Shown, Dismissed and Submitted.

The functions should be used in the relevant JavaScript of the popover at the point where each action takes place.

$TB.popoverShown('{{ slotid }}')

$TB.popoverDismissed('{{ slotid }}')

$TB.popoverSubmitted('{{ slotid }}', emailAddress)

You can submit additional data inside the popover in additional parameters, in the following format:

$TB.popoverSubmitted('{{ slotid }}', emailAddress, rootData, extendData)

The rootData object contains some core person fields used in Fresh Relevance. The list of fields that can be submitted is below:

extendData contains any other data that you might want to submit with this popover.

Example popoverSubmitted signal with gender passed into extendData:

$TB.popoverSubmitted({{ slotid }}, emailAddress, {'fn': firstName, 'ln': lastName}, {'gender': customerGender})