Custom Field – Element Type Simple
Attachment
View
Attachment is used to store different files.
The field will be displayed as follows:
Field Configuration
Column Type: Don’t create DB column.
The extra tab changes with the following fields:
Field | Description | Note |
Type | File type of the attachment, default equals all types |
|
Minimum number of attachment |
|
|
Maximum number of attachment |
| where -1 is unlimited |
Display mode | Sets the display of the elements inside the form, grid or list. |
|
Category
View
Category is used to define the category of the current entity. This field contains various select fields. Each select field is connected to Category model.
If you select one in the first, then you will be prompted another select with children of that selected category as values and so on until the selected category doesn’t have any children. You can add and edit categories in System > Categories. The render on the form will be as follows:
Field Configuration
Column Type: Don’t create DB column.
Checkbox
View
Checkbox is an element type that is rendered in 2 ways inside the form.
Checkbox Render
Toggle Render
Field Configuration
Column Type: Integer or Text
When we select this element type, we have new fields in “extra” tab:
Field | Description | Note |
Render as Toggle | if the element will be rendered as toggle instead of checkbox inside form |
|
Toggle Size |
|
|
Toggle Width |
|
|
Toggle Height |
|
|
Toggle On Color | color of the toggle when it is switched on |
|
Toggle Off Color | color of the toggle when is switched off |
|
Toggle On Outline Color | color of the outline when toggle is on |
|
Toggle Off Outline Color | color of outline when toggle is off |
|
Toggle On Label | label of the toggle when it is switched on |
|
Toggle Off Label | label of toggle when it is switched off |
|
Color
View
This field is used to select a specific color and save the value as HEXA, RGBA or HSVA .
The render inside form is as below:
Field Configuration
Column Type: Text
Date and DateTime
View
Date and Datetime formats renders a calendar where you can select the date you wish and in the case of date time below the calendar you have the time inputs.
The rendering for date is:
The render for datetime is:
Field Configuration
Column Type: Date
Editor
View
Editor is a field that is used to store large texts and is associated with a text area column type.
Field Configuration
Column Type: Text Area
When we select this element type, we will see these new fields inside the extra tab:
Field | Description | Note |
WYSUWYG (Advanced Editor) | is used to turn the text area field to a mini word document where you can change the design of the text |
|
Mentions | is used by the end users to mention someone |
|
Quick Replies | is used to write a generic answer. To use quick replies you need to enable advanced editor. To create new quick replies you need to go to System > Quickreply module configuration |
|
Browser Spell Check | check for spelling errors |
|
Field Configuration
Then select the ‘Text’ option as the ‘Column Type’.
Label
View
Label is the easiest field type. This field is used to display a label or a text. The text that will be displayed is the label of the field.
Field Configuration
Column Type: No DB column
List
View
List is used to create a select field connected to a selected list.
Field Configuration
Column Type: Text (text or alphanumeric key) or Integer (numeric key)
When we select this element type, we can see a new field inside field tab called List Code which connects to the selected list.
All values of the selected list are shown in the select field rendered in the form.
If we go to ‘Extra’ tab we can see 3 new fields:
Field | Description | Note |
Placeholder | placeholder shown when we don’t select anything |
|
Group Filter | is set to yes this will apply the group filter that each value has set inside list |
|
Model Filter | is set to yes this will apply the model filter that each value has set inside list |
|
Number
View
Number is an element that is displayed as a number input field where you can type only numbers and without a leading 0. The render is as follows:
Field Configuration
Column Type: Integer
If we go to ‘Extra’ tab we can see only 1 field:
Field | Description | Note |
Decimal Precision | indicates the decimals of the number |
|
Password
View
Password is a simple input field of type password
Field Configuration
Column Type: Text (password can be alphanumeric).
Percentage
View
Percentage is an element that is rendered as a number input field that holds decimals with an extra element below it [%] indicating that this field is a percentage.
Field Configuration
Column Type: Decimal
Price
View
Percentage is an element that is rendered as a number input field that holds decimals with an extra element below it [USD] indicates that this field is a price.
Field Configuration
Column Type: Decimal
You can select the currency on System > Configuration > Currency Setup.
Radio
View
Radio is an input element of type checkbox with a different style.
Field Configuration
Column Type: Integer
Radios
View
Radios is the complex version of radio element type.
For example, with these configurations we will have all the operations statuses listed as radios and where we can select only one.
With these configurations we will have all the operations statuses listed as radios and where we can select only one.
Field Configuration
Column Type: Text or Integer
If we go to ‘Extra’ tab we can see 3 fields:
Field | Description | Note |
List Code | indicates the list that will be display |
|
Columns | indicates on how many columns these values are going to be distributed |
|
Responsive | sets if the element will be responsive to different screen widths |
|
Rating
View
Rating is an element displayed as stars and the value of this field is the number of stars selected.
Field Configuration
Column Type: integer
In the ‘Extra’ tab we see a field:
Field | Description | Note |
Max Value | max value that indicates the maximum stars that will be displayed |
|
Signature
View
This field has 2 main components displayed inside the form:
- “➕” that is used to create a new one. When clicked it will open a modal where you can draw the new signature.
- “🚫” is used to empty image holder.
Once the signature is inserted, a small new image will appear. This image contains the signature.
Field Configuration
Column Type: text area.
Teamviewer
View
This type is used to connect to Teamviewer application. It is rendered as a button and when clicked the teamviewer configuration window will pop up. If already configured, then the Teamviewer app will launch. Beside this button we have the refresh icon that is used to refresh the connection.
Field Configuration
Column Type: Don’t create DB ColumnText and Textarea
View
These types of elements are used to store text.
Field Configuration
Column Type: Text or Text Area (depends on the length of the text)
