Site Search - Liferay Learn

Document Types and Metadata Sets API Basics

Document Types and Metadata Sets API Basics Liferay DXP 2025.Q1+/Portal GA132+ Liferay's headless delivery application provides REST services for Documents and Media that add document types and...

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

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

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

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

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

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

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

Personalizing Collections

Official Documentation

Personalizing Collections Liferay Portal 7.3 GA6 / DXP 7.3+ By default, any user can see all the collection's content and is part of the Anyone personalized variation. However, you can create a...

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

Using Forms to Poll Users

Official Documentation

Using Forms to Poll Users 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...

Writing a Custom Data Provider

Official Documentation

Writing a Custom Data Provider Liferay Forms fields can be populated using a Data Provider. Out of the box, there's a REST Data Provider that provides a flexible way to consume data from most REST...

Using the Sidecar or Embedded Elasticsearch

Official Documentation

Using the Sidecar or Embedded Elasticsearch Sidecar and embedded Elasticsearch are not suitable for production. When using an app server different other than Tomcat, set up a standalone...

Synonym Sets

Official Documentation

Synonym Sets Subscription A Synonym Set is a group of words or phrases with the same meaning. An administrative User creates the Synonym Set; when a search page end user searches for a keyword or...

Segments Admin Settings

Official Documentation

Segments Admin Settings Liferay DXP/Portal 7.3+ Starting in Liferay DXP 2026.Q1, Segments moves toward a unified experience with Analytics Cloud. The impact depends on your installation type: ...

Personalizing Collections for Liferay 7.2 and Earlier Versions

Official Documentation

Personalizing Collections for Liferay 7.2 and Earlier Versions Personalizing collections tailors content for specific user segments, enhancing user experiences and targeting content effectively. In...

Understanding Roles and Permissions

Official Documentation

Understanding Roles and Permissions To give users the necessary permissions to perform their intended function within Liferay DXP, you must first associate the set of permissions with a role. ...

Redirect URLs

Official Documentation

Redirect URLs Available 7.4+ Your Liferay Instance can be configured to allow redirects to certain URLs or IP addresses. To configure, navigate to Control Panel → Instance Settings → Content &...

Updating Liferay

Official Documentation

Updating Liferay Liferay DXP 7.3 SP3+/Portal 7.4 GA1+ Update your Liferay installation with Bundle Releases. The latest features, security releases, as well as library updates are all delivered...

System Settings

Official Documentation

System Settings You can make System-scoped configurations from Control Panel → Configuration → System Settings. The System Settings application shows configuration sections underneath four...

Understanding Configuration Scope

Official Documentation

Understanding Configuration Scope Liferay DXP settings are applied at four levels, or scopes: System, Virtual Instance, Site, and Widget. System Settings define the system-wide defaults. For all...

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

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

Setting Up Liferay

Official Documentation

Setting Up Liferay After installing Liferay, configure it to meet your needs. Here are common setup tasks. Setup Tasks Preconfigure the System Activate Liferay (Subscription Required) ...

Portal Properties

Portal Properties Configuration options are specified using Portal Properties, sets of name/value pairs read from properties files and Docker environment variables on server startup. Default values...

Initial Instance Localization

Official Documentation

Initial Instance Localization Liferay DXP supports localization by language, time zone, and more. The English (US) language translation and UTC time zone are the defaults, but DXP has over 40...

Database Templates

Database Templates Below are templates (example portal properties and Docker environment variables) for configuring various databases as a built-in data source for Liferay DXP. MariaDB Portal...

2025.Q3 Default Setting and Feature Flag Changes

Official Documentation

2025.Q3 Default Setting and Feature Flag Changes Most new versions of Liferay DXP include changes to the default settings. If you rely on the defaults from your old version, review the changes and...

Providing Files to the Container

Official Documentation

Providing Files to the Container The Liferay container uses the files you provide to execute the following use cases: Configure Liferay with .properties Files and .config files Configure Tomcat...

Upgrading via Docker

Upgrading via Docker Running a Liferay Docker image with auto-upgrade enabled uses the Database Upgrade Tool to upgrade your database transparently on Liferay startup. After the upgrade completes,...

Container Lifecycle and API

Official Documentation

Container Lifecycle and API At a high level, the container starts Tomcat with Liferay deployed on it. Additionally, however, the container entry point provides an API for executing these use cases:...

Preparing for an Upgrade

Official Documentation

Preparing for an Upgrade Preparation and planning may be of little consequence for small, casual installations but is mandatory for large enterprise-level installations. There are specific...

Using Liferay Docker Images

Official Documentation

Using Liferay Docker Images Docker Hub hosts Liferay DXP and Liferay Portal Docker images, bundled with Tomcat on Linux. The Liferay Docker Hub pages provide image details and tags for the...

Propagating Fragment Changes

Official Documentation

Propagating Fragment Changes By default, changes made to a custom fragment's code are not propagated to deployed instances of the fragment. Using fragment propagation, you can propagate changes to...

Configuring Containers

Official Documentation

Configuring Containers Everything that is configurable in a Liferay installation is configurable in a Liferay Docker container. Here are the most common things to configure: JVM Options Portal...

Running Scripts in Containers

Official Documentation

Running Scripts in Containers If there's more that you want to do in the Liferay container beyond setting up Tomcat and Liferay files, deploying arifacts, and applying patches, you can use scripts....

Exporting/Importing Widget Data

Official Documentation

Exporting/Importing Widget Data Export data from individual widget instances without affecting the rest of the site. Many widgets support exporting and importing their data separately, including: ...

Configuring Locked Pages

Official Documentation

Configuring Locked Pages Liferay DXP 2023.Q3+/Portal GA92+ Liferay locks pages during editing to avoid conflicts when multiple users try to edit the same page. This feature works with content,...

Search Results