Difference between revisions of "Ckan 2 zenodo library"

From Gcube Wiki
Jump to: navigation, search
(Overview)
(Configuration)
Line 17: Line 17:
 
The Final Deposition is then returned to the client for further editing, which can eventually ask for its publication (the new Zenodo Doi will be then applied to the CKAN item through gCat).
 
The Final Deposition is then returned to the client for further editing, which can eventually ask for its publication (the new Zenodo Doi will be then applied to the CKAN item through gCat).
  
===Configuration===
+
===IS Configuration===
 +
*'''Zenodo Credentials''' ServiceEndpoint
 +
<source lang="xml">
 +
..
 +
<Category>Repository</Category>
 +
..
 +
<Platform>
 +
  <Name>Zenodo</Name>
 +
...
 +
</source>
 +
 
 +
*'''XML Mapping''' Generic Resource
 +
:'''NB:''' one '''XML Mapping''' per profile is supported
 +
<source lang="xml">
 +
..
 +
<SecondaryType>Ckan-Zenodo-Mappings</SecondaryType>
 +
 
 +
<Name>[***PROFILE_ID***]</Name>
 +
..
 +
</source>
 +
 
 
===Mappings===
 
===Mappings===
 
====Directives====
 
====Directives====

Revision as of 16:05, 26 June 2020

The org.gcube.data.publishing.ckan2Zenodo gCube component is a Java library which translates CKAN items into Zenodo depositions, allowing to further editing and publication.

Overview

Ckan2 zenodo.png

The library is invoked by the client (in this case the gCube CKAN GUI), which relies on the gCat service for interacting with CKAN. After the ckan item is loaded, a default translation is then applied on the item's core fields generating in a Draft Zenodo Deposition. NB If the item has already a linked Zenodo DOI, the Draft Deposition overrides its specified informations.

A XML Mapping associated with item's profile, is then loaded from the IS (token must be specified by the client). The XML Mapping extracts data from the CKAN item and applies them to the Draft Deposition, resulting in a Final Deposition.

The Final Deposition is then returned to the client for further editing, which can eventually ask for its publication (the new Zenodo Doi will be then applied to the CKAN item through gCat).

IS Configuration

  • Zenodo Credentials ServiceEndpoint
..
<Category>Repository</Category>
..
<Platform>
  <Name>Zenodo</Name>
...
  • XML Mapping Generic Resource
NB: one XML Mapping per profile is supported
..
<SecondaryType>Ckan-Zenodo-Mappings</SecondaryType>
 
<Name>[***PROFILE_ID***]</Name>
..

Mappings

Directives

Integration

Maven coordinates

Source Code