Skip to content

DataCite Xml updates- 4.7, language, Translator, Keyword URI, etc.#12346

Open
qqmyers wants to merge 10 commits into
IQSS:developfrom
QualitativeDataRepository:DataCiteXml4.7
Open

DataCite Xml updates- 4.7, language, Translator, Keyword URI, etc.#12346
qqmyers wants to merge 10 commits into
IQSS:developfrom
QualitativeDataRepository:DataCiteXml4.7

Conversation

@qqmyers
Copy link
Copy Markdown
Member

@qqmyers qqmyers commented Apr 21, 2026

What this PR does / why we need it: This PR updates the citation block contributor types to add 'Translator' and makes a few small updates to the DataCite XML export/xml metadata sent to DataCite:

  • updates the schema compliance to version 4.7
  • adds 'Translator' as an allowed contributor type (Dataverse has a 'Translator' option but in DataCite 4.5, 'Translator' is not allowed and the xml mapped it to 'Other' instead)
  • adds a language element for the case where the dataset has one citation metadatablock: language defined. In other cases, the language element is not included (as before).
  • adds the value of any keywordTermURI value as the valueURI attribute in the resulting element
  • accept dates of the form YYYY or YYYY-MM in the timePeriodCovered and dateOfCollection fields, and
  • avoids sending the word 'null' as part of a date range when the start or end date is unspecified.

Which issue(s) this PR closes:

Special notes for your reviewer: Note the timePeriodCovered and dateOfCollection fields show a placeholder with YYYY-MM-DD but in practice many people are using shorter year or year and month entries. These were not being sent to DataCite (as of ~2024 when validation was added). Not sure if it is worth changing the placeholder or not.

Suggestions on how to test this: The individual changes listed above should all be easy to test by filling in the relevant metadata. The XML produced should be visible on Fabrica or via API to get the DataCite XML export, or one could publish and see the export in the UI.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes update needed for this change?:

Additional documentation:

@jggautier
Copy link
Copy Markdown
Contributor

adds 'Translator' as an allowed contributor type (Dataverse has a 'Translator' option but in DataCite 4.5, 'Translator' is not allowed and the xml mapped it to 'Other' instead)

Could you write more about how Dataverse has a 'Translator' option? Or how do we expect someone depositing a dataset in a Dataverse repository to indicate that someone contributed as a translator? I ask because I don't see "Translator" in the deposit form's Contributor Type dropdown on Demo Dataverse or in the list of contributor types in the citation.tsv and citation.properties file that ships with Dataverse.

I do see it in the citation metadata block that QDR is using, at https://data.qdr.syr.edu/api/metadatablocks/citation.

Do you know yet if you're planning to merge this PR for the 6.11 release?

I ask because in #12281 we're tracking other changes we're planning to make to the information that Dataverse includes in the DataCite XML export. That GitHub issue has a milestone label for 6.11, although we're not sure yet if we'll be able to finish it for the 6.11 release.

@qqmyers qqmyers marked this pull request as ready for review April 21, 2026 16:24
@qqmyers qqmyers added the GDCC: QDR of interest to QDR label Apr 21, 2026
@qqmyers
Copy link
Copy Markdown
Member Author

qqmyers commented Apr 21, 2026

Since Translator wasn't yet in the citation block, I've added it in the PR. When/if this gets merged is not my call. (As QDR is already deploying these changes, the priority should be based on whether Harvard or other GDCC members want it.)

@qqmyers qqmyers changed the title DataCite Xml updates- 4.7, language, Translator, Keyword URI DataCite Xml updates- 4.7, language, Translator, Keyword URI, etc. Apr 28, 2026
@jggautier
Copy link
Copy Markdown
Contributor

jggautier commented Jun 3, 2026

It looks like the change about Keyword Term URIs in the issue at #12300 will be made to Dataverse (as well as other changes in that issue's parent issue, #12281), before this PR is merged.

And from what I understand, this PR includes the same change about Keyword Term URIs:

adds the value of any keywordTermURI value as the valueURI attribute in the resulting element

If all of that is true, maybe that part of this PR about Keyword Term URIs could be removed from this PR?

Nevermind! After sprint planning today, it's probable that we won't make the changes described in #12281 as part of the 6.11 version of Dataverse.

@qqmyers
Copy link
Copy Markdown
Member Author

qqmyers commented Jun 3, 2026

OK, even so, it would be best to merge this before asking someone to write the same code again. Also - if it's fixed twice, git will flag a conflict before it can be merged, so no need to address it beforehand.

@jggautier
Copy link
Copy Markdown
Contributor

jggautier commented Jun 3, 2026

Ah, thanks, I like that approach.

Or maybe I should close that #12300 issue about the Keyword Term URIs, and update it and its parent issue at #12281 to point at that merging this PR (#12346) will also help align the DataCite/Datacite and OpenAIRE/oai_datacite exports.

That way regardless of which changes are included in the next release of Dataverse, folks aren't re-writing code.

@qqmyers
Copy link
Copy Markdown
Member Author

qqmyers commented Jun 3, 2026

I just marked this PR as Closing #12300 which should make a note there and auto-close it when this is merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

GDCC: QDR of interest to QDR

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

In DataCite/Datacite export, when the user enters a Keyword Term URI, include Keyword Term URI in the valueURI property of the subject property

2 participants