Write a Template

While we provide some basic templates that you can use, including a .csv and a .feature template, they might not suit your needs and you might want to edit them or to create custom templates from scratch. 

In order to do that, you will need to have some basic experience in scripting or coding. That being said, it is possible to figure it out even without the relevant experience, it will just take a bit longer. 

Write a Template

In order to write a template, use the DotLiquid framework which is a port of Liquid templating language.

In DotLiquid, you can refer to an object and its fields by encasing them in double curly brackets. Example: 

{{ test_case.title }} <!-- refers to a test case title -->

{{ test_case.created_by.first_name }} <!-- refers to the first name of the test case author -->

You can also use various filters to achieve your goals as well as iterations to go through a collection of object fields.

Filters

A good example of filter usage could be getting rid of line breaks, for instance. In order to do that, you would use strip filter along with replace filter. In this case, using this code

{{ step.action_flat | replace: '\n', " " | strip }}

would transform the step action from multiline

When I scroll up
And I click on "Element"

into 

When I scroll up And I click on "Element"

Iteration

In TestFirst templates, the only collection of object fields currently available is the test case steps. In the below code you can see a basic iteration through the steps. 

{% for step in test_case.steps %}
{{ step.number }}. {{ step.action.flat }}
{{ step.expected_result.flat }}
{% endfor %}

The output of this iteration in the exported file will look like this: 

1. Step 1 action
Step 1 expected result

2. Step 2 action
Step 2 expected result

3. Step 3 action
Step 3 expected result

Further information on DotLiquid

You can read the following articles to help you further understand the syntax and see what you can do with it. Use the Object Model description below to see which fields you can use in your templates.

• DotLiquid templating framework - to understand what it's all about;
• Liquid introduction - to get started with the templates;
• Browse through the Liquid documentation to get an understanding of operators, filters, and more.

Object Model

System fields

You can use the following object model in order to create an export template. 

Custom fields

Custom fields can be exported using export templates. In the template, a reference to a custom field should always start with c_ followed by the field's system name. Example:

test_case.c_custom_field_system_name
test_case.c_automation_status

In order to refer to a custom field property, use the dot notation:

test_case.c_autotmation_status.markdown

{% for value in test_case.c_multi_select_field_name %}
{{value.name}}
{% endfor %}

{% for value in test_case.c_multi_select_field_name %}{{value.name}};{% endfor %}