Viewing Data Sets

Liferay DXP 2024.Q1+/Portal GA112+

Important

This feature is behind a release feature flag (LPS-164563).

Once you create a data set, add it to a page to present it to your users. Users can then use it per your configured options.

Adding a Data Set to a Page

Use the Data Set fragment to view a data set on a page.

On any page, click Edit .
On the Fragments tab, expand the Content Display section.
Drag the Data Set fragment onto the page.
Click the Data Set fragment on the page.
In the menu on the right, under Data Set, click Select Data Set ().
Select your desired data set, and click Select.

The selected data set appears on the page.

The data set appears on the page in its default visualization mode (card, list, or table view). The available views, actions, filters, and sorting options depend on the data set’s configuration.

Mapping URL Tokens

Liferay DXP 2026.Q3+ Release Feature (LPD-38564)

A data set’s endpoint URL can contain tokens, which are placeholders written in curly braces. A common case is a one-to-many object relationship endpoint such as /o/c/universities/{universityId}/universityStudents, where the data set has no value of its own for {universityId}. You supply the value in the Data Set fragment.

Tokens can appear in the data set’s REST endpoint and in the Parameters field of its Advanced Optional Parameters section. A token in a parameter, such as filter=contains(friendlyUrlPath,'{path}'), is mapped the same way as a token in the endpoint path.

Before you start, add the Data Set fragment to a page and select your data set. The URL Token Mapping panel appears only when the selected data set’s URL contains at least one token. The panel’s first row shows a Status of Completed or Incomplete. Status reads Completed only when every token in the URL is mapped.

With the page open for editing, click the Data Set fragment on the page.
In the right menu, go to the URL Token Mapping panel.
Select the token you want to map.

When the URL has one token, the Token drop-down preselects it. With multiple tokens, you must select one. Each option is labeled Mapped or Unmapped.
Open the Mapping drop-down and select a mode.

Two modes are available for every token, and up to two more appear depending on where the fragment is and which token you selected. See Mapping Modes to learn more.
Supply the token’s value in the field below the Mapping drop-down.

The field changes with the mode.

Input Token Value: Enter the value in the Token Value field.

Map to Selected Entity: Click Select Entity (), select an item, and choose an identifier in the Field drop-down.

Map to Page Context Entity: Choose an identifier in the Field drop-down.

Resolve Automatically: No field appears, because Liferay supplies the value.
Repeat these steps for each remaining token in the URL.

When every token is mapped, Status reads Completed. Once the tokens also resolve to values, the data set replaces the placeholder.

Mapping Modes

Choose the mode that matches how the token’s value is determined. In this context, an entity is a single record, like an object entry or web content article.

Mode	Use It When	How to Set It
Input Token Value	You know the value and it never changes.	Type it in the Token Value field.
Map to Selected Entity	The data set always shows records belonging to one item, such as the students of one university.	Select an entity, then choose the identifier that supplies the value. Both are required.
Map to Page Context Entity	The page shows a different item each time and the data set follows it. This mode appears only on a display page template.	Choose the identifier that supplies the value. It comes from the record the display page is showing.
Resolve Automatically	Liferay already knows the value, such as the current site or the signed-in user.	Nothing to set. These tokens start out mapped: `{siteId}`, `{scopeKey}`, `{userId}`, `{userExternalReferenceCode}`, and any token the data set’s REST application resolves.

Note

For Map to Selected Entity and Map to Page Context Entity, the Field drop-down offers ID and External Reference Code. Using ERCs is especially helpful when working with entities in external systems.

Switching a token’s mapping mode can clear the value you configured for it, which cannot be undone.

Switch To	What Happens to the Current Value
Input Token Value	Cleared
Map to Selected Entity	Cleared, including the selected entity
Map to Page Context Entity	An identifier field chosen under Map to Selected Entity or Map to Page Context Entity carries over. Anything else is cleared.
Resolve Automatically	Replaced by the resolved value

Unresolved Tokens in the Page Editor

While a token is unresolved, the fragment shows a placeholder instead of the table. The placeholder shows the endpoint URL with its unresolved tokens in bold, an empty table outline, and a dismissible message naming what’s missing.

Status can read Completed while the placeholder is still showing. This means a token is mapped to the page context entity, and the page editor isn’t displaying an entity yet. Pick one with the Preview With drop-down menu.

Important

On a published page, an unresolved token shows no message to visitors. The data set doesn’t appear at all. Before you publish, confirm Status reads Completed and the data set displays in the editor.

Liferay DXP 2024.Q1+/Portal GA112+

Any changes you make to a data set are included in your browser’s URL within parentheses. This includes filters, sorting, visible columns, page, search bar state, and the visualization mode.

When you navigate with the browser’s back or forward buttons, the configuration is preserved. However, navigating away and returning via a link or menu item regenerates the URL, so the configuration is lost.

This example URL displays page 2 of a data set with 40 items per page:

http://localhost:8080/home?com_liferay_frontend_data_set_sample_web_internal_portlet_FDSSamplePortlet-advanced_fdsConfig=(delta:40,page:2)

Important

Before Liferay DXP 2026.Q1, the URL shows parameters in a longer format that doesn’t condense your configuration into a short, readable list. Data set URLs after 2026.Q1 are not shareable with older versions.

To share your current user view with others, copy the page URL. Anyone who opens the copied link sees the same configuration and layout, though displayed data may vary depending on timing and permissions.

Scroll position and column widths are not preserved. Only filters, sorting, visible columns, page, search bar state, and visualization mode are restored.

Saving Your User View

Liferay DXP 2026.Q1+

Note

Enable User Views in the Settings tab of the Data Set Manager for these controls to appear.

When logged in, you can save and manage your user views, including your filters, sorting, and other view settings, via the controls at the top-right of the data set fragment.

Use the drop-down menu to switch between views, and click Actions () to save, rename, or delete the current view from your saved views.

Click the drop-down menu to switch to one of your saved user views.

Save and manage your user views to preserve your data set configurations.

Liferay DXP 2026.Q3+

Important

Sharing views requires the Data Set Manager (LPS-164563) release feature flag.

Copying the page URL shares a one-time snapshot of what you’re looking at. Sharing a saved view is different: it gives colleagues their own entry in the user views drop-down menu that stays synced with your changes. You can share only views you own.

Select the saved view from the user views drop-down menu.
Click Actions () and select Share View.
Use the Add People field to select a user or user group.

Selected recipients appear under Who Can Use This View. Sharing with a user group shares the view with every member of that group.
Click Share. Recipients receive a Liferay platform notification and email.

Sharing grants view access only and doesn’t expire. Recipients cannot modify the view or share it with other users.

Important

Sharing a view shares a configuration, not data. Recipients see only the records they have permission to see, so users may see different rows.

Using a View Shared with You

Shared views appear in the same drop-down menu as your own saved views. They appear under Shared with Me, below your own views.

A shared view stays connected to the owner’s original. When the owner changes its filters or sorting, you see those changes the next time you open it. To create an independent copy that you own, click Save View As….

Revoking Access to a Shared View

Select the shared view from the user views drop-down menu.
Click Actions () and select Share View.

The modal lists everyone who has access to the view.
Click Remove Access on the recipient’s row.
Click Share to save your change.

The view stops appearing in that recipient’s drop-down menu, and they aren’t notified that you removed their access.

Capability:

Development and Tooling

Resource Type:

Official Documentation

Deployment Approach:

Liferay PaaS

Liferay SaaS

Liferay Self-Hosted

Feature:

Data Sets