How to Configure Documents Thumbnails

 

Prerequisites

Smart Previews for SmartHub must be installed for the document thumbnails to be displayed.

About Documents Thumbnails

Document Thumbnails is a new feature that applies to your SmartHub site's Index.html page.

  • SmartHub's default Index.html page is located at the SmartHub root level.

Note: The default Index.html page is overwritten at upgrade time.

  • BA Insight recommends using a custom Index.html page for page customizations.

  • For information about using custom pages, see How to Use the UI Builder.

Document Thumbnails in the SmartHub UI

  • Document Thumbnails replaces the default icon displayed for the Recommendations results with the thumbnail of the first page of the document.
  • This replacement happens only for documents that have generated previews.
  • Otherwise, the default icon based on the extension of the file is displayed.

How to Configure Documents Thumbnails

UI Builder

The easiest and fastest way to change the document thumbnails is via the SmartHub UI Builder.

For information about how to access the UI Builder as well as who can access it, see How to Use the UI Builder.

  1. SmartHub administrators can simply click the UI Editor link from the SmartHub Administration page.

  2. Click the Select a page link from the top menu.

  3. Select (double-click) the Index.html page to modify it.

    1. Below, the Index.html page is shown for sample purposes.

    2. BA Insight recommends you create your own custom page and folder to modify. Leave the default files as templates.

      • Example: Customizations/index.html. Default Index.html is under the top most SmartHub directory.

      • See How to Create Custom Pages.

  4. Select the Advanced mode from the top right of the page.

  5. Select the Customize ContentContainers link from the top of the page.

  6. Select the Advanced settings edit link at the top center of the page.

  7. Scroll down to around line 318, the SH.SmartPreviews section. This is where you will insert your Document Thumbnails settings.

  8. To access the available Document Thumbnail settings, click the See Default Settings link in the top right corner.

    1. A new browser tab opens with all available SmartHub module settings.

  9. Search for the word "Thumbnail" on the page to quickly navigate to the Document Thumbnail default settings, nested inside the SH.SmartPreviews section, shown below:


  10. Copy the Thumbnails settings section from SH.SmartPreviews.DefaultSettings.
    1. In the example above, this section is contained in lines 306 to 310.
  11. Go back to your Advanced settings edit tab.
  12. Paste the copied settings inside section SH.SmartPreviews.CustomSettings.

    1. Change the PersonalizedRecommendations section as follows: 

      • Enabled: Set to true to display the documents thumbnails for the selected container.
      • ResultsSelector: The selector used to get the results list for which the documents thumbnails will appear.
  13. Click Save changes.

  14. Click the link Preview <HTMIL file>.html in the top center of the page.

  15. Examine your changes in the new HTML page that appears.

  16. Make any necessary modifications and click Save changes.

  17. Ensure SmartHub is loading your modified HTML file.
  18. This is set in IIS for your SmartHub site under Default Document.
    • If your new custom page is not shown, click Add, and enter the relative path to your file.

How to Set Document Thumbnail Size

The thumbnails size can be modified as follows:

  1. Locate and open the configuration files found in the bin folder from the Smart Previews Import server (<SmartPreviewsForSmartHub_root>\SmartPreviewsFrontEnd\bin)
    1. Preview offline: PreviewGeneratorV5.exe.config
    2. Preview online (on-demand): AptivCachePreviewGenerator.exe.config
  2. Modify the values for the following settings (size in pixels):
    1. ThumbnailMaxWidth
    2. ThumbnailMaxHeight

  3. After modifying the configuration files, restart Smart Previews services for the changes to take effect.