User interface overview
The DQOps web interface is divided into three main areas.
- The navigation bar has links to the main DQOps data quality monitoring sections and provides access to the main settings and other functions.
- The tree view displays all the data sources available in your workspace or a list of dashboards depending on the section chosen in the navigation bar.
- The main workspace changes according to your selection in the navigation bar and the tree view.
The navigation bar allows you to select the specific sections that you want to focus on.
- The Data Sources section allows you to add new connections, import schemas and tables, set up schedules, add comments and labels, configure data grouping, set the date and time columns for partition checks, and modify the settings of the incidents and notifications.
- The Profiling section allows you to collect and review basic data statistics, as well as enable and run profiling data quality checks that should be used to profile data and run experiments to see which check would be most appropriate for monitoring the quality of data.
- The Monitoring Checks section allows you to enable and run daily or monthly monitoring data quality checks that are standard checks that monitor data quality.
- The Partition Checks section allows you to enable and run daily or monthly partition data quality checks that measure data quality for each daily or monthly partition by creating a separate data quality score.
- The Data Quality Dashboards section lets you review the summaries of data quality monitoring on multiple built-in data quality dashboards.
- The Incidents section helps you review and manage the issues that arise during data quality monitoring.
- The Configuration section lets you customize built-in data quality sensors and rules.
The right side of the navigation bar provides access to the main settings and some other functions.
- Help - Links to the support page, documentation, DQOps account manager and configuration parameters settings set at the start of DQOps. You can change the configuration settings by setting command line arguments at the start of the application.
- Synchronize - Synchronize locally stored results with your DQOps Cloud account.
- Notifications - View DQOps notifications and enable/disable the scheduler. The Notifications icon displays NEW tag, when there is a new notification.
- User account - Provide information about your account, current limits and access to the DQOps Cloud account.
Notifications provide a log of all completed tasks, such as running checks, gathering statistics, importing metadata, synchronizing folders, etc.
You can use the notifications to access a complete log of all jobs that have been executed. This log allows you to check the status of each action, which can be "succeeded," "failed," "running," "waiting," "queued," or "canceled." Additionally, you can expand each job entry to view sub-jobs and access more detailed information about specific tasks.
Main functions of notifications:
In the top part of notifications window you can start and stop the scheduler. You can learn more about scheduling here.
If the job is queued or running you can cancel or stop it by clicking the X button.
You can view the result of executed checks by simply hovering on run checks job. Color of the square represents the highest severity status of the results (green for a valid result, yellow for a warning, orange for an error and red for a fatal error).
The tree view at the Data Source, Profiling, Monitoring Checks and Partition Checks displays all the added sources and allows expanding its schemas, tables, and columns. Additionally, on the Profiling, Monitoring Checks and Partition Checks sections the three view contains the list of checks.
Clicking on an object in the tree view displays settings, statistics or a list of table or column data quality checks on the main workspace. Clicking on an object always opens a new tab in the main workspace.
In the Profiling, Monitoring Checks and Partition Checks sections, when you configure checks on any table or column, this table or column is displayed in bold on the tree view. In the Data Source section the bolded column or table name indicates that there is a check configured on any category.
Tree view menu
Clicking on the tree vertical dots at the end of each element in the tree view opens a menu that allows to run functions specific to the elements such as:
- Run all enabled checks on connection, schema, table or column
- Collect statistics
- Import metadata
- Add schema, table or column
- Refresh connection, schema, table or column
- Delete connection, schema, table or column
- Delete data
The tree view in the Data Quality Dashboards section displays the list of built-in dashboards divided into categories.
The tree view in the Incidents section displays the list of all added sources and a number of open incident from 15 days including today in brackets.
The tree view in the Definitions section shows the list of all built-in data quality sensors and rules that can be customized.
Once you select a section from the navigation bar and tree view, the main workspace will show you various data quality components. These include data source options, information about schemas, tables, and columns, a list of data quality checks, and data quality dashboards.
Clicking on an object in the tree view always opens a new tab in the main workspace that helps in navigating between open elements.
When you select an item from the tree view, it opens a new tab in the main workspace. You can open and close tabs within each section such as Data Source, Profiling, Monitoring Checks, Partition Checks,Data Quality Dashboards, Incidents and Configuration. Each section can have a maximum of seven tabs open at a time. If you try to add an eighth tab, the first one will be automatically removed to maintain the limit. These tabs are stored locally, which means that you can always return to them even after closing the application.
If the tab's content no longer exists, a pop-up notification will appear and the corresponding tab will close automatically.