Help Center

Menu

Implementer training - content auditor

Configuring content auditor

The content auditor provides a series of reports on various aspects of a result page’s content.

The content auditor is primarily designed for web and file content but could be adapted to other content sources.

Interpretation of content auditor reports is covered in detail in INSIGHTS 101 - Search insights and optimization tools.

The content auditor reports can be customized in a number of ways. Customizations include:

  • Reporting on custom metadata

  • Specifying undesirable text

  • Defining acceptable reading grades

Most customizations are applied as soon as the configuration change is saved, however some require an update of related data sources for the changes to take effect.

Funnelback documentation - content auditor

Tutorial: Content auditor reports

  1. Log in to the insights dashboard where you are doing your training.

    See: Training - search dashboard access information if you’re not sure how to access the training. Ignore this step if you’re treating this as a non-interactive tutorial.

  2. Navigate to the foodista service then click on the content auditor tile, or select content auditor from the sidebar menu.

  3. The content auditor - recommendations screen will then load.

    exercise content auditor reports 01

  4. Observe that the report is organized into several sections - recommendations (currently showing), overview (which provides information on the top values for the metadata fields covered by the report), attributes (which breaks down the different metadata fields) and search results (which provides page level information for items that match the current report’s search criteria).

  5. Spend a few minutes exploring the different sections of the content auditor report.

Customize the undesirable text

Funnelback uses Wikipedia’s common misspellings list to identify undesirable words. This list can be replaced or augmented with custom lists of terms.

Customization of undesirable text requires a full update of related data sources.

filter.jsoup.undesirable_text-source.[key_name]

Tutorial: Configuring undesirable text

There are two methods of adding additional words to the undesirable text list. This exercise will use both methods to add to the undesirable text list.

  1. From the search dashboard switch to the foodista data source. Click the edit data source configuration item on the settings panel. A configuration key, filter.jsoup.undesirable_text.[key_name] can be used to add individual values to the undesirable text list.

    manage data source panel settings

  2. Click the add new button and add a configuration option named filter.jsoup.undesirable_text.abbrev-abt and set this to the value of abt.

    exercise configuring undesirable text 01

  3. Run a full update of the foodista data source.

    A full update is required because the undesirable text report is produced using a filter that analyzes the page content. . After the update completes view the content auditor report on the foodista results page. Observe that abt is now included in the list of undesirable text detected for the site.

  4. Return to the foodista data source. We’ll add some more undesirable text items, but this time in an undesirable text file. Use this method if you have a set of words that you need to detect.

  5. Create an undesirable text configuration file for a non-preferred terms list. Select the manage data source configuration files item on the settings panel teh click the add new button. Create an undesirable-text.non-preferred.cfg file. You can create multiple lists of undesirable text that can be reported on separately. We’ll create a list with an ID of non-preferred:

    exercise configuring undesirable text 02

  6. Click on the undesirable-text.non-preferred.cfg item in the file listing to edit the configuration file and enter the following list of words into the editor, then click the save button.

    prawn
prawns
coriander

    This will configure content auditor to identify pages that contain these words. In this example we might want to identify prawn(s) and coriander as non-preferred or banned words. This would allow for these to be updated to say shrimp, cilantro and about if these were the preferred terms in a site’s content guidelines.

  7. Return to the foodista data source management screen and select edit data source configuration from the settings panel. We need to tell content auditor to use the non-preferred word list that we just configured. Add a new configuration key:

    • Parameter key: filter.jsoup.undesirable_text-source.*

    • Key: npt

    • Value: non-preferred

    exercise configuring undesirable text 03

  8. Run a full update of the foodista data source.

  9. After the update completes return to the content auditor report for the foodista results page and observe that occurrences of the words added to the custom undesirable text file are now included in the words listed as undesirable text. Clicking on one of the terms will filter the report to only pages containing the selected word.

    exercise configuring undesirable text 04

Customize the reading grade chart

The range of acceptable grade levels can be configured with search package configuration settings which control the lower and upper bounds of the reading grades that are rendered in green. ui.modern.content-auditor.reading-grade.lower-ok-limit and ui.modern.content-auditor.reading-grade.upper-ok-limit can be set to appropriate grade levels.

Customization of the reading grade chart does not require an update of any related data sources.

ui.modern.content-auditor.reading-grade.lower-ok-limit

ui.modern.content-auditor.reading-grade.upper-ok-limit

Tutorial: Set the reading grade limits

  1. Log in to the search dashboard where you are doing your training.

    See: Training - search dashboard access information if you’re not sure how to access the training. Ignore this step if you’re treating this as a non-interactive tutorial.

  2. Navigate to the foodista results page.

  3. View the content auditor report and observe the acceptable range for reading grade lies between 6 and 9.

    exercise set the document age threshold 01

  4. Change the acceptable reading grade levels to grades 5-7. This must be changed in the parent search package. Edit the search package configuration of the foodista search package and add the following settings:

    ui.modern.content-auditor.reading-grade.lower-ok-limit=5
ui.modern.content-auditor.reading-grade.upper-ok-limit=7

  5. Return to the content auditor report and observe that the reading graph has updated to display the new acceptable range in green. Observe that the changes take place as soon as the configuration changes are saved - no update of the linked foodista data source is required.

    exercise set the document age threshold 02

Customize overview and attributes metadata

Custom metadata fields can be added to the overview and attributes screens.

This is done by adding ui.modern.content-auditor.facet-metadata.(metadata_name)=(facet_name) settings to the results page configuration for each field that should be displayed.

Customization of the overview and attributes reports does not require an update of the linked data sources, unless the metadata fields are not currently mapped.

ui.modern.content-auditor.facet-metadata.[metadata]

Tutorial: Add custom metadata to the overview and attributes screens

  1. Log in to the search dashboard where you are doing your training.

    See: Training - search dashboard access information if you’re not sure how to access the training. Ignore this step if you’re treating this as a non-interactive tutorial.

  2. Navigate to the foodista search results page.

  3. View the content auditor report and observe the overview and attributes screens.

    exercise add custom metadata to the overview and attributes screens 01
    exercise add custom metadata to the overview and attributes screens 02

  4. Edit the results page configuration and add the following setting then save and publish. This will add an Authors field to the overview and attributes screens.

    • Parameter key: ui.modern.content-auditor.facet-metadata.*

    • Metadata name: authors

    • Value: Authors

  5. Return to the content auditor search results and observe that the changes are now reflected in the report.

    exercise add custom metadata to the overview and attributes screens 03
    exercise add custom metadata to the overview and attributes screens 04

Customize the search results display

The search results screen can be configured to display the values of arbitrary metadata fields for each result.

Customization of the search results report does not require an update of the linked data sources, unless the metadata fields are not currently mapped.

ui.modern.content-auditor.display-metadata.[metadataName]

Tutorial: Add custom metadata columns to the search results

  1. Log in to the search dashboard where you are doing your training.

    See: Training - search dashboard access information if you’re not sure how to access the training. Ignore this step if you’re treating this as a non-interactive tutorial.

  2. Navigate to the Foodista search results page.

  3. View the content auditor report and select the search results screen

    exercise add custom metadata columns to the search results 01

  4. Select the edit results page configuration from the customize panel and add the following settings. This will remove the format and subjects columns and add columns that display the author and tags metadata field content.

    ui.modern.content-auditor.display-metadata.f=
ui.modern.content-auditor.display-metadata.keyword=
ui.modern.content-auditor.display-metadata.authors=Author

  5. Return to the content auditor search results and observe that the changes are now reflected in the report.

    exercise add custom metadata columns to the search results 02

Customize the insights dashboard summary tile

The attribute displayed on the content auditor summary tile can be customized by setting a results page configuration parameter.

Customization of the tile source does not require an update of any linked data sources, unless the metadata fields are not currently mapped.

ui.modern.content-auditor.preferred-facets

Tutorial: Change the content auditor summary tile

  1. Log in to the insights dashboard where you are doing your training.

    See: Training - search dashboard access information if you’re not sure how to access the training. Ignore this step if you’re treating this as a non-interactive tutorial.

  2. Open the insights dashboard for the Foodista search results page observe the content auditor summary tile:

    exercise change the content auditor summary tile 01

  3. Switch to the search dashboard, Foodista search results page manage screen and select edit results page configuration from the customize panel. Observe that there is a configuration option setting the summary tile to the date modified:

    ui.modern.content-auditor.preferred-facets=Date Modified
    this option has already been customized for the Foodista search results page - when setting the tile default it is normal for this setting to be missing from the results page configuration.

  4. Edit the configuration setting to display Tags if available, with second preference for Date Modified. Save and publish the setting.

    ui.modern.content-auditor.preferred-facets=Tags,Date Modified
    exercise change the content auditor summary tile 02

  5. Reload the insights dashboard and observe that the content auditor is now displaying tags on the summary tile.

    exercise change the content auditor summary tile 03