Skip to content

Latest commit

 

History

History
56 lines (34 loc) · 2.92 KB

Usage-Guide.md

File metadata and controls

56 lines (34 loc) · 2.92 KB

Usage Guide

This library supports using Azure.Search to index both unstructured and high structured, interrelated content in an Xperience by Kentico solution. This indexed content can then be programmatically queried and displayed in a website channel.

Below are the steps to integrate the library into your solution.

Create a custom Indexing Strategy

See Custom index strategy

Continuous Integration

When starting your application for the first time after adding this library to your solution, a custom module and custom module classes will automatically be created to support managing search index configuration within the administration UI.

If you do not see new items added to your CI repository for the new auto-generated Azure search data types, stop your application and perform a CI store to add the library's custom module configuration to the CI repository.

You should now be able to run a CI restore. Attempting to run a CI restore without the CI files in the CI repository will result in a SQL error during the restore.

When team members are merging changes that include the addition of this library, they must first run a CI restore to ensure they have the same object metadata for the search custom module as your database.

Future updates to indexes will be tracked in the CI repository unless they are excluded.

Managing search indexes

See Managing search indexes

Managing search index aliases

See Managing search index aliases

Search index querying

See Search index querying

Disable indexing

You can disable indexing. This might be useful if there are any problems with differing Kentico version between this integration and your application. You can do so in the appsettings.json. This option defaults to true and therefore does not need to be specified when you want to enable indexing.

 "CMSAzureSearch": {
     "SearchServiceEnabled" : false,         // Add this line to disable indexing
     "SearchServiceEndPoint": "<your application url>",
     "SearchServiceAdminApiKey": "<your application admin key>",
     "SearchServiceQueryApiKey": "<your application query key>"
 }

This disables reindexing through the rebuild hook and after web page and content item events. The administration UI module is still accessible, but does not show any data. Disabling indexing does not delete AzureSearch data from database. Already indexed data can still be accessed from your application.

Upgrades and Uninstalling

See Uninstall