Site Search - Liferay Learn

Developing Page Fragments Page fragments are the building blocks for content pages. They're made from the three components of web pages: CSS, HTML, and JavaScript. To create a page you combine...

Liferay CLI Tool

Official Documentation

Liferay CLI Tool The Liferay CLI tool is deprecated as of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. The Liferay CLI tool makes it easy to create Angular, JavaScript,...

Using a Frontend Data Set Cell Renderer Client Extension

Official Documentation

Using a Frontend Data Set Cell Renderer Client Extension Liferay 7.4+ You can use Frontend Data Set (FDS) cell renderer client extensions to customize the display for your data set. Use this type...

Using Asynchronous Messaging

Official Documentation

Using Asynchronous Messaging Message Bus's asynchronous option provides fire and forget behavior; send a message and continue processing without waiting for a response. An asynchronous message is...

Using a JSP and MVC Portlet

Official Documentation

Using a JSP and MVC Portlet An easy way to start developing a web application is to add markup to a JSP file and render it using a portlet Java class. The W3E7 example application demonstrates...

Liferay Faces Version Scheme

Official Documentation

Liferay Faces Version Scheme In this article, you'll learn which Liferay Faces artifacts should be used with your portlet and explore the Liferay Faces versioning scheme by discovering what each...

Managing Files

Official Documentation

Managing Files Once you've added files to your document library, you can manage them via the Documents and Media UI. To access management actions for a file, select it or click Actions (Actions...

Exporting Packages

Official Documentation

Exporting Packages In OSGi, packages are private by default. You must explicitly exporting a package so other modules can import and use them. Here's how to export packages: Open your bnd.bnd...

Document Shortcut API Basics

Official Documentation

Document Shortcut API Basics Liferay's headless delivery application provides REST services for Documents and Media that add document shortcuts to sites or asset libraries, list their information,...

Document API Basics

Official Documentation

Document API Basics Liferay's headless delivery application provides REST services for Documents and Media that add documents and folders, list their information, modify them, delete them, and...

Using an OSGi Service

Official Documentation

Using an OSGi Service Liferay APIs are readily available as OSGi services. You can access a service by creating a field of that service type and annotating the field with @Reference, like this: ...

API Builder

Official Documentation

API Builder Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) This feature is currently...

Gogo Shell Commands

Official Documentation

Gogo Shell Commands The Gogo shell executes Felix Gogo basic commands and Liferay commands. The Gogo shell is accessible in the Control Panel (recommended) and from the command line. Here are some...

Exported Third Party Packages

Official Documentation

Exported Third Party Packages Liferay provides over one-hundred third party Java packages at run time. The com.liferay.portal.bootstrap module exports the packages by specifying individual packages...

Documents and Media Permissions Reference

Official Documentation

Documents and Media Permissions Reference Liferay 7.4 U76+/GA76+ Manage access to Documents and Media assets using application and resource permissions. With role-based access control, you can...

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,...

Creating Form Fragments

Official Documentation

Creating Form Fragments Liferay 7.4 U45+/GA45+ The form components fragments are for building your object's forms in a content page. If Liferay's form fragments don't satisfy your use case, create...

Creating Collections for Liferay 7.2 and Earlier Versions

Official Documentation

Creating Collections for Liferay 7.2 and Earlier Versions In versions before Liferay DXP 7.3+, collections were called content sets. You can create Content Sets through the Content Sets interface...

Upgrading the Database

Official Documentation

Upgrading the Database Liferay's tools and instructions facilitate upgrading DXP and Portal environments safely and quickly. Non-clustered environments that have small data sets, can be upgraded...

Running Liferay on any Kubernetes Cluster

Official Documentation

Running Liferay on any Kubernetes Cluster These instructions are purposefully generic. They install a cluster that works on any Kubernetes implementation, but additional work is needed to make that...

Setting Rates for Tax Calculations for Commerce 2.0 and Earlier Versions

Official Documentation

Setting Rates for Tax Calculations for Commerce 2.0 and Earlier Versions Define tax rates in Liferay Commerce using configurable tax engines and assign them to tax categories. You can then apply...

Setting Rates for Tax Calculations for Commerce 2.1 and Earlier Versions

Official Documentation

Setting Rates for Tax Calculations for Commerce 2.1 and Earlier Versions Define tax rates in Liferay Commerce using configurable tax engines and assign them to tax categories. You can then apply...

Commerce Roles Reference

Official Documentation

Commerce Roles Reference Liferay includes four roles out-of-the-box for Commerce: account administrator, account member, buyer, and order manager. You can modify these roles or create additional...

Configuring a Message Boards Category Mailing List

Official Documentation

Configuring a Message Boards Category Mailing List The Message Boards widget is deprecated as of Liferay DXP 2024.Q4/Portal GA129. See 2024.Q4 Maintenance Mode and Deprecations for details. You...

Enabling Optimization of Animated GIFs

Official Documentation

Enabling Optimization of Animated GIFs To scale animated GIFs, Adaptive Media uses an external tool called Gifsicle. If Gifsicle isn't installed and image/gif is included as a supported MIME type,...

Virtual Instances

Official Documentation

Virtual Instances Liferay DXP can host multiple portals on one installation. These are called virtual instances. Each virtual instance has completely separate data and configurations. Each is...

Liferay Cloud Native Provisioning

Official Documentation

Liferay Cloud Native Provisioning Liferay's cloud native experience is a Kubernetes-based Helm chart for portable deployment of Liferay instances to any cloud with a Kubernetes engine. This...

Upgrading to Jakarta

Official Documentation

Upgrading to Jakarta Liferay DXP 2025.Q3+/Portal 2026.Q1+ Liferay stepped into the future of enterprise Java when it moved to Jakarta EE starting with the DXP 2025 Q3 and the 2026 Q1 Portal...

Search Results Behavior

Official Documentation

Search Results Behavior Previously, you learned how to display search results. There are additional Search Results concepts and configurations that can enhance your search results: Filtering...

Creating Code with Liferay Workspace

Official Documentation

Creating Code with Liferay Workspace Liferay Workspace is the developer's tool for creating and managing Liferay development projects. Creating Projects Blade CLI makes it easy to create projects...

Creating Job Scheduler Templates

Official Documentation

Creating Job Scheduler Templates Liferay Self-Hosted Liferay PaaS Job Scheduler Tasks are created by implementing the DispatchTaskExecutor interface. Liferay DXP provides multiple out-of-the-box...

Managing Document Access

Official Documentation

Managing Document Access Effectively managing document access in Liferay ensures that your organization’s data remains secure while being accessible to the right users. Control document access by...

Managing Object Entries Using GraphQL

Official Documentation

Managing Object Entries Using GraphQL You can use GraphQL to manage custom object entries in Liferay efficiently. This API framework simplifies data interaction and serves as an alternative to REST...

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...

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,...

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 Display Templates

Official Documentation

Creating Display Templates 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...

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...

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...

Creating Data Definitions

Official Documentation

Creating 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...