Configure a Scan Action
Add a Scan action to run a datastore's quality checks and record anomalies automatically whenever the Flow's trigger activates.
Permission Required
You need the Manager role to edit and publish Flows. See Flow Permissions for details.
Initialized datastores only
Only initialized datastores appear in the Datastore dropdown. A source datastore becomes initialized after successful Sync, Profile, and Scan runs. An enrichment datastore becomes initialized after Sync and Profile.
Field reference
The Scan Settings panel shows the following fields. They mirror the options of running the operation directly on the datastore.
Select the datastore first
The sections below live in the Operation Configuration stepper and stay disabled until a Datastore is selected. For DFS datastores, the Select step lists File Patterns instead of Tables.
| Field | Required | Type | Description |
|---|---|---|---|
| Datastore | Option | The source datastore to scan. |
Select Tables
Choose which tables the scan covers. Picking one of the options is required to move to the next step, and All is preselected.
Select Check Categories
Define which categories of checks are included in the scan. Both are preselected, and at least one must stay selected.
| Field | Required | Type | Description |
|---|---|---|---|
| Metadata | Checkbox | Includes checks that declare an expectation about the table's properties, such as volume. | |
| Data Integrity | Checkbox | Includes checks that declare an expectation about the values held in the table. |
Read Settings
Skipped for metadata-only scans
When only the Metadata category is selected, this step is skipped, since metadata checks do not require data to be loaded.
Choosing the scan Strategy is required, and Incremental is preselected.
| Field | Required | Type | Description |
|---|---|---|---|
| Record Limit | Number | The maximum number of records to scan per table, after any initial filtering. Pick a preset (1M, 10M, 100M, or All) or type a custom value from 1 to 1,000,000,000. Defaults to All, which sets no limit. |
Starting Threshold
Optionally set a minimum incremental identifier value as the starting point for the scan. Only available with the Incremental strategy. Turning on the Starting Threshold toggle reveals the fields below.
Greater Than Batch depends on the datastore
Greater Than Batch only appears for datastores backed by a database connector (JDBC and native connectors). DFS datastores never show it.
| Field | Required | Type | Description |
|---|---|---|---|
| Greater Than Time | Timestamp | The starting timestamp, in UTC. Applies only to tables with an incremental timestamp strategy. | |
| Greater Than Batch | Number | The starting batch value, 0 or higher. Applies only to tables with an incremental batch strategy. |
Scan Settings
Auto Resolve Anomalies depends on the strategy
Auto Resolve Anomalies only appears when the Strategy in Read Settings is Full.
| Field | Required | Type | Description |
|---|---|---|---|
| Archive Duplicate Anomalies | Checkbox | If a new anomaly is a duplicate of an active or acknowledged anomaly, sets the new anomaly's state to duplicate. Checked by default. | |
| Reactivate Recurring Anomalies | Checkbox | If a new anomaly duplicates an archived anomaly, sets the new anomaly as duplicate and the existing anomaly back to active. Checked by default, and only enabled while Archive Duplicate Anomalies is checked. | |
| Auto Resolve Anomalies | Checkbox | Automatically resolves anomalies that are no longer detected when asserting the same checks. Checked by default whenever it is shown. |
Advanced Options
Optionally configure the anomaly thresholds and scan variables. Turning on the Advanced Options toggle reveals the fields below.
Enrichment destination
Maximum Source Examples per Anomaly is disabled when the source datastore has no enrichment destination configured.
| Field | Required | Type | Description |
|---|---|---|---|
| Maximum Record Anomalies per Check | Number | When a check reaches this limit, its record anomalies are rolled up into one for easier management. Pick a preset (1, 10, 100, or 1K) or type a value from 1 to 1,000. Defaults to the datastore's own setting (10 when never changed). | |
| Maximum Source Examples per Anomaly | Number | How many source records are stored in the enrichment destination as examples when a check fails. Pick a preset (10, 100, 1K, or 1B) or type a value from 1 to 1,000,000,000. Defaults to the datastore's own setting (10 when never changed). | |
| Scan Variables | Key-value pairs | Overrides or extends the container's default variables for this scan. They are combined with any container metadata to form the check variables used during the scan. |
Steps
Step 1: Navigate to the Flows page by clicking Flows on the left side panel.
Step 2: On the Definitions tab, click the Flow. On its canvas, click the dashed Action placeholder after the trigger, or the + handle at the bottom edge of a node.
Step 3: In the List of Actions panel, pick the Operation category, then click Scan. The Scan Settings panel opens on the right-hand side.
Step 4: Fill in the fields.
Step 5: Click Save. The node shows a CHANGED badge and the You have unpublished changes banner appears on the canvas.
Step 6: Click Publish to make the action live.