Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DraftMASTDOCS and version 1.3

Component Overview

This page describes the Download Overlay, used for selecting files to download.

Component Features and Functionality

A description of the Download Overlay: 'Select By Product Type', 'Select By Product Extension', 'Select By String Match', 'Download Button' (Download By Streaming To A Zip File), and the 'Show API Query Button' (Download Via A Script).


Panel
borderColor#00617E
bgColor#E3EEF1
borderWidth2
Panel
borderColor#00617E
bgColor#E3EEF1
borderWidth2
Anchor
download_group
download_group
 Displaying Different Product Types

This menu bar selects certain types of products based on classification as defined by the Archive or mission pipelines. Examples are 'CALIBRATED', 'UNCALIBRATED', and 'REFERENCE'. Each option can be toggled on or off, displaying all products under that type to be displayed in the overlay. The products still need to be selected using the checkboxes next to each Observation or product displayed in the overlay. As products are selected, the Observation count, file count, and total estimated download volume is updated at the top of the overlay.

Panel
borderColor#00617E
bgColor#E3EEF1
borderWidth2

Widget Connector
width100%
urlhttps://www.youtube.com/watch?v=zS3xZup0sUw

This video clip demonstrates how to choose products to display in the overlay based on the product extension.

Panel
borderColor#00617E
bgColor#E3EEF1
borderWidth2

Anchor
file_extension
file_extension
 Displaying Different Product Extensions

The 'Product Extensions' drop-down is used to display products based on the product extension. Note that this is not the same thing as a file extension. For example, if a files ends in '_drz.fits', the product extension is 'drz' while the file extension is 'fits'.

Panel
borderColor#00617E
bgColor#E3EEF1
borderWidth2
Widget Connector
width100%
urlhttps://www.youtube.com/watch?v=EKu27-rsVos
Panel
borderColor#00617E
bgColor#E3EEF1
borderWidth2
Anchor
string_match
string_match
 Displaying Different Products By String Matching

The string search box in the Download Overlay can be used to match product names, instruments, and filters/gratings. This can be used to further refine the displayed list of products for easy selection to download. For example, the search box can be used to display only "txt" files by entering ".txt" into the search box, which will only display products that include the string. These can then be selected using the selection checkboxes to include in the download.

Panel
borderColor#00617E
bgColor#E3EEF1
borderWidth2
Widget Connector
width100%
urlhttps://www.youtube.com/watch?v=Lor6FpaJEvs
Panel
borderColor#00617E
bgColor#E3EEF1
borderWidth2

Anchor
select_checkboxes
select_checkboxes
 How To Select Products Using The Checkboxes

Any products displayed in the overlay must be selected using the checkboxes to download them. 'Select All' and 'Select None' will select or deselect all currently displayed products. The selection checkbox next to a given Observation ID  will select or deselect all displayed products only for that Observation. The selection checkbox next to a displayed product  will select or deselect that only that product.

Info

NOTE: Products that are selected will remain selected or deselected if they are later displayed or hidden using other components in the Download Overlay. When in doubt, look at the number of Observations and Files at the top of the Overlay, or display all Product Types and Product Extensions (and remove any string matching in the search box) to get a complete list of products and their selection status.

Panel
borderColor#00617E
bgColor#E3EEF1
borderWidth2
Panel
borderColor#00617E
bgColor#E3EEF1
borderWidth2
Anchor
download_button
download_button
 Download Button (Download By Streaming To A Zip File)

When ready to download the selected products, click the 'START DOWNLOAD' button. This will begin downloading the products by streaming them to a zip file. Note that the download location is set by the preference settings of the web browser, and will be downloaded to the same location other files are downloaded by the browser.

Panel
borderColor#00617E
bgColor#E3EEF1
borderWidth2

Pressing the 'DOWNLOAD WITH API QUERY' button will display the overlay below.

Panel
borderColor#00617E
bgColor#E3EEF1
borderWidth2
Anchor
show_api_button
show_api_button
 Show API Query Button (Download Via A Script)

Another option to download products is to request a download script using the Mission Search API. Clicking on the 'DOWNLOAD WITH API QUERY' button will bring up the Download By API Query Overlay. This overlay displays API commands based on the products you have selected to download the files one at a time. These commands can be copied from the overlay into a text editor and then run as an executable script.

Such API download scripts can be useful in a number of scenarios where a search was conducted but it is desired to download the products at a later time. Examples include slow internet connections, not being at the machine where the files ultimately want to be stored on, or very large product requests where the products can be requested in smaller batches at different times.

Warning

At this time, product downloads for non-public data using API commands is not supported, whether signed into a user account that has access to the products or not. To download non-public products, they must be streamed to a zip file using the Download Overlay.

Panel
borderColor#00617E
bgColor#E3EEF1
borderWidth2

The account menu when not logged in.The account menu when logged in.

Example of non-public products in the Download Overlay if not accessible by you, or if not signed in. Instead of a selection checkbox a locked icon will appear indicating permission is not granted to download those products.

Panel
borderColor#00617E
bgColor#E3EEF1
borderWidth2

Anchor
non_public
non_public
 Downloading Non-Public (Exclusive Access) Products

Some missions, such as HST, have products that are not publicly available to everyone. These non-public (or "exclusive access") products will appear in the download overlay, but will not be available to select for download unless you are signed in to your STScI account and are authorized to retrieve those products.

Info

NOTE: you might be logged-in already if you have signed in to other STScI sites or services, as the account sign-in system is shared across many STScI interfaces.


For Further Reading...