Novell Doc: NW 6.5 SP8 Novell QuickFinder Server 5.0 Administration Guide

12.11 Query Report Template Variables

The following tables list 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.

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.

12.11.1 General

Table 12-8 General Query Report Template Variables

Name	Description
$$ReportName	Displays the filename of the current report without the terminating filename extension. A query report’s filename usually corresponds to the date range represented within the report.
$$SiteName	The name of the virtual search server to which the query report belongs.

12.11.2 Report Summary

Table 12-9 Report Summary Query Report Template Variables

Name	Description
$$AccessTotal	Displays the total number of requests received during the current report period.
$$UniqueUsers	Displays the number of unique users that were successfully authenticated through QuickFinder.

12.11.3 Templates Used

Table 12-10 Templates Used Query Report Template Variables

Name	Description
$$BeginRptTemplatesLoop	Begins a repeating section that displays the list of templates used to return search results information to the end user. This includes all template types.
$$EndRptTemplatesLoop	Ends a repeating section that displays the list of templates used to return search results information to the end user. This includes all template types.
$$RptTemplate	The name of the current QuickFinder template.
$$RptTemplateTotal	The number of times the current template was used.
$$RptTemplateCurrent	The number of the current loop. 1-based.
$$RptTemplateCount	The total number of unique templates requested by all users during the logging period.

12.11.4 Load Details

Table 12-11 Load Details Query Report Template Variables

Name	Description
$$DayOfWeek[#]	Displays the name of the current day of the week. # - optional day of week number (1 - 7)
By Week
$$BeginChartWeek[#]	Begins a repeating section that displays a load chart for the specified week. # - optional week value (1 - 6). If the optional week value is provided, but the week has no load information, this entire section is skipped. If the optional week value is not provided and the “current” week has no load information, the section is skipped for the current week, but repeated for any remaining weeks that follow.
$$EndChartWeek	Ends a repeating section that displays a load chart for the specified week.
$$BeginChartWeekDay[#2] or [#1,#2]	Begins a repeating section that displays information for each day of the week. If the specified day and week do not have load information available, the current section is not skipped. Use $$BeginSkipIfEmptyDay to skip the current section. #1 - optional week value (1 - 6). #2 - optional day value (1 - 7)
$$EndChartWeekDay	Ends a repeating section that displays information for each day of the week.
$$BeginSkipIfEmptyDay[#2] or [#1,#2]	Skips the current section (up to $$EndSkipIfEmptyDay) if the specified day of the week does not have any load information available. #1 - optional week value (1 - 6); defaults to the current value of the $$BeginChartWeek loop. #2 - optional day value (1 - 7); defaults to the current value of $$BeginChartWeekDay loop.
$$EndSkipIfEmptyDay	Ends the current section if the specified day of the week does not have any load information available.
$$WeekDayTotal[#2] or [#1,#2]	Displays the total number of requests handled on the specified day and week. #1 - optional week value (1 - 6); defaults to the current value of the $$BeginChartWeek loop. #2 - optional day value (1 - 7); defaults to the current value of $$BeginChartWeekDay loop.
$$WeekDayPeek[#2] or [#1,#2]	Displays the peak number of requests handled in a single hour on the specified day and week. #1 - optional week value (1 - 6); defaults to the current value of the $$BeginChartWeek loop. #2 - optional day value (1 - 7); defaults to the current value of $$BeginChartWeekDay loop.
$$WeekDayPeekTime[#2] or [#1,#2]	Displays the time of day when the peak number of requests occurred for the specified day and week. #1 - optional week value (1 - 6); defaults to the current value of the $$BeginChartWeek loop. #2 - optional day value (1 - 7); defaults to the current value of the $$BeginChartWeekDay loop.
$$ChartWeekDay[#3] or [#3,#4] or [#2,#3,#4] or [#1,#2,#3,#4]	Displays a chart showing the relative number of requests received on the specified day and week. The chart is produced using a single character (#4) repeated #3 times. #1 - optional week (1 - 6); defaults to $$BeginChartWeek. #2 - optional day value (1 - 7); defaults to $$BeginChartWeekDay. #3 - optional repeat value; defaults to 100. #4 - optional character; defaults to capital I
$$CurrentChartWeek	Displays the number of the current week (1 - 6).
$$WeekDateRange	Displays the date range represented by the current week. Dates are displayed using the Java “medium” date format.
By Day of Week
$$BeginChartDayAverages[#]	Begins a repeating section that displays a load chart for the specified day of week. # - optional day of week value (1 - 7). If the optional day of week value is provided, but the day has no load information, this entire section is skipped. If the optional day of week value is not provided and the “current” day has no load information, the section is skipped for the current day of week, but repeated for any remaining days that follow.
$$EndChartDayAverages	Ends a repeating section that displays a load chart for the specified day of week.
$$BeginChartHour[#2] or [#1,#2]	Begins a repeating section that displays information for each hour of the current day of week. If the specified hour and day do not have load information available, the current section is not skipped. Use $$BeginSkipIfEmptyHour to skip the current section. #1 - optional day value (1 - 7). #2 - optional hour value (1 - 24).
$$EndChartHour	Ends a repeating section that displays information for each hour of the current day of week.
$$IsAverageDay[averageText, actualText]	Displays either averageText or actualText based on the number of days represented by the current day of week.
$$BeginSkipIfEmptyHour[#2] or [#1,#2]	Skips the current section (up to $$EndSkipIfEmptyHour) if the specified hour does not have any load information available. #1 - optional day of week value (1 - 7); defaults to the current value of the $$BeginChartDayAverages loop. #2 - optional hour value (1 - 24); defaults to the current value of the $$BeginChartHour loop.
$$EndSkipIfEmptyHour	Ends the current section if the specified hour does not have any load information available.
$$CurrentChartHour	Displays the time of day corresponding to the current hour.
$$HourTotal[#2] or [#1,#2]	Displays the average number of requests handled during the specified hour and day. #1 - optional day of week value (1 - 7); defaults to the current value of the $$BeginChartDayAverages loop. #2 - optional hour value (1 - 24); defaults to the current value of the $$BeginChartHour loop.
$$HourPeek[#2] or [#1,#2]	Displays the peak number of requests handled during the specified hour. This # matches $$HourTotal if only 1 day is represented for the day of week. #1 - optional day of week value (1 - 7); defaults to the current value of the $$BeginChartDayAverages loop. #2 - optional hour value (1 - 24); defaults to the current value of the $$BeginChartHour loop.
$$HourPeekTime[#2] or [#1,#2]	Displays the time of day when the peak number of requests occurred for the specified hour and day of week. #1 - optional day of week value (1 - 7); defaults to current value of $$BeginChartDayAverages loop. #2 - optional hour value (1 - 24); defaults to current value of $$BeginChartHour loop.
$$ChartHour[#3] or [#3,#4] or [#2,#3,#4] or [#1,#2,#3,#4]	Displays a chart showing the relative number of requests received on the specified hour and day of week. The chart is produced by using a single character (#4) repeated #3 times. #1 - optional day of week (1 - 7); defaults to $$BeginChartDayAverages. #2 - optional hour value (1 - 24); defaults to $$BeginChartHour. #3 - optional repeat value; defaults to 100. #4 - optional character; defaults to capital I

12.11.5 Search Details

Table 12-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 because of a number of hardware-related or software-related issues that can 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 a 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.

12.11.6 Search Results Pages

Table 12-13 Search Results Pages Query Report Template Variables

Name	Description
$$BeginResultPageLoop[#]	Begins a repeating section that displays information regarding the search results page on which users found their information. # - optional page number to begin the loop. 1-based. The loop terminates as soon as a search results page returns a use percentage less than 1%.
$$EndResultPageLoop	Ends a repeating section that displays information regarding the search results page on which users found their information.
$$ResultPageNum	The number of the current search result page. 1-based.
$$ResultPageTotal	The total number of times user found their hit on the current search results page.
$$ResultPageCount	The maximum search results page number includes all of the <1% search results pages.
$$ResultTotalPages	The maximum search results page number includes all of the <1% search results pages.
$$ResultPagePercentage	Percent of users who found a hit on the current search results page.
$$ResultPageCurrent	The number of the current loop; see the optional # in $$BeginResultPageLoop. 1-based.

12.11.7 Top X Queries

Table 12-14 Top X Queries Query Report Template Variables

Name	Description
$$BeginTopQueriesLoop[#]	Begins a repeating section that displays the most popular user searches. The loop is repeated for the top number of queries. The optional number defaults to 100 if not provided.
$$EndTopQueriesLoop	Ends a repeating section that displays the most popular user searches.
$$TopQuery	The current most-popular query
$$TopSubQuery	All additional queries (separated by beginning and ending parentheses).
$$TopFilterQuery	All filter items (separated by beginning and ending parentheses).
$$TopFileFilterQuery	File filter string.
$$TopQueryTotal	The number of times the current query was requested by all users during the logging period.
$$TopQuerySubTotal	The number of searches represented by the top number of queries listed.
$$TopQueryCurrent	The number of the current loop; see the optional # in $$BeginResultPageLoop[#]. 1-based
$$TopQueryCount	The total number of unique queries requested by all users during the logging period.
$$BeginHasSubQuery	Everything between BeginHasSubQuery and EndHasSubQuery is displayed if any subqueries or filters were sent in the query.
$$EndHasSubQuery	Everything between BeginHasSubQuery and EndHasSubQuery is displayed if any subqueries or filters were sent in the query.

12.11.8 Top Queries

Table 12-15 Top Queries Query Report Template Variables

Name	Description
$$BeginIndexQueryLoop[#]	Begins a repeating section that displays the queries associated with the most popular indexes or the most popular index combinations. The loop is repeated for the top number of queries. The optional number defaults to 25 if not provided.
$$EndIndexQueryLoop	Ends a repeating section that displays the queries associated with the most popular indexes or the most popular index combinations.
$$IndexQuery	The current query associated with the index or index combination.
$$IndexQueryTotal	The number of times the current query was requested by all users during the logging period.
$$IndexQuerySubTotal	The number of searches represented by the number of queries listed.
$$IndexQueryCurrent	The number of the current loop; see the optional # in $$BeginIndexQueryLoop[#]. 1-based.
$$IndexQueryCount	The number of unique queries associated with the current index or index combination.
By Index
$$BeginRptIndexesLoop[#]	Begins a repeating section that displays the most popular indexes. The loop is repeated for the top number of indexes. The optional number defaults to 1000 (that is, all indexes)
$$EndRptIndexesLoop	Ends a repeating section that displays the most popular indexes.
$$RptIndex	The name of the current index.
$$RptIndexQueriesTotal	The total number of times the current index was used in a query.
$$RptIndexCurrent	The number of the current loop; see the optional # in $$BeginRptIndexesLoop[#]. 1-based.
$$RptIndexCount	The total number of times the current index searches unique indexes available for searching (including those that were never used in a user query).
By Index Combinations
$$BeginRptFullIndexesLoop	Begins a repeating section that displays the most popular index combinations. All index combinations are displayed.
$$EndRptFullIndexesLoop	Ends a repeating section that displays the most popular index combinations.
$$RptFullIndex	Displays the list of indexes corresponding to the current loop.
$$RptFullIndexQueriesTotal	The total number of times the current index combination was used in a query.
$$RptFullIndexCurrent	The number of the current loop. 1-based.
$$RptFullIndexCount	The total number of unique index combinations available for searching (including those that were never used in a user query).

12.11.9 Error Searches

Table 12-16 Error Searches Query Report Template Variables

Name	Description
$$BeginErrorQueriesLoop[#]	Begins a repeating section that displays the searches that produced an error. The loop is repeated for the top number of error queries. The optional number defaults to 50.
$$EndErrorQueriesLoop	Ends a repeating section that displays the searches that produced an error.
$$ErrorQuery	The current error query.
$$ErrorSubQuery	All additional queries (separated by beginning and ending parentheses).
$$ErrorFilterQuery	All filter items (separated by beginning and ending parentheses).
$$ErrorFileFilterQuery	File filter string.
$$ErrorQueryTotal	The number of times the current error query was requested by all users during the logging period.
$$ErrorQuerySubTotal	The number of searches represented by the top number of error queries listed.
$$ErrorQueryCurrent	The number of the current loop; see the optional # in $$BeginErrorQueriesLoop[#]. 1-based.
$$ErrorQueryCount	The total number of unique error queries requested by all users during the logging period.
$$BeginHasErrorSubQuery	Everything between BeginHasErrorSubQuery and EndHasErrorSubQuery is displayed if any subqueries or filters were sent in the query.
$$EndHasErrorSubQuery	Everything between BeginHasErrorSubQuery and EndHasErrorSubQuery is displayed if any subqueries or filters were sent in the query.

12.11.10 Not Found Searches

Table 12-17 Not Found Searches Query Report Template Variables

Name	Description
$$BeginNotFoundQueriesLoop[#]	Begins a repeating section that displays the searches that produced a Not Found response. This includes the searches that were successfully resolved by looking elsewhere using the Search Expansion feature. The loop is repeated for the top number of Not Found queries. The optional number defaults to 50.
$$EndNotFoundQueriesLoop	Ends a repeating section that displays the searches that produced a Not Found response.
$$NotFoundQuery	The current Not Found query.
$$NotFoundSubQuery	All additional queries (separated by beginning and ending parentheses).
$$NotFoundFilterQuery	All filter items (separated by beginning and ending parentheses).
$$NotFoundFileFilterQuery	File filter string.
$$NotFoundQueryTotal	The number of times the current Not Found query was requested by all users during the logging period.
$$NotFoundQuerySubTotal	The number of searches represented by the top number of Not Found queries listed.
$$NotFoundQueryCurrent	The number of the current loop; see the optional # in $$BeginNotFoundQueriesLoop[#]. 1-based.
$$NotFoundQueryCount	The total number of unique Not Found queries requested by all users during the logging period.
$$BeginHasNotFoundSubQuery	Everything between BeginHasNotFoundSubQuery and EndHasNotFoundSubQuery is displayed if any subqueries or filters were sent in the query.
$$EndHasNotFoundSubQuery	Everything between BeginHasNotFoundSubQuery and EndHasNotFoundSubQuery is displayed if any subqueries or filters were sent in the query
$$BeginNotFoundIndexesLoop	Begins a repeating section that displays the indexes associated with the current Not Found query. The loop is repeated for all associated indexes.
$$EndNotFoundIndexesLoop	Ends a repeating section that displays the indexes associated with the current Not Found query.
$$NotFoundIndex	The name of the current index.
$$NotFoundIndexQueriesTotal	The number of Not Found queries for a particular index.
$$NotFoundIndexCurrent	The number of the current NotFoundIndex loop. 1-based.
$$NotFoundIndexCount	The total number of indexes associated with the current Not Found query.

12.11.11 Redirected Searches

Table 12-18 Redirected Searches Query Report Template Variables

Name	Description
$$BeginRedirectsLoop[#]	Begins a repeating section that displays the searches that were redirected to a specific, admin-defined URL. The loop is repeated for the top number of redirected queries. The optional # defaults to 50.
$$EndRedirectsLoop	Ends a repeating section that displays the searches that were redirected to a specific, admin-defined URL.
$$RedirectedQuery	The current redirected query.
$$RedirectedQueryTotal	The number of times the current redirected query was requested by all users during the logging period.
$$RedirectedQuerySubTotal	The number of searches represented by the top number of redirected queries listed.
$$RedirectedQueryCurrent	The number of the current loop. 1-based.
$$RedirectedQueryCount	The total number of unique queries that were redirected.

12.11.12 Login Requests

Table 12-19 Login Requests Query Report Template Variables

Name	Description
$$BeginLoginUsersLoop	Begins a repeating section that displays the individual users who were authenticated through QuickFinder.
$$EndLoginUsersLoop	Ends a repeating section that displays the individual users who were authenticated through QuickFinder.
$$LoginUser	Displays the name of the current logged-in user.
$$LoginUserTotal	Displays the total number of times the current user logged in through QuickFinder.
$$LoginUserCurrent	The number of the current loop. 1-based.
$$LoginUserCount	The total number of unique users that successfully logged in through QuickFinder.

12.11.13 Print Details

Table 12-20 Print Details Query Report Template Variables

Name	Description
$$PrintTotal	Displays the total number of print requests handled by QuickFinder during the log period. This includes all print request types (successful and unsuccessful).
$$SuccessfulPrints	Displays the total number of print requests that resulted in successful printed output.
$$NotFoundPrints	Displays the total number of print requests that resulted in a Not Found response.
$$ErrorPrints	Displays the total number of print requests that resulted in an error condition.
$$AvgNumHitsPerPrint	Displays the average number of results per print request.
$$AvgTotalPrints	Displays the average number of total results per print request.
$$AvgPrintTime	Displays the average amount of time required to process a print request. Print requests take much longer than searches because the individual documents must be retrieved from their source location, converted into QuickFinder’s internal Unicode format, then streamed back to the user by using the specified output encoding.

12.11.14 Print Errors

Table 12-21 Print Errors Query Report Template Variables

Name	Description
$$BeginPrintErrorsLoop	Begins a repeating section that displays the print requests that produced an error condition. The loop is repeated for the top number of print requests. The optional number of defaults to 50.
$$EndPrintErrorsLoop	Ends a repeating section that displays the print requests that produced an error condition.
$$PrintErrorQuery	The current print request that resulted in an error response.
$$PrintErrorSubQuery	All additional queries (separated by beginning and ending parentheses).
$$PrintErrorFilterQuery	All filter items (separated by beginning and ending parentheses).
$$PrintErrorFileFilterQuery	File filter string.
$$PrintErrorQueryTotal	The number of times the current print request was issued by all users during the logging period.
$$PrintErrorQuerySubTotal	The total number of print requests represented by the current list of print errors.
$$PrintErrorQueryCurrent	The number of the current loop. 1-based.
$$PrintErrorQueryCount	The total number of unique print requests that produced an error response.
$$BeginHasPrintErrorSubQuery	Everything between BeginHasPrintErrorSubQuery and EndHasPrintErrorSubQuery is displayed if any subqueries or filters were sent in the query.
$$EndHasPrintErrorSubQuery	Everything between BeginHasPrintErrorSubQuery and EndHasPrintErrorSubQuery is displayed if any subqueries or filters were sent in the query.

12.11.15 Highlight Details

Table 12-22 Highlight Details Query Report Template Variables

Name	Description
$$HighlightTotal	Displays the total number of requests for QuickFinder to highlight the user’s search terms within the original document. This includes both successful and unsuccessful highlight attempts.
$$SuccessfulHighlights	Displays the total number of successful requests for QuickFinder to highlight the user’s search terms within the original document.
$$ErrorHighlights	Displays the total number of highlight requests that resulted in an error condition.
$$AvgHighlightTime	Displays the average amount of time required to highlight a user’s search terms within the original document. The majority of the time is spent retrieving the original document.

12.11.16 Export Details

These template variables are used to export a raw version of the entire contents of the query log. The ReportTemplate.html file summarizes the queries for a certain date, and the ExportTemplate.xml file contains a complete copy of the query log formatted so that other query reporting engines can consume the results.

Table 12-23 Export Details Query Report Template Variables

Name	Description
$$BeginEXPORTLoop	Begins a repeating section that exports the query details and subsequent response information associated with all QuickFinder Search, Print, and Highlight requests.
$$EndEXPORTLoop	Ends a repeating section that exports the query details and subsequent response information associated with all QuickFinder search, print, and highlight requests.
$$EXPORTDate	Exports the time and date of the request.
$$EXPORTType	Exports the type of request: search, print, or highlight.
$$EXPORTUser	Exports the IP address making the request.
$$EXPORTUserID	Exports the logged-in UserID, if available.
$$EXPORTLocale	Exports the first locale provided by the request. For example, en or en_US.
$$BeginEXPORTIndexes	Begins a repeating section that exports the indexes associated with a request.
$$EndEXPORTIndexes	Ends a repeating section that exports the indexes associated with a request.
$$EXPORTIndex	Exports the name of the current index associated with the request.
$$BeginEXPORTQueries	Begins a repeating section that exports the user queries associated with each request. Users can send multiple weighted queries with each QuickFinder request.
$$EndEXPORTQueries	Ends a repeating section that exports the user queries associated with each request.
$$EXPORTQuery	Exports the current user query associated with the QuickFinder request. Users can send multiple weighted queries with each request.
$$BeginEXPORTFilters	Exports the filters associated with each QuickFinder request. A filter is used to send additional hidden details with each query. Multiple filters can be associated with each query. Multiple queries can be associated with each request.
$$EndEXPORTFilters	Exports the filters associated with each QuickFinder request. A filter is used to send additional hidden details with each query. Multiple filters can be associated with each query. Multiple queries can be associated with each request.
$$EXPORTFilter	Exports the value of the current filter.
$$EXPORTFileFilter	Exports the value of the file filter associated with the current request.
$$EXPORTResult	Exports the type of the response returned from processing the request: Normal \| Expanded \| Redirected \| ShowFirst \| SearchPage \| Login \| Logout \| NotFound \| Error \| SwitchProtocols.
$$EXPORTTemplate	Exports the name of the template associated with the QuickFinder response.
$$EXPORTPage	Exports the number of the search results page. Begins with 1. Used only for Normal, Expanded, and ShowFirst result types.
$$EXPORTHits	Exports the number of hits associated with the current Search Results page.
$$EXPORTTotalHits	Exports the total number of hits associated with the current request.
$$EXPORTTime	Exports the number of milliseconds required to fully process the request.