Generic worktype

[summer-cook]

Story

As a user I can create a Generic Work Type customized to this spreadsheet

Expected Behavior Before Changes

A basic Generic Work model is available.

Expected Behavior After Changes

The Generic Work Type Customizations:

• 2 custom fields: institution/format
• Updates required fields & primary_terms
• Updates multiple true/false to appropriate fields on form
• Updates multiple true/false on appropriate views
• Updates facets
• Updates to have appropriate fields on the index/show pages (search results page/show page)
• Adds help text to locales (& languages)
• Adds controlled vocabulary for ATLA resource_type/institution/format (moved over from atla hyrax)
• Adds 300 character maximum to the index/show page description field (moved over from atla hyrax)
• Adds test coverage and updates pre-existing generic_work models in tests with updated configuration.

Ref Issues Inlcuded:

• https://github.com/scientist-softserv/atla-hyku/issues/27
• https://github.com/scientist-softserv/atla-hyku/issues/30
• https://github.com/scientist-softserv/atla-hyku/issues/43

Screenshots / Video

Video creating and then editing a Generic Work: https://share.getcloudapp.com/04u6wOYQ

CLICK FOR SCREENSHOTS

Notes

N/A

QA Testing Checklist:

Generic Work Type:

• [x] I can create a Generic Work by filling in the required fields
• [x] I can create a Generic Work by filling in all the fields

REQ FIELDS DISPLAYED: On the form, I can see the required fields:

• [x] Title
• [x] Creator
• [ ] Rights Statement
• [ ] Date created
• [ ] Resource Type
• [ ] Institution

REQ'D FIELDS LABELED/DISPLAYED:

• [ ] On the form, I can see the required fields have a "Required Label"
• [ ] On the form, I can see the required fields are displayed above the "Additional Fields' button

FORM LABELS:

• [ ] On the form, I see the correct labels on the create generic work form fields that are in the spreadsheet

HELP TEXT:

• [ ] On the form, I see the correct help text below the correct field on the create generic work form that are in the spreadsheet

MULTIPLE FIELDS:

• [ ] On the form, I can add multiple fields that are in the spreadsheet

CONTROLLED VOCABULARY: On the form, I can see the correct controlled vocab show for the following fields:

• [ ] Resource Type - controlled vocab matches list on the spreadsheet
• [ ] Institution - controlled vocab matches list on the spreadsheet
• [ ] Format - controlled vocab matches list on the spreadsheet

ADDITIONAL METADATA DISPLAYED: After clicking the “Additional Fields” button I can see the non-required fields for the GenericWork model:

• [ ] Alternative Title
• [ ] Contributor
• [ ] Description
• [ ] Abstract
• [ ] Keyword
• [ ] License
• [ ] Access Rights
• [ ] Rights notes
• [ ] Publisher
• [ ] Subject
• [ ] Language
• [ ] Identifier
• [ ] Related URL
• [ ] Format
• [ ] Bibliographic citation

EDITING A WORK: When I click edit on a work:

• [ ] I can see the previously saved field value in the form field
• [ ] I can edit and save the fields and see the updated value present on the saved Generic Work
• [ ] After saving the work and navigating to the work show page, I can see all the metadata listed on the spreadsheet

THE SEACRH RESULTS PAGE: On the search results page you will see the following properties displayed on each work listed in the results.

• [ ] Title
• [ ] Creator
• [ ] Description (with 300 character limit)
• [ ] Resource Type

THE FACETS THAT SHOULD DISPLAY: On the facets, after creating a generic work with all the form fields filled in. You navigate to the search results page and can see the following facets included:

• [ ] Resource Type
• [ ] Creator
• [ ] Contributor
• [ ] Keyword
• [ ] Subject
• [ ] Language
• [ ] Publisher
• [ ] Date created
• [ ] Institution
• [ ] Format

Please double check the accuracy of the form fields' help text by cross checking from in column G titled "Help Text" of this spreadsheet to the Generic Work form fields we updated listed below:

• [ ] Rights Statement
• [ ] Resource Type
• [ ] Institution
• [ ] Description
• [ ] Keyword
• [ ] License
• [ ] Access Rights
• [ ] Rights notes
• [ ] Publisher
• [ ] Subject
• [ ] Format

Please also check to make sure when you flip through the different languages of those help texts' that the help text appears to change to the alternate language selected for the fields listed above.

• [ ] German
• [ ] Spanish
• [ ] Brazilian Portuguese
• [ ] French
• [ ] Italian
• [ ] Chinese

OLD in drop down labelled CLICK ME

CLICK ME

# Summary Set up the atla hyku generic worktype This is the mapping spreadsheet. https://docs.google.com/spreadsheets/d/1cyTtAofi2g1sx0ATJuP7ws-77a7OzBXF/edit#gid=1372594593 # Related #7 epic # Acceptance Criteria - [ ] metadata fields from the spreadsheet for generic worktype are available - [ ] Require fields for generic worktype are correct per the spreadsheet - [ ] Multi value fields for generic worktype are correct per the spreadsheet - [ ] Help text (text below name but above the field) is correct for generic worktype # Notes most likely one dev will work on all 3 worktypes Samvera customizing metadata guide: [link](https://samvera.github.io/customize-metadata-generate-work-type.html)

[DiemBTran]

QA notes:

• [ ] Title
  • [x] required
  • [x] not repeatable
  • [x] not faceted
• [ ] Creator
  • [x] required
  • [x] repeatable
  • [x] faceted
• [ ] Keyword
  • [x] not required
  • [x] repeatable
  • [x] faceted
• [ ] Rights Statement
  • [x] required
  • [x] not repeatable
  • [x] not faceted
• [ ] License
  • [x] not required
  • [x] not repeatable
  • [x] not faceted
• [ ] Alternative Title
  • [x] not required
  • [x] repeatable
  • [x] not faceted
• [ ] Contributor
  • [x] not required
  • [x] repeatable
  • [x] faceted
• [ ] Description
  • [x] not required
  • [x] repeatable
  • [x] not faceted
• [ ] Abstract
  • [x] not required
  • [x] repeatable
  • [x] not faceted
• [ ] Access Rights
  • [x] not required
  • [x] repeatable
  • [x] not faceted
• [ ] Rights notes
  • [x] not required
  • [x] repeatable
  • [x] not faceted
• [ ] Publisher
  • [x] not required
  • [x] repeatable
  • [x] faceted
• [ ] Date created
  • [x] required
  • [x] not repeatable
  • [x] faceted
• [x] Subject
  • will be added in #28
• [ ] Language
  • [x] not required
  • [x] repeatable
  • [x] faceted
• [ ] Identifier
  • [x] not required
  • [x] not repeatable
  • [x] not faceted
• [ ] Related URL
  • [x] not required
  • [x] repeatable
  • [x] linked
• [ ] Source
  • [x] not required
  • [x] repeatable
  • [ ] not faceted
• [x] Resource Type
  • will be added in #30
• [x] Additional rights info
  • [x] not required
  • [x] repeatable
  • [x] not faceted
• [x] Bibliographic citation
  • [x] not required
  • [x] repeatable
  • [x] not faceted
• [x] Institution
  • will be added in #30
• [x] Collection
  • This shows as a relation on an item page when the work is added to collection
• [x] Type
  • will be added in #30
• [x] Format
  • will be added in #27
• [x] Embedded video (label wont show on the work page)
  • will be added in #41

[DiemBTran]

Needs further review: It's almost all there! Just missing 2 fields. See attached screenshots.

tested on:

• https://diem-test.atla-hyku.notch8.cloud/concern/generic_works/db5e7a1c-4ffc-46f4-a28d-5514e6df2175

needs rework:

• [ ] Additional rights info
  • Does not appear on new work form
• [ ] Bibliographic citation
  • appears on new work form, but not on work show page

click to expand

 

[summer-cook]

Rework

• https://github.com/scientist-softserv/atla-hyku/pull/new/generic-worktype-rework

Additional Rights info:

Bibliographic Citation:

[DiemBTran]

This passes SoftServ QA: See attached screenshot.

tested on:

• https://diem-test.atla-hyku.notch8.cloud/concern/generic_works/a95af658-d213-4f87-b0e3-29f7a8b62b81?locale=en

now passing:

• [x] Additional rights info
  • [x] not required
  • [x] repeatable
  • [x] not faceted
• [x] Bibliographic citation
  • [x] not required
  • [x] repeatable
  • [x] not faceted

Additional Right Info and Bibliographic Citation are now correct on Generic Work


[ckarpinski]

• Help text for the subject field is not correct, it should have this "Headings or index terms describing what the work is about. Use a controlled vocabulary." the last part is missing

• help text for rights has a url that should be linked out

• The field that is currently labelled Types needs to be Type. it should not be plural. I understand the backend uses it plural but the label that shows to users should not be.

• is the format field set up to fill in PDF if the user doesnt select something? I dont think we want this becz it is likely to be missed and then we have a lot of inaccurate formats.

• format should NOT be showing the part before the slash and they should be all caps - this should be set up to look as it does in the digital library

• 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

• Looking at PALS, it seems they do not have "GENERIC WORK" showing on the work show page, is this a theme adjustment for me to do later or can it be done in some settings?

• Could we amend the language help text to say "The language of the work's content. Spell out the language and capitalize the first letter."

[summer-cook]

@ckarpinski these are all addressed on other tickets, besides this one:

Looking at PALS, it seems they do not have "GENERIC WORK" showing on the work show page, is this a theme adjustment for me to do later or can it be done in some settings?

In the default show page theme, it does show Generic Work (excuse the ugly theming on their qa tenant)

Can you send me the link for where this is not the case?

It may just be that they have a theme applied to that tenants show page (you would do this in Settings -> Appearance -> Themes)

[summer-cook]

Confirmed - with the "Cultural Show" page theme, it does not show the worktype at the top. Not sure about "Scholarly Show" theme, but you can try it if you'd like ･ᴗ･

[ckarpinski]

The test work i made on hyku commons for some reason says pending and i cant figure out how to change that - it is public and otherwise looks like other works. I have our test site there set to use "Default Show Page" not Cultural Show and it does not show the work type.

https://atla.hykucommons.org/concern/generic_works/3d1ef7a3-8305-4d2c-baa8-c5027b6f52ec?locale=en

[ckarpinski]

What ticket has the help text for subject and language on it?

[summer-cook]

What ticket has the help text for subject and language on it?

i fixed them as part of the etd ticket.