Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
titleSince 3.5

Table of Contents

...

Introduction

This functionality allows enables the system administrator to define establish extended validation rules regarding for the data entered or selected in the object edit form.

Validation is performed carried out on both on the client side for to provide immediate feedback, as well as and on the server side. Server-side validation is always consistently applied, regardless irrespective of the input type (manual entry, import, or via API).

Rules can apply be applied to the a single field; alternatively, or field pairs can be defined by specifying a master and dependent field. In this case, where values allowed in the dependent field are validated based on the selection made in the master field.

Administration and

...

Usage

...

Getting Started

Field validation rules can be added at any time in Administrative panel. Open To begin, open Field Validators section to begin:Image Removed

...

A few things to remember before starting:

...

important considerations before getting started:

  • Rules must be defined carefully since there is no special validation

...

  • process.

  • It will not be possible to edit an existing object that does not meet the new criteria

...

  • .

  • Setting conditions on inaccessible fields

...

  • for specific users

...

  • who can edit objects

...

  • may prevent

...

  • them from editing

...

  • at all.

  • A rule

...

  • set for a parent class

...

  • , such as Document, will also

...

  • apply to its child

...

  • classes. In the administration panel,

...

  • this rule will only be displayed where it was originally defined (on

...

  • the parent class).

     

Define

...

New Field Validator

  1. Choose the class for which you

...

  1. intend to

...

  1. incorporate field validators.

...

...

  1. Determine whether you

...

  1. need to add a master/slave field validator or a single field validator:

...

    1. When implementing master/slave validation,

...

    1. ensure that "dependent fields"

...

    1. is selected.

...

    1. For single field validation,

...

    1. deselect this option.

...

  1. Pick the field, specify the condition, and set the desired value

...

  1. .

  2. Click on "Add Condition."


Once this is done, your new validation condition can be seen on Existing conditions list.

Editing Validators

Conditions cannot be edited. To edit a condition, use the Delete button and add a missing condition again. 

Overlapping Conditions

Overlapping conditions

...

This is a situation occur when two or more conditions match a selected field and value.

In such a caseinstances, a the system will check conditions until a it encounters the first failing condition is found. It This principle also applies to master/slave dependency - a the first matching rule will be usedutilized.

It is advised advisable to avoid overlapping conditions like , as illustrated in this example:

Image Removed

The example above would read:

...

Image Added

  • When the Function field has a value of Personal or Service, the Areaklas field must be LOA or BOA.

  • For field Function having value

    If the Function field has a value of Personal, then the Areaklas field must be BIA.

In this casescenario, when the function field has value is set to Personal, only one of these rules will be applied apply in any order. As a resultConsequently, either LOA/BOA values will be required , or BIA in the second case. While the intention of the system administrator The intended system administration might have been aimed for a situation where for value Personal, LOA, BOA, or BIA are allowed , while for Service, for value Personal and only LOA and BOA . This are allowed for Service. However, this is not presently achievable as the case and the conditions will not be unified automatically merge into one unified set automatically.

To achieve the described validation, it is recommended to use a configuration looking that looks like this is recommended:Image Removed

...

Validator examples

Dependent (master/slave) dictionary fields

Dependent fields are created when selecting "Dependent Fields" configuration is selected. Every time Whenever a master field has an indicated a specified value, a rule for Dependent the dependent field will be enforcedapplied.

What's more, a Additionally, the system will automatically filter out disallowed values that are not allowed automatically.Image Removed

...

A result visible to the user editing a Space object would be as followssee the following result:Image Removed

...

Date

...

Validation

This example shows demonstrates how to set allowed date limits on a specific field. Hereestablish permitted date boundaries for a particular field. In this case, we have selected a specified that the Revision date to must be after 1905-02-25 and also after 2019-02-25.

These conditions are also checked independently, so evaluated separately, ensuring that only one validation will be made is executed at a time. If the "after" validation will passsucceeds, then the "before" validation will be performed conducted (the order might may vary).Image Removed

...

Text validation

A text Text validation can be performed carried out using single or master/slave fields like , as shown below.

In this example, validation will be performed only occur if the revision date is before a given specified date. In that casesuch cases, a document number field will be required to start with must begin with the "HIST-" string. For instance, for example, "HIST-234525" will would be considered a valid number.Image Removed

...

Number

...

Validation

A numeric Numeric field validation can be used utilized to create establish specific conditions like below.

In this caseinstance, we have set a requirement on ahas been defined for the Space object Area BRA field to be in fall within the range of 0 to 1000. 

Image RemovedImage Added

A result visible to that the user will see while editing this field will be is as follows:Image Removed

...

Field rules exceptions

There are some actions that may not apply filed rules.

...

New import option is now added to import dialog called Apply Field Rules.Image Removed

...

If it the checked option is selected, then the filed field validators will be applied during import. Objects from a package that do not apply adhere to fields the field rules will not be added, and a proper message will be added to included in the Object report. If it's un-checked, then no filed field validation will be doneperformed.

Note

In dialog, this option is checked by default checked (validation turned ON). If the import is run by carried out via API, this option's default value is false is false (so currently run scheduled imports will not be affected).

Custom

...

Plugins -

...

Administrator can decide whether Field rules should apply or not when Custom fields plugins are run.

In Custom Fileds\Fields availability tab, new column Apply Field Rules will allow to activate and disable filed rules while plugins run.

...

Smart Fields

Administrators now have the capability to control the application of field rules when executing custom field plugins.

In the Custom Fields\Fields Availability tab, a new column labeled Apply Field Rules allows for the activation and deactivation of field rules during plugin execution.

...

Update area

Info

Update area functionality will never trigger field rules validation.

This function was specifically designed just to copy the area from the corresponding spot to the object's metadata (area fields), . It seems that having field validation seems not needed is unnecessary as it would block prevent area update without chance to meet updates without providing an opportunity to adhere to field rules.