Set up validation rule of type Custom

Release notes

Use validation rules to check if the data is in line with the defined standards.
To validate data, you can use several validation types. This topic explains how to set up the Custom validation type.

Use a custom validation to validate a field value using a custom validation class.
Before you can set up a custom validation rule, ensure that the custom validation class is developed.

For each validation rule, you can set up:

A validation message that is shown if the validation rule is not met.
Conditions to define the data to which the rule applies.

Activities

Name	Responsible	Description
Develop custom validation class	Developer	You can use a custom validation rule to validate a field value using a custom validation class. To set up a custom validation rule, first develop the custom validation class to be applied. The custom validation class must extend the DQSCustomValidationBase base class. When you extend the DQSCustomValidationBase base class: Enter a unique and recognizable description() for the class. The description is shown in the lookup of the Class name field of a custom validation rule. Use these methods to indicate to which data the custom class is applicable: getTablesList(): You can define the tables to which the custom class applies. As a result, you can select the custom class for a custom validation rule with one of the applicable tables defined. getExtendedDataTypesList(): You can assign extended data types to which the custom class applies, for example, 'ExternalItemId'. As a result, you can select the custom class for a custom validation rule with a field defined that uses the same extended data type. getBaseTypesList(): You can define base data types to which the custom class applies, for example, String or Date. As a result, you can select the custom class for a custom validation rule with a field defined with the same data type. Use the validateRecord() method to define the x++ code that runs the validation. This code must return one of these values: True: The value in the validation rule field is valid. False: The value in the validation rule field is invalid. The base structure of an extended DQSCustomValidationBase class is:
Set up validation rule of type Custom	Data quality administrator	Use validation rules to check if the data is in line with the defined standards. To validate data, you can use several validation types. This topic explains how to set up a validation rule of type Custom. Use a custom validation rule to validate a field value using a custom validation class. Before you can set up a custom validation rule, ensure that the custom validation class is developed. You can add validation rules in these ways: Manually. Select the fields to be validated from a page.
Set up validation rule message	Data quality administrator	You can define a message that is shown if the validation rule is not met. If no validation rule message is defined, the default message is shown if the validation is not met. In case of a data pattern validation, the applicable data pattern can also have a message defined. In this case, the message priority is: If a validation rule message is defined, this message is shown. If no validation rule message is defined, the data pattern message is shown. If no data pattern message is defined, the default message is shown. You can also enter a description of the validation rule. You can translate both the validation message and the validation rule description.
Set up validation rule conditions	Data quality administrator	For each validation rule, you can set up conditions. The validation rule is only applied if the conditions are met. To define a validation rule condition, you use a query. The validation rule is applied only to the records that are found by the query. You can use these types of queries: Inquiry: Use the standard D365 F&SCM Inquiry (SysQueryForm) page to define the records to which the validation rule applies. The inquiry only queries the table as defined for the validation rule. Dynamic query: Use a dynamic query to define the records to which the validation rule applies. Before you can set up a condition with a dynamic query, set up the dynamic query to be applied. You can use a dynamic query, for example, to query other tables than the validation rule table, to define table relations, and to have only one record returned.

Activities

Name	Responsible	Description
Develop custom validation class	Developer	You can use a custom validation rule to validate a field value using a custom validation class. To set up a custom validation rule, first develop the custom validation class to be applied. The custom validation class must extend the DQSCustomValidationBase base class. When you extend the DQSCustomValidationBase base class: Enter a unique and recognizable description() for the class. The description is shown in the lookup of the Class name field of a custom validation rule. Use these methods to indicate to which data the custom class is applicable: getTablesList(): You can define the tables to which the custom class applies. As a result, you can select the custom class for a custom validation rule with one of the applicable tables defined. getExtendedDataTypesList(): You can assign extended data types to which the custom class applies, for example, 'ExternalItemId'. As a result, you can select the custom class for a custom validation rule with a field defined that uses the same extended data type. getBaseTypesList(): You can define base data types to which the custom class applies, for example, String or Date. As a result, you can select the custom class for a custom validation rule with a field defined with the same data type. Use the validateRecord() method to define the x++ code that runs the validation. This code must return one of these values: True: The value in the validation rule field is valid. False: The value in the validation rule field is invalid. The base structure of an extended DQSCustomValidationBase class is:
Set up validation rule of type Custom	Data quality administrator	Use validation rules to check if the data is in line with the defined standards. To validate data, you can use several validation types. This topic explains how to set up a validation rule of type Custom. Use a custom validation rule to validate a field value using a custom validation class. Before you can set up a custom validation rule, ensure that the custom validation class is developed. You can add validation rules in these ways: Manually. Select the fields to be validated from a page.
Set up validation rule message	Data quality administrator	You can define a message that is shown if the validation rule is not met. If no validation rule message is defined, the default message is shown if the validation is not met. In case of a data pattern validation, the applicable data pattern can also have a message defined. In this case, the message priority is: If a validation rule message is defined, this message is shown. If no validation rule message is defined, the data pattern message is shown. If no data pattern message is defined, the default message is shown. You can also enter a description of the validation rule. You can translate both the validation message and the validation rule description.
Set up validation rule conditions	Data quality administrator	For each validation rule, you can set up conditions. The validation rule is only applied if the conditions are met. To define a validation rule condition, you use a query. The validation rule is applied only to the records that are found by the query. You can use these types of queries: Inquiry: Use the standard D365 F&SCM Inquiry (SysQueryForm) page to define the records to which the validation rule applies. The inquiry only queries the table as defined for the validation rule. Dynamic query: Use a dynamic query to define the records to which the validation rule applies. Before you can set up a condition with a dynamic query, set up the dynamic query to be applied. You can use a dynamic query, for example, to query other tables than the validation rule table, to define table relations, and to have only one record returned.

Related to	Notes
Set up validation rule of type Custom

Provide feedback