Data Quality Configuration
This page explains how and where to configure data quality scores for your Data Objects.
You can add a data quality component to your Data Object Class Definition through the context menu Add Data Component > Other > Data Quality.
Show in Tree
You can decide whether the data quality score will be displayed in the Data Object tree (if checked) or not (if unchecked). This option is checked by default.
Precondition
The Precondition field can be used to narrow the scope of the Data Objects for which the data quality will be displayed. You can for example use this precondition to exclude all the unpublished Data Objects, or to calculate the data quality score only for Data Objects in a target folder.
If the precondition is not met, the data quality summary will not be shown. The precondition can be any valid Symfony Expression.
The Data Object will be passed to the expression. Use object to build your expression.
With the following sample, the data quality score would be calculated only for published Data Objects:
//precondition example
object.getPublished() == true
Rule Definitions
Here you can configure the rules for computing the data quality score by selecting one or more rule definition(s). Those rule definitions correspond to constraints that can be from different types among the followings:
The weight is used to ponderate the value of each rule definition. A higher weight means a rule definition will have a bigger impact on the data quality score. By default, the same weight is assigned to each new rule definition.
Object Validation Check
This rule definition checks if all the mandatory fields are filled within the Data Object and/or if all validation steps are respected (e.g. min/max value for numeric fields, regular expressions for input fields, etc.).
When not met, this check will display auto-generated suggestions to improve the data quality in the object editor's Data Quality Details tab.
Recommended Fields Check
This rule definition checks if the manually defined recommended fields are filled within the Data Object. The data quality score will be affected by the missing fields.
When not met, this check will display auto-generated suggestions to improve the data quality in the object editor's Data Quality Details tab.
Symfony Expression Check
This rule definition checks a Symfony Expression against the Data Object. The Data Object can be accessed with object (e.g. object.getField1()).
You can edit a suggestion to display in the object editor's Data Quality Details tab for data improvement if the Symfony expression does not match.
The suggestions' translations must be set in Tools (sidebar) > Translations for the DataQualityManagement domain you can select in the drop-down menu.
Be aware that the text the getter returns may sometimes differ from the text displayed in the Data Object editor. It can be the case, for example, for the Country field: the editor displays the full country name (e.g. "Austria"), but the getter returns only the country ID (e.g. "AT"). You must consequently adapt your Symfony expression to match with the getter answers format (i.e. "AT" for our Country sample).