Creating Data Sets

Liferay DXP 2024.Q1+/Portal GA112+

Important

Currently, this feature is behind a release feature flag (LPS-164563).

You can create data sets from different resources available through Liferay Headless APIs. Then, manage the data sets and customize how you display the data.

Creating Custom Data Sets

1. Open the Global Menu (), select the Control Panel tab, and click Data Sets under Object.

2. Click New and name your data set.

3. Choose the REST Application from a list of available options.

   Some of these options enable a REST Schema field where you must select a schema from a list of available options.

   

   Note

   When there is only one option available for the REST schema and endpoint (e.g. object definitions and /batch-planner/v1.0), they are set automatically once you select the REST application.

4. (When available) Choose a REST schema from a list of available options.

   Some of these options enable a REST Endpoint field where you must select an endpoint from a list of available options.

   If there is only one schema available, the option is selected automatically.

5. (When available) Choose a REST endpoint from a list of available options.

   Important

   Some REST application options don’t have usable endpoints, and you cannot create data sets with those options (e.g. /captcha/v1.0 and /data-engine/v2.0).

6. Click Save.

The data set is created, and you can see its information in the data set manager.

Creating System Data Sets

You can use system data sets to adjust and customize an (otherwise unchangeable) Java-based data set, while keeping its underlying implementation. Adding a system data set creates a copy of the Java-based data set, which you can then treat like a custom data set by adding or removing visualization modes, filters, actions, etc.

1. Navigate to the data set manager (Global Menu () → Control Panel → Data Sets).

2. Click the System Data Sets tab at the top of the page.

3. Click New.

   A modal appears with a list of all available Java-based data sets.

   

   Tip

   The Java-based data sets that don’t support system data sets yet don’t appear in the list.

4. Select the desired data set to use as the basis for your customizable system data set.

5. Click Create.

The system data set that appears is a copy of the original data set. Edits you make are independent of the original data set, and the new data set is not affected by changes to the original Java-based data set. System data sets are customizable in the data set manager, similarly to custom data sets.

Creating a system data set also replaces the original data set’s usages in your pages with the new customizations. At any point after its creation, you can disable or enable the system data set in the data set manager by clicking the toggle button in the Status column.

Disabling the system data set reverts pages to the original Java-based data set. This keeps your customized data set available for future edits even when you’re not actively using it.

Data Set Manager

Once created, data sets appear in the data set manager. Use the application to view information and edit the existing data sets.

In the data set manager, you can find

• The search bar (1)
• Each data set’s name (2)
• A link to each data set’s REST application in the API Explorer (3)
• Each data set’s REST schema (4) and the REST endpoint (5) applied to it
• The last time each data set was modified (6)

You can also click the arrow down icon (7) and search for a specific table field or check/uncheck the existing fields to show/hide them in the table.

Edit, alter the permissions, or delete your data set using the data set’s Actions menu ()(8):

Edit: While editing a data set, you can configure its information and layout. Alternatively, click on the name of the data set to edit it.

Permissions: Select the permissions you want to assign and click Save. This option does not appear for system data sets.

Delete: Click Delete to delete your data set.

Related Topics

• Managing Data Sets