Getting Started with Templates¶
Getting started with check templates
A check template is a reusable check definition: a rule type with its filter, properties, coverage, and description, but no table or field. Apply it to as many tables and files as you need, and every check it creates stays linked to it. Lock the template, and one edit updates all of those checks at once.
Templates live in the Library, in the left side panel, and belong to the whole organization rather than to one datastore.
Permissions
Creating, editing, applying, archiving, and exporting templates requires the Manager or Admin role. See Template Permissions.
Deep Dive¶
Understand what a template is, how its checks follow it, and what each part of its page shows.
Concepts¶
-
Templates Introduction
What a template is, why it keeps checks consistent, and how it relates to the checks it creates.
-
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.
Template View¶
-
Template Overview
Every part of a template's page: Summary, Description, Definition, and Timeline.
-
Template Checks
Every check created from the template, across all the datastores that hold one.
-
Template Anomalies
The anomalies found by every check created from the template, in one list.
Examples, Best Practices, and Permissions¶
-
Template Examples
Scenarios that show when a template pays off, and how Locked and Unlocked play out over time.
-
Template Best Practices
How to keep templates easy to find, and the checks they create trustworthy as templates change.
-
Template Permissions
Which user roles work with templates, and which team permissions creating their checks needs.
How-tos¶
Work with templates step by step, from creating one to applying it and keeping it up to date.
Create¶
-
Create a Template
Create a template from scratch in the Library.
-
Create a Template from a Check
Turn a check you already have into a template.
Apply¶
-
Add a Check from a Template
Apply a template to one table or file.
-
Add Multiple Checks from a Template
Apply a template to many tables or files in one go.
Managing¶
-
Edit a Template
Change a template, and its linked checks when it is locked.
-
Bulk Edit Check Templates
Change many templates at once.
-
Archive a Template
Take a template out of the Library and unlink its checks.
-
Export Check Templates
Write every template to a table in an enrichment datastore.
Find Templates¶
-
Filter and Sort Templates
Search, filter, and sort the Library to find the templates you need.
API & FAQ¶
-
Templates API
The endpoints to create, update, archive, and apply templates.
-
Templates FAQ
Common questions about locking, editing, archiving, and
each().