Stepper validations

In a stepper, it is possible to execute data validations that can prompt user alerts.

These validations are triggered by specific events, such as entering a stepper or step, altering a field value, or transitioning out of a step.

Validations in steppers

The types of validations available in a stepper include:

  • Stepper validations: check data in any entity modified during a stepper process in order to warn or block the user. They run upon stepper completion.

  • Step validations: check data in the entity modified within a step in order to warn or block the user. They run upon step completion.

  • Form validations: check data in the entity modified within a 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 an entity, including:

  • Foreign: ensures a referenced value exists.

  • Mandatory: verifies that mandatory attributes or references are not left null.

  • Check: executes SemQL or plugin validations.

A special validation type, called DETECT_DUPS, is available for steppers and steps. When creating a new record, this validation runs the matching rule defined for an entity and presents possible duplicates, allowing the user to replace the new record in the stepper with an existing duplicate.

Configure stepper validations

A stepper validation is triggered upon stepper completion and assesses data changes when the user attempts to apply them. If a validation fails, the user is notified and may be prevented from applying the data changes.

To configure stepper validations:

  1. In the Stepper editor, scroll down to the Validations table. This table displays 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. For multiple selection, click all desired items by pressing and holding the Control key.

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

    • Skip: excludes the validation from execution.

    • Warn: executes the validation and signals any failure as an issue to the user. The user may choose to ignore the warning.

    • Block: executes the validation and marks any failure as a blocking issue to the user. The user cannot proceed as long as blocking issues remain.

Configure step validations

A step validation occurs when the user exits a step. If the validation fails, the user is alerted and may be prevented from progressing beyond 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 displays a table with the list of validations available for the entity handled 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. For multiple selection, click all desired items by pressing and holding the Control key.

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

    • Skip: excludes the validation from execution.

    • Warn: executes the validation and signals any failure as an issue to the user. The user may choose to ignore the warning.

    • Block: executes the validation and marks any failure as a blocking issue to the user. The user cannot proceed as long as blocking issues remain.

Configure form validations

A form validation occurs when the user enters or modifies a form. This type of validation does not block the user, but raises a message beneath the field(s) causing the validation failure. To force the user to resolve the issue before proceeding, consider using a combination of a (non-blocking, informative) form validation and a (blocking) step validation.

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 displays a table with the list of validations available for the entity handled 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. Select the appropriate option to execute validations:

    • On Form Open: executes a validation when the user opens the form.

    • On Data Change: executes a validation when the user changes the value of an attribute that serves as an input for the validation.