Rule auto-generation model - SmartPlant Foundation - IM Update 46 - 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)

Each action you see in the import mapping user interface comes from a specific enumerated list. The following three enumerated lists for actions are delivered with Data Validator: VTLObjectActions, VTLPropActions, and VTLRelActions.

All validation rules have the same class definition and realize a specific interface definition with properties for each rule type, such as IVTLCheckObjectExistsValidationRule.

For an action to appear in the Validation page of the Data Validator Default Options dialog box, the enum must instantiate the IEnumEnumVTLExt interface. For a rule to appear, it must have the IVTLRuleSupportsAutoGen interface. The rules must also have the IPropertyValidationRule interface to be available for property actions, the IVTLRelationshipValidationRule interface to be available for relationship actions, and the IVTLRelDefValidationRule interface to be available for relationship property actions.

To ensure the creation of logical relationships, the relationship definition for VTLActionVTLValidationRule includes specific interfaces to relate the action to the rule.

The following validation rules are provided in the base configuration:

Item

Action

Rule

Object

Check Exists

Check Object Exists,

Compare All Property Values For Objects

Object

Create Update

Check Properties Against Schema,

Compare All Property Values For Objects

Object

Delete

Check Object Exists,

Compare All Property Values For Objects

Object

Terminate

Check Object Exists,

Compare All Property Values For Objects

Object

Rename

Check Object Exists,

Compare All Property Values For Objects

Object

Update

Check Object Exists, Check Properties Against Schema,

Compare All Property Values For Objects

Object

No Action

Compare All Property Values For Objects

Property

Check Staging File Exists

Check File Exists

Property

Check Target System File Exists

Check File Exists

Relationship

Create Update

Target System Cardinality

Relationship

Check Exists

Check Relationship Exists

Relationship

Delete

Check Relationship Exists

Relationship

Terminate

Check Relationship Exists

Relationship Property

Create Update

Check Properties Against Schema

Relationship property

Compare Value

Compare Value

The following rules are not auto-generated in the delivered system, but they can be changed to auto-generate using the system options.

Item

Action

Rule

Object

Check Exists

Check Claimed To Sub Config, Check Parallel Claim, Check Properties Against Schema, Check Revised to Parallel Config, Check Revised to Sub Config

Object

Create Update

Check Claimed To Sub Config, Check Object Exists, Check Parallel Claim, Check Revised to Parallel Config, Check Revised to Sub Config, Check File Exists for Document Revision, Check is Claimable, Check is Revisable

Object

Delete

Check Claimed To Sub Config, Check Parallel Claim, Check Properties Against Schema, Check Revised to Parallel Config, Check Revised to Sub Config

Object

No Action

Check Claimed To Sub Config, Check Object Exists, Check Parallel Claim, Check Properties Against Schema, Check Revised to Parallel Config, Check Revised to Sub Config

Object

Rename

Check Claimed To Sub Config, Check Parallel Claim, Check Properties Against Schema, Check Revised to Parallel Config, Check Revised to Sub Config

Object

Terminate

Check Claimed To Sub Config, Check Parallel Claim, Check Properties Against Schema, Check Revised to Parallel Config, Check Revised to Sub Config

Object

Update

Check Claimed To Sub Config, Check Parallel Claim, Check Revised to Parallel Config, Check Revised to Sub Config, Check File Exists for Document Revision, Check is Claimable, Check is Revisable

Object

Validate Only

Check Claimed To Sub Config, Check Object Exists, Check Parallel Claim, Check Properties Against Schema, Check Revised to Parallel Config, Check Revised to Sub Config, Compare All Property Values For Objects, Check File Exists for Document Revision

Property

Check Staging File Exists

Compare Value

Property

Check Target System File Exists

Compare Value

Property

Compare Create

Check File Exists, Compare Value

Property

Compare Value

Check File Exists, Compare Value

Property

Validate Only

Check File Exists, Compare Value

Relationship

Check Exists

Check for Cyclic Relationship, Compare All Property Values For Objects, Target System Cardinality

Relationship

Create Update

Check for Cyclic Relationship, Compare All Property Values For Objects, Check Relationship Exists

Relationship

Delete

Check for Cyclic Relationship, Compare All Property Values For Objects, Target System Cardinality

Relationship

Terminate

Check for Cyclic Relationship, Compare All Property Values For Objects, Target System Cardinality

Relationship Property

Compare Create

Check Properties Against Schema, Compare Value

Relationship Property

Compare Value

Check Properties Against Schema

Relationship Property

Create Update

Compare Value

The Compare Value rule ignores null values in the target system if the object property action or the relationship property action is set to Compare Create, but respects the null values if the action is set to Compare Value. This is because exporting with a Compare Create action requires blank target system values to be updated without altering any existing values.

  • The VTLActionVTLValidationRule relationship definition links the action to the specific rule interface definition.

  • For a detailed description of each validation rule, see Validation rule description.

  • For more information on setting the Data Validator default options, see Set Data Validator default options.