Validation Rule Conventions
Conventions about validation rules, naming, creation, etc
Validation Rule Metadata Conventions
- The Validation Rule Name MUST try to explain in a concise manner what the validation rule prevents. Note that conciseness trumps clarity for this field.
- All validation Rules
APInames MUST be written in PascalCase.
- Validation Rules SHOULD NOT contain an underscore in the fields name, except where explicitly defined otherwise in these conventions.
- A Validation Rule SHALL always start by a shorthand of the object name (example:
ACC, then the string
VR, followed by a number corresponding to the number of validation rules on the triggering Object, followed by an underscore.
- The Validation Rule Error Message MUST contain an error code indicating the number of the Validation Rule, in the format
XXbeing the Validation Rule Number.1
- Validation Rules MUST have a description, where the description details the Business Use Case that is addressed by the VR. A Description SHALL NOT contain technical descriptions of what triggers the VR - the Validation Rule itself SHOULD be written in such a manner as to be clearly readable.
1 While including an error code in a user displayed message may be seen as strange, this will allow any admin or consultant to find exactly which validation rule is causing problems when user need only communicate the end code for debugging purposes.
Validation rules writing conventions
- All Validation Rules MUST contain a Bypass Rule check.
Wherever possible, a Consultant SHOULD use operators over functions.
All possible instances of
IF()SHOULD be replaced by
Referencing other formula fields should be avoided at all cost.
In all instances,
ISBLANK()should be used instead of
ISNULL, as per this link.
Validation Rules MUST NOT be triggered in a cascading manner.1
||If you select "other" as a cancellation reason, you must fill out the details of that reason. [OPP_VR01]||Prevents selecting "other" less reason without putting a comment in. [OPP_VR01]|
||The status cannot advance further if it is not approved. [OPP_VR02]||The status cannot advance further if it is not approved. [OPP_VR02]|
1 Cascading Validation Rules are defined as VRs that trigger when another VR is triggered. Example: A field is mandatory if the status is Lost, but the field cannot contain less than 5 characters. Doing two validation rules which would trigger one another would result in a user first seeing that the field is mandatory, then saving again, and being presented with the second error. In this case, the second error should be displayed as soon as the first criteria is met.