Active Form Flows Overview
  • 13 Apr 2022
  • 4 Minutes to read
  • Dark
    Light

Active Form Flows Overview

  • Dark
    Light

Article Summary

Overview

Active Form Flows use a combination of Flow and Rule logic to provide additional dynamic behaviors on a Form such as validating a user's input, hiding/showing, enabling/disabling, and/or setting values on controls. Active Form Flows use the Form Rule Behavior with new steps within the Form Rules category in the Toolbox.  

Form validation Rules are found within System > Designers > Catalog > System Defaults > Default Form Validation Rules. Users can also create their own Validation Rules in Designer Projects.

Active Form Flows are bound to the Forms they have been created on and cannot be reused; however, the logic created in the Active Form Flow can be bundled into a Sub Flow and reused in that manner.

It is highly recommended not to edit the default rules; please contact support@decisions.com if you have any questions.

Configuration


Setting NameSetting Description
Triggers
Populate with a list of Form controls that accept Data Types such as String, Int32, Boolean, etc. Below are the following Trigger Types:
  • Enter triggers once the end-user initially enters data.
  • Exit triggers once the end-user exits the control by clicking off of it for example.
  • Clear triggers once the end-user clears the entered value in the control.
  • ValueChanged triggers once the end-user edits the entered value in the control.
  • StoppedTyping triggers once the end-user pauses after entering a value in the control. By default, this initiates after a 300-millisecond wait.

The order in which these controls appear is configured by the Order By setting to either the Control Type or Name of the control.

Run at Startup
Initiates the Active Form Flow as soon as the end-user opens the Form.

For controls that a user would want to be hidden by default until changed otherwise, enable this setting.
Is Blocking

Forces the Form to wait until the Active Form Flow completely loads before proceeding with any other actions on the Forms thus synchronizing the Form's contents by forcing every control to load before submission. This is enabled by default and occurs every time the Flow runs. 

Disabling this setting runs the Active Form Flow asynchronously by allowing early end-user submission even if not every control loads.

Show Loading Indicator
Displays a loading indicator once the trigger occurs.
Auto Run
Schedules the Active Form Flow to run at a designated time interval.
Make Output Data As Form's Output
Makes the output data of the Active Form Flow shown as the output of the Form.
Run on All Outcomes
Designates the Active Form Flow to initialize all available outcomes on the Form.
Run For Outcomes
Designates which outcome(s) the Active Form Flow will run.



Form Rules Glossary

Available exclusively within the Active Form Flows Toolbox, Form Rules steps apply logic to the specified Form control(s). None of these steps are designed to output data; they instead affect Form controls that may contain data.

Step NameDescriptionInputs
Clear All ValidationsRemoves all validations in the Form.Inputs: N/A
Clear Particular ValidationRemoves a specified validation issue from the specified Form control.Inputs: Form Control (FormControlData), Validation Issues (FormControlValidationIssue)
Clear ValidationsRemoves all validations from the specified Form control.Inputs: Form Control (FormControlData)
Disable ControlFreezes the specified control preventing any editing of the control's contents. The Hide Value When Control Is Disabled checkbox toggles if the control's value automatically hides once disabled.Inputs: Form Control (FormControlData)
Disable Multiple ControlsFreezes the specified list of controls preventing any editing of the controls' contents. The Hide Value When Control Is Disabled checkbox toggles if the controls' values automatically hide once disabled.Inputs: Form Control (FormControlData)[]
Enable ControlUnfreezes the specified disabled Form control thus allowing the end-user to edit its contents again.Inputs: Form Control (FormControlData)
Enable Multiple ControlsUnfreezes the specified list of disabled Form controls thus allowing the end-user to edit their contents again.Inputs: Form Control (FormControlData)[]
Exit FormCloses the Form and then follows the specified Outcome Path in the parent Flow.Inputs: Outcome Path (String)
Get Control ValueCollects the set control value of the specified Form control.Inputs: Form Control (FormControlData)
Outputs: Value (dependent on control)
Get Form Data ValueCollects the value of the specified Data Name within a Form. The Type dropdown list allows the selection of the data type of this value.Inputs: Name (String)
Outputs: Value (dependent on control)
Hide ControlRemoves visibility of the specified Form control.Inputs: Form Control (FormControlData)
Hide Multiple ControlsRemoves visibility of the specified list of Form controls.Inputs: Form Control (FormControlData)[]
Set Control ValueChanges the value of the specified Form control.Inputs: Form Control (FormControlData)
Set ValidationsPlaces a list of validations issues on the specified Form control.Inputs: Form Control (FormControlData), Validation Issues (FormControlValidationIssue)[]
Show ControlUnhides the specified hidden Form control.Inputs: Form Control (FormControlData)
Show Multiple ControlsUnhides the specified list of hidden Form controls.Inputs: Form Control (FormControlData) []



Establishing Active Flow Managed Data 

Active Flow Managed Data is established to aid in dynamic behaviors and offer additional inputs to Active Form Flows. Active Form Managed Data is only available on Active Form Flows and cannot be used in the main Flow or as Form input data. 

  1. From the Form Designer, deselect the Form and navigate to the Properties tab. 
  2. Under FORM RULES > Active Flow Managed Data, click SHOW EDITOR. 
  3. On the Active Flow Managed Data window, provide a NAME and select a TYPE. Click Save and close the window.

Accessing Active Flow Managed Data

Add data to a Form by dragging it in from the Data panel under the FLOW MANAGED DATA category or apply it to an Active Form Flow. 




Outcomes

For v7.8- instances, outcomes paths may be utilized with the Exit Form step. For its Outcome Path input, specify the desired outcome name which should match the name of an Event's outcome. For example, an outcome intending to follow an Event Button named 'Submit' should also be named 'Submit'.

Introduced in Decisions v7.9, users may create new outcomes paths within Active Form Flows within the Active Form Flows Outcome Paths setting. To proceed through one of these Outcome Paths, add the Outcome names to the Active Form Flows Outcome Paths. After that, add an Exit Form step to the Active Form Flow and provide it with the matching Outcome name.


For further information on Forms, visit the Decisions Forum.

Was this article helpful?