CMS - Create a new Quality Rule

Create a new Quality Rule

In order to create a new Quality Rule, you need to:

• Ensure that you are working in Expert mode (use the drop down option on the toolbar, or change the mode in the Preferences)
• Ensure that you have at least one Assessment Model in the Assessment Models view
• Double click the appropriate Assessment Model in the Assessment Models view and work in the Assessment Models editor

Principles

Before you begin, take some time to read the following:

1. There are two types of Quality Rules:
   • Quality Rules based on SQL procedures (legacy type, discussed in this document)
   • Quality Rules based on scopes and properties (not yet customizable)
2. You need to consider SQL procedure development i.e. creating procedures that will be used by the Quality Rule. Two stored procedures are required:
   • A detail procedure to identify violations
   • A total procedure to compute the size of the test population

   SQL procedures need to be developed manually, taking inspiration from existing Stored Procedures stored in the CAST Analysis Service.

3. Quality Rules can be distributed to other Dashboard Services using the Import/Export feature
4. Some advanced features are available:
   • Parameters
     • Are used in the SQL procedure
     • Declared in the Assessment Model
     • Technology and Object type dependent values

Creating a new Quality Rule

• In the Assessment Models editor, click the Quality Models tab, then the Quality Rules tab and then select the to create a new Quality Rule:
  
• An editor will be displayed (see Quality Rules/Quality Distributions/Quality Measures tabs)
• Choose a name for the Quality Rule:
  
  
• Now fill in the Quality Rule's documentation fields (use the Documentation sub-tab) and tick each tab to activate it. Please make sure that the Description and Rationale tabs (at a minimum) are populated (see Quality Rules/Quality Distributions/Quality Measures tabs for more information):
  
  
• Next ensure that you fill in the Documentation > Output tab, paying special attention to the Associated Values drop down lists (see Quality Rules/Quality Distributions/Quality Measures tabs for more information):
  
  
• Next move to the Grade Thresholds tab and ensure that the thresholds offered by CAST are appropriate (see Quality Rules/Quality Distributions/Quality Measures tabs for more information):
  
  
• Next move on to the Grade Impacts tab and choose the Technical Criterion (using the button) that are impacted by your new Quality Rule. Make sure you enter a Weight and tick the Critical option if required (see Quality Rules/Quality Distributions/Quality Measures tabs for more information):
  
  
• Next move to the Computing Settings tab and:
  • Choose Computing based on SQL Procedures (Computing based on Scopes and Properties and Computing based on Scopes and Violation Object Sets is not yet customizable)
  • Choose the Technologies that will be targeted (using the button)
  • Enter then names of the Total and Detail Stored Procedures that will be used by the Quality Rule

  

• Lastly, move to the General tab and:
  • Choose the External ID of the new Quality Rule
  • Choose whether the new Quality Rule is Deprecated or XXL (or whether these categories do not apply: N/A)

  (see Quality Rules/Quality Distributions/Quality Measures tabs for more information):
  
  

Your Quality Rule is now complete - remember to use the Save All option. The new Quality Rule will automatically populated in the Dashboard Service when you use the Synchronize option.