Premise

These changes were requested by NSIDC and LPDAAC to reduce the number of failed requests that enter the system. On the front page of Earthdata Search Client, if an end user searches for granules using a bounding rectangle, the coordinates of that rectangle will be pre-populated into any ECHO form loaded in that user's same session. Applying a read-only attribute to the spatial subset fields prevents the user from modifying the pre-populated values, thus guaranteeing that a valid spatial subset will be submitted with the request. For any collection to which the following fixes have been applied, the resulting behavior will force users to specify a spatial subset by searching for granules using the bounding search rectangle; they will not be able to edit the bounding box in the form itself.

Tickets

To locate the ECHO form XML document in the Metadata Management Tool (MMT):

1. Visit mmt.uat.earthdata.nasa.gov or mmt.earthdata.nasa.gov for the UAT or production environments, respectively.
2. In MMT, choose your provider (probably <DAAC_NAME> or <DAAC_NAME>_<MODE>, ex. NSIDC_TS1).
3. Choose Manage CMR.
4. Under the Service Management panel, choose View Service Options.
5. The target form XML document will most likely be named <SHORTNAME.VERSIONID> ESI Service.
6. Once located, choose Edit, under the Actions column.

1. In the form editing panel, navigate to the following element of the XML document:
   
   /form/model/instance/ecs:request



2. On the line below <ecs:REQUEST_MODE>, insert this element:
   
   <ecs:BBOX_EDIT_DISABLED_MSG>Bounding coordinates for spatial subsetting must match the rectangle entered to filter granules on the previous map page. If you wish to modify these coordinates, please go back to the previous page and select the rectangle option under the spatial filter icon.</ecs:BBOX_EDIT_DISABLED_MSG>

(You may modify the text inside this new element as desired.)
   
   

3. For each processing service configured for the target collection, there is an element in the data model, <ecs:<SERVICE_NAME>-request> and multiple corresponding <group> elements in the user interface section of the form. For example, the interface for spatial subsetting is configured by the section:
   
   /form/ui/group[id="<SERVICE_NAME>-spatial"]/group[id="<SERVICE_NAME>-NWESBoundingBox"]



   1. Inside the group, add the following XML snippet as the last item in the group, substituting <SERVICE_NAME> appropriately:

      <output ref="../../../ecs:BBOX_EDIT_DISABLED_MSG" type="xsd:string" relevant="../../../ecs:SUBAGENT_ID/ecs:value='<SERVICE_NAME>' and ../../ecs:spatial_subset_flag='true'"/>

1. Inside the same <group> element where the output message was placed, there will be 4 different input fields, each corresponding to one of the cardinal directions used to define the bounding box. For example:

   <input label="South" ref="ecs:lrlat" relevant="../../../ecs:SUBAGENT_ID/ecs:value='<SERVICE_NAME>' and ../../ecs:spatial_subset_flag='true'" required="true()" type="xsd:double">



   1. In the declaration of the <input> element–inside the tag markers (<>)–there are 3 attributes defined: relevant, required, and type. Add the following attribute to each input element:
      
readonly='true'

This will render the input fields as read-only objects in Earthdata Search Client.

2. Submit the form changes.

Requirements

CM privileges required in the target mode.

Steps

1. Open a terminal session on the *5dpl01* machine.
2. Navigate to /usr/ecs/<MODE>/CUSTOM/WWW/DPL/esi/WEB-INF.
3. There, backup the ECHOFormsGenerator.xsl file: mv ECHOFormsGenerator.xsl ECHOFormsGenerator.xsl.orig_20180928
4. Then copy the customized XSL document to this directory: cp <CUSTOM_XML_FILE> ECHOFormsGenerator.xsl

Expected Results

If updating a form directly in CMR, the changes should be immediately visible in Earthdata Search Client, once submitted.

If using a customized XSLT, then upload order and service forms using the DataAccess GUI or FormUpload.rb in the target mode.

If changes are not immediately visible, wait for the beginning of the next hour, as CMR may have a backlog of updates to process.