5.8 Release - Embargoes

175 views
Skip to first unread message

danny...@g.harvard.edu

unread,
Nov 9, 2021, 11:55:44 AM11/9/21
to Dataverse Users Community
Hi everyone,

I'm excited to announce the release of 5.8! You can learn more and download the release on GitHub:


The main update in this release is Embargo functionality, contributed by DANS and GDCC. I'll copy the summary below. This is a long-requested feature and I'm really excited to see it available. Big thanks to everyone across the community who contributed to this release!

-----

Support for Data Embargoes

The Dataverse Software now supports file-level embargoes. The ability to set embargoes, up to a maximum duration (in months), can be configured by a Dataverse installation administrator. For more information, see the Embargoes section of the Dataverse Software Guides.

  • Users can configure a specific embargo, defined by an end date and a short reason, on a set of selected files or an individual file, by selecting the 'Embargo' menu item and entering information in a popup dialog. Embargoes can only be set, changed, or removed before a file has been published. After publication, only Dataverse installation administrators can make changes, using an API.

  • While embargoed, files cannot be previewed or downloaded (as if restricted, with no option to allow access requests). After the embargo expires, files become accessible. If the files were also restricted, they remain inaccessible and functionality is the same as for any restricted file.

  • By default, the citation date reported for the dataset and the datafiles in version 1.0 reflects the longest embargo period on any file in version 1.0, which is consistent with recommended practice from DataCite. Administrators can still specify an alternate date field to be used in the citation date via the Set Citation Date Field Type for a Dataset API Call.

The work to add this functionality was initiated by Data Archiving and Networked Services (DANS-KNAW), the Netherlands. It was further developed by the Global Dataverse Community Consortium (GDCC) in cooperation with and with funding from DANS.









Sherry Lake

unread,
Feb 3, 2022, 5:01:04 PM2/3/22
to Dataverse Users Community
OK.... UVa is at V 5.9 and I have set "embargoes"
(got this response back: {"status":"OK","data":{":MaxEmbargoDurationInMonths":"24"}} )

And now I am supposed to see/set an embargo how? I don't see any button or words, or anything that tells me how to set one.

What am I missing?

Thanks,
Sherry

James Myers

unread,
Feb 3, 2022, 5:06:57 PM2/3/22
to dataverse...@googlegroups.com

As with the “Restrict/Unrestrict” options, you should see “Embargo” as an option in the various menus for editing files. It is only available for files that have not already been included in a published dataset version. Choosing that option pops-up a dialog asking for a date/reason, and, if you have already set an embargo, an option to remove it (again, only on files that are in the draft version only). Selecting multiple files you can set the embargo for more than one. Once an embargo is set, you’ll see words about it in the file table, a tag on the file page, etc.

 

-- Jim

--
You received this message because you are subscribed to the Google Groups "Dataverse Users Community" group.
To unsubscribe from this group and stop receiving emails from it, send an email to dataverse-commu...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/dataverse-community/ad3cf0b9-ecff-4d46-82fc-d9ebabb74fcdn%40googlegroups.com.

Sherry Lake

unread,
Feb 3, 2022, 5:11:31 PM2/3/22
to dataverse...@googlegroups.com
I don't see "Embargo" at all. On a just created dataset.

Is the setting variable spelled correctly: MaxEmbargoDurationInMonths   ?

I just copied/pasted from the configuration settings.

Screen Shot 2022-02-03 at 5.10.14 PM.png


James Myers

unread,
Feb 3, 2022, 5:20:26 PM2/3/22
to dataverse...@googlegroups.com

Yeah – it looks OK to me. There would be a warning in the log if the setting can’t be interpreted as a number but 24 should be a good value. Off-hand I can’t think of anything and my only advice would be to check the log for a clue.

Philip Durbin

unread,
Feb 3, 2022, 5:26:21 PM2/3/22
to dataverse...@googlegroups.com
Sherry, from your screenshot it looks like you're in the "edit file metadata" screen. To select embargo you have to use either of

- the file landing page
- the file listing on the dataset page

I'll include a couple screenshots from https://demo.dataverse.org that I hope help illustrate.

Hope this helps,

Phil

p.s. I didn't realize until just now that embargo is not enabled by default. But I ran the same curl command you did on my laptop and it worked just fine.



To view this discussion on the web visit https://groups.google.com/d/msgid/dataverse-community/MN2PR07MB7343EF5059D310D293BCAB05BF289%40MN2PR07MB7343.namprd07.prod.outlook.com.


--
Screen Shot 2022-02-03 at 5.22.25 PM.png
Screen Shot 2022-02-03 at 5.22.03 PM.png

Sherry Lake

unread,
Feb 3, 2022, 5:38:34 PM2/3/22
to dataverse...@googlegroups.com

Thanks, Phil 

I’ll have to figure out why - but I do see the embargo option on our production machine but not test machine. Both are supposed to have same settings. 

I’ll check tomorrow. 


Sherry Lake

unread,
Feb 4, 2022, 9:29:37 AM2/4/22
to dataverse...@googlegroups.com
Mystery solved.... I must have ran the Embargo config setting twice on production instead once on production and once on test server.

And as Phil mentioned, Embargoes are not set by default. Admins need to "turn them on" via the config setting: 

--
Sherry


Thomas Jouneau

unread,
Apr 1, 2022, 2:32:19 AM4/1/22
to dataverse...@googlegroups.com, Sherry Lake

Hi all

I just realized that, while the "restrict/unrestrict" options are available as soon as the files have finished uploading, the embargo is not available before the user has clicked on the "Save changes" button, then come back on the dataset landing page.

Before :

After :

What is the reason behind this?

Best

Thomas

Philip Durbin

unread,
Apr 1, 2022, 3:03:15 PM4/1/22
to dataverse...@googlegroups.com
Hi Thomas,

Gustavo, Jim, and I discussed this and it sounds like there's no technical reason why we can't have an "Embargo" button on file upload (before "Save Changes"). The reason it isn't there mostly has to do with some refactoring we'd like to do of the code. I left a comment about this at https://github.com/IQSS/dataverse/issues/7376#issuecomment-1086231186 but please feel free to create an issue dedicated to having an "Embargo" button on file upload before "Save Changes".

Thanks,

Phil

To view this discussion on the web visit https://groups.google.com/d/msgid/dataverse-community/d1780f7c-6c15-333d-f2fa-c9d9c2f33786%40gmail.com.

Thomas Jouneau

unread,
Apr 4, 2022, 10:12:19 AM4/4/22
to dataverse...@googlegroups.com, Philip Durbin

Hi Philip,

Thanks!

I'm doing that now.

Best

Thomas

Thomas Jouneau

unread,
Apr 5, 2022, 3:11:32 AM4/5/22
to dataverse...@googlegroups.com, Philip Durbin

Dear all

I just created a feature request here : https://github.com/IQSS/dataverse/issues/8577

Best

Thomas

Le 01/04/2022 à 21:03, Philip Durbin a écrit :
Reply all
Reply to author
Forward
0 new messages