Form
A form is a:
"...user interface element which allows us to create or modify data in a logical and meaningful fashion"
Navigation
Go to Configuration -> Forms to create or edit existing forms
Form Supported Elements
Input: Text field with a fixed length of up to 255 characters. Can be string or numeric
Textarea: Text-area with length of up to 4000 characters
Datepicker: to select Date
Checkbox: flag for yes/no values
Select: Dropdown from static list of value
Select: Dropdown from a table
JSON: json object
Form Metadata
Form configuration metadata is retrieved by frontend via API - {/form/metadata/:<objectname>}
Form Attributes
Following table consist of form attributes
ID
Integer
Unique ID of form
Name
Varchar
Unique Name of form
Created Date
Datetime
Date on which form was created
ID User Created By
Integer
Unique ID of user who created the form
ID Organization
Integer
Unique ID of an organization
Last Date Updated
Datetime
Last date on which form was updated
ID User Last Updated By
Integer
Unique ID of a user who last updated the form
Short Description
Varchar
Short explanation regarding form
Long Description
Varchar
Detail explanation regarding form
Form Key Attributes
Following table consist of form key attributes
Required
Flag
Whether the field is required or not
Status
Flag
Whether to include this field in metadata or not
Order By
Integer
Determines the order in which the column will appear in the form
Column Key
Varchar
Unique name of table column. This is the key used in API.
Caption
Varchar
Display Title
Show in View
Flag
To display the field or not
Range
Varchar
Range of Values e.g. 1-10
Constrained By
Varchar
Parent key if the field is constrained
Input Type
Varchar
Type of data to be entered e.g. score, date time
Width
Integer
Width of the input field
Placeholder
Varchar
Hint for user to enter data
Dropdown Type
Varchar
Table or LOV
Display Field
Varchar
Field to be displayed when in edit mode
Form Element
Varchar
Front end element to be displayed e.g. date-picker of text-area
Table Name
Varchar
If Dropdown Type is Table then provide the name of the table
Info
Flag
Whether info flag to be shown
Data Type
Read only
Data type of the table column. For information purposes
LOV Type
Varchar
List of value type bound to this column. Only if this field has a dropdown
Action
Icons
Edit and delete icon only soft delete is allowed
Form Configuration
To configure a new form
Go to Configuration -> Form
Click Add New button
To update an existing form
Go to Configuration -> Form a table will open
Click form name to be modified or select Edit from action column
Last updated
Was this helpful?