Capability

Development and Tooling

Liferay offers a comprehensive toolkit to extend or customize your digital experience. Build applications quickly with low-code/no-code features like Objects, or leverage developer tools like Liferay Workspace and Blade CLI for further customizations.

For users on PaaS or running Self-Hosted, Liferay also offers tools deploying customizations.

Feature
Deployment Approach
Capability
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...
Published Date: May 9, 2024 6:51 PM
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,...
Published Date: May 9, 2024 6:51 PM
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: ...
Published Date: May 9, 2024 6:51 PM
Consuming GraphQL APIs
Official Documentation
Consuming GraphQL APIs Liferay DXP contains GraphQL APIs for most of its applications. Here's how to consume them in three steps: Identify the API you wish to consume. Identify the site...
Published Date: May 9, 2024 6:51 PM
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...
Published Date: Nov 16, 2024 3:32 PM
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,...
Published Date: May 9, 2024 6:51 PM
Making Unauthenticated Requests
Official Documentation
Making Unauthenticated Requests By default, Liferay DXP restricts API access for the sake of security, requiring authentication to get a valid response. However, in certain cases it may make sense...
Published Date: May 9, 2024 6:51 PM
Using External Reference Codes
Official Documentation
Using External Reference Codes Liferay DXP/Portal 7.4+ Many of Liferay's headless API endpoints support an external reference code (ERC). The ERC field is useful in wide range of scenarios. For...
Published Date: May 9, 2024 6:51 PM
Sample API Tutorials
Official Documentation
Sample API Tutorials Follow the links below for sample API tutorials that include example requests and example code. Building Applications (Objects) Custom Objects API Basics Custom Objects...
Published Date: May 9, 2024 6:51 PM
Using OAuth 2.0
Official Documentation
Using OAuth 2.0 OAuth 2.0 is an industry-standard authorization protocol. Users with accounts on a Liferay-based website can share select credentials with various clients seamlessly. OAuth 2.0...
Published Date: May 9, 2024 6:51 PM
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...
Published Date: Feb 25, 2025 12:39 PM
Issuing JWT Access Tokens
Official Documentation
Issuing JWT Access Tokens Liferay DXP 7.4 U45+/GA45+ You can configure Liferay to issue access tokens in the JWT format from System Settings. Enabling JWT Tokens Open the Global Menu...
Published Date: Feb 25, 2025 12:39 PM
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...
Published Date: Nov 22, 2024 10:48 PM
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...
Published Date: Feb 25, 2025 12:39 PM
JSON Web Token Assertions
Official Documentation
JSON Web Token Assertions An assertion helps in sharing identity and security information across different domains. There are two uses for assertions: Authorization grants Client authentication...
Published Date: Feb 25, 2025 12:39 PM
Authorizing Account Access with OAuth2
Official Documentation
Authorizing Account Access with OAuth2 Once you have an application registered, you can start authorizing users. To do that, you must construct the URL to the authorization server (Liferay DXP)....
Published Date: Nov 22, 2024 10:48 PM
Using Private Key JWT (JSON Web Token)
Official Documentation
Using Private Key JWT (JSON Web Token) Liferay supports private key JWT as an authentication method for OAuth 2 clients. In this flow, the client itself creates the assertion. Liferay authenticates...
Published Date: Mar 6, 2025 4:05 PM
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: ...
Published Date: Nov 22, 2024 10:48 PM
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...
Published Date: May 9, 2024 6:51 PM
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...
Published Date: May 9, 2024 6:51 PM
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...
Published Date: Nov 22, 2024 10:48 PM
Low Code
Official Documentation
Low Code
Published Date: May 9, 2024 6:55 PM
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...
Published Date: May 9, 2024 6:55 PM
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...
Published Date: May 9, 2024 6:54 PM
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...
Published Date: May 9, 2024 6:55 PM
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...
Published Date: May 9, 2024 6:55 PM
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...
Published Date: May 9, 2024 6:55 PM
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...
Published Date: Jun 26, 2025 6:24 PM
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...
Published Date: Jun 26, 2025 6:24 PM
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...
Published Date: May 9, 2024 6:54 PM
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...
Published Date: Jun 4, 2025 6:31 PM
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...
Published Date: May 9, 2024 6:54 PM
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...
Published Date: May 9, 2024 6:54 PM
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....
Published Date: May 9, 2024 6:54 PM
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...
Published Date: May 9, 2024 6:54 PM
Liferay Documentation Format
Liferay Documentation Format The format, or how a style of documentation is organized, is important to maintaining consistency of experience. As readers make more use of the documentation, the...
Published Date: May 9, 2024 7:01 PM
Building Enterprise Websites with Liferay Exercises
Building Enterprise Websites with Liferay Exercises These exercises supplement the Building Enterprise Websites with Liferay video training and provide an opportunity to solidify your learning....
Published Date: Sep 23, 2024 4:10 PM
Utility Classes
Utility Classes Util-Bridges Util-Java Util-slf4j Util-Taglib
Published Date: May 9, 2024 7:01 PM
Legacy Documentation
Legacy Documentation Using Liferay DXP 7.2 Developing Liferay DXP 7.2 Using Liferay DXP 7.1 Developing Liferay DXP 7.1 Using Liferay DXP 7.0 Developing Liferay DXP 7.0 Using Liferay...
Published Date: Jan 11, 2025 5:03 PM
Liferay Style Conventions
Liferay Style Conventions Conventions are neither correct or incorrect; they are decisions that vary greatly in the industry. After much comparison and use, Liferay's documentation uses the...
Published Date: May 9, 2024 7:01 PM
Properties Documentation
Properties Documentation Portal Properties System Properties Liferay Plugin Package Properties 7.4 Liferay Plugin Package Properties 7.3 Liferay Plugin Package Properties 7.2 Liferay Plugin...
Published Date: May 9, 2024 7:01 PM
Day 1 Exercises for Building Enterprise Websites with Liferay
Introduction page for day 1 Day 1 Exercises for Building Enterprise Websites with Liferay Exercise 1: Exploring Clarity's Public Enterprise Website Exercise 2: Verifying and Launching Liferay...
Published Date: Sep 23, 2024 4:10 PM
Day 2 Exercises for Building Enterprise Websites with Liferay
Introduction page for day 2 Day 2 Exercises for Building Enterprise Websites with Liferay Exercise 11a: Generating Content with ChatGPT Exercise 11b: Auto-Tagging Content (Bonus) Exercise 12a:...
Published Date: Sep 23, 2024 4:11 PM
Liferay University
Liferay University This page serves as an archive and index of videos that were previously hosted on Liferay University. As of February 28, 2023 Liferay University is no longer operational....
Published Date: May 9, 2024 7:01 PM
Liferay Style Guide
Liferay Style Guide The Liferay Style Guide sits on the shoulders of giants---specifically, the giants of The Chicago Manual of Style and Strunk and White's The Elements of Style. Where this guide...
Published Date: May 9, 2024 7:01 PM
Liferay High-Level Style
Liferay High-Level Style There are five types of documentation: Introduction: Placed hierarchically at the top of a section, the introduction is a high level explainer that summarizes how the...
Published Date: Jan 18, 2025 2:52 AM
Liferay Phraseology
Liferay Phraseology Liferay's style phrases prose a certain way. Note that these are also conventions and neither correct nor incorrect; they are the way we have chosen to communicate based on our...
Published Date: Jan 18, 2025 2:52 AM
Training Material
Training Material These materials supplement some recorded and in-person trainings by providing you with opportunities to practice key skills, test your understanding, and gain confidence in...
Published Date: Sep 23, 2024 4:10 PM
Day 3 Exercises for Building Enterprise Websites with Liferay
Introduction page for day 3 Day 3 Exercises for Building Enterprise Websites with Liferay Exercise 19a: Creating an Object Definition Exercise 19b: Building the Form Exercise 19c: Creating a...
Published Date: Sep 23, 2024 4:11 PM
Content Management System
Official Documentation
Content Management System Liferay’s content management system includes tools for creating, organizing, and managing content across your sites. These include Web Content, Tags and Categories, Asset...
Published Date: Jul 17, 2025 12:42 AM
Deprecated Content Features
Official Documentation
Deprecated Content Features These content features are deprecated and no longer actively developed in Liferay. While still available for compatibility and migration purposes, they are not...
Published Date: Jul 17, 2025 12:43 AM
Scoping Your Message Boards
Official Documentation
Scoping Your Message Boards The Scope configuration is deprecated as of Liferay DXP 2024.Q4/Portal GA129 and is scheduled for removal in a future release. Multiple message boards can be created...
Published Date: Jan 18, 2025 2:46 AM
Scoping Your Wikis
Official Documentation
Scoping Your Wikis The Scope configuration is deprecated as of Liferay DXP 2024.Q4/Portal GA129 and is scheduled for removal in a future release. Besides using Wiki Nodes to organize your...
Published Date: May 9, 2024 6:50 PM
Wiki Permissions Reference
Official Documentation
Wiki Permissions Reference You can refer to this reference when assigning permissions to users and roles for the Wiki widget. To learn more about DXP Roles and Permissions in general, see Roles and...
Published Date: May 9, 2024 6:50 PM
Session Property Vocabularies
Official Documentation
Session Property Vocabularies Liferay DXP/Portal 7.3+ With a Session Property Vocabulary, you can create session-based Segment properties using predefined values. This option is useful when you...
Published Date: May 9, 2024 6:50 PM
Exploring Indexed Fields
Official Documentation
Exploring Indexed Fields Some search features can be configured if you know how to explore a search document's fields or inspect the search engine's field mappings. FeatureRelevant...
Published Date: Jul 29, 2025 8:56 PM
Installing Solr
Official Documentation
Installing Solr 7.2-7.3 (CE, DXP); 7.4 DXP U60+ Solr is a popular enterprise search platform built on Apache Lucene. It's reliable, scalable, and fault tolerant. Read more about it here. Solr is...
Published Date: May 9, 2024 6:59 PM
Configuring Search Bar Suggestions
Official Documentation
Configuring Search Bar Suggestions 7.4 U36+ and GA36+ Search Bar Suggestions adds search as you type functionality to Liferay's Search Bar widget. Select a result from the drop-down list or...
Published Date: Jul 29, 2025 8:56 PM
Category Facet
Official Documentation
Category Facet The Category Facet narrows search results for categorized assets that match the search query keywords. Each matching result's categories are aggregated as facet terms. Example of...
Published Date: Jul 29, 2025 8:56 PM
Custom Facet Examples
Official Documentation
Custom Facet Examples The custom facet is a powerful aid to customizing your site's search experience. When the out-of-the-box facets don't meet your requirements, the custom facet fills the gap....
Published Date: Jul 29, 2025 8:56 PM