Template Overview¶
Reviewing a check template
Every check template has its own page. Its Overview tab shows what the template defines, how many checks it has created and how they are doing, and every change made to it. This page explains each part of the Overview and the page's header. The Checks and Anomalies tabs have their own pages: Template Checks and Template Anomalies.
Getting to the Template Page¶
- Click Library in the left side panel, then click a template in the list.
- On a check created from a template, click the Template badge in the Tags panel of the check's page. See Check Views.
- Open a link to the template, such as one copied with Copy Template Link.
Header¶
The top of the page shows where you are, Library followed by the template's number and rule type, such as #333976 Unique, and holds the tabs and actions.
| Element | What it does |
|---|---|
| Overview tab | The template's summary, description, definition, and Timeline. The rest of this page covers it section by section. |
| Checks tab | The checks created from the template. See Template Checks. |
| Anomalies tab | The anomalies found by those checks. See Template Anomalies. |
| Add | Creates checks from the template: Single Check opens the check form with the template selected, and Multiple Checks opens a wizard that creates one check per target. Disabled when your organization does not have the module the template's rule type requires. See Add a Check from a Template and Add Multiple Checks from a Template. |
| menu | Edit opens the template form, and Archive archives the template. See Edit a Template and Archive a Template. |
The Add button and the menu appear only to users with the Manager or Admin role. See Template Permissions.
Summary¶
The Summary opens the Overview tab. Two controls sit at its top right:
- View template definition scrolls down to the Definition.
- Copy Template Link copies a direct link to the template, to share with teammates.
Below them, a row of cards:
| Card | What it shows |
|---|---|
| Template | The rule type of the template, such as Not Null. |
| Type | Locked or Unlocked, with a lock icon. Hover the icon to see who edited the template last. The lock decides whether linked checks follow later edits, not whether the template can be edited: a locked template is still editable. See Locked and Unlocked Templates. |
| Importance | How much failures of the template's checks matter: Low, Medium, High, or Critical. Hover it to see what decided the level. See Check Importance. |
| Coverage | The percentage of evaluated records each check from the template must satisfy. |
| Checks | How many checks are linked to the template. When there is at least one, click on the card to open the Checks tab. See Template Checks. The label reads Check when the count is zero or one. |
| Active Anomalies | How many anomalies of the linked checks are still open. When there is at least one, click on the card to open the Anomalies tab. See Template Anomalies. The label reads Active Anomaly when the count is zero or one. |
Below the cards, the Tags panel lists the template's tags. Users with the Manager or Admin role can add or remove tags right there. Tag changes reach every check linked to the template, locked or unlocked.
Description¶
The Description explains, in plain language, what the template checks and why. It supports Markdown formatting.
Users with the Manager or Admin role can change it in place while the template is not archived:
- Edit description opens the text for editing.
- Suggest a description writes one from the template's definition. It appears only when an AI integration is configured.
On a locked template, a new description is copied to every linked check.
Definition¶
The Definition shows how the template is configured, read-only, in the same groups as the template form:
| Group | What it shows |
|---|---|
| Target | The Filter Clause. With no filter clause, the checks evaluate every record of their table or file. A filter with each() shows the full list of values. See Filter Permutations. |
| Properties | The settings specific to the rule type, such as the Number of Fields of a Field Count template, or the comparison and limits of a Metric template. |
| Metadata | The additional key-value metadata. With none, it reads No custom metadata property defined. |
The rule type, description, tags, coverage, and lock are not repeated here, since the Summary already shows them. To change the definition, use Edit from the menu.
Timeline¶
The Timeline, next to the Definition, is the chronological record of everything that happened to the template: its creation, each change to its configuration, and the comments your team leaves. Entries load as you scroll.
- Changes. Short values read
from <previous value> to <new value>. A long change collapses behind View changes, which reports the before and after lengths and expands into the From and To values. Several properties changed in one save are grouped into one entry. - Comments. Comment on the template from the box above the Timeline, or on a specific change with Comment below its entry. Reply with Reply , one level deep, and type
@to mention a teammate, who receives a Mention notification.
Comments, mentions, and change entries work as they do on a check. See Check Timeline for the details.
Timeline permissions
A check template does not belong to a datastore, so its Timeline follows the platform user role only: any user can read it, comment, reply, and manage their own comments. Deleting another user's comment requires the Admin role. See User Permissions.
See Also¶
-
Template Checks
Every check created from the template, across datastores, and how to review the drafts it creates.
-
Template Anomalies
The anomalies found by every check created from the template, and how to triage them from the template's page.
-
Template Examples
Scenarios that show when a template pays off, and whether to lock it.
-
Template Best Practices
How to name, lock, and maintain templates so their checks stay trustworthy.
-
Template Permissions
Who can create, edit, apply, archive, and export templates.
-
How Templates Work
What a template defines, how checks are created from it, and what Locked and Unlocked change.
-
Filter Permutations
How
each()in a template's filter creates one check per value, and how adding or removing values changes them.