Versions Compared

Old Version 33

changes.mady.by.user Eudoro Olivares Raniolo

Saved on

compared with

New Version 34

changes.mady.by.user Eudoro Olivares Raniolo

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

KeyData TypeExplanation
features
ObjectFeature configuration
    advancedSearch
BooleanEnable/disable the advanced search feature
    authentication
BooleanEnable/disable all features that rely on authentication (logging in/projects)
    featureFacets
ObjectFeature Facet configuration
        showAvailableFromAwsCloud
BooleanShow/hide the Available from AWS Cloud feature facet
        showCustomizable
BooleanShow/hide the Customizable feature facet
        showMapImagery
BooleanShow/hide the Map Imagery feature facet
footer
ObjectFooter configuration
    attributionText
StringText to display in the footer, example "NASA Official: ..."
    displayVersion
BooleanDisplay the current application version in the footer
    primaryLinks
Array

Array of links to display on the left side of the footer

This array is made up of objects with two values:

{
    href: "The URL the link will follow",
    title: "The viewable text of the link" 
}
    secondaryLinks
ArrayArray of links to display on the right side of the footer. This uses the same objects as `primaryLinks`
moreInfoUrl
String (Optional)This is the URL that users will be sent to when clicking on the logo image. If no value is provided clicking on the logo image will return the user to the EDSC portal home (/portal/example/search).
pageTitle
StringThis will appear after the default portal's `pageTitle` in the HTML page title (see in the tab of the browser). For example if EDSC is the default portal then the page title will be "Earthdata Search :: <pageTitle> | Earthdata Search"
parentConfig
StringThe parent config file for this portal. If your portal will be deployed to EOSDIS Earthdata Search this value should be "edsc". If not, set this to "default".
portalBrowser
BooleanToggle to set whether the portal will appear as a listed portal in the portal browser modal
query
Object (Optional)

These parameters are used to filter the list of collections exposed in the portal. 

Current supported values:

  • consortium (Array of strings)
  • dataCenter (String)
  • echoCollectionId (this narrows the results to a single collection, only used as an example) (String)
  • hasGranulesOrCwic (set to null to include all collections)
  • project (String)
  • tagKey (String or String array)

One common pattern is to show all the datasets in a dataCenter. This example shows the ORNL DAAC portal configuration:

  "query": {
    "dataCenter": "ORNL_DAAC",
    "hasGranulesOrCwic": null
  },

Likewise, for Science Project-focused portals, here is the AIRMOSS project portal:

  "query": {
    "project": "AirMOSS",
    "hasGranulesOrCwic": null
  },

A more nuanced approach can be applied using tags in CMR.  Here is an example from the Suborbital portal using the tagKey parameter (note that the tagKey can contain simple wildcards):

  "query": {
    "tagKey": ["gov.nasa.impact.*"],
    "hasGranulesOrCwic": null
  },

If you need support of another CMR query parameter, please contact us.

Refer to the CMR documentation for information on parameters:
https://cmr.earthdata.nasa.gov/search/site/search_api_docs.html 

title
Object

Object containing the primary and secondary title for the portal.

    primary
StringThe primary field in the title object will be displayed on the portal browser modal as the top identifier. It will also be displayed on the top left portal browser context sidebar header and on the leave portal button on the bottom of the collection search results while inside of a portal.
    secondary
StringThe secondary field in the title object will be displayed below the primary on the portal browser modal and in parentheses on the top left portal browser context sidebar header. It is meant to be the fullname of the project, endeavor, organization behind the creation of the portal.
ui
ObjectUI configurations
    showNonEosdisCheckbox
Boolean
    showOnlyGranulesCheckbox
BooleanShow/hide the "
    showTophat
BooleanShow/hide Tophat (Note: This field is deprecated on used only for the defaultPortal  in the deployed instance of EDSC it can be used environment for EDSC, as such new portals cannot hide this UI field in the deployed env. It can however, be changed locally if you set the defaultPortal  to the created portal in overrideStatic.config.json)

...