Rule Detail page

Many features are added on the Rule detail page like offline and online execution capabilities, providing users with greater flexibility. The alert status of each rule is displayed as either "Healthy" or "Alerting" based on specified thresholds. Users can now easily edit rule definitions, descriptions, priorities, and scope, including window types and lookback days. Data aggregation into buckets enables detailed data quality checks. Various threshold types allow tracking and alerting based on exceptions. Rule notifications, action statuses, and scheduling options have been enhanced for improved rule management. The history tab provides execution charts and grids for comprehensive performance analysis. Overall, all these features enhance rule customization, monitoring, and analysis which will be explained in this article.

 
Before moving to functionalities let's go through when any rule is created. The "Data" tab and "History"
tab is disabled initially when the rule is created.
Here on the "Run Rule", the user can either run the rule online or offline. For more information regarding
Run Online & Run Offline, please visit the article "Run Online/Run Offline". Once the Rule is run, the "Data"
tab (if there are exceptions) & History tab gets enabled:
Now we will go through the major functionalities that have been implemented in the User Interface are
highlighted in the screenshot below for a quick review.

 

The Rule Detail page has a significant number of features Let's explore these enhancements in detail:

Not Scheduled - A notification at the top of the page is shown which indicates whether the rule is scheduled. If the rule is not scheduled it will not run automatically.

  • Alert status for the rule will be shown as  

    • Healthy - if the metric value is within specified threshold limits, then the alert status will be Healthy 

    • Alerting  - If the metric value is not within specified threshold limits, then the status will be Alerting

  • Run Result
    • Passed - If the metric value has zero exceptions then the run result will be passed and the alert status will be healthy.

    • Failed If the metric value is not within the defined threshold then the run result will fail and the alert status will be alerting applicable to Unique values, Freshness, Metric, and Count rule.

  • Run

    • Online & Offline rules can be run directly from the Rule detail page

    • For Details please check the article Run Online/Offline

    •  
  • Edit

This button will allow the user to update the following: 

    • Overview

      • Rule Description: Users can update the description for the rule 
      • Priority: Users can update the priority for the rule 

      • Open Rule Definition: Users can directly open the rule definition page from here

Attributes

Users can add any tags to the rule

  • Scope 

    • If the Metric Time field is selected on the table level. Selected field names will be inherited from the rule as well
      Otherwise, the user can also select/update the metric time field at the rule level as well

 

      • Users can set the window type: - Used to define what is the scope of data to be selected. 
        • All Data - By Default all the rules will window type as All data, which will consider all the data in the table during the  execution of the rule 

      • Data Max Time - In the case of incremental data, we can choose this option to run validation only on newly added data based on the timestamp available on the table 

      • Clock Time -  In the case of incremental data, we can choose this option to run validation only on newly added data based on the current timestamp available on the table 

Example:

There is a rule scheduled to run on 2024-01-06 at 11:00:00. This rule is applied to the "UPDATE_DT" column. Please review the sample data below, which produces different outputs based on the selected window type:

      • Users can set the Lookback days for Data max time & Clock time  
      • Users can optionally aggregate data into Buckets and DQ checks will be performed on each bucket. 
        • No bucket 
        • 1 Day  
        • 1 Hour 
      • Users can select available Slicer options

 

  • Threshold 

    • For the Metric type, we can choose whether we want to track and alert based on the number of exceptions or percentage of exceptions. 
      • No Threshold - Metric will not alert. 

      • Constant - Metric will be compared against constant thresholds. 
        • Users can set the Upper bound and Lower Bound

      • Relative - Percentage change (increase or decrease) in metric compared to the previous bucket or execution. For DQ exception checks, the decrease will not alert. 
        • Users can set the percentage for the relative threshold type

      • Adaptive - Thresholds auto-adjust based on observations using outlier detection techniques. It uses the Interquartile range technique to detect if the metric is an outlier. 
        • Users can choose the threshold bounds from the 3 available options: 
          • Upper and Lower
          • Upper
          • Lower

 

  • Notifications 

    • Assign a rule to the user - The user can assign a rule to any user
    • Add/update the schedule for a rule -A new functionality is added to manage the scheduling of the rule

Work Flow Actions

Before moving to Workflow Actions, we need to add a Data Quality workflow enabled  Data domain to our table. On the "Data Domain" tab create a new domain or use an already existing one:

The "Data Quality Workflow" checkbox should be enabled on creating the new Data Domain:

Now on the "Overview" tab on the Table detail page, the above Data domain needs to be added:

Once we have added the Data Quality workflow Data Domain to our table we can then add any scheduled job from the drop-down

Workflow actions are going to appear at the top right

Actions dropdown will contain Acknowledged and resolve

When the user acknowledges the rule, the status will be changed to "Acknowledged".

When the user resolves the rule, a Pop-up will be displayed with the Reason Code and Description

Workflow status is changed to resolved

 

One thing is to be noted here that the "Actions" button and its options on the top right show if the Rule has met the following conditions:

  1. The rule must have exceptions
  2. The rule must be executed
  3. The Table on which the Rule is created must have the Data domain added for which the Data Quality workflow is enabled
  4. The scheduler must be attached to the Rule

Below Work flow status is Activity bar. clicking on comments icon with open the detailed activities.

On the Activity bar, clicking on the comments icon will open the detailed activities.

 

On the Lower Section of the Rule detail page, the user will be able to see only the 3 tabs by default:

 

Users can click on Show More to view the other tabs available:

After clicking on the Show More tab, the user will see the following tabs and if the user wants to Hide them they simply need to click on Hide Others

  • Data tabThe "Data" tab is enabled only when the Rule is run and it has some exceptions. The Exceptions are marked as "Red" for the column on which the rule is applied. All the Exceptions along with the  data in the table are shown:

One thing to be noted here is that only "300" exceptions will be shown on the Grid on the "Data" tab. If the user wants to see more exceptions on the "Data" tab then before running the rule, turn on "All Exceptions in Online Run":

One thing is to be noted here that the "Data" tab will be shown for the following rules only:

  1. Data Format
  2. Blanks
  3. Value Range
  4. Uniqueness
  5. Ruleset
  6. Custom Query
  7. Orphan Keys
  8. Orphan Records
  9. Compare Schema
  10. Compare Metric
  • History

    • The history tab will show the execution history for the rule in the form of a chart

    • The History tab has 2 different views which are:

  • Chart View - In this view, the data is shown to the user in the form of a chart

When the slicer is selected, the data in the History Chart will get distributed based on the Slicer's Field

 

  • Grid View - In this view, the same data is shown to the user in a tabular form

Users can view execution history for: 

  • Current: It will show the metric value for the current execution
  • 30 Days: It will show metric value for 30 days
  • 90 Days: It will show the metric value for 90 days
  • All: It will show the metric value for All data

  • Instructions

Users can add any instructions.

  • Column Sequence

On the "Column Sequence" tab, the users can set 3 different sequences that can be applied to the Rule:

  1. Suggested Sequence
  2. Table Specific Sequence
  3. Rule Specific Sequence

For more details on Column Sequence, there is a separate article written for "Column Sequence". 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk