Create a Metric Check¶

Step-by-step tutorial for creating a Metric check on a table or file. For what each property means and how the rule evaluates the data, see the How It Works page.

Permission Required

You need the Author team permission on the datastore to create an Active check, or Drafter to create it as a Draft. See the Permissions page for the full matrix.

Show me how

The app can walk you through this. Click Show me how in the check creation form's header, or press H while it is open, and the Add a Check walkthrough highlights each step while you fill in the real form.

One row to measure

The check needs exactly one row to evaluate. Pick a container that returns a single row, such as a computed table that aggregates the value, or plan a filter clause that narrows the container to one row. See Exactly One Row.

Field reference¶

The Authored Check Details form is organized in the sections below. Fill them in as you follow the Steps.

Target¶

Field	Type	Description
Associate with a Check Template	Toggle	Links the check to a Check Template. Enabling it replaces the Rule Type dropdown with a Template dropdown where you pick an existing template, which then controls the check's properties. When off, you configure everything on this form.
Rule Type	Option	The validation logic to apply. Select Metric for this check. Shown only while Associate with a Check Template is off.
Table / File	Option	The table or file the check runs against. Locked after the check is saved.
Field	Option	The field whose value is measured. Accepts exactly one `Integral` or `Fractional` field. Locked after the first Scan that includes the check.
Filter Clause	Text	A SQL `WHERE` expression that limits the rows the check evaluates. For a Metric check, it usually narrows the container to the one row the check follows.
Custom Anomaly Description	Toggle	Uses the value of another field on the evaluated row as the anomaly message instead of the default one. Enabling it shows an Anomaly Message Field dropdown where you pick that field. When the selected field is empty, the default message is used.

Create the table or file from the form

If the table or file you need does not exist yet, click Add Computed Table next to the Table / File field while it is empty (Add Computed File on a file-based datastore). Once saved, the new one is selected and pinned to the top of the list with a icon until you close the form. The button appears only with the Author or Editor team permission on the datastore, and not when you add a check from Explore.

Properties¶

Field	Type	Description
Comparison	Option	How the value is evaluated: Absolute Value, Absolute Change, or Percentage Change. Locked after the first Scan that includes the check. See Comparisons.
Min Value	Number	The lower limit: the value itself for Absolute Value, or the smallest allowed movement from the previous measurement for Absolute Change. A negative value allows a decrease of that much. Shown as Min Percentage, entered in percent, for Percentage Change.
Max Value	Number	The upper limit, with the same meaning as Min for each comparison. Shown as Max Percentage for Percentage Change.

At least one of Min Value and Max Value must be filled in, and Min cannot be greater than Max.

Ownership¶

Field	Required	Type	Description
Owner		Option	The user responsible for the check. Already filled in with the check creator.
Anomaly Assignee		Option	The user automatically assigned to anomalies the check produces.

Metadata¶

Field	Type	Description
Description	Text	A plain-language description of what the check enforces. Supports Markdown formatting: click the field to open the Markdown editor. Click the Apply suggested description button for a suggestion based on the rule type.
Tags	Option	Tags applied to the check for filtering and organization. Anomalies the check produces inherit them, which lets a Flow route them.
Additional Metadata	Key-value	Custom key-value pairs, typically links to catalog entries, tickets, or governance records.

No Pass Criteria section

Metric evaluates a single row, so the form shows no Coverage slider.

Let AgentQ fill in the form

When AgentQ is configured for your deployment, the Check Assistant panel in the check form can author the check for you: describe the rule in plain language (for example, "alert me when yesterday's revenue moves more than 30%") and it proposes a configuration you can apply to the form. Review the filled-in fields, then Validate and Save as usual.

Steps¶

Step 1: Select the source datastore from the left menu, then click the Checks tab.

Step 2: Click Add in the top-right corner and select Check from the dropdown. The Authored Check Details form opens.

Step 3: Select Metric in the Rule Type dropdown.

Step 4: Fill in the required fields and any optional ones you need. Every field is described in the Field reference above.

Step 5: Click Validate to test the configuration without saving it. A success message confirms the rule can run. If validation fails, see Troubleshooting. The Validate button needs the Author team permission, so it does not appear for a Drafter, who can skip this step.

Step 6: Click Save. A success message confirms that the check was created. With the Drafter permission, the button reads Save as Draft and creates the check as a Draft.

The check runs on the next Scan

Saving the check does not evaluate it. It is asserted the next time a Scan with the Data Integrity category runs on the container. Validation does not confirm that the filter leaves exactly one row, so check the first Scan's result. A change comparison records its first measurement on that Scan and starts comparing on the next one.