Field Creation
- Content Writers
This section provides a detailed explanation of the attributes required to create custom fields tailored to specific business needs.
Address
Used to store physical or mailing addresses in a structured format. This field type ensures consistency by allowing users to input addresses in a predefined way. When creating an address field, it is needed to define this Attributes.
For example, consider a sales order record that includes various attributes such as order ID, customer details, and an address type field to specify the shipping address for the order.
Sales Order Record:
Order ID: 12345
Shipping Address (Address type field):
Address Line 1: 123 Main St.
City: New York
State: NY
Zip Code: 10001
Array
Allows the storage of multiple values within a single field. Commonly used for lists where multiple items are associated with a single record.
For example, consider a sales order record that includes various attributes such as order ID, customer details, and an array field for products. Each product can be further detailed, making it a perfect candidate for an array data type field.
Sales Order Record:
Order ID: 12345
Customer Name: John Doe
Products (Array type field):
Product 1:
Name: Laptop
Price: $999.99
Product 2:
Name: Smartphone
Price: $699.99
When creating an array field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Minimum Length | Defines the minimum number of entries or the items that must be added in an array. |
Maximum Length | Defines the maximum number of entries or the items that can be added in an array. |
All types of fields can be added into an array field. Using the '+' button shown below, all required fields inside an array field can be added.
Object
The object field type allows storing nested data within a single record, preserving the structure of key-value pairs. This is useful for modeling complex data relationships.
For example, consider a product record that includes various attributes such as name, price, and specifications. The specifications themselves can be further detailed, making it a perfect candidate for an object data type field.
Product Record:
Name: Laptop
Price: $999.99
Specifications(Object type field):
Processor: Intel Core i7
RAM: 16GB
Storage: 512GB SSD
When creating an object field, it is needed to define this Attributes. All types of fields can be added into an array field. Using the '+' button shown below, all required fields inside an array field can be added.
Lookup
Creates relationships between different datasets by linking fields from one object to another. This type is essential for relational databases.
For example, In a sales process, a lookup field can be used to associate a sales order with a specific customer from the customer object. This ensures that each sales order is linked to the correct customer record, enabling efficient tracking and reporting.
Order Object
Order ID: 12345
Customer (Lookup Field): John Doe
Customer Object
Customer Name: John Doe
Customer ID: CUST001
When creating an lookup field, it is needed to define this Attributes.
Below are some key attributes that need to be understood in order to create a lookup field.
Attribute Name | Description |
|---|---|
Relates to | This shows list of all available objects, from which they can select and establish a relationship or link with the currently selected object. |
Label Key | This option enables users to display each record of a selected object (from the Relates to option) with the value of a specific field as its label. |
Is Tightly Coupled | Indicates whether the relationship between two objects is tightly bound, meaning changes in one object directly affect the other. Tightly coupled relationships often enforce stricter constraints and dependencies. |
Child Relationship Name | Specifies the name of the child relationship when linking two objects in a parent-child hierarchy. This helps identify and manage child records associated with a parent record. |
Filters | This option allows users to display only specific records in a lookup field that match the conditions applied. |
ReadOnly | Marks the field as non-editable, meaning users cannot modify its value directly. |
Sortable | Indicates whether the field can be used for sorting records in ascending or descending order |
Filters
This option, used to filter out and show only those records of selected related object based on condition applied.
Reference:
Checkbox
A binary field that allows users to select between two states (checked/unchecked). Often used for boolean values like true/false.
When creating a checkbox field, it is needed to define this Attributes.
Currency
Used to store monetary values along with their respective currency codes. Ensures precision for financial data.
When creating a currency field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Currency Selectable | Displays a dropdown list of available currencies for selection. |
Currency Type | Specifies the currency associated with the field |
Minimum | This option allows to define the minimum allowable length of value in the currency field. |
Maximum | This option allows to define the maximum allowable length of value in the currency field. |
Decimal Places | Specifies the number of decimal places allowed in the currency field. |
Date
Stores calendar dates without time information. Useful for tracking events that occur on specific days.
When creating a date field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Minimum Date | This option allows to define the minimum allowable date for the field. Users will not be able to select a date earlier than the specified date in this attribute. |
Maximum Date | This option allows to define the maximum allowable date for the field. Users will not be able to select a date later than the specified date in this attribute. |
Date Format | Determines how the date is displayed in the field. |
Date/Time
Combines date and time into a single field for events requiring precise timestamps.
When creating an date/time field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Minimum Date | This option allows to define the minimum allowable date for the field. Users will not be able to select a date earlier than the specified date in this attribute. |
Maximum Date | This option allows to define the maximum allowable date for the field. Users will not be able to select a date later than the specified date in this attribute. |
Date Time Format | Determines how the date and time are displayed in the field. |
Hour Clock | Configures whether the time is displayed in a 12-hour or 24-hour clock format. |
Duration
Represents time intervals such as in hours and minutes. Useful for tracking elapsed time.
For example,
Task Record
Task ID: TSK001
Task Name: Develop Landing Page
Time Spent (Duration type field): 04:30 (4 hours, 30 minutes)
Project Record
Project ID: PRJ001
Project Name: Website Redesign
Estimated Duration (Duration type field): 72:15 (72 hours, 15 minutes)
When creating an duration field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Minimum Time Duration | This option allows to define the minimum allowable duration for the time field. |
Maximum Time Duration | This option allows to define the maximum allowable duration for the time field. |
Time Format | Determines how time values are displayed in the field. |
Time
Stores specific times of the day without date information.
When creating an time field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Minimum Time | This option allows to define the earliest time that can be selected or entered in the field. |
Maximum Time | This option allows to define the latest time that can be selected or entered in the field. |
Hour Clock | Configures whether the time is displayed in a 12-hour or 24-hour clock format. |
Image
Allows users to upload and store a single image file in formats like JPEG or PNG.
When creating an image field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Show Tooltip | Displays a tooltip when the user hovers over the field. |
Show Alt Text | Displays alternative text for an image or attachment. |
Show Description | Displays a description or caption for the attachment or image. |
Allowed Sources | Specifies the sources from which attachments or images can be uploaded or selected.
|
Allowed Formats | Defines the file formats that are permitted for attachments. |
Aspect Ratio Width | Specifies the width aspect ratio for images. |
Aspect Ratio Heights | Specifies the height aspect ratio for images. |
Max Attachment Content Length (KB) | Defines the maximum allowable size (in kilobytes) for an attachment. |
Max Record Content Length (KB) | Specifies the maximum size (in kilobytes) of content allowed per record. |
Min Width | Sets the minimum width (in pixels) for an image or attachment. |
Max Width | Sets the maximum width (in pixels) for an image or attachment. |
Min Height | Sets the minimum height (in pixels) for an image or attachment. |
Max Height | Sets the maximum height (in pixels) for an image or attachment. |
Display Width | Defines the width at which an image or attachment is displayed on the screen. |
Display Height | Defines the height at which an image or attachment is displayed on the screen. |
Attachment Path | Specifies the file path where attachments are stored and allows dynamic paths to be created based on different value sources using merge text. |
Reference: Merge Text
Images
Enables the storage of multiple image files in a single field.
When creating an images field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Allowed Show As | Specifies the display options available for the image in field. |
Default Show As | Defines the default display option for the attribute when no specific selection is made by the user. |
Max Count | Specifies the maximum number of items or images that can be displayed or processed for this attribute. |
Stores valid email addresses in a standardized format.
When creating an Email field, it is needed to define this Attributes.
Integer
Stores whole numbers without decimals. Commonly used for counts or IDs.
When creating an Integer field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Maximum Length | Specifies the maximum allowable length for a string input. |
Minimum Length | Specifies the minimum required length for a string input. |
Double (Floating Point)
Stores numbers with decimal points for precision in calculations.
For example, consider a financial record that includes various attributes such as transaction ID, transaction date, and a double data type field to specify the transaction amount.
Financial Record:
Transaction ID: TXN001
Transaction Date: March 20, 2025
Transaction Amount (Double data type field): 1500.75
When creating an Double field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Maximum | Specifies the highest allowable value for a numerical input. |
Minimum | Specifies the lowest allowable value for a numerical input. |
Decimal Places | Defines the number of decimal places allowed or displayed for a numerical input. |
Multi-select
Allows users to select multiple options from a predefined list.
For example, In a project management system, a multi select field can be used to track the technologies utilized in a specific project.
Project ID: PRJ001
Project Name: Website Development
Technologies Used (Multi Select field):
HTML
CSS
JavaScript
When creating an Multi-select field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Value Source | This option allows to specify the origin of the values for the field. |
Is Dependent | This option indicates whether the attribute's value depends on another field or attribute. |
Value Fields | This option allows users to add values that need to be selected during record creation. |
Mappings
When the "Is Dependent" checkbox is selected during field creation, it activates the dependency feature, allowing users to define specific criteria for a set of values. This functionality ensures that the dependent field dynamically updates its available options based on the criteria applied.
For example, Let’s consider a scenario in a project management application where a user wants to create a dependent field for selecting a Task Type based on the Project Status.
Main Field: Project Status
Field Name: Project Status
Values:
Active
On Hold
Completed
Dependent Field: Task Type
Field Name: Task Type
Values:
Development
Testing
Documentation
Mappings Setup
To establish the mapping between these fields, the following criteria can be defined:
Attribute Name: Project Status
Description: The current status of the project, which determines available task types.
Criteria:
Add Criteria:
Field Name: Project Status (select from available fields)
Operator: Equals
Source Type: Static Values
Value: Active
Values to Display Based on Criteria:
When the Project Status is set to Active, the following Task Types should be displayed:
Development
Testing
Additional Criteria for Other Statuses:
If the Project Status is set to On Hold, display:
Documentation
If the Project Status is set to Completed, display no Task Types.
To establish dependent values, it is essential to map the values that should be displayed based on the specified criteria.
Attribute Name | Description |
|---|---|
Criteria | This option allows users to add conditions that dictate how fields behave based on specific criteria. |
Values | This option allows the selection of field values that should be displayed based on conditions applied to specific criteria. |
Criteria
Attribute Name | Description |
|---|---|
Field Name | his option displays a list of all fields associated with the object. Users can select from these fields to define the criteria for conditional logic. |
Operator | This option allows users to select an operator based on the type of field. The operator is essential for comparing or checking the field value against another source value. |
Source Type | This option displays various types of sources from which values can be retrieved for comparison against the selected field's value. |
Value Source
There are 3 different value sources are available from where you get the values from to select in this field those are as follows
Use Value Set: Get the values from already defined value set
Valueset Name: Add the name of the value set whose value you want to add it in the field
Query: To retrieve specific record values from a specific object, the following options can be filled out:
Attribute Name | Description |
|---|---|
Object Name | This option allows you to select the object from a list whose values you want to insert into the field. For example, you can choose an object like "Customer" or "Product" to retrieve and use its data. |
Filters | This option allows you to fetch a specific record set based on the conditions applied. |
Value Key | This option allows you to select the field of the chosen object whose value you want to retrieve. For instance, selecting "Customer ID" from the "Customer" object will fetch the corresponding ID value. |
Label Key | This option allows you to select the field of the chosen object whose value will be displayed as the selected field value. For example, selecting "Customer Name" will display names instead of IDs in dropdowns or lists. |
Reference:
Percentage
Stores percentage values with optional decimal precision.
When creating an percentage field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Maximum | Specifies the highest allowable length of value for field. |
Minimum | Specifies the lowest allowable length of value for field. |
Decimal Places | Defines the number of decimal places allowed or displayed for field. |
Phone
Stores phone numbers in international formats with country codes and extensions.
When creating an phone field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Default Country Code | Specifies the default country code used for the phone field. |
Allowed Extension | This option allows users to display and add the required extension number for their phone number when selected. |
Select (Dropdown)
Allows users to choose one option from a predefined list of choices.
For example, In a employee management system, a select field can be used to select specific department for an employee.
Employee ID: EMP001
Employee Name: Jane Smith
Department (Select field): Human Resources
When creating an Select field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Value Source | This option allows to specify the origin of the values for the field. |
Is Dependent | Indicates whether the attribute's value depends on another field. |
Value Fields | This option allows users to add values that need to be selected during record creation. |
Reference:
Text
Allows users to enter any combination of letters, numbers, and symbols. This field is commonly used for storing short strings such as names, IDs, or codes.
When creating an text field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Maximum Length | Specifies the highest allowable length of value for field. |
Minimum Length | Specifies the lowest allowable length of value for field. |
Pattern | This option allows to specify a Regular Expression (Regex) to enforce a specific pattern of text that a field should accept. |
Tags
Allows users to enter or select multiple tags. This field type is ideal for categorization or labeling items with keywords.
When creating an tags field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Value Source | Specifies the origin of the values for the field. |
Value Fields | This option allows users to add values that need to be selected during record creation. |
Create New | This option allows users to create new tags during record creation when selected. |
Reference:
Radio Button
Allows users to select a single value from a predefined list of options. Only one option can be selected at a time.
When creating an Radio Button field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Values | Allows the addition of custom values to be displayed as radio buttons. |
Text Area
Enables users to input longer text content across multiple lines. This field is suitable for capturing detailed information.
When creating a Text Area field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Minimum Length | Specifies the highest allowable length of value for field. |
Maximum Length | Specifies the lowest allowable length of value for field. |
Columns | This option allows defining a maximum number of columns in which text can be added during record creation. |
Rows | This option allows defining a maximum number of rows in which text can be added during record creation. |
Direction | This option allows you to specify the direction in which your text will be displayed. |
Pattern | This option allows to specify a Regular Expression (Regex) to enforce a specific pattern of text that a field should accept. |
Rich Text Area
Allows users to input formatted text with styles like bold, italic, underlining, and more.
When creating an Rich Text Area field, it is needed to define this Attributes.
URL
Enables users to enter valid website addresses. This field ensures that only properly formatted URLs are accepted.
When creating an URL field, it is needed to define this Attributes.
Merge Text
Allows users to create a single text value by merging data from two or more fields dynamically.
When creating an Merge Text field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Merge Text | Allows values from different fields to be joined together into one text field. |
Reference: Filter
Formula
Enables users to calculate values based on other fields using predefined formulas. The result is dynamically updated whenever the referenced fields change.
When creating an formula field, it is needed to define this Attributes.
Attribute Name | Description |
|---|---|
Return Type | Specifies the type of data or value that the formula will produce as output. |
Editor | The formula editor utilizes MongoDB's query language to write and execute formulas. |
Reference: MongoDB Introduction