:title: Catalog UI Search
:id: org.codice.ddf.catalog.ui
:type: table
:status: published
:application: ${ddf-ui}
:summary: Catalog UI Search.

.[[_org.codice.ddf.catalog.ui]]{title}
[cols="1,1m,1,3,1m,1" options="header"]
|===

|Name
|Id
|Type
|Description
|Default Value
|Required

|Result Count
|resultCount
|Integer
|Specifies the number of results to request from each source.
|250
|true

|Export Result Limit
|exportResultLimit
|Integer
|Specifies the max number of results that can be exported.
|1000
|true

|Imagery Providers
|imageryProviders
|String
a|List of imagery providers to use.

The valid types are:

* *OSM* (OpenStreetMap)
* *AGM* (ArcGisMap)
* *BM* (BingMap)
* *WMS* (WebMapService)
* *WMT* (WebMapTile)
* *TMS* (TileMapService)
* *GE* (GoogleEarth)

*OSM example*: `{"name": "Example OSM", "show": true, "type": "OSM", "url": "http://a.tile.openstreetmap.org", "fileExtension": "png", "order": 0, "alpha": 1, "proxyEnabled": false}`

*AGM example*: `{"name": "Example AGM", "show": true, "type": "AGM", "url": "https://server.arcgisonline.com/arcgis/rest/services/World_Imagery/MapServer", "order": 0, "proxyEnabled": false, "alpha": 1}`

*WMS example*: `{"name": "Example WMS", "show": true, "type": "WMS", "url": "http://suite.opengeo.org/geoserver/gwc/service/wms", "layers" : ["opengeo:countries"], "parameters": {"FORMAT": "image/png", "VERSION": "1.1.1"}, "order": 0, "alpha":1, "proxyEnabled": false}`

*WMT example*: `{ "parameters": { "transparent": false, "format": "image/jpeg" }, "name": "Example WMT", "tileMatrixLabels": [ "EPSG:4326:0", "EPSG:4326:1", "EPSG:4326:2", "EPSG:4326:3", "EPSG:4326:4", "EPSG:4326:5", "EPSG:4326:6", "EPSG:4326:7", "EPSG:4326:8", "EPSG:4326:9", "EPSG:4326:10", "EPSG:4326:11", "EPSG:4326:12", "EPSG:4326:13", "EPSG:4326:14", "EPSG:4326:15", "EPSG:4326:16", "EPSG:4326:17", "EPSG:4326:18", "EPSG:4326:19", "EPSG:4326:20", "EPSG:4326:21" ], "tileMatrixSetID": "EPSG:4326", "order": 0, "url": "http://suite.opengeo.org/geoserver/gwc/service/wmts", "layer": "opengeo:countries", "style": "", "proxyEnabled": false, "type": "WMT", "show": true, "alpha": 1}`

*TMS example* (3D map support only): `{ "name": "Example TMS", "show": true, "type": "TMS", "order": 0, "url": "https://cesiumjs.org/tilesets/imagery/blackmarble", "proxyEnabled": false, "alpha": 1}`

*Multiple layer example*: +
_Topmost Layer_: `{ "name": "Example AGM", "show": true, "type": "AGM", "url": "https://server.arcgisonline.com/arcgis/rest/services/World_Imagery/MapServer", "order": 0, "proxyEnabled": false, "alpha": 1}` +
_Bottommost Layer_: `{ "name": "Example AGM 2", "show": true, "type": "AGM", "url": "https://server.arcgisonline.com/arcgis/rest/services/World_Street_Map/MapServer", "order": 1, "proxyEnabled": false, "alpha": 1}`
|
|false

|Terrain Provider
|terrainProvider
|String
|Terrain provider to use for height data. Valid types are: *CT* (CesiumTerrain), *AGS* (ArcGisImageServer), and *VRW* (VRTheWorld).

Example:
`{"type": "CT", "url": "http://example.com"}`
|{ "type": "CT"\, "url": "http://assets.agi.com/stk-terrain/tilesets/world/tiles" }
|false

|Default Layout
|defaultLayout
|String
|The default UI layout and visualization configuration used in the Catalog UI. See http://golden-layout.com/docs/Config.html {external-link} for more information. Example: `[{"type": "stack", "content": [{"type": "component", "component": "cesium", "componentName": "cesium", "title": "3D Map"}, {"type": "component", "component": "inspector", "componentName": "inspector", "title": "Inspector"}]}]`.
|[{"type": "stack", "content": [{"type": "component", "component": "cesium", "componentName": "cesium", "title": "3D Map"}, {"type": "component", "component": "inspector", "componentName": "inspector", "title": "Inspector"}]}]
|true

|Visualizations
|visualizations
|String
|Visualizations that should be recognized by golden layout. Example `[{"name":"openlayers","title":"2D Map","icon":"map"},{"name":"cesium","title":"3D Map","icon":"globe"},{"name":"inspector","title":"Inspector","icon":"info"},{"name":"histogram","title":"Histogram","icon":"bar-chart"},{"name":"table","title":"Table","icon":"table"}]`
|[{"name":"openlayers","title":"2D Map","icon":"map"},{"name":"cesium","title":"3D Map","icon":"globe"},{"name":"inspector","title":"Inspector","icon":"info"},{"name":"histogram","title":"Histogram","icon":"bar-chart"},{"name":"table","title":"Table","icon":"table"}]
|false

|Map Projection
|projection
|String
|Projection of imagery providers (for example, `EPSG:3857`, `EPSG:4326`).
|EPSG:4326
|false

|Bing Maps Key
|bingKey
|String
|Bing Maps API key. This should only be set if you are using Bing Maps Imagery or Terrain Providers.
|
|false

|Connection Timeout
|timeout
|Integer
|Specifies the client-side connection timeout in milliseconds.
|300000
|false

|Source Poll Interval
|sourcePollInterval
|Integer
|Specifies the interval to poll for sources in milliseconds.
|60000
|true

|Show Sign In
|signInEnabled
|Boolean
|Allow Sign In to Search UI and welcome notice. Enable this if the Search UI is protected.
|true
|false

|Show Tasks
|taskEnabled
|Boolean
|Show task menu area for long running actions.
|false
|false

|Show Gazetteer
|gazetteerEnabled
|Boolean
|Show gazetteer for searching place names.
|true
|false

|Use Online Gazetteer
|onlineGazetteerEnabled
|Boolean
|Should the online gazetteer be used? If unchecked, a local gazetteer service is used. This only applies to the search gazetteer in Intrigue.
|true
|false

|Enable Cache
|cacheEnabled
|Boolean
|Locally cached results are returned in search results.
|true
|true

|Allow Editing
|editingEnabled
|Boolean
|Allow editing capability to be visible in the UI.
|true
|true

|Enable Web Sockets
|webSocketsEnabled
|Boolean
|Enables use of Web Sockets
|true
|false

|Enable Local Catalog
|localCatalogEnabled
|Boolean
|Enables queries to the local catalog.
|true
|true

|Enable Experimental Features
|experimentalEnabled
|Boolean
|WARNING: Enables experimental features in the UI. This allows users to preview upcoming features.
|false
|true

|Show Relevance Scores
|relevanceScoresEnabled
|Boolean
|Toggle the display of relevance scores of search results.
|false
|false

|Relevance Score Precision
|relevancePrecision
|Integer
|Set the number of digits to display in for each relevance score. The default is 5 (for example, 12.345).
|5
|false

|Show Logo in Title Bar
|logoEnabled
|Boolean
|Toggles the visibility of the logo in the menu bar.
|false
|false

|Enable Unknown Error Box
|unknownErrorBoxEnabled
|Boolean
|Enable Unknown Error Box visibility.
|true
|false

|Enable Metacard Preview
|metacardPreviewEnabled
|Boolean
|Enable Metacard Preview in the Inspector.
|true
|true

|Enable Spellcheck
|spellcheckEnabled
|Boolean
|Enable spellcheck for searches.
|false
|false

|Enable Similar Word Matching
|phoneticsEnabled
|Boolean
|Enable phonetic and synonym matching for searches.
|false
|false

|Basic Search Temporal Selections
|basicSearchTemporalSelectionDefault
|String
|Enable Basic Search Temporal Selections.
a|* `created`
* `effective`
* `modified`
* `metacard.created`
* `metacard.modified`
|true

|Basic Search Match Type Metacard Attribute
|basicSearchMatchType
|String
|Metacard attribute used for Basic Search Type Match.
|datatype
|true

|Type Name Mapping
|typeNameMapping
|String
|Mapping of display names to content types in the form name=type.
|
|false

|Read Only Metacard Attributes
|readOnly
|String
|List of metacard attributes that are read-only. NOTE: the provided values are evaluated as JavaScript regular expressions when matched against metacard attributes.
a|* `^checksum$`
* `^checksum-algorithm$`
* `^id$`
* `^resource-download-url$`
* `^resource-uri$`
* `^resource.derived-uri$`
* `^resource.derived-download-url$`
* `^modified$`
* `^metacard-tags$`
* `^metadata$`
* `^metacard-type$`
* `^source-id$`
* `^point-of-contact$`
* `^metacard.`
* `^version.`
* `^validation.`
|false

|Summary Metacard Attributes
|summaryShow
|String
|List of metacard attributes to display in the summary view.
a|* `created`
* `modified`
* `thumbnail`
|false

|Result Preview Metacard Attributes
|resultShow
|String
|List of metacard attributes to display in the result preview.
|
|false

|Query Schedule Frequencies
|scheduleFrequencyList
|Long
|Custom list of schedule frequencies in seconds. This overrides the frequency list in the query schedule tab. Leave this empty to use the frequency list on the Catalog UI.
a|* `1800`
* `3600`
* `7200`
* `14400`
* `28800`
* `57600`
* `86400`
|true

|Maximum Endpoint Upload Size
|maximumUploadSize
|Integer
a|The maximum size (in bytes) to allow per client when receiving a POST/PATCH/PUT.

NOTE: this does not affect resource upload size, just the maximum size allowed for calls from Intrigue.
|1048576
|true

|Map Home
|mapHome
|String
|Specifies the default home view for the map by bounding box. The format is "`West, South, East, North"`, where North, East, South, and West are coordinates in degrees. An example is: `-124, 60, -100, 40`.
|
|false

|UI Product Name
|product
|String
|Specifies a custom UI product name in the UI.
|Intrigue
|true

|Upload Editor: Attribute Configuration
|attributeEnumMap
|String
|List of attributes to show in the upload editor. See <<{metadata-prefix}catalog_taxonomy_definitions,Catalog Taxonomy>>
for a list of supported attributes.

Supported entry syntax: +
1. `attribute` +
2. `attribute=value1,value2,...`

Using the first syntax, the editor attempts to determine the appropriate control to display
based on the attribute datatype.
The second syntax forces the editor to use a dropdown selector populated with the provided
values. This is intended for use with String datatypes, which by default may be assigned any value.
|
|false

|Upload Editor: Required Attributes
|requiredAttributes
|String
|List of attributes which must be set before an upload is permitted. If an attribute is
listed as required but not shown in the editor, it is ignored.
|
|false

|===
