Capability

Search

Search Bar

Liferay Search is a fundamental component of Liferay DXP. Search obviously powers search results for your sites, but can also be tailored and configured to do much more! Use Search to build dynamic navigation menus based on categories, boost search results for important content, or use it to present a dynamic content experience for users.

Search features include Full-text Search, Indexing of all content types, Search Pages and Widgets, Search Results, and more.

Feature
Deployment Approach
Search Insights
Search Insights This feature is intended for testing and development only \ Works with Elasticsearch only The Search Insights Widget, when added to a Search Page, is for inspecting two things: ...
Published Date: May 9, 2024 7:00 PM
Enabling Search Suggestions
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...
Published Date: May 9, 2024 7:00 PM
Using Search Widget Templates
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...
Published Date: May 9, 2024 7:00 PM
Working with Search Pages
Working with Search Pages Search Pages Creating a Search Page Using a Search Page Template
Published Date: May 9, 2024 7:00 PM
Search Results
Search Results Search Results Configuring the Search Results Widget Sorting Search Results Filtering Search Results Custom Filter Examples Enabling Search Suggestions Search Results...
Published Date: May 9, 2024 7:00 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: May 9, 2024 7:00 PM
Creating a Search Page
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...
Published Date: May 9, 2024 7:00 PM
Search Pages
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,...
Published Date: May 9, 2024 7:00 PM
Using a Search Page Template
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...
Published Date: May 9, 2024 7:00 PM
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, 2024 3:46 PM
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, 2024 3:46 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: Sep 25, 2024 4:15 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: Oct 26, 2024 3:14 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, 2024 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, 2024 3:14 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, 2024 3:14 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: Dec 7, 2024 12:15 AM
Search
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...
Published Date: Jan 18, 2025 2:44 AM
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, 2025 2:51 AM
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, 2025 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, 2025 2:51 AM
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, 2025 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, 2025 2:51 AM
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, 2025 2:51 AM
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, 2025 2:51 AM
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, 2025 2:51 AM
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, 2024 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, 2024 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, 2024 6:59 PM
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, 2025 2:51 AM
Setting Up a Text Embedding Provider
Setting Up a Text Embedding Provider 7.4 U70+ [Beta Feature](../../../../system-administration/configuring-liferay/feature-flags.md) A text embedding provider has two jobs: At index time, use...
Published Date: May 9, 2024 7:00 PM
Search Configuration Reference
Search Configuration Reference Search in Liferay DXP can be configured in lots of ways. Once you understand the concept of configuration scope, you'll understand where to find a certain...
Published Date: May 9, 2024 7:00 PM
Search Facets
Search Facets Enter a keyword in the Search Bar and click the Search button. The default search experience redirects to a page with results on the right and a collection of facets on the left. ...
Published Date: May 9, 2024 7:00 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: May 9, 2024 7:00 PM
Custom Facet
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...
Published Date: May 9, 2024 7:00 PM
Folder Facet
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. ...
Published Date: May 9, 2024 7:00 PM
Modified Facet
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...
Published Date: May 9, 2024 7:00 PM
Site Facet
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...
Published Date: May 9, 2024 7:00 PM
Type Facet
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...
Published Date: May 9, 2024 7:00 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: May 9, 2024 7:00 PM
User Facet
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...
Published Date: May 9, 2024 7:00 PM
Search Results Behavior
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...
Published Date: May 9, 2024 7:00 PM
Using the Search Results Widget
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...
Published Date: May 9, 2024 7:00 PM
Understanding Low Level Search Options
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...
Published Date: May 9, 2024 7:00 PM
Sorting Search Results
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...
Published Date: May 9, 2024 7:00 PM
Similar Results
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...
Published Date: May 9, 2024 7:00 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
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, 2025 4:54 PM

Capabilities

Product

Education

Contact Us

Connect

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