Page tree

Search Filters

Last updated

Watch and Learn

Brikit Targeted Search for Confluence (1:51)

An overview of Brikit Targeted Search.

An effective search tool is an important alternative to menus for users to find what they need on your site. Learn how to label your pages for effective search and how to create search filters--two key elements in creating effective searches.

An effective search tool is an important alternative to menus for users to find what they need on your site. The two key elements in creating effective searches are labels and search filters.

Learn how to label your pages for effective search, if you aren't familiar with how to do that. 

Search filters will improve Targeted Search results and also invisibly train your users to label content more accurately to match your taxonomy.

 

Targeted Search labels provide users with:

  • A controlled vocabulary, ensuring consistency of labeling by content managers
  • The ability to use macros to dynamically pull together content from anywhere in the site that a label has been applied, without concern that a free-text variant of the label will be missed–essentially, a one-button instant search
  • Targeted Search results that can be narrowed down by selecting pre-defined filter options

 

Avoid hyphens

Due to an issue in Confluence (CONF-41459), labels with hyphens, such as part-time or world-class, could be treated as separate labels when searching (becoming part, time, world, and class). To avoid unexpected results, use underscores instead (such as part_time or world_class).

And if you're using Targeted Search, you can display more friendly versions of labels (such as Part Time and World Class), so the hyphen-versus-underscore choice won't matter as much.

Link

What you're doing when you set up search filters is simply putting different search labels into logical collections that make it easier for users to narrow down results or choose appropriate labels when tagging information. You can also pre-set searches with filters to force the search into a specific space or to use specific labels.


Here's how you do it:

View Groups of Filters and Individual Filters

The procedures below require that you access the Targeted Search Filters page. To do so, complete the following procedures.

  1. From the Administration (gear) icon, select Confluence Admin or General Configuration.
  2. If necessary, enter your login credentials then press the Confirm button.
  3. The Administration Console page opens.
  4. Scroll to the Brikit Targeted Search section.
  5. Click the Configure Search Filters link.
  6. The Targeted Search Filters page opens.

Add a Filter Group

Complete the following procedures to add a filter group to the system.

  1. View the Targeted Search Filters page.
  2. Click the Add Filter Group button.
  3. The Add Filter Group window opens.
  4. Enter a name in the Name text box.
  5. Click the Save button.

Add a Filter to the Group

You must first add a group before adding filters.

Complete the following procedures to add a filter to the system.

  1. View the Targeted Search Filters page.
  2. Click the gear ( ) icon that corresponds to the appropriate group.
  3. Select Add Filter from the dropdown.
  4. The Add Filter window opens.
  5. Enter a name in the Name text box.
  6. Enter a label in the Label text box.
  7. Click the Save button.

Delete a Filter Group

Complete the following procedures to delete a group of filters from the system.

One GroupSeveral Groups 
Applies to all versions.
  1. View the Targeted Search Filters page .
  2. Click the gear () icon that corresponds to the appropriate group.
  3. Select Delete Group from the dropdown.

  4. The Delete Group window opens.

  5. Click the OK button to confirm the deletion.

Applies to version 1.1 or higher.
  1. View the Targeted Search Filters page.
  2. Check each box that corresponds to the appropriate group.
  3. Click the Delete Selected button.

Delete a Filter

Complete the following procedures to delete a filter from the system.

One FilterSeveral Filters 
Applies to all versions.
  1. View the Targeted Search Filters page.
  2. Click the gear () icon that corresponds to the appropriate filter.
  3. Select Delete Filter from the dropdown.
  4. The Delete Filter window opens.
  5. Click the OK button to confirm the deletion.
Applies to version 1.1 or higher.
  1. View the Targeted Search Filters page.
  2. Check each box that corresponds to the appropriate filter.
  3. Click the Delete Selected button.

 

Edit a Filter Group

Complete the following procedures to edit a filter group in the system.

  1. View the Targeted Search Filters page.
  2. Click the gear () icon that corresponds to the appropriate group.
  3. Select Edit Group from the dropdown.
  4. The Edit Group window opens.
  5. Make the appropriate changes.
  6. Click the Save button.

Edit a Filter

Complete the following procedures to edit a filter in the system.

  1. View the Targeted Search Filters page.
  2. Click the gear () icon that corresponds to the appropriate filter.
  3. Select Edit Filter from the dropdown.
  4. The Edit Filter window opens.
  5. Make the appropriate changes
  6. Click the Save button.

Complete the following procedures to set or edit the visibility of a group of filters.

  1. View the Targeted Search Filters page.
  2. Click the gear () icon that corresponds to the appropriate group.
  3. Select Set Visibility from the dropdown.
  4. The Set Visibility window opens.
  5. Enter one or more space labels in the Space Category text box.
  6. Click the Save button.

As an alternative to working in the Targeted Search Filters page, you can also manage filters using a tab-delimited text file. You can export or import this file.


WARNING: Importing will OVERWRITE all existing filters!

When importing, Targeted Search replaces all filters in the system. Best practice is to EXPORT first, save a back-up, edit a copy, and then import the edited copy.

Getting Started

For a quick start, try the following steps and avoid creating a text file from scratch.

  1. Add at least one filter to the Targeted Search Filters page.
  2. Export the settings.
  3. Open the targeted-search-settings.txt file.

    Spreadsheet

    You can maintain your filters using a spreadsheet. Just remember to import/export the content as a tab-delimited text file.

  4. Make changes.
  5. Save the file.
  6. Import the new settings.

Exporting

To export filters, complete the following procedures.

  1. From the Administration (gear) icon, select Confluence Admin or General Configuration.
  2. If necessary, enter your login credentials then click the Confirm button.
  3. The administration console page opens.
  4. Scroll to the Brikit Targeted Search section then click the Configure Search Filters link.
  5. The Targeted Search Filters page opens.
  6. Click the Export () button.
  7. Wait for the download to complete.

File Name

The name of the exported file is targeted-search-settings.txt.

File Location

Targeted Search exports this file into two locations:

  • Confluence  home/temp  directory
  • downloads folder set in browser

Importing

WARNING: Importing will OVERWRITE all existing filters!

When importing, Targeted Search replaces all filters in the system. Best practice is to EXPORT first, save a back-up, edit a copy, and then import the edited copy.

To import filters, complete the following procedures.

  1. From the Administration (gear) icon, select Confluence Admin or General Configuration.
  2. If necessary, enter your login credentials then click the Confirm button.
  3. The administration console page opens.
  4. Scroll to the Brikit Targeted Search section then click the Configure Search Filters link.
  5. The Targeted Search Filters page opens.
  6. Click the Import () button.
  7. A window opens.
  8. Navigate to and open the tab-delimited .txt file.
  9. A confirmation window opens.
  10. Select the checkbox then click the OK button.

Unique Values

Group Name

Each group name must be unique.  If the importer encounters a duplicate, the add-on ignores the name.

Filter Name and Label

Each filter name and label must be unique.  If the importer encounters a duplicate, the add-on ignores the name or label.

 

Next Steps

Still need help?