Using Data Set Actions

Liferay DXP 2024.Q1 U112

Here are some examples for how to use data set actions and perform different tasks.

Use Case: Using Actions to Edit Documents

Background: You have performance review documents in your site’s Documents and Media application and you want to show a list of performance reviews, their ID, title, external reference code, and the date they were created. You also want to allow users who can view the data set to edit the documents.

Setting up the Environment: Before you create the action, create a Data Set with these parameters:

Field	Value
Name	Documents Data Set
REST Application	`/headless-delivery/v1.0`
REST Schema	Document
REST Endpoint	`/v1.0/sites/{siteId}/documents`

Start editing the Documents Data Set and add the id, externalReferenceCode, title, and dateCreated fields to it.

Then, upload the documents to the Documents and Media application.

Creating the Edit Action

In the New Item Action page, enter the fields using the information in the table below:

Field	Value
Label	Edit Document
Icon	pencil ()
Type	Link

To fill in the URL,

In a new tab, look for a performance review document in the Documents and Media application (Site Menu → Content & Data → Documents and Media).
Open the document’s Actions menu (), right-click the Edit options, and select Copy Link Address.

The URL should look like this http://localhost:8080/group/guest/~/control_panel/manage?(...)_com_liferay_document_library_web_portlet_DLAdminPortlet_fileEntryId=32813&(...)state%3Dmaximized%26p_p_mode%3Dview%26p_p_auth%3DYH1QvqK9&p_p_auth=YH1QvqK9
Return to the New Item Action window and paste the URL in its field.

If you use the action as it is now, users are sent to the same editing page referring to the same document regardless of the entry they are trying to edit.

Since you don’t want that, you should make the URL as universal as possible and parameterize values to guarantee that each action points to a specific entry’s URL.
To make the URL more universal, you can start by finding and deleting the initial address (http://localhost:8080).

This guarantees that the action works even if the site’s address is altered.
You can also find and delete the authentication token p_p_auth%3DYH1QvqK9&p_p_auth=YH1QvqK9.

This prevents authentication conflicts since the p_p_auth authentication token changes every time you log in.
To parameterize your URL, find the fileEntryId value in your URL. Replace it with a parameter used in the headless API to refer to the document. In this case, id.

The value for the fileEntryId is different in your instance.

If you are not sure which values you should use, access your API explorer and look for the parameters used in your REST application.
Replace 32813 with {id}.

Enter the parameter value between curly braces ({}).
Once the URL is set, add the Headless Activation Key. You can find it using your API explorer. Find the REST application you are using and execute a GET command. The keys are in the response body like this:
```
(...)
   "actions": {
   "get": {
      "method": "GET",
      "href": "http://localhost:8080/o/c/performancereviews/32647"
   },
   "replace": {
      "method": "PUT",
      "href": "http://localhost:8080/o/c/performancereviews/32647"
   },
   "update": {
      "method": "PATCH",
      "href": "http://localhost:8080/o/c/performancereviews/32647"
   },
   "delete": {
      "method": "DELETE",
      "href": "http://localhost:8080/o/c/performancereviews/32647"
   }
}
```
In this case, the action keys are get, replace, update, and delete.

Since users edit the document, you should use the PUT method and its activation key (replace). Add the key to the Headless Action Key field and ensure that the user has the required permissions for that action.
In this case, there is no need for a Confirmation Message, so click Save.

Using a Data Set Fragment in a Content Page

The action is set. Use a Data Set fragment to display your data set in a content page:

Create a new page or start editing one.
In the Fragments and Widgets menu on the left, search for Data Set under fragments. Drag and drop the fragment in your editing area.
Click on your fragment. In the General tab on your right, there is a field where you can select a data set. Click Add () and select the Documents Data Set.
Publish the page.

The data set displays your data set as you configured. Click Edit to edit the document.

Add the Data Set fragment to a content page and publish it. If the action is working properly, you are redirected to the document's editing page once you click on the action button.