Data Check Definitions

Data Check objects were added in Version 20, Patch April 9, 2018

For an overview of Data Checks see Data Check Overview help. For help on using Data Checks in Case Information Displays see Data Checks Results shown in Case Information Displays

This help topic describes how to define a Data Check object. The fastest way to get a list of Data Checks to the Case Information Ribbon Tab and click on the Data Check button. This brings up a dialog with a three tabs. The third tab provides access to a case information display showing the list of Data Checks.

Data Check Exemptions

DataCheckExemption objects were added in Version 23, Patch September 25, 2023

A DataCheckExemption groups an Object and a DataCheck together. By defining a DataCheckExemption, then the Object will never return that it meets the respective DataCheck.

	Field	Description of Field
	DataCheckName	(KEY FIELD) Name of the data check to which this exemption applies
	Object	(KEY FIELD) String identifying the object using its objecttype and keyfields or label. This will follow the same syntax used for the ObjectID Field for use in Auxiliary Files. This field will show object strings based on the option set in the Case Information Toolbar for either Primary, Secondary , or Label key field identifiers.
	Reason	User enterable reason for the exemption. This string can be anything the user wants to enter and can also be a blank string.
	MeetsCriteria	Will show YES if the Object meets the DataCheck. If it is NO then it means the Exemption is not needed.

Data Check Objects

A data check object has key fields of ObjectType to which it applies and a Name. The Name need only be unique across all the Data Check objects that apply to the same ObjectType. The important fields of a Data Check are as follows.

	Field	Description of Field
	ObjectType	(KEY FIELD) This is the type of object to which the Data Check applies.
	Name	(KEY FIELD) The Name need only be unique across all the Data Check objects that apply to the same ObjectType
	Filter	This is the name of a filter that is applied to the objects of type ObjectType. The user may also enter a simple string defining a single field comparison such as “Vpu < 0.94” so that a named filter need not be created.
	Show	This is either YES or NO and determines whether to show the data check on the Check Results tab of the Data Check overview dialog . This stores the check box status from that dialog.
	ShowAggregation	This is either YES or NO and determines whether to show the data check on the Check Aggregation Results tab of the Data Check overview dialog . This stores the check box status from that dialog.
	Filter Meets String	If a particular object meets the Filter, then it will display the string specified here in the column associated with this data check. See
	Filter Not Meets String	Same as before, but this string will appear in the column associated with this Data Check if the object does not meet the filter.
	Description	This is the string that will appear when hovering the mouse over top the column headers associated with the Data Checks in the same way other column header hints work in case information displays
	Aggregation Format	The Aggregation Format describes how the aggregation fields will be displayed. The choices are Meets Meets/Total Meets:Not Meets See examples on the Data Checks Results shown in Case Information Displays.
	... additional fields...	A Data Check object can also be used to implement Dynamic Formatting on either the case information displays or the oneline diagrams. See help on Dynamic Formatting Overview for more information. Use this to dynamic highlight using colors and other graphic features data that meets the Filter of the data check.

Data Check Dialog

Right-clicking on a Data Check object in the case information display and choosing to Show Dialog will show the Data Check dialog. The Data Check dialog is shown in the following figure and provide access to editing the fields above. If you want to edit all the features related to Dynamic Formatting Dialog based on objects that meeting the Filter of the Data Check, then check the box Show Dynamic Formatting Features to expose those options.