€cdocutils.nodes document q)q}q(U nametypesq}q(X(use case 27 - metadata version migrationqNXuc27qˆXhistoryqˆuUsubstitution_defsq }q Uparse_messagesq ]q Ucurrent_sourceq NU decorationqNUautofootnote_startqKUnameidsq}q(hU&use-case-27-metadata-version-migrationqhUuc27qhUhistoryquUchildrenq]q(cdocutils.nodes target q)q}q(U rawsourceqX .. _UC27:UparentqhUsourceqXj/var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/UseCases/27_uc.txtqUtagnameqUtargetqU attributesq }q!(Uidsq"]Ubackrefsq#]Udupnamesq$]Uclassesq%]Unamesq&]Urefidq'huUlineq(KUdocumentq)hh]ubcdocutils.nodes section q*)q+}q,(hUhhhhUexpect_referenced_by_nameq-}q.hhshUsectionq/h }q0(h$]h%]h#]h"]q1(hheh&]q2(hheuh(Kh)hUexpect_referenced_by_idq3}q4hhsh]q5(cdocutils.nodes title q6)q7}q8(hX(Use Case 27 - Metadata Version Migrationq9hh+hhhUtitleq:h }q;(h$]h%]h#]h"]h&]uh(Kh)hh]q…q?}q@(hh9hh7ubaubcsphinx.addnodes index qA)qB}qC(hUhh+hhhUindexqDh }qE(h"]h#]h$]h%]h&]UentriesqF]qG((UsingleqHX Use Case 27Uindex-0qIUNtqJ(hHXUC27hIUNtqK(hHX MN StatushIUNtqL(hHXstatushIUNtqM(hHXhealthhIUNtqNeUinlineqO‰uh(Kh)hh]ubh)qP}qQ(hUhh+hhhhh }qR(h"]h#]h$]h%]h&]h'hIuh(Kh)hh]ubcdocutils.nodes definition_list qS)qT}qU(hUhh+hhh-}hUdefinition_listqVh }qW(h$]h%]h#]h"]qXhIah&]uh(Nh)hh3}qYhIhPsh]qZ(cdocutils.nodes definition_list_item q[)q\}q](hX+Revisions View document revision history_. hhThhhUdefinition_list_itemq^h }q_(h$]h%]h#]h"]h&]uh(K h]q`(cdocutils.nodes term qa)qb}qc(hX Revisionsqdhh\hhhUtermqeh }qf(h$]h%]h#]h"]h&]uh(K h]qgh=X Revisionsqh…qi}qj(hhdhhbubaubcdocutils.nodes definition qk)ql}qm(hUh }qn(h$]h%]h#]h"]h&]uhh\h]qocdocutils.nodes paragraph qp)qq}qr(hX View document revision history_.hhlhhhU paragraphqsh }qt(h$]h%]h#]h"]h&]uh(K h]qu(h=XView document revision qv…qw}qx(hXView document revision hhqubcdocutils.nodes reference qy)qz}q{(hXhistory_Uresolvedq|KhhqhU referenceq}h }q~(UnameXhistoryqUrefuriq€X”https://redmine.dataone.org/projects/d1/repository/changes/documents/Projects/cicore/architecture/api-documentation/source/design/UseCases/27_uc.txtqh"]h#]h$]h%]h&]uh]q‚h=Xhistoryqƒ…q„}q…(hUhhzubaubh=X.…q†}q‡(hX.hhqubeubahU definitionqˆubeubh[)q‰}qŠ(hX…Goal CN should support forward migration of metadata documents from one version to another within a standard and to other standards. hhThhhh^h }q‹(h$]h%]h#]h"]h&]uh(K h)hh]qŒ(ha)q}qŽ(hXGoalqhh‰hhhheh }q(h$]h%]h#]h"]h&]uh(K h]q‘h=XGoalq’…q“}q”(hhhhubaubhk)q•}q–(hUh }q—(h$]h%]h#]h"]h&]uhh‰h]q˜hp)q™}qš(hXCN should support forward migration of metadata documents from one version to another within a standard and to other standards.q›hh•hhhhsh }qœ(h$]h%]h#]h"]h&]uh(K h]qh=XCN should support forward migration of metadata documents from one version to another within a standard and to other standards.qž…qŸ}q (hh›hh™ubaubahhˆubeubeubhp)q¡}q¢(hXSummaryq£hh+hhhhsh }q¤(h$]h%]h#]h"]h&]uh(Kh)hh]q¥h=XSummaryq¦…q§}q¨(hh£hh¡ubaubcdocutils.nodes block_quote q©)qª}q«(hUhh+hhhU block_quoteq¬h }q­(h$]h%]h#]h"]h&]uh(Nh)hh]q®(hp)q¯}q°(hXÖThe standards to which science metadata are developed evolve over time, and it should be possible to perform lossless update of science metadata to ensure that content is kept up-to-date with current use standards.q±hhªhhhhsh }q²(h$]h%]h#]h"]h&]uh(Kh]q³h=XÖThe standards to which science metadata are developed evolve over time, and it should be possible to perform lossless update of science metadata to ensure that content is kept up-to-date with current use standards.q´…qµ}q¶(hh±hh¯ubaubhp)q·}q¸(hX—Since Coordinating Nodes hold original copies of all science metadata, it should be reasonably straight forward for a privileged service on a CN to create new versions of science metadata given appropriate tools for performing the transforms. The original copies of the metadata should be preserved and the associated system metadata references updated to indicate the newer version of the science metadata.q¹hhªhhhhsh }qº(h$]h%]h#]h"]h&]uh(Kh]q»h=X—Since Coordinating Nodes hold original copies of all science metadata, it should be reasonably straight forward for a privileged service on a CN to create new versions of science metadata given appropriate tools for performing the transforms. The original copies of the metadata should be preserved and the associated system metadata references updated to indicate the newer version of the science metadata.q¼…q½}q¾(hh¹hh·ubaubhp)q¿}qÀ(hXÔNote that while technically feasible, such a service may not be desirable as it implies a level of control exerted by the Coordinating Nodes that may be in conflict with data sharing and participation agreements.qÁhhªhhhhsh }qÂ(h$]h%]h#]h"]h&]uh(Kh]qÃh=XÔNote that while technically feasible, such a service may not be desirable as it implies a level of control exerted by the Coordinating Nodes that may be in conflict with data sharing and participation agreements.qÄ…qÅ}qÆ(hhÁhh¿ubaubeubhS)qÇ}qÈ(hUhh+hNhhVh }qÉ(h$]h%]h#]h"]h&]uh(Nh)hh]qÊ(h[)qË}qÌ(hXdActors - Coordinating Nodes - Science metadata - Data managers - Science metadata translation tools hhÇhhhh^h }qÍ(h$]h%]h#]h"]h&]uh(K$h]qÎ(ha)qÏ}qÐ(hXActorsqÑhhËhhhheh }qÒ(h$]h%]h#]h"]h&]uh(K$h]qÓh=XActorsqÔ…qÕ}qÖ(hhÑhhÏubaubhk)q×}qØ(hUh }qÙ(h$]h%]h#]h"]h&]uhhËh]qÚcdocutils.nodes bullet_list qÛ)qÜ}qÝ(hUh }qÞ(UbulletqßX-h"]h#]h$]h%]h&]uhh×h]qà(cdocutils.nodes list_item qá)qâ}qã(hXCoordinating Nodesqäh }qå(h$]h%]h#]h"]h&]uhhÜh]qæhp)qç}qè(hhähhâhhhhsh }qé(h$]h%]h#]h"]h&]uh(K!h]qêh=XCoordinating Nodesqë…qì}qí(hhähhçubaubahU list_itemqîubhá)qï}qð(hXScience metadataqñh }qò(h$]h%]h#]h"]h&]uhhÜh]qóhp)qô}qõ(hhñhhïhhhhsh }qö(h$]h%]h#]h"]h&]uh(K"h]q÷h=XScience metadataqø…qù}qú(hhñhhôubaubahhîubhá)qû}qü(hX Data managersqýh }qþ(h$]h%]h#]h"]h&]uhhÜh]qÿhp)r}r(hhýhhûhhhhsh }r(h$]h%]h#]h"]h&]uh(K#h]rh=X Data managersr…r}r(hhýhjubaubahhîubhá)r}r(hX#Science metadata translation tools h }r (h$]h%]h#]h"]h&]uhhÜh]r hp)r }r (hX"Science metadata translation toolsr hjhhhhsh }r(h$]h%]h#]h"]h&]uh(K$h]rh=X"Science metadata translation toolsr…r}r(hj hj ubaubahhîubehU bullet_listrubahhˆubeubh[)r}r(hX×Preconditions - A new version of a science metadata standard exists - Content exists in the deprecated version - A translation tool exists for performing the migrations - Agreements for the update have been secured hhÇhhhh^h }r(h$]h%]h#]h"]h&]uh(K*h)hh]r(ha)r}r(hX Preconditionsrhjhhhheh }r(h$]h%]h#]h"]h&]uh(K*h]rh=X Preconditionsr…r}r(hjhjubaubhk)r }r!(hUh }r"(h$]h%]h#]h"]h&]uhjh]r#hÛ)r$}r%(hUh }r&(hßX-h"]h#]h$]h%]h&]uhj h]r'(há)r(}r)(hX3A new version of a science metadata standard existsr*h }r+(h$]h%]h#]h"]h&]uhj$h]r,hp)r-}r.(hj*hj(hhhhsh }r/(h$]h%]h#]h"]h&]uh(K'h]r0h=X3A new version of a science metadata standard existsr1…r2}r3(hj*hj-ubaubahhîubhá)r4}r5(hX(Content exists in the deprecated versionr6h }r7(h$]h%]h#]h"]h&]uhj$h]r8hp)r9}r:(hj6hj4hhhhsh }r;(h$]h%]h#]h"]h&]uh(K(h]r<h=X(Content exists in the deprecated versionr=…r>}r?(hj6hj9ubaubahhîubhá)r@}rA(hX7A translation tool exists for performing the migrationsrBh }rC(h$]h%]h#]h"]h&]uhj$h]rDhp)rE}rF(hjBhj@hhhhsh }rG(h$]h%]h#]h"]h&]uh(K)h]rHh=X7A translation tool exists for performing the migrationsrI…rJ}rK(hjBhjEubaubahhîubhá)rL}rM(hX,Agreements for the update have been secured h }rN(h$]h%]h#]h"]h&]uhj$h]rOhp)rP}rQ(hX+Agreements for the update have been securedrRhjLhhhhsh }rS(h$]h%]h#]h"]h&]uh(K*h]rTh=X+Agreements for the update have been securedrU…rV}rW(hjRhjPubaubahhîubehjubahhˆubeubh[)rX}rY(hX8Triggers - A new metadata standard revision is released hhÇhhhh^h }rZ(h$]h%]h#]h"]h&]uh(K-h)hh]r[(ha)r\}r](hXTriggersr^hjXhhhheh }r_(h$]h%]h#]h"]h&]uh(K-h]r`h=XTriggersra…rb}rc(hj^hj\ubaubhk)rd}re(hUh }rf(h$]h%]h#]h"]h&]uhjXh]rghÛ)rh}ri(hUh }rj(hßX-h"]h#]h$]h%]h&]uhjdh]rkhá)rl}rm(hX-A new metadata standard revision is released h }rn(h$]h%]h#]h"]h&]uhjhh]rohp)rp}rq(hX,A new metadata standard revision is releasedrrhjlhhhhsh }rs(h$]h%]h#]h"]h&]uh(K-h]rth=X,A new metadata standard revision is releasedru…rv}rw(hjrhjpubaubahhîubahjubahhˆubeubh[)rx}ry(hX¹Post Conditions - Copies of metadata in the new version are created - References between the new and deprecated copies are created - Watchers of the objects are notified of the changes hhÇhhhh^h }rz(h$]h%]h#]h"]h&]uh(K2h)hh]r{(ha)r|}r}(hXPost Conditionsr~hjxhhhheh }r(h$]h%]h#]h"]h&]uh(K2h]r€h=XPost Conditionsr…r‚}rƒ(hj~hj|ubaubhk)r„}r…(hUh }r†(h$]h%]h#]h"]h&]uhjxh]r‡hÛ)rˆ}r‰(hUh }rŠ(hßX-h"]h#]h$]h%]h&]uhj„h]r‹(há)rŒ}r(hX1Copies of metadata in the new version are createdrŽh }r(h$]h%]h#]h"]h&]uhjˆh]rhp)r‘}r’(hjŽhjŒhhhhsh }r“(h$]h%]h#]h"]h&]uh(K0h]r”h=X1Copies of metadata in the new version are createdr•…r–}r—(hjŽhj‘ubaubahhîubhá)r˜}r™(hX<References between the new and deprecated copies are createdršh }r›(h$]h%]h#]h"]h&]uhjˆh]rœhp)r}rž(hjšhj˜hhhhsh }rŸ(h$]h%]h#]h"]h&]uh(K1h]r h=X<References between the new and deprecated copies are createdr¡…r¢}r£(hjšhjubaubahhîubhá)r¤}r¥(hX4Watchers of the objects are notified of the changes h }r¦(h$]h%]h#]h"]h&]uhjˆh]r§hp)r¨}r©(hX3Watchers of the objects are notified of the changesrªhj¤hhhhsh }r«(h$]h%]h#]h"]h&]uh(K2h]r¬h=X3Watchers of the objects are notified of the changesr­…r®}r¯(hjªhj¨ubaubahhîubehjubahhˆubeubeubhp)r°}r±(hX **Notes**r²hh+hhhhsh }r³(h$]h%]h#]h"]h&]uh(K4h)hh]r´cdocutils.nodes strong rµ)r¶}r·(hj²h }r¸(h$]h%]h#]h"]h&]uhj°h]r¹h=XNotesrº…r»}r¼(hUhj¶ubahUstrongr½ubaubhÛ)r¾}r¿(hUhh+hhhjh }rÀ(hßX-h"]h#]h$]h%]h&]uh(K6h)hh]rÁhá)rÂ}rÃ(hX#Should this apply to data as well? hj¾hhhhîh }rÄ(h$]h%]h#]h"]h&]uh(Nh)hh]rÅhp)rÆ}rÇ(hX"Should this apply to data as well?rÈhjÂhhhhsh }rÉ(h$]h%]h#]h"]h&]uh(K6h]rÊh=X"Should this apply to data as well?rË…rÌ}rÍ(hjÈhjÆubaubaubaubh)rÎ}rÏ(hX¡.. _history: https://redmine.dataone.org/projects/d1/repository/changes/documents/Projects/cicore/architecture/api-documentation/source/design/UseCases/27_uc.txtU referencedrÐKhh+hhhhh }rÑ(h€hh"]rÒhah#]h$]h%]h&]rÓhauh(K8h)hh]ubeubehUU transformerrÔNU footnote_refsrÕ}rÖUrefnamesr×}rØh]rÙhzasUsymbol_footnotesrÚ]rÛUautofootnote_refsrÜ]rÝUsymbol_footnote_refsrÞ]rßU citationsrà]ráh)hU current_linerâNUtransform_messagesrã]rä(cdocutils.nodes system_message rå)ræ}rç(hUh }rè(h$]UlevelKh"]h#]Usourcehh%]h&]UlineKUtypeUINFOréuh]rêhp)rë}rì(hUh }rí(h$]h%]h#]h"]h&]uhjæh]rîh=X*Hyperlink target "uc27" is not referenced.rï…rð}rñ(hUhjëubahhsubahUsystem_messageròubjå)ró}rô(hUh }rõ(h$]UlevelKh"]h#]Usourcehh%]h&]UlineKUtypejéuh]röhp)r÷}rø(hUh }rù(h$]h%]h#]h"]h&]uhjóh]rúh=X-Hyperlink target "index-0" is not referenced.rû…rü}rý(hUhj÷ubahhsubahjòubeUreporterrþNUid_startrÿKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r (Ufootnote_backlinksr KUrecord_dependenciesr NU rfc_base_urlr Uhttps://tools.ietf.org/html/r U tracebackrˆUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh:NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetr‰Uoutput_encoding_error_handlerrUstrictrU sectnum_xformr KUdump_transformsr!NU docinfo_xformr"KUwarning_streamr#NUpep_file_url_templater$Upep-%04dr%Uexit_status_levelr&KUconfigr'NUstrict_visitorr(NUcloak_email_addressesr)ˆUtrim_footnote_reference_spacer*‰Uenvr+NUdump_pseudo_xmlr,NUexpose_internalsr-NUsectsubtitle_xformr.‰U source_linkr/NUrfc_referencesr0NUoutput_encodingr1Uutf-8r2U source_urlr3NUinput_encodingr4U utf-8-sigr5U_disable_configr6NU id_prefixr7UU tab_widthr8KUerror_encodingr9UUTF-8r:U_sourcer;hUgettext_compactr<ˆU generatorr=NUdump_internalsr>NU smart_quotesr?‰U pep_base_urlr@U https://www.python.org/dev/peps/rAUsyntax_highlightrBUlongrCUinput_encoding_error_handlerrDjUauto_id_prefixrEUidrFUdoctitle_xformrG‰Ustrip_elements_with_classesrHNU _config_filesrI]Ufile_insertion_enabledrJˆU raw_enabledrKKU dump_settingsrLNubUsymbol_footnote_startrMKUidsrN}rO(hh+hIhThh+hjÎuUsubstitution_namesrP}rQhh)h }rR(h$]h"]h#]Usourcehh%]h&]uU footnotesrS]rTUrefidsrU}rV(h]rWhahI]rXhPauub.