Configuring Form Wizard

Owned by kiran.kumari@intellectdesign.com (Unlicensed)
Last updated: May 22, 2019 by Ravikumar Babu CTOO (Unlicensed)

Form Wizard consists of a sequence of forms through which the end user can navigate sequentially in order to achieve a specific objective. Form Wizard is similar to Tab panel, but the difference is, Form Wizard enables end user to navigate between the forms using Previous and Next buttons, also allows you to complete the process using the Submit button.



Form Wizard can contain any number of forms within the wizard as menus. Sequence of the menus is defined by the sequence in which the forms are selected while adding them to the Form Wizard.

The sequence of the menus can be changed only by deleting the menus and adding the forms again in a correct sequence.



In the subsequent steps, let's look at the details for creating a Form Wizard in Form Designer.

  1. Click Create > Form.



  2. Click Form Wizard icon in the Form ribbon.



  3. In the pop-up window, select the forms which are to be displayed in the Form Wizard. Sequence of the menus in Form Wizard is defined by the sequence in which the forms are selected from the pop-up window.



  4. Click Save to save the form selections and close the pop-up window.
  5. Configure the Form Wizard. The following table provides information about the properties that are applicable to Form Wizard:


#

Property

Description

Sample Values

1

Form ID

Unique ID of the Form on which you want to place the Form Item.

BASIC_DETAILS

2

Title

Form Title that appears on the user interface as a title. Form title can be a plain text or property-key driven text.

Form wizard

3

Description

Brief description about the Form for reference.

Example for Form Wizard

4

Data support class

Class Path of the data support class will be entered here. The data support class can contain the data for combo boxes, check boxes and radio buttons.

com.intellectdesign.canvas.formdefinition.addinfo.DefaultAdditionalDataSupport

5

Channel

Assigns the form item compatibility for various devices.

Desktop / Tablet / Mobile

6

Logo

Indicates the logo image for the form. To specify the logo, click Logo in the form configuration ribbon and enter the URL of the logo.


7

Bundle

Indicates the name of the key associated with the property file which provides the localized label text for the current form and its form items. Bundle key field at the form level must have any name of the key associated with the property file and cannot be left blank.

common

8

Request Model ID

The ID that you provide while creating a request in Request Modeler's Create New Request screen is referred to as Request Model ID.

This property enables you to map forms designed in form designer to the request created in the Request modeler. This property will come handy when you do not want to use the auto generated forms of Request Modeler and want to skip the following steps in form creation:

  1. Create and attach a listener to the form.
  2. Create and register handlers to action buttons.
  3. Prepare the AJAX request to place the request to the server.
  4. Handle the request on the server by attaching a handler to the request.
  5. Perform business validations and handle errors.
  6. Prepare SQL maps to insert data and map them to the table columns.
  7. Invoke Database requests to use the SQL map, pass data and persist.
  8. Handle responses and display error messages, if required to the user.

    In this case, you have the following options:
  • You can design your own form in form designer and create a request in the Request Modeler using the tables created for the form.

OR

  • Create a request in the Request Modeler using the tables needed for the form and then create a form in the form designer.

Then, ensure to map the form created by you to the correct Request Model ID. The Request Modeler submission sequence will be applied to your form.

  • The Form Item IDs must match the column IDs in the referenced table.
  • The same Request Model ID can be mapped to many forms. However, this can be done only if the target tables for the forms are the same and the request created maps to the same tables.

For more information on wiring the self-designed forms with Request Modeler, refer the Submission Support Provided for Forms Designed in Form Designer.

EMP_FORM_REQ

9

Top ()

Align the menus in top orientation.

Selected

10

Left ()

Align the menus in left orientation.

Selected

11

Right ()

Align the menus in the right orientation.

Selected

12

Step Click ()

Enables the user to navigate to the next forms by clicking the menus.
Note: This navigation will work only when the mandatory fields are filled in with details.

Selected

13

Forward Navigation ()

Enables the forward navigation to the next forms by clicking the menus.
Note: This property can be selected only if Step Click is enabled.

Selected

14

Backward Navigation ()

Enables the backward navigation to the previous forms by clicking the menus.
Note: This property can be selected only if Step Click is enabled.

Selected

15

Enable submit button ()

Enables the user to set the submit button to any form. By default the submit button will be at the last menu.

3

      6.  Click Save to save the Form Wizard.