Condition Checks
The Rules Engine comes with a predefined list of optional condition checks which can be configured for each rule. If one or more of these condition checks are not met, the rule is not run, and the user is prompted with a message describing what condition was not met and for which document and attribute. Each check is separate, and until all the conditions have been met, the operation cannot be completed.
'EMPTY' attribute check
For the condition to pass, the attribute in Parameter 1 must be empty. The user is required to clear this attribute before the operation can be completed.
'NOT_EMPTY' attribute check
For the condition to pass, the attribute in Parameter 1 cannot be empty. The user is required to clear this attribute before the operation can be completed.
'EQUAL_TO' attribute check
For the condition to pass, the value of the attribute in Parameter 1 must be the same as the static value or attribute value defined in Parameter 2.
When comparing attributes, the attribute name in Param2 must be of the form: $EDIT#<Attribute Name>$
'NOT_EQUAL_TO' attribute check
For the condition to pass, the value of the attribute in Parameter 1 cannot be the same as the static value or attribute value defined in Parameter 2.
When comparing attributes, the attribute name in Param2 must be of the form: $EDIT#<Attribute Name>$
'IN' attribute check
For the condition to pass, the attribute in Parameter 1 must be in the list of static values defined in Parameter 2. Each value must be separated by a semi-colon (;).
'NOT_IN' attribute check
For the condition to pass, the attribute in Parameter 1 cannot be in the list of static values defined in Parameter 2. Each value must be separated by a semi-colon (;).
'REGEXP_MATCH' attribute check
For the condition to pass, the attribute in Parameter 1 must conform to the regular expression defined in Parameter 2. Used in situations where specific validation is strongly recommended. Can also be used to establish that an attribute is not empty.
Action Type | IN |
---|---|
Param1 | <Target Attribute Name> |
Param2 | <Static Value>;<Static Value>;<Static Value> ... |
For more information on regular expressions, see:
'REFS_VALID' reference document attribute check
This condition check is used exclusively for CAD reference sets (CAD master documents that have CAD reference documents attached)
The attribute defined in Parameter 1 will be checked in all reference documents and if any of them contains any one of the values defined in Parameter 2, the condition will fail, and the master document cannot have its state changed. For example, if any references are marked as UNAPPROVED, you cannot approve the master document.
Action Type | REFS_VALID |
---|---|
Param1 | <Target Attribute Name in Reference Documents> |
Param2 | Unapproved reference status value (for example, UNAPPROVED) |
As an example, as reference documents are created, the default value of the reference status attribute would be set to UNAPRROVED. As it is issued as an approved design, and therefore suitable to be used as a reference document with other master documents, the reference status attribute could be set to APPROVED using the Rules Engine’s SET_ATTR action. Any reference documents which still have UNAPPROVED as their reference status value would fail the REFS_VALID condition check, if Parameter 2 is set to UNAPPROVED.