Akumina Developer Documentation

Akumina Developer Documentation

  • API
  • Docs
  • Blog

Akumina-Search-Checklist

Search Checklist

ItemAction
Configure SearchValidate PageData_AK list and set up managed properties; see https://community.akumina.com/knowledge-base/configuring-search-for-akumina-widget-content/
Page exclusionDetermine which pages to exclude from the search. See "Search Page Exclusion List (Part of Core Site)" at https://community.akumina.com/knowledge-base/foundation-site-installation/
Content ExclusionDetermine which sections of the site to exclude, for example the header and footer. See "Excluding Certain Content from Search" at https://community.akumina.com/knowledge-base/configuring-search-for-akumina-widget-content/
ScopeDetermine the scope of what search results you want. See Scope
TaggingDetermine if and how additional keywords should be added to improve search result findability. See Tagging
Modern SearchSetup Office 365 Modern search to properly display results from an Akumina site; see https://community.akumina.com/knowledge-base/modern-search/

Scope

The scope of the search is controlled by the KQL query that is executed, similar to the way it works in SharePoint. The query is executed by the GenericSearchListWidget, and by default is similar to the below.

{searchboxquery}* {QueryString.scope} (SPSiteURL:{SiteCollection} (((FileExtension:zip OR FileExtension:txt OR FileExtension:doc OR FileExtension:docx OR FileExtension:xls OR FileExtension:xlsx OR FileExtension:ppt OR FileExtension:pptx OR FileExtension:pdf)(IsDocument:"True")) OR (contentclass:"STS_ListItem" Path:"{SiteCollection}/Lists/PageData_AK/*" {AkLanguageId:{Site.LanguageId}})))

The clause SPSiteURL:{SiteCollection} requires the items to be in the current site collection. To search other locations, you can modify the query:

  • Remove the clause to search all site collections.
  • Add another clause to search other site collection(s)
    • (SPSiteURL:{SiteCollection} OR SPSiteURL:http://tenant.sharepoint.com/sites/central)
  • or Add another KQL clause to search other data
    • (SPSiteURL:{SiteCollection} OR ContentType:CustomArticle)
  • Or a combination of the above

Tagging

With items inside SharePoint, keywords can be added in various ways:

  • Adding the Enterprise Keywords field to the content type
  • Adding a seperate keyword field, of type text, note, or managed metadata

The Enterprise Keywords field is already mapped to a managed property (Keywords) but if a seperate field is added, then a new managed property would need to be setup. The key for the managed property is the Searchable attribute:

Enables querying against the content of the managed property. The content of this managed property is included in the full-text index. For example, if the property is "author", a simple query for "Smith" returns items containing the word "Smith" and items whose author property contains "Smith".

A managed property with the searchable attribute checked will allow its content to be searched in a normal text search, without having to use a specific field clause in your search query.

References

  • https://docs.microsoft.com/en-us/sharepoint/search/search-schema-overview#managed-property-settings-overview
  • Search Checklist
    • Scope
    • Tagging
    • References
Akumina Developer Documentation
Docs
Akumina Framework 5.0Akumina Widget BuilderAkumina Yeoman GeneratorSite Deployer
Community
Akumina Community Site
More
GitHubStar
Copyright © 2021 Akumina