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 20 Next »

Overview

The List View component displays records from different objects in a tabular format, organized into rows and columns. It offers features such as pagination, search, sorting, and data export, enabling users to perform various operations on the displayed data.

Although multiple List Views can be created for each object, each List View is linked to a single object.

image-20240816-095830.png

Attributes

Attributes are the options available for each component, allowing you to customize its appearance and control their behavior. It includes various sections explained below.

Basic:

image-20240925-133149.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.

Object

  • You are required to choose the object for displaying the List View.

  • Only standard and custom objects will be available for selection here.

Note: Metadata and System objects are excluded from the list

List View

  • You can choose a List View name from the available options.

  • Each object can have multiple List Views.

Note: You can select only one List View at a time.

Table Actions

  • You can create multiple table actions for the List View. By default, two actions are visible in the top right corner.

  • These actions are used to perform operations such as creating, refreshing, and managing selected or unselected records

Row Actions

  • Actions are performed at the record level for individual records.

  • These actions are primarily used to read, update, or delete a single record.

  • Each action is linked to a workflow that executes the specific operation. While default row actions include edit, delete, and view, you have the flexibility to create additional actions according to your needs.

Column Actions

  • You can set the actions at the column level on the List View.

  • You can assign only one action to any column.

  • When you click record in the column action gets executed. Each action has a workflow that actually performs an operation.

Note: When you assign a column action, the record in that column becomes a clickable link.

Reference: Column Actions

Layout For New

You can choose an existing layout from the list.

Same for Edit?

  • If the “Same for Edit” checkbox is enabled, the layout selected for “Layout For New” will also apply to Edit operations.

  • If disabled, you can choose a different layout for editing from the available options.

Layout For Edit Checkbox

You can select any layout from the drop-down for editing purposes.

Order By

  • You can specify the order in which fields are used to query and display records in the List View.

  • Records can be sorted in either ascending or descending order.

Reference: Order By

Config:

image-20240925-133746.png

Attribute Name

Description

Icon

  • This field allows you to choose an icon from different categories like utility, action, custom, doctype, and standard

  • A search bar option is available to search for icons by name

Note: The default icon size set as Small

Show Index

Enabling this checkbox will display the index of records in the List View.

Export supported

If you check that checkbox then the download icon will appear on the right side of the search box

Note: Upon clicking the download icon on the List View, all the records can be exported in a CSV file

UI State:

image-20240925-134057.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

Base UI:

image-20240925-133904.png

Attribute Name

Description

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.

UI:

image-20240925-134250.png

Attribute Name

Description

Listview Selectable?

Selecting this checkbox enables the list view selection dropdown option on the list view name.

Offset

You can set an offset for the query on the object.

For example, if there are 200 records and you set the offset to 100, the List View will display records starting from the 101st record.

Limit

Set the number of records to query at once.

For example, if there are 200 records for an object and you set the limit to 100, the List View will retrieve and display the first 100 records.

Filter Section Header

Users have the option to customize the header name that appears on the filter section on List View.

Table and Row Actions

image-20240813-121054.pngimage-20240821-063509.pngimage-20240821-063035.png

Attributes

Description

Label

A Label is the name shown to users and can come from various sources.

Reference: Source Type

Name

Enter a unique the name for your action.

Icon

This option lets you choose from various icons to add to the action button.

Variant

This feature allows users to change the appearance of the action button.

  1. Neutral

  2. Brand

  3. Outline Brand

  4. Success

  5. Destructive

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

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 Visibility Type here.

Is Bulk Action Checkbox

If the bulk action checkbox is marked as true, it enables users to perform bulk actions on the selected items.

Minimum Record Count

The Minimum Record Count setting allows users to specify the minimum number of records required to perform a bulk action. This ensures that bulk actions are only triggered when a certain threshold of selected records is met

Label Source Type:

image-20240813-133213.png

Attribute

Description

Model (Salesforce Object)

From this source, users can select a Model (Salesforce Object) 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.

Column actions

Column Action Attributes

Description

Label

A Label is the name shown to users and can come from various value sources.

Name

Enter the unique for Column Action.

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 attribute

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.

Column

Here, users can select the fields displayed in the List View table.

Label Value Source:

image-20240813-133213.png

Label Source Type Attribute

Description

Model (Salesforce Object)

From this source, users can select a Model (Salesforce Object) 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.

Order By

In Salesforce, there’s no guarantee of the order of results unless you use an Order By clause in a query. Thus, we need to specify Order By to have specific records under consideration.

image-20240925-135042.png

Specifies whether the results are ordered in ascending (ASC) or descending (DESC) order. Default order is ascending.

Order By Attribute

Description

Field Name

Allows to specify field name which determines the sorting order of the query results.

Sort As

Allows to specify whether the results are ordered in Ascending or Descending order.

Note: By default, Sort As is set as Ascending.

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, only onload event actions are available for this components.

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

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-20240927-061640.png

After clicking on Pencil icon, user can view the screen to set Input Mapping as follows:

image-20240822-091307.png

After clicking on + button, user can set up input mapping using Input Mapping Screen as follows:

image-20240927-062108.png

Condition

Description

Destination Type

It specifies the destination where the connector mapping is to be done.

Reference: Destination Type

Note: By default, the Destination Type is set as Model.

Model

It is specifically dependent on Destination Type one chooses. If you choose another Destination Type, you will get that field label here.

Note: Fields below this will only be enabled once user filled above two fields.

Field

After choosing the second condition field, you will get this field visible in modal. If you chose Model as second condition field, this will be field and if you chose variable as second field, there will be variable.

Operator

It is specifically operator value such as Set, Equals, Greater than, Equals than.

Source Type

In this option, you can select various sources from which you want to display values.

Reference: Source Type

Note: By default, the Source Type is set as Static.

Value

The available options will change depending on the selected source type. For example, if you choose "Static" as the source, you can provide a fixed static value.

image-20240822-093156.png

Destination Type

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.

Input Variable

Here, users can select the input variable which they have created earlier.

Cookie key

By using the Cookie Key, the result is fetched by the value that has been added under the Cookie Key. But, have to make sure that the value that we are adding is from the Cookie Key value.

Local Storage Key

By using the Local Storage Key, the result is fetched by the value that has been added under the Local Storage Key. But, have to make sure that the value that we are adding is from the Local storage value.

Source Type

Source Type

Description

Static

Use this option to provide a fixed static value.

Field

Select the field from the chosen object in the model whose value you want to include.

Model

Choose the field from other models whose value you want to include.

Variable

Select from the variables created in the layout whose value you want to use as Source.

Output Variable

Select from the output variables created in the layout whose value you want to use as Source.

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

You can also select fields from the current logged-in user in your organization to include in the merge.

Note: The User source refers to the currently logged-in user in your organization. This means that if you include the First Name field from the user, each time a different user logs in, they will see their own First Name displayed.

Null

It enables assign null value to the Destination Type field we chose.

Blank

It enables assign blank value to the Destination Type field we chose.

  • No labels