Site Search - Liferay Learn

User Groups API Basics You can Create and Manage User Groups from the Application menu, but you can also use Liferay's REST APIs. Call these services to manage user groups. Adding a User Group ...

Batch Engine API Basics - Exporting Data

Official Documentation

Batch Engine API Basics - Exporting Data Liferay's Headless Batch Engine provides REST APIs to import and export data. Call these services to export data from Liferay. Exporting Data Then,...

Configuring JSON Web Services

Official Documentation

Configuring JSON Web Services Liferay’s services are exposed as JSON web services out-of-the-box. This is enabled by default. You can access these services via the API page at...

Consuming GraphQL APIs

Official Documentation

Consuming GraphQL APIs Liferay DXP contains GraphQL APIs for most of its applications. The GraphQL APIs are available at http://[host]:[port]/o/graphql. Here's how to consume them in three steps: ...

Data Migration Center

Official Documentation

Data Migration Center Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../../../../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) Currently,...

API Headers Reference

Official Documentation

API Headers Reference API headers are components of HTTP requests that provide essential information to the server about the client's request and how the server should handle it. You can use API...

Consuming APIs

Official Documentation

Consuming APIs APIs, or Application Programming Interfaces, serve as the bridge between different software applications, allowing them to communicate and exchange data. By consuming external APIs,...

API Query Parameters

Official Documentation

API Query Parameters Whether you consume REST APIs or GraphQL APIs, different query parameters are available to help you filter the responses. Fields Parameter Use this parameter to specify and...

Batch Engine API Basics - Importing Data

Official Documentation

Batch Engine API Basics - Importing Data Liferay's Headless Batch Engine provides REST APIs to import and export data. Call these services to import data to Liferay. Importing Data Then follow...

Consuming REST Services

Official Documentation

Consuming REST Services Liferay DXP contains REST services for most of its applications. These services are fully OpenAPI compliant. Here, learn how to consume them. This takes only three steps: ...

Creating an OAuth2 Application

Official Documentation

Creating an OAuth2 Application When you have an application that can use OAuth 2.0 for authorization, you must register that application so Liferay can recognize it. Open the Global Menu...

JSON Web Tokens (JWTs)

Official Documentation

JSON Web Tokens (JWTs) JSON Web Tokens (JWTs) represent encoded data. They are compact, self-contained, and secure. There are two primary types of JSON Web Tokens: Encrypted JWT: ensures the...

Client Secret JWT

Official Documentation

Client Secret JWT Liferay supports client secret JWT as an authentication method for OAuth 2 clients. In this flow, the client itself creates the assertion and signs it using the client secret....

Configuring the JWT Bearer Flow

Official Documentation

Configuring the JWT Bearer Flow To use JWT Bearer as a grant type in Liferay, you must create an OAuth 2 client with the Client Authentication Method set to Client Secret Basic or Post. The client...

OAuth 2 Scopes

Official Documentation

OAuth 2 Scopes In OAuth 2.0, applications are granted access to limited subsets of user data. These are called scopes (not to be confused with Liferay scopes). You can create them in two ways: ...

REST Builder

Official Documentation

REST Builder REST Builder is a code generation tool that makes it easy for you to take your local APIs and make them available on the web. It uses the OpenAPI Specification to generate REST and...

Using OAuth2 to Authorize Users

Official Documentation

Using OAuth2 to Authorize Users You can create applications that access Liferay's headless REST APIs using the OAuth 2.0 authorization protocol. The provided sample React app demonstrates three...

App Builder

Official Documentation

App Builder Liferay CE/DXP 7.3 (deprecated and removed in 7.4) App Builder is a low-code application development solution for Liferay DXP. Build a data model, define the application's forms (for...

Creating a Workflow Powered Application

Official Documentation

Creating a Workflow Powered Application Subscribers Workflow Powered Applications require data from multiple stakeholders. These process-driven applications can go through multiple stages before...

Low Code

Official Documentation

Low Code

Creating a Standard Application

Official Documentation

Creating a Standard Application To create applications based on a custom object takes four steps: create the object, create at least one form view, create at least one table view, and deploy the...

Using Camunda Business Processes

Official Documentation

Using Camunda Business Processes Liferay 7.4+, and all quarterly releases Liferay's native workflow features are designed for business processes requiring basic review and approval. If your...

Calling Liferay APIs from Camunda

Official Documentation

Calling Liferay APIs from Camunda The Liferay Connector enables calling Liferay APIs from your Camunda tasks. It's a protocol connector built on top of the Camunda HTTP REST connector. Follow...

Triggering Events in Camunda with Liferay Webhooks

Official Documentation

Triggering Events in Camunda with Liferay Webhooks You can send payloads from Liferay's webhook object actions to your Camunda process instances. This enables inbound communication from Liferay to...

Data Sets

Official Documentation

Data Sets Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). Data sets are like virtual containers that help organize and manage related...

Creating Data Sets

Official Documentation

Creating Data Sets Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). You can create data sets from different resources available through...

Producing and Implementing APIs with REST Builder

Official Documentation

Producing and Implementing APIs with REST Builder With REST Builder, you can define the API you want to build, and REST Builder provides the framework and endpoints for you. Deploy an Example REST...

Creating the Role Change Request App

Official Documentation

Creating the Role Change Request App Subscribers The Role Change Request App starts with the employee submitting a request form. Processing then proceeds to the Current Manager, then to the...

Creating the Role Change Request Object

Official Documentation

Creating the Role Change Request Object Subscribers Consider a Human Resources application that collects employee requests to change Roles within the software engineering department: the Role...

Managing Data Sets

Official Documentation

Managing Data Sets Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). Once you create a data set, you can customize how users see it....

Data Set Actions

Official Documentation

Data Set Actions Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). While managing data set, define actions to be used in the data set...

Using Data Set Actions

Official Documentation

Using Data Set Actions Liferay DXP 2024.Q1/Portal GA112 Currently, this feature is behind a release feature flag (LPS-164563). Here are some examples for how to use data set actions and perform...

Data Set Filters

Official Documentation

Data Set Filters Liferay DXP 2024.Q1/Portal GA112 Currently, this feature is behind a release feature flag (LPS-164563). While managing data sets, you can define pre-applied filters to be used...

Data Set Sorting

Official Documentation

Data Set Sorting Liferay DXP 2024.Q1/Portal GA112 Currently, this feature is behind a release feature flag (LPS-164563). While managing data sets, you can set default sorting rules for Data Sets...

Data Set Visualization Modes

Official Documentation

Data Set Visualization Modes Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). To customize the data display in your data set, use the...

Forms

Official Documentation

Forms The Forms application is in maintenance mode as of Liferay DXP 2024.Q4/Portal GA129. Migrate your forms to objects and form container fragments to future-proof your solutions. You can use...

Customizing Auto-Save Behavior

Official Documentation

Customizing Auto-Save Behavior The Forms application automatically saves the form creation progress as you create a form. By default, a form's draft is auto-saved every minute. To change the...

Exporting and Importing Forms

Official Documentation

Exporting and Importing Forms You can export all your forms as a LAR file and then import them into a different Site for reuse. See Exporting/Importing Site Pages and Content to learn about the...

Forms Field Types Reference

Official Documentation

Forms Field Types Reference The Liferay Forms application contains lots of field types and elements to add to your forms. To discover the available elements, Open the Product Menu (Product Menu)...

Forms Permissions Reference

Official Documentation

Forms Permissions Reference This article serves as a guide for all permissions associated with the Forms application. Form Widget Permissions Navigate to the site page where the Form widget has...

Translating Forms

Official Documentation

Translating Forms Forms can be translated and presented in any language that is currently enabled on the current site. To add a translation: Begin by viewing an existing form (e.g., Guest...

Building Forms with Conditional Fields

Official Documentation

Building Forms with Conditional Fields Forms can become dynamic forms where the answer to one question may allow the respondent to skip the next three questions, or require the respondent to answer...

Creating Forms

Official Documentation

Creating Forms You can create multi-field forms with the Forms application. Only authenticated users with the requisite permissions can create forms. At minimum, they should have permission to...

Customizing Form Layouts

Official Documentation

Customizing Form Layouts By default, new elements on your form are added to a new row and occupy the entire width of the form. Form with all elements occupying entire width of form. Sometimes it...

Forms Configuration Reference

Official Documentation

Forms Configuration Reference Here's an overview of all the Forms configurations so you can quickly find a configuration you need. Forms Options You can export and import forms between sites. To...

Using Storage Adapters

Official Documentation

Using Storage Adapters When a User adds a form record, Liferay routes the processing of the request through a storage adapter API. The same is true for the other CRUD operations performed on form...

Validation and Masking

Official Documentation

Validation and Masking Certain Forms fields can be validated (Text, Date, and Numeric fields) and masked (Numeric fields) to ensure User input is valid. Date Fields can be validated beginning in...

Validation Conditions Reference

Official Documentation

Validation Conditions Reference There are several out-of-the-box validation conditions that can be used to validate form responses before they are submitted. Text Field Validation Conditions...

Data Providers

Official Documentation

Data Providers Data providers serve data that can be consumed by the Forms application. The REST Data Provider is included with the Forms application. With it, you can consume data from REST web...

Creating and Managing Forms

Official Documentation

Creating and Managing Forms The Forms application is in maintenance mode as of Liferay DXP 2024.Q4/Portal GA129. Migrate your forms to objects and form container fragments to future-proof your...

Customizing the Submit Button

Official Documentation

Customizing the Submit Button Available 7.4+ When a User is finished entering data into a form, they must submit the form. By default a button that says Submit is displayed for this purpose. ...

Field Autocompletion

Official Documentation

Field Autocompletion You can configure form field autocompletion in the Forms application: Autocompletion TypeConfigurationField Types ManualType a list of autocompletion optionsText Data...

Providing Help Text and Predefined Values

Official Documentation

Providing Help Text and Predefined Values Form fields can be configured to have help text, placeholder text, and predefined values that assist users in understanding and filling out a form. Help...

Reusing Sets of Form Elements

Official Documentation

Reusing Sets of Form Elements Forms often request the same sets of information, such as name, birthday, and address. Rather than adding these fields for every new form, you can group elements as a...

Using the Search Location Field

Official Documentation

Using the Search Location Field Use a Search Location field so a user can interact with Google's Maps JavaScript API and Google Places API, selecting a location and getting these fields autofilled...

Using the REST Data Provider to Populate Form Options

Official Documentation

Using the REST Data Provider to Populate Form Options Select from List fields can hold many options. Those options can be supplied automatically by using the JSON web services registered in Liferay...

Getting Started with Dynamic Data Lists

Official Documentation

Getting Started with Dynamic Data Lists Dynamic Data Lists is deprecated as of Liferay DXP 7.3, and is planned for removal in 2024. It is replaced by Objects. Please migrate your Dynamic Data...

Managing Data Definitions

Official Documentation

Managing Data Definitions Dynamic Data Lists is deprecated as of Liferay DXP 7.3, and is planned for removal in 2024. It is replaced by Objects. Please migrate your Dynamic Data Lists to Objects...

Migrating to Liferay Objects

Official Documentation

Migrating to Liferay Objects Dynamic Data Lists is deprecated and scheduled for removal by the end of 2024. To prevent data loss and achieve the same functionality, please migrate your structures...

Using Templates to Display Forms and Lists

Official Documentation

Using Templates to Display Forms and Lists Dynamic Data Lists is deprecated as of Liferay DXP 7.3, and is planned for removal in 2024. It is replaced by Objects. Please migrate your Dynamic Data...

Search Results