Define validation rules and rule sets - SmartPlant Foundation - IM Update 48 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

When do I need to create a validation rule?

Create a validation rule when you need to validate the data before you export it to a target system. The validation rule ensures that the data conforms to the quality requirements, schema standards, and so on.

How do I ensure that imported data conforms to the object property schema and the relationship property schema?

The Check Properties Against Schema validation rule ensures that imported data conforms to the object and relationship property schemas. This rule can be auto-generated when configuring the system options.

How do I ensure that imported properties are valid on classified items?

The Check Properties Against Classification validation rule ensures that only those property definitions that are relevant to the object classification of the item can be imported. The rule checks for attributes on the column sets of the classification items.

For more information on managing attributes for classifications, see SmartPlant Attribute Manager.

The rule does not validate documents.

  • The rule ensures that attributes not applicable for a classification do not get loaded if they are not defined on the column set related to the object classification. If no attributes are found for the object classification (SPFPrimaryClassification), the rule will search for a relevant column set along the hierarchy of the object’s classification tree till a column set is found and then validate the properties on the object against this column set.

    For example, tags of type pipe and pressure transmitter will have different properties. A pipe will have properties like paint code and nominal pipe diameter while it does not make sense for a pressure transmitter to have such properties.

  • Also, if the classification was not provided as part of the load job for an existing object, the classification against which the attribution will be checked can be derived by the rule from the Target system object.

  • If the classification is shared by more than one classified item (for example, SDAAsset and SDAModel with FDWMaterialClassification), the rule is capable of detecting which attribution it needs to check against. For example, an Asset is not validated against a Model column set.

  • The rule works in combination with Concurrent Engineering, where tags or assets might be claimed from As Built, Projects, and so on, and reclassified consequently. The rule checks for the classification of the object in the appropriate configuration. For example, an asset can have different classifications in As Built and in Projects, and the rule checks for the relevant attributes for the classification accordingly.

Validation rules and rulesets

Validation rules verify that the data in an imported record meets the data standards specified for the target system. Each validation rule contains a formula that evaluates the imported data in one or more fields and verifies that it matches the existing criteria and hierarchy found in the target system database. Each validation rule includes an error message that is recorded in a validation report when the rule returns an invalid value.

All the validation rules that will be used in a job are grouped into a set. You can create a validation rule set, and then create the individual rules that will make up that set. When you create or edit your own custom mappings, we recommend you do not use the MSR or HEX prefix in the names of the mapping element. For more information, see Configure Data Validator mappings.

For a list of the existing validation rules and their actions supplied with Data Validator, see Validation rules and actions.

SHARED Tip You can configure Data Validator to automatically generate validation rules when you create your import mapping. For more information, see Configure the automatic generation of validation rules and Create a validation rule relationship.

When any validation rule is deleted that contains class definitions, relationship definitions, or property definitions that are no longer used by Data Validator, those schema items are automatically removed from the database.

What do you want to do?