Controlled Vocabularies - Format

[summer-cook]

Summary

Set up for Atla Hyku format field controlled vocabulary - add to all 3 work types & set up like the DL

Related

EPIC: #8

Acceptance Criteria

• [ ] Format field follows these rules: https://docs.google.com/document/d/1Ubn7DHb5Ay33zlHR-tE07T8WUF-q4s4PJf2xtswTrWc/edit

Testing Instructions

Create a work for each worktype.

Generic

• [x] Enter some of the variations from this spreadsheet and confirm they convert after saving. https://docs.google.com/document/d/1Ubn7DHb5Ay33zlHR-tE07T8WUF-q4s4PJf2xtswTrWc/edit

ETD

• [x] Enter some of the variations from this spreadsheet and confirm they convert after saving. https://docs.google.com/document/d/1Ubn7DHb5Ay33zlHR-tE07T8WUF-q4s4PJf2xtswTrWc/edit

Paper or Report

• [x] Enter some of the variations from this spreadsheet and confirm they convert after saving. https://docs.google.com/document/d/1Ubn7DHb5Ay33zlHR-tE07T8WUF-q4s4PJf2xtswTrWc/edit

Notes

[labradford]

It's kind of weird how format has duplicate "PDF" selected on the multiple fields

[labradford]

This will be ready for QA once ETD is merged and deployed to staging

[DiemBTran]

This passes SoftServ QA: See attached screenshots.

tested on:

• paper or report: https://diem-test.atla-hyku.notch8.cloud/concern/paper_or_reports/cafd5908-218a-4d58-a40f-2c20890c39d6?locale=en
• etd: https://diem-test.atla-hyku.notch8.cloud/concern/etds/3ffda985-b640-4756-b849-d54820beff44?locale=en
• generic work: https://diem-test.atla-hyku.notch8.cloud/concern/generic_works/d0f7e924-df1e-4a12-8488-a61a8ffba079?locale=en

Formats can be selected from a dropdown menu on the new work form

  

[ckarpinski]

• this should appear similar to the DL - just PDF, JPG etc not first part "application/" etc. and it should be in all caps

• It looks like PDF is being applied as a default - if you dont choose a format it forces this one. We do not want a default becz we will end up with a lot of incorrect format fields if someone doesnt see this field or doesnt fill it out

• i added a work with multiple files, when i go to edit it, it keeps adding an extra format field PDF. i chose JPEG and it keeps adding PDF a new instance of PDF every time i edit it

[ckarpinski]

• MP4 is listed twice, but MP3 is not listed - could these maybe be in a-z order to be less confusing?
• Need to add MOV to this list unless that file type is not allowed?

do you know what MPEG would be used for if not MP4 or MP3?

[ckarpinski]

This is how the field is set up on the DL and how we want it here - https://docs.google.com/document/d/1Ubn7DHb5Ay33zlHR-tE07T8WUF-q4s4PJf2xtswTrWc/edit

It shows all the variations that can be input into the field, but all should show on the front end as just PDF, JPG etc.

We have a drop down for when someone adds a work manually, but ideally for the CSV import it would be the same as the DL where you could have any variation and it be correct.

[ckarpinski]

Curiously right now i tried to do a CSV import with the format set to URL and it failed. This is in the drop down list so I have no clue what the system is expecting for this value since our dropdown only shows the URL bit.

[summer-cook]

I just made the necessary changes for this:

• https://github.com/scientist-softserv/atla-hyku/pull/72
• https://github.com/scientist-softserv/atla-hyku/pull/73

this field should now behave the same way as in the DL for imports and for elsewhere in the app.

[summer-cook]

Softserv QA

Format can be entered in the work edit page, it does not have pdf as a default and instead has a blank option


when saved in the UI it shows up correctly


formats are alphabetized in the form, MOV is added & duplicates are hidden


[ckarpinski]

Question - if someone were to input application/pdf or vary the capitalization in a CSV import - will it work? So all variation from that google doc if put into the CSV would out put on the work show page as PDF or whatever?

[summer-cook]

@ckarpinski I just tested it locally, the import worked for me when i put application/pdf in the format field. Heres a screenshot of the work show page, and the csv i used

format-test.csv

[ckarpinski]

Our expectation on this field was that it would be set up similar to how the Digital Library is set up. This google doc is the list we shared https://docs.google.com/document/d/1Ubn7DHb5Ay33zlHR-tE07T8WUF-q4s4PJf2xtswTrWc/edit

An example: application/pdf, pdf, PDF - all show as PDF

That means if any of those 3 values are input, the work show page will show PDF. To me this means the CSV should be able to accept those variations

an acceptable alternative would be if it can accept either PDF or pdf

BUT if you look through that list there are others that have more variation like image/jpeg, image/jpg, jpeg, jpg, JPEG, JPG - all show as JPEG - for that it would be acceptable to have it accept jpet, jpg, JPEG, JPG

etc.

[summer-cook]

@ckarpinski this has been changed to be set up like you mentioned above.

You should now be able to import formats that match any of the "alts" from this file: https://github.com/scientist-softserv/atla-hyku/blob/main/config/authorities/formats.yml