Filters / Taxonomy Aggregations

Overview

Documents that are synchronised using the native connectors are enriched with various default Taxonomy values, which can be configured to be displayed as filters within General search, and also used in Advanced Filter (JSON) within Content Widgets and Content Listing Blocks.

This document describes how to enable these taxonomy values for use within general search filters.

Taxonomy Aggregations (JSON) Application Variable

The additional filters that are displayed on the general search results page are configurable via the "Taxonomy Aggregations (JSON)" application variable.

Standard Taxonomy Values

There are a set of standard Taxonomy values for each connector. Please see the connector specific documentation for full details about which values are available.

For example, for the SharePoint Online native connector, the following out of the box taxonomy values are populated for synchronised documents (as relevant)

  • Site Collection
  • Site
  • Site Drive
  • Site List
  • File Extension
  • Directory

The general search results page can be configured to include these additional taxonomy values in the familiar Filters flyout as aggregations.

Custom Taxonomy Values

As SharePoint is very configurable, we also have support for recording the values from custom columns of lists against the synchronised documents. This then allows for those additional values to also appear as filters within the general search results page.

Taxonomy Value Types

When populating the Facets in the application variable, it is assumed that the fields are textual fields. However, if the connector has been configured to synchronise taxonomy values which are not textual, then you must specify the type as well. Supported types include:

  • Text
  • Number
  • Date

Examples

Standard taxonomy values

If you want to include some of the standard SharePoint Online taxonomy values, then you could populate the application variable with the following:

{
  "Aggregations": [
    {
      "Facet": "Site Collection"
    },
    {
      "Facet": "Site"
    },
    {
      "Facet": "Site Drive"
    },
    {
      "Facet": "Site List"
    },
    {
      "Facet": "File Extension"
    },
    {
      "Facet": "Directory"
    }
  ]
}

Additional taxonomy values

If you have configured your connector to synchronise additional taxonomy values for documents (e.g. for custom columns within a SharePoint List), then you could populate the application variable with the following:

{
  "Aggregations": [
    {
      "Facet": "Site Collection"
    },
    {
      "Facet": "Site"
    },
    {
      "Facet": "Site Drive"
    },
    {
      "Facet": "Site List"
    },
    {
      "Facet": "File Extension"
    },
    {
      "Facet": "Directory"
    },
    {
      "Facet": "Social Media Use"
    },
    {
      "Facet": "Mobile friendly format"
    },
    {
      "Facet": "User Journey Stage"
    },
    {
      "Facet": "Secondary topic"
    }
  ]
}

This will include the following taxonomy fields, which in this example have come from custom columns on a SharePoint list:

  • Social Media Use
  • Mobile Friendly Format
  • User Journey Stage
  • Secondary Top