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

[Spike - Frontend] Analyze downloading options of the Dataset page in view mode and create spike issues #182

Closed
Tracked by #63
GPortas opened this issue Sep 26, 2023 · 2 comments
Assignees
Labels
MVP Milestone 2 MVP Milestone 2: Add a Dataset pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows Size: 3 A percentage of a sprint. 2.1 hours. SPA: Dataset page (View)

Comments

@GPortas
Copy link
Contributor

GPortas commented Sep 26, 2023

Overview of the Feature Request

The goal of this issue is to analyze the required frontend development for #63 and create spike issues (UI ).

What inspired the request?

Any open or closed issues related to this feature request?

@GPortas GPortas added MVP Milestone 2 MVP Milestone 2: Add a Dataset pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows SPA: Dataset page (View) Size: 10 A percentage of a sprint. 7 hours. labels Sep 26, 2023
@MellyGray
Copy link
Contributor

MellyGray commented Oct 2, 2023

Analysis

  1. Citation Download Options
    Captura de pantalla 2023-10-02 a las 11 09 45
  1. File Download Options
    Captura de pantalla 2023-10-02 a las 11 11 42
  • [Frontend] Access File Download Options -> Size: 80
    [API/js-dataverse]:
  • There is a feature called Globus Transfer marked as experimental. Do we want to add this to the MVP?
  • dataset guestbook needed to do some checks in the frontend datasetVersion.getDataset().getGuestbook()
  • fileMetadata.dataFile.filePackage property needed to do some checks in the frontend
  • systemConfig.HTTPDownload there is a check on wether the http download is available by config
  • There is a logic to check if the file is locked from download permissionService.checkDownloadFileLock.This is not the same as the fileUserPermissions.canDownloadFile implemented in the js-dataverse module
  • fileMetadata.dataFile.originalFormatLabel property needed to do some checks in the frontend
  • There are 3 options to download file citation fileDownloadService.downloadDatafileCitationXML(fileMetadata) fileDownloadService.downloadDatafileCitationRIS(fileMetadata) fileDownloadService.downloadDatafileCitationBibtex(fileMetadata)

Auxiliary files is an experimental feature - we may want to keep it out of the MVP

  • There is an option to download auxiliaryFiles, so there is a check on wether there are any auxiliary files auxiliaryFileServiceBean.findAuxiliaryFiles(fileMetadata.dataFile) And then from this auxiliary files there is a loop to iterate each auxiliary file type and display it in the frontend
  • Same for the other auxiliary files auxiliaryFileServiceBean.findOtherAuxiliaryFiles(fileMetadata.dataFile)
  1. Files Table Header Download Options
    Captura de pantalla 2023-10-02 a las 11 11 10
  • [Frontend] Files Table Header Download Button -> Size: 10
  • [API/js-dataverse] This new property is also mentioned in the point 2, permissionService.checkDownloadFileLock
  1. Dataset Download Options
    Captura de pantalla 2023-10-02 a las 11 10 44
  • [Frontend] Access Dataset Download Button -> Size 33
    [API/js-dataverse]:
  • There is a check in the frontend on the size of the dataset. If there are tabular files, there are 2 options to download both formats, with the original tabular files or with the transformed tabular files, so both sizes are needed.
  • There is a feature called Globus Transfer marked as experimental. Do we want to add this to the MVP?
  1. Metadata Download Button
    Captura de pantalla 2023-10-02 a las 11 14 41
  • [Frontend] Export Metadata Button -> Size 10
  • [API/js-dataverse]: ExportService.getInstance().getExportersLabels() from the frontend perspective we need a list of ExporterDisplayFormat + ExporterDownloadLink. Not all exporters are available to the users, there is also a check exporter.isAvailableToUsers()

Created Frontend Spike Issues

@MellyGray MellyGray self-assigned this Oct 2, 2023
@MellyGray MellyGray changed the title Analyze downloading options of the Dataset page in view mode and create spike issues [Spike - Frontend] Analyze downloading options of the Dataset page in view mode and create spike issues Oct 3, 2023
@MellyGray MellyGray added Size: 3 A percentage of a sprint. 2.1 hours. and removed Size: 10 A percentage of a sprint. 7 hours. labels Oct 3, 2023
@MellyGray MellyGray removed their assignment Oct 3, 2023
@sekmiller sekmiller self-assigned this Oct 5, 2023
@sekmiller
Copy link
Contributor

There are some additional ui options when there are tabular files present in the dataset. I have noted them in the sub-issues created in the spike

@sekmiller sekmiller removed their assignment Oct 5, 2023
@kcondon kcondon self-assigned this Oct 13, 2023
@kcondon kcondon closed this as completed Oct 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
MVP Milestone 2 MVP Milestone 2: Add a Dataset pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows Size: 3 A percentage of a sprint. 2.1 hours. SPA: Dataset page (View)
Projects
Status: No status
Development

No branches or pull requests

4 participants