€cdocutils.nodes document q)q}q(U nametypesq}q(Xuc22qˆX,use case 22 - link/citation report for ownerqNXhistoryqˆuUsubstitution_defsq }q Uparse_messagesq ]q Ucurrent_sourceq NU decorationqNUautofootnote_startqKUnameidsq}q(hUuc22qhU*use-case-22-link-citation-report-for-ownerqhUhistoryquUchildrenq]q(cdocutils.nodes target q)q}q(U rawsourceqX .. _UC22:UparentqhUsourceqXj/var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/UseCases/22_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 22 - Link/Citation Report for Ownerq9hh+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 22Uindex-0qIUNtqJ(hHXUC22hIUNtqK(hHXreporthIUNtqL(hHXcitationhIUNtqM(hHXobject reference reporthIUNtqNeUinlineqO‰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/22_uc.txtqh"]h#]h$]h%]h&]uh]q‚h=Xhistoryqƒ…q„}q…(hUhhzubaubh=X.…q†}q‡(hX.hhqubeubahU definitionqˆubeubh[)q‰}qŠ(hXlGoal User can get report of links and citations to objects they own (also can view this as a referrer log). 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š(hXfUser can get report of links and citations to objects they own (also can view this as a referrer log).q›hh•hhhhsh }qœ(h$]h%]h#]h"]h&]uh(K h]qh=XfUser can get report of links and citations to objects they own (also can view this as a referrer log).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°(hXVA data owner would benefit from having a report that indicated the connections to objects they own. Within DataONE, this could be handled by examining the object associations contained in the system metadata. For external references to content, DataONE could provide summaries generated from log reports, though with much greater uncertainty.q±hhªhhhhsh }q²(h$]h%]h#]h"]h&]uh(Kh]q³h=XVA data owner would benefit from having a report that indicated the connections to objects they own. Within DataONE, this could be handled by examining the object associations contained in the system metadata. For external references to content, DataONE could provide summaries generated from log reports, though with much greater uncertainty.q´…qµ}q¶(hh±hh¯ubaubaubhS)q·}q¸(hUhh+hNhhVh }q¹(h$]h%]h#]h"]h&]uh(Nh)hh]qº(h[)q»}q¼(hXGActors - Data owner - Data referrer - Member Nodes - Coordinating Node hh·hhhh^h }q½(h$]h%]h#]h"]h&]uh(Kh]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Ó(hX Data ownerqÔh }qÕ(h$]h%]h#]h"]h&]uhhÌh]qÖhp)q×}qØ(hhÔhhÒhhhhsh }qÙ(h$]h%]h#]h"]h&]uh(Kh]qÚh=X Data ownerqÛ…qÜ}qÝ(hhÔhh×ubaubahU list_itemqÞubhÑ)qß}qà(hX Data referrerqáh }qâ(h$]h%]h#]h"]h&]uhhÌh]qãhp)qä}qå(hháhhßhhhhsh }qæ(h$]h%]h#]h"]h&]uh(Kh]qçh=X Data referrerqè…qé}qê(hháhhäubaubahhÞubhÑ)që}qì(hX Member Nodesqíh }qî(h$]h%]h#]h"]h&]uhhÌh]qïhp)qð}qñ(hhíhhëhhhhsh }qò(h$]h%]h#]h"]h&]uh(Kh]qóh=X Member Nodesqô…qõ}qö(hhíhhðubaubahhÞubhÑ)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 Noder…r}r(hhýhhûubaubahhÞubehU bullet_listrubahhˆubeubh[)r}r(hXzPreconditions - Owner has content in DataONE - References to content appear directly in system metadata or in access logs hh·hhhh^h }r(h$]h%]h#]h"]h&]uh(Kh)hh]r(ha)r}r (hX Preconditionsr hjhhhheh }r (h$]h%]h#]h"]h&]uh(Kh]r h=X Preconditionsr …r}r(hj hjubaubhk)r}r(hUh }r(h$]h%]h#]h"]h&]uhjh]rhË)r}r(hUh }r(hÏX-h"]h#]h$]h%]h&]uhjh]r(hÑ)r}r(hXOwner has content in DataONErh }r(h$]h%]h#]h"]h&]uhjh]rhp)r}r(hjhjhhhhsh }r(h$]h%]h#]h"]h&]uh(Kh]r h=XOwner has content in DataONEr!…r"}r#(hjhjubaubahhÞubhÑ)r$}r%(hXKReferences to content appear directly in system metadata or in access logs h }r&(h$]h%]h#]h"]h&]uhjh]r'hp)r(}r)(hXJReferences to content appear directly in system metadata or in access logsr*hj$hhhhsh }r+(h$]h%]h#]h"]h&]uh(Kh]r,h=XJReferences to content appear directly in system metadata or in access logsr-…r.}r/(hj*hj(ubaubahhÞubehjubahhˆubeubh[)r0}r1(hXrTriggers - Owner requests report for content citations and references - Scheduled report generated for data owner hh·hhhh^h }r2(h$]h%]h#]h"]h&]uh(K#h)hh]r3(ha)r4}r5(hXTriggersr6hj0hhhheh }r7(h$]h%]h#]h"]h&]uh(K#h]r8h=XTriggersr9…r:}r;(hj6hj4ubaubhk)r<}r=(hUh }r>(h$]h%]h#]h"]h&]uhj0h]r?hË)r@}rA(hUh }rB(hÏX-h"]h#]h$]h%]h&]uhj<h]rC(hÑ)rD}rE(hX:Owner requests report for content citations and referencesrFh }rG(h$]h%]h#]h"]h&]uhj@h]rHhp)rI}rJ(hjFhjDhhhhsh }rK(h$]h%]h#]h"]h&]uh(K"h]rLh=X:Owner requests report for content citations and referencesrM…rN}rO(hjFhjIubaubahhÞubhÑ)rP}rQ(hX*Scheduled report generated for data owner h }rR(h$]h%]h#]h"]h&]uhj@h]rShp)rT}rU(hX)Scheduled report generated for data ownerrVhjPhhhhsh }rW(h$]h%]h#]h"]h&]uh(K#h]rXh=X)Scheduled report generated for data ownerrY…rZ}r[(hjVhjTubaubahhÞubehjubahhˆubeubh[)r\}r](hX–Post Conditions - Owner has a report on citations and references to their data - System state is updated to enable reporting for the next time period hh·hhhh^h }r^(h$]h%]h#]h"]h&]uh(K'h)hh]r_(ha)r`}ra(hXPost Conditionsrbhj\hhhheh }rc(h$]h%]h#]h"]h&]uh(K'h]rdh=XPost Conditionsre…rf}rg(hjbhj`ubaubhk)rh}ri(hUh }rj(h$]h%]h#]h"]h&]uhj\h]rkhË)rl}rm(hUh }rn(hÏX-h"]h#]h$]h%]h&]uhjhh]ro(hÑ)rp}rq(hX<Owner has a report on citations and references to their datarrh }rs(h$]h%]h#]h"]h&]uhjlh]rthp)ru}rv(hjrhjphhhhsh }rw(h$]h%]h#]h"]h&]uh(K&h]rxh=X<Owner has a report on citations and references to their datary…rz}r{(hjrhjuubaubahhÞubhÑ)r|}r}(hXESystem state is updated to enable reporting for the next time period h }r~(h$]h%]h#]h"]h&]uhjlh]rhp)r€}r(hXDSystem state is updated to enable reporting for the next time periodr‚hj|hhhhsh }rƒ(h$]h%]h#]h"]h&]uh(K'h]r„h=XDSystem state is updated to enable reporting for the next time periodr……r†}r‡(hj‚hj€ubaubahhÞubehjubahhˆubeubeubcdocutils.nodes comment rˆ)r‰}rŠ(hXy@startuml images/22_seq.png actor "User (Data Owner)" as user participant "Client" as app_client << Application >> user -> app_client participant "Authentication API" as c_authenticate << Coordinating Node >> app_client -> c_authenticate: login (user, pw) app_client <-- c_authenticate: token or failure participant "Query API" as c_query << Coordinating Node >> app_client -> c_query: getLinksAndCites (PID, fromDate, toDate) participant "Authorization API" as c_authorize << Coordinating Node >> c_query -> c_authorize: isAuth (token, resultset) participant "Verify API" as c_ver << Coordinating Node >> c_authorize -> c_ver: isValidToken (token) c_authorize <-- c_ver: T or F c_query <-- c_authorize: T or F app_client <-- c_query: 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+hhhUcommentr‹h }rŒ(U xml:spacerUpreserverŽh"]h#]h$]h%]h&]uh(KAh)hh]rh=Xy@startuml images/22_seq.png actor "User (Data Owner)" as user participant "Client" as app_client << Application >> user -> app_client participant "Authentication API" as c_authenticate << Coordinating Node >> app_client -> c_authenticate: login (user, pw) app_client <-- c_authenticate: token or failure participant "Query API" as c_query << Coordinating Node >> app_client -> c_query: getLinksAndCites (PID, fromDate, toDate) participant "Authorization API" as c_authorize << Coordinating Node >> c_query -> c_authorize: isAuth (token, resultset) participant "Verify API" as c_ver << Coordinating Node >> c_authorize -> c_ver: isValidToken (token) c_authorize <-- c_ver: T or F c_query <-- c_authorize: T or F app_client <-- c_query: 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’(hUhj‰ubaubcdocutils.nodes image r“)r”}r•(hX.. image:: images/22_seq.png hh+hhhUimager–h }r—(UuriX!design/UseCases/images/22_seq.pngr˜h"]h#]h$]h%]U candidatesr™}ršU*j˜sh&]uh(KCh)hh]ubhp)r›}rœ(hX|*Figure 1.* Interactions for use case 22, User can get report of links, cites my data (also can view this as a referrer log)hh+hhhhsh }r(h$]h%]h#]h"]h&]uh(KDh)hh]rž(cdocutils.nodes emphasis rŸ)r }r¡(hX *Figure 1.*h }r¢(h$]h%]h#]h"]h&]uhj›h]r£h=X Figure 1.r¤…r¥}r¦(hUhj ubahUemphasisr§ubh=Xq Interactions for use case 22, User can get report of links, cites my data (also can view this as a referrer log)r¨…r©}rª(hXq Interactions for use case 22, User can get report of links, cites my data (also can view this as a referrer log)hj›ubeubh)r«}r¬(hX¡.. _history: https://redmine.dataone.org/projects/d1/repository/changes/documents/Projects/cicore/architecture/api-documentation/source/design/UseCases/22_uc.txtU referencedr­Khh+hhhhh }r®(h€hh"]r¯hah#]h$]h%]h&]r°hauh(KGh)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 "uc22" 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_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrˆUtrim_footnote_reference_spacer‰UenvrNUdump_pseudo_xmlr NUexpose_internalsr NUsectsubtitle_xformr ‰U source_linkr NUrfc_referencesr NUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrUUTF-8rU_sourcerhUgettext_compactrˆU generatorrNUdump_internalsrNU smart_quotesr‰U pep_base_urlrU https://www.python.org/dev/peps/rUsyntax_highlightrUlongr Uinput_encoding_error_handlerr!jüUauto_id_prefixr"Uidr#Udoctitle_xformr$‰Ustrip_elements_with_classesr%NU _config_filesr&]Ufile_insertion_enabledr'ˆU raw_enabledr(KU dump_settingsr)NubUsymbol_footnote_startr*KUidsr+}r,(hIhThj«hh+hh+uUsubstitution_namesr-}r.hh)h }r/(h$]h"]h#]Usourcehh%]h&]uU footnotesr0]r1Urefidsr2}r3(hI]r4hPah]r5hauub.