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
Search Suggestions API
Search Suggestions API DXP 7.4 U36+/Portal GA36+ You can return suggestions with the using the /suggestions headless API. This API is used by Liferay's Search Bar Suggestions feature. There are...
Published Date: Sep 7, 24, 3:46 PM
Getting Started
Getting Started
Published Date: May 9, 24, 6:59 PM
Developer Guide
Developer Guide Contributing Custom Content to the Similar Results Widget Search Queries and Filters Aggregations Model Entity Indexing APIs Search Headless APIs
Published Date: Jan 18, 25, 2:51 AM
Search Queries and Filters
Search Queries and Filters To get sensible results from the search engine, you must provide a sensible query. Liferay's query APIs are in the portal-search-api module and are used to construct both...
Published Date: Jan 18, 25, 2:51 AM
Search API
Search API [Release Feature](../../../system-administration/configuring-liferay/feature-flags.md#release-feature-flags) 7.4 U88+ and GA88+ You can search for content from a Liferay search page,...
Published Date: Sep 7, 24, 3:46 PM
Search Overview
Search Overview Search is a fundamental component of Liferay. Elasticsearch is bundled with Liferay for testing and development purposes. Production environments require Elasticsearch running on a...
Published Date: May 9, 24, 6:59 PM
Search Headless APIs
Search Headless APIs You can search with headless APIs using the endpoints at /o/search. Search Headless APIs Availability The first search headless endpoint, /portal-search-rest, was released...
Published Date: May 9, 24, 6:59 PM
Contributing Custom Content to the Similar Results Widget
Contributing Custom Content to the Similar Results Widget Subscribers Availability: This functionality relies on a Service Provider Interface (SPI) that's bundled with Liferay DXP 7.3+. It's...
Published Date: May 9, 24, 6:59 PM
Getting Started with Elasticsearch
Getting Started with Elasticsearch Compatibility: See the Search Engine Compatibility Matrix for details on the compatible Elasticsearch versions, available Liferay connectors, and required...
Published Date: Jan 18, 25, 2:51 AM
Exercise: Run Liferay and Elasticsearch Using Docker
Exercise: Run Liferay and Elasticsearch Using Docker 7.3+ Here you can walk through a minimal Liferay-Elasticsearch setup on your local machine to see how a secure REST Client connection between...
Published Date: May 9, 24, 6:59 PM
Securing Elasticsearch
Securing Elasticsearch The very first thing you must do to secure Elasticsearch is enable X-Pack Security. After that you can begin configuring authentication and encrypted communication. ...
Published Date: Jan 18, 25, 2:51 AM
Installing Elasticsearch
Installing Elasticsearch Here's how to install, configure, and start Elasticsearch on-premises. If you have Elasticsearch indexes used for primary data storage (storing data not backed by a...
Published Date: Jan 18, 25, 2:51 AM
What's New in Search for 7.3?
What's New in Search for 7.3? Elasticsearch Integration Elasticsearch 7 Support Availability: Liferay CE 7.3 GA4+, Liferay DXP 7.3 GA1+ Liferay DXP 7.3 comes with out-of-the-box support for...
Published Date: May 9, 24, 6:59 PM
Connecting to Elasticsearch
Connecting to Elasticsearch After setting up Elasticsearch, connect it to Liferay using the Liferay Connector to Elasticsearch. Connection steps depend on the connector you're configuring. See...
Published Date: May 9, 24, 6:59 PM
Searching for Content
Searching for Content All indexed content (a.k.a. assets in Liferay DXP) can be returned as search results. Custom content can also be indexed, so your installation might have additional asset...
Published Date: May 9, 24, 6:59 PM
Installing and Upgrading a Search Engine
Installing and Upgrading a Search Engine A search engine is a critical component of your Liferay installation. Creating an Example Cluster can get you started with an Elasticsearch installation,...
Published Date: May 9, 24, 6:59 PM
Elasticsearch
Elasticsearch Elasticsearch is the highly scalable, full-text search engine Liferay uses by default. Elasticsearch is bundled with Liferay for non-production purposes. In production, Liferay...
Published Date: May 9, 24, 6:59 PM
Elasticsearch Connector Configuration Reference
Elasticsearch Connector Configuration Reference The configuration information here applies to the latest available (bundled or through Marketplace) version of the Elasticsearch 6 and Elasticsearch...
Published Date: May 9, 24, 6:59 PM
What's New in Search for 7.4?
What's New in Search for 7.4? There are several highlights and new features added to Liferay's search infrastructure for the 7.4 release. New features include those added to the product for Liferay...
Published Date: May 9, 24, 6:59 PM
Advanced Configuration of the Liferay Elasticsearch Connector
Advanced Configuration of the Liferay Elasticsearch Connector The Elasticsearch connection is configured using a configuration file or via System Settings. The Elasticsearch connector has a lot of...
Published Date: May 9, 24, 6:59 PM
Troubleshooting the Elasticsearch Connection
Troubleshooting the Elasticsearch Connection Listed here are some connection issues you can encounter when configuring the Liferay-Elasticsearch connection, along with the most common solutions to...
Published Date: Jan 18, 25, 2:51 AM
Backing Up Elasticsearch
Backing Up Elasticsearch Elasticsearch replicas protect against a node going down, but they won't help you with a catastrophic failure. Only good backup practices can help you then. Backing Up...
Published Date: Jan 18, 25, 2:51 AM
Upgrading Elasticsearch
Upgrading Elasticsearch Liferay supports Elasticsearch 8. The compatibility matrix provides the latest support details. Solr is in maintenance mode in Liferay 7.4. Elasticsearch 6.x is not...
Published Date: May 9, 24, 6:59 PM
Troubleshooting Elasticsearch: Common Issues
Troubleshooting Elasticsearch: Common Issues Listed here are some common issues you may encounter while configuring Elasticsearch and Liferay. Additional connection-specific errors are discussed in...
Published Date: May 9, 24, 6:59 PM
Troubleshooting Elasticsearch Installation
Troubleshooting Elasticsearch Installation Liferay and Elasticsearch are complex systems full of configurations. When connecting them, you can run into difficulty along the way. Included below are...
Published Date: May 9, 24, 6:59 PM
Upgrading Search Infrastructure
Upgrading Search Infrastructure While upgrading Liferay, you must account for the search experience when using Elasticsearch. The exact steps depend on your existing search engine installation and...
Published Date: May 9, 24, 6:59 PM
Upgrading to Elasticsearch 7
Upgrading to Elasticsearch 7 7.1 and 7.2 Liferay 7.3 and 7.4 support Elasticsearch 7 out of the box. To find the latest available search engine version for your Liferay installation, see the...
Published Date: Jan 18, 25, 2:51 AM
Upgrading to Elasticsearch 8
Upgrading to Elasticsearch 8 7.4 U81+, 7.3 U31+ Elasticsearch 8 is supported and recommended for the latest Liferay 7.4 Update and GA release out of the box. For specific version compatibility...
Published Date: May 9, 24, 6:59 PM
Installing a Search Engine
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...
Published Date: May 9, 24, 6:59 PM
Installing OpenSearch
Installing OpenSearch Subscription Required [Beta Feature](../../../system-administration/configuring-liferay/feature-flags.md) You can connect OpenSearch with Liferay. For detailed OpenSearch...
Published Date: Nov 28, 24, 3:14 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, 24, 6:59 PM
OpenSearch
OpenSearch Subscription Required [Beta Feature](../../system-administration/configuring-liferay/feature-flags.md) Elasticsearch is Liferay's native search engine. Beginning with Liferay DXP...
Published Date: Nov 28, 24, 3:14 PM
OpenSearch Connector Configuration Reference
OpenSearch Connector Configuration Reference Subscription Required [Beta Feature](../../../system-administration/configuring-liferay/feature-flags.md) Configure Liferay's connection to OpenSearch...
Published Date: Nov 28, 24, 3:14 PM
Using the Sidecar or Embedded Elasticsearch
Using the Sidecar or Embedded Elasticsearch The Liferay Tomcat bundles installed via a ZIP file or Docker image include an Elasticsearch node that starts with Liferay. The node in Liferay 7.3+ and...
Published Date: Jan 18, 25, 2:51 AM
Solr Limitations
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...
Published Date: May 9, 24, 6:59 PM
Liferay Enterprise Search
Liferay Enterprise Search A Liferay Enterprise Search (LES) subscription provides access and support for additional search features. Detailed installation and usage instructions are available in...
Published Date: May 9, 24, 6:59 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: May 9, 24, 6:59 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: May 9, 24, 6:59 PM
Configuring an Example CCR Installation: Replicating Between Data Centers
Configuring an Example CCR Installation: Replicating Between Data Centers Liferay Enterprise Search (LES) Subscribers This example configures Liferay DXP's Cross-Cluster Replication module and...
Published Date: May 9, 24, 6:59 PM
Solr
Solr Solr is in maintenance mode in Liferay 7.4. Solr Limitations Installing Solr
Published Date: May 9, 24, 6:59 PM
Configuring CCR in a Local Follower Data Center
Configuring CCR in a Local Follower Data Center First configure CCR in the remote/leader data center before following the steps below. The local/follower data center holds Liferay DXP cluster...
Published Date: May 9, 24, 6:59 PM
Cross-Cluster Replication
Cross-Cluster Replication Liferay Enterprise Search (LES) Subscribers In a classic Liferay DXP/search engine installation, one Liferay DXP cluster talks to one Elasticsearch cluster, sending all...
Published Date: May 9, 24, 6:59 PM
Configuring CCR In a Remote Leader Data Center
Configuring CCR In a Remote Leader Data Center Ensure you have completed the necessary prerequisite steps before following the steps below. This data center holds Liferay DXP cluster nodes with a...
Published Date: May 9, 24, 6:59 PM
Configuring CCR: Settings Reference
Configuring CCR: Settings Reference To help with the CCR configuration process, the example configurations from the step-by-step instructions in this guide are collected here. These configuration...
Published Date: May 9, 24, 6:59 PM
Learning to Rank
Learning to Rank Liferay Enterprise Search (LES) Subscribers Search engines like Elasticsearch have well-tuned relevance algorithms, good for general search purposes. LES Learning to Rank...
Published Date: May 9, 24, 7:00 PM
Troubleshooting Cross-Cluster Replication
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...
Published Date: May 9, 24, 7:00 PM
Monitoring Elasticsearch
Monitoring Elasticsearch [LES Subscription](./activating-liferay-enterprise-search.md) If you have a Liferay Enterprise Search (LES) subscription, you can integrate Elastic's Kibana monitoring UI...
Published Date: May 9, 24, 7:00 PM
Predefined Element Variables Reference
Predefined Element Variables Reference In the Element Source editor, place the cursor in the desired location and click the variable in the left hand sidebar to insert it. In the Custom JSON...
Published Date: May 9, 24, 7:00 PM
Search Experiences
Search Experiences [LES Subscription](./activating-liferay-enterprise-search.md) DXP 7.4 U5+; 7.3 U6+ The Liferay Enterprise Search Experiences app includes a suite of features granting...
Published Date: May 9, 24, 7:00 PM
Collections with Search Blueprints
Collections with Search Blueprints 7.4 U88+ [Beta Feature](../../../../system-administration/configuring-liferay/feature-flags.md) When you create a search blueprint, a collection provider is...
Published Date: May 9, 24, 7:00 PM
Search Blueprints
Search Blueprints [LES Subscription](../activating-liferay-enterprise-search.md) DXP 7.4 U5+; 7.3 U6+ Search Blueprints is the first feature in the Search Experiences application. With it you can ...
Published Date: May 9, 24, 7:00 PM
Collapsing Search Results
Collapsing Search Results Liferay DXP 2023.Q4+ You can collapse search results that have identical keyword field values. For example, an internal blog titled Employee of the Month produces...
Published Date: May 9, 24, 7:00 PM
Creating and Managing Elements
Creating and Managing Elements Elements are one of the fundamental building blocks of Search Blueprints and are managed within the Blueprints application. Open the Global Menu's Applications...
Published Date: May 9, 24, 7:00 PM
Creating Elements
Creating Elements There are a lot of system Elements that ship with Search Blueprints. If none of the system Elements meets your needs, there are many ways to create your own Search Blueprints...
Published Date: May 9, 24, 7:00 PM
Custom Element Examples
Custom Element Examples Here are example elements that use custom fields and nested fields in their contributed query clauses. Using Custom Fields (Expando) in Elements You can add custom fields...
Published Date: Jan 11, 25, 4:54 PM
Managing Elements
Managing Elements To create new Elements, click Add (Add). See Creating Elements for more details. As of Liferay DXP 2023.Q4+, the title and description fields are localizable. To provide...
Published Date: May 9, 24, 7:00 PM
Reindexing Modes
Reindexing Modes Liferay 2023.Q4+/GA102+ Reindexing is refreshing all or part of the search index that's used for searching, and in some cases displaying, Liferay's content. Execute a reindex from...
Published Date: May 9, 24, 7:00 PM
Result Rankings
Result Rankings Subscribers This feature does not work with Solr. Result Rankings are for changing the list of returned results for specific keywords. With Results Rankings you can Designate...
Published Date: May 9, 24, 7:00 PM
Sorting Results in a Search Blueprint
Sorting Results in a Search Blueprint Add a sort configuration to search blueprints to control the order of search results: Open the Global Menu (Global Menu), click the Applications tab, and...
Published Date: May 9, 24, 7:00 PM
Understanding Search Blueprints
Understanding Search Blueprints Search Blueprints is the first feature of the Search Experiences toolset. Use Blueprints to tailor the search page experience to your users' needs, without deploying...
Published Date: May 9, 24, 7:00 PM

Capabilities

Product

Education

Contact Us

Connect

Powered by Liferay
© 2024 Liferay Inc. All Rights Reserved • Privacy Policy