Skip to content

Modules · Veva.Modules.SearchManager

Search the whole site.

The crawler reads your pages, documents, PDFs and Office files into one Lucene index. Search Manager lets you tune the ranking, pin results and see what visitors look for. Press Ctrl K to try it here.

dotnet add package Veva.Modules.SearchManager

What it does

Found on the first try.

A crawler you set up

Set the start address, the CSS selectors to read or skip, depth and threads. Pages are crawled again when published.

Pages and files

HTML pages, PDF files (PDFPig) and Word and Excel files (NPOI) all go into the index.

Ranking you can tune

Boost title, content or address, turn on fuzzy matching, add synonyms and favour newer pages.

Results you choose

Moderated entries are results of your own, with a priority, for the queries that matter.

Search analytics

Top and trending queries, searches without results and click-through, exported as CSV.

Search on your pages

The Web search component shows results in your own design, filtered by category, tags, language or date.

How it works

From a crawl to a result.

  1. 01

    Crawl

    The crawl task reads the site from its start address and sitemap.

    WebsiteCrawlTask
  2. 02

    Read

    Readers turn HTML, PDF, Word and Excel into text to index.

    IDocumentReader
  3. 03

    Index

    Entries go into the search catalog and a Lucene index.

    Lucene.Net
  4. 04

    Query

    Queries run with your boosts, fuzzy matching and synonyms.

    ISearchIndexQueryService
  5. 05

    Show

    In the Web search component, or a palette like this site's Ctrl K.

For developers

Query the index from code.

This site's Ctrl K palette is a theme endpoint over ISearchIndexQueryService. The same service gives your own components results by query, tags, category and language.

Extension points

API

Query the index, read new kinds of files, supply synonyms:

  • ISearchIndexQueryService: queries the index
  • ISearchProviderService: runs a search with the site's settings
  • IDocumentReader: reads one kind of file for the crawler
  • ISynonymService: supplies synonyms
SearchManagerSiteSearch.cs
QueryResult? result = _index.Query(       // ISearchIndexQueryService
    request.Query,
    request.WebsiteId,
    Array.Empty<string>(),                // tags
    TagFilterType.Any,
    category: string.Empty,
    documentType: string.Empty,
    origin: string.Empty,
    language: string.Empty,
    pageNr: 1,
    pageSize: request.Take);

// result.Results: PageTitle, Url, MetaDescription, Content, DocumentType

More of Veva

Explore the other modules.

Each one is a package. Reference it, restart, and its components are in the editor.

All modules

Page builder

Compose pages from components, then preview and publish

Open

Documents

Structured content you list, filter and serve anywhere

Open

Assets

One media library, with images sized on request

Open

Veva core

BuildVeva(), modules, components, themes and hooks

Open

Integrations

Data sources, sign-in, mail, analytics and media

Open

Type to search the docs, components and API.

↑↓ to move ↵ to open Esc to close Search by Veva