Search Results

All Results 6974
Sort By
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
Object APIs
Object APIs You can use headless APIs to interface with objects and picklists. Here are resources to help you understand and integrate these APIs to enhance your ability to manage objects.
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...
Managing Object Entry Versions
Official Documentation
Managing Object Entry Versions Liferay DXP 2025.Q4+/Portal 2026.Q1+ Object entry versioning is used in Liferay's Content Management System (CMS). To use versioning with a custom object's entries,...
Using Aggregation Terms with REST APIs
Official Documentation
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...
Using Batch APIs
Official Documentation
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...
Using nestedFields to Audit Entry History
Official Documentation
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...
Using nestedFields to Query Related Entries
Official Documentation
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...
Using Object APIs With Base64 Encoded Files
Official Documentation
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...
Using Relationship REST APIs
Official Documentation
Using Relationship REST APIs Liferay 7.4 U70+/GA70+ When you add relationships to custom or system objects, Liferay generates REST endpoints for accessing those relationships. You can relate and...
Picklists API Basics
Official Documentation
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...
Process Automation APIs
Process Automation APIs You can use headless APIs to interface with automation features in Liferay DXP, including workflows. Here are resources to help you understand and integrate these APIs to...
Search APIs
Official Documentation
Search APIs Generally Available in Liferay DXP 2025.Q4+/Portal 2026.Q1+ You can search with headless APIs using the endpoints at /o/search. These are the primary endpoints: Use the GET /search...
Search API Basics
Official Documentation
Search API Basics Generally Available in Liferay DXP 2025.Q4+/Portal 2026.Q1+ You can search for content from a Liferay search page, but you can also use the /search API endpoints. If you're...
Notifications API Basics
Official Documentation
Notifications API Basics Liferay's headless delivery application provides REST and GraphQL services for subscribing to or unsubscribing from notifications for platform events across several default...
Workflow Definition Link API Basics
Official Documentation
Workflow Definition Link API Basics Liferay DXP 2025.Q1+/Portal GA132+ You can manage workflow definition links from the Liferay UI or using Liferay's REST APIs. In Liferay, the Control Panel →...
Search Suggestions API
Official Documentation
Search Suggestions API DXP 7.4 U36+/Portal GA36+ You can return suggestions using the /suggestions headless API. This API is used by Liferay's Search Bar Suggestions feature. There are two primary...
Site APIs
Official Documentation
Site APIs Use Liferay’s REST APIs to manage site elements programmatically. This guide introduces the Navigation Menu API and shows how to create, retrieve, update, and delete navigation menus...
Navigation Menu API Basics
Official Documentation
Navigation Menu API Basics Liferay's REST APIs provide services for Liferay's navigation menus. You can create and edit navigation menus with the API. Start by seeing an example of adding a new...
Form Reports
Official Documentation
Form Reports 7.3, 7.4 Once users begin submitting form entries, you can access a field-by-field report on the form's records: Navigate to the Forms application. In the Product Menu (Product...
Managing Form Entries
Official Documentation
Managing Form Entries Once users begin submitting form entries, you can access the form entry data through the UI or export the data to a different file format for further analysis and review. ...
Using Forms with a Workflow
Official Documentation
Using Forms with a Workflow The Forms application is integrated with the Workflow application and therefore users can activate a workflow process for a form. This means that before a form's entry...
Notifications
Official Documentation
Notifications Liferay provides integrated notification tools to alert users to platform events. For Liferay DXP, this includes email and website notifications for the following default...
Configuring Personal Notifications
Official Documentation
Configuring Personal Notifications Liferay provides integrated notification tools, so you can ensure users are alerted to platform events. Users can customize which notifications they receive by...
Enabling CAPTCHA on Form Submissions
Official Documentation
Enabling CAPTCHA on Form Submissions CAPTCHA can be enabled to deter automated form submissions. To enable CAPTCHA: Click the form's Options (Options) and select Settings. Navigate to the Form...
Redirecting Users on Form Submission
Official Documentation
Redirecting Users on Form Submission By default, when a user submits a form response, they are directed to a success page. This behavior can be configured to instead redirect a user to a specific...
Sharing Forms
Official Documentation
Sharing Forms There are two ways to share a form: Placing the Form widget on a site page and configuring the widget to display the particular form. This allows the form to be seen and submitted...
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...
Creating Notification Templates
Official Documentation
Creating Notification Templates Liferay DXP 2023.Q4+/Portal GA102+ With Notification Templates, you can design automated email and user notifications for Liferay services. Each template identifies...
Objects
Official Documentation
Objects Liferay 7.4+ With Liferay Objects, you can build and deliver applications without having to write code or deploy modules. Each application built with Objects is integrated with Liferay's...
Using the Notification Queue
Official Documentation
Using the Notification Queue Liferay 7.4 U75+/GA75+ Liferay provides the Notification Queue application for reviewing email notifications triggered by an object action. You can verify the status...
Creating and Managing Objects
Official Documentation
Creating and Managing Objects Liferay 7.4+ Liferay Objects provides a convenient UI for creating custom applications that meet your business needs without writing code. You can also use Objects to...
Actions
Official Documentation
Actions Object actions define custom business logic that you can run manually or automatically for object entry events. Examples include delivering entry event data to a webhook URL, sending email...
Defining Object Actions
Official Documentation
Defining Object Actions Liferay 7.4 U60+/GA60+ Object actions define operations that you can run manually or automatically for object entry events. To add an action, Open the Global Menu (...
Understanding Action Types
Official Documentation
Understanding Action Types Liferay 7.4 U60+/GA60+ Actions define custom operations triggered by object entry events. Liferay provides these action types: TypeDescription NotificationSend email or...
Using Manual Actions
Official Documentation
Using Manual Actions Liferay 7.4 U60+/GA60+ When you use the standalone trigger for object actions, the actions become manual instead of automatic. Trigger these actions using these methods: ...
Activating and Deactivating Objects
Official Documentation
Activating and Deactivating Objects Custom objects are activated when published. While active, you can use the object to create entries via the Liferay UI or dedicated REST APIs. If needed, you can...
Creating Objects
Official Documentation
Creating Objects Liferay DXP 2023.Q4+/Portal GA102+ Liferay Objects provides development capabilities in the Liferay UI. Using Objects, you can build fully integrated Liferay applications without...
Auditing Object Events
Official Documentation
Auditing Object Events Liferay 7.4 U72+/GA72+ You can use Liferay's audit framework to track events for custom object definitions and their entries. To track entry events, you must enable entry...
Deleting Objects
Official Documentation
Deleting Objects Liferay 7.4 U26+/GA26+ You can delete draft and published object definitions. Deleting a definition removes its associated data, including the stored entries for published...
Exporting and Importing Object Definitions
Official Documentation
Exporting and Importing Object Definitions Liferay 7.4 U68+/GA68+ You can export and import object definitions as .json files. These files include the definition's complete schema (e.g.,...
Extending Unmodifiable System Objects
Official Documentation
Extending Unmodifiable System Objects Liferay 7.4 U86+/GA86+ With Liferay Objects, you can extend supported system services. These services are integrated with the Objects framework as...
Fields
Official Documentation
Fields Liferay DXP 2023.Q4+/Portal GA102+ Object fields are data definitions that represent database columns and store different types of values. All objects include default system fields, but you...
Adding and Managing Custom States
Official Documentation
Adding and Managing Custom States Liferay 7.4+ Some use cases may require assigning multiple states to an object entry at the same time. For example, when building an Order application, you may...
Adding Fields to Objects
Official Documentation
Adding Fields to Objects Liferay DXP 2023.Q4+/Portal GA102+ Fields are data definitions that represent database columns and store different types of values. By default, all objects include these...
Aggregation Fields
Official Documentation
Aggregation Fields Liferay 7.4 U47+/GA47+ Aggregation fields perform basic calculations on the entries from a relationship table and display the resulting values. Available aggregation functions...
Attachment Fields
Official Documentation
Attachment Fields Attachment fields are for uploading files to your instance's Document Library. When uploaded, the file is linked to the entry's attachment field. Each field can only be linked to...
Assignee Fields
Official Documentation
Assignee Fields Liferay DXP 2025.Q4+/Portal 2026.Q1+ Assignee fields are for selecting existing users or roles in the object entry. Assigned users can edit the entry with no manual permission...
Auto-Increment Fields
Official Documentation
Auto-Increment Fields DXP 2024.Q1+/Portal GA112+ Auto-Increment fields are configurable read-only fields for uniquely identifying object entries in a human-readable format. For example, an IT...
Encrypted Fields
Official Documentation
Encrypted Fields Self-Hosted and PaaS Only Liferay 7.4 U72+/GA72+ Liferay provides the encrypted field type for storing sensitive user data. To use encrypted fields, first add an encryption...
Formula Fields
Official Documentation
Formula Fields Liferay DXP 2023.Q4+/Portal GA102+ Formula fields provide read-only values calculated using numeric fields in the object definition. Unlike other fields, formula values are...
Upgrading to Elasticsearch 8
Official Documentation
Upgrading to Elasticsearch 8 7.4 U81+, 7.3 U31+ Elasticsearch 8 is supported and recommended for the latest Liferay DXP Quarterly and Portal GA release out of the box. For specific version...
Installing a Search Engine
Official Documentation
Installing a Search Engine A search engine is a critical component of your Liferay installation. Creating an Example Cluster can get you started with the installation, but this guide demonstrates...
Installing OpenSearch
Official Documentation
Installing OpenSearch Subscription Required [Beta Feature](../../../security-and-administration/administration/configuring-liferay/feature-flags.md) You can connect OpenSearch with Liferay. For...
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...
Solr
Official Documentation
Solr Solr is in maintenance mode in Liferay 7.4. Solr Limitations Installing Solr
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...
OpenSearch
Official Documentation
OpenSearch Subscription Required [Beta Feature](../../security-and-administration/administration/configuring-liferay/feature-flags.md) Elasticsearch is Liferay's native search engine. Beginning...
OpenSearch Connector Configuration Reference
Official Documentation
OpenSearch Connector Configuration Reference Subscription Required [Beta Feature](../../../security-and-administration/administration/configuring-liferay/feature-flags.md) Configure Liferay's...
Liferay Enterprise Search
Official Documentation
Liferay Enterprise Search Liferay's Enterprise Search (LES) features significantly upgrade the default search capabilities. With a LES subscription you gain the following benefits: Search...
Solr Limitations
Official Documentation
Solr Limitations Liferay's Solr implementation has limitations. Some Liferay features and APIs cannot be used when you choose Solr as the search engine. Install Elasticsearch for the best...