Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note: After choosing Connection, this field auto-populates, mirroring the connection label, which can be edited later.

Details Config

Description

Type

Specify the type of model, such as:

  • API: For integrating with external applications via REST APIs.

  • Record: For managing Salesforce object data.

Connection

Allows you to choose the desired REST connection to fetch records from.

Label

Assign a unique name to the model.

Info

Name

Provide unique API name for the model.

info

Note: After choosing Connection, this field auto-populates, mirroring the connection name, which can be edited later.

Execute on Load

Enables records to be fetched automatically upon loading the component

...

Field Config

Description

Name

The identifier for the field within the schema. This is the name that will be used to reference the field in the data structure.

Type

It specifies the data type of the field.

info

Note: By default, field type is text.

Info

Reference: Field Type

Required

It indicates whether the field is mandatory.

Minimum Length

It defines the minimum number of characters or elements that the field must contain.

Maximum Length

It defines the maximum number of characters or elements that the field must contain.

Pattern

It is a regular expression that the field’s value must match. This is typically used for validating formats like email addresses, phone numbers, etc.

Help Text

It provides additional information or guidance on what the field represents and how it should be used. This is often displayed in the UI to assist users.

Default Value

It is a predefined value that the field will take if no other value is provided. This helps in setting initial values.

...

Field Type

Description

Array

  • It represents a collection of items, where each item can be of the same type or a specified set of types.

  • Arrays are useful for storing lists or multiple values under a single field.

Example:
Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#DEEBFF
#F4F5F7

For example, A list of user roles in a system: ["admin", "editor", "viewer"]

Checkbox

  • It represents a boolean value, typically used in forms to indicate a true/false or yes/no option.

  • This field type is ideal for settings or preferences that can be toggled on or off.

Example: A "
Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#DEEBFF
#F4F5F7

For example, A Subscribe to newsletter" option

Date

  • It stores a date value without time information.

  • This type is used when only the date is relevant, such as a birthdate or a specific event date.

Example:
Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#DEEBFF
#F4F5F7

For example, "2024-08-26"

Date and Time

  • It stores both date and time information.

  • This is used when the exact moment of an event is important, such as timestamps for record creation or updates.

Example:
Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#DEEBFF
#F4F5F7

For example, "2024-08-26T14:30:00Z"

Double

  • It represents a floating-point number, suitable for storing decimal values or precise measurements.

  • This type is ideal for fields that require numeric data with fractions.

Example:
Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#DEEBFF
#F4F5F7

For example, 1234.56

Integer

  • It represents a whole number without any decimal points.

  • This type is used for counting or indexing, such as user IDs, quantity fields, or age.

Example:
Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#DEEBFF
#F4F5F7

For example, 42

Object

  • It represents a structured data type that can contain multiple named properties, each with its own type.

  • Objects are used for more complex data structures, such as nested entities.

Example:
Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#DEEBFF
#F4F5F7

For example,

image-20240826-061126.png

Text

  • It stores plain text, which can be a short string or a longer block of text.

  • This field type is used for any data that needs to be expressed in words, such as names, descriptions, or comments.

Example:
Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#DEEBFF
#F4F5F7

For example, "This is a sample text field."