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
7551 expanded compound datasetfield validation #7608
7551 expanded compound datasetfield validation #7608
Conversation
src/main/resources/db/migration/V5.3.0.3__7551-expanded-compound-datasetfield-validation.sql
Outdated
Show resolved
Hide resolved
src/main/resources/db/migration/V5.3.0.3__7551-expanded-compound-datasetfield-validation.sql
Show resolved
Hide resolved
Thanks @sekmiller for the review. @jggautier (and @scolapasta) - do you have thoughts about putting this in the Guides? I added a small bit to the Dataverse Management Guide in 9b0cab6. I think we should also document this in the "required" section of https://github.com/IQSS/dataverse/blob/develop/doc/sphinx-guides/source/admin/metadatacustomization.rst#datasetfield-field-properties, but some guidance would be appreciated - thank you! |
I can add something to that "required" row in the table at https://github.com/IQSS/dataverse/blob/develop/doc/sphinx-guides/source/admin/metadatacustomization.rst#datasetfield-field-properties, taking language from the release notes at https://github.com/IQSS/dataverse/pull/7608/files#diff-dbe06af7170aef8078a673760ffe3fb0bbc1a3038853782079ad8308c4567e07. @scolapasta let me know if you'd like me to give that a shot, unless you'd like to. I might not be up to speed on all of this. We mention in the introduction section of the metadata customization guide how Dataverse collection admins can make dataset metadata fields required or not required, so that should change too, I think. |
@jggautier if you feel comfortable making the edits please feel free to do so. Thanks, and let me know if you have questions about formatting (or anything else, but you're more knowledgable about the metadata system than I am :)) and I'll try to help. Thanks also @sekmiller for the review! @scolapasta is back this week and he should have something to chew on here. |
Revising sentence about controlling which fields are shown, hidden, required and conditionally required in Dataverse collections.
Added conditionally required metadata field info to Introduction section
Added info about conditionally required fields to "required" row of the "datasetField (field) properties" table
Fixing small typo
Okay I'm done editing the docs. I don't have any practical experience with the new logic for compound fields, so what I added to the "required" row of the "datasetField (field) properties" table should be reviewed. |
Looks good @scolapasta. I will add a use case at release time, or you can do so now.
What this PR does / why we need it:
Adds the ability to set subfields of a compound metadata field as Conditionally Required.
(Still needs any guide changes)
Which issue(s) this PR closes:
Closes #7606
Closes #7551
Special notes for your reviewer:
In addition to reviewing the citation.tsv (included in this PR), it would be good to make sure I didn't miss any required fields in the other tsv files.
Suggestions on how to test this:
Check display of Producer Name and validation. Change default requirements for Producer name for your dataverse. Also make sure, currently Required fields still work correctly.
While you don't have to reupload citation.tsv (since the changes are also handled in the flyway script, it would be a goo check, for example, on a fresh installation.
Bonus testing, modify a TSV to add more Conditionally Required fields and see if they work correctly.
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
Yes, some screenshots are in #7606
Is there a release notes update needed for this change?:
Yes, installations will need to modify custom tsv files
Additional documentation: