€cdocutils.nodes document q)q}q(U nametypesq}q(X)use case 18 - mn retrieve aggregated logsqNXuc18qˆXhistoryqˆuUsubstitution_defsq }q Uparse_messagesq ]q Ucurrent_sourceq NU decorationqNUautofootnote_startqKUnameidsq}q(hU'use-case-18-mn-retrieve-aggregated-logsqhUuc18qhUhistoryquUchildrenq]q(cdocutils.nodes target q)q}q(U rawsourceqX .. _UC18:UparentqhUsourceqXj/var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/UseCases/18_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 18 - MN Retrieve Aggregated Logsq9hh+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 18Uindex-0qIUNtqJ(hHXUC18hIUNtqK(hHXaggregated logshIUNtqL(hHX log retrievalhIUNtqM(hHXMN logshIUNtqNeUinlineqO‰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/18_uc.txtqh"]h#]h$]h%]h&]uh]q‚h=Xhistoryqƒ…q„}q…(hUhhzubaubh=X.…q†}q‡(hX.hhqubeubahU definitionqˆubeubh[)q‰}qŠ(hXqGoal Member nodes can request aggregated CRUD log for {time period/object id/userid} for all of 'their' objects. 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š(hXkMember nodes can request aggregated CRUD log for {time period/object id/userid} for all of 'their' objects.q›hh•hhhhsh }qœ(h$]h%]h#]h"]h&]uh(K h]qh=XkMember nodes can request aggregated CRUD log for {time period/object id/userid} for all of 'their' objects.qž…qŸ}q (hh›hh™ubaubahhˆubeubh[)q¡}q¢(hXÄSummary A Member Node should be able to request use information for any objects for which that Member Node is the origin (or defacto origin in the case where the original MN was decommissioned). hhThhhh^h }q£(h$]h%]h#]h"]h&]uh(Kh)hh]q¤(ha)q¥}q¦(hXSummaryq§hh¡hhhheh }q¨(h$]h%]h#]h"]h&]uh(Kh]q©h=XSummaryqª…q«}q¬(hh§hh¥ubaubhk)q­}q®(hUh }q¯(h$]h%]h#]h"]h&]uhh¡h]q°hp)q±}q²(hXºA Member Node should be able to request use information for any objects for which that Member Node is the origin (or defacto origin in the case where the original MN was decommissioned).q³hh­hhhhsh }q´(h$]h%]h#]h"]h&]uh(Kh]qµh=XºA Member Node should be able to request use information for any objects for which that Member Node is the origin (or defacto origin in the case where the original MN was decommissioned).q¶…q·}q¸(hh³hh±ubaubahhˆubeubh[)q¹}qº(hX*Actors - Coordinating Node - Member Node hhThhhh^h }q»(h$]h%]h#]h"]h&]uh(Kh)hh]q¼(ha)q½}q¾(hXActorsq¿hh¹hhhheh }qÀ(h$]h%]h#]h"]h&]uh(Kh]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 Node h }qÒ(h$]h%]h#]h"]h&]uhhÊh]qÓhp)qÔ}qÕ(hXCoordinating NodeqÖhhÐhhhhsh }q×(h$]h%]h#]h"]h&]uh(Kh]qØh=XCoordinating NodeqÙ…qÚ}qÛ(hhÖhhÔubaubahU list_itemqÜubhÏ)qÝ}qÞ(hX Member Node h }qß(h$]h%]h#]h"]h&]uhhÊh]qàhp)qá}qâ(hX Member NodeqãhhÝhhhhsh }qä(h$]h%]h#]h"]h&]uh(Kh]qåh=X Member Nodeqæ…qç}qè(hhãhháubaubahhÜubehU bullet_listqéubahhˆubeubh[)qê}që(hX6Preconditions - Aggregate logs are accumulated by CNs hhThhhh^h }qì(h$]h%]h#]h"]h&]uh(Kh)hh]qí(ha)qî}qï(hX Preconditionsqðhhêhhhheh }qñ(h$]h%]h#]h"]h&]uh(Kh]qòh=X Preconditionsqó…qô}qõ(hhðhhîubaubhk)qö}q÷(hUh }qø(h$]h%]h#]h"]h&]uhhêh]qùhÉ)qú}qû(hUh }qü(hÍX-h"]h#]h$]h%]h&]uhhöh]qýhÏ)qþ}qÿ(hX&Aggregate logs are accumulated by CNs h }r(h$]h%]h#]h"]h&]uhhúh]rhp)r}r(hX%Aggregate logs are accumulated by CNsrhhþhhhhsh }r(h$]h%]h#]h"]h&]uh(Kh]rh=X%Aggregate logs are accumulated by CNsr…r}r (hjhjubaubahhÜubahhéubahhˆubeubh[)r }r (hXCTriggers - MN Administrator requests aggregate logs - Timed event hhThhhh^h }r (h$]h%]h#]h"]h&]uh(K h)hh]r (ha)r}r(hXTriggersrhj hhhheh }r(h$]h%]h#]h"]h&]uh(K h]rh=XTriggersr…r}r(hjhjubaubhk)r}r(hUh }r(h$]h%]h#]h"]h&]uhj h]rhÉ)r}r(hUh }r(hÍX-h"]h#]h$]h%]h&]uhjh]r(hÏ)r}r(hX)MN Administrator requests aggregate logs h }r (h$]h%]h#]h"]h&]uhjh]r!hp)r"}r#(hX(MN Administrator requests aggregate logsr$hjhhhhsh }r%(h$]h%]h#]h"]h&]uh(Kh]r&h=X(MN Administrator requests aggregate logsr'…r(}r)(hj$hj"ubaubahhÜubhÏ)r*}r+(hX Timed event h }r,(h$]h%]h#]h"]h&]uhjh]r-hp)r.}r/(hX Timed eventr0hj*hhhhsh }r1(h$]h%]h#]h"]h&]uh(K h]r2h=X Timed eventr3…r4}r5(hj0hj.ubaubahhÜubehhéubahhˆubeubh[)r6}r7(hXMPost Conditions - Aggregate log information is available to the Member Node hhThhhh^h }r8(h$]h%]h#]h"]h&]uh(K$h)hh]r9(ha)r:}r;(hXPost Conditionsr<hj6hhhheh }r=(h$]h%]h#]h"]h&]uh(K$h]r>h=XPost Conditionsr?…r@}rA(hj<hj:ubaubhk)rB}rC(hUh }rD(h$]h%]h#]h"]h&]uhj6h]rEhÉ)rF}rG(hUh }rH(hÍX-h"]h#]h$]h%]h&]uhjBh]rIhÏ)rJ}rK(hX;Aggregate log information is available to the Member Node h }rL(h$]h%]h#]h"]h&]uhjFh]rMhp)rN}rO(hX9Aggregate log information is available to the Member NoderPhjJhhhhsh }rQ(h$]h%]h#]h"]h&]uh(K#h]rRh=X9Aggregate log information is available to the Member NoderS…rT}rU(hjPhjNubaubahhÜubahhéubahhˆubeubeubcdocutils.nodes comment rV)rW}rX(hXÖ@startuml images/18_seq.png participant "CRUD API" as m_crud << Member Node >> participant "Query API" as c_query << Coordinating Node >> c_query -> m_crud: getLogRecords (nodeID, fromDate, toDate) note right Assume Member Node has authority for accessing Coordinating Node log records. end note c_query <-- m_crud: records or fail note right Can the Query API handle queries on log records or should this be handled by another API? (e.g. "Report API"?) end note @endumlhh+hhhUcommentrYh }rZ(U xml:spacer[Upreserver\h"]h#]h$]h%]h&]uh(K7h)hh]r]h=XÖ@startuml images/18_seq.png participant "CRUD API" as m_crud << Member Node >> participant "Query API" as c_query << Coordinating Node >> c_query -> m_crud: getLogRecords (nodeID, fromDate, toDate) note right Assume Member Node has authority for accessing Coordinating Node log records. end note c_query <-- m_crud: records or fail note right Can the Query API handle queries on log records or should this be handled by another API? (e.g. "Report API"?) end note @endumlr^…r_}r`(hUhjWubaubcdocutils.nodes image ra)rb}rc(hX.. image:: images/18_seq.png hh+hhhUimagerdh }re(UuriX!design/UseCases/images/18_seq.pngrfh"]h#]h$]h%]U candidatesrg}rhU*jfsh&]uh(K9h)hh]ubhp)ri}rj(hX)*Figure 1.* Interactions for use case 18.rkhh+hhhhsh }rl(h$]h%]h#]h"]h&]uh(K:h)hh]rm(cdocutils.nodes emphasis rn)ro}rp(hX *Figure 1.*h }rq(h$]h%]h#]h"]h&]uhjih]rrh=X Figure 1.rs…rt}ru(hUhjoubahUemphasisrvubh=X Interactions for use case 18.rw…rx}ry(hX Interactions for use case 18.hjiubeubhp)rz}r{(hX **Notes**r|hh+hhhhsh }r}(h$]h%]h#]h"]h&]uh(K=h)hh]r~cdocutils.nodes strong r)r€}r(hj|h }r‚(h$]h%]h#]h"]h&]uhjzh]rƒh=XNotesr„…r…}r†(hUhj€ubahUstrongr‡ubaubhp)rˆ}r‰(hXvThis operation should really be a function for the administrative functions of the Investigator Toolkit. It is reasonable to expect that (especially for the first iteration of the infrastructure) MN administrators will want to peruse and evaluate the log data. In later stages, this information could be associated with content, so use statistics appear with search results.rŠhh+hhhhsh }r‹(h$]h%]h#]h"]h&]uh(K?h)hh]rŒh=XvThis operation should really be a function for the administrative functions of the Investigator Toolkit. It is reasonable to expect that (especially for the first iteration of the infrastructure) MN administrators will want to peruse and evaluate the log data. In later stages, this information could be associated with content, so use statistics appear with search results.r…rŽ}r(hjŠhjˆubaubh)r}r‘(hX¡.. _history: https://redmine.dataone.org/projects/d1/repository/changes/documents/Projects/cicore/architecture/api-documentation/source/design/UseCases/18_uc.txtU referencedr’Khh+hhhhh }r“(h€hh"]r”hah#]h$]h%]h&]r•hauh(KFh)hh]ubeubehUU transformerr–NU footnote_refsr—}r˜Urefnamesr™}ršh]r›hzasUsymbol_footnotesrœ]rUautofootnote_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 "uc18" 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Â]rÃU citation_refsrÄ}rÅUindirect_targetsrÆ]rÇUsettingsrÈ(cdocutils.frontend Values rÉorÊ}rË(Ufootnote_backlinksrÌKUrecord_dependenciesrÍNU rfc_base_urlrÎUhttps://tools.ietf.org/html/rÏU tracebackrЈUpep_referencesrÑNUstrip_commentsrÒNU toc_backlinksrÓUentryrÔU language_coderÕUenrÖU datestampr×NU report_levelrØKU _destinationrÙNU halt_levelrÚKU strip_classesrÛNh:NUerror_encoding_error_handlerrÜUbackslashreplacerÝUdebugrÞNUembed_stylesheetr߉Uoutput_encoding_error_handlerràUstrictráU 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_referencesròNUoutput_encodingróUutf-8rôU source_urlrõNUinput_encodingröU utf-8-sigr÷U_disable_configrøNU id_prefixrùUU tab_widthrúKUerror_encodingrûUUTF-8rüU_sourcerýhUgettext_compactrþˆU generatorrÿNUdump_internalsrNU smart_quotesr‰U pep_base_urlrU https://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjáUauto_id_prefixrUidrUdoctitle_xformr ‰Ustrip_elements_with_classesr NU _config_filesr ]Ufile_insertion_enabledr ˆU raw_enabledr KU dump_settingsrNubUsymbol_footnote_startrKUidsr}r(hIhThh+hh+hjuUsubstitution_namesr}rhh)h }r(h$]h"]h#]Usourcehh%]h&]uU footnotesr]rUrefidsr}r(h]rhahI]rhPauub.