Help Center

Home

Crawl and Index

Serving
  Front Ends
    Output Format
    KeyMatch
    Related Queries
    Filters
    Remove URLs
    OneBox Modules
  OneBox Modules
  Result Biasing

Status and Reports

Administration

More Information

Serving > Front Ends > KeyMatch

KeyMatch lets you promote specific web pages on your site. 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 the new web page is returned alongside the search results (as a text-based ad does) for queries containing the term operations. This feature is especially useful in driving traffic directly 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 create a KeyMatch, you must provide the word, phrase, or exact match criteria for which a specific result will be returned. The rules for creating a KeyMatch are as follows: 

KeyMatch Type	Criteria (none are case-sensitive)	If search query is "Abraham Lincoln"	Reason for KeyMatch
KeywordMatch	A word that must appear anywhere in query.	KeywordMatches = "Abraham" and "Lincoln"	If your KeywordMatch is "Abraham Lincoln", the search query must include both "Abraham" and "Lincoln" to trigger this KeywordMatch. To get a KeywordMatch for either "Abraham" or "Lincoln," then enter two KeywordMatches: one for "Abraham" and one for "Lincoln."
PhraseMatch	A phrase that appears anywhere in query. For the phrase to match, all of the words must be present, the order of the words must be the same with no intervening words, and any hyphens in the query must be matched.	PhraseMatch = "Abraham Lincoln," "President Abraham Lincoln," "Abraham Lincoln president," and "young Abraham Lincoln"	These are all phrase KeyMatches because the words appear in the order entered in the search query, "Abraham Lincoln." "Abraham the Tall Lincoln" is not a PhraseMatch because "the Tall" separates the phrase "Abraham Lincoln."
ExactMatch	Phrase must exactly match the query.	ExactMatch = "Abraham Lincoln"	Only "Abraham Lincoln" is an ExactMatch for the query. "President Abraham Lincoln" and "Abraham Lincoln's" are not ExactMatches.

You can submit up to five designated URLs per word, phrase, or exact match. By default, however, only a maximum of three keymatches are returned for a search. If you want to increase this number to five, you can use the numgm parameter documented in the XML Reference document.

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.

To use KeyMatches:

1. Click Serving and then click 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.

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.

To edit existing KeyMatches:

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 the Save Changes button.
4. Select the box in the Delete column for any matches you want to delete.
5. Click the Save Changes button.

To add new KeyMatches:

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

To import or export KeyMatches:

Because KeyMatches are overwritten when a new KeyMatch file is imported, export a current version before making changes. See steps 4 and 5.

1. Click the Import/Export Matches link.
2. To import KeyMatches from a URL, enter the URL in the URL field and click the Import KeyMatches Now button.
3. To import KeyMatches from a file, click the Browse button, select the file, click Open, and click the Import KeyMatches Now button.
4. To export KeyMatches from this system to a local file, click the Export KeyMatches Now button.
   The File Download wizard is displayed.
5. Save the file with a .csv extension, which can be opened in Microsoft Excel.

To delete KeyMatches:

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