---
title: "Entity list"
slug: "entity-list"
abstract: "How to display a collection of entities matching specific criteria."
---
# Entity list
The **Entity list** component can be used on an entity details page to display a collection of entities matching specific criteria. This type of component is highly configurable, letting you choose the type and number of entities to display, the format they are displayed in, and more.
> [!important]
> This component will be deprecated. Use the **Search** component instead.
To add an **Entity list** component
1. On the menu bar, click **Manage** :mdiCogOutline:.
2. On the **Manage** page, click **Pages**.
3. On the **Pages** page, select the details page you want to modify.
4. On the **Layout** tab, add the page component.
5. Click the component to open its details page.
6. On the details page, configure the component by filling out the various fields on the following tabs:
:::tab{title="Select"}
Use this tab to define the query that identifies entities to display. You can also apply filters to the query results.
## Entity definition
In this pane, you define the query that fetches entity data to display in the list.
| Field | Description | Mandatory |
| --- | --- | --- |
| **Definition** | The definition type of entities you want the query to fetch, such as *Asset*. | Yes |
| **Query type** | The query type. Choose between *Default*, *Dependent/query* and *Dependent/relation*. | Yes |
| **Take** | The maximum number of results to display in the list. | No |
| **Created by user** | Hides all entities not created by the current user. | No |
| **Enable sorting** | Applies sorting to the list contents. This is not available for Dependent/relation query type. | No |
| **Sorting property** | The property used to sort the list contents, and the direction they are sorted in. | No |
| **Preflight request** | The page will check if the request is allowed based on the server's CORS configuration. | No |
## Filters
In this pane, you can apply filters to the query results. Only entities that match the query and its filters are displayed by the list component.
| Field | Description | Mandatory |
| --- | --- | --- |
| **Type** | The filter type. | Yes |
| **Property** | The property to use. | For *Property* type only |
| **Relation** | The relation to use. | For *Relation* type only |
| **Option list** | The option list to use. | For *Option list* type only |
| **Operator** | The operator to use. | Yes |
| **Full-text search** | The text to search for. | Yes |
## Results
This pane shows a preview of entities that match the query and applied filters.
:::
:::tab{title="Output"}
Use this tab to choose which entity properties to display in the list. For each property you want to display, click **Add output property** and fill out the following fields:
| Field | Description | Mandatory |
| --- | --- | --- |
| **Type** | The type of output parameter. | Yes |
| **Output property** | The system property. | Yes. For *System property* type only. |
| **DateTime Format** | The system property format. | Yes. For *System property* type only. |
| **Property** | The property. | Yes. For *Property* type only. |
| **Format** | The property display format. | Yes. For *Property* type only. |
| **Selected icon** | Sets an icon to represent the output parameter. | No. For *Icon* type only. |
| **Label** | Label of the output property. | No |
| **Action** | Associates an action to a property. | No |
When you’ve finished configuring a property, click **Add** to apply it to the component.
:::
:::tab{title="Template"}
Use this tab to modify the appearance of the component based on one of several templates. After selecting a Category listed below, you can select one of the templates in that category.
| Template category | Description |
| --- | --- |
| **List** | Renders entities as a simple list of text. |
| **Image grid** | Renders entities in a grid containing images. After selecting a template, you can choose how many columns the grid contains and the size of the image rendition used for each entity. |
| **Table** | Renders a table containing columns of data about each entity. After selecting a template, you can choose whether the table should include a header. |
| **Image Carousel** | Renders a carousel that lets page visitors view the entities matching your query in a sequence. After selecting a template, you can specify the maximum number of entities to display at one time, the type of image rendition to display for each entity, and whether the carousel plays automatically. |
:::
:::tab{title="Components"}
Use this tab to add functionality to the rendered component, letting page visitors update and interact with the query results.
## Pagination
You can add pagination to the top and bottom of a list and set up an alternate list size by setting the following parameters:
| Field | Description | Mandatory |
| --- | --- | --- |
| **Pagination top** | Adds pagination at the top of the list. | No |
| **Pagination bottom** | Adds pagination at the bottom of the list. | No |
| **Use take alternate** | Uses the **Alternate take** value to limit the number of displayed result items. | No |
| **Alternate take** | Limits the number of displayed result items. | No |
## Sorting
Adding sort properties lets page visitors use them to manually sort the query results. After filling out the following fields for a property, click **Add**.
| Field | Description | Mandatory |
| --- | --- | --- |
| **Property** | The sorting property. | Yes |
| **Caption** | A label for the sorting property. | Yes |
## Refresh query
You can set a refresh query, enable a search component, and track query results by using the following fields:
| Field | Description | Mandatory |
| --- | --- | --- |
| **Refresh query / Enable** | Adds a component that repeats the query to check for new results. | No |
| **Title** | A title for the refresh query. | No |
| **Search / Enable** | Adds a search component. | No |
| **Track** | Tracks the query result changes. | No |
## Filters
Adding filters lets page visitors use them to manually filter the query results.
| Field | Description | Mandatory |
| --- | --- | --- |
| **Property** | The filter property. | Yes |
| **Label** | Label of the filter property. | No |
| **Condition** | Condition for displaying the filter. You must specify a *Label* and a *Key*. | No |
## Buttons
You can add one or more buttons to provide additional functionality for page visitors.
| Field | Description | Mandatory |
| --- | --- | --- |
| **Size** | The size of the button. | Yes |
| **Style** | The button style. | Yes |
| **Action** | The action type of the button:
- *Page link* - specify a *Link to page* URL
- *OpenModalAction* - specify an action for the button
| Yes |
| **Title** | Title of the button component. | No |
| **Type** | The visual aspect of the button. | Yes |
| **Text** | Label of the button. | No |
| **Link parameters** | Parameters for the link. You must specify a *Label* and a *Key*.You must specify a Label and a Key. | No |
:::
:::tab{title="Labels"}
Use the Labels tab to set a title for the component, apply a hyperlink to that title, and set default text for empty results.
You can configure labels by setting the following parameters:
| Field | Description | Mandatory |
| --- | --- | --- |
| **Title** | The component title. | Yes |
| **Title link** | The hyperlink applied to the title. | Yes |
| **Empty message** | Text to show when there are no results to display. | Yes |
:::
:::tab{title="Advanced"}
Use the **Advanced** tab to apply specific classes provided with the solution. This is useful when you want to use styling other than the default system styling.
:::
7. Click **Save and close**.