How to Add the Content Containers Module

• About

• How to Configure the Content Containers Module

  • Modify an Existing Content Container

  • Create a New Content Container

• Content Containers Parameters

About

• Content Containers is a SmartHub module located in the modules directory - <SmartHub_root>\modules

• SmartHub Content Containers replaces the Content-By-Search feature.

  Note: Content-By-Search code is still supported.
  Any existing CBS structure will continue to function.

• Supported templates are HTML (underscore)

Content Containers:

• Can be rendered event-based, anywhere on the page

• A single SmartHub page can contain multiple Content Containers

• Configuration is based on the standard settings files (Index.js, Results.js settings files).

• Modifying HTML pages (Results.html / Index.html) is unnecessary.

How to Configure the Content Containers Module

Modify an Existing Content Container

The easiest and fastest way to work with content containers 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.

Procedure:

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 page (Index.html, landing.html, etc.) you wish to modify.

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

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

      • Example: MyResultsPage.html

      • See How to Create a Custom Page.

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

5. Two pre-defined containers appear:

   1. ChatBotCbs

      • This container controls Best Bets and other chat bot and content-by-search functions.

   2. MainResults

      • Shown below.

      • Most common container to modify

      • See the Content Containers Parameters table below for details about available options.

6. After making changes you must click both Apply and then Save changes (bottom left corner) for your changes to take effect.

MainResults

Create a New Content Container

Procedure:

1. To create a new Content Container, from the default Customize ContentContainers page click the '+' icon.

2. Enter an ID (name) for the new Content Container.

3. Select the Content Container type.

4. Select the Content Container position.

5. Select the Content Container settings, as desired.

6. Click Apply. The dialogue closes.

7. Click Save Changes.

Content Containers Parameters

SampleCBSWithDefaultValues: {
                    ParentContainerSelector: '.sh-main-results-container',
                    Title: '',
                    ControlTemplatePath: SH.RootLevelURL + "/modules/ContentContainers/templates/cbsControlTemplate.html",
                    ItemTemplatePicker: function (result) { return SH.RootLevelURL + "/modules/ContentContainers/templates/cbsItemTemplate.html"; },
                    QueryTemplate: '{searchboxquery} FederatorBackends:"*"',
                    SourceId: 'b29924a9-ec32-4c10-8892-a544b69ee121',
                    RowsPerPage: 5,
                    EnablePagination: false,
                    EnableCountTotal: false,
                    EnableSmartPreviews: true,
                    EnableContentIntelligence: true,
                    EnableResultFeedback: true,
                    EnableRatings: false,
                    EnablePubChemViewer: false,
                    Baskets:{'.basketButton':false},
                    ShowSort: false,
                    AllowUserActivation: true,
                    SortProperties: 'Rank,Date',
                    SortDirection: 'Descending,Ascending',
                    IsMainResults: false,
                    FieldsToInclude: 'clickUri,title,Rank,ContentSource,FileExtension,excerpt,SDFUrl,date,DisplayAuthor,isUserProfile,WorkEmail,Title,JobTitle,Department,AboutMe,escbasecrawurl,UserName',
                    TriggerNewQueryOn: 'afterInitialization', 
                    DeferredRendering: false

},
SampleMainResultsWithDefaultValues: {
                    ParentContainerSelector: '.sh-main-results-container',
                    Title: '',
                    ControlTemplatePath: SH.RootLevelURL + "/modules/ContentContainers/templates/controlResultTemplate.html",
                    ItemTemplatePicker: function (result) {
                        if (result.isError)
                            return SH.RootLevelURL + "/modules/ContentContainers/templates/errorResultItemTemplate.html";
                        if (result.isUserProfile == 'true')
                            return SH.RootLevelURL + "/modules/ContentContainers/templates/peopleResultItemTemplate.html";
                        if(result.isAuth)
                            return SH.RootLevelURL + "/modules/ContentContainers/templates/authResultItemTemplate.html";
    
                        return SH.RootLevelURL + "/modules/ContentContainers/templates/resultItemTemplate.html";
                    },
                    QueryTemplate: '{searchboxquery} FederatorBackends:"*"',
                    SourceId: 'b29924a9-ec32-4c10-8892-a544b69ee121',
                    RowsPerPage: 10,
                    EnablePagination: false,
                    EnableCountTotal: false,
                    EnableSmartPreviews: true,
                    EnableContentIntelligence: true,
                    EnableResultFeedback: true,
                    EnableRatings: false,
                    EnablePubChemViewer: false,
                    Baskets:{'.basketButton':false},
                    ShowSort: false,
                    AllowUserActivation: false,
                    SortProperties: 'Rank,Date',
                    SortDirection: 'Descending,Ascending',
                    FieldsToInclude: 'clickUri,title,Rank,ContentSource,FileExtension,excerpt,SDFUrl,date,DisplayAuthor,isUserProfile,WorkEmail,JobTitle,Department,AboutMe,escbasecrawurl,UserName,PictureUrl',
                    TriggerNewQueryOn: 'deferredQuerySuccess',
                    IsMainResults: true,
                    DeferredRendering: false

}