Skip to content

Create an Expected Schema Check

Step-by-step tutorial for creating an Expected Schema check on a container. 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.

Field reference

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

Target

Field Required Type Description
Associate with a Check Template Toggle Leave it off for this rule. The toggle replaces the Rule Type dropdown with a Template dropdown, and Expected Schema is not offered as a template rule type, so no template can supply it.
Rule Type Option The validation logic to apply. Select Expected Schema for this check.
Table / File Option The table or file whose structure is asserted. Locked after the check is saved.
Custom Anomaly Description Toggle Has no effect on this rule. The option replaces the message on Record Anomalies, and Expected Schema emits a Shape Anomaly only.

Properties

Field Required Type Description
Fields Option The fields the container must carry, picked from the container's field list. This is the declaration the check compares the container against; the type each one is checked against comes from the field's profile.
Allow other fields Text Whether columns that are not declared are tolerated. On, extras pass; off, the container must hold exactly the declared set.

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 Required 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.
Additional Metadata Key-value Custom key-value pairs, typically links to catalog entries, tickets, or governance records.

No Filter Clause and no Pass Criteria section

Expected Schema reads the container's structure rather than its rows, so the form shows neither a Filter Clause input nor a 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, "the orders extract must have order id as an integer and status as text") 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 Expected Schema 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 rule against the selected data without saving it. A success message confirms the rule can run on that data. If validation fails, see Troubleshooting.

Step 6: Click Save. A success message confirms that the check was created.