Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The bulk file download via the web client is a new feature that will allow users to select files, review/refine the file selection, and then download all of the files as a single zip file.  The workflow consists of file five basic phases: file selection, selection review, download, download review.   While a typical workflow flow might involve the user moving through the all of the phase in order, the user is free to move between phases at will.

File selection

The user's goal for this phase will simply be to select files they wish to download from various sources in Synapse. This phase is similar to the product selection phase of an online shopping experience. In this phase the user will be able to select files from various sourcethe following sources:

  • Add all files from a folder.  Note: This operation is not recursive, so files within sub-folders will not be added.
  • Add a single file from a folder.
  • Add all of the files listed in a view query.  We do not plan to support adding individual files from a view, instead the user is expected to refine their query to sub-select files from views.  Note: This operation will add all files from the view query, not just the single page of files shown in the UI.

Selection review

All files selected in the file selection phase will be added to a user's download list.  In the selection review phase a user will be able to manage their download list.  The download list is similar to an online shopping cart.  Each user will have a single download list that is persistent and private.

The user's goal for this phase this phase is to review and refine the files they selected prior to actually starting the download.  This phase is similar to the review of a shopping cart/basket of an online shopping experience. All of the files the users selected in the file selection phase will be consolidated in the user's private download list.  The download list will include the following information about each file:

  • Link to the original file
  • File sizeAny
  • File availability:
    • Are there any unmet access restrictions on the file?
    • Is the file
    downloadable via
    • type available for bulk download? 
    File sources such as SFTP and external links cannot be downloaded via the bulk download feature
    • For example, external file links and SFTP files will not be available for bulk download.

For each file in the download list the user will have the option to perform the following actions:

...

  • Clear the list
  • Download the list

Download

In the download phase the The user's goal for this phase will be start the actual bulk download of their files.  This phase is similar to the checkout phase of the an online shopping experience.  In this phase the user will provide a name for the their zip file and will be presented with information about the number sub-set of files to that will actually be included in the zip and the total size of the download.In the download phase the user will have the option to start the download or canceldownload (unavailable files will be excluded).  When the user chooses to proceed with the download, the download transaction will be stared (see below for details on the download transaction).

Download Review

When a user starts a file download, they will enter the last phase: download review.  In this phase the user will be able to monitor the download progress.  After the requested zip file is prepared, the user will then be able to download the zip file to their machine.

...