DDF Standard Search UI Users Guide
- Jesse Kim (Unlicensed)
Description
The DDF Standard Search UI is an application that not only provides results in a html format but also provides a convenient, simple querying user interface. The left pane of the SearchUI contains basic fields to query the Catalog and other Sources. The right pane consists of a map.
Search Criteria
The SearchUI allows for querying a Catalog in the following methods:
- Keyword Search - searching with keywords using the grammar of the underlying endpoint/Catalog.
- Temporal Search - searching based on relative or absolute time.
- Spatial search - searching spatially with a Point-Radius or Bounding Box.
- Content Type Search - searching for specific Metacard.CONTENT_TYPE values
- Sources - Select from All Sources, or Specific Sources.
- All sources results in an enterprise search where all federations are queried.
- Specific Sources allows the user to select which sources are queried. If a source is unavailable, it will be shown in red text.
Results List Pane Sample Output
| Data Element | Description |
| Result Count | Total Number of Results returned from this query. |
| Query | Return to query pane. |
| Record | Click on Record to view details on the selected record. |
| Result List | Shows the query results from the query search. The results list the following: |
Record Summary Sample Output
| Data Element | Description |
| Results | Navigates back to the original results list of the query. The number of results from the query is also displayed parenthetically. |
| Navigation Arrows | Navigates up and down the summary records in the query results set. If you are at the end of the list going up or down, the respective arrow will be grey and disabled, indicating that you cannot navigate any further in that direction within the set. |
| Summary Tab | Shows a high level overview of the result set. The current view is depicted is the summary view. |
| Details Tab | Shows a more detailed view of the record data in the current record. |
| Title | Displays title of the record. |
| Source | Displays where the metadata came from, which could be the local provider or a federated source. |
| Created Time | Displays when the record was created. |
| Modified Time | Displays how long ago the record was modified. |
| Locate | Centers the map to the current record’s location. |
| Thumbnail | Depicts a reduced size image of the original artifact for the current record, if available. |
| Download | A download link to retrieve the product associated with the record, when applicable. It will also display the size of the product. |
Record Details Sample Output
| Data Element | Description |
| Results | Navigates back to the original results list of the query. The number of results from the query is also displayed parenthetically. |
| Navigation Arrows | Navigates up and down the summary records in the query results set. If you are at the end of the list going up or down, the respective arrow will be grey and disabled, indicating that you cannot navigate any further in that direction within the set. |
| Summary Tab | Shows a high level overview of the result set. The current view is depicted is the summary view. |
| Details Tab | Shows a more detailed view of the record data in the current record. |
| Attributes | Displays record attributes along with the associated values. |
| Metadata | Shows a representation of the metadata XML, if available. |
Query Response Result Mapping
SearchUI Column Title | Catalog Result | Notes |
|---|---|---|
| Title | Metacard.TITLE | The title maybe hyperlinked to view the full Metacard |
| Source | Metacard.getSourceId() | Source where the Metacard was discoved |
| Location | Metacard.LOCATION | Geographical location of the Metacard |
| Time | Metacard.CREATED or Metacard.EFFECTIVE | Time received/created |
| Thumbnail | Metacard.THUMBNAIL | No column shown if no results have thumbnail |
| Resource | Metacard.RESOURCE_URI | No column shown if no results have a resource |
Usage
Clicking on the following link http://localhost:8181/search should bring up the Standard Search UI.
After the page has loaded, enter the desired search criteria in the appropriate fields. Then click the "Search" button in order to execute the search on the Catalog.
The "Clear" button will reset the query criteria specified.
Installation
Search UI App is installed by default. This search UI's feature, search-ui, can be uninstalled or installed using the system console http://localhost:8181/system/console/features
Configuration
In the Admin Console the SearchUI can be configured under the Standard Search UI.
Configurable Properties
Title | Property | Type | Description | Default Value | Required |
|---|---|---|---|---|---|
| Header | header | String | Specifies the header text to be rendered on the SearchUI |
| no |
| Footer | footer | String | Specifies the footer text to be rendered on the SearchUI |
| no |
| Style | style | String | Specifies the style name (background color) of the Header and Footer | yes | |
| Text Color | textColor | String | Specifies the text color of the Header and Footer | yes | |
| WMS Server | wmsServer | String | Specifies the WMS server to be used as the map tile provider | no | |
| WMS Layers | layers | String | Specifies the WMS layers to be used | no | |
| WMS Format | format | String | Specifies the WMS layer format (image/png, etc.) | no |
Whitelist
No packages have been exported by the DDF Standard Search UI.