Skip to content

Create a Template

DO Creating metadata or metric checks or templates

DQ Creating integrity checks or templates

Create a check template from scratch in the Library, to apply the same rule to many tables later. To turn a check you already have into a template, see Create a Template from a Check.

Permissions

Creating a template requires the Manager or Admin role, and the module for its rule type. See Template Permissions.

Let AgentQ fill in the form

When AgentQ is configured and its data-sharing level is Metadata shared or higher, the Template Assistant panel next to the form can write the template for you: describe the rule in plain language, or pick one of its suggested prompts, and apply the configuration it proposes. Review the fields before you save.

Steps

Step 1: Click Library in the left side panel. The Library page opens.

Step 2: Click Add Check Template at the top right. The Check Template Details dialog opens.

Step 3: Under Target, select the Rule type. The rest of the form adapts to it. The rule type cannot be changed after the template is saved.

Step 4: Optionally, enter a Filter Clause to limit the records each check evaluates. Use each() to create one check per value. See Filter Permutations.

Step 5: Fill in the Properties the rule type asks for.

Step 6: Under Pass Criteria, set the Coverage: the percentage of evaluated records each check must satisfy.

Step 7: Under Template Options, select Locked if the checks created from the template should follow its later edits. See Locked and Unlocked Templates.

Step 8: Under Metadata, enter the Description. With an AI integration configured, Suggest a description writes one from the template's definition. Optionally, add Tags and Additional Metadata.

Step 9: Click Save. A success message appears, and the template is added to the Library.

Unused suggestion

If a suggested description is waiting and you click Save without applying it, a warning appears. Click Review Suggestion to look at it, or Save Anyway to keep the description you have.

Next, create checks from the template. See Add a Check from a Template and Add Multiple Checks from a Template.