How Between Times Checks Work
Definition
Asserts that every value in a Date or Timestamp field falls between a start and an end instant, with both boundaries included.
Overview
The Between Times rule defines a time window on a single date or timestamp field. Each row must hold a value inside the window formed by Min and Max. Unlike the numeric Between rule, both boundaries are always inclusive: a value equal to the start or to the end passes. Both boundaries are stored as UTC instants, and the comparison runs in UTC.
Typical use cases:
- Validate that dates fall inside a reporting period, such as a fiscal quarter.
- Keep event timestamps inside a contract term or a campaign window.
- Catch values outside a plausible range, such as an activity date before the system existed or far in the future.
Field Scope
Single: The rule evaluates exactly one field per check.
Accepted Types
| Type | Supported |
|---|---|
Timestamp |
|
Date |
|
Array |
On an array field every element is tested against the window and the row fails as soon as one element falls outside it. That evaluation runs as a field-level check, so it reports a Shape Anomaly for the field instead of per-row Record Anomalies, whatever the coverage is set to.
General Properties
| Name | Supported |
|---|---|
Filter Allows the targeting of specific data based on conditions |
|
Coverage Customization Allows adjusting the percentage of records that must meet the rule's conditions |
The filter allows you to define a subset of data upon which the rule will operate.
It requires a valid Spark SQL expression that determines the criteria rows in the DataFrame should meet. This means the expression specifies which rows the DataFrame should include based on those criteria. Since it's applied directly to the Spark DataFrame, traditional SQL constructs like WHERE clauses are not supported.
Examples
Direct Conditions
Simply specify the condition you want to be met.
Combining Conditions
Combine multiple conditions using logical operators like AND and OR.
Correct usage" collapsible="true
Incorrect usage" collapsible="true
Utilizing Functions
Leverage Spark SQL functions to refine and enhance your conditions.
Correct usage" collapsible="true
Incorrect usage" collapsible="true
Using scan-time variables
To refer to the current dataframe being analyzed, use the reserved dynamic variable {{_qualytics_self}}.
Correct usage" collapsible="true
Incorrect usage" collapsible="true
While subqueries can be useful, their application within filters in our context has limitations. For example, directly referencing other containers or the broader target container in such subqueries is not supported. Attempting to do so will result in an error.
Important Note on {{_qualytics_self}}
The {{_qualytics_self}} keyword refers to the dataframe that's currently under examination. In the context of a full scan, this variable represents the entire target container. However, during incremental scans, it only reflects a subset of the target container, capturing just the incremental data. It's crucial to recognize that in such scenarios, using {{_qualytics_self}} may not encompass all entries from the target container.
Specific Properties
Between Times has two rule-specific properties:
| Name | Description |
|---|---|
Min |
The start of the window. A value equal to it passes. |
Max |
The end of the window. A value equal to it passes. |
Anomaly Types
| Type | Supported |
|---|---|
| Record Flag inconsistencies at the row level |
|
| Shape Flag inconsistencies in the overall patterns and distributions of a field |
Evaluation Flow
Every Between Times check follows the same four-step evaluation flow:
- Apply the filter clause. If the check has a
filterset, only rows matching the filter expression continue to the next step. Rows outside the filter are ignored and cannot contribute to the violation count. - Interpret the field value as a timestamp. The platform reads the row's value as an instant for comparison.
- Compare against both boundaries. The value must be greater than or equal to Min and less than or equal to Max. Failing either side fails the row.
- Apply coverage. At 100% coverage, any failing row causes the check to fail. Below 100% coverage, the check fails only when the passing fraction drops below the threshold (see Coverage and Tolerance).
Both Boundaries Are Inclusive
Between Times has no inclusivity toggles: a value equal to Min or to Max always passes. When you need an exclusive edge, pair After Date Time and Before Date Time, which are both strict. Nudging the boundary instead (one day earlier on a Date) only works when the column has no finer resolution than the step you take: on a timestamp with sub-second precision, pulling the upper bound back by a second also rejects the values in between, such as 11:59:59.500.
Time Zone Behavior
Both boundaries are stored as UTC instants and the comparison runs in UTC. Values that carry an explicit time zone are compared directly; values without one are interpreted as UTC (a Date counts as midnight UTC of that day). When the source data was written in a local or mixed time zone, normalize the field upstream with a Computed Field so the window means the same thing for every row.
NULL Handling
The check passes NULL values: a row with NULL in the evaluated field is not counted as a violation. Between Times only asserts that present values fall inside the window.
If the field must also be populated, pair it with a Not Null check on the same field. Values that cannot be interpreted as a timestamp are flagged as violations, which rarely happens because the field picker accepts only Date, Timestamp, and array fields.
Array Fields
On an array field, every element is tested against the window and the row fails as soon as one element falls outside it. Empty arrays and NULL arrays pass, since there is nothing to evaluate.
The Filter Clause
The filter clause is a SQL WHERE expression applied before the evaluation. Filtered-out rows are ignored entirely (they cannot trigger a violation and are not counted in the totals).
When a filter is set, both the Record Anomaly and the Shape Anomaly messages end with [filter: <expression>] so the evaluated scope is visible in the alert.
Coverage and Tolerance
Coverage is a fractional value between 0 and 1 that defines the minimum fraction of evaluated rows that must pass:
1.0(100%, default): every row in the filtered set must pass. Any failing row causes the check to fail. This is the strictest setting.< 1.0: the check tolerates a fraction of rows failing. The check fails only when the fraction of passing rows drops below the threshold.
Lower coverage values are useful when a small, known fraction of failures is expected. Use coverage carefully: a 0.5% tolerance can mask a real regression that happens to fall just under the threshold.
See Also
-
Anomaly Reporting
The anomaly messages the check produces, what the numbers mean, Source Records highlighting, and Custom Anomaly Description.
-
Examples
Three production scenarios with sample data, anomaly messages, and the SQL equivalent of what the check evaluates.
-
Best Practices
Guidelines for choosing the window, handling time zones, pairing rules, and keeping the signal clean.
-
Permissions
The team permission each action needs: view, create, edit, archive, restore, and delete.