add message when DataCite DOI has not been reserved #7102 #7121

pdurbin · 2020-07-23T15:38:33Z

What this PR does / why we need it:

Here's the problem scenario:

DataCite was down when the dataset was created, meaning that the DOI was never reserved on the DataCite side.
When the user tries to publish, they get a somewhat confusing error: "Cannot publish dataset because its persistent identifier has not been reserved." (screenshot below).

To help explain what's going on, this pull request add a message to the top of the dataset page:

Which issue(s) this PR closes:

Closes #7102

Special notes for your reviewer:

~~I copied and pasted the text that was given to me but I would prefer to use the word "reserved" rather than "registered" because we already use the former throughout our documentation and code.~~ Fixed in fee1772.
~~I used "Dataset Locked" as the short message before the long explanation but we can certainly change this to whatever we want.~~ Changed to "Dataset DOI Not Reserved" in fee1772.
I made use of the the "displayLockInfo" infrastructure even though this message isn't a true DatasetLock.

Suggestions on how to test this:

The message should only appear for DataCite installations. In addition, the message should only appear for datasets with a null value for GlobalIdCreateTime (dvobject table), which is what we use to indicate if a DOI is reserved. It's the time the PID was created on the remote system.

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

Yes, please see screenshots, above.

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

No, I think it falls under the umbrella of Dataverse 5 allowing DOIs to be reserved.

Additional documentation:

None.

coveralls · 2020-07-23T16:20:21Z

Coverage decreased (-0.007%) to 19.603% when pulling 1c1ae2c on 7102-unreserved-doi into 941d17d on develop.

mheppler · 2020-07-27T13:46:44Z

src/main/java/propertyFiles/Bundle.properties

@@ -1322,6 +1322,8 @@ dataset.locked.ingest.message=The tabular data files uploaded are being processe
 dataset.unlocked.ingest.message=The tabular files have been ingested.
 dataset.locked.editInProgress.message=Edit In Progress
 dataset.locked.editInProgress.message.details=Additional edits cannot be made at this time. Contact {0} if this status persists.
+dataset.locked.pidNotReserved.message=Dataset Locked
+dataset.locked.pidNotReserved.message.details=The DOI displayed in the citation for this dataset has not yet been registered with DataCite. Please do not share this DOI until it has been registered.


I know we don't want to keep going back and forth on this, but... this msg reads like we need additional success and warning issues if the DOI was finally registered or ultimately changed. This came to mind reading the comment from @landreev in Slack in regards to issue #6980.

I don't feel strongly about the wording and don't mind if someone changes it.

mheppler · 2020-07-27T13:49:38Z

src/main/java/propertyFiles/Bundle.properties

@@ -1322,6 +1322,8 @@ dataset.locked.ingest.message=The tabular data files uploaded are being processe
 dataset.unlocked.ingest.message=The tabular files have been ingested.
 dataset.locked.editInProgress.message=Edit In Progress
 dataset.locked.editInProgress.message.details=Additional edits cannot be made at this time. Contact {0} if this status persists.
+dataset.locked.pidNotReserved.message=Dataset Locked


I don't think we need to add another "Dataset Locked" bundle value here. There is already dataset.locked.message.

I put the key in as a placeholder but just changed it to "Dataset DOI Not Reserved" in fee1772.

pdurbin · 2020-07-27T16:55:31Z

In design standup I got some guidance from @TaniaSchlatter and @djbrooke on wording. Fixed in fee1772.

djbrooke · 2020-07-27T17:41:10Z

Wording as of fee1772 looks good, thanks @pdurbin

kcondon · 2020-07-29T19:31:46Z

@pdurbin I'm seeing the doi not reserved lock banner on the create dataset page. should it be there? a little confusing imho.

pdurbin · 2020-07-29T19:35:52Z

No, it shouldn't be on the create page.

kcondon · 2020-07-29T19:39:54Z

Well you are checking on a null global create time, right? create page has null too. maybe needs to be excluded?

pdurbin · 2020-07-29T19:42:35Z

Yeah, there's probably some kind of MODE!=CREATE we can check.

kcondon · 2020-07-29T19:50:13Z

Also, getting something weird happening:

make incorrect datacite url in domain.xml
create and attempt to publish dataset, fails to reserve, check.
fix url, restart try to publish, persists in saying could not reserve. It should now be able to but it doesn't. Why not?
log says:


[2020-07-29T19:48:00.263+0000] [Payara 5.201] [SEVERE] [] [edu.harvard.iq.dataverse.DatasetPage] [tid: _ThreadID=90 _ThreadName=http-thread-pool::jk-connector(3)] [timeMillis: 1596052080263] [levelValue: 1000] [[
  Cannot publish dataset because its persistent identifier has not been reserved.]]

pdurbin · 2020-07-29T20:19:20Z

In 1c1ae2c I just added the logic to not show the "DOI not reserved" message on create.

For your other scenario, the plan reserve DOIs regularly and there's a new script in pull request #7142 for this. Basically, if DataCite is down, we simply can't reserve DOIs during that period. So maybe the script runs nightly or so to reserve them.

kcondon · 2020-07-30T14:16:22Z

@pdurbin Thanks for the info, will retest the message.
As for the other behavior, needing to run an API to reserve a failed DOI reservation that potentially and likely happened either due to a misconfiguration or simply the service was temporarily inaccessible, you and I have discussed it outside of this pr and also raised it with the group. It seems a little weird and impractical to me and not how our prior implementation of EZID worked. If it failed to reserve on create, it would just try again on publish, at which time, if a temporarily inaccessible issue is resolved, then it just works seemlessly without intervention or in my case, I've caught my config issue and corrected it. Folks in the group appeared to acknowledge this made sense but as there is an explicit rationale for the current behavior, ie more control over when things are and are not reserved, then will leave up to practical, real world experience to inform future adjustments. One potential concern is a rise in support issues from this and may/will require intervention by an admin but experience will serve as a guide.

pdurbin · 2020-07-30T14:25:56Z

@kcondon yes, thanks for the discussion. I have very little practical experience with EZID and have only glanced at that code, so I'll take your word for it as to how it behaved.

It looks like there's a new issue and pull request where the discussion can continue:

issue Backward compatibility/error recovery for PID reservation during publish #7146: Backward compatibility/error recovery for PID reservation during publish
pull request Reserve PID at publication if needed #7147: Reserve PID at publication if needed

(Or we can keep talking here if that's better.)

kcondon · 2020-07-30T14:36:31Z

@pdurbin Fair enough, though your old officemate Stephen created the EZID implementation and several others on the team were familiar with that functionality and I'd thought the original discussion about implementing DataCite's version was to copy what EZID did and that was my expectation going into this. I really just want a clear idea of what things do and that are logical so I have that for now and hopefully future discussions will proceed on that basis. Thanks.

Fernand0S · 2020-08-13T22:03:37Z

Hello, i have problem publications article in Dataverse. The configurations /usr/local/glassfish4/glassfish/domain/domain1/config/domain.xml

<jvm-options>-Ddoi.username=</jvm-options> and <jvm-options>-Ddoi.password=</jvm-options> for use of Handle is not Doi, modified strings but error persistent.

pdurbin · 2020-08-24T19:56:57Z

@Fernand0S hi, please email support@dataverse.org about your problem to open a support ticket. Thanks.

Fernand0S · 2020-08-24T21:49:55Z

Philip, I solved problem. reply you with email.

add message when DataCite DOI has not been reserved #7102

9af7d99

pdurbin added this to Code Review 🦁 in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) via automation Jul 23, 2020

pdurbin mentioned this pull request Jul 23, 2020

DOI registration is not confirmed by Datacite #7102

Closed

djbrooke added this to the Dataverse 5 milestone Jul 24, 2020

mheppler reviewed Jul 27, 2020

View reviewed changes

pdurbin moved this from Code Review 🦁 to IQSS Team - In Progress 💻 in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) Jul 27, 2020

pdurbin self-assigned this Jul 27, 2020

use "reserved" for consistency, not locked #7102

fee1772

pdurbin moved this from IQSS Team - In Progress 💻 to Code Review 🦁 in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) Jul 27, 2020

pdurbin removed their assignment Jul 27, 2020

sekmiller self-assigned this Jul 29, 2020

sekmiller approved these changes Jul 29, 2020

View reviewed changes

IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) automation moved this from Code Review 🦁 to QA 🔎✅ Jul 29, 2020

sekmiller removed their assignment Jul 29, 2020

kcondon self-assigned this Jul 29, 2020

kcondon moved this from QA 🔎✅ to IQSS Team - In Progress 💻 in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) Jul 29, 2020

kcondon assigned pdurbin and unassigned kcondon Jul 29, 2020

don't show "DOI not reserved" message on create #7102

1c1ae2c

pdurbin moved this from IQSS Team - In Progress 💻 to QA 🔎✅ in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) Jul 29, 2020

pdurbin removed their assignment Jul 29, 2020

kcondon self-assigned this Jul 30, 2020

kcondon merged commit 1ad8647 into develop Jul 30, 2020

IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) automation moved this from QA 🔎✅ to Done 🚀 Jul 30, 2020

kcondon deleted the 7102-unreserved-doi branch July 30, 2020 15:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add message when DataCite DOI has not been reserved #7102 #7121

add message when DataCite DOI has not been reserved #7102 #7121

pdurbin commented Jul 23, 2020 •

edited

coveralls commented Jul 23, 2020 •

edited

mheppler Jul 27, 2020

pdurbin Jul 27, 2020

mheppler Jul 27, 2020

pdurbin Jul 27, 2020

pdurbin commented Jul 27, 2020 •

edited

djbrooke commented Jul 27, 2020

kcondon commented Jul 29, 2020

pdurbin commented Jul 29, 2020

kcondon commented Jul 29, 2020

pdurbin commented Jul 29, 2020

kcondon commented Jul 29, 2020

pdurbin commented Jul 29, 2020

kcondon commented Jul 30, 2020 •

edited

pdurbin commented Jul 30, 2020

kcondon commented Jul 30, 2020

Fernand0S commented Aug 13, 2020 •

edited by jggautier

pdurbin commented Aug 24, 2020

Fernand0S commented Aug 24, 2020

add message when DataCite DOI has not been reserved #7102 #7121

add message when DataCite DOI has not been reserved #7102 #7121

Conversation

pdurbin commented Jul 23, 2020 • edited

coveralls commented Jul 23, 2020 • edited

mheppler Jul 27, 2020

Choose a reason for hiding this comment

pdurbin Jul 27, 2020

Choose a reason for hiding this comment

mheppler Jul 27, 2020

Choose a reason for hiding this comment

pdurbin Jul 27, 2020

Choose a reason for hiding this comment

pdurbin commented Jul 27, 2020 • edited

djbrooke commented Jul 27, 2020

kcondon commented Jul 29, 2020

pdurbin commented Jul 29, 2020

kcondon commented Jul 29, 2020

pdurbin commented Jul 29, 2020

kcondon commented Jul 29, 2020

pdurbin commented Jul 29, 2020

kcondon commented Jul 30, 2020 • edited

pdurbin commented Jul 30, 2020

kcondon commented Jul 30, 2020

Fernand0S commented Aug 13, 2020 • edited by jggautier

pdurbin commented Aug 24, 2020

Fernand0S commented Aug 24, 2020

pdurbin commented Jul 23, 2020 •

edited

coveralls commented Jul 23, 2020 •

edited

pdurbin commented Jul 27, 2020 •

edited

kcondon commented Jul 30, 2020 •

edited

Fernand0S commented Aug 13, 2020 •

edited by jggautier