Stepper Validations

In a stepper, it is possible to run data validations and raise issues to the user.

Validations run when certain events take place in the stepper. For example, when the user enters a stepper or a step, modifies a field value or leaves a step.

Validations in Steppers

The type of validations available in a stepper include:

  • Stepper Validations check data in any entity modified in the stepper in order to warn or block the user. They run when the stepper finishes.

  • Step Validations check data in the entity modified in the step in order to warn or block the user. They run when the step completes.

  • Form Validations check data in the entity modified in the step in order to warn or block the user. They run when the user opens or modifies data in the form step.

Validations refer to the data quality rules defined for the entities, including:

  • FOREIGN to check a that a referenced value exists.

  • MANDATORY to check that a mandatory attribute or reference is not left null.

  • CHECK to run a SemQL or Plug-in Validation.

A special validation type called DETECT_DUPS is available for Stepper and Step Validations. When the user is creating a new record, this validation type run the matching rule defined for the entity and shows possible duplicates, allowing the user to replace the new record in the stepper by an existing duplicate.

Configure Stepper Validations

A stepper validation runs a validation when the stepper completes and the user tries to apply the data changes.
If a validation fails, it is raised to the user, and may possibly prevent him from applying the data changes.

To configure stepper validations:

  1. In the Stepper editor, scroll down to the Validations table. This table shows the list of validations defined for the entities managed in the stepper.

  2. Click the Synchronize Stepper Finish Validations Synchronize Stepper Finish Validations button in the table toolbar to refresh the list with new validations.

  3. Select the validation you want to run or select multiple validations while keeping the <CTRL> key pressed.

  4. Right-click and then select the behavior of this validation:

    • Skip: Do not run this validation

    • Warn: Run this validation and raise a failure as an issue to the user. The user may choose to ignore the warning.

    • Block: Run this validation and raise a failure as a blocking issue to the user. As long as blocking issues exist, the user cannot proceed.

Configure Step Validations

A step validation runs a validation when the user leaves a step.
If a validation fails, it is raised to the user, and may possibly prevent him from leaving the current step.

To configure step validations:

  1. In the Stepper editor, scroll down to the Steps tree table.

  2. Select the step you want to modify.

  3. In the Properties view, select the Validations finger tab.
    This tab shows a table with the list of validations available for the entity managed in the step.

  4. Click the Synchronize Step Validations Synchronize Step Validations button in the table toolbar to refresh the list with new validations.

  5. Select the validation you want to run or select multiple validations while keeping the <CTRL> key pressed.

  6. Right-click and then select the behavior of this validation:

    • Skip: Do not run this validation

    • Warn: Run this validation and raise a failure as an issue to the user.

    • Block: Run this validation and raise a failure as a blocking issue to the user. As long as blocking issues exist, the user cannot proceed.

Configure Form Validations

A form validation runs a validation when the user enter or modifies a form. Such a validation does not block the user, but raises a message under the field(s) that causes the validation failure. Combine the use of a form validation (which shows useful information but is non-blocking) with a step validation (blocking) if the user should be forced to fix an issue before proceeding.

To configure form validations:

  1. In the Stepper editor, scroll down to the Steps tree table.

  2. Select the form step you want to modify.

  3. In the Properties view, select the Form Validations finger tab.
    This tab shows a table with the list of validations available for the entity managed in the step.

  4. Click the Synchronize Form Step Validations Synchronize Form Step Validations button in the table toolbar to refresh the list with new validations.

  5. Check the appropriate option to run validations:

    • On Form Open: When the user opens the form.

    • On Data Change: When the user changes the value of an attribute that is an input for the validation.