Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Globus: Identify and add configurable button(s) for Upload and Download actions on Dataset page #7626

Closed
amberleahey opened this issue Feb 17, 2021 · 6 comments · Fixed by #8891
Labels
NIH OTA: 1.1.1 1 | 1.1.1 | Minimum Viable Product (MVP) for registering metadata in the repository and connectin... pm.GREI-d-1.1.1 NIH, yr1, aim1, task1: MVP for registering metadata in the repository
Milestone

Comments

@amberleahey
Copy link

There is a need to have additional external tools added at the Dataset level. The two main areas identified where external tools are required are the 'Upload Files' and 'Download' buttons/actions.

With this particular integration (Globus), there is a need to have a configurable button for dataset editors to connect to an external tool that would allow for uploading files and submitting large file transfers via the hosted Globus endpoint and external tool. In addition, this button should be configurable to ensure data passed between the systems is reflected throughout Dataverse and conforms to all publishing workflows. The same goes for the Download process.

At the moment there aren't open frameworks in DV for supporting edit-based Dataset external tools. Let's consider making these buttons configurable for other external tools, if so how do you suggest we get started on this?

(Some other considerations for this issue:
-need to consolidate the current Upload and Download actions in the UI or at least ensure these are consistent throughout
-Still doesn't address the Dataset Creation > Upload workflows , but this can be managed with buttons and messaging
-Slight consideration of UI / UX for Globus uploaders, but need to do more (for now the existing Upload and Download buttons were chosen, but this can change))

Screen Shot 2021-02-17 at 2 46 47 PM

Screen Shot 2021-02-17 at 2 46 21 PM

Screen Shot 2021-02-17 at 2 46 10 PM

Screen Shot 2021-02-17 at 2 44 58 PM

Screen Shot 2021-02-17 at 2 45 06 PM

Screen Shot 2021-02-17 at 2 45 14 PM

@djbrooke
Copy link
Contributor

Thanks @amberleahey. We're discussing some prioritization this week and we should be able to follow up soon after that.

One thing that I didn't bring up during our meeting is the existing workflow that we have for rsync/SSH. In this workflow, there's a similar issue of needing the Dataset created before files can be uploaded, since the rsync script needs the dataset ID. In this case, we provided a message during Dataset create that you can upload files after saving instead of doing it all on the dataset create page (see screenshot).

Screen Shot 2021-02-03 at 5 33 12 PM

This was a few years ago, and this was also pre-external tools, so we'll want to review, but I thought the way we worked around the limitations in that case was interesting.

@amberleahey
Copy link
Author

amberleahey commented Mar 30, 2021

Hi everyone, I thought I'd share some ideas for which existing buttons on the Dataverse dataset pages UI could be used for this Globus integration work. We are thinking about this workflow:

Upload

  1. User creates a Dataset > Under the "Files" section options > "Upload with Globus" option is presented under other upload options > during dataset creation message appears for users "To upload files using Globus, please sign up for a Globus account and download the Globus Connect Personal application to enable transfer of your local files to Dataverse. When you are ready to upload, click "Save" during the Dataset creation process and proceed to "+ Upload Files" button that will appear on the Dataset landing page. For more information about how to use Globus in Dataverse see the Dataverse Globus Tool Guide. " (suggested wording)
    Upload_datasetpage

  2. On the Dataset landing page, users navigate to the "+ Upload Files" button which presents the Files page window
    Upload_dropdown Link to Globus Upload Tool presented

  3. User initiates the Globus Upload Tool to transfer files to Dataverse Dataset

Download

  1. The Globus Tool can support folder and file level downloading and permissions, it would be nice to make the "Access Dataset" button support Globus Download (I think this button is already configurable but will need to confirm it can pass permissions and versions in all cases)

Screen Shot 2021-03-30 at 8 57 30 AM

  1. At the file level, the existing download icon is a dropdown, add Globus download option

Screen Shot 2021-03-30 at 8 57 56 AM

I'm not sure in all cases we need to show the Globus download options, but perhaps for now if we've enabled Globus External Tool in our instance we could show it as an option. We could also configure this to only show up when a file is uploaded via Globus or when a file is over a certain size limit (perhaps based on the instance's upload size limit). In all cases, the download buttons must support all versions of a dataset and pass permissions at the file level to the Globus Tool.

Let us know if this makes sense and would work!

@lubitchv
Copy link
Contributor

File level external tool has a mandatory field contentType in manifest json. But globus file level external tool for download should work on any type of file. So there is a need either to make contentType not to be mandatory (like in dataset level external tool) and show Globus tool for any type of file or Globus Tool would have to use a different framework (not the present external tool one).

@pacian
Copy link

pacian commented Apr 12, 2022

Hello, just trying to get a sense of where this issue is in the pipeline. I see this as a potential deliverable in Q1 2022; Q1 2022 has passed; will this be delivered in FY 2022?

@qqmyers
Copy link
Member

qqmyers commented Apr 12, 2022

Working on this through June with the intent to have it working (if a Dataverse instance configures it) for public files. Hoping to coordinate through the community slack on this.

@pdurbin pdurbin added this to the 5.12 milestone Sep 19, 2022
@pdurbin
Copy link
Member

pdurbin commented Sep 19, 2022

This seems to be the issue where we are tracking the Globus UI work. I just merged the Globus PR (#8891) and deployed the code from develop to the test server @qqmyers set up (thanks!).

Here are screenshots from the following scenario:

  • Transfer an XML file from a public Globus endpoint into a Dataverse dataset.
  • Transfer the XML file from a Dataverse dataset to a laptop running Globus Personal Connect.

Screenshot 2022-09-19 at 13-52-26 Add New Dataset - Root
Screenshot 2022-09-19 at 13-52-41 NCBI Linkout Nucleotide
Screenshot 2022-09-19 at 13-53-01 Upload Files - NCBI Linkout Nucleotide
Screenshot 2022-09-19 at 13-53-26 Globus
Screenshot 2022-09-19 at 13-53-40 Globus
Screenshot 2022-09-19 at 13-54-07 Globus
Screenshot 2022-09-19 at 13-54-18 Globus

Screenshot 2022-09-19 at 14-10-45 NCBI Linkout Nucleotide

Screenshot 2022-09-19 at 13-55-22 NCBI Linkout Nucleotide
Screenshot 2022-09-19 at 13-56-17 Globus
Screen Shot 2022-09-19 at 1 59 08 PM

@mreekie mreekie added the NIH OTA: 1.1.1 1 | 1.1.1 | Minimum Viable Product (MVP) for registering metadata in the repository and connectin... label Oct 8, 2022
@mreekie mreekie added the pm.GREI-d-1.1.1 NIH, yr1, aim1, task1: MVP for registering metadata in the repository label Mar 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NIH OTA: 1.1.1 1 | 1.1.1 | Minimum Viable Product (MVP) for registering metadata in the repository and connectin... pm.GREI-d-1.1.1 NIH, yr1, aim1, task1: MVP for registering metadata in the repository
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants