Adding custom search text extractors for files

Custom extractors allow you to use the attachment search feature of page indexes for non-default file types.

To define a custom search text extractor:

1. Create a class that implements the ISearchTextExtractor interface (CMS.Search namespace).

   • You can add the class into your web project inside the App_Code folder (or CMSApp_AppCode -> Old_App_Code on web application projects) or as part of a custom assembly.

2. Define the ExtractContent method.

   The ExtractContent method has the following parameters:

   • BinaryData data - contains the data of the attachment file.
   • ExtractionContext context - provides information about the page whose attachment is being indexed. Use the context.Culture property to get the culture code of the page’s language version.The method must return an XmlData object. The system adds the object’s data to page search indexes for the given attachment. Use the XmlData.SetValue method to enter values into individual search index fields.

3. Register the extractor for a file extension by calling the SearchTextExtractorManager.RegisterExtractor method.

   Copy

   
   
   
    SearchTextExtractorManager.RegisterExtractor("extension", new CustomExtractorClass());
   
   
    

   Note: You need to call the RegisterExtractor method at the start of your application (when the application and modules are being initialized).

4. Rebuild your page search indexes.

The search uses the custom extractor to index page attachments with the specified extension.

Example - Implementing a search text extractor

The following example demonstrates how to create a very basic extractor for .txt files:

1. Open your web project in Visual Studio.

2. Create a new class in the App_Code folder (or CMSApp_AppCode -> Old_App_Codeon web application projects). For example, name the class CustomSearchTextExtractor.cs.

3. Add the following using statements to the class:

   Copy

   
   
   
    using CMS.Search;
    using CMS.Base;
    using CMS.Core;
    using CMS.Helpers;
    using CMS.IO;
    using CMS.DataEngine;
   
   
    

4. Make the class implement the ISearchTextExtractor interface.

   Copy

   
   
   
    public class CustomSearchTextExtractor : ISearchTextExtractor
   
   
    

5. Define the ExtractContent method:

   Copy

   
   
   
    public XmlData ExtractContent(BinaryData data, ExtractionContext context)
    {
        if (data.Stream != null)
        {
            // Reads the text file's data stream
            data.Stream.Position = 0;
            string resultString = StreamReader.New(data.Stream).ReadToEnd();
   
            // Adds text into the CONTENT search index field
            XmlData contentData = new XmlData();
            contentData.SetValue(SearchFieldsConstants.CONTENT, resultString);
   
            return contentData;
        }
   
        return null;
    }
   
   
    

6. Extend the CMSModuleLoader partial class (outside of the CustomSearchTextExtractor class), and add a CMSLoaderAttribute attribute that registers your custom extractor for the .txt extension:

   Copy

   
   
   
    [RegisterCustomExtractors]
    public partial class CMSModuleLoader
    {
        private class RegisterCustomExtractorsAttribute : CMSLoaderAttribute
        {
            // The system automatically calls the Init method when the application starts
            public override void Init()
            {
                // Registers the CustomSearchText extractor for the .txt extension
                SearchTextExtractorManager.RegisterExtractor("txt", new CustomSearchTextExtractor());
            }
        }
    }
   
   
    

7. Save the CustomSearchTextExtractor.cs file.

8. Log in to the Kentico administration interface.

9. Open the Smart search application and Rebuild your page search indexes.

The example is only intended as a demonstration — the system already contains a default extractor for .txt files. You can use the same approach to create extractors for other file types.