Search Results

All Results 7006
Sort By
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
Custom Element YAML Configuration Reference
Official Documentation
Custom Element YAML Configuration Reference You can define a custom element client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a custom...
Understanding Bundler Configuration Presets
Official Documentation
Understanding Bundler Configuration Presets The Liferay npm bundler is deprecated of Liferay 2024.Q4/Portal GA129, and it's planned for future removal. The liferay-npm-bundler comes with a...
Creating A Path File
Official Documentation
Creating A Path File Test Scenario Write your first path file using the test scenario below: You would like to test that your name does not appear on any learn.liferay.com article. The steps you...
Auto-Deploying Fragments
Official Documentation
Auto-Deploying Fragments Liferay Portal 7.3 GA1+ or Liferay DXP 7.3+ If you're developing page fragments with your own tooling, you can deploy them by packaging them in ZIP files for importing via...
Developing Page Fragments
Official Documentation
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...
Provisioning Cloud Apps
Official Documentation
Provisioning Cloud Apps You can provision cloud apps to your Liferay instance and start using them immediately. Unlike DXP apps, cloud apps integrate with Liferay SaaS directly and don't require...
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 Liferay as a Headless Platform
Using Liferay as a Headless Platform Liferay provides a suite of APIs that perform the same kinds of actions available in the web interface. This is essential when you must get data in a...
Creating a Model Listener
Creating a Model Listener Model listeners listen for persistence method calls that signal changes to a specified model (such as update or add methods). Most of the methods model listeners use are...
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...
Load Balancer
Official Documentation
Load Balancer The Ingress Load Balancer gives internet access to your environment's services via proxied HTTP(S) connections using TLS (1.2 or 1.3) protocol. Each load balancer has a static IP that...
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...
Maintenance Mode and Deprecations in 7.4
Maintenance Mode and Deprecations in 7.4 With each new Liferay DXP and Liferay Portal release, a feature may not warrant continued enhancements or may become obsolete. Stopping enhancements for a...
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...
2025 Deprecations and Breaking Changes
2025 Deprecations and Breaking Changes Liferay quarterly releases introduce new features and enhancements while phasing out older or less-used functionality. Some features move to Maintenance Mode,...
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...
Creating Form Templates
Official Documentation
Creating Form 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 as...
Migration from Audience Targeting
Official Documentation
Migration from Audience Targeting If you're upgrading from a Liferay version that used Audience Targeting, you must migrate to the built-in Segmentation and Personalization features introduced in...
IBM Cloud Object Storage
Official Documentation
IBM Cloud Object Storage Self-Hosted Only Liferay DXP implements IBM’s Cloud Object Storage store with the S3 compatibility layer so that it uses the same configuration as the AWS S3 store. Once...
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....
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...
Creating Data Lists
Official Documentation
Creating 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 Lists to Objects as soon...
Enabling Automated Live Chat Systems
Official Documentation
Enabling Automated Live Chat Systems Liferay 7.4+ Liferay now offers integration with several live support chat platforms. Enabling this integration adds a chat window to sites on your Liferay...
Google Cloud Storage
Official Documentation
Google Cloud Storage Self-Hosted Only Liferay DXP 7.3 SP3+ and 7.4+ Liferay DXP provides integration with Google's Cloud Storage (GCS) service. With GCS integration, you can seamlessly store and...
Troubleshooting Cross-Cluster Replication
Official Documentation
Troubleshooting Cross-Cluster Replication Known common pitfalls encountered during the CCR setup are covered here, as well as general troubleshooting techniques. For further troubleshooting, look...
Site Facet
Official Documentation
Site Facet The Site Facet narrows search results down to those existing in a certain site. Each site with content matching the searched keyword appears as a facet term. Example of Site facet...