IQSS / IQSS/dataverse

In OpenAIRE/oai_datacite export, for determining publicationYear, use logic that DataCite/Datacite export uses

Open
#12,293 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

GREI 2 GREI 3 GREI 4 Size: 3
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Feature Request

The OpenAIRE/oai_datacite export should use the same logic as the DataCite/Datacite export when determining the value of the publicationYear property. Currently, the two exports use different logic to determine the dataset's publication year, which means the same dataset can have different publicationYear values depending on which export is used.

This issue is part of a larger effort to align both metadata exports, described in https://github.com/IQSS/dataverse/issues/11916 and https://github.com/IQSS/dataverse/issues/12281.

What kind of user is the feature intended for?

API User, Superuser, and Sysadmin

What inspired the request?

This is part of a larger effort to align the OpenAIRE/oai_datacite and DataCite/Datacite metadata exports. There is more context at https://github.com/IQSS/dataverse/issues/11916 and https://github.com/IQSS/dataverse/issues/12281.

What existing behavior do you want changed?

Currently, the DataCite/Datacite export determines publicationYear using the following logic:

  • If the user has set the dataset's citation date using the API endpoint "Set Citation Date Field Type for a Dataset", then the DataCite/Datacite export uses the year of the date field that the user has set as the citation date
  • If the user hasn't set the dataset's citation date using that API endpoint, then the DataCite/Datacite export uses the latest of:
    • the Publication Date, when the dataset's first version was published in the Dataverse repository, or
    • the embargo citation date, being the latest date of embargoed files on the dataset's first version
  • If the latest dataset version is a draft and the user hasn't set any embargo dates for files in the dataset, the DataCite/Datacite export uses the date when the user last updated the draft version

The OpenAIRE/oai_datacite export uses different logic: it uses the year of the latest Publication Date, Distribution Date, or Deposit Date. For example, if the year in the Deposit Date field is later than the Publication Date and the Distribution Date, the year of the Deposit Date is used for the publicationYear in the OpenAIRE/oai_datacite export.

The OpenAIRE/oai_datacite export should be changed to use the same logic as the DataCite/Datacite export.

Any open or closed issues related to this feature request?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the OpenAIRE/oai_datacite and DataCite/Datacite export implementations and compare how each determines publicationYear. Review the related issues for alignment context, then add or update tests covering the citation date, publication date, embargo date, and draft-version cases so both exports produce the same value.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.