Site Search - Liferay Learn

Search Pages and Widgets Liferay's default search page is at . You can create your own page from scratch or reuse the existing page, adding or removing Search widgets as you like.

Folder Facet

Official Documentation

Folder Facet The Folder Facet narrows search results down to content found in specific Asset Folders. Note that the search match is not for folder names but for content found in the folders. ...

Tag Facet

Official Documentation

Tag Facet The Tag Facet narrows search results for any assets with tags that match the search keyword. Each match appears as a facet term. Example of tag facet results. Configuring the Tag Facet...

User Facet

Official Documentation

User Facet The User Facet narrows search results down to those created by certain Users. Example of user facet results. Configuring the User Facet To configure the User Facet, open the Options...

Custom Facet

Official Documentation

Custom Facet The Custom Facet is unique among the out-of-the-box search facets. Rather than always grouping results by a single static field (like the modified date or the asset type), you can...

Modified Facet

Official Documentation

Modified Facet The Modified Facet narrows search results down to those that match the searched keyword and results that were created or modified during a certain time period. Example of modified...

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

Type Facet

Official Documentation

Type Facet The Type Facet narrows search results down to those associated with a certain Asset Type. Each Type with content matching the searched keyword appears as a facet term. Example of type...

Search Insights

Official Documentation

Search Insights This feature is intended for testing and development. The Search Insights Widget, when added to a Search Page, is for inspecting two things: The query string that's constructed...

Enabling Search Suggestions

Official Documentation

Enabling Search Suggestions Search terms can be suggested to users when their initial queries can be improved. Spell check settings allow administrators to configure the Search application so that...

Sorting Search Results

Official Documentation

Sorting Search Results Search results displayed in the Search Results widget are ordered by relevance score (as calculated by the search engine) by default. With the Sort widget, users can control...

Similar Results

Official Documentation

Similar Results Subscription [Bundled with DXP 7.3 and 7.4; Liferay Marketplace for DXP 7.2 SP2+/FP5+](https://web.liferay.com/marketplace/-/mp/application/172465398) This feature does not work...

Using Search Widget Templates

Official Documentation

Using Search Widget Templates The default search widgets views are useful, but your site's widgets likely need a specific design. You can choose from one of the available widget templates or create...

Working with Search Pages

Official Documentation

Working with Search Pages Search Pages Creating a Search Page Using a Search Page Template

Search Results

Official Documentation

Search Results Search Results Configuring the Search Results Widget Sorting Search Results Filtering Search Results Custom Filter Examples Enabling Search Suggestions Search Results...

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

Using the Search Results Widget

Official Documentation

Using the Search Results Widget Search results should be easy to navigate, sort, and filter. Give your users an optimal search experience by understanding the default search experience and the many...

Understanding Low Level Search Options

Official Documentation

Understanding Low Level Search Options Low level search works only with Elasticsearch. Low level search doesn't go through the Search and Indexing Framework, which is infrastructure used for...

Using the Custom Filter Widget

Official Documentation

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

Creating a Search Page

Official Documentation

Creating a Search Page You can create and configure a search page for your Site if you choose not to base it on an existing search page template. This approach is preferable if you do not want to...

Search Pages

Official Documentation

Search Pages Access the default search page at localhost:8080/web/guest/search. If you have a running Liferay DXP with some content in it, you can navigate there and execute a search. By default,...

Using a Search Page Template

Official Documentation

Using a Search Page Template The default search page is backed by a Global scope page template. Manually created search pages can use that same template as a baseline. Out-of-the-box, the Search...

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

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

Getting Started with Elasticsearch

Official Documentation

Getting Started with Elasticsearch Compatibility: See the Search Engine Compatibility Matrix for details on the compatible Elasticsearch versions, available Liferay connectors, and required...

Installing Elasticsearch

Official Documentation

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

Developer Guide

Official Documentation

Developer Guide Contributing Custom Content to the Similar Results Widget Search Queries and Filters Aggregations Model Entity Indexing APIs Search Headless APIs

Search Queries and Filters

Official Documentation

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

Troubleshooting the Elasticsearch Connection

Official Documentation

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

Backing Up Elasticsearch

Official Documentation

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

Securing Elasticsearch

Official Documentation

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

Upgrading to Elasticsearch 7

Official Documentation

Upgrading to Elasticsearch 7 7.1 and 7.2 Liferay's connection to Elasticsearch 7.17.x servers is deprecated due to the End of Life for Elasticsearch 7.17. Connecting to a deprecated Elasticsearch...

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

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

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

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

Custom Element Examples

Official Documentation

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

Search

Official Documentation

Search You can use the search page to find content available on a Liferay site. This can be web content, knowledge base articles, documents, images, products, etc. The search page contains a search...

Deactivating Liferay Enterprise Search

Official Documentation

Deactivating Liferay Enterprise Search Starting with Liferay DXP 7.4 and in all quarterly releases, the Liferay Enterprise Search (LES) features are included out-of-the-box. You can begin using LES...

Cross Cluster Replication

Official Documentation

Cross Cluster Replication Cross Cluster Replication Configuring an Example Cross Cluster Replication Installation Configuring a Cross Cluster Replication in a Remote Leader Data Center ...

Elasticsearch Indexes Reference

Official Documentation

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

Exploring Indexed Fields

Official Documentation

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. The available index fields can...

Configuring Search Bar Suggestions

Official Documentation

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

Category Facet

Official Documentation

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

Custom Filter Examples

Official Documentation

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

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

Configuring the Search Results Widget

Official Documentation

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

Search Results Widget Template Reference

Official Documentation

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

Limiting the Number of Search Results and Mitigating "Result window is too large." Errors when Using Elasticsearch via index.search.limit and index.max_result_window

Troubleshooting

Every functionality that relies on search engine queries in Liferay can return a maximum of 10,000 results by default. This applies to Search Bar widget searches, search toolbar searches, search REST API usages, and...

Empty searches return no results using a Text Match Over Multiple Fields blueprint element

legacy Troubleshooting

Issue When a Blueprint is configured with the Text Match Over Multiple Fields element, performing an empty search yields no results. Environment Liferay DXP 7.4 U5+ Liferay DXP Quarterly Releases Resolution Text...

How Blueprints Work in Liferay while using Fuzziness?

legacy

Issue How Blueprints Work in Liferay while using Fuzziness? Environment Liferay Quarterly Release Resolution Example case: 1.) Create new environment. 2.) Create new blueprint 3.) Open preview 4.) Add Text...

Running script to import Result Rankings data fails

legacy Troubleshooting

Issue When attempting to run the script from step 2 on Importing the Search Tuning Indexes in 7.4 to import the Result Rankings data, execution fails with the following errors: startup failed: Script1.groovy: 3: unable to...

Hindi Month Names Are Truncated in Search Results

legacy Troubleshooting

Issue After adding the JVM argument -Djava.locale.providers=CLDR, long month names in Hindi get truncated in search results. Example: "सितंबर 07, 2001" to "सितं 07, 2001" Environment Liferay DXP 2023.Q4 Resolution...

Blueprints Display External Reference Codes (ERC)

legacy

Issue After updating Liferay, Blueprints configuration now displays External Reference Codes (ERC) next to the categories, sites and other elements. Environment 2024.Q4+ Resolution This change was implemented in...

Upgrading to a Quarterly Release fails due to Elasticsearch exceptions in the logs

legacy Troubleshooting

Issue When upgrading to a Quarterly Release, coming from an old DXP version, the upgrade fails because of some Elasticsearch errors that can be seen in the logs: ERROR [main][ROOT:47] bundle...

"Elasticsearch node search-1 does not meet the minimum version requirement of 7.16" when updating to u30

legacy Troubleshooting

Issue During our recent update to Update 30, the portal experienced an issue and did not start correctly. The logs show the following error: Elasticsearch node search-1 does not meet the minimum version requirement...

Search Blueprints feature is not shown in Liferay

legacy Troubleshooting

Issue According to this documentation, Search Blueprints, the Search Blueprints functionality is available in DXP 7.3 starting with Update 6. However, after installing DXP 7.3 Update 6, the Search Blueprints...

AssetTagException when using special characters in tag names

legacy

Issue AssetTagException is thrown when the article gets published, in case special characters are used in tag names. 2020-06-23 07:16:18.168 ERROR [http-nio-10.155.2.197-443-exec-4][PortletServlet:112]...

Users Not Appearing in Control Panel After Upgrading Liferay Version

legacy Troubleshooting

Issue Users are not appearing in the Control Panel > Users > Users and Organizations section after upgrading to a newer Liferay version. Environment Liferay DXP 7.0, 7.1 Resolution 1. Remove...

Updating Elasticsearch certificates for x-pack security

legacy Troubleshooting

, knowledgeArticleType: troubleshooting, legacy: true, name: Updating Elasticsearch certificates for x-pack security, showDisclaimerMessage: true, sourceTeam: Support, ticketNumber: 95203, title:...