Feature Request: Align the DataCite/Datacite and OpenAIRE/oai_datacite exports that ship with Dataverse

[jggautier]

Overview of the Feature Request
This is the parent GitHub issue for GitHub issues about making changes to the DataCite/Datacite and OpenAIRE/oai_datacite exports that, as much as possible, make them contain the same information about datasets and other research objects that users publish in Dataverse repositories.

The information that's in each dataset's "DataCite/Datacite" export is sent to DataCite, while repository managers tell OpenAIRE's systems to harvest their metadata using the OpenAIRE/oai_datacite export.

What kind of user is the feature intended for?
(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin)
API User, Curator, Superuser, Sysadmin

What inspired the request?
Confusion about the two metadata exports (such as https://groups.google.com/g/dataverse-community/c/S8YaKcfyJbg/m/2iYmoBhzAQAJ), the extra work involved in syncing the two exports, which have become out of sync over the years and would otherwise become more out of sync as the Dataverse community continues to change the metadata it sends to DataCite and to OpenAIRE, and an investigation, described in #11916, about how to address these challenges.

What existing behavior do you want changed?
@scolapasta suggested I create separate issues for each of the changes to make it easier to track any discussion about them. So I've described specific changes to the DataCite/Datacite and OpenAIRE/oai_datacite exports in other GitHub issues and made them this issue's child issues.

To help us have a shared overview of all of the changes, here are the GitHub issues that describe changes to either or both of the exports. Most of the GitHub issues describe changes to the OpenAIRE/oai_datacite export, but there are three issues that describe changes only to the DataCite/Datacite export, and two issues that describe changes to both exports.

Child GitHub issues that describe changes to DataCite/Datacite export:

• In DataCite/Datacite export, when the user adds a DAI author identifier, include in creator nameIdentifier property #12296
• In DataCite/Datacite export, when user chooses cstr and URL from Related Publication Identifier Type dropdown, add cstr and URL to related identifiers #12306
• In DataCite/Datacite export, don't use dateType "Available" #12360

Child GitHub issues that describe changes to OpenAIRE/oai_datacite export:

• In OpenAIRE/oai_datacite export, for determining publicationYear, use logic that DataCite/Datacite export uses #12293
• In OpenAIRE/oai_datacite export, use dateType "Updated" for date of latest published version only after user has published more than one version #12294
• In OpenAIRE/oai_datacite export, fix casing of creator nameIdentifier's schemeURI property and include schemeURI for all supported identifier types #12295
• In OpenAIRE/oai_datacite export, when the user chooses author affilitation that includes a ROR, add ROR information and use organization's name instead of ROR URL #12297
• In OpenAIRE/oai_datacite export, when the user adds contributor and chooses any contriubutor type, or adds Distributors and Producers, add guessed nameType to contributor property #12298
• In OpenAIRE/oai_datacite export, when the user chooses no contributor type, default contributorType to "Other" #12299
• In OpenAIRE/oai_datacite export, include user's partial Date of Collection #12301
• In OpenAIRE/oai_datacite export, add what user enters in Time Period field to the date property #12302
• In OpenAIRE/oai_datacite export, add Previous Dataset Persistent ID to Alternate Identifier property #12303
• In OpenAIRE/oai_datacite export, when user doesn't enter an Other Identifier Agency, default alternateIdentifierType to ":unav" #12304
• In OpenAIRE/oai_datacite export, when user doesn't choose a relationType, use "IsSupplementTo" #12305
• In OpenAIRE/oai_datacite export, when user enters DOI in Related Publication Identifier field, without choosing the identifier type, include related identifier #12307
• To OpenAIRE/oai_datacite export, add file DOI related identifiers #12308
• In OpenAIRE/oai_datacite export, use the user-entered PURL as the PURL related identifier #12309
• In OpenAIRE/oai_datacite export's description property, when user doesn't enter Software Version, include Software Name #12310
• In OpenAIRE/oai_datacite export, include "Custom terms specific to this dataset" and link to custom licenses in rights property #12329

Child GitHub issues that describe changes to both OpenAIRE/oai_datacite and DataCite/Datacite exports:

• In DataCite/Datacite and OpenAIRE/oai_datacite exports, add to GeoLocationPlace properties what user enters in Production Location and Geospatial Geographic Coverage fields and fix comma bug #12311
• In DataCite/Datacite and OpenAIRE/oai_datacite exports, determine "Issued" dateType by following same logic used for determining publicationYear #12361

What should not change
So far, after we make the changes described in the GitHub issues, these are things I would expect to remain different between the two exports:

The DataCite schema version:

• OpenAIRE/oai_datacite export should continue pointing to 4.1 version of DataCite

  <resource
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns="http://datacite.org/schema/kernel-4" 
       xsi:schemaLocation="http://datacite.org/schema/kernel-4 http://schema.datacite.org/meta/kernel-4.1/metadata.xsd">
  

• DataCite/Datacite export should continue pointing to 4.5 version of DataCite (until PR #12346 is merged, which will make the DataCite/Datacite export point to the 4.7 version of DataCite)

  <resource
       xmlns="http://datacite.org/schema/kernel-4"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
       xsi:schemaLocation="http://datacite.org/schema/kernel-4 http://schema.datacite.org/meta/kernel-4.5/metadata.xsd">
  

Identifiers of predefined licenses in "Rights" property:

• When the user adds a predefined license to the dataset:

  
  • the OpenAIRE/oai_datacite export's "Rights" metadata shouldn't include rightsIdentifier, rightsIdentifierScheme, and schemeURI properties, since the 4.1 version of DataCite doesn't include those properties

    <rightsList>
           <rights
                  rightsURI="http://creativecommons.org/publicdomain/zero/1.0">CC0 1.0
           </rights>
    </rightsList>
    

  • the DataCite/Datacite export's "Rights" metadata should continue to include the rightsIdentifier, rightsIdentifierScheme, and schemeURI properties, since the 4.5 version of DataCite includes those properties

    <rightsList>
           <rights 
                  rightsURI="http://creativecommons.org/publicdomain/zero/1.0" 
                  rightsIdentifier="CC0-1.0" 
                  rightsIdentifierScheme="SPDX" 
                  schemeURI="https://spdx.org/licenses/" xml:lang="en">Creative Commons CC0 1.0 Universal Public Domain Dedication.  
           </rights>
    </rightsList>
    

Local context info in "Rights" property:

The PR at #12224 will probably be merged before other changes described in this GitHub issue are merged. That PR adds more information to the "Rights" property of the DataCite/Datacite export and does not add the same information to the "Rights" property of the OpenAIRE/oai_datacite export

Funding References:

• When the user chooses a funder from the organization names suggested by the Funding Information Agency field:

  

  • the OpenAIRE/oai_datacite export shouldn't include funderIdentifier and funderIdentifierType properties with ROR information since the 4.1 version of DataCite doesn't include those properties

    <fundingReference>
           <funderName>https://ror.org/04vq5kb54</funderName>
    </fundingReference>
    

    What's included in the funderName property should continue to be the ROR URL of the funder. Fixing this bug so that the name of the funder is used instead is part of the GitHub issue Metadata export with ROR support #11955.

  • the DataCite/Datacite export should continue to include funderIdentifier, funderIdentifierType, and schemeURI properties with ROR information since the 4.5 version of DataCite includes those properties

    <fundingReference>
           <funderName>UCLA Medical Center</funderName>
           <funderIdentifier 
                  funderIdentifierType="ROR" 
                  schemeURI="https://ror.org">https://ror.org/04vq5kb54</funderIdentifier>
    </fundingReference>
    

Keyword Term URI:

When the user enters a Keyword Term URI, the DataCite/Datacite export should continue to not include a valueURI property with the Keyword Term URI. Instead, @qqmyers has included this change in PR #12346, and told GitHub to close #12300 when that PR is merged.

Any open or closed issues related to this feature request?

• Suggestion: Investigate ways to resolve confusion about and reduce the maintenance burden of the "Datacite" and "OpenAIRE" metadata exports #11916
• Align or merge DataCite metadata exports #5889
• DataciteXML changes Plus RelationType field #10632
• DataCite Xml updates- 4.7, language, Translator, Keyword URI, etc. #12346