Data Quality Helper Admin Guide

1. Navigate to the ‘Data Quality Helper Configuration’ tab.
2. Click on the ‘Data Validation Configuration’ option.
3. Click the ‘New Setting’ button
1. Populate the name of the rule (something to make the setting easily identifiable).
2. Populate the description field with a description of what the new rule will achieve.
3. Select the object that the rule is being created for.
4. Check the ‘Active’ checkbox if you would like the rule to be active on creation.
5. If you would like the rule to be a soft validation rule (that will allow users to save a record regardless of the warning message) check the ‘Allow Save After Displaying Warning’ checkbox. If you would like to completely prevent the save of a record select the ‘Prevent Save After Displaying Warning’ checkbox.
6. Select when you would like the rule to run. If ‘Before Save’ is selected, the rule will run prior to any automation taking place (ex: triggers, workflows, etc). If ‘After Save’ is selected, all automation will take place before checking for the error.
7. Populate the custom warning message that should be displayed when the validation rule is encountered during the creation/update of a record.
8. Select the background color for the warning message that will be displayed to users.
9. Optional Configuration (click to expand)
• The ‘Track Records That Encounter Warning’ setting will log when a record encounters a Data Quality Helper warning message when enabled.
• The ‘Allow Users To Ignore Warning’ setting will allow users to prevent Data Quality Helper warning messages from displaying when they no longer want to see them while viewing/editing a record.
4. Once the input information looks correct, click the ‘Next’ button to advance to the criterion creation.
1. Select the object that you would like to create a validation setting criterion for. By default, it will be set to the object the rule is being created for; however, you may traverse to a parent or child object as well.
2. Select the field for the selected object you would like to validate.
1. If the object selected in step a is not a parent or child object, you have the option to only evaluate the criterion being created if the value for the field you select in this step has a change of value.
3. Select the comparison type you would like to use. You may either compare the selected field’s value to another field’s value by selecting the ‘Field Comparison’ option, or you may compare the selected field’s value to a defined value by selecting the ‘Value Comparison’ option.
4. Select the operator you would like to use to validate the data.
1. Populate a value or select a field that the field should be compared to.
5. Once the defined criterion looks correct, click the ‘Add Criteria’ button.
6. Repeat the above steps a-e until all the validation criteria is completely defined.
7. Update the criteria logic if needed.
8. Click the ‘Save’ button to create the new Data Quality Helper Validation Rule.

1. Navigate to the ‘Data Quality Helper Configuration’ tab.
2. Click on the ‘Duplicate Rule Configuration’ option.
3. Click the ‘New Setting’ button
1. Populate the name of the rule (something to make the setting easily identifiable).
2. Populate the description field with a description of what the new rule will achieve.
3. Select the object that the rule is being created for.
4. Check the ‘Active’ checkbox if you would like the rule to be active on creation.
5. Select the option of how the duplicate rule should be handled.
• ‘Automatically Merge’ will merge the closest matching duplicate record when found.
• ‘Manually Merge’ will allow users to select what duplicate to merge with as well as allow them to select what fields should be updated during the merge. 
6. Select when you would like the rule to run. If ‘Before Save’ is selected, the rule will run prior to any automation taking place (ex: triggers, workflows, etc). If ‘After Save’ is selected, all automation will take place before checking for the error.
7. Optional Configuration (click to expand)
• The ‘Track Records That Encounter Warning’ setting will log when a record has duplicate records when enabled.
• The ‘Allow Users To Ignore Warning’ setting will allow users to remove duplicate records from the list of duplicates when viewing/editing a record.
4. Once the input information looks correct, click the ‘Next’ button to advance to the criterion creation.
1. Select the object that you would like to check for duplicates.
2. Select the operator that you would like to use when checking for duplicates.
1. If you select the ‘Similarity Percentage’ option:
1. Use the slider to define how similar the field values should be
2. Select the fields that should be compared
2. If you select any other option:
1. Select the two fields to compare on the records.
3. Once the defined criterion looks correct click the ‘Add Criteria’ button.
4. Repeat the above steps a-c until all the validation criteria is completely defined.
5. Update the criteria logic if needed.
6. Click the ‘Save’ button to create the new Data Quality Helper Duplicate Rule.

Once the desired Data Quality Helper settings have been created, the default buttons for the settings’ objects will need to be updated to leverage the Data Quality Helper lightning component. Please Note: The DQH_Upsert Lightning Web Component does not support the Task and Event objects.

1. Go into Setup (in the lightning experience)
2. Search for and select the ‘Object Manager’
3. Select the object that you have created a setting for.
4. Select the ‘Buttons, Links, and Action’ section.
5. Find the buttons you would like to override to leverage the Data Quality Helper functionality.
   
1. If you would like to run the Data Quality Helper settings on creation of a record, select the dropdown menu to the right of the ‘New’ button and click ‘Edit’.
2. If you would like to run the Data Quality Helper settings on edit of a record, select the dropdown menu to the right of the ‘Edit’ button and click ‘Edit’.
6. Update both the ‘Lightning Experience Override’ and ‘Mobile Override’ sections to leverage the ‘DQH:DQH_Upsert’ Lightning Component. (see image below for an example)
   
7. Repeat the above steps 3-6 for each object that a Data Quality Helper rule has been created for.

Enable functionality when viewing record detail pages

View All Data Quality Issues

If you have created a validation or duplicate rule that is no longer needed, you may follow the steps below to delete the unneeded rules.

1. Go to setup (in the lightning experience).
2. Search for and select ‘Custom Metadata Types’.
   
3. Click ‘Manage Records’ next to the ‘Data Quality Helper Setting’ metadata type.
   
4. Identify which rule should be deleted, then click on the label for the rule.
   
5. Delete all of the criteria in the ‘Data Quality Helper Criteria’ related list.
   
6. Once all criteria are deleted, click the ‘Delete’ button for the rule you are viewing.