Generate a Hit Report

This article contains information about building and running search Hit Reports.

Hit Reports shares a Project Admin screen with Wordlists. Hit Reports allow administrators to create and folder results of a list of search terms. Terms are added, one per line. Boolean operators (AND, OR, NOT) and RQL search syntax may be used in generating this report.

The reports that are generated provide insight into the search terms, for example, how many documents hits in a document on a specific term, how many unique documents hit one term and none of the other terms in the search, and the total number of hits on a particular term.

1. Hit Reports are accessed by going to the Project Admin screen, selecting Wordlists and choosing the Hit Reports tab on the left side of the screen.
2. You may create a Hit Report by clicking +Add at the upper left of the table.
3. Enter a unique Job Name.
4. Select a Source Work Folder if you wish to only apply the search to a certain set of documents, otherwise the Hit Report will run on the entire contents of the database.
5. Enter the Search Terms, one term per line, in the Search Terms box, with phrases set out between quotation marks (e.g., "quotation marks").
6. Select Optional Output either when adding or editing later and choose your options:
   1. Populate root folder, which will populate a root work folder with unique results from ALL hit report search terms; you may populate the same root folder selected for “Create work folder for each term” or a different root folder;
   2. Create work folder for each term; 
   3. Create saved search for each term, clicking the ellipses […] button to select a saved search folder in which to put it; or 
   4. Populate a field with search results, which offers a choice of
      1. creating a New field within a specified Field Profile (and optionally making it initially visible), or
      2. specifying an Existing custom multi-value field that you specify to store the results.
      3. To create a New field:
         1. Click on the ellipses next to the Populate field with search results field. The Select Field window appears.
         2. In the New field, enter a name for the field, and use the dropdown to add it to the selected Field Profile.
         3. Select the Initially Visible checkbox.
         4. Choose OK to finish the field creation.
7. Choose ADD to complete the Hit Report (or EDIT if modifying the Hit Report).
8. Once returned to the main Hit Reports table, click the down-arrow next to the Status icon to select Start to run the report job. You will be prompted “This will start processing hit report job '<Name>'. Are you sure?” Click YES to confirm. 
9. Choose the Refresh button until the Job shows a green check mark under Status indicating it is complete.
10. Select the dropdown arrow and choose View Results to see the details of the report.
11. The results screen provides:
    1. Doc Hit Count: The number of documents that contain each search term.
    2. Family Count: The number of documents when family members are included in the Search Results.
    3. Uniqueness: The number of unique documents that contain hits for the search term.
    4. Inclusiveness: The percentage of documents that contain the search term as compared to the entire document count of the database.
    5. Total Unique Documents: The number of unique documents found by all of the Search Terms.
    6. The Hit Report Results window has an option to Export the results into an XLS format file.
       
       
       

Last Updated 9/05/2023