Introduction

Getting started

Walkthrough Guides

CafeX Apps

Workflows

Using CafeX Collaborate App

Reporting

Managing CafeX

Integrating CafeX

Security

App Studio

App Studio Components

App Studio Components

Managing Multi-page Form Component

Modified on Wed, 15 Jan at 4:20 AM

TABLE OF CONTENTS


The Multi-page Form Component enables you to create a form split across multiple pages.


Configuration Settings


The Multi-page Form Component includes a wide range of configuration options to tailor the functionality and behavior of your form. Below are the key settings:


SettingDescription
Configure pagesAdd, remove, and customize pages in your multi-page form. For details, check the Configuring Pages section. 
LayoutChoose the layout for the form: Vertical, Horizontal, or Table.
Label positionSet the label position: Inside Top, Inside Left, Top, or Left.
Publish live datasetToggle to publish the form data to a live dataset during user interactions.
Prevent progress if invalid fieldsPrevent further navigation if validation errors exist in the current form section.
Show previous buttonDisplay a button to navigate to the previous page of the form.
Show next buttonDisplay a button to navigate to the next page of the form.
Show submit buttonDisplay a button to submit the form.
Show clear buttonDisplay a button to reset all fields in the form.
Show summaryToggle to display a summary page with all completed fields for review before submission. If disabled, the final page shows the submit button.
Highlight required fieldsHighlight fields marked as required.
Disable previous buttonPrevent users from clicking the previous button.
Disable next buttonPrevent users from clicking the next button.
Disable submit buttonPrevent users from clicking the submit button.
Disable clear buttonPrevent users from clicking the clear button.
Previous button textCustomize the label of the previous button.
Next button textCustomize the label of the next button.
Submit button textCustomize the label of the submit button.
Clear button textCustomize the label of the clear button.
Summary titleCustomize the title displayed at the top of the summary page.
Data setSelect the data set to associate with the form.
Data pathSelect an array of objects from the data set output to display in the table.
Defaults data setSelect the data set to pre-fill the form fields.
Defaults attribute pathSpecify the attribute path for default field values.
Field errors data setSelect the data set for error messages associated with fields.
Field errors attribute pathSpecify the attribute path for field error handling.
Additional buttonsAdd and customize additional buttons using the New button option.
Tooltip textProvide information that appears when users hover over the form component.
Event handlersAdd an event handler. For details, check the Using Event Handlers article.
Form validationConfigure validation rules. For details, check the Form validation rules article.


Appearance Settings


The Multi-page Form Component supports the following appearance customization:

SettingDescription
Standard appearance settingsRefer to the Altering the appearance of an App Studio Component article for details.
Label appearanceCustomize the style of field labels.
Field appearanceAdjust the appearance of input fields.
Summary label appearanceDefine the styling for summary labels.
Summary field appearanceCustomize the appearance of summary fields.
Section header appearanceModify the headers for form sections.
Primary button appearanceStyle the main buttons.
Secondary button appearanceStyle secondary buttons.


Configuring Pages


The Configure Pages option allows to add, remove, and customize pages in your multi-page form. Click the Configure Pages option from the Configuration tab to access the configurator. Here, you can configure two main aspects of the form:

  • Sections
  • Fields

Sections Overview

Sections act as the building blocks of a multi-page form and allow users to group related fields. The configurator has the following key features for managing sections:

  • Section List Panel (Left Side): This panel displays an overview of all created sections. Users can click a section name to focus on or edit it. Also, this is where you can add new sections by clicking the "+" button.
  • Section Layout Panel (Middle Area): This panel displays the structure of the selected sections. Each section includes a placeholder for adding fields where you can drag and drop existing fields from the Fields section or click the + button above to add fields directly into the selected section.
  • Section Properties Panel (Right Area): This panel on the right-hand side of the configurator displays section properties when the section is selected. This is where you can customize the following section properties:

    SettingDescription
    IDA unique identifier for the section.
    Navigation HeadingThe label displayed in the form’s navigation.
    Section HeadingThe title displayed at the top of the section within the form.
    Show Heading in FormToggle to display or hide the section heading.
    VisibilityControl whether the section is visible to users.
    Read-onlyMake the section non-editable if required.
    Omit from SummaryExclude the section from summary views.
    Show Tooltip IconsEnable tooltips to provide additional guidance.



Fields Overview

Fields represent the input elements of a form where users can enter data. The configurator provides means for creating and organizing the fields. The configurator has the following key features for managing fields:

  • Fields Panel (Bottom Left): This panel displays a list of available fields.
    Here you can add new fields by clicking the "+" button and then selecting the required type. After the field has been created, you can drag and drop it onto the Section Layout Panel (Middle Area). Fields added to the layout are marked with a green check icon (), while those not yet added are indicated by an orange exclamation mark ().

    The Fields Panel also provides filtering options to help you quickly locate fields:
    1) filter by name (),
    2) filter by the status icons ( / ).
     
  • Fields Properties Panel (Right Area): This panel displays field properties. Typically, fields have such properties as Name, Field type, and Visibility. Additional properties depend on the specific field type. For instance, text fields have settings for a header tooltip, read-only mode, default value, and input field size. You also have the options to edit the field's appearance or delete the field.


Example: Creating a Page in the Configurator


In this example, we'll create a new page in the configurator.


Step 1: Add Sections

  1. Navigate to the Section List Panel (Left Side) and click the "+" button to add a new section.
  2. Rename the section by selecting it and editing its properties. Customize the remaining settings based on your specific requirements.
    IDuser_details
    Navigation HeadingUser Details
    Section HeadingPersonal Information


Step 2: Create Fields

  1. In the Fields Panel, click the "+" button to create a new field. For example, you can add a Short Text type field for the user's name.
  2. Rename the field and configure the remaining field properties in the Properties Panel.
    NameFull Name
    IDfull_name
  3. Repeat the steps to add more fields, such as Date of Birth, Email Address, Phone Number, and so on.


Step 3: Organize Fields into the Section

  1. Drag the Full Name field from the Fields panel to the User Details section in the layout panel. The field should become marked with a green check icon.
  2. Repeat the step to add additional fields.


Step 4: Preview the Page

Once the steps are completed, you can close the configurator and check the form layout.


Example: Multi-page User Registration Form


To demonstrate the Multi-page Form Component, we’ll create a simple user registration form with three pages: Personal Information, Account Details, and Summary.


Step 1: Add the Multi-page Form Component:

From the Components tab of the Explorer and Components panel, drag and drop the Multi-page Form component onto the canvas.


Step 2: Configure Pages

  1. Select the component on the canvas and navigate to the Configuration tab of the Appearance and Configuration panel.
  2. Open the Configure Pages dialog.
  3. Add three sections (pages) and their corresponding fields: Personal Information, Account Details, and Preferences. For details on using the Pages Configurator, see the Configuring Pages section above.


Step 3: Complete Configuration Settings

On the Configuration tab of the Appearance and Configuration panel, configure the settings. For example:

  • Set the layout to Vertical.
  • Enable Prevent rogress if invalid fields, Show previous button, Show next button, and Show submit button.
  • Customize the button text:
    • Previous: Back
    • Next: Continue
    • Submit: Create Account
  • Select a data set for the form.


Step 4: Customize the Appearance

Navigate to Appearance and Configuration > Appearance and customize the appearance of the form.


The screenshot below demonstrates the Personal Information and Account Details pages of the user registration form .


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article