Page History
| Excerpt | ||
|---|---|---|
| ||
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 | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
This menu bar selects certain types of products based on classification as defined by the Archive or mission pipelines. Examples are include 'CALIBRATED', 'UNCALIBRATED', and 'REFERENCE'. Each option can be toggled on or off, displaying all products under that type to be displayed in the overlay. When one type is selected, the background color changes to blue. By default, 'CALIBRATED' datasets are selected. The products still need to be selected using the checkboxes next to each Observation (dataset) or product displayed in the overlay when selecting other product types than 'CALIBRATED'. Alternatively, use 'SELECT ALL' to select all files or 'SELECT NONE' and then select individual files. As products are selected, the Observation count, file count, and total estimated download volume is are updated at the top of the overlay. |
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
This video clip demonstrates how to choose products to display in the overlay based on the product extension. |
| Panel | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||
The 'Product Another way to refine data, use the 'Extensions' drop-down. It is used to display products based on the product extension. Note that this is not the same thing as Once clicking the menu, scroll through the available list of extensions and select those of interest to download. Alternatively, use 'SELECT ALL' or select individual extension after clicking 'SELECT NONE' inside the drop-down menu.
|
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
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. This search box offers type-ahead functionality. For example, the search box can be used to display only "txt" files file extension type by entering ".txt" into the search box, which will only display products that include the string. It is not limited to only file types but any string in a file name can be searched. These can then be selected using the selection checkboxes to include in the download. Also, 'SELECT ALL' and 'SELECT NONE' are enabled.
|
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Any products displayed in the overlay must be selected using the checkboxes to download them. 'Select AllSELECT ALL' and 'Select NoneSELECT NONE' will will select or deselect all currently displayed products. The selection checkbox next to a given Observation ID
|
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
When ready to download the selected products, click the 'START DOWNLOAD' button. This will begin downloading the products by streaming them to a zip Zip file. Note that the download location is set by the preference settings of the web browser, and . If the browser does not allow customizing where to download the Zip file, it will be downloaded to the same default download location other files are downloaded by the browser. |
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Pressing the 'DOWNLOAD WITH API QUERY' button will display the overlay below. |
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
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.
|
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Example of non-public products in the Download Overlay if not accessible by you, or if authorized and/or not signed in. Instead of a selection checkbox, a locked icon with a yellow background will appear, indicating permission is not granted to download those products. |
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
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 the STScI account and are authorized to retrieve those products.
|