Generic Rules
Basic data quality rules that can be used in multiple use cases and scenarios to validate any product data.
Check_DependentFields
General description
Checks if a dependent field has a value if its driver field is complete.
Input ports
inDriverField |
Data field that defines (based on whether it is empty or not) if the dependent field needs to be filled. |
inDependentField |
Dependent field which may not be empty if driver field has a value. |
Output ports
Status_Code |
Returns the overall Status Code after the rule execution (OK or Failed). (QualityStatusEntry.Status) |
Status_Message |
Returns the overall Status Message after the rule execution. (QualityStatusEntry.Message) |
Meta data and reference tables
Error_messages_by_Language |
Contains a 4 digit error code plus a language to indicate the preferred error message to be output. |
Example usage
If the attribute for "Hazardous Material" (inDriverField) is set to "true" the attribute value for "Risk & Security Sentences" (inDependentField) may not be empty
Example output
Status_Code |
Failed |
Status_Message |
Checked field requires a value to be completed according to the dependent field. |
Check_Equal
General description
Checks if 2 field values assigned as input ports are equal.
Input ports
inObjectID |
Identifier of the parent object. (Object_ID) |
inCheckField1 |
Data field 1 that will be checked for equality against data field 2 |
inCheckField2 |
Data field 2 that will be checked for equality against data field 1 |
Output ports
outObjectID |
Returns the identifier of the parent object. (needed to aggregate status messages from multiple attribute checks to a single parent object status message) |
Status_Code |
Returns the overall Status Code after the rule execution (OK or Failed). (QualityStatusEntry.Status) |
Status_Message |
Returns the overall Status Message after the rule execution. (QualityStatusEntry.Message) |
Meta data and reference tables
Error_messages_by_Language |
Contains a 4 digit error code plus a language to indicate the preferred error message to be output. |
Example usage
Check if the value of Manufacturer (inCheckField1) is the same as for the attribute of brand name (inCheckField2)
Example output
Status_Code |
Failed |
Status_Message |
The input values are not equal. |
Check_isEmpty
General description
Checks if a given data field is null or empty.
Input ports
Field_Value |
Any product data field that will be checked whether it is 'null' or empty. |
Output ports
Status_Code |
Returns the overall Status Code after the rule execution (OK or Failed). (QualityStatusEntry.Status) |
Status_Message |
Returns the overall Status Message after the rule execution. (QualityStatusEntry.Message) |
Meta data and reference tables
Error_messages_by_Language |
Contains a 4 digit error code plus a language to indicate the preferred error message to be output. |
Example usage
Check if the "English short description" (Field_Value) of an item is null or empty.
Example output
Status_Code |
Failed |
Status_Message |
Input data value is blank or null. |
Check_isEmpty_SubentityLevel
General description
Checks if a given data field is null or empty. While running this rule on sub entities the inObjectID needs to be set to a valid object codeof the parent.
Note: sub entities need to exist to get evaluated by this rule, if no sub entities exists, this rule will never be executed and status will automatically be set to OK.
Input ports
inObjectID |
Identifier of the parent object. (Object_ID) |
inCheckField |
Any data field on sub entity level that will be checked whether it is 'null' or empty. |
Output ports
Object_id |
Returns the identifier of the parent object. (needed to aggregate status messages from multiple attribute checks to a single parent object status message) |
Status_Code |
Returns the overall Status Code after the rule execution (OK or Failed). (QualityStatusEntry.Status) |
Status_Message |
Returns the overall Status Message after the rule execution. (QualityStatusEntry.Message) |
Meta data and reference tables
Error_messages_by_Language |
Contains a 4 digit error code plus a language to indicate the preferred error message to be output. |
Example usage
Check if the any attribute value of an item is null or empty and report back failed if at least one of the attributes has no value set.
Example output
Status_Code |
Failed |
Status_Message |
Input data value is blank or null. |
Check_MaxLength
General description
Checks if a given data field is exceeding the allowed length. The particular length can be set through the rule configuration user interface by typing the desired integer number into the "inLength" field.
Input ports
inLength |
User Input of maximum length allowed |
inData |
Data field that will be checked for its length |
Output ports
Status_Code |
Returns the overall Status Code after the rule execution (OK or Failed). (QualityStatusEntry.Status) |
Status_Message |
Returns the overall Status Message after the rule execution. (QualityStatusEntry.Message) |
Meta data and reference tables
Error_messages_by_Language |
Contains a 4 digit error code plus a language to indicate the preferred error message to be output. |
Example usage
Check if the "English short description" (inData) is longer than the defined maximum length (inLength) specified.
Example output
Status_Code |
Failed |
Status_Message |
Data Field exceeds maximum length specified (10). |
Check_MinLength
General description
Checks if a given data field is having a minimum length. The particular length can be set through the rule configuration user interface by typing the desired integer number into the "inLength" field. Empty values are treated as zero-length and cause the rule to fail.
Input ports
inLength |
User Input of minimum length needed. |
inData |
Data field that will be checked for its length |
Output ports
Status_Code |
Returns the overall Status Code after the rule execution (OK or Failed). (QualityStatusEntry.Status) |
Status_Message |
Returns the overall Status Message after the rule execution. (QualityStatusEntry.Message) |
Meta data and reference tables
Error_messages_by_Language |
Contains a 4 digit error code plus a language to indicate the preferred error message to be output. |
Example usage
Check if the "English short description" (inData) is shorter than the allowed minimum length (inLength) specified.
Example output
Status_Code |
Failed |
Status_Message |
Data field shorter than minimum length specified (7). |