How to create a custom index in Umbraco V9

This may be touched on in the official Umbraco V9 documentation when that is released, but for now at least, this is how I have managed to create a custom Umbraco Index in V9 filtered to a specific document type.

In V8 we could use an IndexCreator to achieve this as seen in the documentation here, however it seems this is no longer a thing in V9 and now we inherit the UmbracoExamineIndex and override IIndex.IndexItems.

This is probably not the correct way to do this, but until there is some documentation it seems to work, if you find an alternative (or better way) please let me know in the comments below.

So firstly you will want to create your index, so in my case it's for the Knowledgebase in the new UmbHost website, where I only wanted to index items of type knowledgebaseArticle, in the code below you can see we are restricting the indexed items to the knowledgebaseArticle document type.

Next you will want to register this with a composer, here you can see we are giving the index a name of KnowledgebaseArticles:

And here you can see it is now showing up in the Umbraco Back Office:

Knowledgebase Index in Umbraco Back Office

And that's all there is to it as far as I can see, so pretty simple.


Comments (0)
Leave a Comment

Your comment

Contact Info