Form Element is a type of plugin that is extensible via Joget's plugin architecture. Form Element is responsible for providing the end users form input elements to interact with.

There are many different form fields (i.e., TextField, SelectBox, Hidden Field, etc.) to choose from when you are designing your forms.  

You can drag and drop them on your form canvas and then edit their properties. 


Each form element has its own set of attributes, ID and Label attributes are common to most of them.

Figure 1: Text Field Properties

NameDescription

Label

"Label" is the human-readable identifier for the form field.

ID

The 'ID' in the property editor is a unique identifier.
The Joget Workflow core uses this ID as a column name within the table associated with the form (e.g. c_title in the figure above).
When a user enters a value in the field during a workflow process, the value is stored in that column.
If the ID has never been used in previous forms associated to the same table, a new column will be created.
If the ID, on the other hand, has been used before, that column will be used. 
It is important to note that when someone enters a value when completing a form during a workflow process, that value will overwrite the existing one.

Do not use the following reserved IDs on the form element's ID attribute:

  • id     (can be used but with caution)
  • appId
  • appVersion
  • version
  • userviewId
  • menuId
  • key
  • embed
  • primaryKey

Take note of the following IDs as these are automatically generated upon the creation of a new form. Please take note upon submission of the form in runtime, these fields will be updated automatically:

  • dateCreated
  • dateModified
  • createdBy
  • createdByName
  • modifiedBy
  • modifiedByName

We recommend using snake_case (i.e. first_name) as this is the standard database naming convention. The ID declared will be part of the database table column name.



This is a new feature in Joget DX 8.

The Form Builder now suggests an ID to an element based on the Label you have entered for that element. (Figure 2)


List of Form Elements