Joget DX Available for Download

Check out Joget DX, the next generation successor to Joget Workflow for faster, simpler digital transformation.

Skip to end of metadata
Go to start of metadata

Introduction

The Multi Select Box allows you to select multiple items with auto-complete behavior. Multi Select Box is a useful replacement for the ordinary Select Box, particularly when there is a very long list of options to choose from. Options are displayed based on the user's input.

The Advanced Grid is only available on Professional and Enterprise Edition.

Get Started

The easiest way to see how the Multi Select Box works is to create a new app. Here are the steps:

StepsScreens (Click to view)
  1. Start the Joget Server and open the App Center.

  2. Log in as admin and click on the Design New App button. (see Figure 1)

  3. Fill up the App Details as follows and click Save (see Figure 2):
      1. App ID: tutorial
      2. App Name: Tutorial


  4. You will be directed to the Design App. Click on the Create New Form button and fill up the Form Details as follows (see Figure 3):
    1. Form ID: mulltiSb
    2. Form Name: Multi Select Box
    3. Table Name: tutorial


  5. Click on Save and you will be directed to the  Form Builder.

  6. Drag and drop a Multi Select Box element on to the canvas.

  7. Hover the mouse over the Multi Select Box element on the canvas and click on Edit to open up the Edit Multi Select Box properties.

  8. Fill up the Options Hardcoded field as follows and click on OK (see Figure 4):

    Default ValueLabel
    LocalLocal
    InternationalInternational



  9. Click on Preview, try typing one of the labels and/or selecting both options to see it working.

Figure 1


Figure 2


Figure 3


Figure 4




Multi Select Box Properties

Edit Multi Select Box

NameDescriptionScreen (Click to view)
IDElement ID (By declaring as "country", a corresponding database table column "c_country" will be created)

LabelElement Label to be displayed to the end-user.
Options (Hardcoded)

Select Box options

Options defined here will not be put into use if Options Binder is defined below.

Or Choose Options Binder

Options to be populated dynamically using Options Binder plugin.

Performance Warning

If you have thousands of select options or sourcing them from Options Binder, this may cause a significant increase in page load time. Consider using Popup Select Box instead.


Advanced Options

Data

NameDescriptionScreen (Click to view)
Default Value

Default Value when there's no existing value found/selected.

A hash variable is accepted here. For example, you may key the following

#currentUser.firstName# #currentUser.lastName#

to pre-populate the field with currently logged in user's name.

You may define multiple default options by separating them using semicolons.

Sample
option1;option2;option3



Multiple Selection

Toggle Multiple Selection.

Field ID to control available options based on Grouping

Dynamically change the available options based on the "grouping" attribute defined in the options by matching to the current value of the element ID defined.

Dependency

NameDescriptionScreen (Click to view)
Field ID to control available options based on Grouping

Dynamically change the available options based on the "grouping" attribute defined in the options by matching the current value of the element ID defined.

UI

NameDescriptionScreen (Click to view)
Width

Column width in characters.

Sample
200px



Readonly

Determines if the element is editable.

Display field as Label when readonly?

Displays the value of the element as plain text when an element is set to "Readonly".

Validation

NameDescriptionScreen (Click to view)
Validator

Attach a Validator plugin to validate the input value.

When will validation takes place?

Validation will take place whenever a form is submitted except when it is submitted as "Save as Draft".

Workflow

NameDescriptionScreen (Click to view)
Workflow Variable

If the form is part of a workflow process, upon saving of the form (by clicking on "Save as Draft" or "Complete" button). The value in this input field will be saved into the corresponding workflow variable named here.

Using a non-existent Workflow Variable name

You will get the following warning with the name printed out (e.g. status) in the server log if you attempt to map to a non-existent Workflow Variable.

context attribute status does not exist in process context - adding new attributes to the process context is not allowed


Related Video Tutorials

  • No labels