Validation Feedback Collector

Category: Modules
Subcategory: Tracing

Overview

NOTE: The only difference between version 1.2.0 and 1.1.0 and 1.1.1 is the supported Mx Versions. See release notes for more details.

Reuse your validation microflows in an easy way!

We all love to build validation microflows and use the “Validation Feedback”-microflow activity to show validations to the user in a nice user-friendly way. However, as soon as you would like to re-use that microflow when the user does not have the input fields on the page, you’ll get ugly Info popups, sometimes even per message. Eg. reusing the microflow for a bulk validation, is tricky. The old workaround for this would include input booleans to show these messages, or by having “lists of errors,” neither of which make for clear and concise microflows. This module combines the best of both worlds! You can keep the Validation Feedback activities and later convert them in a “list of errors”. It can also prevent the pop-ups from showing up to the user. For a demo see: https://validationfeedback-sandbox.mxapps.io/

Documentation

Demo urlhttps://validationfeedback-sandbox.mxapps.io/

Description

Reuse your validation microflows in an easy way! We all love to build validation microflows and use the “Validation Feedback”-microflow activity to show validations to the user in a nice user-friendly way.

However, as soon as you would like to re-use that microflow when the user does not have the input fields on the page, you’ll get ugly Info popups, sometimes even per message. Eg. reusing the microflow for a bulk validation, is tricky. The old workaround for this would include input booleans to show these messages, or by having “lists of errors,” neither of which make for clear and concise microflows.

This module combines the best of both worlds! You can keep the Validation Feedback activities and later convert them in a “list of errors”. It can also prevent the pop-ups from showing up to the user.

For a demo see: https://validationfeedback-sandbox.mxapps.io/

 

Typical usage scenario

  • Reusing validation flows that use validation feedback messages in REST / SOAP services
  • Reuse validation flows in a bulk validation action
  • Reuse validation flows for pages in a wizard in one grand total validation on the last page.

Features and limitations

Main feature: convert validation feedback messages that should be pushed to the client into a list of non persistent objects with:

  • Entity Name
  • Object GUID
  • Object Member (attribute / reference) that the message is pushed to
  • Validation Message

Included Actions:

  • Get all validation feedback messages that should be pushed to the client
  • Filter validations by entity (and it’s specialisations)
  • Filter validations by object
  • Retrieve an object of a specific entity type, by GUID, note: this will get the changed or dirty state version, just as a retrieve over association would.

Dependencies

Supports Mx 7.14.1 and up

Installation

Just import the module and you’re set!

Configuration

Use a validation flow as described here: https://docs.mendix.com/howto/logic-business-rules/extract-and-use-sub-microflows#HowtoUseSubMicroflows or https://gettingstarted.mendixcloud.com/link/module/95/lecture/822 

After your validation flow, you can use the Java Actions (exposed as Microflow Actions) to return the feedback in lists of Error objects. This way you don’t have to change anything in the validation flow. (See the screenshots).

The RemoveFeedback boolean determines whether:

  • False: the feedback is copied, but the messages are still sent to the client.
  • True: the feedback is copied, and the messages will no longer be shown in the client.

Known bugs

None

Frequently Asked Questions

  • Q: Is it really that easy?
  • A: Yes, it is!

Releases

Version: 1.2.0
Framework Version: 9.6.0
Release Notes: Upgraded to Mx 9.6.0. Aside from that, identical to 1.1.0 and 1.1.1.
Version: 1.1.1
Framework Version: 7.23.1
Release Notes: Added read access for new module role "User". (Mx 8 version)
Version: 1.1.0
Framework Version: 7.14.1
Release Notes: Added read access for new module role "User". (Mx 7 version)
Version: 1.0.0
Framework Version: 7.14.1
Release Notes: Initial upload