Schema Validation
What is Schema Validation?
Schema Validation is the Process of checking Attributes of Components for existence, format, range and values matching defined rules, producing a detailed breakdown of validation per Attribute, and a rolled up Model level score.
Schema Validation requires Attributes & Values definition, and a Validation run for each Model.
Define Attribute Rules
To define Attribute Rule, open the App and navigate to Processes > Schema Check > Attributes & Values.
Simple Rule
Click the New Check button and type in a Schema (Group), Category, Property and optionally a Pattern (T-SQL Like) to apply globally to all values.
As an entry on its own, an Attribute Check will simply verify that the Attribute exists on the Component and that the Value follows the Pattern if one was provided. But we can also define a list of Values allowed for the Attribute.
Allowed Value
In the Values panel, click the Add Value button. Type in the Category and Property the Value applies to, and enter the Value. Values themselves support Patterns like Attribute, which is use for Pattern Conditional Dependencies. Click Repeat to add as many Values as required in one go.
After the first Value of an Attribute is Created, more Values can be added by clicking the Add Value in-line in the Grid directly.
Conditional Value
Allowed Values can be Dependent, that is only be valid if another rule is also validated. To define a Dependent Value, search and select a Parent from the list of available Values in the Add Value dialogue. Alternatively, click the Add Child Value button directly from the Grid to add a Dependent Value to the selected Value.
IMPORT SETUP |
|
|
Both Attributes and Values can be imported from csv files. Click Data Transfers, navigate to View Import and select Import Attributes/Values then click Preview. Browse to the csv file to load, review the Results Preview and accept if everything is as expected. You can download the template csv file for the import using the Download Template button. |
Running the Checks
With all our Attributes Checks setup, we can now run the Validation.
To run and review the Validation, navigate to Processes > Schema Check > Validation Status.
The Board shows a list of all Models by Project, Area, Discipline and Model Name, with information about the Index and Status of the Validation, one of:
- Valid: The Validation ran as expected (note this does not mean the result is 100% compliant)
- Model Updated: The Model has been (partially) updated since the validation was last run (note: it does not necessarily impact the validation result for this model)
- Settings Updated: The Validation settings (Suitability or Attribute Rules) have changed since the validation was last run (note: it does not necessarily impact the validation result for this model)
- Error: The Validation did not complete and ran into an error, that is displayed in the Message
- Not Run: The Validation was not run on this Model
- Excluded Run: This Model is excluded from the Validation Process, but it was forcibly run manually OR ran before the exclusion rule was defined
- Exclusion Rule: This Model is excluded from the Validation Process
We can run the check on all Models using the Run All button in the toolbar. The operation runs on all Models that require an update (not checked or updated since the last check) either on all versions or only the latest of each Model depending on the option we choose.
Alternatively we can run the check only on the selected Model(s) by clicking the in-line Run button.
Next
Custom Registers Process | All Processes