Versions Compared

Old Version 1

changes.mady.by.user Hugo

Saved on

compared with

New Version 2

changes.mady.by.user Aadrian Zarin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

...

Text Field is a standard HTML Input element to collect information from the user in a form.

Panel
borderColorpurple
borderWidth1
titleBGColor#ddccff
borderStylesolid
titleNew Feature

This feature is enhanced in Joget Workflow v6 to support placeholder, number formatting and numeric value storage.

...

Get Started

The easiest way to see how the Text Field works is to use the existing built-in App Expenses Claims. Here are the steps:

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

  2. Log in as admin and click on the pencil icon on the Expenses Claim to open the Design App. (see Figure 1)

  3. Click on  Expense Claim New and you will be directed to the Form Builder. 

  4. Hover the mouse over the Title (Example: China Travel, July Claims etc.) field and click on Edit to open up the Edit Text Field properties. 


  5. Click on Preview.

Image Added

Figure 1


Image Added

Figure 2


Text Field Properties

Edit

Figure 1: Screenshot highlighting Text Field obtained from sample Expenses Claim App

Screenshots in this article obtained from http://localhost:8080/jw/web/console/app/hr_expense/1/form/builder/hr_expense_new

Image Removed

...

Text Field Properties

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

Image Added

LabelElement Label to be displayed to the end-user.

...

...

Advanced Options

Data

NameDescriptionScreen (Click to view)
Value

Default Value when there's no existing value found.

Hash

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

Code Block
#currentUser.firstName# #currentUser.lastName#

to pre-populate the field with

current

currently logged in user's name.

Image Added

Max Length

Maximum character length allowed.

Validator

Attach a Validator plugin to validate the input value.

Info
titleWhen will validation takes place?

Validation will

takes

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

Encryption

Determines if the value should be encrypted upon saving into the database. Read more in Protect Sensitive Data.

Placeholder

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.

Info
titleUsing 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.

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


UI

New Feature added in Joget Workflow v6
NameDescriptionScreen (Click to view)
PlaceholderNew Feature

The placeholder attribute specifies a short hint that describes the expected value of an input field (e.g. a sample value or a short description of the expected format). The short hint is displayed in the input field before the user enters a value.

Image Added




Size

Width of the element.

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".

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.

Info
titleUsing 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.

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

Image Added

Number Formatting

...

infoNew Feature added in Joget Workflow v6New Feature
Name
titleNew Feature
DescriptionScreen (Click to view)
Formatting Style
  • US Style Formatting (1,000.00)
  • European Formatting (1.000,00)

When you have selected this option, you can further define the following attributes:-

  • Number of Decimal
  • Prefix
  • Postfix
  • Use Thousand Separator?

Image Added

Store as Numeric Value?
Info
title

New Feature added in Joget Workflow v6

When formatting is applied, value is stored as it is. You may check this option to strip off formatting and store it as numerical value only.

 

 

...