How to Display a Document Summary in its Own Window

The Summary Content returns values into a modal windows for a specific metadata.

The Summary Content button can be found in the action bar from search results.

Clicking the button opens a modal window that displays values for Field configured in settings.

How to Enable Summary Content

The Summary Content component is disabled by default.

  • The corresponding settings files detail which files SmartHub loads by default.

  • To make changes to your SmartHub components, you setup custom configuration files in just a few steps.

  • For more information, see How to Customize Your SmartHub User Interface.

Do not modify the settings file or the file CustomSettingsTemplate.js directly because these files could be changed by a future update operation.

Copy
/modules/SmartHubResourceLoader/CustomSettingsTemplate.js

SH.Summary.CustomSettings = {};
SH.Summary.PathsToExclude =[];

To enable Summary Content, set Enabled to true.

Settings File Parameters

Use the following table for information about the settings file parameters.

Setting Default Value Description
Enabled false false - Summary content is disabled
true - Summary content is enabled
Field

DocumentSummaryExtraction

Recognize known metadata in text and provide values into a modal windows
EntityLinksProperty ExtractedEntitiesUrls

Recognize known entities in text and provide links to a knowledge base (wikipedia by default) that display as clickable links in results.

Expected format: {'Value1:Url1; Value2:Url2'}

DefaultUrlFunction http://wikipedia.org/wiki/ In case that the link returned for values is empty, a new link will be created by adding default value + returned value

How to Disable the Document Summary Component

Use the corresponding settings file to see which files SmartHub loads by default.

Do not modify the settings file or the file CustomSettingsTemplate.js directly because these files could be changed by a future update operation.

To disable the Document Summary component, use the following instructions:

  1. Open the custom settings file (such as "CustomResultsSettings.js") for the page you want to modify.
    1. For example the SmartHub Index and Results pages have the corresponding setting files IndexSettings.js and ResultsSettings.js, and typically similarly named custom settings files.

  2. Change the parameter Enabled to "false".

    Copy
        SH.Summary.CustomSettings = {
            'Enabled':'false'
        };

        SH.Summary.PathsToExclude = [];
  3. Save your custom setting file.