Enable users to view saved queries and query history

• About the Saved Queries/Query History Feature

• Configuring Saved Queries/Query History

  • UI Editor

• Saved Queries Template

About the Saved Queries/Query History Feature

• The Saved Queries component lets user save their favorites queries.
• The Query History component lets user see their history of queries.

Configuring Saved Queries/Query History

UI Editor

• To modify the Saved Queries feature on your HTML page, use the procedure below.

• The easiest and fastest way to configure saved queries and query history is via the SmartHub UI Editor.

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

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 Results.html page.

   1. Below, the Results.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.

      1. Example: Customizations/index.html, shown below. Default Index.html is under the top most SmartHub directory.

      2. See Creating Custom Pages.

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

5. Select the Advanced HTML edit link at the top center of the page.

6. Place the following code fragment in the desired place for display on the page:

   <div id='saved-query-component'></div>

7. Click Save changes.

8. Click Advanced Settings Edit.

9. Locate the SH.SavedQueries.CustomSettings section.
   
   

10. To access the available SavedQueries settings, click the See Default Settings link in the top right corner.

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

12. Search for "SH.SavedQueries" to locate the following code:

SH.SavedQueries.DefaultSettings = {
    EnableSavedQueries: true,
    EnableQueryHistory: true,
    ShowSavedQueriesSortOptions: false,
    ShowQueryHistorySortOptions: false,
    RequiresTracking: true,
    TrackRefiners: true
    ParentContainerSelector: "#saved-query-component",
    TemplatePath: SH.RootLevelURL + "/modules/SavedQueries/templates/template.html",
    ModalPath: SH.RootLevelURL + "/modules/SavedQueries/templates/modal.html",
    GroupId: "Default", //Saved Queries components on different pages will show the same content if they have the same GroupId
    UserProfilePropertyName: "SavedQueries",
    MaxHistoryItems: 5,
    EmailTitle: "Useful query".toLocaleString(),
    EmailBody: "I thought you might find this useful: ".toLocaleString(),
    DeleteSavedQueryWarnMessage: "Are you sure you want to delete this query?".toLocaleString()
};

13. Copy and paste the settings code in your custom settings file under SH.SavedQueries.CustomSettings back in your Advanced settings browser tab.

14. Modify the code as you desire.

15. Click Save changes.

16. Click the link Preview <page>.html at the top of the code editor.

17. Observe the HTML page.

18. Make any changes and repeat as necessary.

19. Click Save changes after making changes.

Saved queries and query history settings

Saved Queries Template

• The SavedQueries template offers several options that can be modified.

• The file can be found, as specified in Default settings at: <SmartHub_installation_dir>/modules/SavedQueries/templates/template.html.