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

[EPIC] Upgrade from DataCite schema 4.5 to 4.6 #805

Open
24 tasks
adambuttrick opened this issue Dec 9, 2024 · 0 comments
Open
24 tasks

[EPIC] Upgrade from DataCite schema 4.5 to 4.6 #805

adambuttrick opened this issue Dec 9, 2024 · 0 comments
Labels
epic High-level project with multiple sub-issues

Comments

@adambuttrick
Copy link

adambuttrick commented Dec 9, 2024

DataCite's schema 4.6 is now public, so we need to upgrade EZID to support DOIs registered with this version of the schema.

Requirements:

  • Version 4.6 becomes the default schema version for new DataCite DOIs
  • Version 4.6 is supported for DataCite DOIs registered via both the UI and API
  • Version 4.6 is supported for XML registrations
  • Version 4.6 is supported in the batch-registration script
  • Existing DataCite DOIs that have older schema versions can be updated by users to incorporate the new elements from 4.6
  • In the case of existing DataCite DOIs with older schema versions, users updating those DOIs (regardless of whether they are incorporating 4.6 elements or not) should not experience any compatibility errors when they make changes as long as the DOIs were registered with 4.x-compatible metadata. If the DOIs are not 4.x compatible, users will receive an error
  • Update Quick Start Guides for 4.6 updates

Changes in version 4.6 that need to be reflected in EZID are as follows:

DataCite documentation

  • Add "Award" and "Project" as allowed resource types in the resourceTypeGeneral field. These values should be added to UI dropdowns where resourceTypeGeneral is used, including:

    • Resource type dropdown
    • Any other locations using resourceTypeGeneral
  • Add "CSTR" and "RRID" as allowed identifier types in the relatedIdentifierType field. These values should be added to dropdowns where relatedIdentifierType is used, including:

    • Related identifier type dropdown
  • Add "Translator" as new contributor type in the contributorType field. This value should be added to dropdowns where contributorType is used, including:

    • Contributor type dropdown
  • Add new relation type pair to Related Identifier - Relation Type: "HasTranslation" and "IsTranslationOf"

  • Add new date type: "Coverage"

Key milestones

  • Develop and test new schema support on dev
  • Develop and test new schema support on stage
  • Test new schema support on stage
  • Release on production
  • Communicate to users (via EZID-L) that new schema version is available

Tests

  • UI create DataCite record (advanced form) with/without required data fields
  • UI update Schema 4.x records
  • API create Schema 4.x records with/without required data fields
  • API update Schema 4.x records with/without required data fields
  • API create datacite.fieldname profile record
  • API update datacite.fieldname profile record
  • batch-registration script

Deployment plan

  • Create new migration file
  • Deploy the release code
  • Stop EZID
  • Apply the database migrations
  • Restart EZID
@adambuttrick adambuttrick added the epic High-level project with multiple sub-issues label Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
epic High-level project with multiple sub-issues
Projects
None yet
Development

No branches or pull requests

1 participant