[Quick Reference] Liquid Template - Reference Manual for Dynamics 365 Portals - DotLiquid, Dynamics 365, Dynamics CRM, Liquid, Portals, TemplateDotLiquid, Dynamics 365, Dynamics CRM, Liquid, Portals, Template

In Adxstudio (version 7.x), we can create templates using one of two methods.

Page Templates – Custom .aspx pages deployed to the server
Web Templates – Dynamics 365 Entity which is used to define dynamic content rendering

With the introduction of SaaS based Dynamics 365 Portals, the Page Template is no longer an option (For comparison of version 7.x and 8.x of Portals, click here). Web Templates are built using a web templating system called “Liquid”. Liquid can also be used inside Web Page’s Copy (HTML) field to render dynamic content. We are heavily reliant on Web Templates and Liquid now than ever before. This article serves as a quick reference guide which includes many resources to master Liquid.

What is Liquid?

Liquid is an open-source template language created by Shopify and written in Ruby. The code base was ported to .NET by Tim Jones to another open-source project called DotLiquid. Dynamics 365 Portals (also Adxstudio) use DotLiquid as the Liquid Template Engine of their portal. DotLiquid is a complete port of the original Shopify Liquid project. Therefore, the Shopify documentation is also valid and useful when designing Dynamics 365 Portal’s Liquid statements.

Where can I use Liquid?

Web Templates
Copy (HTML) field of a Web Page
Content Snippets

Liquid Basics

We need to learn three key terms, when using Liquid.

Tags – Liquid tags are the programming logic that tells templates what to do. Tags are wrapped in: {% %} characters. Certain tags, such as for and cycle can take on parameters.

Objects – Liquid objects contain attributes to output dynamic content on the page. For example, the page object contains an attribute called title that can be used to output the title of a page. Liquid objects are also often referred to as Liquid variables. To output an object’s attribute, wrap the object’s name in {{ and }}.

Filters – Filters are simple methods that modify the output of numbers, strings, variables and objects. They are placed within an output tag {{ }} and are denoted by a pipe character |.

Tags

Control flow tags

{% if product.title == 'Awesome Shoes' %}
  You are buying some awesome shoes!
{% endif %}

{% if product.title == 'Awesome Shoes' %}

You are buying some awesome shoes!

{% endif %}

unless

{% unless product.title == 'Awesome Shoes' %}
  You are not buying awesome shoes.
{% endunless %}

{% unless product.title == 'Awesome Shoes' %}

You are not buying awesome shoes.

{% endunless %}

else / elsif

{% if shipping_method.title == 'International Shipping' %}
  You're shipping internationally. Your order should arrive in 2–3 weeks.
{% elsif shipping_method.title == 'Domestic Shipping' %}
  Your order should arrive in 3–4 days.
{% else %}
  Thank you for your order!
{% endif %}

{% if shipping_method.title == 'International Shipping' %}

You're shipping internationally. Your order should arrive in 2–3 weeks.

{% elsif shipping_method.title == 'Domestic Shipping' %}

Your order should arrive in 3–4 days.

{% else %}

Thank you for your order!

{% endif %}

case / when

{% case shipping_method.title %}
  {% when 'International Shipping' %}
     You're shipping internationally. Your order should arrive in 2–3 weeks.
  {% when 'Domestic Shipping' %}
    Your order should arrive in 3–4 days.
  {% when 'Local Pick-Up' %}
    Your order will be ready for pick-up tomorrow.
  {% else %}
     Thank you for your order!
{% endcase %}

{% case shipping_method.title %}

{% when 'International Shipping' %}

You're shipping internationally. Your order should arrive in 2–3 weeks.

{% when 'Domestic Shipping' %}

Your order should arrive in 3–4 days.

{% when 'Local Pick-Up' %}

Your order will be ready for pick-up tomorrow.

{% else %}

Thank you for your order!

{% endcase %}

Multiple conditions (and / or)

and

{% if line_item.grams > 20000 and customer_address.city == 'Ottawa' %}
  You're buying a heavy item, and live in the same city as our store. Choose local pick-up as a shipping option to avoid paying high shipping costs.
{% endif %}

{% if line_item.grams > 20000 and customer_address.city == 'Ottawa' %}

You're buying a heavy item, and live in the same city as our store. Choose local pick-up as a shipping option to avoid paying high shipping costs.

{% endif %}

{% if customer.tags contains 'VIP' or customer.email contains 'mycompany.com' %}
  Welcome! We're pleased to offer you a special discount of 15% on all products.
{% else %}
  Welcome to our store!
{% endif %}

{% if customer.tags contains 'VIP' or customer.email contains 'mycompany.com' %}

Welcome! We're pleased to offer you a special discount of 15% on all products.

{% else %}

Welcome to our store!

{% endif %}

Iteration tags

for (maximum of 50 results per page)

{% for product in collection.products %}
  {{ product.title }}
{% endfor %}

{% for product in collection.products %}

{% endfor %}

else

{% for product in collection.products %}
  {{ product.title }}
{% else %}
  The collection is empty.
{% endfor %}

{% for product in collection.products %}

{% else %}

The collection is empty.

{% endfor %}

break

{% for i in (1..5) %}
  {% if i == 4 %}
    {% break %}
  {% else %}
    {{ i }}
  {% endif %}
{% endfor %}

{% for i in (1..5) %}

{% if i == 4 %}

{% break %}

{% else %}

{% endif %}

{% endfor %}

continue

{% for i in (1..5) %}
  {% if i == 4 %}
    {% continue %}
  {% else %}
    {{ i }}
  {% endif %}
{% endfor %}

{% for i in (1..5) %}

{% if i == 4 %}

{% continue %}

{% else %}

{% endif %}

{% endfor %}

limit

<!-- numbers = [1,2,3,4,5] -->

{% for item in numbers limit:2 %}
  {{ item }}
{% endfor %}

<!-- output -->
<!-- 1 2 -->

{% for item in numbers limit:2 %}

{% endfor %}

offset

<!-- numbers = [1,2,3,4,5] -->
  {% for item in numbers offset:2 %}
    {{ item }}
  {% endfor %}

<!-- output 3 4 5 6 -->

{% for item in numbers offset:2 %}

{% endfor %}

range

{% for i in (3..5) %}
  {{ i }}
{% endfor %}

{% assign my_limit = 4 %}
{% for i in (1..my_limit) %}
{{ i }}
{% endfor %}

<!-- output 3 4 5 -->
<!-- output 1 2 3 4 -->

{% for i in (3..5) %}

{% endfor %}

{% assign my_limit = 4 %}

{% for i in (1..my_limit) %}

{% endfor %}

reversed

<!-- if array = [1,2,3,4,5,6] -->
{% for item in array reversed %}
  {{ item }}
{% endfor %}

<!-- output 6 5 4 3 2 1 -->

{% for item in array reversed %}

{% endfor %}

cycle

{% cycle 'one', 'two', 'three' %}
{% cycle 'one', 'two', 'three' %}
{% cycle 'one', 'two', 'three' %}
{% cycle 'one', 'two', 'three' %}

<!-- output -->

one
two
three
one

{% cycle 'one', 'two', 'three' %}

one

two

three

one

tablerow

<!-- input -->

<table>
  {% tablerow product in collection.products %}
    {{ product.title }}
  {% endtablerow %}
</table>

<!-- output -->

<table>
  <tr class="row1">
    <td class="col1">
      Cool Shirt
    </td>
    <td class="col2">
      Alien Poster
    </td>
    <td class="col3">
      Batman Poster
    </td>
    <td class="col4">
      Bullseye Shirt
    </td>
    <td class="col5">
      Another Classic Vinyl
    </td>
    <td class="col6">
      Awesome Jeans
    </td>
  </tr>
</table>

<table>

{% tablerow product in collection.products %}

{% endtablerow %}

</table>

<table>

Cool Shirt

</td>

Alien Poster

</td>

Batman Poster

</td>

Bullseye Shirt

</td>

Another Classic Vinyl

</td>

Awesome Jeans

</td>

</tr>

</table>

Variable tags

assign

<!-- input -->

{% assign favorite_food = 'apples' %}

My favorite food is {{ favorite_food }}.

<!-- output -->

My favorite food is apples.

{% assign favorite_food = 'apples' %}

My favorite food is {{ favorite_food }}.

My favorite food is apples.

capture

<!-- input -->

{% assign favorite_food = 'pizza' %}
{% assign age = 35 %}

{% capture about_me %}
I am {{ age }} and my favorite food is {{ favorite_food }}.
{% endcapture %}

{{ about_me }}

<!-- output -->

I am 35 and my favorite food is pizza.

{% assign favorite_food = 'pizza' %}

{% assign age = 35 %}

{% capture about_me %}

I am {{ age }} and my favorite food is {{ favorite_food }}.

{% endcapture %}

I am 35 and my favorite food is pizza.

increment

<!-- input -->

<ul>
  <li class="item-{% increment counter %}">apples</li>
  <li class="item-{% increment counter %}">oranges</li>
  <li class="item-{% increment counter %}">peaches</li>
  <li class="item-{% increment counter %}">plums</li>
</ul>

<!-- output -->

<ul>
  <li class="item-0">apples</li>
  <li class="item-1">oranges</li>
  <li class="item-2">peaches</li>
  <li class="item-3">plums</li>
</ul>

<ul>

<li class="item-{% increment counter %}">apples</li>

<li class="item-{% increment counter %}">oranges</li>

<li class="item-{% increment counter %}">peaches</li>

<li class="item-{% increment counter %}">plums</li>

</ul>

<ul>

<li class="item-0">apples</li>

<li class="item-1">oranges</li>

<li class="item-2">peaches</li>

<li class="item-3">plums</li>

</ul>

decrement

<!-- input -->

{% decrement variable %}
{% decrement variable %}
{% decrement variable %}

<!-- output -->

-1
-2
-3

{% decrement variable %}

-1

-2

-3

Theme tags

Objects

Objects are specific to Dynamics 365 Portals. Below are the commonly used objects.

Global Objects

entities – Allows you to load any Dynamics 365 entity by ID.

{% assign account = entities.account['936DA01F-9ABD-4d9d-80C7-02AF85C822A8'] %}
{% if account %}
  {{ account.name }} ({{ account.statecode.label }})
{% endif %}

{% assign entity_logical_name = 'contact' %}
{% assign contact = entities[entity_logical_name][request.params.contactid] %}
{% if contact %}
  {{ contact.fullname }} ({{ contact.parentcustomerid.name }})
{% endif %}

{% assign account = entities.account['936DA01F-9ABD-4d9d-80C7-02AF85C822A8'] %}

{% if account %}

{{ account.name }} ({{ account.statecode.label }})

{% endif %}

{% assign entity_logical_name = 'contact' %}

{% assign contact = entities[entity_logical_name][request.params.contactid] %}

{% if contact %}

{{ contact.fullname }} ({{ contact.parentcustomerid.name }})

{% endif %}

now – A date/time object that refers to the current UTC time, at the time the template is rendered.

page – Refers to the current portal request page. The page object provides access to things like the breadcrumbs for the current page, the title or URL of the current page, and any other attributes or related entities of the underlying Dynamics 365 record.

<ul class="breadcrumb">
  {% for crumb in page.breadcrumbs %}
    <li><a href="{{ crumb.url | escape }}">{{ crumb.title | escape }}</a></li>
  {% endfor %}
  <li class="active">{{ page.title | escape }}</li>
</ul>

<div class="page-header">
  <h1>{{ page.title | escape }}</h1>
</div>

<div class="page-copy">
  {{ page.adx_copy }}
</div>

<div class="list-group">
  {% for child in page.children %}
    <a class="list-group-item" href="{{ child.url | escape }}">
        {{ child.title | escape }}
    </a>
  {% endfor %}
</div>

<!-- Page {{ page.id }} was last modified on {{ page.modifiedon }}. -->

{% for crumb in page.breadcrumbs %}

<li><a href="{{ crumb.url | escape }}">{{ crumb.title | escape }}</a></li>

{% endfor %}

<li class="active">{{ page.title | escape }}</li>

</ul>

<h1>{{ page.title | escape }}</h1>

</div>

</div>

{% for child in page.children %}

</a>

{% endfor %}

</div>

params – A convenient shortcut for request.params.

request – Contains information about the current HTTP request.

{% assign id = request.params['id'] %}

<a href="{{ request.url | add_query: 'foo', 1 }}">Link</a>

{% assign id = request.params['id'] %}

settings – Allows you to load any Site Setting by name.

{{ settings["My Setting"] }}

{% assign search_enabled = settings["Search/Enabled"] | boolean %}
{% if search_enabled %}
  Search is enabled.
{% endif %}

{% assign pagesize = settings['page size'] | integer | default: 10 %}

{% if pagesize > 10 %}
  Page size is greater than 10.
{% endif %}

{% assign search_enabled = settings["Search/Enabled"] | boolean %}

{% if search_enabled %}

Search is enabled.

{% endif %}

{% assign pagesize = settings['page size'] | integer | default: 10 %}

{% if pagesize > 10 %}

Page size is greater than 10.

{% endif %}

sitemap – Allows access to the portal site map.

<h1>{{ sitemap.root.title }}</h1>

<ul class="breadcrumb">
  {% for crumb in sitemap.current.breadcrumbs %}
    <li><a href="{{ crumb.title }}">{{ crumb.title }}</a></li>
  {% endfor %}
  <li class="active">{{ sitemap.current.title }}</li>
</ul>

{% for child in sitemap.current.children %}
  <a href="{{ child.url }}">{{ child.title }}</a>
{% endfor %}

<!-- It's also possible to load a site map node by URL path: -->

{% assign node = sitemap["/content/page1/"] %}
{% if node %}
  {% for child in node.children %}
    <a href="{{ child.url }}">{{ child.title }}</a>
  {% endfor %}
{% endif %}

<h1>{{ sitemap.root.title }}</h1>

{% for crumb in sitemap.current.breadcrumbs %}

<li><a href="{{ crumb.title }}">{{ crumb.title }}</a></li>

{% endfor %}

<li class="active">{{ sitemap.current.title }}</li>

</ul>

{% for child in sitemap.current.children %}

<a href="{{ child.url }}">{{ child.title }}</a>

{% endfor %}

{% assign node = sitemap["/content/page1/"] %}

{% if node %}

{% for child in node.children %}

<a href="{{ child.url }}">{{ child.title }}</a>

{% endfor %}

{% endif %}

sitemarkers – Allows you to load any Site Markers by name.

{{ sitemarkers["Login"].url }}

{% assign my_sitemarker = sitemarkers["My Site Marker"] %}
{% if my_sitemarker %}
  <a href="{{ my_sitemarker.url }}">{{ my_sitemarker.adx_name }}</a>
{% else %}
  Site marker "My Site Marker" does not exist.
{% endif %}

{% assign my_sitemarker = sitemarkers["My Site Marker"] %}

{% if my_sitemarker %}

<a href="{{ my_sitemarker.url }}">{{ my_sitemarker.adx_name }}</a>

{% else %}

Site marker "My Site Marker" does not exist.

{% endif %}

snippets – Allows you to load any Content Snippet by name.

user – Refers to the current portal user, allowing access to all attributes of the underlying Dynamics 365 contact record. If no user is signed in, this variable will be null.

weblinks – Allows you to load any Web Link Set by name or ID.

<!-- input -->

{{ website.adx_name }} ({{ website.id }})

<!-- output -->

Community Portal (936DA01F-9ABD-4d9d-80C7-02AF85C822A8)

{{ website.adx_name }} ({{ website.id }})

Community Portal (936DA01F-9ABD-4d9d-80C7-02AF85C822A8)

website – Refers to the portal Website record, allowing access to all attributes of the Dynamics 365 Website (adx_website) record for the portal.

<!-- Load web link set by ID -->
{{ weblinks[page.adx_navigation.id].name }}

<!-- Load web link set by name -->
{% assign nav = weblinks["Primary Navigation"] %}
{% if nav %}
  <h1>{{ nav.title | escape }}</h1>
  <ul>
    {% for link in nav.weblinks %}
      <li>
        <a href="{{ link.url | escape }}" title="{{ link.tooltip | escape }}">
          {% if link.image %}
            <img src="{{ link.image.url | escape }}" alt="{{ link.image.alternate_text | escape }}" />
          {% endif %}
          {{ link.name | escape }}
        </a>
      </li>
    {% endfor %}
  </ul>
{% endif %}

{% assign nav = weblinks["Primary Navigation"] %}

{% if nav %}

<h1>{{ nav.title | escape }}</h1>

<ul>

{% for link in nav.weblinks %}

<li>

{% if link.image %}

{% endif %}

</a>

</li>

{% endfor %}

</ul>

{% endif %}

Filters

Array filters

batch
concat
except
first
group_by
join
last
order_by
random
select
shuffle
size
skip
take
then_by
where

Entity List filters

current_sort
metafilters
reverse_sort

Date filters

Math filters

ceil
divided_by
floor
minus
modulo
plus
round
times

String filters

append
capitalize
downcase
escape
newline_to_br
prepend
remove
remove_first
replace
replace_first
split
strip_html
strip_newlines
text_to_html
truncate
truncate_words
upcase
url_escape
xml_escape

Type filters

boolean
decimal
integer
string

URL filters

add_query
base
host
path
path_and_query
port
remove_query
scheme

Additional filters

default
file_size
has_role
liquid

Thank you for visiting Dyn365Apps.com.

Follow me on Twitter to get the latest news, tips and tricks and more …

Follow @dyn365apps

Until next time…

[Quick Reference] Liquid Template Engine Reference Manual for Dynamics 365 Portals

Dynamics 365 Apps

[Quick Reference] Liquid Template Engine Reference Manual for Dynamics 365 Portals

What is Liquid?

Where can I use Liquid?

Liquid Basics

Tags

Objects

Global Objects

Filters

Leave a Reply Cancel reply