The following tables lists all available query report template variables that can be used in addition to the global template variables to extend the functionality of the default query report templates or to create new templates from scratch
All numbers, dates, times, and day names throughout the report use either the locale of the template or server to properly display this information according to the rules defined by each language and country.
Table 8-8 General Query Report Template Variables
Table 8-10 Templates Used Query Report Template Variables
Table 8-11 Load Details Query Report Template Variables
Table 8-12 Search Details Query Report Template Variables
Name |
Description |
---|---|
$$QueryTotal |
Displays the total number of search requests received by QuickFinder. This includes all types of search including failed searches. |
$$SuccessfulQueries |
Displays the total number of regular search requests that were successfully completed. |
$$NotFoundQueries |
Displays the total number of search requests that could not find any hits. This includes the searches that were successfully completed by looking in other indexes using the Search Expansion feature. See $$ExpandedQueries for more information. |
$$ErrorQueries |
Displays the total number of search requests that resulted in an error condition. Errors can arise if the server is currently unable to complete the request, the request is too complex or takes too long to process, the query syntax is incorrect, the server load is too great, or a number of hardware- or software-related issues that may prevent a search from processing properly. |
$$ExpandedQueries |
Displays the total number of “Not Found” search requests that were successfully completed by looking in other indexes as a result of the Search Expansion feature. |
$$RedirectedQueries |
Displays the total number of search requests that were redirected to an specific, admin-defined URL. |
$$ShowFirstQueries |
Displays the total number of search requests that resulted in a successful search, but were redirected to the first hit in the search results list. |
$$SearchPageQueries |
Displays the total number of search requests that resulted in showing the Advanced Search page to the end user. |
$$LoginQueries |
Displays the total number of search requests that represent an attempt by the search user to log in. |
$$LogoutQueries |
Displays the total number of search requests that represent an attempt by the search user to log out. |
$$SwitchProtocolQueries |
Displays the total number of search requests that result in a switch of protocols. If specified by the administrator, QuickFinder can redirect login attempts from the unsecured HTTP protocol to the more secure HTTPS. |
$$AvgNumHitsPerPage |
Displays the average number of hits listed on a single search results page. |
$$AvgTotalNumHits |
Displays the average total number of hits for user queries. |
$$AvgQueryTime |
Displays the average amount of time required to complete user queries. |
Table 8-13 Search Results Pages Query Report Template Variables
Table 8-14 Top X Queries Query Report Template Variables
Table 8-15 Top Queries Query Report Template Variables
Table 8-16 Error Searches Query Report Template Variables
Table 8-17 Not Found Searches Query Report Template Variables
Table 8-18 Redirected Searches Query Report Template Variables
Table 8-19 Login Requests Query Report Template Variables
Table 8-20 Print Details Query Report Template Variables
Table 8-21 Print Errors Query Report Template Variables
Table 8-22 Highlight Details Query Report Template Variables
These template variables are used to export a raw version of the entire contents of the query log. Whereas the ReportTemplate.html file summarizes query date, the ExportTemplate.xml file contains a complete copy of the query log formatted so that other query reporting engines can consume the results.
Table 8-23 Export Details Query Report Template Variables