Field
- Content Writers
Overview
Field component is used to represent individual data elements within a record, similar to columns in a relational database. It is designed to store and manage various types of data values required for different objects.
Fields can hold different types of data, such as numbers, phone numbers, email addresses, and text, depending on the data type configuration.
Fields can be bound to models and variables, enabling dynamic data handling and updates within your application.
The Field component is generic and can be configured to accept and display data in multiple formats and types.
If you need to present or capture data without linking it to a specific object, the Field component can be used independently.
Attributes:
Attributes are the options available for each component, allowing you to customize its appearance and functionality. They help you tailor the look and behavior of your components to fit your needs.
Basic
Attribute Name | Description |
|---|---|
Component Size |
For example, |
Display As | Display As allows you to select data type options to define how the field will be display. For example, if you have a text field and choose to display it as a picklist, the data will be stored as text but displayed as a picklist. |
Label | A Label is the name shown to users and can come from various sources. Reference: Label Source Type |
Place holder | This is a hint or example text displayed in an input field before the user enters their own data. |
Type | Here you can choose different field types. Reference: Field Type. |
Dest Type | This attribute specifies whether the user wants to store a value in a variable or a model. Model: Here, you can select "Model" as the value destination. Note: Value Destination Model field appears when you select "Model" as the Value Destination Type. |
Dest Var | Here you can choose the variable option from this list. Note: This appears when you select "Variable" as the Value Destination Type. |
Validations:
Attribute Name | Description |
|---|---|
Required Type | Here, users can apply validation based on filter conditions.
|
Required Error | Enter the error message you want to display for required fields. |
Min Length | Set the minimum number of characters required for the input field. |
Min Length Error | Enter the error message to display if the input does not meet the required minimum length. |
Max Length | Set the maximum number of characters allowed for the input field. |
Max Length Error | Enter the error message to display if the input exceeds the maximum allowed length. |
Pattern | A regex pattern or regular expression pattern, is a sequence of characters that defines a search pattern. It's used for pattern matching within strings, such as validating input, searching for specific text, or replacing text. |
Pattern Error | A "Pattern Error Message" typically refers to an error generated when input data does not match the expected format defined by a regular expression pattern. This message is usually displayed to inform users that their input is invalid or incorrectly formatted. |
UI State:
Base UI:
Attribute Name | Description |
|---|---|
Margin Location | "Margin Location" refers to the spacing around the outside edge of an element |
Margin Size | "Margin Size" refers to the amount of space around the outside edges of an element, |
Hide Space | After marking this checkbox as true, it will crop the extra corners of the fields. |
Visibility Type:
Attribute Name | Description |
|---|---|
Visibility Type | It determines whether a component is visible on the layout. It offers the following visibility types:
Reference: Conditional Visibility |
Read Only Type:
Attribute Name | Description |
|---|---|
Read Only Type | It specifies whether a component can be edited by users. It offers the following options:
Reference: Read Only |
Disability Type:
Attribute Name | Description |
|---|---|
Disability Type | It determines whether a component is disable on the layout. It offers the following visibility types:
Reference: Conditional Disability |
UI:
Attribute Name | Description |
|---|---|
Layout | Field Layout allows you to arrange fields on the form. For more details check this Reference: Field Layout |
Is Copy Enabled | After marking the checkbox as true, a copy icon will appear beside the field. |
Help Text | Provides additional guidance or information about a field or element to assist users in understanding how to complete it or what data is expected. |
Label Source Type:
Attribute | Description |
|---|---|
Model | From this source, users can select a Model field to be displayed as the label name. |
Variable | Here, users can select the label name from variables such as Record ID, Is Disabled, Is Read only, or Is Visible. |
Cookie Key | Choose the available cookie key whose value you want to include from your browser. |
Local Storage Key | Select the available Local Storage Key whose value you want to include from your browser. |
User | Here, you can choose the label from user fields such as First Name, Last Name, Email, Name, Phone, or Session ID. |
Merge Field Expression | Merge Field Expression displays the value selected from the chosen value source. |
Message Body | Inside the message body, user also can add the values manually. |
Field Types:
Field Types | Description |
|---|---|
Text | Text refers to any written or printed words or characters displayed within a field or interface. Reference: Text |
Text Area | A text Area is a multi-line input field that allows users to enter larger amounts of text. Reference: Text Area |
Rich Text Area | A Rich Text Area is an input field that allows users to enter and format text with styling options like bold, italics, lists, and more. Reference: Rich Text Area |
Checkbox | An interactive element that lets users select or deselect an option by checking a box. Reference: Checkbox |
Integer | An Integer field is a data input field that accepts whole numbers without decimal points. Reference: Integer |
Double | A Double field is a data input field that accepts numerical values with decimal points. Reference: Double |
Currency | A Currency field is a data input field that accepts numerical values formatted as monetary amounts. Reference: Currency |
Date | A Date field is an input field that allows users to select or enter a date, typically displayed in a calendar format. Reference: Date |
Datetime | A Datetime field is an input field that allows users to select or enter both a date and a time. Reference: Datetime |
Time | A Time field is an input field that allows users to select or enter a specific time of day. Reference: Time |
Picklist | A picklist is a dropdown menu that allows users to select a single value from a predefined list of options. Reference: Picklist |
Multi Picklist | A Multi Picklist is a dropdown menu that allows users to select multiple values from a predefined list of options. Reference: Multi Picklist |
Tag | A Tag is a label or keyword that is used to categorize or identify items. Reference: Tag |
Array | An array is a data structure that holds a collection of items. Reference: Array |
An Email field is an input field designed for entering and validating email addresses. Reference: Email | |
Password | A Password field is an input field that obscures entered text to ensure confidentiality and is used for entering passwords. Reference: Password |
Phone | A Phone field is an input field designed for entering and formatting mobile numbers. Reference: Phone |
URL | A URL field is an input field for entering and validating web addresses or links. Reference: URL |
Icon | An icon is a small graphic or symbol used to represent an application, function, or action in a user interface. Reference: Icon |
Radio | A Radio button is a selection input that allows users to choose one option from a set of predefined choices. Reference: Radio |
Image | An image field is used to display or upload visual content, such as pictures or graphics, within a user interface. Reference: Image |
Images | An Image field is used to display or upload multiple visual content, such as pictures or graphics, within a user interface. Reference: Images |
Lookup | A lookup field is an input field that allows users to search for and select a related record from another table or dataset. Reference: Lookup |
Color | A Color field is an input field that allows users to select or specify a color, often using a color picker or color code. Reference: color |
Visual Picker | A Visual Picker is a UI component that lets users select options or values from a graphical representation, such as images or icons, rather than text-based lists. Reference: Visual Picker |
Percentage | A Percentage field is an input field designed to enter and display values as a percentage. Reference: Percentage |
Address | An Address field is an input field used for entering and formatting address information, including details like street, city, state, and zip code. Reference: Address |
Duration | A Duration field is an input field that allows users to specify a length of time. Reference: Duration |
Progress Bar | A Progress Bar is a graphical element that visually displays the completion status of a task or process, often as a horizontal bar filled to indicate the percentage of completion. Reference: Progress Bar |
Rating | A Rating is a UI element that allows users to evaluate or provide feedback on a product, service, or content, typically represented by stars, numbers, or other symbols. Reference: Rating |
Events:
Events are essentially the automation of invoking the component's actions.
Here, we have onload event, click, double click actions are available for this components.
Icon Events | Description |
|---|---|
onload | This event action is triggered when the Field component is loaded. |
change | This event action is triggered when the field is changed.. |
blur |
|
Below here is the onload event workflow action.
Note: Similarly you can create event action for change event and blur.
on Load Event:
In the image below, you can select the created workflows.
Note: You need to create a workflow for selecting from this list.
For more information about Workflow check this out.
Reference: Workflow
onload Events:
We have an onload event that runs when the component is loaded
For example, when a form is loaded, you can choose fields to be prepopulated by mapping field values using input mapping at the time the form component is loaded.
Input Mapping
Input Mapping: "Whenever an event is triggered and you want to pass data to destinations such as models, variables, or components, you can use input mapping to achieve that.
