Page History

...

UI Expand

title	Configure Download Methods for Collections

UI Text Box

type	info

These steps can be used to enable Stage for Delivery or Customized download options.

UI Steps

size	small

UI Step

LOGIN to the Metadata Management Tool at https://mmt.earthdata.nasa.gov/.

UI Text Box

type	tip

This method will enable download options in the PROD environment only. For changes to UAT use https://mmt.uat.earthdata.nasa.gov/. For changes to SIT use https://mmt.sit.earthdata.nasa.gov/.

Image Modified

UI Step

SELECT the appropriate provider in both the context drop-down and under "Provider." SELECT the Services radio button, then CLICK Search Services.

Image Modified

UI Step

CLICK the appropriate service implementation record.

UI Text Box

type	tip

The service implementation options will vary by data provider.

Image Modified

UI Step

CLICK on Manage Collection Associations.

Image Modified

UI Step

To add a collection for this service implementation record, CLICK on Add Collection Associations.

Alternatively, to delete a collection for this service implementation record, SELECT the appropriate collection by marking the checkbox next to the entry title, then CLICK Delete Selected Associations.

UI Text Box

type	tip

Check for existing collection associations by SEARCHING the records for the collection entry title or short name. This is most easily done by using the Command+F function on Mac, or Control+F function on Windows. Please note, there may be several pages of collections sorted in alphabetical order.

Image Modified

UI Step

SELECT a Search Field and ENTER the appropriate Search Term to find the collection of interest. CLICK the + button to add each collection of interest. Once all collections have been added, CLICK Submit.

UI Text Box

type	note

The Earthdata Search background job that searches for new or updated collection associations runs every 4 hours, and takes approximately 45 minutes to complete. It may take some time before you see any changes on the Earthdata Search website.

Image Modified

UI Expand

title	Confirm Existing Download Methods for Collections

UI Text Box

type	tip

These steps can be done in a web browser, using the terminal or command line, or by using a dedicated application for API environments (i.e. Postman). These instructions will be shown using a web browser.

UI Steps

size	small

UI Step

Using the following URL format, NAVIGATE to the page below in a web browser.

https://cmr.earthdata.nasa.gov/search/collections.json?ECHO_collection_id=<ECHO_collection_id>&include_tags=*

Example for concept ID C1299783579-LPDAAC_ECS: https://cmr.earthdata.nasa.gov/search/collections.json?ECHO_collection_id=C1299783579-LPDAAC_ECS&include_tags=*

UI Text Box

type	info

This example uses the echo_collection_id parameter to find the appropriate collection. The list of available parameters to search for in the CMR API can be found at https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html.

Image Modified

UI Step

RETRIEVE a token (if necessary). Some collections and/or data providers require a token to access the CMR API information. In this case, the response returned from CMR would be blank. An example would be concept ID C1236303843-NSIDC_ECS.

Image Modified

In this case the URL format should be as follows, to include a token:

https://cmr.earthdata.nasa.gov/search/collections.json?ECHO_collection_id=<ECHO_collection_id>&include_tags=*&token=<token>

A token can be retrieved using the Postman POST Request file below. In the Body of the request, replace the username and password with your Earthdata Login credentials.

View file

name	Get Token.postman_collection.json
height	150

UI Step

Various tags for the collection can be found in the metadata, depending on the download method of interest.

UI Expand

title	Direct Download

An example collection for Direct Download would be concept ID C194001241-LPDAAC_ECS. The tag associations for direct download can be found under:

edsc.extra.serverless.collection_capabilities

granule_online_access_flag

https://cmr.earthdata.nasa.gov/search/collections.json?ECHO_collection_id=C194001241-LPDAAC_ECS&include_tags=*

The granule_online_access_flag is set by granule metadata within the collection. The granule(s) must have an OnlineAccessURL tag in its metadata. Earthdata Search inspects the first granule for this OnlineAccessURL tag that is then used to enable Direct Download for the collection.

An example for this same collection would be granule concept ID G1658148046-LPDAAC_ECS.

https://cmr.earthdata.nasa.gov:443/search/concepts/G1658148046-LPDAAC_ECS/1

Image Modified

UI Expand

title	Stage for Delivery

An example collection for Stage for Delivery would be concept ID C1299783579-LPDAAC_ECS. The tag associations for the ECHO orders service implementation can be found under edsc.extra.serverless.subset_service.ECHO_orders.

https://cmr.earthdata.nasa.gov/search/collections.json?ECHO_collection_id=C1299783579-LPDAAC_ECS&include_tags=*

Image Modified

The id field under the data tag displays the service implementation ID. In this example, the service implementation ID is S1568897323-LPDAAC_ECS.

Using the steps above under 'Configure Download Methods for Collections,' this ID number will correlate with the MMT service implementation record ID. This ID can be seen in the URL of the MMT Service Implementation page.

https://mmt.earthdata.nasa.gov/services/S1568897323-LPDAAC_ECS

Image Modified

UI Expand

title	Customized

An example collection for Customized Download would be C43677706-LARC. The tag associations for the ESI service implementation can be found under edsc.extra.serverless.subset_service.esi.

https://cmr.earthdata.nasa.gov/search/collections.json?ECHO_collection_id=C43677706-LARC&include_tags=*

Image Modified

The following tags determine the various badges seen on the Earthdata Search collections page. The tags are generated by CMR, referencing the UMM-S record.:

has_spatial_subsetting
has_transforms
has_variables
has_formats
has_temporal_subsetting

Image RemovedImage Added

The id field under service_option_definitions is the ID for the ECHO form used to generate the customized options available on the Earthdata Search project page.

In this example the ECHO form ID is 15E07651-0061-8ACF-75BF-81B91D9FFFB0. The name of the ECHO form is MIL2ASAE.2 ESI Service.

Image RemovedImage Added

UI Step

CONFIRM the appropriate Earthdata Search tags are associated with the collection. If the appropriate tags for the associated download method are missing, the download option on Earthdata Search will not be made available.

UI Text Box

type	note

The Earthdata Search background job that searches for new or updated collection associations runs every 4 hours, and takes approximately 45 minutes to complete. It may take some time before you see any changes on the Earthdata Search website.

UI Expand

title	Check the UMM-S Record for Collections

UI Text Box

type	info

These steps can be used to check UMM-S records for Stage for Delivery or Customized download options. This example will show a Customized download option.

UI Steps

size	small

UI Step

Using the following URL format, NAVIGATE to the page below in a web browser.

https://cmr.earthdata.nasa.gov/search/collections.json?ECHO_collection_id=<ECHO_collection_id>&include_tags=*

An example collection for Customized Download would be C43677706-LARC.

https://cmr.earthdata.nasa.gov/search/collections.json?ECHO_collection_id=C43677706-LARC&include_tags=*

Image Modified

UI Text Box

type	info

This example uses the echo_collection_id parameter to find the appropriate collection. The list of available parameters to search for in the CMR API can be found at https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html.

UI Step

RETRIEVE a token (if necessary). Some collections and/or data providers require a token to access the CMR API information. In this case, the response returned from CMR would be blank. An example would be concept ID C1236303843-NSIDC_ECS.

Image Modified

In this case the URL format should be as follows, to include a token:

https://cmr.earthdata.nasa.gov/search/collections.json?ECHO_collection_id=<ECHO_collection_id>&include_tags=*&token=<token>

A token can be retrieved using the Postman POST Request file below. In the Body of the request, replace the username and password with your Earthdata Login credentials.

View file

name	Get Token.postman_collection.json
height	150

UI Step

FIND the ECHO form ID and name in the collection metadata. The id field under service_option_definitions is the ID for the ECHO form used to generate the customized options available on the Earthdata Search project page.

In this example the ECHO form ID is 15E07651-0061-8ACF-75BF-81B91D9FFFB0. The name of the ECHO form is MIL2ASAE.2 ESI Service.

Image Removed

UI Step

LOGIN to the Metadata Management Tool at https://mmt.earthdata.nasa.gov/.

UI Text Box

type	tip

To view ECHO forms for UAT use https://mmt.uat.earthdata.nasa.gov/. For SIT use https://mmt.sit.earthdata.nasa.gov/.

Image AddedImage Modified

UI Step

SELECT the appropriate provider in the context drop-down menu.

Image Modified

UI Step

CLICK on Manage CMR.

Image Modified

UI Step

Under Service Management, CLICK on View Service Options.

UI Text Box

type	tip

The Service Management → View Service Options will show Customized/ESI ECHO forms.

The Orders → View Order Options will show Stage for Delivery ECHO forms.

Image Modified

UI Step

Using the ECHO form name found in Step 3, SEARCH then CLICK on the appropriate ECHO form to view the XML document.

Alternatively, CLICK on Edit or Delete to perform those actions.

UI Text Box

type	tip

Searching for the appropriate ECHO form is most easily done by using the Command+F function on Mac, or Control+F function on Windows. Please note, there may be several pages of forms which are sorted in alphabetical order.

Image Modified

UI Step

The ECHO form XML will load.

UI Text Box

type	tip

Please note the URL of the ECHO form XML matches the ECHO form ID found in Step 3. In this example the ECHO form ID is 15E07651-0061-8ACF-75BF-81B91D9FFFB0.

An alternative to Steps 4 - 8 is to use the ECHO form ID in the following URL format:

https://mmt.earthdata.nasa.gov/service_options/<ECHOFormID>

Using this example: https://mmt.earthdata.nasa.gov/service_options/15E07651-0061-8ACF-75BF-81B91D9FFFB0

Image Modified

Space shortcuts

Child pages

Versions Compared

Old Version 34

New Version Current

Key