Implement CSV export of data tables - Githubissues

CCA-Public / scope

SCOPE: An access interface for DIPs from Archivematica

GNU Affero General Public License v3.0

23 stars 4 forks source link

Implement CSV export of data tables #92

Open kellyannewithane opened 6 years ago

kellyannewithane commented 6 years ago

From the user stories (reference archivist, round 2 and administrator, round 2)

1 - As a Reference Librarian, I want to export the tables (such as the Digital Files within a Folder, or within a particular Search result) as a CSV or Excel file to send to researchers before they arrive at CCA to help them prepare for their visit.

jraddaoui commented 6 years ago

1 - Some questions:

What tables should be exportable?
- Folder and search pages (Digital Files)?
- Home and collections pages (Collections)?
- Collection page (Folders)?
This reports should be generated asynchronously in a Celery task as they could be time expensive. Which raises the issue of how to show the result (the CSV) to the user ...
- Create a task management page to show task status and result?
- Send via email?
- Link in user page (after #56)?
Should this reports be accessible by other users?
Should the reports for individual resources (Collections/Folders) be generated automatically via Cron task or Celery Beat?
Should this reports be deleteable? Automatically? When?

stefanabreitwieser commented 6 years ago

For my part, all tables will need to be exportable and should be accessible for all users.

jraddaoui commented 6 years ago

Thanks @stefanabreitwieser, I'm preparing a few options and estimates for 1, but I'd appreciate if you could provide more information about 3.

stefanabreitwieser commented 6 years ago

Sure, I think this is something that @bunekcca and I will bring up with our users in the demos. Is it okay if we get back to you then?

Also tagging @marcbouchercca so that he's aware of our work here, since this appears to have a heavily technical component.

jraddaoui commented 6 years ago

Sure @stefanabreitwieser!

jraddaoui commented 6 years ago

Sent link and credentials from a test Binder instance via email for further analysis of 3.

jraddaoui commented 6 years ago

Moved point 2 to #106 and point 3 to #107, we can leave this on to talk about data tables exports.

jraddaoui commented 6 years ago

Option A: Periodic auto-generated CSV files:

For example each night, a task is executed to generate CSV files for each Collection and Folder in the application. A link to the generated CSV files will be placed in the attachments section of those resources. Those CSV files will contain the same data as the tables.

Estimate: 40 hours.

Additionally, the same could be done for the entire Collections and search tables, placing the link in a new section of the Collections and search pages.

Estimate: 10 extra hours.

Option B: User generated CSV files:

Allow users to export the table they're looking, including the query and sort options (and selected filters after #91) . This is the harder to estimate given the questions in the first comment. As a rough ballpark, 100 hours should allow to address most of those questions.

Option C: Option A and Option B together:

Doing both options together will take a little less time than the sum of both estimates. Again, as a rough ballpark, 120 hours should allow to do both options.