Versions Compared

Old Version 29

changes.mady.by.user Ryan Abbott

Saved on

compared with

New Version 30

changes.mady.by.user Matthew Crouch

Saved on

Key

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

...

KeyData TypeExplanation
featuresObjectFeature configuration
    advancedSearchBooleanEnable/disable the advanced search feature
    authenticationBooleanEnable/disable all features that rely on authentication (logging in/projects)
    featureFacetsObjectFeature Facet configuration
        showAvailableFromAwsCloudBooleanShow/hide the Available from AWS Cloud feature facet
        showCustomizableBooleanShow/hide the Customizable feature facet
        showMapImageryBooleanShow/hide the Map Imagery feature facet
footerObjectFooter configuration
    displayVersionBooleanDisplay the current application version in the footer
    attributionTextStringText to display in the footer, example "NASA Official: ..."
    primaryLinksArray

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

This array is made up of objects with two values:

{
    title: "The viewable text of the link", 
    href: "The URL the link will follow"
}
    secondaryLinksArrayArray of links to display on the right side of the footer. This uses the same objects as `primaryLinks`
hasStyles
Boolean

This tells EDSC if it needs to load a "styles.scss" file,  see Advanced Configuration.

hasScripts
BooleanThis tells EDSC if it needs to load a "scripts.js" file, see Advanced Configuration.
logo
Object (Optional)Configuration for a logo to appear to the right of the NASA logo in the upper left of the page. If omitted, no logo will be added.
    id
String (Optional)This is the id attribute of the <a> tag that houses the logo image, see Advanced Configuration.
    image
String (Optional)Path to logo image. This is not recommended, please see Advanced Configuration for the preferred method of adding the logo image.
    link
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).
    title
String (Optional)This text is set as the title attribute in the <a> tag that houses the logo image, it will be displayed when you user hovers their mouse over the logo
org
String (Optional)A short string representing the organization that replaces "Earthdata" in the top-left of the site toolbar. If omitted, it will just say "Earthdata."
pageTitleStringThis will appear after the default portal's `org` and `title` 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>"
parentConfigStringThe 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".
query
Object (Optional)

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

Current supported values:

  • tagKeyconsortium
  • dataCenter
  • project
  • hasGranulesOrCwic (set to null to include all collections)
  • echoCollectionId (this narrows the results to a single collection, only used as an example)
  • hasGranulesOrCwic (set to null to include all collections)
  • project
  • tagKey

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
String (Optional)

A short string to be used when referring to the portal. This will appear verbatim where the word "Search" is in the top-left of the site toolbar and will appear in various other places as "Example Portal" when referring to the portal. If omitted, a capitalized version of the portal ID will be used, i.e. "Example."

uiObjectUI configurations
    showOnlyGranulesCheckboxBooleanShow/hide the "
    showNonEosdisCheckboxBoolean
    showTophatBooleanShow/hide Tophat

...