HowTo: Create a Dynamic Form

Official Content
This documentation is valid for:

This article explains how to create a new and simple Dynamic Form (ref.: Dynamic Forms) in GXflow Client.

Step 1 - Run the GXflow Standard Client

First, open your GXflow Standard Client application. To do so, right-click on one of your Business Process Diagram object and select Run:

DynamicForm1_20221026103627_1_png

Step 2 - Log in and give permission to the user

Log in with a user that has the GXflow Backend Administrator role and add the GXflow Form Designer role —see Management Console for details on how to manage users and roles. If no user has the GXflow Backend Administrator role, log in with the WFADMINISTRATOR user in order to set this role to any user. Then log in with that user.

Note: when using GeneXus Access Manager the GAM Backoffice must be used in order to manage users, roles and permissions.

Step 3 - Open the Form Definitions component

Open the Form Definitions component by selecting it —it is located under the Dynamic Forms node. Once opened, the Form Definitions dialog should look as follows: 

DynamicForm2_png

Step 4 - Create a new Form Definition

Press the "NEW" button and write the form name:

DynamicForm3_png

Note: when using GeneXus Access Manager a permission will be created once the Form Definition is created, using the GAM Prefix property value. The GAM Prefix property will be ignored when GeneXus Access Manager is not used.

Step 5 - Add elements to the Form Definition

Next, you need to add some Elements to the newly created Form Definition.

To do so, select it from the grid and press the "ELEMENTS" button. A dialog box will be displayed for you to add and delete elements from the form:

DynamicForm4_png

In order to add an element press the "NEW" button. When the button is pressed the element creation dialog will be displayed; add a new element called "User Name" as follows:

DynamicForm5_png

Note: see Elements for details about the properties of an element.

Add two new elements called "Password" and "Password Confirmation" as shown below:

DynamicForm6_png

The last element to be added will be "User Age"; create this element as numeric using Length = 2 and Decimals = 0.

The layout should look as follows:

DynamicForm7_png

Add a rule in order to check that the "User Age" is not under 18.

To do so, edit the "User Age" element by hovering the mouse over the element and pressing the "RULES" button. Then in the Rules tab, and press the "NEW" button. Add an "Error" rule as follows:

DynamicForm8_20221026103033_1_png

Next, add a condition over the Rule; to do so, select the Rule from the grid and press "CONDITIONS" and then "NEW". Select the "User Age" element and create a condition as follows:

DynamicForm10_png

Step 6 - Associate the Form Definition to a User Task

Once the dynamic form is defined you need to associate it with a User Task. To do so, open your Knowledge Base and create a new Business Process Diagram object, drag a user task to the diagram and set the Application form property of the user task to the newly created Form Definition as shown below:

DynamicForm11_png

In order to set the newly created Form Definition to the user task: open the Application form property options by clicking on the "..." in it.
Then press the "..." of the "Form" property and select "MyNewDynForm" as follows:

DynamicForm12_pngDynamicForm13_png

Once the Form Definition is set to the Application form property deploy your Business Process Diagram object and execute the GXflow Client—running the newly created Business Process Diagram object is enough. 

Step 7 - Done!

Finally, test your form. To do so, Create a new Process Instance and execute it.

DynamicForm14_png

See Also

Dynamic Forms
Form Definitions