Bulk Edit Check Templates
Use this flow to change many check templates at once. To edit one template, open it from the Library; see Check Templates. To change checks in bulk instead, see Edit Checks.
Permissions
Editing check templates requires the Manager user role or higher. See User Roles.
What You Can Change
The Bulk Edit Check Templates dialog offers the options below. Each option you turn on shows how it is applied next to its name.
| Option | How it is applied |
|---|---|
| Filter Clause | Always Overwrite: the clause you enter replaces the filter of every selected template. Leaving it empty removes their filter. The clause follows the same rules as a template's Filter Clause. |
| Tags | Overwrite (the default) makes the tags you pick each template's only tags. Add keeps each template's current tags and adds the ones you pick, without duplicating a tag it already has. |
Effect on Linked Checks
The checks created from a template follow some of these changes:
- Tags reach every check linked to the template, whether the template is locked or unlocked. The tags you add are added to those checks; with Overwrite, the tags taken off the template are taken off them too.
- Filter Clause reaches the linked checks only when the template is Locked. An unlocked template keeps its checks' filters as they are. See Template State.
- A Filter Clause that uses
each()gives every value in the list its own check, so changing the list changes those checks:- On a Locked template, a value removed from the list deletes its check. A value added creates a check on each table or file that still has a check from the list. Adding
each()to a filter that had none splits every linked check into one check per value. - On an unlocked template, a value removed from the list keeps its check. A value added creates a check only on the tables or files that already have checks from the list, so adding
each()to a filter that had none creates no checks.
- On a Locked template, a value removed from the list deletes its check. A value added creates a check on each table or file that still has a check from the list. Adding
Replacing every value of the list
New checks are copied from the checks the list already has. On a locked template, removing every value and adding new ones in the same save deletes the old checks first, so no check is created for the new values. Add the new values and save, then remove the old ones and save again.
When the save is refused
The selected templates are saved one after another. If one of them cannot take the change, the dialog shows the reason and that template is left as it was, but templates saved before it may already carry the change, together with their linked checks. Reopen the list to see which templates changed before you try again. A template refuses the change when:
- Its rule type does not accept a filter and a Filter Clause was sent. The message reads
Check type '<rule type>' does not support a filter clause. Leave those templates out of the selection, or turn the Filter Clause toggle off. - The change would reach linked checks in a datastore you cannot access, such as new tags or a new filter on a locked template. The message reads
Cannot update this template: it has linked checks in datastores you do not have access to. An Admin can make the change, or you can leave that template out.
To make the same change through the API, send PATCH /api/quality-check-templates with a list of entries carrying the template id and the values to change, such as filter, tags with tags_mode, and additional_metadata with additional_metadata_mode. Each mode is replace (the default) or add; the API also takes Additional Metadata, which the dialog does not offer.
Other Bulk Actions
The same Bulk menu also offers Archive for the selected templates. It is not offered while the selection includes a Locked template that still has linked checks, because such a template cannot be archived; unlock it first, or leave it out of the selection. A locked template with no linked checks can be archived. See Template State.
Steps
Step 1: Click Library on the left side panel. The list of check templates opens.
Step 2: Hover over each template you want to change and click the checkbox on its row. To select every template on the current page, click the Select all in page checkbox. The top of the list turns into a selection toolbar showing the count, for example 2 selected.
Step 3: Click the Bulk menu button in the selection toolbar.
Step 4: Click Edit in the menu.
Step 5: The Bulk Edit Check Templates dialog opens. The notice at the top reads Toggle the fields to update for followed by the number of selected check templates, and the Filter Clause and Tags toggles are off.
Step 6: Turn on the options you want to change:
- Filter Clause: an Overwrite badge appears next to it. Enter the
WHEREexpression in the field below. Click Information next to the label for a reminder of what the clause accepts. - Tags: an Overwrite / Add selector appears next to it. Keep Overwrite or click Add, then click the tag field and pick the tags to apply.
The notice updates to say which options are overwritten and which are added to, for example This action will overwrite Filter Clause and add to the existing Tags for 2 selected check templates.
Step 7: Click Save. Every selected template is updated, and a success message appears.