Using Template Fields in Test Actions

Overview

Template fields are dynamic placeholders that resolve to values from the test execution context at runtime. They allow your action scripts, emails, and metadata values to reference the test's name, result, execution counts, URLs, and more — without hardcoding any of it.

Template fields use Handlebars syntax: {{field_name}}. When an action step executes, Validatar replaces each template field with the actual value from the completed test execution.

Where Template Fields Are Supported

Available Template Fields

Context Fields

These fields provide information about the test and its location within the project.

Result Fields

Timing Fields

Test Definition Fields

These fields describe how the test is built, so a ticket or log entry can show the query that failed.

Error Fields

Count Fields — Top Level

Count Fields — Row Level

Count Fields — Matched Rows

These fields apply to comparison tests where rows are matched between the test and control data sets.

Count Fields — Unmatched Test Rows

Rows from the test data set that did not match any row in the control data set.

Count Fields — Unmatched Control Rows

Rows from the control data set that did not match any row in the test data set.

Template Fields in Macros

A Run a Macro step resolves its script in two passes. The first fills in the macro's parameters. The second fills in template fields. The first pass removes any placeholder that is not one of the macro's parameters, so a template field written directly in a macro's script is gone before the second pass can resolve it.

To give a macro a template field, the macro declares a parameter for it, and you type the template field into that parameter in the step, for example {{result}} in a parameter named Test Result. The macros in Validatar's integration templates declare the parameters they need, and their help text gives the exact value to type. Open and Resolve Jira Issues from Test Results shows a complete example.

A macro's own script can also carry a template field past the first pass by escaping it with a backslash: the first pass turns \{{execution_url}} into {{execution_url}}, and the second pass fills it in. The Jira template's Automatic macros work this way. They take only the execution URL and read the rest of the run from the Validatar API. Nothing is typed into their steps.

Run a Script steps have no first pass, so template fields can be written anywhere in their script.

Helper References

In addition to template fields, the script editor in action steps provides access to helper references — the same Handlebars helper functions available in template test scripting. These enable more advanced logic within your action scripts.

For the full list of available helper functions, see [Template Test Functions]().

Using the Autocomplete

The script editor and the email body editor both support autocomplete for template fields and helper references:

1. Type { in the editor.
2. A popup appears listing all available template fields and helper references.
3. Use the arrow keys to navigate the list, or continue typing to filter.
4. Press Enter or Tab to insert the selected field.

The autocomplete inserts the full Handlebars expression (e.g., {{test_name}}) at the cursor position.

You can also open the template fields helper by clicking the helper icon next to text fields that support template fields. This opens a full reference panel with all available template fields, helper functions, and a code editor.

Scroll down in the helper panel to see the template fields available for insertion:

Examples

SQL Script: Log Test Results to an Audit Table

A "Run a Script" step that inserts the test result into a custom audit table after each execution:

INSERT INTO dq_audit.test_execution_log (
    project_name,
    test_name,
    result,
    started_at,
    completed_at,
    duration,
    passed_count,
    failed_count,
    error_count,
    execution_url
)
VALUES (
    '{{project_name}}',
    '{{test_name}}',
    '{{result}}',
    '{{start_date}}',
    '{{complete_date}}',
    '{{duration}}',
    {{passed_count}},
    {{failed_count}},
    {{error_count}},
    '{{execution_url}}'
);

SQL Script: Create a Ticket in an External System via API

Tip: For Jira Cloud, the Jira integration does this with a ready-made macro that needs no template fields. It also comments on repeat failures, resolves the issue when the test passes, and never opens a second issue for the same failure.

A "Run a Script" step using Python to call a JIRA API when a critical test changes status to "Now Failing":

import requests
import json

url = "https://your-domain.atlassian.net/rest/api/2/issue"
headers = {
    "Content-Type": "application/json",
    "Authorization": "Basic YOUR_API_TOKEN"
}

payload = {
    "fields": {
        "project": {"key": "DQ"},
        "summary": "Data Quality Alert: {{test_name}} is Now Failing",
        "description": (
            "Test *{{test_name}}* in project *{{project_name}}* "
            "has changed status to Now Failing.\n\n"
            "Result: {{result}}\n"
            "Failed Count: {{failed_count}}\n"
            "Execution: {{execution_url}}"
        ),
        "issuetype": {"name": "Bug"},
        "priority": {"name": "High"}
    }
}

response = requests.post(url, headers=headers, data=json.dumps(payload))

Email: Notify on Status Change

A "Send an Email" step with template fields in the subject and body:

Subject:

Data Quality Alert: {{test_name}} — {{result}}

Body:

The test {{test_name}} in project {{project_name}} has changed status.

Result: {{result}}
Started: {{start_date}}
Completed: {{complete_date}}
Duration: {{duration}}

Passed: {{passed_count}}
Failed: {{failed_count}}
Errors: {{error_count}}

View the execution details: {{execution_url}}

Metadata Value: Stamp a Linked Object

A "Set Linked Object Metadata Value" step on a text-type custom field called "Last Test Result":

Value:

{{result}} — {{test_name}} ({{complete_date}})

This sets the linked object's custom field to something like: Failed — Hub Customer BK Uniqueness (3/27/2026 2:15 PM).

Tips

• String values need quotes in SQL. When using template fields inside SQL string literals, wrap the field in single quotes: '{{test_name}}'. Numeric fields like {{passed_count}} do not need quotes.
• Preview before saving. For "Run a Script" and "Run a Macro" steps, use the Preview button to see the script with template fields resolved and verify the output.
• Template fields in metadata values work only with text-type custom fields. For dropdown, tag list, or user/group list fields, you select from predefined options rather than entering free text.
• The recipients field in email steps does not support template fields. Enter email addresses directly.

What's Next

• What are Test Actions — overview of test actions, triggers, and steps
• Configuring Simple Test Actions — step-by-step guide to creating triggers and steps