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
Picklists API Basics
Picklists API Basics Liferay provides the headless-admin-list-types REST APIs for creating and managing picklist definitions (ListTypeDefinition) and their entries (ListTypeEntry). You can view and...
Published Date: May 9, 2024 6:54 PM
Managing Guest User Entries
Managing Guest User Entries When you create an object and its application UI, unauthenticated users cannot add object entries, even if you add an object-backed application to a page and grant the...
Published Date: May 9, 2024 6:54 PM
Understanding Object Integrations
Understanding Object Integrations Published custom objects are integrated with Liferay's core frameworks, so you can leverage Liferay's features to build unified experiences across the platform....
Published Date: May 9, 2024 6:54 PM
Using Aggregation Terms with REST APIs
Using Aggregation Terms with REST APIs When querying Object entries using REST APIs, you can use an Object's fields as facet criteria for aggregating entry data. To do this, add the...
Published Date: May 9, 2024 6:54 PM
Managing Object Entries Using GraphQL
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...
Published Date: Nov 22, 2024 10:50 PM
Object API Basics
Object API Basics When you publish an Object, Liferay automatically generates REST APIs for it. These APIs differ for Company and Site scoped Objects, but they all use the c/[pluralobjectlabel]...
Published Date: May 9, 2024 6:54 PM
Using Custom Object APIs
Using Custom Object APIs Liferay 7.4+ When you publish a custom object definition, Liferay generates default REST APIs for interacting with the object and its data. These APIs vary depending on...
Published Date: May 9, 2024 6:54 PM
Using nestedFields to Audit Entry History
Using nestedFields to Audit Entry History Liferay 7.4 U72+/GA72+ When you enable entry history for an object definition, you can use the nestedFields parameter with REST APIs to audit entry...
Published Date: May 9, 2024 6:54 PM
Using Batch APIs
Using Batch APIs When you publish an Object, Liferay automatically generates REST APIs for it. These include the batch APIs for bulk POST, PUT, and DELETE operations. Here you'll use cURL commands...
Published Date: May 9, 2024 6:54 PM
Using Object APIs With Base64 Encoded Files
Using Object APIs With Base64 Encoded Files Liferay DXP 2024.Q2+/Portal GA120+ When creating object entries with attachment fields through APIs, you can generally upload files from your computer...
Published Date: Jun 7, 2024 3:58 PM
Using nestedFields to Query Related Entries
Using nestedFields to Query Related Entries Liferay 7.4 U69+/GA69+ The nestedFields parameter returns multiple levels of related object entries in a single GET request. Pass the nestedFields...
Published Date: May 9, 2024 6:54 PM
Optimizing Search Response Size
Optimizing Search Response Size In rare cases, an overly large search response can result in ERROR messages from the search engine: ERROR [http-nio-8080-exec-335][ElasticsearchIndexSearcher:165]...
Published Date: May 9, 2024 7:00 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
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
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
Utility Classes
Utility Classes Util-Bridges Util-Java Util-slf4j Util-Taglib
Published Date: May 9, 2024 7:01 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
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
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
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
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
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
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
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
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
Wiki API Basics
Wiki API Basics Liferay's Headless Delivery application provides REST services for the Wiki application. With these services, you can add Wiki nodes and pages, list their information, modify their...
Published Date: May 9, 2024 6:50 PM
Scoping Your Message Boards
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
Content Management System
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
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 Wikis
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
Exploring Indexed Fields
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
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
Blog API Basics
Blog API Basics Liferay's REST APIs provide services for adding, modifying, and deleting blog posts and images. Liferay DXP 2024.Q4+/Portal GA129+ The Blogs API now uses External Reference Codes...
Published Date: May 9, 2024 6:50 PM
Message Boards API Basics
Message Boards API Basics Liferay's Headless Delivery application provides REST services for the Message Boards application. With these services, you can add message board categories, threads, and...
Published Date: May 9, 2024 6:49 PM
Wiki Permissions Reference
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
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
Elasticsearch Indexes Reference
Elasticsearch Indexes Reference Liferay 7.3 and 7.4 each have a set of indexes created in Elasticsearch. Understanding these indexes and what they do can help you better configure and administer...
Published Date: Jul 29, 2025 8:56 PM
Activating Liferay Enterprise Search
Activating Liferay Enterprise Search Starting with Liferay DXP 7.4, the Liferay Enterprise Search (LES) applications are included out-of-the-box. You can begin using LES right away, then purchase...
Published Date: Jul 29, 2025 8:56 PM
Cross Cluster Replication
Cross Cluster Replication Cross Cluster Replication Configuring an Example Cross Cluster Replication Installation Configuring a Cross Cluster Replication in a Remote Leader Data Center ...
Published Date: Jul 29, 2025 8:56 PM
Custom Filter Examples
Custom Filter Examples This feature does not work with Solr. The Custom Filter widget is a powerful aid to your search tuning efforts. Without deploying custom code, you can exert control over...
Published Date: Jul 29, 2025 8:56 PM
Configuring the Search Results Widget
Configuring the Search Results Widget Configure the Search Results widget by opening its options menu (Options) and selecting Configuration. The display of Search Results is configured in the...
Published Date: Jul 29, 2025 8:56 PM
Category Facet
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
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
Configuring Search Bar Suggestions
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
Using the Custom Filter Widget
Using the Custom Filter Widget This feature does not work with Solr. With Custom Filters, you can contribute queries to the main search query, filtering search results to control what's returned...
Published Date: May 9, 2024 7:00 PM
Search Results Widget Template Reference
Search Results Widget Template Reference While creating a search results widget template, you can access pre-populated variables in the FreeMarker template editor. The variables listed in the...
Published Date: Jul 29, 2025 8:56 PM
Managing Third-Party Cookies
Managing Third-Party Cookies Liferay DXP 2024.Q1+/Portal GA112+ Third-party cookies are generated by domains different from the one a user is currently visiting. These cookies are often used by...
Published Date: Nov 22, 2024 10:53 PM
System for Cross-domain Identity Management (SCIM)
System for Cross-domain Identity Management (SCIM) Liferay DXP 2024.Q1+ System for Cross-domain Identity Management or SCIM, is an open standard that automates user provisioning. In other words,...
Published Date: May 9, 2024 6:52 PM
Enabling GDPR Compliance for Cookies
Enabling GDPR Compliance for Cookies You can ensure GDPR compliance for your cookies using Liferay's configuration interface. Open the Global Menu (Global Menu), and navigate to Control Panel →...
Published Date: May 9, 2024 6:59 PM
Types of Utility Pages
Types of Utility Pages Utility pages are content pages managed at the site level. Since the default system-level pages are not customizable, you can use site-level utility pages to provide a unique...
Published Date: Nov 22, 2024 10:52 PM
Jakarta 2025 FAQ
Jakarta 2025 FAQ Liferay DXP is evolving! To continue providing you with the most advanced and secure platform, Liferay is transitioning its underlying enterprise platform from Java EE 8 to Jakarta...
Published Date: Jul 26, 2025 1:16 PM
Reference
Reference Note: These pages contain the latest Liferay reference documentation. You can download reference documentation for older releases from Github here. :::: 2 :gutter: 3 3 3 3 ::: DXP...
Published Date: May 9, 2024 7:01 PM