Getting Started with DQM
Copyright © 2020 EarthSoft, Inc • Modified: 24 Feb 2020
The Data Qualification Module (DQM) is organized around a primary key field, DQM_QAPP_CODE, which allows all of the DQM checks, rules, and parameters to have different values for different agencies, regions, individual QAPPs, etc. For each DQM_QAPP_CODE uploaded or copied, the user can modify the parameters, qualifiers, and remarks associated with each check/rule in DQM Settings. Note that control limits in the RT_DQM_CONTROL_LIMITS table defines QAPP-specific control limits for certain checks.
Every DQM QAPP must have a Global Parameters "Check". The Global Parameters check holds the parameters used by all other checks within a given DQM QAPP and can be easily modified in the Parameters tab of the DQM Settings form. The Global Parameters check is not listed in the Check menu on the DQM Start Event form because it does not run an actual check.
Each DQM event is a review of an analytical results dataset (such as the lab results reported for a given Lab SDG).
•The review begins with Creating a DQM event, which runs a selected dataset through one or more or all of the automated checks for the selected DQM QAPP Code.
•The review continues with Processing a DQM Event, which displays results in the Event Summary, Exceptions by Check, Review All Results, Results by Sample, and Errors tabs. At this stage, the DQM event is available for future reference and to edit at a later time, without saving changes to results.
DQM must be installed and configured prior to usage. DQM only needs to be installed one time. Prior to creating a DQM event, complete all of the installation steps described here.
Note: If a previous version of DQM has already been installed, it is still necessary to proceed with these steps. A couple of additional considerations are detailed at the bottom of this page.
The installation of DQM is a three-step process:
1.Install the DQM application files during the custom setup step,
2.Publish the DQM report .dll file (EarthSoft.Reports.Library.63867.dll) to the EQuIS database, and
3.Apply the DQM Schema to the EQuIS database. Steps 2 and 3 must be performed for each EQuIS database that will utilize DQM.
To install DQM, select the DQM Module during the installation of EQuIS Professional Version 6.2 or later. If EQuIS Professional is already installed, the installer can be run again to add the DQM Module.
When complete, verify that EarthSoft.Reports.Library.63867.dll is in the EQuIS Professional folder (e.g., C:\Program Files\EarthSoft\EQuIS). Publish the EarthSoft.Reports.Library.63867.dll to the database. Instructions for publishing reports such as this can be found in the Report Publisher help article.
Update the database with Schema.DQM.xme. Follow the steps for SQL in the Database Update with SQL Server help article.
A DQM QAPP EDD can be created and uploaded into the EQuIS database via Professional EDP. When creating a DQM QAPP EDD, utilize the template file DQM_checks_v7.0.xlsx (before v7.0.19214) or DQM Starter QAPP.xlsx (beginning with v7.0.19214), (typically located in C:\Program Files\EarthSoft\EQuIS\Formats\DQM).
Review and modify the template file, based upon the actual project requirements. Perform the following steps to create the new DQM QAPP EDD.
1.Locate the DQM Checks EDD (DQM_checks_v7.0.xlsx or DQM Starter QAPP.xlsx) and save the file with a new name that contains the name of the project or DQM QAPP.
2.Decide which QAPP Codes will be needed. For example, Radio Chemistry Data Checks may not be needed. On the worksheet RT_DQM_QAPP, populate the DQM_QAPP_CODE with the name of the DQM QAPP. Populate the other fields in the worksheet as desired. Multiple DQM QAPP codes can be defined in the same spreadsheet.
3.Modify each tab of the EDD to match the new QAPP Codes by deleting rows and modifying data as necessary. (Hint: A global Find and Replace with the "Within" option set to "Workbook" is best for changing the DQM_QAPP_CODE). Continuing with the above example, the RT_DQM_CHECK tab would be changed as shown below.
Note: In the DQM forms, any list of checks will display the DQM_CHECK_DESC column. Thus, there are a couple of things to consider:
•The checks can be displayed in a language other than English by changing the DQM_CHECK_DESC column.
•Although the DQM_CHECK_DESC column will accept 255 characters, DQM forms only display about
•If the DQM_CHECK_DESC column is blank, the user will get an error when trying to select checks to Start an Event.
4.On the worksheet RT_MATRIX, populate the MATRIX_CODE and MATRIX_DESC with all the field matrices that are applicable to the project.
5.Review and modify all qualifiers specified on the RT_DQM_RULE tab.
6.Review and modify all parameters specified on the RT_DQM_CHECK_PARAM tab.
7.Review and modify the holding time limits on the RT_HOLDING_TIME tab and the control limits on the RT_DQM_CONTROL_LIMITS tab by referring to the DQM Control Limits help article.
8.Save the file.
9.The next step is to load the modified DQM Checks EDD file to the EQuIS database using EDP. On the EQuIS Professional Home ribbon, select the EDP button.
10.Click the Format button and select DQM-refvals.zip from the installed DQM files, typically located in \Programs Files\EarthSoft\EQuIS\Formats\DQM.
11.Select the EDD button.
12.Select the modified DQM Checks EDD created in the above steps.
13.Create and Commit the EDD.
Note: For updating an existing DQM install, load the latest DQM_Checks EDD using the Insert and Update commit type.
After all three of the Installation steps above have been completed (remember especially Step 2: the DQM report DLL must be published to the database), then users with ALS Admin permissions have access to DQM as shown by the DQM buttons being enabled on the ribbon.
Use the following instructions to make DQM available to users without ALS Admin permissions:
1.Except for the special read-only user described below, start by assigning the standard ALS Read-Write role to the user.
2.Then give the user Owner permission to the published DQM Report - DQM Exceptions Report by EDD. This enables the History, Settings, and In Process Events buttons.
3.Also give the user Creator permission to Reports. This will enable the Start Event button.
Note that it is now possible to disable all other EQuIS Professional Ribbon buttons to make the user a "DQM only" user by following the instructions here: https://help.earthsoft.com/pro_equis-professional-tools-acces.htm.
Any one of the DQM buttons (such as Settings) can be disabled for the user using that same EQuIS Professional Tools Access functionality.
Also, the DQM Settings can be set to read-only by creating and assigning an ALS connection role, which calls a database user that has only been granted SELECT permissions on the tables listed below.
If a previous version of DQM has already been installed, here are a couple of additional considerations:
1.If the Qualification Report button still shows up in the DQM ribbon toolbar do the following:
b.Find and delete the following XML file: \Users\<user>\AppData\Roaming\EarthSoft\EarthSoft.EQuIS.Toolbar.en-US.6.6.0.xxxxx.xml
2.To use QAPP Settings already uploaded, add the following record to RT_DQM_RULE for each QAPP Code you wish to continue using:
a.DQM_QAPP_CODE = <existing qapp code>
b.DQM_CHECK = 'EarthSoft.DQM.GlobalParameters'
c.DQM_RULE = 'Manually Entered Apply Qualifier'
d.REMARK = 'This rule is used to create the DQM_RULE_ID for manually entered Apply Qualifiers.'