Tdocutils.nodesdocument)}( rawsourcechildren](hraw)}(h\newpageh]hText\newpage}(hhparenth uba attributes}(ids]classes]names]dupnames]backrefs]formatlatex xml:spacepreserveutagnameh sourceW/var/lib/jenkins/jobs/Metacat_stable/workspace/metacat/docs/user/metacat/source/doi.rstlineKhhhhubhsection)}(hhh](htitle)}(hDOI Managementh]hDOI Management}(hh3hh1hhh'Nh)Nubah}(h]h]h]h]h ]uh&h/hh,hhh'h(h)Kubsphinx.addnodesindex)}(hhh]h}(h]h]h]h]h ]entries](singleDOIindex-0hNtainlineuh&h@h'h(h)K hh,hhubhtarget)}(hhh]h}(h]h]h]h]h ]refidhOuh&hRhh,hhh'h(h)K ubhdefinition_list)}(hhh](hdefinition_list_item)}(hAuthor Benjamin Leinfelder h](hterm)}(hAuthorh]hAuthor}(hhmhhkubah}(h]h]h]h]h ]uh&hih'h(h)K hheubh definition)}(hhh]h paragraph)}(hBenjamin Leinfelderh]hBenjamin Leinfelder}(hhhhubah}(h]h]h]h]h ]uh&h~h'h(h)K hh{ubah}(h]h]h]h]h ]uh&hyhheubeh}(h]h]h]h]h ]uh&hch'h(h)K hh`ubhd)}(h9Date - 20130307 [BRL] Initial draft of DOI documentation h](hj)}(hDateh]hDate}(hhhhubah}(h]h]h]h]h ]uh&hih'h(h)Khhubhz)}(hhh]h bullet_list)}(hhh]h list_item)}(h220130307 [BRL] Initial draft of DOI documentation h]h)}(h120130307 [BRL] Initial draft of DOI documentationh]h120130307 [BRL] Initial draft of DOI documentation}(hhhhubah}(h]h]h]h]h ]uh&h~h'h(h)Khhubah}(h]h]h]h]h ]uh&hhhubah}(h]h]h]h]h ]bullet-uh&hh'h(h)Khhubah}(h]h]h]h]h ]uh&hyhhubeh}(h]h]h]h]h ]uh&hch'h(h)Khh`hhubhd)}(hLGoal Register DOI-identified objects with the EZID service on insert/update h](hj)}(hGoalh]hGoal}(hhhhubah}(h]h]h]h]h ]uh&hih'h(h)Khhubhz)}(hhh]h)}(hFRegister DOI-identified objects with the EZID service on insert/updateh]hFRegister DOI-identified objects with the EZID service on insert/update}(hhhhubah}(h]h]h]h]h ]uh&h~h'h(h)Khhubah}(h]h]h]h]h ]uh&hyhhubeh}(h]h]h]h]h ]uh&hch'h(h)Khh`hhubhd)}(hXSummary Metacat supports generating identifiers using UUID and DOI schemes via the DataONE Member Node API. After client has generated a DOI using this method, Metacat must ensure that the DOI registration with EZID/DataCite is created and kept up-to-date. h](hj)}(hSummaryh]hSummary}(hjhjubah}(h]h]h]h]h ]uh&hih'h(h)Khjubhz)}(hhh]h)}(hMetacat supports generating identifiers using UUID and DOI schemes via the DataONE Member Node API. After client has generated a DOI using this method, Metacat must ensure that the DOI registration with EZID/DataCite is created and kept up-to-date.h]hMetacat supports generating identifiers using UUID and DOI schemes via the DataONE Member Node API. After client has generated a DOI using this method, Metacat must ensure that the DOI registration with EZID/DataCite is created and kept up-to-date.}(hj(hj&ubah}(h]h]h]h]h ]uh&h~h'h(h)Khj#ubah}(h]h]h]h]h ]uh&hyhjubeh}(h]h]h]h]h ]uh&hch'h(h)Khh`hhubeh}(h]hOah]h]h]h ]uh&h^hh,hhh'h(h)Nexpect_referenced_by_name}expect_referenced_by_id}hOhTsubh+)}(hhh](h0)}(hDOI Generationh]hDOI Generation}(hjOhjMhhh'Nh)Nubah}(h]h]h]h]h ]uh&h/hjJhhh'h(h)Kubh)}(hX*Metacat will generate, or "mint" a DOI using the EZID service and return that identifier to the client. This identifier is guaranteed by EZID to be unique for the shoulder configured for this Metacat instance. The Metacat instance must have a valid EZID account in order to utilze the EZID service.h]hX.Metacat will generate, or “mint” a DOI using the EZID service and return that identifier to the client. This identifier is guaranteed by EZID to be unique for the shoulder configured for this Metacat instance. The Metacat instance must have a valid EZID account in order to utilze the EZID service.}(hj]hj[hhh'Nh)Nubah}(h]h]h]h]h ]uh&h~h'h(h)KhjJhhubh)}(hThere will be no attempt to "reserve" the DOI with the CN because Metacat will be configured with a unique shoulder and a specific EZID account that allows minting under that shoulder.h]hThere will be no attempt to “reserve” the DOI with the CN because Metacat will be configured with a unique shoulder and a specific EZID account that allows minting under that shoulder.}(hjkhjihhh'Nh)Nubah}(h]h]h]h]h ]uh&h~h'h(h)K!hjJhhubh)}(hEDOIs will only be minted if the following metacat.properties are set.h]hEDOIs will only be minted if the following metacat.properties are set.}(hjyhjwhhh'Nh)Nubah}(h]h]h]h]h ]uh&h~h'h(h)K%hjJhhubhtable)}(hhh]htgroup)}(hhh](hcolspec)}(hhh]h}(h]h]h]h]h ]colwidthKuh&jhjubj)}(hhh]h}(h]h]h]h]h ]colwidthK@uh&jhjubhthead)}(hhh]hrow)}(hhh](hentry)}(hhh]h)}(hMetadata Fieldh]hMetadata Field}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)K(hjubah}(h]h]h]h]h ]uh&jhjubj)}(hhh]h)}(hSource or value of metadatah]hSource or value of metadata}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)K(hjubah}(h]h]h]h]h ]uh&jhjubeh}(h]h]h]h]h ]uh&jhjubah}(h]h]h]h]h ]uh&jhjubhtbody)}(hhh](j)}(hhh](j)}(hhh]h)}(hguid.ezid.enabledh]hguid.ezid.enabled}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)K*hjubah}(h]h]h]h]h ]uh&jhjubj)}(hhh]h)}(htrue (default, false)h]htrue (default, false)}(hjhj ubah}(h]h]h]h]h ]uh&h~h'h(h)K*hj ubah}(h]h]h]h]h ]uh&jhjubeh}(h]h]h]h]h ]uh&jhjubj)}(hhh](j)}(hhh]h)}(hguid.ezid.usernameh]hguid.ezid.username}(hj/hj-ubah}(h]h]h]h]h ]uh&h~h'h(h)K+hj*ubah}(h]h]h]h]h ]uh&jhj'ubj)}(hhh]h)}(h# (default, "apitest")h]h' (default, “apitest”)}(hjFhjDubah}(h]h]h]h]h ]uh&h~h'h(h)K+hjAubah}(h]h]h]h]h ]uh&jhj'ubeh}(h]h]h]h]h ]uh&jhjubj)}(hhh](j)}(hhh]h)}(hguid.ezid.passwordh]hguid.ezid.password}(hjfhjdubah}(h]h]h]h]h ]uh&h~h'h(h)K,hjaubah}(h]h]h]h]h ]uh&jhj^ubj)}(hhh]h)}(h$ (default, "apitest")h]h( (default, “apitest”)}(hj}hj{ubah}(h]h]h]h]h ]uh&h~h'h(h)K,hjxubah}(h]h]h]h]h ]uh&jhj^ubeh}(h]h]h]h]h ]uh&jhjubj)}(hhh](j)}(hhh]h)}(hguid.ezid.doishoulder.1h]hguid.ezid.doishoulder.1}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)K-hjubah}(h]h]h]h]h ]uh&jhjubj)}(hhh]h)}(h< (default, "doi:10.5072/FK2")h]h@ (default, “doi:10.5072/FK2”)}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)K-hjubah}(h]h]h]h]h ]uh&jhjubeh}(h]h]h]h]h ]uh&jhjubeh}(h]h]h]h]h ]uh&jhjubeh}(h]h]h]h]h ]colsKuh&jhjubah}(h]h]h]h]h ]uh&jhjJhhh'h(h)Nubeh}(h]doi-generationah]h]doi generationah]h ]uh&h*hh,hhh'h(h)Kubh+)}(hhh](h0)}(hDOI Registrationh]hDOI Registration}(hjhjhhh'Nh)Nubah}(h]h]h]h]h ]uh&h/hjhhh'h(h)K2ubh)}(hWhen an object identified with a DOI is inserted or updated in Metacat using the DataONE API, Metacat will supply EZID with the appropriate metadata for that DOI based on the information available for the object.h]hWhen an object identified with a DOI is inserted or updated in Metacat using the DataONE API, Metacat will supply EZID with the appropriate metadata for that DOI based on the information available for the object.}(hjhjhhh'Nh)Nubah}(h]h]h]h]h ]uh&h~h'h(h)K3hjhhubh)}(hXpThe following metadata will be submitted for objects that specify an AccessPolicy containing a public read rule. The same metadata will be updated when the Member Node is alerted to a SystemMetadata change on the CN. When a newer object is added (MN.update()) metadata for the obsolete object is updated as the metadata for the new object is added - both via EZID API.h]hXpThe following metadata will be submitted for objects that specify an AccessPolicy containing a public read rule. The same metadata will be updated when the Member Node is alerted to a SystemMetadata change on the CN. When a newer object is added (MN.update()) metadata for the obsolete object is updated as the metadata for the new object is added - both via EZID API.}(hjhjhhh'Nh)Nubah}(h]h]h]h]h ]uh&h~h'h(h)K7hjhhubj)}(hhh]j)}(hhh](j)}(hhh]h}(h]h]h]h]h ]colwidthK6uh&jhjubj)}(hhh]h}(h]h]h]h]h ]colwidthKvuh&jhjubj)}(hhh]j)}(hhh](j)}(hhh]h)}(hMetadata Fieldh]hMetadata Field}(hj9hj7ubah}(h]h]h]h]h ]uh&h~h'h(h)K>hj4ubah}(h]h]h]h]h ]uh&jhj1ubj)}(hhh]h)}(hSource or value of metadatah]hSource or value of metadata}(hjPhjNubah}(h]h]h]h]h ]uh&h~h'h(h)K>hjKubah}(h]h]h]h]h ]uh&jhj1ubeh}(h]h]h]h]h ]uh&jhj.ubah}(h]h]h]h]h ]uh&jhjubj)}(hhh](j)}(hhh](j)}(hhh]h)}(h dc_identifierh]h dc_identifier}(hjyhjwubah}(h]h]h]h]h ]uh&h~h'h(h)K@hjtubah}(h]h]h]h]h ]uh&jhjqubj)}(hhh]h)}(h the DOI valueh]h the DOI value}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)K@hjubah}(h]h]h]h]h ]uh&jhjqubeh}(h]h]h]h]h ]uh&jhjnubj)}(hhh](j)}(hhh]h)}(h datacite_urlh]h datacite_url}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)KAhjubah}(h]h]h]h]h ]uh&jhjubj)}(hhh]h)}(hthe MN /object URLh]hthe MN /object URL}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)KAhjubah}(h]h]h]h]h ]uh&jhjubeh}(h]h]h]h]h ]uh&jhjnubj)}(hhh](j)}(hhh]h)}(hdc_titleh]hdc_title}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)KBhjubah}(h]h]h]h]h ]uh&jhjubj)}(hhh]h)}(hEcollect from EML; or default to "[Meta]Data object" depending on typeh]hIcollect from EML; or default to “[Meta]Data object” depending on type}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)KBhjubah}(h]h]h]h]h ]uh&jhjubeh}(h]h]h]h]h ]uh&jhjnubj)}(hhh](j)}(hhh]h)}(h dc_creatorh]h dc_creator}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)KChjubah}(h]h]h]h]h ]uh&jhjubj)}(hhh]h)}(h,collect from EML; default to SM.rightsHolderh]h,collect from EML; default to SM.rightsHolder}(hj5hj3ubah}(h]h]h]h]h ]uh&h~h'h(h)KChj0ubah}(h]h]h]h]h ]uh&jhjubeh}(h]h]h]h]h ]uh&jhjnubj)}(hhh](j)}(hhh]h)}(h dc_publisherh]h dc_publisher}(hjUhjSubah}(h]h]h]h]h ]uh&h~h'h(h)KDhjPubah}(h]h]h]h]h ]uh&jhjMubj)}(hhh]h)}(hMember Node nodeId or nodeNameh]hMember Node nodeId or nodeName}(hjlhjjubah}(h]h]h]h]h ]uh&h~h'h(h)KDhjgubah}(h]h]h]h]h ]uh&jhjMubeh}(h]h]h]h]h ]uh&jhjnubj)}(hhh](j)}(hhh]h)}(hdatacite_publicationyearh]hdatacite_publicationyear}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)KEhjubah}(h]h]h]h]h ]uh&jhjubj)}(hhh]h)}(h,collect from EML; default to SM.dateUploadedh]h,collect from EML; default to SM.dateUploaded}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)KEhjubah}(h]h]h]h]h ]uh&jhjubeh}(h]h]h]h]h ]uh&jhjnubj)}(hhh](j)}(hhh]h)}(hdatacite_resourcetypegeneralh]hdatacite_resourcetypegeneral}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)KFhjubah}(h]h]h]h]h ]uh&jhjubj)}(hhh]h)}(h "Dataset"h]h “Dataset”}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)KFhjubah}(h]h]h]h]h ]uh&jhjubeh}(h]h]h]h]h ]uh&jhjnubj)}(hhh](j)}(hhh]h)}(hdatacite_resourcetypeh]hdatacite_resourcetype}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)KGhjubah}(h]h]h]h]h ]uh&jhjubj)}(hhh]h)}(hone of "metadata" or "data"h]h#one of “metadata” or “data”}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)KGhj ubah}(h]h]h]h]h ]uh&jhjubeh}(h]h]h]h]h ]uh&jhjnubj)}(hhh](j)}(hhh]h)}(hdatacite_formath]hdatacite_format}(hj1hj/ubah}(h]h]h]h]h ]uh&h~h'h(h)KHhj,ubah}(h]h]h]h]h ]uh&jhj)ubj)}(hhh]h)}(h SM.formatIdh]h SM.formatId}(hjHhjFubah}(h]h]h]h]h ]uh&h~h'h(h)KHhjCubah}(h]h]h]h]h ]uh&jhj)ubeh}(h]h]h]h]h ]uh&jhjnubj)}(hhh](j)}(hhh]h)}(h.datacite_relatedidentifier_ispreviousversionofh]h.datacite_relatedidentifier_ispreviousversionof}(hjhhjfubah}(h]h]h]h]h ]uh&h~h'h(h)KIhjcubah}(h]h]h]h]h ]uh&jhj`ubj)}(hhh]h)}(hSM.obsoletedByh]hSM.obsoletedBy}(hjhj}ubah}(h]h]h]h]h ]uh&h~h'h(h)KIhjzubah}(h]h]h]h]h ]uh&jhj`ubeh}(h]h]h]h]h ]uh&jhjnubj)}(hhh](j)}(hhh]h)}(h2datacite_relatedidentifier_ispreviousversionoftypeh]h2datacite_relatedidentifier_ispreviousversionoftype}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)KJhjubah}(h]h]h]h]h ]uh&jhjubj)}(hhh]h)}(h"DOI", if above existsh]h“DOI”, if above exists}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)KJhjubah}(h]h]h]h]h ]uh&jhjubeh}(h]h]h]h]h ]uh&jhjnubj)}(hhh](j)}(hhh]h)}(h)datacite_relatedidentifier_isnewversionofh]h)datacite_relatedidentifier_isnewversionof}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)KKhjubah}(h]h]h]h]h ]uh&jhjubj)}(hhh]h)}(h SM.obsoletesh]h SM.obsoletes}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)KKhjubah}(h]h]h]h]h ]uh&jhjubeh}(h]h]h]h]h ]uh&jhjnubj)}(hhh](j)}(hhh]h)}(h-datacite_relatedidentifier_isnewversionoftypeh]h-datacite_relatedidentifier_isnewversionoftype}(hj hj ubah}(h]h]h]h]h ]uh&h~h'h(h)KLhjubah}(h]h]h]h]h ]uh&jhjubj)}(hhh]h)}(h"DOI", if above existsh]h“DOI”, if above exists}(hj$hj"ubah}(h]h]h]h]h ]uh&h~h'h(h)KLhjubah}(h]h]h]h]h ]uh&jhjubeh}(h]h]h]h]h ]uh&jhjnubj)}(hhh](j)}(hhh]h)}(h#datacite_relatedidentifier_ispartofh]h#datacite_relatedidentifier_ispartof}(hjDhjBubah}(h]h]h]h]h ]uh&h~h'h(h)KMhj?ubah}(h]h]h]h]h ]uh&jhj<ubj)}(hhh]h)}(hORE DOI or MN /object URLh]hORE DOI or MN /object URL}(hj[hjYubah}(h]h]h]h]h ]uh&h~h'h(h)KMhjVubah}(h]h]h]h]h ]uh&jhj<ubeh}(h]h]h]h]h ]uh&jhjnubj)}(hhh](j)}(hhh]h)}(h'datacite_relatedidentifier_ispartoftypeh]h'datacite_relatedidentifier_ispartoftype}(hj{hjyubah}(h]h]h]h]h ]uh&h~h'h(h)KNhjvubah}(h]h]h]h]h ]uh&jhjsubj)}(hhh]h)}(h"DOI" or "URL", if above existsh]h'“DOI” or “URL”, if above exists}(hjhjubah}(h]h]h]h]h ]uh&h~h'h(h)KNhjubah}(h]h]h]h]h ]uh&jhjsubeh}(h]h]h]h]h ]uh&jhjnubeh}(h]h]h]h]h ]uh&jhjubeh}(h]h]h]h]h ]colsKuh&jhjubah}(h]h]h]h]h ]uh&jhjhhh'h(h)Nubeh}(h]doi-registrationah]h]doi registrationah]h ]uh&h*hh,hhh'h(h)K2ubh+)}(hhh](h0)}(h+DOI Registration for deprecated Metacat APIh]h+DOI Registration for deprecated Metacat API}(hjhjhhh'Nh)Nubah}(h]h]h]h]h ]uh&h/hjhhh'h(h)KRubh)}(heFor objects that are inserted or updated using the original Metacat API using identifiers in the formh]heFor objects that are inserted or updated using the original Metacat API using identifiers in the form}(hjhjhhh'Nh)Nubah}(h]h]h]h]h ]uh&h~h'h(h)KShjhhubh literal_block)}(hscope.docid.revh]hscope.docid.rev}(hhhjubah}(h]h]h]h]h ]h$h%uh&jh)KXhjhhh'h(ubh)}(h8(e.g., "smith.1.1") will have DOIs generated in the formh]h<(e.g., “smith.1.1”) will have DOIs generated in the form}(hjhjhhh'Nh)Nubah}(h]h]h]h]h ]uh&h~h'h(h)KZhjhhubj)}(h)/scope.docid.revh]h)/scope.docid.rev}(hhhjubah}(h]h]h]h]h ]h$h%uh&jh)K^hjhhh'h(ubh)}(hs(e.g., "doi:10.5072/FK2/smith.1.1") and registered with the same metadata as objects submitted via the DataONE API.h]hw(e.g., “doi:10.5072/FK2/smith.1.1”) and registered with the same metadata as objects submitted via the DataONE API.}(hjhjhhh'Nh)Nubah}(h]h]h]h]h ]uh&h~h'h(h)K`hjhhubeh}(h]+doi-registration-for-deprecated-metacat-apiah]h]+doi registration for deprecated metacat apiah]h ]uh&h*hh,hhh'h(h)KRubeh}(h]doi-managementah]h]doi managementah]h ]uh&h*hhhhh'h(h)Kubeh}(h]h]h]h]h ]sourceh(uh&hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(h/N generatorN datestampN source_linkN source_urlN toc_backlinksjfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerjPerror_encodingUTF-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourceh( _destinationN _config_files]pep_referencesN pep_base_url https://www.python.org/dev/peps/pep_file_url_templatepep-%04drfc_referencesN rfc_base_urlhttps://tools.ietf.org/html/ tab_widthKtrim_footnote_reference_spacefile_insertion_enabled raw_enabledKsyntax_highlightlong smart_quotessmartquotes_localesNcharacter_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xformembed_stylesheetcloak_email_addressesenvNgettext_compactubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}hO]hTasnameids}(j+j(jjjjj#j u nametypes}(j+NjNjNj#Nuh}(j(h,hOh`jjJjjj ju footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startKid_startKparse_messages]transform_messages]hsystem_message)}(hhh]h)}(hhh]h-Hyperlink target "index-0" is not referenced.}(hhhjubah}(h]h]h]h]h ]uh&h~hjubah}(h]h]h]h]h ]levelKtypeINFOsourceh(lineK uh&juba transformerN decorationNhhub.