Validation rule description - SmartPlant Foundation - Help

SmartPlant Foundation Help

PPMProductFamily
Asset Information Management
PPMProduct
SmartPlant Foundation
PPMCategory
Help
SPFVersion_custom
2019 (10.0)
Version_Integration
(none)
Version_SPM_custom
2019 (10.0)
Version_SPPID
8.0.0
Version_SDAConnectorforTruView
(none)
Version_Fusion
(none)
Version_MTR
(none)
Version_SPO
(none)
Version_SPR
13.x(2018)
Version_TruView
(none)
Version_SDV
(none)

The following table lists all the validation rules and their descriptions supplied with Data Validator.

Rule name

Description

Check Claimed to Sub Configuration

Checks to see if a plant-level item has been claimed to the project.

Check Duplicate Issue Dates

Checks to see if there are revisions with duplicate issue dates for the same master document.

Check File Exists

Checks to see that a file exists in the specified path and that security has been set to configure access permissions.

Check For Cyclic Relationships

Checks to determine if the same object is set on both End 1 and End 2 of a relationship definition.

Check Object Exists

Checks to see if the object exists in the target system already.

Check File Exists for Document Revision

Checks to see if any file is attached to the document revision if the document revision is not a planned revision.

Check Parallel Claim

Checks to see if the item is claimed to a parallel project under the same plant.

Check Is Claimable

Checks to see if the data object is claimable into the SmartPlant Foundation collaboration project and prevents the object from being loaded.

Check is Revisable

Checks to see if the document is revisable to the SmartPlant Foundation collaboration project and prevents the document revision from being loaded.

Check Revised to Sub Config

Checks to see if a plant-level document has been revised to the project.

Check Revised to Parallel Config

Checks to see if the document item has been revised to a parallel project under the same plant.

Check Properties Against Schema

Checks to see if the target property definitions are valid for the target object type or relationship type, and if the values are valid for these properties, including whether required values are present.

Check Relationship Exists

Checks to see if the relationship exists in the target system.

Check Unique Key

Checks to see if a specific unique key already exists elsewhere in the system and cannot be implicitly claimed. This check runs only on the target system and detects duplicates in the source files.

Check Value and UOM

Checks to see if the UOM of the object property is the same as the UOM configured in the target system. It also checks to see if the object property value is defined within a specified range of minimum and maximum values.

Compare All Property Values For Objects

Checks to see if all the staging system object property values are the same as the target system object property values.

Compare Value

Checks to see if the staging system object property or relationship property value is the same as the target system object property or relationship property value.

Date Time

Checks to see if an object property or relationship property must validate against some date and time, YMD, or DMY. Must be in invariant format.

Double

Checks to see if an object property value or relationship property value has a minimum and a maximum value.

Integer

Checks to see if an object property value or relationship property value is defined within a specified range by a minimum and maximum value.

Regular Expression

Checks to see if an object property value or relationship property value adheres to a specified pattern.

Staging System Cardinality

Checks for the cardinalities between the related objects.

String Does Not Start With

Checks to see that the value does not start with the given value.

String Length

Checks to see if the length of an object property or relationship property is within a specified minimum and maximum limit or adheres to a specified pattern.

String Not Equal To

Checks to see that the value is not equal to the given value.

Target System Cardinality

Checks for the minimum and maximum cardinality values between related objects from the target system.

  • The Check Duplicate Issue Dates rule cannot be used if the revision object is configured to be identified using a query definition.

  • The Check File Exists rule validates the existence of the file specified in your CSV file by checking in your Data Validator application server file system or your target system application file system, depending on the property action.

  • The Check File Exists for Document Revision rule validates the document revision and checks if any file is attached to it, unless the document revision is a planned revision. In the case of a planned revision, the rule does not check for attached files.

  • The Check is Claimable rule is applicable only when data objects are loaded into collaboration projects.

  • The Check is Revisable rule is applicable only when document revisions are loaded into collaboration projects.

  • The Check Unique Key rule can be used in collaboration projects to avoid loading of duplicate data for non-claimable items.

  • The Compare Value rule ignores null values in the target system if the object property action or 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 Check Revised to Sub Config rule and Check Revised to Parallel rule are not auto generated in the supplied system, but they can be changed to auto generate using the system options.

  • The Regular Expression rule allows you to create a regular expression by including object properties in the pattern. The object property text should exactly match the case of the object property in the database. Additionally, you must add an ampersand (&) around each property for it to be parsed. For example, the following syntax will search for two digits, followed by a hyphen, and then an object property: ^(\d\d-&OBJ.<Property Definition UID>&)$.

  • The Check Properties Against Schema rule checks for:

    • The disabled enums and unmapped properties and reports the results in the validation report. You can use the Allow Disabled Enum Entries check box in the Edit Rule dialog box to determine whether the disabled enums are to be reported in the validation report. The Check for Unmapped Properties check box in the Edit Rule dialog box allows you to check if any of the properties of an object are not mapped to the target system properties.

    • The property values scoped by an enumerated list level type by matching them to the parent enumerated list values. For example, an instrument has two properties, Construction Status and Construction Status2. ConstructionStatus is scoped by EnumListType, and ConstructionStatus2 is scoped by EnumLevelListType. The ConstructionStatus2 property value depends on the value of the ConstructionStatus property. If the input CSV file specifies ConstructionStatus as New and ConstructionStatus2 as Relocate, which is not in the New list, the Construction Status2 property is reported as invalid in the validation report.

      ConstructionStatus

      (EnumListType)

      ConstructionStatus2

      (EnumListLevelType)

      New

      New

      Existing

      Relocate

      Revamp

      Temporary

  • The Check Value and UOM rule checks the UOM of the object property when the object property value is blank. You can use the Allow Blank Values check box to specify that the object property value is blank.