Table of Content
- Result content
- Result ordering
- Result boosting
- Result pagination
- Result page URL
- Navigation towards the DE visualisation page
When users perform a free text search or browse by a facet from the .Stat DE homepage, then a page with the results of the search is presented. The search result page displays a list of all the corresponding hits from the search, along with the associated facets depending on the current search context (see documentation on Facets).
The total number of search hits is displayed on top of the search result page content, followed by the first set of the most relevant search results.
The search results page is paginated and lists all result hits.
Each search result is divided into three parts:
- The first part displays the basic information by default (in the collapsed mode);
- The second part displays extended information in the expanded mode;
- third part is the set of options on the right side.
The following information is displayed for each search result:
- Default display of basic information (collapsed mode)
- The localised dataflow name (or its ID if no localised dataflow name exists) linking to the table data preview. The link takes the current search terms into account.
- The localised dataflow description if exists. It is shortened to 3 lines if too long.
- The localied comma-separated list of dataflow dimension names (in the order of their definition in the DSD) that have more than one dimension value with real data (according to actual data availability).
- The localised name of values of dataflow dimensions (togther with the localised dimension name), which have search hits. One line per dimension.
Expandicon to display extended information (see below).
Downloadicon to download the entire dataflow content in SDMX-CSV format. (For details see the sub-section below.)
- When a free text search is performed, then all the search term(s) is/are highlighted in each of the above pieces of information. See documentation on How free text search hits are displayed.
- Display of additional extended information (expanded mode)
- The entire description becomes visible if it was shortened in the default display.
- The comma-separated values for all home page facets for this dataflow prefixed with ‘
... >’ when a value has a parent hierarchy, and with the facet names, e.g., ‘
Topic: ... > Health Status, ... > Production, Environment’, unless the facet is already listed as a dimension with a free-text search hit under the basic information. One line per facet. All values not fitting on one line are replaced by 3 dots
.... When there is a hierarchy, then the whole parent hierarchy is made available in a black tooltip on mouseover (similar to “Applied filters”).
- The date/time of the last update of the dataflow
Collapseicon (instead of the
Expandicon) in order to return to the default display (see above).
Optional download feature
When this option is enabled (see the configuration documentation), then two options of download are made available in the search result objects:
- Download of the complete unfiltered dataflow data in tabular text (SDMX-CSV format) using the current language;
- (since March 10, 2021 Release .Stat Suite JS 7.1.0) Download any additional files that are attached to the dataflow through the SDMX
EXT_RESOURCEannotation (see the related specifications).
Released with April 11, 2022 .Stat Suite JS 14.0.0
By default, the search result dataflows are sorted in this order:
- Descending relevance (where the free-text was found, dataflow boost)
- Ascending alphabetical (localised dataflow name)
- Descending “Last updated” date
In order to easier find specific dataflows, the user can change the sort order by selecting one of the predefined criteria using the dropdown menu:
Released with April 11, 2022 .Stat Suite JS 14.0.0
The default relevance score used to order the search results depends on where the search term was found, which can be customised as documented here.
The .Stat faceted search allows using the dataflow annotation of type
SEARCH_WEIGHT to boost dataflows in the search result order when ordered by “Relevance”.
SEARCH_WEIGHT annotation needs to be of type “SEARCH_WEIGHT”. The weight value is an integer or number and should be set:
- in the localised Annotation Text, in case the boost is language-dependent, otherwise
- in the non-localised Annotation Title
<common:Annotations> <common:Annotation> <common:AnnotationTitle>2</common:AnnotationTitle> <common:AnnotationType>SEARCH_WEIGHT</common:AnnotationType> <common:AnnotationText xml:lang="en">3</common:AnnotationText> <common:AnnotationText xml:lang="es">4</common:AnnotationText> <common:AnnotationText xml:lang="fr">5</common:AnnotationText> </common:Annotation> </common:Annotations>
The localised boost value, if available, or alternatively the non-localised boost value is used to multiply the dataflow score calculated by Solr and thus influences accordingly the ordering by relevance. The bigger the calculated score value, the higher is the listing of the dataflow in the search results.
Weight value and Solr search engine score
The Solr search engine determines the score per dataflow automatically depending on the count and location of search hits in the different dataflow properties (searched fields), before it multiplies that score with the dataflow’s
SEARCH_WEIGHT annotation value, if present. The
SEARCH_WEIGHT boost value should be smaller than 1 to decrease the score and higher than 1 to increase the score. The value has no limits other than the ones defined by the internal number type.
The “developer tools” of the web browser (accessibly through the F12 key) allow seeing the current final Solr score per dataflow for a specific query in the response message of the search requests (look out for queries to https://example.org/api/search?tenant=xxxxx). This analysis can be used to determine the optimal
SEARCH_WEIGHT boost values.
Search results are paginated, and the number of results per page is configurable (see Documentation).
By using the feature at the bottom right side of the search results page, the user can move to the next, first or last page by using the corresponding arrows
>|. The user can also enter a page number in the appropriate box.
Result page URL
The search result page(s) can also be accessed through a direct link, because some of the user’s choices and options are part of the URL, which can thus be shared or bookmarked.
The configurations of the search results included in the URL are listed and explained in the following table:
|locale||string||locale of the app||lc=fr|
|facet||string||open box in side in search results||fc=qmsoRy4r|
|start||integer||page index of the search||pg=0|
|constraints||array||selected facets of the search||constraints=SIS-CC-stable|
|hasAccessibility||boolean||a11y mode of the app||ac=false|
|hasDataAvailability||boolean||sdmx data availability mode||hasDataAvailability=false|
Note that the full set of configurations of the URL is listed in the Viewing data topic.
Navigation towards the DE visualisation page
When the user clicks on a search result name from the search result page, then she/he is forwarded to the DE data visualisation page that corresponds to the selected result.
The filter selections are also kept to the visualisation page that uses it to make the automated filter selections. For example, if the user has selected a reference area in the reference area facet of the search result page, then this selection is maintained in the reference area filter in the data visualisation page.
(since May 19, 2021 Release .Stat Suite JS 8.0.0) If the free-text search is used and a “perfect match” (excluding non-alphanumeric characters) search hit is found within a dimension value, and if such dimension has no facet selection, then instead of DEFAULT selections, automatically the (perfect match) value(s) is selected in the filter of the data visualisation page for that dimension.
Example with searching terms “GDP current prices France”:
- In the dataflow “SDMX-CountryData” visualisation:
- The “Series” dimension will only be filtered on the value “GDP (current prices)”;
- The “Reference Area” dimension will only be filtered on the value “France”;
- The DEFAULT selections -if any- will apply on the other dimensions not concerned by the hit of the free-text search.
- In the dataflow “SDMX_-CountryData_UIS_UNData” visualisation:
- The “Reference Area” dimension will only be filtered on the value “France”.