DOIs and Zenodo

The CPS-VO has integrated with an archive and DOI generation service provided by Zenodo. Zenodo refers to these entities within their API as depositions. This integration is still being actively improved, with several enhancements planned in the future. We also have added the ability to list your own DOI, if you have previously published content that has been also made available here on the CPS-VO.

All functions described in this section of the documentation can be accessed using the 'DOI' tab, which will only be visible if this feature is available for the content being displayed.

Image showing where the Zenodo tab is for enabled nodes

Currently, the types of content that we have the Zenodo service enabled for is limited, but we do plan to expand which content types support Zenodo. Please reach out to us with the contact form if you have a specific question or request for support regarding our Zenodo integration.

Viewing DOI information

Content on the CPS-VO that has provided related DOI information will display a DOI tag at the bottom of the node as marked in the image below with the red arrow. People who wish to cite this content can utiliize this DOI information or can click on the tag to be taken to to view more detailed information.
If DOI information is available, it will be displayed in a tag at the bottom of the node.

If your user account has permission to view extended details of the DOI information, you can access these details via the Zenodo tab at the top of the content. Pre-existing DOi information has very little extended information:

Example of basic DOI details

Zenodo archives will contain substantially more information, as well as a link to view the archive on the Zenodo website:

Example of Zenodo archive details

Requesting a DOI from another author

Content that does not yet have a DOI associated to it on the CPS-VO will have a link for requesting a DOI from the author if the following conditions are met:

  • You have the necessary permissions to request a citable tag from the author
    (currently Trusted User and above: learn more about roles here and check your Badges under 'My Account' to see which you have)
  • The content type has citations enabled for it
  • The author has not disabled DOI/Zenodo for the particular piece of content

Image showing where the 'Request DOI' link can be found

Following the link to 'Request DOI' will present you with the form below:

Example of form for requesting a DOI from another author

If you have previously requested a DOI for this content, there will be an additional message warning you about this. It is preferred that you do NOT repeatedly request a DOI as this will generate an email to the author each time; it remains available for extenuating circumstances.

Example of form for requesting a DOI from another author, with previous pending request.

You will be notified at the email address associated with your account when the author either denies your request or publishes a DOI for the node as requested.

Dealing with a DOI request from another user

If you have authored content on the CPS-VO, you may receive an email from our 'announcements' email address informing you that a user has requested a DOI be generated for content authored by you. This email will contain the user name of the requester with a link to their account, the name of the content involved with a link to that, any comments from the requester, and links to the Zenodo tab for adding a DOI as well as a link to directly deny the request. You will be required to log in to access the Zenodo or denial links. Logging in will also make more information available to you when viewing the requesters account page, if you are a Trusted User or better role.

Viewing the 'Zenodo' tab for your content will have an additional message at the top if you have pending requests:

example of pending requests for an author

As the message indicates, publishing an archive or submitting a pre-existing DOI will automatically fulfill all pending requests. When requests are fulfilled or denied, the requesters will receive an email informing them.

It is possible that you might receive a request for a DOI, and not have sufficient permissions to add or generate a DOI on the CPS-VO. If this occurs, please apply for elevated "trusted user" status via the "Contact Support" link under the "Home" tab in the global menu at the top of every CPS-VO page.

Adding an existing DOI record to your content

Often content on the CPS-VO will reflect work published elsewhere, and you may wish to tag your content with such DOI information. Users that have permission to manage their own DOI can manage the DOI information for enabled content types via the 'Zenodo' tab or the 'Generate DOI' link at the bottom of the content.

Image showing where the 'Generate DOI' link is for content

You will be presented with two expandable sections, the first of which 'Associated DOIs (no Zenodo archive)' you'll use for adding a pre-existing DOI. Simply enter the DOI in the form and submit, and it will be immediately visible on the node going forward for all users.

Example of the form for adding a pre-existing DOI to a node.

Please note that if you change the node after adding a DOI, the DOI will be disabled until you return to this form and confirm it is still valid for the content by clicking on 'Re-enable' button.

This type of DOI information CAN be deleted from the node.

Generating an archive DOI with Zenodo

If you wish to archive content from the CPS-VO itself and generate a DOI from that archive, our Zenodo service integration can provide that.

For file content types, the file itself will be transmitted to Zenodo and archived. For other enable content types, a PDF of the node will be generated and archived with Zenodo. Currently there is a file size limitation of 100MB. If your file content is larger, this feature will not be available.

Users that have permission to manage their own DOI can manage the DOI information for enabled content types via the 'Zenodo' tab or the 'Generate DOI' link at the bottom of the content.

Example of where to find the 'generate DOI' link

You will be presented with two expandable sections, the second of which 'Zenodo Archives/DOI' you'll use for adding a new archive. All fields are required.

New archive's fields are pre-filled with content from the node itself. Draft archives are filled with content as previously submitted to Zenodo! All can be edited as desired until it is published.

Example of. Zenodo new archive form

Publishing an archive with Zenodo is a two-step process - first is creation of the draft, and then after you are satisfied with it, publishing the draft. A draft archive that has been submitted to Zenodo will have a dark yellow heading with {Draft} in the title, and will look similar to this:

Example of Zenodo archive draft

If you need to modify the data, please be sure to click 'Update'. The publish button does not submit form changes to Zenodo; it only publishes the last data that Zenodo received from us!

Published archives are permanent records with Zenodo and cannot be altered or deleted after being published! Once an archive is published, it will have a green header with {Published} and look similar to this:

Example of published zenodo archive

Disabling DOIs/Zenodo for your content

In some cases, having DOIs or Zenodo options for your content does not make sense, or you simply may not wish to have it. For these situations, we have added the ability to explicitly disable the Zenodo feature for your content. When editing content for which the DOI/Zenodo feature is enabled, you will have an additional option you can check for completely disabling the Zenodo functionality for your node.

Image showing the 'Disable Zenodo' checkbox

If the adminstrators of the CPS-VO disable Zenodo site-wide for a specific content type, any existing, valid, published DOI information will still be shown on the node until the node has been edited, thereby invalidating the DOIs.

Troubleshooting DOIs

The nature of DOIs requires that the content referenced cannot change. However, the CPS-VO has significant metadata for nodes that can be altered without substantively modifying the actual content the DOI refers to.
Our solution for this is to disable a DOI if the node has changed since the DOI was added/published. It will be hidden from view on the node page, but still be visible on the Zenodo tab to the author, with a red heading. The label showing 'Current Version' will be replaced with the revision information that matches what the DOI was published under:

Example disabled DOI information

If you are confident that the content has not substantively changed and that the DOI is still an accurate representation of the content, you may re-enable the DOI and it will be flagged with the current version again.

Rarely, it is possible the CPS-VO will be out of sync with what is actually published on Zenodo. If you experience a situation where publishing an archive throws no errors but still doesn't seem to work, please use the 'Contact Us' page or the feedback tab with the specific node you are experiencing an issue with.