Project

General

Profile

metacat / docs / user / metacat / source / doi.rst @ 8272

1
.. raw:: latex
2

    
3
  \newpage
4
  
5

    
6
DOI Management
7
=====================
8

    
9
.. index:: DOI
10

    
11
Author
12
  Benjamin Leinfelder
13

    
14
Date
15
  - 20130307 [BRL] Initial draft of DOI documentation
16

    
17
Goal
18
  Register DOI-identified objects with the EZID service on insert/update
19

    
20
Summary 
21
  Metacat supports generating identifiers using UUID and DOI schemes via the 
22
  DataONE Member Node API. After client has generated a DOI using this 
23
  method, Metacat must ensure that the DOI registration with EZID/DataCite
24
  is created and kept up-to-date.
25

    
26
DOI Generation
27
---------------------
28
Metacat will generate, or "mint" a DOI using the EZID service and return that
29
identifier to the client. This identifier is guaranteed by EZID to be unique 
30
for the shoulder configured for this Metacat instance. The Metacat instance
31
must have a valid EZID account in order to utilze the EZID service.
32

    
33
There will be no attempt to "reserve" the DOI with the CN because Metacat 
34
will be configured with a unique shoulder and a specific EZID account that 
35
allows minting under that shoulder.
36

    
37
DOIs will only be minted if the following metacat.properties are set.
38

    
39
=========================== =============================================================
40
Metadata Field     			Source or value of metadata
41
=========================== =============================================================
42
guid.ezid.enabled			true (default, false)
43
guid.ezid.username			<EZID account> (default, "apitest")
44
guid.ezid.password			<EZID password> (default, "apitest")
45
guid.ezid.doishoulder.1		<EZID shoulder for home server> (default, "doi:10.5072/FK2")
46
=========================== =============================================================
47

    
48

    
49
DOI Registration
50
---------------------
51
When an object identified with a DOI is inserted or updated in Metacat 
52
using the DataONE API, Metacat will supply EZID with the appropriate 
53
metadata for that DOI based on the information available for the object.
54

    
55
The following metadata will be submitted for objects that specify an AccessPolicy 
56
containing a public read rule. The same metadata will be updated when the 
57
Member Node is alerted to a SystemMetadata change on the CN. When a newer
58
object is added (MN.update()) metadata for the obsolete object is updated as 
59
the metadata for the new object is added - both via EZID API.
60

    
61
====================================================== =======================================================================
62
Metadata Field     										Source or value of metadata
63
====================================================== =======================================================================
64
dc_identifier											the DOI value
65
datacite_url											the MN /object URL
66
dc_title												collect from EML; or default to "[Meta]Data object" depending on type
67
dc_creator												collect from EML; default to SM.rightsHolder
68
dc_publisher											Member Node nodeId or nodeName
69
datacite_publicationyear								collect from EML; default to SM.dateUploaded
70
datacite_resourcetypegeneral							"Dataset"
71
datacite_resourcetype									one of "metadata" or "data"
72
datacite_format											SM.formatId
73
datacite_relatedidentifier_ispreviousversionof			SM.obsoletedBy
74
datacite_relatedidentifier_ispreviousversionoftype		"DOI", if above exists
75
datacite_relatedidentifier_isnewversionof				SM.obsoletes
76
datacite_relatedidentifier_isnewversionoftype			"DOI", if above exists
77
datacite_relatedidentifier_ispartof						ORE DOI or MN /object URL 
78
datacite_relatedidentifier_ispartoftype					"DOI" or "URL", if above exists 
79
====================================================== =======================================================================
80

    
81
DOI Registration for deprecated Metacat API
82
---------------------------------------------
83
For objects that are inserted or updated using the original Metacat API
84
using identifiers in the form
85

    
86
::
87

    
88
	scope.docid.rev 
89
	
90
(e.g., "smith.1.1") will have DOIs generated in the form
91

    
92
::
93

    
94
	<configured doi shoulder>/scope.docid.rev
95

    
96
(e.g., "doi:10.5072/FK2/smith.1.1") and registered with the same metadata as objects 
97
submitted via the DataONE API.