-
Notifications
You must be signed in to change notification settings - Fork 20
ESGF_New_Facets
| Wiki Reorganisation |
|---|
| This page has been classified for reorganisation. It has been given the category MOVE. |
| The content of this page will be revised and moved to one or more other pages in the new wiki structure. |
A common need of many projects is to allow its users to search for data based on a set of specific search categories (a.k.a. facets). The ESGF infrastructure makes adding new facets extremely simple. In short, two things need to happen:
-
The desired facet name and values need to be included in the THREDDS catalogs as property tags:
- For example, to add a new facet called "continent", publish THREDDS catalogs with property tags such as
-
The new facet needs to be configured as a new allowed search category in the ESGF web portal:
-
For the search back-end services, the facet key needs to be entered in the property file /usr/local/tomcat/webapps/esg-search/WEB-INF/classes/esg/search/config/facets.properties
-
For the search web portal user interface, you must add a _ facet name:facet label _ pair to the properties file /usr/local/tomcat/webapps/esgf-web-fe/WEB-INF/classes/longnames.properties
- For example, add the following to the end of the longnames.properties file: continent:Earth Continent (preceding with a _ ; _ to separate from previous entries).
-
After restarting Tomcat, the new facet is available for searching and for wget-scripting.
That's it! If you want to know more details, please read on...
When parsing THREDDS catalogs, the ESGF publishing service will interpret any unknown tag as a facet of type _ string _ , with multiple possible values (if the facet is intended to be of numeric type, like integer or float, it needs to be explicitly configured in the Solr schema). All the facet (name, value) pairs will be ingested into the Solr index, but they still need to be explicitly configured in the above mentioned property files to be available as valid request parameters in the ESGF web portal and back-end search services. This design decision was motivated by the need to _ not _ allow arbitrary query parameters to be present in the HTTP request, for security reasons.
Please note that in the future, the two configuration files _ facet.properties _ and _ longnames.properties _ will be consolidated in a single configuration file, external to the source code distribution, so that site-specific changes can survive software upgrades.