Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

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.

image-20240816-134318.png

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

image-20240926-055245.png

Attribute Name

Description

Component Size

  • This allows users to modify the size of a specific component according to the grid size of layout.

For example,
If the layout grid size is 3 then layout is divided into 3 sections then you can changes the components size between 1 to 3.

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.

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.
Variable: If you choose the variable option, you can select the variable where you want to save the field's value. You can bind this variable's value to the component by creating the appropriate variable.

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.

Layout

Field Layout allows you to arrange fields on the form.
For more details check this

Hide Space? Checkbox

After marking this checkbox as true, it will crop the extra corners of the fields.

Config and UI Attributes:

image-20240820-081705.png

Attribute Group

Attribute Name

Description

Config

Debounce (sec)

"Debounce time in seconds" refers to the delay period set to prevent a Event from being called.

For example, if the debounce time is set to 2 seconds, the Event will only execute if there is a 2-second pause.

Copy Enabled? checkbox

After marking the checkbox as true, a copy icon will appear beside the name 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.

Value Destination Model

  • From the value destination model, you can select the specific model where you want to save the field's value.

  • By using a model, you can bind a value to the component, with the value coming from the object used during model creation.

UI

Component Size

  • This allows users to modify the size of a section within the layout according to the grid size.

  • This feature allows for flexible customization, enabling users to resize components to fit their specific needs within the defined grid structure.

Note: Currently, we support Component Size 1 for Section. All other sizes will throw an error alert displaying Max allowed value is 1 .

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,

Style

  • It is used to apply custom styles to section, such as color, font, size, and more.

  • It allows you to define the appearance of a component by specifying CSS properties directly within the attribute.

Classes

  • It is used to apply SLDS classes to section, if needed.

Validation:

image-20240823-084650.png

Attribute Name

Description

Required Type

Here, users can apply validation based on filter conditions.

  1. Never: This field is never required.

  2. Always: This field is always required..

  3. Conditional: The required field is determined based on specific criteria of And, OR condition

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.

Conditional Visibility:

image-20240823-084905.png

Attribute Name

Description

Visibility Type

It determines whether a component is visible on the layout. It offers the following visibility types:

  1. Always: The component will always be visible.

  2. Conditional: The component's visibility is determined based on specific criteria, which can make it either visible or hidden as needed.
    You can explore more about Visibility Type here.

Read Only:

image-20240823-085059.png

Attribute Name

Description

Read Only Type

It specifies whether a component can be edited by users. It offers the following options:

  1. Never: The component will always be editable at any time.

  2. Always: The component will never be editable.

  3. Conditional: The component's editability is determined based on specific criteria, which can make it either editable or read only as needed.
    You can explore more about Read Only Type here.

Reference: Read Only

Conditional Disability:

image-20240823-085133.png

Attribute Name

Description

Disability Type

It determines whether a component is disable on the layout. It offers the following visibility types:

  1. Never: There is no disable option for this component

  2. Always: The component will always be visible.

  3. Conditional: The component's visibility is determined based on specific criteria, which can make it either visible or hidden as needed.
    You can explore more about Disability Type here

Component:

image-20240823-085206.png

Attribute Name

Description

Component Label

It simply shows the name over the field.

Label Source Type:

image-20240813-133213.png

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

Object

Object is data structure that represents a collection of related properties and methods, used to model entities.

Reference: Object

Criteria

Criteria are conditions or rules used to filter or evaluate data based on specific requirements or attributes.

Reference: Criteria

Email

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

Jsons

A JSON field is used for entering and storing data in JavaScript Object Notation (JSON) format, which is a lightweight data-interchange format.

Reference: Json

Slider

A Slider is an interactive UI element that allows users to adjust a value within a specified range by moving a handle along a track.

Reference: Slider

Action

An Action refers to a specific operation or task that can be triggered or performed, such as a button click or a menu selection.

Reference: Action

Icon

An icon is a small graphic or symbol used to represent an application, function, or action in a user interface.

Reference: Icon

Model

A model is a representation or structure used to define and manage data, often encompassing the rules and relationships of data in a system or application.

Reference: Model

Fields

Fields are individual data elements or attributes within a data model or form, used to capture and store specific pieces of information.

Reference: Fields

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

Record

A Record is a collection of related data fields or attributes that represent a single item or entry in a database or data system.

Reference: Record

Formulae

A Formula field allows users to calculate and display values based on a formula that combines other fields, constants, or functions.

Reference: Formulae

Merge Text

Merge Text refers to combining or inserting dynamic values from multiple sources into a single text field or document, often used for generating personalized content.

Reference: Merge Text

Field Selector

A Field Selector is an interface element that allows users to choose and specify which fields to display or use within a form, report, or data view.

Reference: Field Selector

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

Number

A Number field is an input field designed to enter and validate numerical values, which may include options for specifying the range or format.

Reference: Number

Boolean

A Boolean field is an input field that stores a value representing one of two states, typically "true" or "false."

Reference: Boolean

HTML

An HTML field is used for entering and displaying content in Hyper Text Markup Language, allowing for structured and formatted text with various elements.

Reference: HTML

CSS

A CSS field is used for entering and applying Cascading Style Sheets, allowing users to define the appearance and layout of HTML elements with styles.

Reference: CSS

Java Script

A JavaScript field is used for entering and executing JavaScript code, allowing for dynamic behavior and interactions on web pages.

Reference: Java Script

Duration

A Duration field is an input field that allows users to specify a length of time.

Reference: Duration

Encrypted

An Encrypted field is a data input field that stores information in an encrypted format.

Reference: Encrypted

Filter

A Filter is a tool or feature that allows users to narrow down or sort data based on specific criteria or conditions.

Reference: Filter

Any

The term "any" is used to indicate that a condition or action applies to all possible values or options within a given context.

Reference: Any

Model Selector

A Model Selector is a UI component that allows users to choose or specify a data model or schema to use within an application or system.

Reference: Model Selector

Categories Selector

Categories Selector typically refers to a feature or tool that allows users to choose from a list of predefined categories. This helps in organizing and filtering content or data based on the selected categories.

Device

A Device refers to a physical or virtual piece of hardware used to perform tasks, access information, or interact with software, such as a computer, smartphone, or tablet.

Reference: Device

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

Conditional Visibility Type:

image-20240814-092607.png

Attributes Name

Description

Destination Type

Users can select the destination type where the visibility criteria must be applied.

Reference: Destination Type

Operator

Here, users can select different operators to add filters.

Reference: Filter Operator.

Source Type

Here, you can select the source type from various sources.

Value

Here user can select the value from different Source Type.

Reference: Merge Text

Destination Type

Destination Type

Description

Model

From this source, users can select a Model field to be displayed as the destination type.

Variable

Here, users can select the destination type from variables such as Record ID, Is Disabled, Is Read only, or Is Visible.

User

Here, you can choose the label from user fields such as First Name, Last Name, Email, Name, Phone, or Session ID.

Record

It enables to choose record fields as destination type.

Device

It enables user to decide whether the action will be visible on the specific device type or not. Devices supported:

  1. Mobile

  2. Desktop

  3. Tablet

Conditional Disability Type:

image-20240814-093021.png

Attributes Name

Description

Destination Type

Users can select the destination type from various sources.

Reference: Destination Type

Operator

Here, users can select different operators to add filters.

Reference: Filter Operator.

Source Type

Here, you can select the source type from various sources.
Reference: Available Sources.

Value

Here user can select the value from different Source Type.

Reference: Merge Text

Conditional Read Only:

image-20240823-064414.png

Attribute Name

Description

Read Only Type

It specifies whether a component can be edited by users. It offers the following options:

  1. Never: The component will always be editable at any time.

  2. Always: The component will never be editable.

  3. Conditional: The component's editability is determined based on specific criteria, which can make it either editable or read only as needed.

Add Condition & Group Condition

image (21)-20240822-182312.png

Condition

Description

Add Condition

  • The Add Condition feature allows users to define multiple criteria that must be met for a validation rule to trigger.

  • This feature is used to create complex logic by combining different conditions that Salesforce evaluates before allowing a record to be saved.

Add Group Condition

  • The Add Group Condition feature allows users to group multiple conditions together, creating complex logic that involves different sets of criteria.

  • This feature is particularly useful when combining conditions that should be evaluated as a unit (logical OR within a group) or when nesting conditions for more advanced logic.

Filter Operator:

Note: Before using the filter criteria, it's important to understand which filter operators are supported for each field type

Filters Attributes:

image-20240822-134925.png

Filter Operators

Operator

Supported Field Types

Description

Equal

Number, Currency, Date, Text, Boolean, Picklist

The equal operator is used to compare two values or expressions. It is used to compare numbers, strings, Boolean values, variables, objects, etc. The result is TRUE if the expressions are equal otherwise it’s FALSE

Contains

Text, Picklist

The contains operator returns TRUE if the value on the left contains the value on the right, and otherwise FALSE

Starts With

Text, Picklist

It returns TRUE if a string or number starts with the specified character otherwise it returns FALSE.

Ends With

Text, Picklist

It returns TRUE if a string or number ends with the specified character otherwise it returns FALSE

In

Text, Picklist

IN operator allows you to easily test if the expression matches any value in the list of values. Determines whether the value of an expression is equal to any of several values in a specified list.

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.

image-20240824-095737.png

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:

image-20240822-091137.png

In the image below, you can select the created workflows.

image-20240822-084758.png

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

image-20240822-091307.png

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.

image-20240822-093156.png

  • No labels