One of the greatest benefits of Discovery Attender is the variety of options that can be used for keyword searching. However, a significant amount of time can be expended on trial and error in crafting an appropriate search expression. In this installment of our series of Discovery Attender features, we will investigate the Keyword Tester. This helpful tool has been integrated into the search wizard to save time and effort by evaluating keyword lists and confirming expressions before a search is run.
Who should use the Keyword Tester?
- If you have any doubt about how an expression or pattern will be evaluated by Discovery Attender
- If you are using a keyword list, use the Keyword Tester for its testing capabilities as well as verifying how items are parsed.
- If you need to refine your search criteria before a search is initiated
- If you need to answer questions as to why an item did or did not hit after a search
What can the Keyword Tester do?
The main functionality, as the name suggests, is to test keyword criteria for syntax, validity, proper structure, efficiency and effectiveness. It is designed to assist a user in understanding how Discovery Attender evaluates a given list of words, patterns or search expressions. It can also be used to answer questions as to why a search expression matched (or not) given a file or snippet of text as well as view the text which is parsed from a file.
What doesn’t the Keyword Tester do?
While the Keyword Tester is unsurpassed at showing users when an expression is syntactically incorrect, it cannot automatically test for items that are logically incorrect. That is why it is important to always test the expressions using the Search Text and Search File buttons to provide a sample to compare against. Don’t forget to include samples that should match the given expression, and also data that should not match.
Keyword Logic Tree
The Keyword Logic Tree is a visual representation of how the Discovery Attender search engine will evaluate a search expression or list. Each line, or ‘leaf’, is a word or phrase to evaluate. Each leaf is joined as ‘branches’ rooted in the logical operators. In addition to representing a format of an expression, the logic tree also provides a visual map of how a keyword hit is represented from the sample test item.
The Keyword Logic Tree can be used for two purposes.
- To validate that a search expression parses as expected.
- To show how the search engine has evaluated test data.
Using the Keyword Tester
The following steps should prove helpful in using the keyword tester. Before starting, make sure you have a sample text or files that should match your criteria, as well as samples that should *not* match the keyword criteria.
- Enter your search terms or expression in the wizard screen.
- Click on the Test button of the Choose Keyword wizard screen. If your criteria is not syntactically correct, an error message will appear. Clicking ‘OK’ will, in most cases, place the cursor at the location of the syntax problem. You must correct the error before the tester can open.
- Upon opening, the keyword logic tree of the tester will be populated. Review the tree to verify the search engine will evaluate your criteria as intended.
- Enable the optional evaluation choices (Complete Search, Merge Files or Match Case) or keep the defaults.
- Use the buttons and options on the Search Panel (Search Text, Search File) to enter sample data to evaluation.
- The logic tree will change from all black to highlights of blue or green depending on whether a hit was found or not inside the result set.
- If a hit was found with your test sample, the Details section is populated with data about the hits. Review this data to verify that any hits found are valid.
- Adjust your criteria in the search wizard or hit reset to test more items.
More information on the Keyword Tester is available in the help document or by contacting Technical Support.