Home

Content Sources

Index

Search
  Search Features
    Front Ends
      Output Format
      KeyMatch
      Related Queries
      Filters
      Remove URLs
      OneBox Modules
    Query Settings
    Document Preview Module
    Result Biasing
    Suggestions
    Dynamic Navigation
    Language Bundles
    User Results
    Expert Search
  Secure Search
  Diagnostics

Reports

GSA Unification

GSAⁿ

Administration

More Information

Search > Search Features > Front Ends > KeyMatch

Use the Search > Search Features > Front Ends > KeyMatch page to perform the following tasks:

• Adding a new KeyMatch
• Viewing KeyMatches
• Editing a KeyMatch
• Deleting a KeyMatch
• Importing or exporting KeyMatches

A KeyMatch associates a specific term with a particular result, enabling you to direct users to a result that is especially relevant but that might not appear at the top of the results page. For example, if a department is releasing a new Operations web page that should be returned for certain types of queries, you can direct users to that new web page by associating specific search terms, such as operations, with the new web page. A link for that page is returned at the top of search results for queries containing the term operations.

This feature is especially useful for directing users to web pages that are not yet part of the production index or that have very few links to them, causing them to appear further down in the results list than you would like.

To use KeyMatches:

1. Click Search > Search Features > Front Ends.
2. Click the Edit link next to the collection front end you want to edit.
3. Click the KeyMatch tab.
   From this page, you can view, edit, create, and import and export matches.

Before Starting these Tasks

Before adding KeyMatches, identify the front ends where you want to add KeyMatches. If you only use the default_frontend, determine if you want to add KeyMatches to it. If you only want to add KeyMatches for a specific group of end users, you must create a front end for this group of end users.

Specifying KeyMatches

To create a KeyMatch, you must specify the word, phrase, or exact match criteria for which a specific result will be returned. The rules for creating a KeyMatch are described in the following table.  

The maximum length for a Title for Match is 100 characters.

You can submit any number of URLs per word, phrase, or exact match. By default, however, only a maximum of three KeyMatches are returned for a search. You can increase the maximum number of KeyMatches returned up to 50 by using the numgm parameter, which is described in the Search Protocol Reference.

The search appliance returns KeyMatch results based on the order in which the rules are created.

If you modify an existing KeyMatch or create new KeyMatches, you can expect a time delay before the configuration is updated.

Note: There is a limit to the number of KeyMatches you can specify. KeyMatch or Synonym files containing 75,000 lines, or greater, may cause the search appliance to return a server error.

Adding a New KeyMatch

To add a new KeyMatch:

1. Click the Add Matches link.
   The Add Matches page displays with editable fields.
2. Add your KeyMatches, one per line.
3. To add more lines, click Add More Lines.
4. Click Save.

Viewing KeyMatches

To view existing KeyMatches:

1. Click the View Matches link.
   If matches have been created, all matches are displayed with a search field and navigation links.
2. To navigate through all of the KeyMatches, use the First, Previous, Next, and Last links.

Editing a KeyMatch

To edit an existing KeyMatch:

1. Click the Edit Matches link.
   The Edit page is displayed with all matches in editable fields with a search field and navigation links.
2. To navigate through all of the KeyMatches, use the First, Previous, Next, and Last links. KeyMatches are displayed 25 at a time.
3. Make changes and click Save.

Deleting a KeyMatch

To delete KeyMatches:

1. Click the Edit Matches link.
2. Click the check box for the KeyMatch in the Delete column.
3. Click Save.

Importing or Exporting KeyMatches

You can import KeyMatches from a URL or from a .csv format file. Any KeyMatch file that you import must be in UTF-8 encoding. Because KeyMatches are overwritten when a new KeyMatch file is imported, export a current version before making changes.

To import KeyMatches from a URL:

1. Click the Import/Export Matches link.
2. Type the URL in the URL field.
3. Click Import.

To import KeyMatches from a file:

1. Click Choose File.
2. Select the file.
3. Click Open.
4. Click Import.

To export KeyMatches from this system to a local file:

1. Click Export.
   The File Download wizard is displayed.
2. Save the file with a .csv extension, which can be opened in Microsoft Excel.

For More Information

For detailed information about KeyMatches, see "Using KeyMatches to Guide Users to URLs" in "Creating the Search Experience: Best Practices," which is linked to the Google Search Appliance help center.