addedValues Plugin

Search Reports

Introduction

A search report is a text string constructed using the values from hitLists - collection of addedValues Entities returned by a search. Searches are always generated by queries, even when initiated from a search form and their output is results a sequence of hits - references to messages, gems, etc. and they have an order as defined by the query (or search form). Conventionally a search report provides links to each individual addedValues Entity in the hitlist, but this is up to the discretion of the addedValues programmer.

Search report come in many favours, which are considered seperately

• Search Results - present hitlist as a formatted sequence of Item Detail Reports, one per hit.
• "Picklist" - present hitlist in a form that calls an updater for hits selected manually.
• Calendar - presents hitList as a calendar
• "Tabulation" - presents hitlist as a 2-dimensional table
• "RSS Report" - presents hitlist as an RSS feed
• Export Report - presents hitlist as single flat downloadable file (GEM)

Report Options

• Default Date Format - set the way in which dates are coerced into strings
• Hits In Descending Order - start from the end or the beginning of the hitsList
• Never Use Group Layout - whether to break on changes in the sorted by variables value.
• "RPC Search OK?" - whether this report can be displayed from outside the website
• "Values for" -
• "Accumulators" -

• Enable Delete Button? - whether a picklist report should contain a delete button
• "Enable Hitlist Filtering?" -

• "Show incomplete rows only" - tabulation only

• "RSS feed must be SSL" -
• "RSS Feed Configure" -

See Also

b284 - Until now the search report pseudo variables hitsperpage, totalhits, firstpagehit, lastpagehit, hitspergroup in header layout text and hitnumber, hiturl, hitkeyvalue, and hitdgurl in report layouts were not permitted as the parameters of macros and builtin functions. Now they can be used freely inside macro evaluations , subject to normal addedValue type checking - without the [[ and ]] delimiters or being quoted, for example, {string.percent(firstpageHit, totalHits, 2)} or {"hit " + addedValueMacros.getlink(hitnumber, hiturl)}

b284 - Hitlist filtering is the ability to review the results of a query, the hitlist, manually and remove elements before calling up the report which displays the results. It is most useful if the report will be printed or exported in some way. To enable hitlist filtering, set the new search report option from the dropdown menu called "Choose a manual filter'. That menu will only exist if there are picklist reports for the same attribute of and groupname as the search report you are filtering and which have the new option 'Enable hitlist filtering?' set. When a query macro call uses a filtered search report, addedValues will first display the hitlist with the picklist report and permit discarding any of the hits, until the continue button is clicked. Then the reduced hit list will be displayed using the original search report.