MDQE

This page guides you through the overview, installation, and use of Cinchy's MDQE function.

Overview

Metadata Quality Exceptions (MDQE) can send out notifications based on a set of rules and the “exceptions” that break them. This powerful tool can be used to send notifications for exceptions such as:

  • Health checks returning a critical status

  • Upcoming Project Due Dates/Timelines

  • Client Risk Ratings reaching a high threshold

  • Tracking Ticket Urgency or Status markers

  • Unfulfilled and Pending Tasks/Deliverables

  • Etc.

MDQE monitors for specific changes in data, and then pushes out notifications when that change occurs.

Prerequisites

Install MDQE

To install MDQE in your Cinchy environment, follow the below steps:

  1. Download the MDQE Installation package.

  2. Unzip the file.

  3. Open an instance of PowerShell as an Administrator and navigate to the path where you extracted the MDQE package in step 2 > Metadata Quality Exceptions V.x > Metadata Quality Exceptions.

  4. Run the following command to install all MDQE components in your environment, using the table below as a parameter guide.

.\CinchyDXD.ps1 install `
-s "url.com/Cinchy" `
-sso "url.com/CinchySSO" `
-u "CinchyDQE" `
-p "cinchy" `
-c "C:\Cinchy CLI\Cinchy CLI v4.12.0.564" `
-d "C:\Cinchy CLI\Cinchy CLI Error Logs" `
-y
  1. Within the MDQE file package, navigate to the PowerShell - DQE Orchestration folder.

  2. Extract the contents.

  3. Navigate to the _config.json file and update the parameter values using the below as a guide. Make sure to save when finished.

Create MDQE rules

  1. In the environment where you installed MDQE, search for and open the [Cinchy MDQE].[Rules] table.

  2. Using the “Create Rule” view and the following data, create your Rule:

Use the “Invalid Rules” view to correct Rules with have syntax errors

View all exceptions

All exceptions can be viewed in the [Cinchy MDQE].[Data Quality Exceptions] table

  • The Default view only displays exceptions assigned to the currently logged in user.

  • The All Data view displays all exceptions. This is only visible with admin privileges.

Debugging

Ways to debug your rules:

  • If your PowerShell scripts aren't running: Run the script files in the PowerShell - DQE Orchestration folder using an IDE to make sure that all the configurations are correct.

  • Check to see if your bugged Rule is part of the “Invalid Rules” view.

  • If you have admin privileges, check to see if an equivalent SQL statement has been created in the [Rules CQL] table.

  • Check if there is a row for the Rule’s Signature value in the [Cinchy].[Formatting Rules] table.

Schedule MDQE jobs

You can use the Windows Task Scheduler to run MDQE jobs at regular intervals.

  1. Navigate to your MDQE installation package > Windows Task Scheduler Jobs folder.

  2. Import the files into the Windows Task Scheduler, updating the parameters accordingly.

Last updated