Authored Check

Authored checks capture business expectations that your team defines and governs. Create them in the Qualytics platform or through the API, using guided rule types, reusable templates, or SQL expressions for specialized logic. Unlike AI Managed checks, Authored checks remain under your team's control and are not changed by later Profile operations.

Navigation

Step 1: Log in to your Qualytics account and select the datastore from the left menu.

Step 2: Click on the "Checks" from the Navigation Tab.

Step 3: In the top-right corner, click on the "Add" button, then select "Check" from the dropdown menu.

A modal window titled “Authored Check Details” will appear, providing you the options to add the authored check details.

Step 4: Enter the following details to add the authored check:

1. Associate with a Check Template:

• If you toggle ON the "Associate with a Check Template" option, the check will be linked to a specific template.

• If you toggle OFF the "Associate with a Check Template" option, the check will not be linked to any template, which allows you full control to modify the properties independently.

2. Rule Type (Required): Select a Rule from the dropdown menu, such as checking for non-null values, matching patterns, comparing numerical values, or verifying date-time constraints. Each rule type defines the specific validation logic to be applied.

For demonstration purposes we have selected the After Date Time rule type.

For more details about the available rule types, refer to the Rule Types Overview documentation.

3. File (Required): Select a file from the dropdown menu on which the check will be performed.

4. Field (Required): Select a field from the dropdown menu on which the check will be performed.

5. Filter Clause: Specify a valid SQL WHERE expression to limit the records evaluated by the check.

The filter clause defines the conditions under which the check will be applied. It typically includes a WHERE statement that specifies which rows or data points should be included in the check.

6. Custom Anomaly Messages: Enable this option to use a source record field as the anomaly message instead of the default system-generated message.

Select a source field from the dropdown. The value in that field will be displayed as the anomaly description for failed records.

7. Date (Required): Enter the reference date for the rule. For the After Date Time rule, records in the selected field must have a timestamp later than this specified date.

8. Coverage: Adjust the Coverage setting to specify the percentage of records that must comply with the check.

9. Description (Required): Enter a detailed description of the check template, including its purpose, applicable data, and relevant information to ensure clarity for users. If you're unsure of what to include, click on the "💡" lightbulb icon to apply a suggested description based on the rule type.

Example: The Date of Birth must be a timestamp later than < date_time >.

This description specifies that the Date of Birth field must have a timestamp later than the specified < date_time >.

10. Tag: Assign relevant tags to your check to facilitate easier searching and filtering based on categories like "data quality," "financial reports," or "critical checks."

11. Additional Metadata: Add key-value pairs as additional metadata to enrich your check. Click the plus icon (+) next to this section to open the metadata input form, where you can add as many key-value pairs as needed.

Enter the desired key-value pairs (e.g., DataSourceType: SQL Database and PriorityLevel: High). After entering the necessary metadata, click "Confirm" to save the custom metadata.

Step 5: After completing the check details, click Validate to test the proposed rule against the selected data without saving it. A successful validation confirms that the rule can run on that data. Review the result and business meaning before saving the check.

A success message appears when validation completes.

If validation fails, an error message explains what needs attention. Review the rule settings, selected data, and any connection or loading error before trying again.

Step 6: Once you have a successful validation, click the Save button.

After you click Save, a success message confirms that the check was created.

Author a Check via API

You can also create and manage checks through the API. See the interactive API documentation at /api/docs for request schemas and examples.