Page History
Excerpt | ||
---|---|---|
| ||
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
The Download Overlay is a component of the Mission Search forms that allows users to more finely control which files to download, and to select the method of download. On this page... | ||||||
expandCollapseAll | true | |||||
root | DraftMASTDOCS:Download Overlay | startDepth | 2
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 filter shows or hides types of products based on their classification as defined by the Archive archive or mission pipelines. Examples include 'CALIBRATED', 'UNCALIBRATED', and 'REFERENCE'. Each option can be toggled on or off, displaying or hiding all products under that type from the overlayfile-selection table. When a type is selected , the background color changes to blue. After products are shown on the table, they need to be selected to be downloaded. Select rows using the checkboxes next to each Observation (dataset) or product displayed in the overlay. from the dropdown list, it shows as checked. Alternatively, use 'SELECT ALLSHOW ALL' to or 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 are updated at the top of the overlayone or more types after clicking 'SHOW NONE' inside the drop-down menu.
|
Panel | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
This video clip demonstrates how to choose products to display in the overlay based on the product extensionsuffix. |
Panel | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
SuffixesAnother way to refine data , use the 'Extensionsproducts displayed in the table is to use the 'Suffixes' drop-down. It is used to display products based on the product extensionsuffix. Once After clicking the menu, scroll through the available list of extensions suffixes and select those of interest to downloaddisplay in the file-selection table. Alternatively, use 'SELECT ALLSHOW ALL' or select individual extension suffix after clicking 'SELECT SHOW 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 downloaddisplay in the file-selection table. This search box offers type-ahead functionality. For example, the search box can be used to display only "txt" file extension type by entering ".txt" into the search box, which will only display products that include the string. It is not limited to file types, any string in a file name can be searched. These can then be selected for download using the selection checkboxes to include the left of the product filename in the downloadfile-selection table. Also, the 'SELECT ALL' and 'SELECT NONE' are enabled. Tip | , 'NONE', and 'RECOMMENDED' table selection buttons may be used to select or deselect from the currently displayed products. |
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Any products displayed in the overlay must be selected using the checkboxes to download them. The 'SELECT ALL', 'NONE', and 'SELECT NONE' will RECOMMENDED' table selection buttons will select or deselect all from currently displayed products. The selection checkbox next checkbox next to a given Observation ID will will select or deselect all displayed products of that Observation matching the filters applied. The selection checkbox next to a displayed product will select or deselect only that product.
|
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
If there are a large number of products available for the selected observations and filters, they may span multiple pages. Paging allows a large number of products to be made available without impacting the speed of the browser. At the bottom of the product-selection table, the current product range (e.g., 1 - 100) and total number of products (e.g., 584) matching the current 'File Type' and 'File Suffix' selections are displayed . These paging controls can be used to change how many products are displayed on a page and to navigate through the pages of available products.
|
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
When selecting multiple products that may be spread between multiple filters by category or suffix, or across multiple pages, it can be helpful to see a summary of only the selected products. A product summary can be displayed by clicking the 'Files=xx' link at the top of the overlay, where xx is the number of products currently selected. This opens a file summary overlay displaying ONLY the selected product files, grouped by their suffix.
|
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 file. Note that the download location is set by the preference settings of the web browser. Some browsers allow choice of download location, otherwise the Zip file will be downloaded to the default location the browser downloads all files (Likely the download folder). |
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Pressing the 'DOWNLOAD WITH API QUERY' button will display the overlay below. |
Panel | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Another way to download products is to request a download script using the Mission Search API. Click the 'DOWNLOAD WITH API QUERY' button to show the Download By API Query Overlay. This overlay displays API commands based on the products 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 at a different time than you want to download the products. Examples include slow internet connections, not being at the machine where the files will be stored, 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 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 Hubble, 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 for download except to those who sign in to the STScI account and authorized to retrieve those products.
|