Topics

All topics

Site search API

Sitefinity CMS Search uses the Publishing system in order to collect data that should be indexed. It registers the SearchIndexOutboundPipe that listens for changes in Sitefinity CMS and pushes them to the search index, using the active Search service.

The following diagram shows how a page content is pushed to the Search service index when the user publishes it. Other content in Sitefinity CMS is indexed in a similar manner. The difference between indexing different content types is that each of them comes from a different InboundPipe.

This section contains

CRUD operations for a search index
The sample in this article demonstrates how you can use the API to create, update, and delete a search index and how you can perform a search operation.
Connect to search service
Connect to third party search service by implementing the ISearchService interface and replacing the registration using ServiceBus.RegisterService(service).
Customize the Lucene search scoring
Sitefinity CMS versions 11.1 and above exposes a mechanism for influencing the Lucene search results via customizing the Lucene search scoring.
Search with accented characters
Replace the default analyzer used by Lucene search with one that replaces accented characters with the corresponding unaccented ones.
Index external content
Index data items that are managed on external systems.
Add a custom page taxonomy to a search index
Add a custom taxonomy for pages to a search index to filter search results, for example, by a tag.
Add a document to a search index
The sample in this article demonstrates how you can use the API to create and add a new document to an existing search index.
Create a search index that applies to group of pages
You can create a search index that applies only to a selection of pages under a group page by replacing the default PageInboundPipe with a custom one.
Customize the label of the search button in multisite
Customize the label of search buttons on different sites in a multisite project. Hard-code the label for each site or dynamically change the label.

Additional resources

ARTICLES

For developers: Publishing system

Increase your Sitefinity skills by signing up for our free trainings. Get Sitefinity-certified at Progress Education Community to boost your credentials.

Web Security for Sitefinity Administrators

The free standalone Web Security lesson teaches administrators how to protect your websites and Sitefinity instance from external threats. Learn to configure HTTPS, SSL, allow lists for trusted sites, and cookie security, among others.

Foundations of Sitefinity ASP.NET Core Development

The free on-demand video course teaches developers how to use Sitefinity .NET Core and leverage its decoupled architecture and new way of coding against the platform.

Was this article helpful?

Yes No

Would you like to submit additional feedback?

Your feedback about this content is important

How helpful is this article?

Very helpful Somewhat helpful Not helpful

How can we improve this article?(Optional)

Fix typos or links

Fix incorrect information

Add or update code samples

Add or update illustrations

Add information about...

Send feedback Cancel

Personalization and Tracking consent API