Ensuring that your data meets a defined quality standard is vital. In Orien's Validation module, users can create specific validations to be applied to your Orien Data. This article provides details on the following aspects of the Validation Module:
- How to create customised validations
- Running validations
- Identifying and Exporting validation violations
For details on other Modules, please refer to the article on Module Configuration.
Validation Config
Basic Validations will be available on all databases. For custom validations, they will need to be configured before they can be run on assets. This is simple and easy to implement. To create Validations, select the Database Level and then select the Validation Config Module.
This module will show all of your created Validations and their details. The following details are shown:
- Validation Description
- Location
- Validation Type
- Activated
- Notes
A Validation Type must be defined for any Validation Configuration. There are various types to choose from, each with their own purpose. Below is a list of each and details on their usage:
This validation has 2 states: Passed and Warning. Passed is met when all tactics are in a finalised state. The warning is when at least 1 tactics revision is in a working revision. This is treated as a warning and not a violation as this isn't incorrect but should be noted.
An example of a cross-table conditional requirement, if the Constraint of an Activity is Offline, then an Activity's access time is required.
For example, all Meter Reading Dates must more recent than 1st January 2022.
For example, Budgeted Replacements shouldn't occur more than 10 number of times per month.
For example, ensuring that Operation Descriptions don't contain underscores ( _ ) or dashes ( - ).
This validation is designed to ensure that the increased in flexibility with Active Packaging Syncs (for more information read our article on the Operation Builder). This is designed to be a potential system requirement on critical assets ensure that every governance step is followed - especially with 3rd party integrations.
For example, the Regex formula for ensuring that Operations start with: 1-2 numbers followed by a single Letter, and then a space e.g. '12W ' is '/^\d{1,2}[a-zA-Z]\s.*/g'
For example, I want to ensure that all of my Activities have an Activity Type applied. Activity Type isn't a required field in Orien but this Validation finds each Activity where an Activity Type isn't applied.
Below are the required fields for each Strategy Type category - if these aren't met then they fail the validation:
- Condition Based
- Fixed Time
- Run to Failure
- Fault Find Interval
Note
Redundant Failure Modes are excluded from this Validation.
For example, checking that all Operation Descriptions have more than 15 Characters.
For example, checking that all Failure Mode Intervals are Greater Than 0.
For example, a Unique System Value on my SAP DIR Number Custom fields shows a violation where duplicates are found.
For example, Valid Global Codes for Operation Materials ensures that any Material Allocated to an Operation hasn't been deleted from the database - before being unallocated.
Validation Module
The Validation module can be selected on any location or asset. The Validation Module contains 2 tabs: Validator and All Validations. The Validator tab contains all Validations appropriate to the selected location, the status of the Validation (Successful or Unsuccessful), and additional details of the validations. The All Validations Tabs shows basic details for all the validations run for the selected locations and all locations beneath.
There are reasons for specific Validations not being shown on specific locations. Locations can have different data types e.g. Assemblies not containing Measurement data or Validations being allocated to specific structures.
Validator
Once created the Validations will appear in the Validation Module. The first tab labelled Validator only shows the validations applied to the selected location, and their last generated validation. On this tab, each validation, per location can be individually run and the result provided on the screen. Also, by selecting 'Validate All', all Validations for the selected location can be run.
Each Validation's configuration, that applies to this location, can be viewed on this screen by selecting 'View Validation' beneath the Validation's Description. This will show all details for this Validation, including the validation elements themselves. For example, you can view the Regex being applied to the Operation Description and the notes associated to it.
If the Validation is Violated, then a link labelled 'View Violations' is show. This will show all the violations for that Validation. This is a critical part of the validation module. The ability to see each Violation, the field and reason it failing the validation, and to be directed to object failing the validation.
All Validations Grid
The All Validations Tab provides the ability to see all run validations and their status, for multiple locations. Below are the criteria for each status:
- Successful - All Validations available to that location have been successfully run.
- Incomplete - Only some Validations have been run successfully.
- Violated - One or More Validations for this location has been violated.
Locations can be filtered to show their specific status (Successful, Incomplete, Violated) by selecting the wanted filtering status. Additionally, the progress bar of this screen shows the percentage of Validations run for that location compared to the total Validations applied.
Validations in Approvals
Validations can be allocated within the approval configurations as a Validation Step. Validation steps run the selected validation/s prior to finalisation - one or many validations can be run in a single step. If the Validation is violated, the finalisation fails and it reverts back to a Working State.
The Packaging Approval process below will start by running the Validations called 'Required Operation Labour' and 'Required Operation Constraint' in the 1st Step. If any violations occur for these two Validations it will be rejected and the Requester will receive an email of the Violations. If it succeeds, it will process to the 2nd Step which is a User Approval.
When these validations are run as part of the approval step, they are run in the Validation Module and will override the most recent validation run. For more information, please refer to the Approval Configuration article.