cdocutils.nodes document q)q}q(U nametypesq}q(Xusing the registryqNXsearching metacatqNXsupported actionsqNXcreating your own clientq NXinstalling the registryq NX%using html forms (the http interface)q NXcustomizing the registryq NX%using the earthgrid api (aka ecogrid)q NXldap account managementqNX,a brief note about how information is storedqNXjavadocqX8inserting, updating, and deleting xml and data documentsqNX*accessing and submitting metadata and dataqNX logging inqNX using morphoqNXpaged query returnsqNXreading data and metadataqNXcontentsqNuUsubstitution_defsq}qUparse_messagesq]q(cdocutils.nodes system_message q)q}q(U rawsourceqUUparentq cdocutils.nodes section q!)q"}q#(hUh h!)q$}q%(hUh h!)q&}q'(hUh hUsourceq(XX/var/lib/jenkins/jobs/metacat-unstable/workspace/docs/user/metacat/source/submitting.rstq)Utagnameq*Usectionq+U attributesq,}q-(Udupnamesq.]Uclassesq/]Ubackrefsq0]Uidsq1]q2U*accessing-and-submitting-metadata-and-dataq3aUnamesq4]q5hauUlineq6KUdocumentq7hUchildrenq8]q9(cdocutils.nodes title q:)q;}q<(hX*Accessing and Submitting Metadata and Dataq=h h&h(h)h*Utitleq>h,}q?(h1]h0]h.]h/]h4]Urefidq@Uid10qAuh6Kh7hh8]qBcdocutils.nodes Text qCX*Accessing and Submitting Metadata and DataqDqE}qF(hh=h h;ubaubcdocutils.nodes topic qG)qH}qI(hUh h&h(h)h*UtopicqJh,}qK(h.]h/]qLUcontentsqMah0]h1]qNUcontentsqOah4]qPhauh6Kh7hh8]qQ(h:)qR}qS(hXContentsh hHh(h)h*h>h,}qT(h.]h/]h0]h1]h4]uh6Kh8]qUhCXContentsqVqW}qX(hUh hRubaubcdocutils.nodes bullet_list qY)qZ}q[(hUh hHh(Nh*U bullet_listq\h,}q](h.]h/]h0]h1]h4]uh6Nh7hh8]q^cdocutils.nodes list_item q_)q`}qa(hUh,}qb(h.]h/]h0]h1]h4]uh hZh8]qc(cdocutils.nodes paragraph qd)qe}qf(hUh,}qg(h.]h/]h0]h1]h4]uh h`h8]qhcdocutils.nodes reference qi)qj}qk(hUh,}ql(h1]qmhAah0]h.]h/]h4]Urefidh3uh heh8]qnhCX*Accessing and Submitting Metadata and Dataqoqp}qq(hh=h hjubah*U referenceqrubah*U paragraphqsubhY)qt}qu(hUh,}qv(h.]h/]h0]h1]h4]uh h`h8]qw(h_)qx}qy(hUh,}qz(h.]h/]h0]h1]h4]uh hth8]q{hd)q|}q}(hUh,}q~(h.]h/]h0]h1]h4]uh hxh8]qhi)q}q(hUh,}q(h1]qUid11qah0]h.]h/]h4]UrefidU,a-brief-note-about-how-information-is-storedquh h|h8]qhCX,A Brief Note about How Information is Storedqq}q(hX,A Brief Note about How Information is Storedqh hubah*hrubah*hsubah*U list_itemqubh_)q}q(hUh,}q(h.]h/]h0]h1]h4]uh hth8]q(hd)q}q(hUh,}q(h.]h/]h0]h1]h4]uh hh8]qhi)q}q(hUh,}q(h1]qUid12qah0]h.]h/]h4]UrefidUusing-the-registryquh hh8]qhCXUsing the Registryqq}q(hXUsing the Registryqh hubah*hrubah*hsubhY)q}q(hUh,}q(h.]h/]h0]h1]h4]uh hh8]q(h_)q}q(hUh,}q(h.]h/]h0]h1]h4]uh hh8]qhd)q}q(hUh,}q(h.]h/]h0]h1]h4]uh hh8]qhi)q}q(hUh,}q(h1]qUid13qah0]h.]h/]h4]UrefidUinstalling-the-registryquh hh8]qhCXInstalling the Registryqq}q(hXInstalling the Registryqh hubah*hrubah*hsubah*hubh_)q}q(hUh,}q(h.]h/]h0]h1]h4]uh hh8]qhd)q}q(hUh,}q(h.]h/]h0]h1]h4]uh hh8]qhi)q}q(hUh,}q(h1]qUid14qah0]h.]h/]h4]UrefidUcustomizing-the-registryquh hh8]qhCXCustomizing the RegistryqŅq}q(hXCustomizing the Registryqh hubah*hrubah*hsubah*hubh_)q}q(hUh,}q(h.]h/]h0]h1]h4]uh hh8]qhd)q}q(hUh,}q(h.]h/]h0]h1]h4]uh hh8]qhi)q}q(hUh,}q(h1]qUid15qah0]h.]h/]h4]UrefidUldap-account-managementquh hh8]qhCXLDAP account managementq؅q}q(hXLDAP account managementqh hubah*hrubah*hsubah*hubeh*h\ubeh*hubh_)q}q(hUh,}q(h.]h/]h0]h1]h4]uh hth8]q(hd)q}q(hUh,}q(h.]h/]h0]h1]h4]uh hh8]qhi)q}q(hUh,}q(h1]qUid16qah0]h.]h/]h4]UrefidU#using-html-forms-the-http-interfacequh hh8]qhCX%Using HTML Forms (the HTTP Interface)q녁q}q(hX%Using HTML Forms (the HTTP Interface)qh hubah*hrubah*hsubhY)q}q(hUh,}q(h.]h/]h0]h1]h4]uh hh8]q(h_)q}q(hUh,}q(h.]h/]h0]h1]h4]uh hh8]qhd)q}q(hUh,}q(h.]h/]h0]h1]h4]uh hh8]qhi)q}q(hUh,}q(h1]qUid17qah0]h.]h/]h4]UrefidUsupported-actionsruh hh8]rhCXSupported Actionsrr}r(hXSupported Actionsrh hubah*hrubah*hsubah*hubh_)r}r(hUh,}r(h.]h/]h0]h1]h4]uh hh8]r hd)r }r (hUh,}r (h.]h/]h0]h1]h4]uh jh8]r hi)r}r(hUh,}r(h1]rUid18rah0]h.]h/]h4]UrefidU logging-inruh j h8]rhCX Logging Inrr}r(hX Logging Inrh jubah*hrubah*hsubah*hubh_)r}r(hUh,}r(h.]h/]h0]h1]h4]uh hh8]rhd)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r hi)r!}r"(hUh,}r#(h1]r$Uid19r%ah0]h.]h/]h4]UrefidU6inserting-updating-and-deleting-xml-and-data-documentsr&uh jh8]r'hCX8Inserting, Updating, and Deleting XML and Data Documentsr(r)}r*(hX8Inserting, Updating, and Deleting XML and Data Documentsr+h j!ubah*hrubah*hsubah*hubh_)r,}r-(hUh,}r.(h.]h/]h0]h1]h4]uh hh8]r/hd)r0}r1(hUh,}r2(h.]h/]h0]h1]h4]uh j,h8]r3hi)r4}r5(hUh,}r6(h1]r7Uid20r8ah0]h.]h/]h4]UrefidUsearching-metacatr9uh j0h8]r:hCXSearching Metacatr;r<}r=(hXSearching Metacatr>h j4ubah*hrubah*hsubah*hubh_)r?}r@(hUh,}rA(h.]h/]h0]h1]h4]uh hh8]rBhd)rC}rD(hUh,}rE(h.]h/]h0]h1]h4]uh j?h8]rFhi)rG}rH(hUh,}rI(h1]rJUid21rKah0]h.]h/]h4]UrefidUpaged-query-returnsrLuh jCh8]rMhCXPaged Query ReturnsrNrO}rP(hXPaged Query ReturnsrQh jGubah*hrubah*hsubah*hubh_)rR}rS(hUh,}rT(h.]h/]h0]h1]h4]uh hh8]rUhd)rV}rW(hUh,}rX(h.]h/]h0]h1]h4]uh jRh8]rYhi)rZ}r[(hUh,}r\(h1]r]Uid22r^ah0]h.]h/]h4]UrefidUreading-data-and-metadatar_uh jVh8]r`hCXReading Data and Metadatararb}rc(hXReading Data and Metadatardh jZubah*hrubah*hsubah*hubeh*h\ubeh*hubh_)re}rf(hUh,}rg(h.]h/]h0]h1]h4]uh hth8]rhhd)ri}rj(hUh,}rk(h.]h/]h0]h1]h4]uh jeh8]rlhi)rm}rn(hUh,}ro(h1]rpUid23rqah0]h.]h/]h4]UrefidU#using-the-earthgrid-api-aka-ecogridrruh jih8]rshCX%Using the EarthGrid API (aka EcoGrid)rtru}rv(hX%Using the EarthGrid API (aka EcoGrid)rwh jmubah*hrubah*hsubah*hubh_)rx}ry(hUh,}rz(h.]h/]h0]h1]h4]uh hth8]r{hd)r|}r}(hUh,}r~(h.]h/]h0]h1]h4]uh jxh8]rhi)r}r(hUh,}r(h1]rUid24rah0]h.]h/]h4]UrefidU using-morphoruh j|h8]rhCX Using Morphorr}r(hX Using Morphorh jubah*hrubah*hsubah*hubh_)r}r(hUh,}r(h.]h/]h0]h1]h4]uh hth8]rhd)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhi)r}r(hUh,}r(h1]rUid25rah0]h.]h/]h4]UrefidUcreating-your-own-clientruh jh8]rhCXCreating Your Own Clientrr}r(hXCreating Your Own Clientrh jubah*hrubah*hsubah*hubeh*h\ubeh*hubaubeubhd)r}r(hXVThe Metacat repository can be accessed and updated using a number of tools, including:rh h&h(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh7hh8]rhCXVThe Metacat repository can be accessed and updated using a number of tools, including:rr}r(hjh jubaubhY)r}r(hUh h&h(h)h*h\h,}r(UbulletrX*h1]h0]h.]h/]h4]uh6K h7hh8]r(h_)r}r(hX.the Registry, Metacat's optional Web interfacerh jh(h)h*hh,}r(h.]h/]h0]h1]h4]uh6Nh7hh8]rhd)r}r(hjh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6K h8]rhCX.the Registry, Metacat's optional Web interfacerr}r(hjh jubaubaubh_)r}r(hXuser-created HTML formsrh jh(h)h*hh,}r(h.]h/]h0]h1]h4]uh6Nh7hh8]rhd)r}r(hjh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6K h8]rhCXuser-created HTML formsrr}r(hjh jubaubaubh_)r}r(hXMetacat's EarthGrid APIrh jh(h)h*hh,}r(h.]h/]h0]h1]h4]uh6Nh7hh8]rhd)r}r(hjh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6K h8]rhCXMetacat's EarthGrid APIrr}r(hjh jubaubaubh_)r}r(hXqexisting clients, such as KNB's Morpho application, designed to help scientists create, edit, and manage metadatah jh(h)h*hh,}r(h.]h/]h0]h1]h4]uh6Nh7hh8]rhd)r}r(hXqexisting clients, such as KNB's Morpho application, designed to help scientists create, edit, and manage metadatarh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6K h8]rhCXqexisting clients, such as KNB's Morpho application, designed to help scientists create, edit, and manage metadatarr}r(hjh jubaubaubh_)r}r(hXHuser-created desktop clients that take advantage of Metacat's Java API. h jh(h)h*hh,}r(h.]h/]h0]h1]h4]uh6Nh7hh8]rhd)r}r(hXGuser-created desktop clients that take advantage of Metacat's Java API.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh8]rhCXGuser-created desktop clients that take advantage of Metacat's Java API.rr}r(hjh jubaubaubeubhd)r}r(hXnIn this section, we will look at how to take advantage of these tools to customize Metacat for your user-base.rh h&h(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh7hh8]rhCXnIn this section, we will look at how to take advantage of these tools to customize Metacat for your user-base.rr}r(hjh jubaubh!)r}r(hUh h&h(h)h*h+h,}r(h.]h/]h0]h1]rhah4]rhauh6Kh7hh8]r(h:)r}r(hhh jh(h)h*h>h,}r(h1]h0]h.]h/]h4]h@huh6Kh7hh8]rhCX,A Brief Note about How Information is Storedrr}r(hhh jubaubhd)r}r(hXMetacat stores XML files as a hierarchy of nodes, where each node is stored as records in database tables. Because many XML data schemas are broken up into multiple DTDs requiring multiple XML files that are related but stored separately in the system, the system uses "packages" to link related but separate documents. Packaged documents contain information that shows how they are related to eachother, essentially stating that file A has a relationship to file B, etc. A package file also allows users to link metadata files to the data files they describe. For more information about the structure of data packages and how XML documents and data are stored in Metacat, please see the developer's documentation.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh7hh8]rhCXMetacat stores XML files as a hierarchy of nodes, where each node is stored as records in database tables. Because many XML data schemas are broken up into multiple DTDs requiring multiple XML files that are related but stored separately in the system, the system uses "packages" to link related but separate documents. Packaged documents contain information that shows how they are related to eachother, essentially stating that file A has a relationship to file B, etc. A package file also allows users to link metadata files to the data files they describe. For more information about the structure of data packages and how XML documents and data are stored in Metacat, please see the developer's documentation.rr}r(hjh jubaubeubh$h!)r}r(hUh h&h(h)h*h+h,}r(h.]h/]h0]h1]rhah4]rh auh6Kh7hh8]r (h:)r }r (hhh jh(h)h*h>h,}r (h1]h0]h.]h/]h4]h@huh6Kh7hh8]r hCX%Using HTML Forms (the HTTP Interface)rr}r(hhh j ubaubhd)r}r(hXMetacat's HTTP interface supports Get and Post requests and a variety of actions (Table 4.1) that facilitate information retrieval and storage. HTTP requests can be sent from any client application that communicates using the Web's HTTP protocol.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh7hh8]rhCXMetacat's HTTP interface supports Get and Post requests and a variety of actions (Table 4.1) that facilitate information retrieval and storage. HTTP requests can be sent from any client application that communicates using the Web's HTTP protocol.rr}r(hjh jubaubhY)r}r(hUh jh(h)h*h\h,}r(jX*h1]h0]h.]h/]h4]uh6Kh7hh8]r(h_)r}r(hXSupported Actions (API)rh jh(h)h*hh,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r!hd)r"}r#(hjh jh(h)h*hsh,}r$(h.]h/]h0]h1]h4]uh6Kh8]r%hCXSupported Actions (API)r&r'}r((hjh j"ubaubaubh_)r)}r*(hX Logging inr+h jh(h)h*hh,}r,(h.]h/]h0]h1]h4]uh6Nh7hh8]r-hd)r.}r/(hj+h j)h(h)h*hsh,}r0(h.]h/]h0]h1]h4]uh6Kh8]r1hCX Logging inr2r3}r4(hj+h j.ubaubaubh_)r5}r6(hX8Inserting, Updating, and Deleting XML and Data Documentsr7h jh(h)h*hh,}r8(h.]h/]h0]h1]h4]uh6Nh7hh8]r9hd)r:}r;(hj7h j5h(h)h*hsh,}r<(h.]h/]h0]h1]h4]uh6Kh8]r=hCX8Inserting, Updating, and Deleting XML and Data Documentsr>r?}r@(hj7h j:ubaubaubh_)rA}rB(hXSearching MetacatrCh jh(h)h*hh,}rD(h.]h/]h0]h1]h4]uh6Nh7hh8]rEhd)rF}rG(hjCh jAh(h)h*hsh,}rH(h.]h/]h0]h1]h4]uh6Kh8]rIhCXSearching MetacatrJrK}rL(hjCh jFubaubaubh_)rM}rN(hXPaged Query ReturnrOh jh(h)h*hh,}rP(h.]h/]h0]h1]h4]uh6Nh7hh8]rQhd)rR}rS(hjOh jMh(h)h*hsh,}rT(h.]h/]h0]h1]h4]uh6Kh8]rUhCXPaged Query ReturnrVrW}rX(hjOh jRubaubaubh_)rY}rZ(hXReading Data and Metadata h jh(h)h*hh,}r[(h.]h/]h0]h1]h4]uh6Nh7hh8]r\hd)r]}r^(hXReading Data and Metadatar_h jYh(h)h*hsh,}r`(h.]h/]h0]h1]h4]uh6Kh8]rahCXReading Data and Metadatarbrc}rd(hj_h j]ubaubaubeubh!)re}rf(hUh jh(h)h*h+h,}rg(h.]h/]h0]h1]rhjah4]rihauh6Kh7hh8]rj(h:)rk}rl(hjh jeh(h)h*h>h,}rm(h1]h0]h.]h/]h4]h@huh6Kh7hh8]rnhCXSupported Actionsrorp}rq(hjh jkubaubhd)rr}rs(hXMetacat supports get and post requests as well as actions for writing, querying, and reading stored XML. In addition, the HTTP interface includes functions for validating and transforming XML documents (see table).rth jeh(h)h*hsh,}ru(h.]h/]h0]h1]h4]uh6Kh7hh8]rvhCXMetacat supports get and post requests as well as actions for writing, querying, and reading stored XML. In addition, the HTTP interface includes functions for validating and transforming XML documents (see table).rwrx}ry(hjth jrubaubhd)rz}r{(hXNote that if Replication is enabled, Metacat recognizes several additional actions, included in Table 4.2. For more information about replication, please see :doc:`replication`.h jeh(h)h*hsh,}r|(h.]h/]h0]h1]h4]uh6Kh7hh8]r}(hCXNote that if Replication is enabled, Metacat recognizes several additional actions, included in Table 4.2. For more information about replication, please see r~r}r(hXNote that if Replication is enabled, Metacat recognizes several additional actions, included in Table 4.2. For more information about replication, please see h jzubcsphinx.addnodes pending_xref r)r}r(hX:doc:`replication`rh jzh(h)h*U pending_xrefrh,}r(UreftypeXdocrUrefwarnrU reftargetrX replicationU refdomainUh1]h0]U refexplicith.]h/]h4]UrefdocrX submittingruh6Kh8]rcdocutils.nodes literal r)r}r(hjh,}r(h.]h/]r(Uxrefrjeh0]h1]h4]uh jh8]rhCX replicationrr}r(hUh jubah*UliteralrubaubhCX.r}r(hX.h jzubeubcdocutils.nodes table r)r}r(hUh jeh(h)h*Utablerh,}r(h.]h/]h0]h1]h4]uh6Nh7hh8]rcdocutils.nodes tgroup r)r}r(hUh,}r(h1]h0]h.]h/]h4]UcolsKuh jh8]r(cdocutils.nodes colspec r)r}r(hUh,}r(h1]h0]h.]h/]h4]UcolwidthKuh jh8]h*Ucolspecrubj)r}r(hUh,}r(h1]h0]h.]h/]h4]UcolwidthMuh jh8]h*jubcdocutils.nodes thead r)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rcdocutils.nodes row r)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(cdocutils.nodes entry r)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXActionrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh8]rhCXActionrr}r(hjh jubaubah*Uentryrubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXDescription and Parametersrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh8]rhCXDescription and Parametersrr}r(hjh jubaubah*jubeh*Urowrubah*Utheadrubcdocutils.nodes tbody r)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXdeleterh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh8]rhCXdeleterr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hXDelete the specified document from the database. For an example, please see Inserting, Updating, and Deleting XML and Data Documents.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh8]rhCXDelete the specified document from the database. For an example, please see Inserting, Updating, and Deleting XML and Data Documents.rr}r(hjh jubaubhd)r}r(hX/``docid`` - the docid of the document to deleteh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh8]r(j)r}r(hX ``docid``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXdocidrr}r(hUh jubah*jubhCX& - the docid of the document to deleterr}r(hX& - the docid of the document to deleteh jubeubeh*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r hd)r }r (hXexportr h jh(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh8]rhCXexportrr}r(hj h j ubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hX$Export a data package in a zip file.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh8]rhCX$Export a data package in a zip file.rr}r(hjh jubaubhd)r}r(hX/``docid`` - the docid of the document to deleteh jh(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh8]r!(j)r"}r#(hX ``docid``h,}r$(h.]h/]h0]h1]h4]uh jh8]r%hCXdocidr&r'}r((hUh j"ubah*jubhCX& - the docid of the document to deleter)r*}r+(hX& - the docid of the document to deleteh jubeubeh*jubeh*jubj)r,}r-(hUh,}r.(h.]h/]h0]h1]h4]uh jh8]r/(j)r0}r1(hUh,}r2(h.]h/]h0]h1]h4]uh j,h8]r3hd)r4}r5(hXgetaccesscontrolr6h j0h(h)h*hsh,}r7(h.]h/]h0]h1]h4]uh6Kh8]r8hCXgetaccesscontrolr9r:}r;(hj6h j4ubaubah*jubj)r<}r=(hUh,}r>(h.]h/]h0]h1]h4]uh j,h8]r?(hd)r@}rA(hX=Get the access control list (ACL) for the specified document.rBh j<h(h)h*hsh,}rC(h.]h/]h0]h1]h4]uh6Kh8]rDhCX=Get the access control list (ACL) for the specified document.rErF}rG(hjBh j@ubaubhd)rH}rI(hX/``docid`` - the docid of the document to deleteh j<h(h)h*hsh,}rJ(h.]h/]h0]h1]h4]uh6Kh8]rK(j)rL}rM(hX ``docid``h,}rN(h.]h/]h0]h1]h4]uh jHh8]rOhCXdocidrPrQ}rR(hUh jLubah*jubhCX& - the docid of the document to deleterSrT}rU(hX& - the docid of the document to deleteh jHubeubeh*jubeh*jubj)rV}rW(hUh,}rX(h.]h/]h0]h1]h4]uh jh8]rY(j)rZ}r[(hUh,}r\(h.]h/]h0]h1]h4]uh jVh8]r]hd)r^}r_(hX getalldocidsr`h jZh(h)h*hsh,}ra(h.]h/]h0]h1]h4]uh6Mh8]rbhCX getalldocidsrcrd}re(hj`h j^ubaubah*jubj)rf}rg(hUh,}rh(h.]h/]h0]h1]h4]uh jVh8]ri(hd)rj}rk(hX9Retrieve a list of all docids registered with the system.rlh jfh(h)h*hsh,}rm(h.]h/]h0]h1]h4]uh6Mh8]rnhCX9Retrieve a list of all docids registered with the system.rorp}rq(hjlh jjubaubhd)rr}rs(hXL``scope`` - a string used to match a range of docids in a SQL LIKE statementh jfh(h)h*hsh,}rt(h.]h/]h0]h1]h4]uh6Mh8]ru(j)rv}rw(hX ``scope``h,}rx(h.]h/]h0]h1]h4]uh jrh8]ryhCXscoperzr{}r|(hUh jvubah*jubhCXC - a string used to match a range of docids in a SQL LIKE statementr}r~}r(hXC - a string used to match a range of docids in a SQL LIKE statementh jrubeubeh*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX0getdataguide DEPRECATED Use getdtdschema insteadrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX0getdataguide DEPRECATED Use getdtdschema insteadrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hX1Read a data guide for the specified document typerh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX1Read a data guide for the specified document typerr}r(hjh jubaubhd)r}r(hX9``doctype`` - the doctype for which to get the data guideh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]r(j)r}r(hX ``doctype``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXdoctyperr}r(hUh jubah*jubhCX. - the doctype for which to get the data guiderr}r(hX. - the doctype for which to get the data guideh jubeubeh*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX getdoctypesrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M h8]rhCX getdoctypesrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXRGet all doctypes currently available in the Metacat Catalog System. No parameters.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M h8]rhCXRGet all doctypes currently available in the Metacat Catalog System. No parameters.rr}r(hjh jubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX getdtdschemarh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M h8]rhCX getdtdschemarr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hX9Read the DTD or XMLSchema file for the specified doctype.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M h8]rhCX9Read the DTD or XMLSchema file for the specified doctype.rr}r(hjh jubaubhd)r}r(hXB``doctype`` - the doctype for which DTD or XMLSchema files to readh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M h8]r(j)r}r(hX ``doctype``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXdoctyperr}r(hUh jubah*jubhCX7 - the doctype for which DTD or XMLSchema files to readrr}r(hX7 - the doctype for which DTD or XMLSchema files to readh jubeubeh*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX getlastdocidrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX getlastdocidrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hX8Get the latest docid with revision number used by scope.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX8Get the latest docid with revision number used by scope.r r }r (hjh jubaubhd)r }r (hX#``scope`` - the scope to be queriedh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]r(j)r}r(hX ``scope``h,}r(h.]h/]h0]h1]h4]uh j h8]rhCXscoperr}r(hUh jubah*jubhCX - the scope to be queriedrr}r(hX - the scope to be queriedh j ubeubeh*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r (h.]h/]h0]h1]h4]uh jh8]r!hd)r"}r#(hXgetlogr$h jh(h)h*hsh,}r%(h.]h/]h0]h1]h4]uh6Mh8]r&hCXgetlogr'r(}r)(hj$h j"ubaubah*jubj)r*}r+(hUh,}r,(h.]h/]h0]h1]h4]uh jh8]r-(hd)r.}r/(hX7Get the latest docid with revision number used by user.r0h j*h(h)h*hsh,}r1(h.]h/]h0]h1]h4]uh6Mh8]r2hCX7Get the latest docid with revision number used by user.r3r4}r5(hj0h j.ubaubhd)r6}r7(hX=``ipaddress`` - the internet protocol address for the event ``principal`` - the principal for the event (a username, etc) ``docid`` - the identifier of the document to which the event applies ``event`` - the string code for the event ``start`` - beginning of date-range for query ``end`` - end of date-range for queryh j*h(h)h*hsh,}r8(h.]h/]h0]h1]h4]uh6Mh8]r9(j)r:}r;(hX ``ipaddress``h,}r<(h.]h/]h0]h1]h4]uh j6h8]r=hCX ipaddressr>r?}r@(hUh j:ubah*jubhCX/ - the internet protocol address for the event rArB}rC(hX/ - the internet protocol address for the event h j6ubj)rD}rE(hX ``principal``h,}rF(h.]h/]h0]h1]h4]uh j6h8]rGhCX principalrHrI}rJ(hUh jDubah*jubhCX1 - the principal for the event (a username, etc) rKrL}rM(hX1 - the principal for the event (a username, etc) h j6ubj)rN}rO(hX ``docid``h,}rP(h.]h/]h0]h1]h4]uh j6h8]rQhCXdocidrRrS}rT(hUh jNubah*jubhCX= - the identifier of the document to which the event applies rUrV}rW(hX= - the identifier of the document to which the event applies h j6ubj)rX}rY(hX ``event``h,}rZ(h.]h/]h0]h1]h4]uh j6h8]r[hCXeventr\r]}r^(hUh jXubah*jubhCX! - the string code for the event r_r`}ra(hX! - the string code for the event h j6ubj)rb}rc(hX ``start``h,}rd(h.]h/]h0]h1]h4]uh j6h8]rehCXstartrfrg}rh(hUh jbubah*jubhCX% - beginning of date-range for query rirj}rk(hX% - beginning of date-range for query h j6ubj)rl}rm(hX``end``h,}rn(h.]h/]h0]h1]h4]uh j6h8]rohCXendrprq}rr(hUh jlubah*jubhCX - end of date-range for queryrsrt}ru(hX - end of date-range for queryh j6ubeubeh*jubeh*jubj)rv}rw(hUh,}rx(h.]h/]h0]h1]h4]uh jh8]ry(j)rz}r{(hUh,}r|(h.]h/]h0]h1]h4]uh jvh8]r}hd)r~}r(hXgetloggedinuserinforh jzh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXgetloggedinuserinforr}r(hjh j~ubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jvh8]rhd)r}r(hX>Get user info for the currently logged in user. No parameters.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX>Get user info for the currently logged in user. No parameters.rr}r(hjh jubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX getpricipalsrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX getpricipalsrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXMGet all users and groups in the current authentication schema. No parameters.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXMGet all users and groups in the current authentication schema. No parameters.rr}r(hjh jubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXgetrevisionanddoctyperh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M h8]rhCXgetrevisionanddoctyperr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hXaReturn the revision and doctype of a document. The output is String that looks like "rev;doctype"rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M h8]rhCXaReturn the revision and doctype of a document. The output is String that looks like "rev;doctype"rr}r(hjh jubaubhd)r}r(hX%``docid`` - the docid of the documenth jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M#h8]r(j)r}r(hX ``docid``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXdocidrr}r(hUh jubah*jubhCX - the docid of the documentrr}r(hX - the docid of the documenth jubeubeh*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX getversionrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M%h8]rhCX getversionrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXSGet Metacat version. Return the current version of Metacat as XML. No parameters.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M%h8]rhCXSGet Metacat version. Return the current version of Metacat as XML. No parameters.rr}r(hjh jubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXinsertrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M'h8]rhCXinsertrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r (hX}Insert an XML document into the database. For an example, please see Inserting, Updating, and Deleting XML and Data Documentsr h jh(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M'h8]r hCX}Insert an XML document into the database. For an example, please see Inserting, Updating, and Deleting XML and Data Documentsr r}r(hj h jubaubhd)r}r(hXy``docid`` - the user-defined docid to assign to the new XML document ``doctext`` - the text of the XML document to inserth jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M*h8]r(j)r}r(hX ``docid``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXdocidrr}r(hUh jubah*jubhCX< - the user-defined docid to assign to the new XML document rr}r(hX< - the user-defined docid to assign to the new XML document h jubj)r}r(hX ``doctext``h,}r (h.]h/]h0]h1]h4]uh jh8]r!hCXdoctextr"r#}r$(hUh jubah*jubhCX) - the text of the XML document to insertr%r&}r'(hX) - the text of the XML document to inserth jubeubeh*jubeh*jubj)r(}r)(hUh,}r*(h.]h/]h0]h1]h4]uh jh8]r+(j)r,}r-(hUh,}r.(h.]h/]h0]h1]h4]uh j(h8]r/hd)r0}r1(hXinsertmultipartr2h j,h(h)h*hsh,}r3(h.]h/]h0]h1]h4]uh6M-h8]r4hCXinsertmultipartr5r6}r7(hj2h j0ubaubah*jubj)r8}r9(hUh,}r:(h.]h/]h0]h1]h4]uh j(h8]r;(hd)r<}r=(hXBInsert an XML document using multipart encoding into the database.r>h j8h(h)h*hsh,}r?(h.]h/]h0]h1]h4]uh6M-h8]r@hCXBInsert an XML document using multipart encoding into the database.rArB}rC(hj>h j<ubaubhd)rD}rE(hXy``docid`` - the user-defined docid to assign to the new XML document ``doctext`` - the text of the XML document to inserth j8h(h)h*hsh,}rF(h.]h/]h0]h1]h4]uh6M/h8]rG(j)rH}rI(hX ``docid``h,}rJ(h.]h/]h0]h1]h4]uh jDh8]rKhCXdocidrLrM}rN(hUh jHubah*jubhCX< - the user-defined docid to assign to the new XML document rOrP}rQ(hX< - the user-defined docid to assign to the new XML document h jDubj)rR}rS(hX ``doctext``h,}rT(h.]h/]h0]h1]h4]uh jDh8]rUhCXdoctextrVrW}rX(hUh jRubah*jubhCX) - the text of the XML document to insertrYrZ}r[(hX) - the text of the XML document to inserth jDubeubeh*jubeh*jubj)r\}r](hUh,}r^(h.]h/]h0]h1]h4]uh jh8]r_(j)r`}ra(hUh,}rb(h.]h/]h0]h1]h4]uh j\h8]rchd)rd}re(hX isregisteredrfh j`h(h)h*hsh,}rg(h.]h/]h0]h1]h4]uh6M2h8]rhhCX isregisteredrirj}rk(hjfh jdubaubah*jubj)rl}rm(hUh,}rn(h.]h/]h0]h1]h4]uh j\h8]ro(hd)rp}rq(hXCheck if an individual document exists in either the xml_documents or xml_revisions tables. For more information about Metacat's database schema, please see the developer documentation.rrh jlh(h)h*hsh,}rs(h.]h/]h0]h1]h4]uh6M2h8]rthCXCheck if an individual document exists in either the xml_documents or xml_revisions tables. For more information about Metacat's database schema, please see the developer documentation.rurv}rw(hjrh jpubaubhd)rx}ry(hX%``docid`` - the docid of the documenth jlh(h)h*hsh,}rz(h.]h/]h0]h1]h4]uh6M5h8]r{(j)r|}r}(hX ``docid``h,}r~(h.]h/]h0]h1]h4]uh jxh8]rhCXdocidrr}r(hUh j|ubah*jubhCX - the docid of the documentrr}r(hX - the docid of the documenth jxubeubeh*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXloginrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M7h8]rhCXloginrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hXLog the user in. You must log in using this action before you can perform many of the actions. For an example of the login action, see Logging In.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M7h8]rhCXLog the user in. You must log in using this action before you can perform many of the actions. For an example of the login action, see Logging In.rr}r(hjh jubaubhd)r}r(hXG``username`` - the user's login name ``password`` - the user's passwordh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M:h8]r(j)r}r(hX ``username``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXusernamerr}r(hUh jubah*jubhCX - the user's login name rr}r(hX - the user's login name h jubj)r}r(hX ``password``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXpasswordrr}r(hUh jubah*jubhCX - the user's passwordrr}r(hX - the user's passwordh jubeubeh*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXlogoutrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M=h8]rhCXlogoutrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXKLog the current user out and destroy the associated session. No parameters.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M=h8]rhCXKLog the current user out and destroy the associated session. No parameters.rr}r(hjh jubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXqueryrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M?h8]rhCXqueryrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hXHPerform a free text query. For an example, please see Searching Metacat.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6M?h8]rhCXHPerform a free text query. For an example, please see Searching Metacat.rr}r(hjh jubaubhd)r}r(hXL``returndoctype`` - the doctype to use for your Package View. For more information about packages, see http://knb.ecoinformatics.org/software/metacat/packages.html ``qformat`` - the format of the returned result set. Possible values are html or xml or the name of your servlet's Metacat skin. ``querytitle`` - OPTIONAL - the title of the query ``doctype`` - OPTIONAL - if doctype is specified, the search is limited only to the specified doctype(s). (e.g., eml://ecoinformatics.org/eml-2.0.1 and/or eml://ecoinformatics.org/eml-2.0.0) If no doctype element is specified, all document types are returned ``returnfield`` - a custom field to be returned by any hit document. ``operator`` - the Boolean operator to apply to the query. Possible values are: union or intersect ``searchmode`` - the type of search to be performed. Possible values are: contains, starts-with, ends-with, equals, isnot-equal, greater-than, less-than, greater-than-equals, less-than-equals. ``anyfield`` - a free-text search variable. The value placed in this parameter will be searched for in any document in any node. ``pagesize`` - the number of search results to display on each search results page (e.g., 10). Used with pagestart. See section 4.3.4 for an example. ``pagestart`` - the displayed search results page (e.g, 1). Used with pagesize. See section 4.3.4 for an example.h jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6MAh8]r(j)r}r(hX``returndoctype``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCX returndoctyperr}r(hUh jubah*jubhCXV - the doctype to use for your Package View. For more information about packages, see rr}r(hXV - the doctype to use for your Package View. For more information about packages, see h jubhi)r}r(hX<http://knb.ecoinformatics.org/software/metacat/packages.htmlrh,}r(Urefurijh1]h0]h.]h/]h4]uh jh8]rhCX<http://knb.ecoinformatics.org/software/metacat/packages.htmlrr}r(hUh jubah*hrubhCX r}r (hX h jubj)r }r (hX ``qformat``h,}r (h.]h/]h0]h1]h4]uh jh8]r hCXqformatrr}r(hUh j ubah*jubhCXv - the format of the returned result set. Possible values are html or xml or the name of your servlet's Metacat skin. rr}r(hXv - the format of the returned result set. Possible values are html or xml or the name of your servlet's Metacat skin. h jubj)r}r(hX``querytitle``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCX querytitlerr}r(hUh jubah*jubhCX% - OPTIONAL - the title of the query rr}r(hX% - OPTIONAL - the title of the query h jubj)r}r(hX ``doctype``h,}r (h.]h/]h0]h1]h4]uh jh8]r!hCXdoctyper"r#}r$(hUh jubah*jubhCX - OPTIONAL - if doctype is specified, the search is limited only to the specified doctype(s). (e.g., eml://ecoinformatics.org/eml-2.0.1 and/or eml://ecoinformatics.org/eml-2.0.0) If no doctype element is specified, all document types are returned r%r&}r'(hX - OPTIONAL - if doctype is specified, the search is limited only to the specified doctype(s). (e.g., eml://ecoinformatics.org/eml-2.0.1 and/or eml://ecoinformatics.org/eml-2.0.0) If no doctype element is specified, all document types are returned h jubj)r(}r)(hX``returnfield``h,}r*(h.]h/]h0]h1]h4]uh jh8]r+hCX returnfieldr,r-}r.(hUh j(ubah*jubhCX6 - a custom field to be returned by any hit document. r/r0}r1(hX6 - a custom field to be returned by any hit document. h jubj)r2}r3(hX ``operator``h,}r4(h.]h/]h0]h1]h4]uh jh8]r5hCXoperatorr6r7}r8(hUh j2ubah*jubhCXW - the Boolean operator to apply to the query. Possible values are: union or intersect r9r:}r;(hXW - the Boolean operator to apply to the query. Possible values are: union or intersect h jubj)r<}r=(hX``searchmode``h,}r>(h.]h/]h0]h1]h4]uh jh8]r?hCX searchmoder@rA}rB(hUh j<ubah*jubhCX - the type of search to be performed. Possible values are: contains, starts-with, ends-with, equals, isnot-equal, greater-than, less-than, greater-than-equals, less-than-equals. rCrD}rE(hX - the type of search to be performed. Possible values are: contains, starts-with, ends-with, equals, isnot-equal, greater-than, less-than, greater-than-equals, less-than-equals. h jubj)rF}rG(hX ``anyfield``h,}rH(h.]h/]h0]h1]h4]uh jh8]rIhCXanyfieldrJrK}rL(hUh jFubah*jubhCXu - a free-text search variable. The value placed in this parameter will be searched for in any document in any node. rMrN}rO(hXu - a free-text search variable. The value placed in this parameter will be searched for in any document in any node. h jubj)rP}rQ(hX ``pagesize``h,}rR(h.]h/]h0]h1]h4]uh jh8]rShCXpagesizerTrU}rV(hUh jPubah*jubhCX - the number of search results to display on each search results page (e.g., 10). Used with pagestart. See section 4.3.4 for an example. rWrX}rY(hX - the number of search results to display on each search results page (e.g., 10). Used with pagestart. See section 4.3.4 for an example. h jubj)rZ}r[(hX ``pagestart``h,}r\(h.]h/]h0]h1]h4]uh jh8]r]hCX pagestartr^r_}r`(hUh jZubah*jubhCXd - the displayed search results page (e.g, 1). Used with pagesize. See section 4.3.4 for an example.rarb}rc(hXd - the displayed search results page (e.g, 1). Used with pagesize. See section 4.3.4 for an example.h jubeubeh*jubeh*jubj)rd}re(hUh,}rf(h.]h/]h0]h1]h4]uh jh8]rg(j)rh}ri(hUh,}rj(h.]h/]h0]h1]h4]uh jdh8]rkhd)rl}rm(hXreadrnh jhh(h)h*hsh,}ro(h.]h/]h0]h1]h4]uh6MLh8]rphCXreadrqrr}rs(hjnh jlubaubah*jubj)rt}ru(hUh,}rv(h.]h/]h0]h1]h4]uh jdh8]rw(hd)rx}ry(hXmGet a document from the database and return it in the specified format. See Searching Metacat for an example.rzh jth(h)h*hsh,}r{(h.]h/]h0]h1]h4]uh6MLh8]r|hCXmGet a document from the database and return it in the specified format. See Searching Metacat for an example.r}r~}r(hjzh jxubaubhd)r}r(hX``docid`` - the docid of the document to return ``qformat`` - the format to return the document in. Possible values are: ``html``, ``xml``,or, if your Metacat uses a skin, the name of the skin.h jth(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6MNh8]r(j)r}r(hX ``docid``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXdocidrr}r(hUh jubah*jubhCX' - the docid of the document to return rr}r(hX' - the docid of the document to return h jubj)r}r(hX ``qformat``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXqformatrr}r(hUh jubah*jubhCX> - the format to return the document in. Possible values are: rr}r(hX> - the format to return the document in. Possible values are: h jubj)r}r(hX``html``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXhtmlrr}r(hUh jubah*jubhCX, rr}r(hX, h jubj)r}r(hX``xml``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXxmlrr}r(hUh jubah*jubhCX7,or, if your Metacat uses a skin, the name of the skin.rr}r(hX7,or, if your Metacat uses a skin, the name of the skin.h jubeubeh*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXreadinlinedatarh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6MQh8]rhCXreadinlinedatarr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hXRead inline data only.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6MQh8]rhCXRead inline data only.rr}r(hjh jubaubhd)r}r(hX4``inlinedataid`` - the id of the inline data to readh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6MSh8]r(j)r}r(hX``inlinedataid``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCX inlinedataidrr}r(hUh jubah*jubhCX$ - the id of the inline data to readrr}r(hX$ - the id of the inline data to readh jubeubeh*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX setaccessrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6MUh8]rhCX setaccessrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hX=Change access permissions for a user on a specified document.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6MUh8]rhCX=Change access permissions for a user on a specified document.rr}r(hjh jubaubhd)r}r(hXC``docid`` - the docid of the document to be modified. ``principal`` - the user or group whose permissions will be modified ``permission`` - the permission to set (read, write, all) ``permType`` - the type of permission to set (allow, deny) ``permOrder`` - the order in which to apply the permission (allowFirst, denyFirst)h jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6MWh8]r(j)r}r(hX ``docid``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXdocidrr}r(hUh jubah*jubhCX- - the docid of the document to be modified. rr}r(hX- - the docid of the document to be modified. h jubj)r}r(hX ``principal``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCX principalrr}r(hUh jubah*jubhCX8 - the user or group whose permissions will be modified rr}r (hX8 - the user or group whose permissions will be modified h jubj)r }r (hX``permission``h,}r (h.]h/]h0]h1]h4]uh jh8]r hCX permissionrr}r(hUh j ubah*jubhCX- - the permission to set (read, write, all) rr}r(hX- - the permission to set (read, write, all) h jubj)r}r(hX ``permType``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXpermTyperr}r(hUh jubah*jubhCX/ - the type of permission to set (allow, deny) rr}r(hX/ - the type of permission to set (allow, deny) h jubj)r}r(hX ``permOrder``h,}r (h.]h/]h0]h1]h4]uh jh8]r!hCX permOrderr"r#}r$(hUh jubah*jubhCXE - the order in which to apply the permission (allowFirst, denyFirst)r%r&}r'(hXE - the order in which to apply the permission (allowFirst, denyFirst)h jubeubeh*jubeh*jubj)r(}r)(hUh,}r*(h.]h/]h0]h1]h4]uh jh8]r+(j)r,}r-(hUh,}r.(h.]h/]h0]h1]h4]uh j(h8]r/hd)r0}r1(hX spatial_queryr2h j,h(h)h*hsh,}r3(h.]h/]h0]h1]h4]uh6M]h8]r4hCX spatial_queryr5r6}r7(hj2h j0ubaubah*jubj)r8}r9(hUh,}r:(h.]h/]h0]h1]h4]uh j(h8]r;(hd)r<}r=(hXPerform a spatial query. These queries may include any of the queries supported by the WFS / WMS standards. For more information, see Spatial Queries.r>h j8h(h)h*hsh,}r?(h.]h/]h0]h1]h4]uh6M]h8]r@hCXPerform a spatial query. These queries may include any of the queries supported by the WFS / WMS standards. For more information, see Spatial Queries.rArB}rC(hj>h j<ubaubhd)rD}rE(hX``xmax`` - max x spatial coordinate ``ymax`` - max y spatial coordinate ``xmin`` - min x spatial coordinate ``ymin`` - min y spatial coordinateh j8h(h)h*hsh,}rF(h.]h/]h0]h1]h4]uh6M`h8]rG(j)rH}rI(hX``xmax``h,}rJ(h.]h/]h0]h1]h4]uh jDh8]rKhCXxmaxrLrM}rN(hUh jHubah*jubhCX - max x spatial coordinate rOrP}rQ(hX - max x spatial coordinate h jDubj)rR}rS(hX``ymax``h,}rT(h.]h/]h0]h1]h4]uh jDh8]rUhCXymaxrVrW}rX(hUh jRubah*jubhCX - max y spatial coordinate rYrZ}r[(hX - max y spatial coordinate h jDubj)r\}r](hX``xmin``h,}r^(h.]h/]h0]h1]h4]uh jDh8]r_hCXxminr`ra}rb(hUh j\ubah*jubhCX - min x spatial coordinate rcrd}re(hX - min x spatial coordinate h jDubj)rf}rg(hX``ymin``h,}rh(h.]h/]h0]h1]h4]uh jDh8]rihCXyminrjrk}rl(hUh jfubah*jubhCX - min y spatial coordinatermrn}ro(hX - min y spatial coordinateh jDubeubeh*jubeh*jubj)rp}rq(hUh,}rr(h.]h/]h0]h1]h4]uh jh8]rs(j)rt}ru(hUh,}rv(h.]h/]h0]h1]h4]uh jph8]rwhd)rx}ry(hXsqueryrzh jth(h)h*hsh,}r{(h.]h/]h0]h1]h4]uh6Meh8]r|hCXsqueryr}r~}r(hjzh jxubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jph8]r(hd)r}r(hXIPerform a structured query. For an example, please see Searching Metacat.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Meh8]rhCXIPerform a structured query. For an example, please see Searching Metacat.rr}r(hjh jubaubhd)r}r(hX``query`` - the text of the pathquery document sent to the server ``qformat`` - the format to return the results in. Possible values are: ``xml``, or the name of the a skin.h jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mgh8]r(j)r}r(hX ``query``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXqueryrr}r(hUh jubah*jubhCX9 - the text of the pathquery document sent to the server rr}r(hX9 - the text of the pathquery document sent to the server h jubj)r}r(hX ``qformat``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXqformatrr}r(hUh jubah*jubhCX> - the format to return the results in. Possible values are: rr}r(hX> - the format to return the results in. Possible values are: h jubj)r}r(hX``xml``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXxmlrr}r(hUh jubah*jubhCX, or the name of the a skin.rr}r(hX, or the name of the a skin.h jubeubeh*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXupdaterh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mjh8]rhCXupdaterr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hXOverwrite an XML document with a new one and give the new one the same docid but with the next revision number. For an example, please see Inserting, Updating, and Deleting XML and Data Documents.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mjh8]rhCXOverwrite an XML document with a new one and give the new one the same docid but with the next revision number. For an example, please see Inserting, Updating, and Deleting XML and Data Documents.rr}r(hjh jubaubhd)r}r(hXl``docid`` - the docid of the document to update ``doctext`` - the text with which to update the XML documenth jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mnh8]r(j)r}r(hX ``docid``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXdocidrr}r(hUh jubah*jubhCX' - the docid of the document to update rr}r(hX' - the docid of the document to update h jubj)r}r(hX ``doctext``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXdoctextrr}r(hUh jubah*jubhCX1 - the text with which to update the XML documentrr}r(hX1 - the text with which to update the XML documenth jubeubeh*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXuploadrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mqh8]rhCXuploadrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hXUpload (insert or update) a data file into Metacat. Data files are stored on Metacat and may be in any format (binary or text), but they are all treated as if they were binary.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mqh8]rhCXUpload (insert or update) a data file into Metacat. Data files are stored on Metacat and may be in any format (binary or text), but they are all treated as if they were binary.rr}r(hjh jubaubhd)r}r(hXW``docid`` - the docid of the data file to upload ``datafile`` - the data file to uploadh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mth8]r(j)r}r(hX ``docid``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXdocidrr}r(hUh jubah*jubhCX( - the docid of the data file to upload r r }r (hX( - the docid of the data file to upload h jubj)r }r (hX ``datafile``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXdatafilerr}r(hUh j ubah*jubhCX - the data file to uploadrr}r(hX - the data file to uploadh jubeubeh*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXvalidater h jh(h)h*hsh,}r!(h.]h/]h0]h1]h4]uh6Mwh8]r"hCXvalidater#r$}r%(hj h jubaubah*jubj)r&}r'(hUh,}r((h.]h/]h0]h1]h4]uh jh8]r)(hd)r*}r+(hX.Validate a specified document against its DTD.r,h j&h(h)h*hsh,}r-(h.]h/]h0]h1]h4]uh6Mwh8]r.hCX.Validate a specified document against its DTD.r/r0}r1(hj,h j*ubaubhd)r2}r3(hXj``docid`` - the docid of the document to validate ``valtext`` - the DTD by which to validate this documenth j&h(h)h*hsh,}r4(h.]h/]h0]h1]h4]uh6Myh8]r5(j)r6}r7(hX ``docid``h,}r8(h.]h/]h0]h1]h4]uh j2h8]r9hCXdocidr:r;}r<(hUh j6ubah*jubhCX) - the docid of the document to validate r=r>}r?(hX) - the docid of the document to validate h j2ubj)r@}rA(hX ``valtext``h,}rB(h.]h/]h0]h1]h4]uh j2h8]rChCXvaltextrDrE}rF(hUh j@ubah*jubhCX- - the DTD by which to validate this documentrGrH}rI(hX- - the DTD by which to validate this documenth j2ubeubeh*jubeh*jubeh*UtbodyrJubeh*UtgrouprKubaubhd)rL}rM(hXMetacat Replication ParametersrNh jeh(h)h*hsh,}rO(h.]h/]h0]h1]h4]uh6M~h7hh8]rPhCXMetacat Replication ParametersrQrR}rS(hjNh jLubaubj)rT}rU(hUh jeh(h)h*jh,}rV(h.]h/]h0]h1]h4]uh6Nh7hh8]rWj)rX}rY(hUh,}rZ(h1]h0]h.]h/]h4]UcolsKuh jTh8]r[(j)r\}r](hUh,}r^(h1]h0]h.]h/]h4]UcolwidthKuh jXh8]h*jubj)r_}r`(hUh,}ra(h1]h0]h.]h/]h4]UcolwidthKuh jXh8]h*jubj)rb}rc(hUh,}rd(h.]h/]h0]h1]h4]uh jXh8]rej)rf}rg(hUh,}rh(h.]h/]h0]h1]h4]uh jbh8]ri(j)rj}rk(hUh,}rl(h.]h/]h0]h1]h4]uh jfh8]rmhd)rn}ro(hXActionrph jjh(h)h*hsh,}rq(h.]h/]h0]h1]h4]uh6Mh8]rrhCXActionrsrt}ru(hjph jnubaubah*jubj)rv}rw(hUh,}rx(h.]h/]h0]h1]h4]uh jfh8]ryhd)rz}r{(hXDescription and Parametersr|h jvh(h)h*hsh,}r}(h.]h/]h0]h1]h4]uh6Mh8]r~hCXDescription and Parametersrr}r(hj|h jzubaubah*jubeh*jubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jXh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXforcereplicaterh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXforcereplicaterr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hXJForce the local server to get the specified document from the remote host.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXJForce the local server to get the specified document from the remote host.rr}r(hjh jubaubhd)r}r(hX``server`` - The server to which this document is being sent ``docid`` - The docid of the document to send ``dbaction`` - The action to perform on the document: insert or update (the default)h jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]r(j)r}r(hX ``server``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXserverrr}r(hUh jubah*jubhCX3 - The server to which this document is being sent rr}r(hX3 - The server to which this document is being sent h jubj)r}r(hX ``docid``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXdocidrr}r(hUh jubah*jubhCX% - The docid of the document to send rr}r(hX% - The docid of the document to send h jubj)r}r(hX ``dbaction``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXdbactionrr}r(hUh jubah*jubhCXH - The action to perform on the document: insert or update (the default)rr}r(hXH - The action to perform on the document: insert or update (the default)h jubeubeh*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXgetallrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXgetallrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXWForce the local server to check all known servers for updated documents. No parameters.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXWForce the local server to check all known servers for updated documents. No parameters.rr}r(hjh jubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX getcatalogrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX getcatalogrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXISend the contents of the xml_catalog table encoded in XML. No parameters.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXISend the contents of the xml_catalog table encoded in XML. No parameters.rr}r(hjh jubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(j)r }r (hUh,}r (h.]h/]h0]h1]h4]uh jh8]r hd)r }r (hXgetlockr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCXgetlockr r }r (hj h j ubaubah*jubj)r }r (hUh,}r (h.]h/]h0]h1]h4]uh jh8]r (hd)r }r (hX)Request a lock on the specified document.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX)Request a lock on the specified document.r r }r (hj h j ubaubhd)r }r (hXR``docid`` - the docid of the document ``updaterev`` - the revision number of docidh j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r (j)r }r (hX ``docid``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXdocidr r! }r" (hUh j ubah*jubhCX - the docid of the document r# r$ }r% (hX - the docid of the document h j ubj)r& }r' (hX ``updaterev``h,}r( (h.]h/]h0]h1]h4]uh j h8]r) hCX updaterevr* r+ }r, (hUh j& ubah*jubhCX - the revision number of docidr- r. }r/ (hX - the revision number of docidh j ubeubeh*jubeh*jubj)r0 }r1 (hUh,}r2 (h.]h/]h0]h1]h4]uh jh8]r3 (j)r4 }r5 (hUh,}r6 (h.]h/]h0]h1]h4]uh j0 h8]r7 hd)r8 }r9 (hXgettimer: h j4 h(h)h*hsh,}r; (h.]h/]h0]h1]h4]uh6Mh8]r< hCXgettimer= r> }r? (hj: h j8 ubaubah*jubj)r@ }rA (hUh,}rB (h.]h/]h0]h1]h4]uh j0 h8]rC hd)rD }rE (hX4Return the local time on this server. No parameters.rF h j@ h(h)h*hsh,}rG (h.]h/]h0]h1]h4]uh6Mh8]rH hCX4Return the local time on this server. No parameters.rI rJ }rK (hjF h jD ubaubah*jubeh*jubj)rL }rM (hUh,}rN (h.]h/]h0]h1]h4]uh jh8]rO (j)rP }rQ (hUh,}rR (h.]h/]h0]h1]h4]uh jL h8]rS hd)rT }rU (hX servercontrolrV h jP h(h)h*hsh,}rW (h.]h/]h0]h1]h4]uh6Mh8]rX hCX servercontrolrY rZ }r[ (hjV h jT ubaubah*jubj)r\ }r] (hUh,}r^ (h.]h/]h0]h1]h4]uh jL h8]r_ (hd)r` }ra (hXDPerform the specified replication control on the Replication daemon.rb h j\ h(h)h*hsh,}rc (h.]h/]h0]h1]h4]uh6Mh8]rd hCXDPerform the specified replication control on the Replication daemon.re rf }rg (hjb h j` ubaubhd)rh }ri (hXF``add`` - add a new server to the replication list ``delete`` - remove a server from the replication list ``list`` - list all of the servers currently in the server list ``replicate`` - a Boolean flag (1 or 0) which determines if this server should copy files from the newly added server. ``server`` - the server to add/deleteh j\ h(h)h*hsh,}rj (h.]h/]h0]h1]h4]uh6Mh8]rk (j)rl }rm (hX``add``h,}rn (h.]h/]h0]h1]h4]uh jh h8]ro hCXaddrp rq }rr (hUh jl ubah*jubhCX, - add a new server to the replication list rs rt }ru (hX, - add a new server to the replication list h jh ubj)rv }rw (hX ``delete``h,}rx (h.]h/]h0]h1]h4]uh jh h8]ry hCXdeleterz r{ }r| (hUh jv ubah*jubhCX- - remove a server from the replication list r} r~ }r (hX- - remove a server from the replication list h jh ubj)r }r (hX``list``h,}r (h.]h/]h0]h1]h4]uh jh h8]r hCXlistr r }r (hUh j ubah*jubhCX8 - list all of the servers currently in the server list r r }r (hX8 - list all of the servers currently in the server list h jh ubj)r }r (hX ``replicate``h,}r (h.]h/]h0]h1]h4]uh jh h8]r hCX replicater r }r (hUh j ubah*jubhCXj - a Boolean flag (1 or 0) which determines if this server should copy files from the newly added server. r r }r (hXj - a Boolean flag (1 or 0) which determines if this server should copy files from the newly added server. h jh ubj)r }r (hX ``server``h,}r (h.]h/]h0]h1]h4]uh jh h8]r hCXserverr r }r (hUh j ubah*jubhCX - the server to add/deleter r }r (hX - the server to add/deleteh jh ubeubeh*jubeh*jubj)r }r (hUh,}r (h.]h/]h0]h1]h4]uh jh8]r (j)r }r (hUh,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (hXreadr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCXreadr r }r (hj h j ubaubah*jubj)r }r (hUh,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (hXSends docid to the remote host.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCXSends docid to the remote host.r r }r (hj h j ubaubhd)r }r (hX-``docid`` - the docid of the document to readh j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r (j)r }r (hX ``docid``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXdocidr r }r (hUh j ubah*jubhCX$ - the docid of the document to readr r }r (hX$ - the docid of the document to readh j ubeubeh*jubeh*jubj)r }r (hUh,}r (h.]h/]h0]h1]h4]uh jh8]r (j)r }r (hUh,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (hXstartr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCXstartr r }r (hj h j ubaubah*jubj)r }r (hUh,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (hX<Start the Replication daemon with a time interval of deltaT.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX<Start the Replication daemon with a time interval of deltaT.r r }r (hj h j ubaubhd)r }r (hX``rate`` - The rate (in seconds) at which you want the replication daemon to check for updated documents. The value cannot be less than 30. The default is 1000h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r (j)r }r (hX``rate``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXrater r }r (hUh j ubah*jubhCX - The rate (in seconds) at which you want the replication daemon to check for updated documents. The value cannot be less than 30. The default is 1000r r }r (hX - The rate (in seconds) at which you want the replication daemon to check for updated documents. The value cannot be less than 30. The default is 1000h j ubeubeh*jubeh*jubj)r }r (hUh,}r (h.]h/]h0]h1]h4]uh jh8]r (j)r }r (hUh,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (hXstopr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCXstopr r }r (hj h j ubaubah*jubj)r }r (hUh,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (hX+Stop the Replication daemon. No parameters.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX+Stop the Replication daemon. No parameters.r r }r (hj h j ubaubah*jubeh*jubj)r }r (hUh,}r (h.]h/]h0]h1]h4]uh jh8]r (j)r }r (hUh,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (hXupdater h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCXupdater r }r (hj h j ubaubah*jubj)r }r (hUh,}r (h.]h/]h0]h1]h4]uh j h8]r! hd)r" }r# (hXbSend a list of all documents on the local server along with their revision numbers. No parameters.r$ h j h(h)h*hsh,}r% (h.]h/]h0]h1]h4]uh6Mh8]r& hCXbSend a list of all documents on the local server along with their revision numbers. No parameters.r' r( }r) (hj$ h j" ubaubah*jubeh*jubeh*jJubeh*jKubaubeubh!)r* }r+ (hUh jh(h)h*h+h,}r, (h.]h/]h0]h1]r- jah4]r. hauh6Mh7hh8]r/ (h:)r0 }r1 (hjh j* h(h)h*h>h,}r2 (h1]h0]h.]h/]h4]h@juh6Mh7hh8]r3 hCX Logging Inr4 r5 }r6 (hjh j0 ubaubhd)r7 }r8 (hX/To log in to Metacat, use the ``login`` action.r9 h j* h(h)h*hsh,}r: (h.]h/]h0]h1]h4]uh6Mh7hh8]r; (hCXTo log in to Metacat, use the r< r= }r> (hXTo log in to Metacat, use the h j7 ubj)r? }r@ (hX ``login``h,}rA (h.]h/]h0]h1]h4]uh j7 h8]rB hCXloginrC rD }rE (hUh j? ubah*jubhCX action.rF rG }rH (hX action.h j7 ubeubhd)rI }rJ (hXThe following is an example of a Web form (see figure) that logs a user into Metact. Example HTML code is included below the screenshot.rK h j* h(h)h*hsh,}rL (h.]h/]h0]h1]h4]uh6Mh7hh8]rM hCXThe following is an example of a Web form (see figure) that logs a user into Metact. Example HTML code is included below the screenshot.rN rO }rP (hjK h jI ubaubcdocutils.nodes figure rQ )rR }rS (hUh j* h(h)h*UfigurerT h,}rU (UalignrV Xcenterh1]rW Uid4rX ah0]h.]h/]h4]uh6Nh7hh8]rY (cdocutils.nodes image rZ )r[ }r\ (hXk.. figure:: images/screenshots/image039.jpg :align: center Logging into Metacat using an HTML form. h,}r] (UuriXimages/screenshots/image039.jpgr^ h1]h0]h.]h/]U candidatesr_ }r` U*j^ sh4]uh jR h8]h*Uimagera ubcdocutils.nodes caption rb )rc }rd (hX(Logging into Metacat using an HTML form.re h jR h(h)h*Ucaptionrf h,}rg (h.]h/]h0]h1]h4]uh6Mh8]rh hCX(Logging into Metacat using an HTML form.ri rj }rk (hje h jc ubaubeubcdocutils.nodes literal_block rl )rm }rn (hX-
username:
organization:
password:
 
h j* h(h)h*U literal_blockro h,}rp (U xml:spacerq Upreserverr h1]h0]h.]h/]h4]uh6Mh7hh8]rs hCX-
username:
organization:
password:
 
rt ru }rv (hUh jm ubaubeubh!)rw }rx (hUh jh(h)h*h+h,}ry (h.]h/]h0]h1]rz j&ah4]r{ hauh6Mh7hh8]r| (h:)r} }r~ (hj+h jw h(h)h*h>h,}r (h1]h0]h.]h/]h4]h@j%uh6Mh7hh8]r hCX8Inserting, Updating, and Deleting XML and Data Documentsr r }r (hj+h j} ubaubhd)r }r (hX Adding, editing, and deleting XML documents in Metacat can be accomplished using the insert, update, and delete actions, respectively. Before you can insert, delete, or update documents, you must log in to Metacat using the login action. See Logging in for an example.r h jw h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r hCX Adding, editing, and deleting XML documents in Metacat can be accomplished using the insert, update, and delete actions, respectively. Before you can insert, delete, or update documents, you must log in to Metacat using the login action. See Logging in for an example.r r }r (hj h j ubaubcdocutils.nodes definition_list r )r }r (hUh jw h(h)h*Udefinition_listr h,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r (cdocutils.nodes definition_list_item r )r }r (hX[``insert`` Insert a new XML or data document into Metacat. You must specify a document ID. h j h(h)h*Udefinition_list_itemr h,}r (h.]h/]h0]h1]h4]uh6Mh8]r (cdocutils.nodes term r )r }r (hXinserth j h(h)h*Utermr h,}r (h.]h/]h0]h1]h4]uh6Mh8]r j)r }r (hX ``insert``r h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXinsertr r }r (hUh j ubah*jubaubcdocutils.nodes definition r )r }r (hUh,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (hXOInsert a new XML or data document into Metacat. You must specify a document ID.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCXOInsert a new XML or data document into Metacat. You must specify a document ID.r r }r (hj h j ubaubah*U definitionr ubeubj )r }r (hXe``update`` Update an existing Metacat document. The original document is archived, then overwritten. h j h(h)h*j h,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r (j )r }r (hXupdateh j h(h)h*j h,}r (h.]h/]h0]h1]h4]uh6Mh8]r j)r }r (hX ``update``r h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXupdater r }r (hUh j ubah*jubaubj )r }r (hUh,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (hXYUpdate an existing Metacat document. The original document is archived, then overwritten.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCXYUpdate an existing Metacat document. The original document is archived, then overwritten.r r }r (hj h j ubaubah*j ubeubj )r }r (hXI``delete`` Archive a document and move the pointer in xml_documents to xml_revisions, effectively "deleting" the document from public view, but preserving the revision for the revision history. No further updates will be allowed for the Metacat document that was "deleted". All revisions of this identifier are no longer public. h j h(h)h*j h,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r (j )r }r (hXdeleteh j h(h)h*j h,}r (h.]h/]h0]h1]h4]uh6Mh8]r j)r }r (hX ``delete``r h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXdeleter r }r (hUh j ubah*jubaubj )r }r (hUh,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (hX=Archive a document and move the pointer in xml_documents to xml_revisions, effectively "deleting" the document from public view, but preserving the revision for the revision history. No further updates will be allowed for the Metacat document that was "deleted". All revisions of this identifier are no longer public.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M h8]r hCX=Archive a document and move the pointer in xml_documents to xml_revisions, effectively "deleting" the document from public view, but preserving the revision for the revision history. No further updates will be allowed for the Metacat document that was "deleted". All revisions of this identifier are no longer public.r r }r (hj h j ubaubah*j ubeubeubcdocutils.nodes warning r )r }r (hXcIt is not possible to "delete" one revision without "deleting" all revisions of a given identifier.h jw h(h)h*Uwarningr h,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r hd)r }r (hXcIt is not possible to "delete" one revision without "deleting" all revisions of a given identifier.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCXcIt is not possible to "delete" one revision without "deleting" all revisions of a given identifier.r r }r (hj h j ubaubaubhd)r }r (hXThe following is an example of a Web form (see figure) that can perform all three tasks. Example HTML code is included in the sidebar.r h jw h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r hCXThe following is an example of a Web form (see figure) that can perform all three tasks. Example HTML code is included in the sidebar.r r }r (hj h j ubaubjQ )r }r (hUh jw h(h)h*jT h,}r (jV Xcenterh1]r Uid5r ah0]h.]h/]h4]uh6Nh7hh8]r (jZ )r }r (hX.. figure:: images/screenshots/image041.jpg :align: center An example of a Web form used to insert, delete, or update XML documents in Metacat. h,}r (UuriXimages/screenshots/image041.jpgr h1]h0]h.]h/]j_ }r U*j sh4]uh j h8]h*ja ubjb )r }r (hXTAn example of a Web form used to insert, delete, or update XML documents in Metacat.r h j h(h)h*jf h,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCXTAn example of a Web form used to insert, delete, or update XML documents in Metacat.r r }r (hj h j ubaubeubjl )r }r (hX8 MetaCat MetaCat XML Loader

Upload, Change, or Delete an XML document using this form.

1. Choose an action: Insert Update Delete
2. Provide a Document ID (optional for Insert) Public Document
3. Provide XML text (not needed for Delete)

4. Provide DTD text for upload (optional; not needed for Delete)
h jw h(h)h*jo h,}r (jq jr h1]h0]h.]h/]h4]uh6Mh7hh8]r hCX8 MetaCat MetaCat XML Loader

Upload, Change, or Delete an XML document using this form.

1. Choose an action: Insert Update Delete
2. Provide a Document ID (optional for Insert) Public Document
3. Provide XML text (not needed for Delete)

4. Provide DTD text for upload (optional; not needed for Delete)
r r }r (hUh j ubaubeubh!)r }r (hUh jh(h)h*h+h,}r (h.]h/]h0]h1]r j9ah4]r hauh6M;h7hh8]r! (h:)r" }r# (hj>h j h(h)h*h>h,}r$ (h1]h0]h.]h/]h4]h@j8uh6M;h7hh8]r% hCXSearching Metacatr& r' }r( (hj>h j" ubaubhd)r) }r* (hX:To search Metacat use the ``query`` or ``squery`` actions.r+ h j h(h)h*hsh,}r, (h.]h/]h0]h1]h4]uh6M<h7hh8]r- (hCXTo search Metacat use the r. r/ }r0 (hXTo search Metacat use the h j) ubj)r1 }r2 (hX ``query``h,}r3 (h.]h/]h0]h1]h4]uh j) h8]r4 hCXqueryr5 r6 }r7 (hUh j1 ubah*jubhCX or r8 r9 }r: (hX or h j) ubj)r; }r< (hX ``squery``h,}r= (h.]h/]h0]h1]h4]uh j) h8]r> hCXsqueryr? r@ }rA (hUh j; ubah*jubhCX actions.rB rC }rD (hX actions.h j) ubeubj )rE }rF (hUh j h(h)h*j h,}rG (h.]h/]h0]h1]h4]uh6Nh7hh8]rH (j )rI }rJ (hX``query``: Perform a free text query. Specify the returndoctype, qformat, returnfield, operator, searchmode, anyfield, and (optionally) a querytitle and doctype. h jE h(h)h*j h,}rK (h.]h/]h0]h1]h4]uh6M@h8]rL (j )rM }rN (hXquery:h jI h(h)h*j h,}rO (h.]h/]h0]h1]h4]uh6M@h8]rP (j)rQ }rR (hX ``query``h,}rS (h.]h/]h0]h1]h4]uh jM h8]rT hCXqueryrU rV }rW (hUh jQ ubah*jubhCX:rX }rY (hX:h jM ubeubj )rZ }r[ (hUh,}r\ (h.]h/]h0]h1]h4]uh jI h8]r] hd)r^ }r_ (hXPerform a free text query. Specify the returndoctype, qformat, returnfield, operator, searchmode, anyfield, and (optionally) a querytitle and doctype.r` h jZ h(h)h*hsh,}ra (h.]h/]h0]h1]h4]uh6M?h8]rb hCXPerform a free text query. Specify the returndoctype, qformat, returnfield, operator, searchmode, anyfield, and (optionally) a querytitle and doctype.rc rd }re (hj` h j^ ubaubah*j ubeubj )rf }rg (hXg``squery``: Perform a structured query by submitting an XML pathquery document to the Metacat server. h jE h(h)h*j h,}rh (h.]h/]h0]h1]h4]uh6MEh7hh8]ri (j )rj }rk (hXsquery:h jf h(h)h*j h,}rl (h.]h/]h0]h1]h4]uh6MEh8]rm (j)rn }ro (hX ``squery``h,}rp (h.]h/]h0]h1]h4]uh jj h8]rq hCXsqueryrr rs }rt (hUh jn ubah*jubhCX:ru }rv (hX:h jj ubeubj )rw }rx (hUh,}ry (h.]h/]h0]h1]h4]uh jf h8]rz hd)r{ }r| (hXYPerform a structured query by submitting an XML pathquery document to the Metacat server.r} h jw h(h)h*hsh,}r~ (h.]h/]h0]h1]h4]uh6MCh8]r hCXYPerform a structured query by submitting an XML pathquery document to the Metacat server.r r }r (hj} h j{ ubaubah*j ubeubeubhd)r }r (hX!When Metacat receives a query via HTTP (screenshot below), the server creates a "pathquery" document, which is an XML document populated with the specified search criteria. The pathquery document is then translated into SQL statements that are executed against the database. Results are translated into an XML "resultset" document, which can be returned as XML or transformed into HTML and returned (specify which you would prefer with the returnfield parameter). You can also opt to submit a pathquery document directly, using an squery action.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6MGh7hh8]r hCX!When Metacat receives a query via HTTP (screenshot below), the server creates a "pathquery" document, which is an XML document populated with the specified search criteria. The pathquery document is then translated into SQL statements that are executed against the database. Results are translated into an XML "resultset" document, which can be returned as XML or transformed into HTML and returned (specify which you would prefer with the returnfield parameter). You can also opt to submit a pathquery document directly, using an squery action.r r }r (hj h j ubaubjQ )r }r (hUh j h(h)h*jT h,}r (jV Xcenterh1]r Uid6r ah0]h.]h/]h4]uh6Nh7hh8]r (jZ )r }r (hX.. figure:: images/screenshots/image043.jpg :align: center Example of a basic search form using a query action. The HTML code used to create the form is displayed below. h,}r (UuriXimages/screenshots/image043.jpgr h1]h0]h.]h/]j_ }r U*j sh4]uh j h8]h*ja ubjb )r }r (hXnExample of a basic search form using a query action. The HTML code used to create the form is displayed below.r h j h(h)h*jf h,}r (h.]h/]h0]h1]h4]uh6MSh8]r hCXnExample of a basic search form using a query action. The HTML code used to create the form is displayed below.r r }r (hj h j ubaubeubjl )r }r (hXa Search
Search for:
h j h(h)h*jo h,}r (jq jr h1]h0]h.]h/]h4]uh6MWh7hh8]r hCXa Search
Search for:
r r }r (hUh j ubaubhd)r }r (hXMetacat's pathquery document can query specific fields of any XML document. The pathquery can also be used to specify which fields from each hit are returned and displayed in the search result set.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Msh7hh8]r hCXMetacat's pathquery document can query specific fields of any XML document. The pathquery can also be used to specify which fields from each hit are returned and displayed in the search result set.r r }r (hj h j ubaubjl )r }r (hX  unspecified unspecified dataset/title keyword dataset/creator/individualName/surName eml://ecoinformatics.org/eml-2.1.0 eml://ecoinformatics.org/eml-2.0.1 eml://ecoinformatics.org/eml-2.0.0 Charismatic megafauna dataset/title sea otter keyword Enhydra abstract/para h j h(h)h*jo h,}r (jq jr h1]h0]h.]h/]h4]uh6Myh7hh8]r hCX  unspecified unspecified dataset/title keyword dataset/creator/individualName/surName eml://ecoinformatics.org/eml-2.1.0 eml://ecoinformatics.org/eml-2.0.1 eml://ecoinformatics.org/eml-2.0.0 Charismatic megafauna dataset/title sea otter keyword Enhydra abstract/para r r }r (hUh j ubaubhd)r }r (hXEach ```` parameter specifies a field that the database will return (in addition to the fields Metacat returns by default) for each search result.h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r (hCXEach r r }r (hXEach h j ubj)r }r (hX````h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX r r }r (hUh j ubah*jubhCX parameter specifies a field that the database will return (in addition to the fields Metacat returns by default) for each search result.r r }r (hX parameter specifies a field that the database will return (in addition to the fields Metacat returns by default) for each search result.h j ubeubhd)r }r (hXThe ```` field limits the type of returned documents (eg, eml://ecoinformatics.org/eml-2.0.1 and/or eml://ecoinformatics.org/eml-2.0.0). If no returndoctype element is specified, all document types are returned.h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r (hCXThe r r }r (hXThe h j ubj)r }r (hX````h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXr r }r (hUh j ubah*jubhCX field limits the type of returned documents (eg, eml://ecoinformatics.org/eml-2.0.1 and/or eml://ecoinformatics.org/eml-2.0.0). If no returndoctype element is specified, all document types are returned.r r }r (hX field limits the type of returned documents (eg, eml://ecoinformatics.org/eml-2.0.1 and/or eml://ecoinformatics.org/eml-2.0.0). If no returndoctype element is specified, all document types are returned.h j ubeubhd)r }r (hX6A ```` creates an AND or an OR statement that applies to the nested ```` tags. The querygroup operator can be UNION or INTERSECT. A ```` defines the actual field (contained in ```` tags) against which the query (contained in the ```` tags) is being performed.h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r (hCXA r r }r (hXA h j ubj)r }r (hX````h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX r r }r (hUh j ubah*jubhCX> creates an AND or an OR statement that applies to the nested r r }r (hX> creates an AND or an OR statement that applies to the nested h j ubj)r }r (hX````h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX r r }r (hUh j ubah*jubhCX< tags. The querygroup operator can be UNION or INTERSECT. A r r }r (hX< tags. The querygroup operator can be UNION or INTERSECT. A h j ubj)r }r (hX````h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX r r }r (hUh j ubah*jubhCX( defines the actual field (contained in r r }r (hX( defines the actual field (contained in h j ubj)r }r (hX````h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX r r }r (hUh j ubah*jubhCX1 tags) against which the query (contained in the r r }r (hX1 tags) against which the query (contained in the h j ubj)r }r (hX ````h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXr r }r (hUh j ubah*jubhCX tags) is being performed.r r }r (hX tags) is being performed.h j ubeubhd)r }r (hXFThe ```` can also contain a document type keyword contained in ```` tags. The specified document type applies only to documents that are packaged together (e.g., a data set and its corresponding metadata file). If Metacat identifies the search term in a packaged document, the servlet will check to see if that document's type matches the specified one. If not, Metacat will check if one of the other documents in the package matches. If so, Metacat will return the matching document. For more information about packages, please see the developer documentation.h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r (hCXThe r r }r (hXThe h j ubj)r }r (hX````h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX r r }r (hUh j ubah*jubhCX7 can also contain a document type keyword contained in r r }r (hX7 can also contain a document type keyword contained in h j ubj)r }r! (hX````h,}r" (h.]h/]h0]h1]h4]uh j h8]r# hCX r$ r% }r& (hUh j ubah*jubhCX tags. The specified document type applies only to documents that are packaged together (e.g., a data set and its corresponding metadata file). If Metacat identifies the search term in a packaged document, the servlet will check to see if that document's type matches the specified one. If not, Metacat will check if one of the other documents in the package matches. If so, Metacat will return the matching document. For more information about packages, please see the developer documentation.r' r( }r) (hX tags. The specified document type applies only to documents that are packaged together (e.g., a data set and its corresponding metadata file). If Metacat identifies the search term in a packaged document, the servlet will check to see if that document's type matches the specified one. If not, Metacat will check if one of the other documents in the package matches. If so, Metacat will return the matching document. For more information about packages, please see the developer documentation.h j ubeubhd)r* }r+ (hXRAfter Metacat has processed a Pathquery document, it returns a resultset document.r, h j h(h)h*hsh,}r- (h.]h/]h0]h1]h4]uh6Mh7hh8]r. hCXRAfter Metacat has processed a Pathquery document, it returns a resultset document.r/ r0 }r1 (hj, h j* ubaubjl )r2 }r3 (hX3 unspecified unspecified dataset/title keyword dataset/creator/individualName/surName eml://ecoinformatics.org/eml-2.1.0 eml://ecoinformatics.org/eml-2.0.1 eml://ecoinformatics.org/eml-2.0.0 Charismatic megafauna dataset/title sea otter keyword Enhydra abstract/para nrs.569.3 eml eml://ecoinformatics.org/eml-2.0.0 2012-06-06 2012-06-06 Marine Mammal slides Bancroft knb-lter-sbc.61.1 eml eml://ecoinformatics.org/eml-2.1.0 2012-06-06 2012-06-06 Nelson Harrer Reed SBC LTER: Reef: Sightings of Sea Otters (Enhydra lutris) near Santa Barbara and Channel Islands, ongoing since 2007 ..... h j h(h)h*jo h,}r4 (jq jr h1]h0]h.]h/]h4]uh6Mh7hh8]r5 hCX3 unspecified unspecified dataset/title keyword dataset/creator/individualName/surName eml://ecoinformatics.org/eml-2.1.0 eml://ecoinformatics.org/eml-2.0.1 eml://ecoinformatics.org/eml-2.0.0 Charismatic megafauna dataset/title sea otter keyword Enhydra abstract/para nrs.569.3 eml eml://ecoinformatics.org/eml-2.0.0 2012-06-06 2012-06-06 Marine Mammal slides Bancroft knb-lter-sbc.61.1 eml eml://ecoinformatics.org/eml-2.1.0 2012-06-06 2012-06-06 Nelson Harrer Reed SBC LTER: Reef: Sightings of Sea Otters (Enhydra lutris) near Santa Barbara and Channel Islands, ongoing since 2007 ..... r6 r7 }r8 (hUh j2 ubaubhd)r9 }r: (hXWhen Metacat returns a resultset document, the servlet always includes the pathquery used to create it. The pathquery XML is contained in the tag, the first element in the resultset.r; h j h(h)h*hsh,}r< (h.]h/]h0]h1]h4]uh6Mh7hh8]r= hCXWhen Metacat returns a resultset document, the servlet always includes the pathquery used to create it. The pathquery XML is contained in the tag, the first element in the resultset.r> r? }r@ (hj; h j9 ubaubhd)rA }rB (hXEach XML document returned by the query is represented by a ```` tag. By default, Metacat will return the docid, docname, doctype, doctitle, createdate and updatedate for each search result. If the user specified additional return fields in the pathquery using ```` tags (e.g., dataset/title to return the document title), the additional fields are returned in ```` tags.h j h(h)h*hsh,}rC (h.]h/]h0]h1]h4]uh6Mh7hh8]rD (hCX<Each XML document returned by the query is represented by a rE rF }rG (hX<Each XML document returned by the query is represented by a h jA ubj)rH }rI (hX````h,}rJ (h.]h/]h0]h1]h4]uh jA h8]rK hCX rL rM }rN (hUh jH ubah*jubhCX tag. By default, Metacat will return the docid, docname, doctype, doctitle, createdate and updatedate for each search result. If the user specified additional return fields in the pathquery using rO rP }rQ (hX tag. By default, Metacat will return the docid, docname, doctype, doctitle, createdate and updatedate for each search result. If the user specified additional return fields in the pathquery using h jA ubj)rR }rS (hX````h,}rT (h.]h/]h0]h1]h4]uh jA h8]rU hCX rV rW }rX (hUh jR ubah*jubhCX` tags (e.g., dataset/title to return the document title), the additional fields are returned in rY rZ }r[ (hX` tags (e.g., dataset/title to return the document title), the additional fields are returned in h jA ubj)r\ }r] (hX ````h,}r^ (h.]h/]h0]h1]h4]uh jA h8]r_ hCXr` ra }rb (hUh j\ ubah*jubhCX tags.rc rd }re (hX tags.h jA ubeubhd)rf }rg (hXJMetacat can return the XML resultset to your client as either XML or HTML.rh h j h(h)h*hsh,}ri (h.]h/]h0]h1]h4]uh6Mh7hh8]rj hCXJMetacat can return the XML resultset to your client as either XML or HTML.rk rl }rm (hjh h jf ubaubeubh!)rn }ro (hUh jh(h)h*h+h,}rp (h.]h/]h0]h1]rq jLah4]rr hauh6Mh7hh8]rs (h:)rt }ru (hjQh jn h(h)h*h>h,}rv (h1]h0]h.]h/]h4]h@jKuh6Mh7hh8]rw hCXPaged Query Returnsrx ry }rz (hjQh jt ubaubhd)r{ }r| (hXDividing large search result sets over a number of pages speeds load-time and makes the result sets more readable to users (Figure 4.12). To break your search results into pages, use the query action's optional pagestart and pagesize parameters. The pagesize parameter indicates how many results should be returned for a given page. The pagestart parameter indicates which page you are currently viewing.r} h jn h(h)h*hsh,}r~ (h.]h/]h0]h1]h4]uh6Mh7hh8]r hCXDividing large search result sets over a number of pages speeds load-time and makes the result sets more readable to users (Figure 4.12). To break your search results into pages, use the query action's optional pagestart and pagesize parameters. The pagesize parameter indicates how many results should be returned for a given page. The pagestart parameter indicates which page you are currently viewing.r r }r (hj} h j{ ubaubjQ )r }r (hUh jn h(h)h*jT h,}r (jV Xcenterh1]r Uid7r ah0]h.]h/]h4]uh6Nh7hh8]r (jZ )r }r (hXf.. figure:: images/screenshots/image045.jpg :align: center An example of paged search results. h,}r (UuriXimages/screenshots/image045.jpgr h1]h0]h.]h/]j_ }r U*j sh4]uh j h8]h*ja ubjb )r }r (hX#An example of paged search results.r h j h(h)h*jf h,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX#An example of paged search results.r r }r (hj h j ubaubeubhd)r }r (hX#When a paged query is performed, the query's resultset contains four extra fields: pagestart, pagesize, nextpage, and previouspage (Figure 4.13). The nextpage and previouspage fields help Metacat generate navigational links in the rendered resultset using XSLT to transform the XML to HTML.r h jn h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r hCX#When a paged query is performed, the query's resultset contains four extra fields: pagestart, pagesize, nextpage, and previouspage (Figure 4.13). The nextpage and previouspage fields help Metacat generate navigational links in the rendered resultset using XSLT to transform the XML to HTML.r r }r (hj h j ubaubjl )r }r (hX 1 10 2 0 ... ... ... h jn h(h)h*jo h,}r (jq jr h1]h0]h.]h/]h4]uh6Mh7hh8]r hCX 1 10 2 0 ... ... ... r r }r (hUh j ubaubhd)r }r (hXThe HTML search results displayed in the figure were rendered using Kepler's XSLT, which can be found in lib/style/skins/kepler. Kepler's XSLT uses the four extra resultset fields to render the "Next" and "Previous" links.r h jn h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r hCXThe HTML search results displayed in the figure were rendered using Kepler's XSLT, which can be found in lib/style/skins/kepler. Kepler's XSLT uses the four extra resultset fields to render the "Next" and "Previous" links.r r }r (hj h j ubaubjl )r }r (hXPrevious Page Next Pageh jn h(h)h*jo h,}r (jq jr h1]h0]h.]h/]h4]uh6Mh7hh8]r hCXPrevious Page Next Pager r }r (hUh j ubaubhd)r }r (hXIn the example above, the current page is 1, and the previous page (page 0) and next page (page 2) pages are indicated by the values of the pagestart parameters.r h jn h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r hCXIn the example above, the current page is 1, and the previous page (page 0) and next page (page 2) pages are indicated by the values of the pagestart parameters.r r }r (hj h j ubaubeubh!)r }r (hUh jh(h)h*h+h,}r (h.]h/]h0]h1]r j_ah4]r hauh6Mh7hh8]r (h:)r }r (hjdh j h(h)h*h>h,}r (h1]h0]h.]h/]h4]h@j^uh6Mh7hh8]r hCXReading Data and Metadatar r }r (hjdh j ubaubhd)r }r (hXTo read data or metadata from Metacat, use the ``read`` action. The ``read`` action takes two parameters: ``docid``, which specifies the document ID of the document to return, and ``qformat``, which specifies the return format for the document (``html`` or ``xml`` or the name of a configured style-set, e.g., ``default``). If ``qformat`` is set to ``xml``, Metacat will return the XML document untransformed. If the return format is set to ``html``, Metacat will transform the XML document into HTML using the default XSLT style sheet (specified in the Metacat configuration). If the name of a style-set is specified, Metacat will use the XSLT styles specified in the set to transform the XML.h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r (hCX/To read data or metadata from Metacat, use the r r }r (hX/To read data or metadata from Metacat, use the h j ubj)r }r (hX``read``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXreadr r }r (hUh j ubah*jubhCX action. The r r }r (hX action. The h j ubj)r }r (hX``read``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXreadr r }r (hUh j ubah*jubhCX action takes two parameters: r r }r (hX action takes two parameters: h j ubj)r }r (hX ``docid``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXdocidr r }r (hUh j ubah*jubhCXA, which specifies the document ID of the document to return, and r r }r (hXA, which specifies the document ID of the document to return, and h j ubj)r }r (hX ``qformat``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXqformatr r }r (hUh j ubah*jubhCX6, which specifies the return format for the document (r r }r (hX6, which specifies the return format for the document (h j ubj)r }r (hX``html``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXhtmlr r }r (hUh j ubah*jubhCX or r r }r (hX or h j ubj)r }r (hX``xml``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXxmlr r }r (hUh j ubah*jubhCX. or the name of a configured style-set, e.g., r r }r (hX. or the name of a configured style-set, e.g., h j ubj)r }r (hX ``default``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXdefaultr r }r (hUh j ubah*jubhCX). If r r }r (hX). If h j ubj)r }r (hX ``qformat``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXqformatr r }r (hUh j ubah*jubhCX is set to r r }r (hX is set to h j ubj)r }r! (hX``xml``h,}r" (h.]h/]h0]h1]h4]uh j h8]r# hCXxmlr$ r% }r& (hUh j ubah*jubhCXU, Metacat will return the XML document untransformed. If the return format is set to r' r( }r) (hXU, Metacat will return the XML document untransformed. If the return format is set to h j ubj)r* }r+ (hX``html``h,}r, (h.]h/]h0]h1]h4]uh j h8]r- hCXhtmlr. r/ }r0 (hUh j* ubah*jubhCX, Metacat will transform the XML document into HTML using the default XSLT style sheet (specified in the Metacat configuration). If the name of a style-set is specified, Metacat will use the XSLT styles specified in the set to transform the XML.r1 r2 }r3 (hX, Metacat will transform the XML document into HTML using the default XSLT style sheet (specified in the Metacat configuration). If the name of a style-set is specified, Metacat will use the XSLT styles specified in the set to transform the XML.h j ubeubjQ )r4 }r5 (hUh j h(h)h*jT h,}r6 (jV Xcenterh1]r7 Uid8r8 ah0]h.]h/]h4]uh6Nh7hh8]r9 (jZ )r: }r; (hX.. figure:: images/screenshots/image047.jpg :align: center The same document displayed using different qformat parameters (from left to right: the default style-set, XML, and HTML). h,}r< (UuriXimages/screenshots/image047.jpgr= h1]h0]h.]h/]j_ }r> U*j= sh4]uh j4 h8]h*ja ubjb )r? }r@ (hXzThe same document displayed using different qformat parameters (from left to right: the default style-set, XML, and HTML).rA h j4 h(h)h*jf h,}rB (h.]h/]h0]h1]h4]uh6M)h8]rC hCXzThe same document displayed using different qformat parameters (from left to right: the default style-set, XML, and HTML).rD rE }rF (hjA h j? ubaubeubhd)rG }rH (hXNote that the ``read`` action can be used to read both data files and metadata files. To read a data file, you could use the following request::h j h(h)h*hsh,}rI (h.]h/]h0]h1]h4]uh6M,h7hh8]rJ (hCXNote that the rK rL }rM (hXNote that the h jG ubj)rN }rO (hX``read``h,}rP (h.]h/]h0]h1]h4]uh jG h8]rQ hCXreadrR rS }rT (hUh jN ubah*jubhCXy action can be used to read both data files and metadata files. To read a data file, you could use the following request:rU rV }rW (hXy action can be used to read both data files and metadata files. To read a data file, you could use the following request:h jG ubeubjl )rX }rY (hXThttp://yourserver.com/yourcontext/metacat?action=read&docid=nceas.55&qformat=defaulth j h(h)h*jo h,}rZ (jq jr h1]h0]h.]h/]h4]uh6M/h7hh8]r[ hCXThttp://yourserver.com/yourcontext/metacat?action=read&docid=nceas.55&qformat=defaultr\ r] }r^ (hUh jX ubaubhd)r_ }r` (hXWhere ``nceas.55`` is the docid of the data file stored in the Metacat and ``default`` is the name of the style (you could also use "html" or "xml" or the name of a customized skin).h j h(h)h*hsh,}ra (h.]h/]h0]h1]h4]uh6M1h7hh8]rb (hCXWhere rc rd }re (hXWhere h j_ ubj)rf }rg (hX ``nceas.55``h,}rh (h.]h/]h0]h1]h4]uh j_ h8]ri hCXnceas.55rj rk }rl (hUh jf ubah*jubhCX9 is the docid of the data file stored in the Metacat and rm rn }ro (hX9 is the docid of the data file stored in the Metacat and h j_ ubj)rp }rq (hX ``default``h,}rr (h.]h/]h0]h1]h4]uh j_ h8]rs hCXdefaultrt ru }rv (hUh jp ubah*jubhCX` is the name of the style (you could also use "html" or "xml" or the name of a customized skin).rw rx }ry (hX` is the name of the style (you could also use "html" or "xml" or the name of a customized skin).h j_ ubeubjl )rz }r{ (hXr Read Document
h j h(h)h*jo h,}r| (jq jr h1]h0]h.]h/]h4]uh6M7h7hh8]r} hCXr Read Document
r~ r }r (hUh jz ubaubeubeubh!)r }r (hUh h&h(h)h*h+h,}r (h.]h/]h0]h1]r jrah4]r h auh6MFh7hh8]r (h:)r }r (hjwh j h(h)h*h>h,}r (h1]h0]h.]h/]h4]h@jquh6MFh7hh8]r hCX%Using the EarthGrid API (aka EcoGrid)r r }r (hjwh j ubaubcdocutils.nodes note r )r }r (hXThe EarthGrid/EcoGrid web service API is *deprecated* as of Metacat 2.0.0 and will be removed from a future version of Metacat. Its functionality is being replaced by the standardized DataONE REST service interface. The EarthGrid API will be completely removed by the end of 2013.h j h(h)h*Unoter h,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r hd)r }r (hXThe EarthGrid/EcoGrid web service API is *deprecated* as of Metacat 2.0.0 and will be removed from a future version of Metacat. Its functionality is being replaced by the standardized DataONE REST service interface. The EarthGrid API will be completely removed by the end of 2013.h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6MJh8]r (hCX)The EarthGrid/EcoGrid web service API is r r }r (hX)The EarthGrid/EcoGrid web service API is h j ubcdocutils.nodes emphasis r )r }r (hX *deprecated*h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX deprecatedr r }r (hUh j ubah*Uemphasisr ubhCX as of Metacat 2.0.0 and will be removed from a future version of Metacat. Its functionality is being replaced by the standardized DataONE REST service interface. The EarthGrid API will be completely removed by the end of 2013.r r }r (hX as of Metacat 2.0.0 and will be removed from a future version of Metacat. Its functionality is being replaced by the standardized DataONE REST service interface. The EarthGrid API will be completely removed by the end of 2013.h j ubeubaubhd)r }r (hXlThe EarthGrid (aka EcoGrid) provides access to disparate data on different networks (e.g., KNB, GBIF, GEON) and storage systems (e.g., Metacat and SRB), allowing scientists access to a wide variety of data and analytic resources (e.g., data, metadata, analytic workflows and processors) networked at different sites and at different organizations via the internet.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6MOh7hh8]r hCXlThe EarthGrid (aka EcoGrid) provides access to disparate data on different networks (e.g., KNB, GBIF, GEON) and storage systems (e.g., Metacat and SRB), allowing scientists access to a wide variety of data and analytic resources (e.g., data, metadata, analytic workflows and processors) networked at different sites and at different organizations via the internet.r r }r (hj h j ubaubhd)r }r (hXBecause Metacat supports the EarthGrid API (see table), it can query the distributed EarthGrid, retrieve metadata and data results, and write new and updated metadata and data back to the grid nodes.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6MUh7hh8]r hCXBecause Metacat supports the EarthGrid API (see table), it can query the distributed EarthGrid, retrieve metadata and data results, and write new and updated metadata and data back to the grid nodes.r r }r (hj h j ubaubhd)r }r (hXFor more information about each EarthGrid service and its WSDL file, navigate to the "services" page on your Metacat server (e.g., http://knb.ecoinformatics.org/metacat/services). Note that the AdminService and Version service that appear on this page are not part of EarthGrid.h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6MYh7hh8]r (hCXFor more information about each EarthGrid service and its WSDL file, navigate to the "services" page on your Metacat server (e.g., r r }r (hXFor more information about each EarthGrid service and its WSDL file, navigate to the "services" page on your Metacat server (e.g., h j ubhi)r }r (hX.http://knb.ecoinformatics.org/metacat/servicesr h,}r (Urefurij h1]h0]h.]h/]h4]uh j h8]r hCX.http://knb.ecoinformatics.org/metacat/servicesr r }r (hUh j ubah*hrubhCXe). Note that the AdminService and Version service that appear on this page are not part of EarthGrid.r r }r (hXe). Note that the AdminService and Version service that appear on this page are not part of EarthGrid.h j ubeubhd)r }r (hXEarthGrid/EcoGrid API Summaryr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M_h7hh8]r hCXEarthGrid/EcoGrid API Summaryr r }r (hj h j ubaubj)r }r (hUh j h(h)h*jh,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r j)r }r (hUh,}r (h1]h0]h.]h/]h4]UcolsKuh j h8]r (j)r }r (hUh,}r (h1]h0]h.]h/]h4]UcolwidthKuh j h8]h*jubj)r }r (hUh,}r (h1]h0]h.]h/]h4]UcolwidthKeuh j h8]h*jubj)r }r (hUh,}r (h.]h/]h0]h1]h4]uh j h8]r j)r }r (hUh,}r (h.]h/]h0]h1]h4]uh j h8]r (j)r }r (hUh,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (hXServicer h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mbh8]r hCXServicer r }r (hj h j ubaubah*jubj)r }r (hUh,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (hX Descriptionr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mbh8]r hCX Descriptionr r }r (hj h j ubaubah*jubeh*jubah*jubj)r }r(hUh,}r(h.]h/]h0]h1]h4]uh j h8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh j h8]r(j)r}r(hUh,}r (h.]h/]h0]h1]h4]uh jh8]r hd)r }r (hXAuthenticationQueryServicer h jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mdh8]rhCXAuthenticationQueryServicerr}r(hj h j ubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hX`Search for and retrieve protected metadata and data from the EarthGrid as an authenticated user.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mdh8]rhCX`Search for and retrieve protected metadata and data from the EarthGrid as an authenticated user.rr}r(hjh jubaubhd)r}r (hXMethods: ``query``, ``get``h jh(h)h*hsh,}r!(h.]h/]h0]h1]h4]uh6Mfh8]r"(hCX Methods: r#r$}r%(hX Methods: h jubj)r&}r'(hX ``query``h,}r((h.]h/]h0]h1]h4]uh jh8]r)hCXqueryr*r+}r,(hUh j&ubah*jubhCX, r-r.}r/(hX, h jubj)r0}r1(hX``get``h,}r2(h.]h/]h0]h1]h4]uh jh8]r3hCXgetr4r5}r6(hUh j0ubah*jubeubeh*jubeh*jubj)r7}r8(hUh,}r9(h.]h/]h0]h1]h4]uh j h8]r:(j)r;}r<(hUh,}r=(h.]h/]h0]h1]h4]uh j7h8]r>hd)r?}r@(hXAuthenticationServicerAh j;h(h)h*hsh,}rB(h.]h/]h0]h1]h4]uh6Mhh8]rChCXAuthenticationServicerDrE}rF(hjAh j?ubaubah*jubj)rG}rH(hUh,}rI(h.]h/]h0]h1]h4]uh j7h8]rJ(hd)rK}rL(hXLog in and out of the EarthGridrMh jGh(h)h*hsh,}rN(h.]h/]h0]h1]h4]uh6Mhh8]rOhCXLog in and out of the EarthGridrPrQ}rR(hjMh jKubaubhd)rS}rT(hXMethods: ``login``, ``logout``h jGh(h)h*hsh,}rU(h.]h/]h0]h1]h4]uh6Mjh8]rV(hCX Methods: rWrX}rY(hX Methods: h jSubj)rZ}r[(hX ``login``h,}r\(h.]h/]h0]h1]h4]uh jSh8]r]hCXloginr^r_}r`(hUh jZubah*jubhCX, rarb}rc(hX, h jSubj)rd}re(hX ``logout``h,}rf(h.]h/]h0]h1]h4]uh jSh8]rghCXlogoutrhri}rj(hUh jdubah*jubeubeh*jubeh*jubj)rk}rl(hUh,}rm(h.]h/]h0]h1]h4]uh j h8]rn(j)ro}rp(hUh,}rq(h.]h/]h0]h1]h4]uh jkh8]rrhd)rs}rt(hXIdentifierServiceruh joh(h)h*hsh,}rv(h.]h/]h0]h1]h4]uh6Mlh8]rwhCXIdentifierServicerxry}rz(hjuh jsubaubah*jubj)r{}r|(hUh,}r}(h.]h/]h0]h1]h4]uh jkh8]r~(hd)r}r(hXQList, lookup, validate, and add Life Science Identifiers (LSIDs) to the EarthGridrh j{h(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mlh8]rhCXQList, lookup, validate, and add Life Science Identifiers (LSIDs) to the EarthGridrr}r(hjh jubaubhd)r}r(hX]Methods: ``isRegistered``, ``addLSID``, ``getNextRevision``, ``getNextObject``, ``getAllIds``h j{h(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mnh8]r(hCX Methods: rr}r(hX Methods: h jubj)r}r(hX``isRegistered``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCX isRegisteredrr}r(hUh jubah*jubhCX, rr}r(hX, h jubj)r}r(hX ``addLSID``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXaddLSIDrr}r(hUh jubah*jubhCX, rr}r(hX, h jubj)r}r(hX``getNextRevision``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXgetNextRevisionrr}r(hUh jubah*jubhCX, rr}r(hX, h jubj)r}r(hX``getNextObject``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCX getNextObjectrr}r(hUh jubah*jubhCX, rr}r(hX, h jubj)r}r(hX ``getAllIds``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCX getAllIdsrr}r(hUh jubah*jubeubeh*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh j h8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX PutServicerh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mph8]rhCX PutServicerr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hXWrite metadata to the EarthGridrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mph8]rhCXWrite metadata to the EarthGridrr}r(hjh jubaubhd)r}r(hXMethods: ``put``h jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mrh8]r(hCX Methods: rr}r(hX Methods: h jubj)r}r(hX``put``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXputrr}r(hUh jubah*jubeubeh*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh j h8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX QueryServicerh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mth8]rhCX QueryServicerr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hX3Search for and retrieve metadata from the EarthGridrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mth8]rhCX3Search for and retrieve metadata from the EarthGridrr}r(hjh jubaubhd)r}r(hXMethods: ``query``, ``get``h jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mvh8]r(hCX Methods: rr}r (hX Methods: h jubj)r }r (hX ``query``h,}r (h.]h/]h0]h1]h4]uh jh8]r hCXqueryrr}r(hUh j ubah*jubhCX, rr}r(hX, h jubj)r}r(hX``get``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXgetrr}r(hUh jubah*jubeubeh*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh j h8]r(j)r}r (hUh,}r!(h.]h/]h0]h1]h4]uh jh8]r"hd)r#}r$(hXRegistryServicer%h jh(h)h*hsh,}r&(h.]h/]h0]h1]h4]uh6Mxh8]r'hCXRegistryServicer(r)}r*(hj%h j#ubaubah*jubj)r+}r,(hUh,}r-(h.]h/]h0]h1]h4]uh jh8]r.(hd)r/}r0(hXAdd, update, remove, and search for registered EarthGrid services. Note: The WSDL for this service is found under http://ecogrid.ecoinformatics.org/registry/servicesh j+h(h)h*hsh,}r1(h.]h/]h0]h1]h4]uh6Mxh8]r2(hCXsAdd, update, remove, and search for registered EarthGrid services. Note: The WSDL for this service is found under r3r4}r5(hXsAdd, update, remove, and search for registered EarthGrid services. Note: The WSDL for this service is found under h j/ubhi)r6}r7(hX3http://ecogrid.ecoinformatics.org/registry/servicesr8h,}r9(Urefurij8h1]h0]h.]h/]h4]uh j/h8]r:hCX3http://ecogrid.ecoinformatics.org/registry/servicesr;r<}r=(hUh j6ubah*hrubeubhd)r>}r?(hX=Methods: ``add``, ``update``, ``remove``, ``list``, ``query``h j+h(h)h*hsh,}r@(h.]h/]h0]h1]h4]uh6M{h8]rA(hCX Methods: rBrC}rD(hX Methods: h j>ubj)rE}rF(hX``add``h,}rG(h.]h/]h0]h1]h4]uh j>h8]rHhCXaddrIrJ}rK(hUh jEubah*jubhCX, rLrM}rN(hX, h j>ubj)rO}rP(hX ``update``h,}rQ(h.]h/]h0]h1]h4]uh j>h8]rRhCXupdaterSrT}rU(hUh jOubah*jubhCX, rVrW}rX(hX, h j>ubj)rY}rZ(hX ``remove``h,}r[(h.]h/]h0]h1]h4]uh j>h8]r\hCXremover]r^}r_(hUh jYubah*jubhCX, r`ra}rb(hX, h j>ubj)rc}rd(hX``list``h,}re(h.]h/]h0]h1]h4]uh j>h8]rfhCXlistrgrh}ri(hUh jcubah*jubhCX, rjrk}rl(hX, h j>ubj)rm}rn(hX ``query``h,}ro(h.]h/]h0]h1]h4]uh j>h8]rphCXqueryrqrr}rs(hUh jmubah*jubeubeh*jubeh*jubeh*jJubeh*jKubaubeubh!)rt}ru(hUh h&h(h)h*h+h,}rv(h.]h/]h0]h1]rwjah4]rxhauh6Mh7hh8]ry(h:)rz}r{(hjh jth(h)h*h>h,}r|(h1]h0]h.]h/]h4]h@juh6Mh7hh8]r}hCX Using Morphor~r}r(hjh jzubaubhd)r}r(hXHMorpho is a desktop tool created to facilitate the creation, storage, and retrieval of metadata. Morpho interfaces with any Metacat server, allowing users to upload, download, store, query and view relevant metadata and data using the network. Users can authorize the public or only selected colleagues to view their data files.rh jth(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh7hh8]rhCXHMorpho is a desktop tool created to facilitate the creation, storage, and retrieval of metadata. Morpho interfaces with any Metacat server, allowing users to upload, download, store, query and view relevant metadata and data using the network. Users can authorize the public or only selected colleagues to view their data files.rr}r(hjh jubaubhd)r}r(hXMorpho is part of the Knowledge Network for Biocomplexity (KNB), a national network intended to facilitate ecological and environmental research on biocomplexity. To use Morpho with your Metacat, set the Metacat URL in the Morpho Preferences to point to your Metacat server.rh jth(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh7hh8]rhCXMorpho is part of the Knowledge Network for Biocomplexity (KNB), a national network intended to facilitate ecological and environmental research on biocomplexity. To use Morpho with your Metacat, set the Metacat URL in the Morpho Preferences to point to your Metacat server.rr}r(hjh jubaubjQ )r}r(hUh jth(h)h*jT h,}r(jV Xcenterh1]rUid9rah0]h.]h/]h4]uh6Nh7hh8]r(jZ )r}r(hX.. figure:: images/screenshots/image049.png :align: center Set the Metacat URL in the Morpho preferences to point to your Metacat. h,}r(UuriXimages/screenshots/image049.pngrh1]h0]h.]h/]j_ }rU*jsh4]uh jh8]h*ja ubjb )r}r(hXGSet the Metacat URL in the Morpho preferences to point to your Metacat.rh jh(h)h*jf h,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXGSet the Metacat URL in the Morpho preferences to point to your Metacat.rr}r(hjh jubaubeubhd)r}r(hXMFor more information about Morpho, please see: http://knb.ecoinformatics.org/rh jth(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh7hh8]r(hCX/For more information about Morpho, please see: rr}r(hX/For more information about Morpho, please see: h jubhi)r}r(hXhttp://knb.ecoinformatics.org/rh,}r(Urefurijh1]h0]h.]h/]h4]uh jh8]rhCXhttp://knb.ecoinformatics.org/rr}r(hUh jubah*hrubeubeubh!)r}r(hUh h&h(h)h*h+h,}r(h.]h/]h0]h1]rjah4]rh auh6Mh7hh8]r(h:)r}r(hjh jh(h)h*h>h,}r(h1]h0]h.]h/]h4]h@juh6Mh7hh8]rhCXCreating Your Own Clientrr}r(hjh jubaubj )r}r(hXNOTE: The Client API (and underlying servlet implementation) has been deprecated as of Metacat 2.0.0. Future development should utilize the DataONE REST service methods. The Client API will be completely removed by the end of 2013.h jh(h)h*j h,}r(h.]h/]h0]h1]h4]uh6Nh7hh8]rhd)r}r(hXNOTE: The Client API (and underlying servlet implementation) has been deprecated as of Metacat 2.0.0. Future development should utilize the DataONE REST service methods. The Client API will be completely removed by the end of 2013.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXNOTE: The Client API (and underlying servlet implementation) has been deprecated as of Metacat 2.0.0. Future development should utilize the DataONE REST service methods. The Client API will be completely removed by the end of 2013.rr}r(hjh jubaubaubhd)r}r(hXMetacat's client API is available in Java and Perl (the Java interface is described in this section and further detailed in the appendix). Some of the API is also available in Python and Ruby. The API allows client applications to easily authenticate users and perform basic Metacat operations such as reading metadata and data files; inserting, updating, and deleting files; and searching for packages based on metadata matches.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh7hh8]rhCXMetacat's client API is available in Java and Perl (the Java interface is described in this section and further detailed in the appendix). Some of the API is also available in Python and Ruby. The API allows client applications to easily authenticate users and perform basic Metacat operations such as reading metadata and data files; inserting, updating, and deleting files; and searching for packages based on metadata matches.rr}r(hjh jubaubhd)r}r(hX~The Client API is defined by the interface edu.ucsb.nceas.metacat.client.Metacat, and all operations are fully defined in the javadoc_ documentation. To use the client API, include the ``metacat-client.jar``, ``utilities.jar``, ``commons-io-2.0.jar``, and ``httpclient.jar`` in your classpath. After including these classes, you can begin using the API methods (see the next table).h jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh7hh8]r(hCX~The Client API is defined by the interface edu.ucsb.nceas.metacat.client.Metacat, and all operations are fully defined in the rr}r(hX~The Client API is defined by the interface edu.ucsb.nceas.metacat.client.Metacat, and all operations are fully defined in the h jubhi)r}r(hXjavadoc_UresolvedrKh jh*hrh,}r(UnameXjavadocrUrefurirXAhttp://knb.ecoinformatics.org/software/metacat/dev/api/index.htmlrh1]h0]h.]h/]h4]uh8]rhCXjavadocrr}r(hUh jubaubhCX3 documentation. To use the client API, include the rr}r(hX3 documentation. To use the client API, include the h jubj)r}r(hX``metacat-client.jar``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXmetacat-client.jarrr}r(hUh jubah*jubhCX, rr}r(hX, h jubj)r}r(hX``utilities.jar``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCX utilities.jarrr}r(hUh jubah*jubhCX, rr}r(hX, h jubj)r}r(hX``commons-io-2.0.jar``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXcommons-io-2.0.jarrr}r(hUh jubah*jubhCX, and rr}r(hX, and h jubj)r}r (hX``httpclient.jar``h,}r (h.]h/]h0]h1]h4]uh jh8]r hCXhttpclient.jarr r }r(hUh jubah*jubhCXl in your classpath. After including these classes, you can begin using the API methods (see the next table).rr}r(hXl in your classpath. After including these classes, you can begin using the API methods (see the next table).h jubeubcdocutils.nodes target r)r}r(hXN.. _javadoc: http://knb.ecoinformatics.org/software/metacat/dev/api/index.htmlU referencedrKh jh(h)h*Utargetrh,}r(jjh1]rUjavadocrah0]h.]h/]h4]rhauh6Mh7hh8]ubhd)r}r(hXrThe following code block displays a typical session for reading a document from Metacat using the Java client API.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh7hh8]rhCXrThe following code block displays a typical session for reading a document from Metacat using the Java client API.r r!}r"(hjh jubaubjl )r#}r$(hXString metacatUrl = "http://foo.com/context/metacat"; String username = "uid=jones,o=NCEAS,dc=ecoinformatics,dc=org"; String password = "neverHarcodeAPasswordInCode"; try { Metacat m = MetacatFactory.createMetacatConnection(metacatUrl); m.login(username, password); Reader r = m.read("testdocument.1.1"); // Do whatever you want with Reader r } catch (MetacatAuthException mae) { handleError("Authorization failed:\n" + mae.getMessage()); } catch (MetacatInaccessibleException mie) { handleError("Metacat Inaccessible:\n" + mie.getMessage()); } catch (Exception e) { handleError("General exception:\n" + e.getMessage()); } Operations provided by Client API (Metacat.java class)h jh(h)h*jo h,}r%(jq jr h1]h0]h.]h/]h4]uh6Mh7hh8]r&hCXString metacatUrl = "http://foo.com/context/metacat"; String username = "uid=jones,o=NCEAS,dc=ecoinformatics,dc=org"; String password = "neverHarcodeAPasswordInCode"; try { Metacat m = MetacatFactory.createMetacatConnection(metacatUrl); m.login(username, password); Reader r = m.read("testdocument.1.1"); // Do whatever you want with Reader r } catch (MetacatAuthException mae) { handleError("Authorization failed:\n" + mae.getMessage()); } catch (MetacatInaccessibleException mie) { handleError("Metacat Inaccessible:\n" + mie.getMessage()); } catch (Exception e) { handleError("General exception:\n" + e.getMessage()); } Operations provided by Client API (Metacat.java class)r'r(}r)(hUh j#ubaubj)r*}r+(hUh jh(h)h*jh,}r,(h.]h/]h0]h1]h4]uh6Nh7hh8]r-j)r.}r/(hUh,}r0(h1]h0]h.]h/]h4]UcolsKuh j*h8]r1(j)r2}r3(hUh,}r4(h1]h0]h.]h/]h4]UcolwidthKuh j.h8]h*jubj)r5}r6(hUh,}r7(h1]h0]h.]h/]h4]UcolwidthKuh j.h8]h*jubj)r8}r9(hUh,}r:(h1]h0]h.]h/]h4]UcolwidthKuh j.h8]h*jubj)r;}r<(hUh,}r=(h.]h/]h0]h1]h4]uh j.h8]r>j)r?}r@(hUh,}rA(h.]h/]h0]h1]h4]uh j;h8]rB(j)rC}rD(hUh,}rE(h.]h/]h0]h1]h4]uh j?h8]rFhd)rG}rH(hXMethodrIh jCh(h)h*hsh,}rJ(h.]h/]h0]h1]h4]uh6Mh8]rKhCXMethodrLrM}rN(hjIh jGubaubah*jubj)rO}rP(hUh,}rQ(h.]h/]h0]h1]h4]uh j?h8]rRhd)rS}rT(hXParameters and ThrowsrUh jOh(h)h*hsh,}rV(h.]h/]h0]h1]h4]uh6Mh8]rWhCXParameters and ThrowsrXrY}rZ(hjUh jSubaubah*jubj)r[}r\(hUh,}r](h.]h/]h0]h1]h4]uh j?h8]r^hd)r_}r`(hX Descriptionrah j[h(h)h*hsh,}rb(h.]h/]h0]h1]h4]uh6Mh8]rchCX Descriptionrdre}rf(hjah j_ubaubah*jubeh*jubah*jubj)rg}rh(hUh,}ri(h.]h/]h0]h1]h4]uh j.h8]rj(j)rk}rl(hUh,}rm(h.]h/]h0]h1]h4]uh jgh8]rn(j)ro}rp(hUh,}rq(h.]h/]h0]h1]h4]uh jkh8]rrhd)rs}rt(hXdeleteruh joh(h)h*hsh,}rv(h.]h/]h0]h1]h4]uh6Mh8]rwhCXdeleterxry}rz(hjuh jsubaubah*jubj)r{}r|(hUh,}r}(h.]h/]h0]h1]h4]uh jkh8]r~hd)r}r(hXy``public String delete(String docid) throws InsufficientKarmaException, MetacatException, MetacatInaccessibleException;``rh j{h(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rj)r}r(hjh,}r(h.]h/]h0]h1]h4]uh jh8]rhCXupublic String delete(String docid) throws InsufficientKarmaException, MetacatException, MetacatInaccessibleException;rr}r(hUh jubah*jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jkh8]rhd)r}r(hX)Delete an XML document in the repository.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX)Delete an XML document in the repository.rr}r(hjh jubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jgh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX getAllDocidsrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX getAllDocidsrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXE``public Vector getAllDocids(String scope) throws MetacatException;``rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rj)r}r(hjh,}r(h.]h/]h0]h1]h4]uh jh8]rhCXApublic Vector getAllDocids(String scope) throws MetacatException;rr}r(hUh jubah*jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXsReturn a list of all docids that match a given scope. If scope is null, return all docids registered in the system.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXsReturn a list of all docids that match a given scope. If scope is null, return all docids registered in the system.rr}r(hjh jubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jgh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX getLastDocidrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX getLastDocidrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXE``public String getLastDocid(String scope) throws MetacatException;``rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rj)r}r(hjh,}r(h.]h/]h0]h1]h4]uh jh8]rhCXApublic String getLastDocid(String scope) throws MetacatException;rr}r(hUh jubah*jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXReturn the highest document ID for a given scope. Used by clients to determine the next free identifier in a sequence for a given scope.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXReturn the highest document ID for a given scope. Used by clients to determine the next free identifier in a sequence for a given scope.rr}r(hjh jubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jgh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXgetloggedinuserinforh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXgetloggedinuserinforr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXL``public String getloggedinuserinfo() throws MetacatInaccessibleException;``rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rj)r}r (hjh,}r (h.]h/]h0]h1]h4]uh jh8]r hCXHpublic String getloggedinuserinfo() throws MetacatInaccessibleException;r r }r(hUh jubah*jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX+Return the logged in user for this session.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX+Return the logged in user for this session.rr}r(hjh jubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jgh8]r(j)r}r (hUh,}r!(h.]h/]h0]h1]h4]uh jh8]r"hd)r#}r$(hXgetNewestDocRevisionr%h jh(h)h*hsh,}r&(h.]h/]h0]h1]h4]uh6Mh8]r'hCXgetNewestDocRevisionr(r)}r*(hj%h j#ubaubah*jubj)r+}r,(hUh,}r-(h.]h/]h0]h1]h4]uh jh8]r.hd)r/}r0(hXJ``public int getNewestDocRevision(String docId) throws MetacatException;``r1h j+h(h)h*hsh,}r2(h.]h/]h0]h1]h4]uh6Mh8]r3j)r4}r5(hj1h,}r6(h.]h/]h0]h1]h4]uh j/h8]r7hCXFpublic int getNewestDocRevision(String docId) throws MetacatException;r8r9}r:(hUh j4ubah*jubaubah*jubj)r;}r<(hUh,}r=(h.]h/]h0]h1]h4]uh jh8]r>hd)r?}r@(hXAReturn the latest revision of specified the document from MetacatrAh j;h(h)h*hsh,}rB(h.]h/]h0]h1]h4]uh6Mh8]rChCXAReturn the latest revision of specified the document from MetacatrDrE}rF(hjAh j?ubaubah*jubeh*jubj)rG}rH(hUh,}rI(h.]h/]h0]h1]h4]uh jgh8]rJ(j)rK}rL(hUh,}rM(h.]h/]h0]h1]h4]uh jGh8]rNhd)rO}rP(hX getSessonIdrQh jKh(h)h*hsh,}rR(h.]h/]h0]h1]h4]uh6Mh8]rShCX getSessonIdrTrU}rV(hjQh jOubaubah*jubj)rW}rX(hUh,}rY(h.]h/]h0]h1]h4]uh jGh8]rZhd)r[}r\(hX!``public String getSessionId();``r]h jWh(h)h*hsh,}r^(h.]h/]h0]h1]h4]uh6Mh8]r_j)r`}ra(hj]h,}rb(h.]h/]h0]h1]h4]uh j[h8]rchCXpublic String getSessionId();rdre}rf(hUh j`ubah*jubaubah*jubj)rg}rh(hUh,}ri(h.]h/]h0]h1]h4]uh jGh8]rjhd)rk}rl(hX/Return the session identifier for this session.rmh jgh(h)h*hsh,}rn(h.]h/]h0]h1]h4]uh6Mh8]rohCX/Return the session identifier for this session.rprq}rr(hjmh jkubaubah*jubeh*jubj)rs}rt(hUh,}ru(h.]h/]h0]h1]h4]uh jgh8]rv(j)rw}rx(hUh,}ry(h.]h/]h0]h1]h4]uh jsh8]rzhd)r{}r|(hXinsertr}h jwh(h)h*hsh,}r~(h.]h/]h0]h1]h4]uh6Mh8]rhCXinsertrr}r(hj}h j{ubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jsh8]rhd)r}r(hX``public String insert(String docid, Reader xmlDocument, Reader schema) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;``rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rj)r}r(hjh,}r(h.]h/]h0]h1]h4]uh jh8]rhCXpublic String insert(String docid, Reader xmlDocument, Reader schema) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;rr}r(hUh jubah*jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jsh8]rhd)r}r(hX+Insert an XML document into the repository.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX+Insert an XML document into the repository.rr}r(hjh jubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jgh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX isRegisteredrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX isRegisteredrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXF``public boolean isRegistered(String docid) throws MetacatException;``rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rj)r}r(hjh,}r(h.]h/]h0]h1]h4]uh jh8]rhCXBpublic boolean isRegistered(String docid) throws MetacatException;rr}r(hUh jubah*jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX7Return true if given docid is registered; false if not.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX7Return true if given docid is registered; false if not.rr}r(hjh jubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jgh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXloginrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXloginrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXt``public String login(String username, String password) throws MetacatAuthException, MetacatInaccessibleException;``rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rj)r}r(hjh,}r(h.]h/]h0]h1]h4]uh jh8]rhCXppublic String login(String username, String password) throws MetacatAuthException, MetacatInaccessibleException;rr}r(hUh jubah*jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXLog in to a Metacat server.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXLog in to a Metacat server.rr}r(hjh jubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jgh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXlogoutrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXlogoutrr}r(hjh jubaubah*jubj)r}r(hUh,}r (h.]h/]h0]h1]h4]uh jh8]r hd)r }r (hXQ``public String logout() throws MetacatInaccessibleException, MetacatException;``r h jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rj)r}r(hj h,}r(h.]h/]h0]h1]h4]uh j h8]rhCXMpublic String logout() throws MetacatInaccessibleException, MetacatException;rr}r(hUh jubah*jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXLog out of a Metacat server.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXLog out of a Metacat server.r r!}r"(hjh jubaubah*jubeh*jubj)r#}r$(hUh,}r%(h.]h/]h0]h1]h4]uh jgh8]r&(j)r'}r((hUh,}r)(h.]h/]h0]h1]h4]uh j#h8]r*hd)r+}r,(hXqueryr-h j'h(h)h*hsh,}r.(h.]h/]h0]h1]h4]uh6Mh8]r/hCXqueryr0r1}r2(hj-h j+ubaubah*jubj)r3}r4(hUh,}r5(h.]h/]h0]h1]h4]uh j#h8]r6hd)r7}r8(hXZ``public Reader query(Reader xmlQuery) throws MetacatInaccessibleException, IOException;``r9h j3h(h)h*hsh,}r:(h.]h/]h0]h1]h4]uh6Mh8]r;j)r<}r=(hj9h,}r>(h.]h/]h0]h1]h4]uh j7h8]r?hCXVpublic Reader query(Reader xmlQuery) throws MetacatInaccessibleException, IOException;r@rA}rB(hUh j<ubah*jubaubah*jubj)rC}rD(hUh,}rE(h.]h/]h0]h1]h4]uh j#h8]rFhd)rG}rH(hXCQuery the Metacat repository and return the result set as a Reader.rIh jCh(h)h*hsh,}rJ(h.]h/]h0]h1]h4]uh6Mh8]rKhCXCQuery the Metacat repository and return the result set as a Reader.rLrM}rN(hjIh jGubaubah*jubeh*jubj)rO}rP(hUh,}rQ(h.]h/]h0]h1]h4]uh jgh8]rR(j)rS}rT(hUh,}rU(h.]h/]h0]h1]h4]uh jOh8]rVhd)rW}rX(hXqueryrYh jSh(h)h*hsh,}rZ(h.]h/]h0]h1]h4]uh6Mh8]r[hCXqueryr\r]}r^(hjYh jWubaubah*jubj)r_}r`(hUh,}ra(h.]h/]h0]h1]h4]uh jOh8]rbhd)rc}rd(hXj``public Reader query(Reader xmlQuery, String qformat) throws MetacatInaccessibleException, IOException;``reh j_h(h)h*hsh,}rf(h.]h/]h0]h1]h4]uh6Mh8]rgj)rh}ri(hjeh,}rj(h.]h/]h0]h1]h4]uh jch8]rkhCXfpublic Reader query(Reader xmlQuery, String qformat) throws MetacatInaccessibleException, IOException;rlrm}rn(hUh jhubah*jubaubah*jubj)ro}rp(hUh,}rq(h.]h/]h0]h1]h4]uh jOh8]rrhd)rs}rt(hXrQuery the Metacat repository with the given metacat-compatible query format and return the result set as a Reader.ruh joh(h)h*hsh,}rv(h.]h/]h0]h1]h4]uh6Mh8]rwhCXrQuery the Metacat repository with the given metacat-compatible query format and return the result set as a Reader.rxry}rz(hjuh jsubaubah*jubeh*jubj)r{}r|(hUh,}r}(h.]h/]h0]h1]h4]uh jgh8]r~(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh j{h8]rhd)r}r(hXreadrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXreadrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh j{h8]rhd)r}r(hX``public Reader read(String docid) throws InsufficientKarmaException, MetacatInaccessibleException, DocumentNotFoundException, MetacatException;``rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rj)r}r(hjh,}r(h.]h/]h0]h1]h4]uh jh8]rhCXpublic Reader read(String docid) throws InsufficientKarmaException, MetacatInaccessibleException, DocumentNotFoundException, MetacatException;rr}r(hUh jubah*jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh j{h8]rhd)r}r(hX-Read an XML document from the Metacat server.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX-Read an XML document from the Metacat server.rr}r(hjh jubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jgh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXreadInlineDatarh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXreadInlineDatarr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX``public Reader readInlineData(String inlinedataid) throws InsufficientKarmaException, MetacatInaccessibleException, MetacatException;``rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rj)r}r(hjh,}r(h.]h/]h0]h1]h4]uh jh8]rhCXpublic Reader readInlineData(String inlinedataid) throws InsufficientKarmaException, MetacatInaccessibleException, MetacatException;rr}r(hUh jubah*jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX1Read inline data from the Metacat server session.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX1Read inline data from the Metacat server session.rr}r(hjh jubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jgh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX setAccessrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX setAccessrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX``public String setAccess(String _docid, String _principal, String _permission, String _permType, String _permOrder ); throws InsufficientKarmaException, MetacatException, MetacatInaccessibleException;``rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rj)r}r(hjh,}r(h.]h/]h0]h1]h4]uh jh8]rhCXpublic String setAccess(String _docid, String _principal, String _permission, String _permType, String _permOrder ); throws InsufficientKarmaException, MetacatException, MetacatInaccessibleException;rr}r(hUh jubah*jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX>Set permissions for an XML document in the Metacat repository.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX>Set permissions for an XML document in the Metacat repository.rr}r(hjh jubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jgh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX setMetacatUrlr h jh(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX setMetacatUrlr r }r(hj h jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX1``public void setMetacatUrl(String metacatUrl);``rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rj)r}r(hjh,}r(h.]h/]h0]h1]h4]uh jh8]rhCX-public void setMetacatUrl(String metacatUrl);rr}r(hUh jubah*jubaubah*jubj)r}r (hUh,}r!(h.]h/]h0]h1]h4]uh jh8]r"hd)r#}r$(hX7Set the MetacatUrl to which connections should be made.r%h jh(h)h*hsh,}r&(h.]h/]h0]h1]h4]uh6Mh8]r'hCX7Set the MetacatUrl to which connections should be made.r(r)}r*(hj%h j#ubaubah*jubeh*jubj)r+}r,(hUh,}r-(h.]h/]h0]h1]h4]uh jgh8]r.(j)r/}r0(hUh,}r1(h.]h/]h0]h1]h4]uh j+h8]r2hd)r3}r4(hX setSessionIdr5h j/h(h)h*hsh,}r6(h.]h/]h0]h1]h4]uh6Mh8]r7hCX setSessionIdr8r9}r:(hj5h j3ubaubah*jubj)r;}r<(hUh,}r=(h.]h/]h0]h1]h4]uh j+h8]r>hd)r?}r@(hX/``public void setSessionId(String sessionId);``rAh j;h(h)h*hsh,}rB(h.]h/]h0]h1]h4]uh6Mh8]rCj)rD}rE(hjAh,}rF(h.]h/]h0]h1]h4]uh j?h8]rGhCX+public void setSessionId(String sessionId);rHrI}rJ(hUh jDubah*jubaubah*jubj)rK}rL(hUh,}rM(h.]h/]h0]h1]h4]uh j+h8]rNhd)rO}rP(hX,Set the session identifier for this session.rQh jKh(h)h*hsh,}rR(h.]h/]h0]h1]h4]uh6Mh8]rShCX,Set the session identifier for this session.rTrU}rV(hjQh jOubaubah*jubeh*jubj)rW}rX(hUh,}rY(h.]h/]h0]h1]h4]uh jgh8]rZ(j)r[}r\(hUh,}r](h.]h/]h0]h1]h4]uh jWh8]r^hd)r_}r`(hXupdaterah j[h(h)h*hsh,}rb(h.]h/]h0]h1]h4]uh6Mh8]rchCXupdaterdre}rf(hjah j_ubaubah*jubj)rg}rh(hUh,}ri(h.]h/]h0]h1]h4]uh jWh8]rjhd)rk}rl(hX``public String update(String docid, Reader xmlDocument, Reader schema) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;``rmh jgh(h)h*hsh,}rn(h.]h/]h0]h1]h4]uh6Mh8]roj)rp}rq(hjmh,}rr(h.]h/]h0]h1]h4]uh jkh8]rshCXpublic String update(String docid, Reader xmlDocument, Reader schema) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;rtru}rv(hUh jpubah*jubaubah*jubj)rw}rx(hUh,}ry(h.]h/]h0]h1]h4]uh jWh8]rzhd)r{}r|(hXXUpdate an XML document in the repository by providing a new version of the XML document.r}h jwh(h)h*hsh,}r~(h.]h/]h0]h1]h4]uh6Mh8]rhCXXUpdate an XML document in the repository by providing a new version of the XML document.rr}r(hj}h j{ubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jgh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXuploadrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXuploadrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX``public String upload(String docid, File file) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;``rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rj)r}r(hjh,}r(h.]h/]h0]h1]h4]uh jh8]rhCXpublic String upload(String docid, File file) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;rr}r(hUh jubah*jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX+Upload a data document into the repository.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX+Upload a data document into the repository.rr}r(hjh jubaubah*jubeh*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jgh8]r(j)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hXuploadrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCXuploadrr}r(hjh jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX``public String publicupload(String docid, String fileName, InputStream fileData, int size) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;``rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rj)r}r(hjh,}r(h.]h/]h0]h1]h4]uh jh8]rhCXpublic String publicupload(String docid, String fileName, InputStream fileData, int size) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;rr}r(hUh jubah*jubaubah*jubj)r}r(hUh,}r(h.]h/]h0]h1]h4]uh jh8]rhd)r}r(hX+Upload a data document into the repository.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Mh8]rhCX+Upload a data document into the repository.rr}r(hjh jubaubah*jubeh*jubeh*jJubeh*jKubaubeubeubh(h)h*h+h,}r(h.]h/]h0]h1]rhah4]rhauh6K!h7hh8]r(h:)r}r(hhh h$h(h)h*h>h,}r(h1]h0]h.]h/]h4]h@huh6K!h7hh8]rhCXUsing the Registryrr}r(hhh jubaubhd)r}r(hXMetacat's optional Registry provides a simple Web-based interface for creating, editing, and submitting metadata to the Metacat repository (screenshot below). The interface includes help documentation, and can be customized using Metacat's configuration settings. The Registry also includes an administrative interface for managing LDAP user accounts, which is useful if you are using LDAP as your Metacat authentication system. Note that you must be running your own LDAP server if you wish to use the LDAP Web interface. If you do not have your own LDAP server, you can create and manage new accounts on the KNB website (http://knb.ecoinformatics.org/). Please note that at this time, the Registry interface has only been tested on Linux systems.h h$h(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6K"h7hh8]r(hCXoMetacat's optional Registry provides a simple Web-based interface for creating, editing, and submitting metadata to the Metacat repository (screenshot below). The interface includes help documentation, and can be customized using Metacat's configuration settings. The Registry also includes an administrative interface for managing LDAP user accounts, which is useful if you are using LDAP as your Metacat authentication system. Note that you must be running your own LDAP server if you wish to use the LDAP Web interface. If you do not have your own LDAP server, you can create and manage new accounts on the KNB website (rr}r(hXoMetacat's optional Registry provides a simple Web-based interface for creating, editing, and submitting metadata to the Metacat repository (screenshot below). The interface includes help documentation, and can be customized using Metacat's configuration settings. The Registry also includes an administrative interface for managing LDAP user accounts, which is useful if you are using LDAP as your Metacat authentication system. Note that you must be running your own LDAP server if you wish to use the LDAP Web interface. If you do not have your own LDAP server, you can create and manage new accounts on the KNB website (h jubhi)r}r(hXhttp://knb.ecoinformatics.org/rh,}r(Urefurijh1]h0]h.]h/]h4]uh jh8]rhCXhttp://knb.ecoinformatics.org/rr}r(hUh jubah*hrubhCX_). Please note that at this time, the Registry interface has only been tested on Linux systems.rr}r(hX_). Please note that at this time, the Registry interface has only been tested on Linux systems.h jubeubjQ )r}r(hUh h$h(h)h*jT h,}r(jV Xcenterh1]rUid1rah0]h.]h/]h4]uh6Nh7hh8]r(jZ )r}r(hX.. figure:: images/screenshots/image033.jpg :align: center An example installation of the Register's web interface. Customize the displayed and required modules with the Skins Configuration settings. h,}r(UuriXimages/screenshots/image033.jpgrh1]h0]h.]h/]j_ }rU*jsh4]uh jh8]h*ja ubjb )r}r(hXAn example installation of the Register's web interface. Customize the displayed and required modules with the Skins Configuration settings.rh jh(h)h*jf h,}r(h.]h/]h0]h1]h4]uh6K0h8]rhCXAn example installation of the Register's web interface. Customize the displayed and required modules with the Skins Configuration settings.rr }r (hjh jubaubeubhd)r }r (hXYou can customize which modules (e.g., "Name of Submitter" or "Temporal Coverage of Data") are displayed and which are required using the Skins Configuration settingsr h h$h(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6K3h7hh8]rhCXYou can customize which modules (e.g., "Name of Submitter" or "Temporal Coverage of Data") are displayed and which are required using the Skins Configuration settingsrr}r(hj h j ubaubh"h!)r}r(hUh h$h(h)h*h+h,}r(h.]h/]h0]h1]rhah4]rh auh6Kh7hh8]r(h:)r}r(hhh jh(h)h*h>h,}r(h1]h0]h.]h/]h4]h@huh6Kh7hh8]rhCXCustomizing the Registryrr}r(hhh jubaubhd)r }r!(hXBefore using the registry, you may wish to customize the interface using the Skins Configuration settings. If you are using the default skin, you must disable the 'show site list' setting before you can submit the form without errors. You may also wish to remove (or modify) the list of NCEAS-specific projects that appear in the default registry. To remove these form fields, open Metacat's administrative interface (http:///metacat/admin) and select the Skins Specific Properties Configuration option. On the skins configuration page, uncheck the boxes beside any form elements that you do not wish to appear in the registry.h jh(h)h*hsh,}r"(h.]h/]h0]h1]h4]uh6Kh7hh8]r#(hCXBefore using the registry, you may wish to customize the interface using the Skins Configuration settings. If you are using the default skin, you must disable the 'show site list' setting before you can submit the form without errors. You may also wish to remove (or modify) the list of NCEAS-specific projects that appear in the default registry. To remove these form fields, open Metacat's administrative interface (r$r%}r&(hXBefore using the registry, you may wish to customize the interface using the Skins Configuration settings. If you are using the default skin, you must disable the 'show site list' setting before you can submit the form without errors. You may also wish to remove (or modify) the list of NCEAS-specific projects that appear in the default registry. To remove these form fields, open Metacat's administrative interface (h j ubhi)r'}r((hXhttp:/r)h,}r*(Urefurij)h1]h0]h.]h/]h4]uh j h8]r+hCXhttp:/r,r-}r.(hUh j'ubah*hrubhCX//metacat/admin) and select the Skins Specific Properties Configuration option. On the skins configuration page, uncheck the boxes beside any form elements that you do not wish to appear in the registry.r/r0}r1(hX//metacat/admin) and select the Skins Specific Properties Configuration option. On the skins configuration page, uncheck the boxes beside any form elements that you do not wish to appear in the registry.h j ubeubhd)r2}r3(hXOnce you have saved your changes, you must restart Tomcat for them to come into effect. To restart Tomcat, type: ``sudo /etc/init.d/tomcat7 restart`` or an equivalent command appropriate to your operating system.h jh(h)h*hsh,}r4(h.]h/]h0]h1]h4]uh6Kh7hh8]r5(hCXqOnce you have saved your changes, you must restart Tomcat for them to come into effect. To restart Tomcat, type: r6r7}r8(hXqOnce you have saved your changes, you must restart Tomcat for them to come into effect. To restart Tomcat, type: h j2ubj)r9}r:(hX$``sudo /etc/init.d/tomcat7 restart``h,}r;(h.]h/]h0]h1]h4]uh j2h8]r<hCX sudo /etc/init.d/tomcat7 restartr=r>}r?(hUh j9ubah*jubhCX? or an equivalent command appropriate to your operating system.r@rA}rB(hX? or an equivalent command appropriate to your operating system.h j2ubeubjQ )rC}rD(hUh jh(h)h*jT h,}rE(jV Xcenterh1]rFUid3rGah0]h.]h/]h4]uh6Nh7hh8]rH(jZ )rI}rJ(hXL.. figure:: images/screenshots/image037.jpg :align: center Uncheck the box beside any setting to remove it from the Registry form. In the example, the "Show Site List" and "Show Work Group" form fields, corresponding to the "Station Name" and "NCEAS Project" drop-down lists in the registry form, have been removed. h,}rK(UuriXimages/screenshots/image037.jpgrLh1]h0]h.]h/]j_ }rMU*jLsh4]uh jCh8]h*ja ubjb )rN}rO(hXUncheck the box beside any setting to remove it from the Registry form. In the example, the "Show Site List" and "Show Work Group" form fields, corresponding to the "Station Name" and "NCEAS Project" drop-down lists in the registry form, have been removed.rPh jCh(h)h*jf h,}rQ(h.]h/]h0]h1]h4]uh6Kh8]rRhCXUncheck the box beside any setting to remove it from the Registry form. In the example, the "Show Site List" and "Show Work Group" form fields, corresponding to the "Station Name" and "NCEAS Project" drop-down lists in the registry form, have been removed.rSrT}rU(hjPh jNubaubeubeubh!)rV}rW(hUh h$h(h)h*h+h,}rX(h.]h/]h0]h1]rYhah4]rZhauh6Kh7hh8]r[(h:)r\}r](hhh jVh(h)h*h>h,}r^(h1]h0]h.]h/]h4]h@huh6Kh7hh8]r_hCXLDAP account managementr`ra}rb(hhh j\ubaubhd)rc}rd(hXIf you intend to use Metacat's built-in LDAP account management feature, you will need public and private keys for the reCaptcha widget.reh jVh(h)h*hsh,}rf(h.]h/]h0]h1]h4]uh6Kh7hh8]rghCXIf you intend to use Metacat's built-in LDAP account management feature, you will need public and private keys for the reCaptcha widget.rhri}rj(hjeh jcubaubhd)rk}rl(hX}1. Get private and public recaptcha keys from Google using your Google account: https://www.google.com/recaptcha/admin/createh jVh(h)h*hsh,}rm(h.]h/]h0]h1]h4]uh6Kh7hh8]rn(hCXP1. Get private and public recaptcha keys from Google using your Google account: rorp}rq(hXP1. Get private and public recaptcha keys from Google using your Google account: h jkubhi)rr}rs(hX-https://www.google.com/recaptcha/admin/createrth,}ru(Urefurijth1]h0]h.]h/]h4]uh jkh8]rvhCX-https://www.google.com/recaptcha/admin/createrwrx}ry(hUh jrubah*hrubeubcdocutils.nodes enumerated_list rz)r{}r|(hUh jVh(h)h*Uenumerated_listr}h,}r~(UsuffixrU.UstartrKh1]h0]h.]UprefixrUh/]h4]UenumtyperUarabicruh6Kh7hh8]rh_)r}r(hXDConfigure Metacat to use those keys in the metacat.properties file: h j{h(h)h*hh,}r(h.]h/]h0]h1]h4]uh6Nh7hh8]rhd)r}r(hXCConfigure Metacat to use those keys in the metacat.properties file:rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh8]rhCXCConfigure Metacat to use those keys in the metacat.properties file:rr}r(hjh jubaubaubaubcdocutils.nodes block_quote r)r}r(hUh jVh(h)h*U block_quoterh,}r(h.]h/]h0]h1]h4]uh6Nh7hh8]rjl )r}r(hXWldap.recaptcha.publickey= ldap.recaptcha.privatekey=h jh*jo h,}r(jq jr h1]h0]h.]h/]h4]uh6Kh8]rhCXWldap.recaptcha.publickey= ldap.recaptcha.privatekey=rr}r(hUh jubaubaubjz)r}r(hUh jVh(h)h*j}h,}r(jU.jKh1]h0]h.]jUh/]h4]jjuh6Kh7hh8]rh_)r}r(hXRestart Tomcat h jh(h)h*hh,}r(h.]h/]h0]h1]h4]uh6Nh7hh8]rhd)r}r(hXRestart Tomcatrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh8]rhCXRestart Tomcatrr}r(hjh jubaubaubaubeubeubh(h)h*h+h,}r(h.]h/]h0]h1]rhah4]rh auh6K8h7hh8]r(h:)r}r(hhh h"h(h)h*h>h,}r(h1]h0]h.]h/]h4]h@huh6K8h7hh8]rhCXInstalling the Registryrr}r(hhh jubaubhd)r}r(hXIn order to install and run the Registry, you must have Metacat installed and Tomcat must be running behind an Apache Web server (see previous sections for information about installing and configuring Apache to run with Tomcat).rh h"h(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6K9h7hh8]rhCXIn order to install and run the Registry, you must have Metacat installed and Tomcat must be running behind an Apache Web server (see previous sections for information about installing and configuring Apache to run with Tomcat).rr}r(hjh jubaubhd)r}r(hX To install and run the Registry:rh h"h(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6K=h7hh8]rhCX To install and run the Registry:rr}r(hjh jubaubjz)r}r(hUh h"h(h)h*j}h,}r(jU.h1]h0]h.]jUh/]h4]jjuh6K@h7hh8]rh_)r}r(hX\Install the required system libraries using Ubuntu/Debian (instructions Red Hat in sidebar) h jh(h)h*hh,}r(h.]h/]h0]h1]h4]uh6Nh7hh8]rhd)r}r(hX[Install the required system libraries using Ubuntu/Debian (instructions Red Hat in sidebar)rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6K@h8]rhCX[Install the required system libraries using Ubuntu/Debian (instructions Red Hat in sidebar)rr}r(hjh jubaubaubaubj)r}r(hUh h"h(Nh*jh,}r(h.]h/]h0]h1]h4]uh6Nh7hh8]rhY)r}r(hUh,}r(jX*h1]h0]h.]h/]h4]uh jh8]r(h_)r}r(hXInstall the libraries :: sudo apt-get install ant libappconfig-perl libxml-libxml-perl \ libxml-libxslt-perl libtemplate-perl libcgi-session-perl \ build-essential libnet-ldap-perl libterm-readkey-perl \ libxml-dom-perl libsoap-lite-perl -y h,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hXInstall the librariesrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6KCh8]rhCXInstall the librariesrr}r(hjh jubaubjl )r}r(hXsudo apt-get install ant libappconfig-perl libxml-libxml-perl \ libxml-libxslt-perl libtemplate-perl libcgi-session-perl \ build-essential libnet-ldap-perl libterm-readkey-perl \ libxml-dom-perl libsoap-lite-perl -yh jh*jo h,}r(jq jr h1]h0]h.]h/]h4]uh6KGh8]rhCXsudo apt-get install ant libappconfig-perl libxml-libxml-perl \ libxml-libxslt-perl libtemplate-perl libcgi-session-perl \ build-essential libnet-ldap-perl libterm-readkey-perl \ libxml-dom-perl libsoap-lite-perl -yrr}r(hUh jubaubeh*hubh_)r}r(hXInstall two more package using cpan :: sudo cpan -i Digest::SHA1 sudo cpan -i Config::Properties sudo cpan -i Scalar::Util sudo cpan -i Captcha:reCAPTCHA sudo cpan -i DateTime sudo cpan -i Crypt::JWT sudo cpan -i Crypt::X509 h,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hX#Install two more package using cpanrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6KLh8]rhCX#Install two more package using cpanrr}r(hjh jubaubjl )r}r(hXsudo cpan -i Digest::SHA1 sudo cpan -i Config::Properties sudo cpan -i Scalar::Util sudo cpan -i Captcha:reCAPTCHA sudo cpan -i DateTime sudo cpan -i Crypt::JWT sudo cpan -i Crypt::X509h jh*jo h,}r(jq jr h1]h0]h.]h/]h4]uh6KPh8]rhCXsudo cpan -i Digest::SHA1 sudo cpan -i Config::Properties sudo cpan -i Scalar::Util sudo cpan -i Captcha:reCAPTCHA sudo cpan -i DateTime sudo cpan -i Crypt::JWT sudo cpan -i Crypt::X509rr}r(hUh jubaubeh*hubeh*h\ubaubcdocutils.nodes sidebar r)r}r (hX* Install the libraries :: sudo yum install gcc libxml2-devel libxslt-devel ant -y * Install CPAN, which allows us to install the Perl dependencies for the registry and account management parts of Metacat. If asked to manually configure cpan, type 'no' and CPAN will be setup with its default values. :: sudo yum install perl-CPAN sudo cpan * You should now see a prompt which looks like: :: cpan> * The rest of the commands assume you're inside of CPAN. Let's get the most recent version of the CPAN software. Just press return after any prompts you receive during this process. :: install Bundle::CPAN reload cpan * Install the required modules. Here we're installing an old LibXSLT, as the current one requires a newer libxslt than is available on Redhat 4 & 5. Again, just answer 'yes' to any questions. :: install AutoLoader install CGI install CGI::SEssion install LWP::UserAgent install Net::LDAP install Template install URI install MSERGEANT/XML-LibXSLT-1.58.tar.gz install Captcha:reCAPTCHA install DateTime install Crypt::JWT install Crypt::X509h h"h(Nh*Usidebarr h,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r (h:)r }r(hX+Instructions for Red Hat (Alternate Step 2)rh jh(h)h*h>h,}r(h.]h/]h0]h1]h4]uh6Kh8]rhCX+Instructions for Red Hat (Alternate Step 2)rr}r(hjh j ubaubhY)r}r(hUh,}r(jX*h1]h0]h.]h/]h4]uh jh8]r(h_)r}r(hXUInstall the libraries :: sudo yum install gcc libxml2-devel libxslt-devel ant -y h,}r(h.]h/]h0]h1]h4]uh jh8]r(hd)r}r(hXInstall the librariesrh jh(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6KZh8]r!hCXInstall the librariesr"r#}r$(hjh jubaubjl )r%}r&(hX7sudo yum install gcc libxml2-devel libxslt-devel ant -yh jh*jo h,}r'(jq jr h1]h0]h.]h/]h4]uh6K^h8]r(hCX7sudo yum install gcc libxml2-devel libxslt-devel ant -yr)r*}r+(hUh j%ubaubeh*hubh_)r,}r-(hXInstall CPAN, which allows us to install the Perl dependencies for the registry and account management parts of Metacat. If asked to manually configure cpan, type 'no' and CPAN will be setup with its default values. :: sudo yum install perl-CPAN sudo cpan h,}r.(h.]h/]h0]h1]h4]uh jh8]r/(hd)r0}r1(hXInstall CPAN, which allows us to install the Perl dependencies for the registry and account management parts of Metacat. If asked to manually configure cpan, type 'no' and CPAN will be setup with its default values.r2h j,h(h)h*hsh,}r3(h.]h/]h0]h1]h4]uh6K`h8]r4hCXInstall CPAN, which allows us to install the Perl dependencies for the registry and account management parts of Metacat. If asked to manually configure cpan, type 'no' and CPAN will be setup with its default values.r5r6}r7(hj2h j0ubaubjl )r8}r9(hX$sudo yum install perl-CPAN sudo cpanh j,h*jo h,}r:(jq jr h1]h0]h.]h/]h4]uh6Kfh8]r;hCX$sudo yum install perl-CPAN sudo cpanr<r=}r>(hUh j8ubaubeh*hubh_)r?}r@(hX;You should now see a prompt which looks like: :: cpan> h,}rA(h.]h/]h0]h1]h4]uh jh8]rB(hd)rC}rD(hX-You should now see a prompt which looks like:rEh j?h(h)h*hsh,}rF(h.]h/]h0]h1]h4]uh6Kih8]rGhCX-You should now see a prompt which looks like:rHrI}rJ(hjEh jCubaubjl )rK}rL(hXcpan>h j?h*jo h,}rM(jq jr h1]h0]h.]h/]h4]uh6Kmh8]rNhCXcpan>rOrP}rQ(hUh jKubaubeh*hubh_)rR}rS(hXThe rest of the commands assume you're inside of CPAN. Let's get the most recent version of the CPAN software. Just press return after any prompts you receive during this process. :: install Bundle::CPAN reload cpan h,}rT(h.]h/]h0]h1]h4]uh jh8]rU(hd)rV}rW(hXThe rest of the commands assume you're inside of CPAN. Let's get the most recent version of the CPAN software. Just press return after any prompts you receive during this process.rXh jRh(h)h*hsh,}rY(h.]h/]h0]h1]h4]uh6Koh8]rZhCXThe rest of the commands assume you're inside of CPAN. Let's get the most recent version of the CPAN software. Just press return after any prompts you receive during this process.r[r\}r](hjXh jVubaubjl )r^}r_(hX install Bundle::CPAN reload cpanh jRh*jo h,}r`(jq jr h1]h0]h.]h/]h4]uh6Kuh8]rahCX install Bundle::CPAN reload cpanrbrc}rd(hUh j^ubaubeh*hubh_)re}rf(hXInstall the required modules. Here we're installing an old LibXSLT, as the current one requires a newer libxslt than is available on Redhat 4 & 5. Again, just answer 'yes' to any questions. :: install AutoLoader install CGI install CGI::SEssion install LWP::UserAgent install Net::LDAP install Template install URI install MSERGEANT/XML-LibXSLT-1.58.tar.gz install Captcha:reCAPTCHA install DateTime install Crypt::JWT install Crypt::X509h,}rg(h.]h/]h0]h1]h4]uh jh8]rh(hd)ri}rj(hXInstall the required modules. Here we're installing an old LibXSLT, as the current one requires a newer libxslt than is available on Redhat 4 & 5. Again, just answer 'yes' to any questions.rkh jeh(h)h*hsh,}rl(h.]h/]h0]h1]h4]uh6Kxh8]rmhCXInstall the required modules. Here we're installing an old LibXSLT, as the current one requires a newer libxslt than is available on Redhat 4 & 5. Again, just answer 'yes' to any questions.rnro}rp(hjkh jiubaubjl )rq}rr(hXinstall AutoLoader install CGI install CGI::SEssion install LWP::UserAgent install Net::LDAP install Template install URI install MSERGEANT/XML-LibXSLT-1.58.tar.gz install Captcha:reCAPTCHA install DateTime install Crypt::JWT install Crypt::X509h jeh*jo h,}rs(jq jr h1]h0]h.]h/]h4]uh6K~h8]rthCXinstall AutoLoader install CGI install CGI::SEssion install LWP::UserAgent install Net::LDAP install Template install URI install MSERGEANT/XML-LibXSLT-1.58.tar.gz install Captcha:reCAPTCHA install DateTime install Crypt::JWT install Crypt::X509rurv}rw(hUh jqubaubeh*hubeh*h\ubeubjz)rx}ry(hUh h"h(h)h*j}h,}rz(jU.jKh1]h0]h.]jUh/]h4]jjuh6Kh7hh8]r{(h_)r|}r}(hXDouble-check that Metacat's temporary folder, application.tempDir, is writable by the apache user, usually www-data or apache. h jxh(h)h*hh,}r~(h.]h/]h0]h1]h4]uh6Nh7hh8]rhd)r}r(hX~Double-check that Metacat's temporary folder, application.tempDir, is writable by the apache user, usually www-data or apache.rh j|h(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh8]rhCX~Double-check that Metacat's temporary folder, application.tempDir, is writable by the apache user, usually www-data or apache.rr}r(hjh jubaubaubh_)r}r(hXMake sure that the following scripts (found in ``/webapps/metacat/cgi-bin``) are executable: register-dataset.cgi and ldapweb.cgi. h jxh(h)h*hh,}r(h.]h/]h0]h1]h4]uh6Nh7hh8]rhd)r}r(hXMake sure that the following scripts (found in ``/webapps/metacat/cgi-bin``) are executable: register-dataset.cgi and ldapweb.cgi.h jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh8]r(hCX/Make sure that the following scripts (found in rr}r(hX/Make sure that the following scripts (found in h jubj)r}r(hX)``/webapps/metacat/cgi-bin``h,}r(h.]h/]h0]h1]h4]uh jh8]rhCX%/webapps/metacat/cgi-binrr}r(hUh jubah*jubhCX7) are executable: register-dataset.cgi and ldapweb.cgi.rr}r(hX7) are executable: register-dataset.cgi and ldapweb.cgi.h jubeubaubeubj)r}r(hUh h"h(h)h*jh,}r(h.]h/]h0]h1]h4]uh6Nh7hh8]rjl )r}r(hX9sudo chmod +x /webapps/metacat/cgi-bin/*.cgih jh*jo h,}r(jq jr h1]h0]h.]h/]h4]uh6Kh8]rhCX9sudo chmod +x /webapps/metacat/cgi-bin/*.cgirr}r(hUh jubaubaubjz)r}r(hUh h"h(h)h*j}h,}r(jU.jKh1]h0]h.]jUh/]h4]jjuh6Kh7hh8]r(h_)r}r(hX<Ensure apache CGI module is enabled :: sudo a2enmod cgid h jh(h)h*hh,}r(h.]h/]h0]h1]h4]uh6Nh7hh8]r(hd)r}r(hX#Ensure apache CGI module is enabledrh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh8]rhCX#Ensure apache CGI module is enabledrr}r(hjh jubaubjl )r}r(hXsudo a2enmod cgidh jh*jo h,}r(jq jr h1]h0]h.]h/]h4]uh6Kh8]rhCXsudo a2enmod cgidrr}r(hUh jubaubeubh_)r}r(hXRestart Apache. h jh(h)h*hh,}r(h.]h/]h0]h1]h4]uh6Nh7hh8]rhd)r}r(hXRestart Apache.rh jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh8]rhCXRestart Apache.rr}r(hjh jubaubaubeubj)r}r(hUh h"h(h)h*jh,}r(h.]h/]h0]h1]h4]uh6Nh7hh8]rjl )r}r(hX sudo /etc/init.d/apache2 restarth jh*jo h,}r(jq jr h1]h0]h.]h/]h4]uh6Kh8]rhCX sudo /etc/init.d/apache2 restartrr}r(hUh jubaubaubjz)r}r(hUh h"h(h)h*j}h,}r(jU.jKh1]h0]h.]jUh/]h4]jjuh6Kh7hh8]rh_)r}r(hXXVisit the resulting URL: http:///cgi-bin/register-dataset.cgi?cfg=default Where ```` is the URL of the server hosting the Metacat followed by the name of the WAR file (i.e., the application context) that you installed. For instance, the context URL for the KNB Metacat is: http://knb.ecoinformatics.org/knb. h jh(h)h*hh,}r(h.]h/]h0]h1]h4]uh6Nh7hh8]rhd)r}r(hXWVisit the resulting URL: http:///cgi-bin/register-dataset.cgi?cfg=default Where ```` is the URL of the server hosting the Metacat followed by the name of the WAR file (i.e., the application context) that you installed. For instance, the context URL for the KNB Metacat is: http://knb.ecoinformatics.org/knb.h jh(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh8]r(hCXVisit the resulting URL: rr}r(hXVisit the resulting URL: h jubhi)r}r(hXhttp:/rh,}r(Urefurijh1]h0]h.]h/]h4]uh jh8]rhCXhttp:/rr}r(hUh jubah*hrubhCXC//cgi-bin/register-dataset.cgi?cfg=default Where rr}r(hXC//cgi-bin/register-dataset.cgi?cfg=default Where h jubj)r}r(hX````h,}r(h.]h/]h0]h1]h4]uh jh8]rhCXrr}r(hUh jubah*jubhCX is the URL of the server hosting the Metacat followed by the name of the WAR file (i.e., the application context) that you installed. For instance, the context URL for the KNB Metacat is: rr}r(hX is the URL of the server hosting the Metacat followed by the name of the WAR file (i.e., the application context) that you installed. For instance, the context URL for the KNB Metacat is: h jubhi)r}r(hX!http://knb.ecoinformatics.org/knbrh,}r(Urefurijh1]h0]h.]h/]h4]uh jh8]rhCX!http://knb.ecoinformatics.org/knbrr}r(hUh jubah*hrubhCX.r}r(hX.h jubeubaubaubhd)r}r(hXNIf everything worked correctly, the registry home page will open (see figure).rh h"h(h)h*hsh,}r(h.]h/]h0]h1]h4]uh6Kh7hh8]rhCXNIf everything worked correctly, the registry home page will open (see figure).r r }r (hjh jubaubjQ )r }r (hUh h"h(h)h*jT h,}r(jV Xcenterh1]rUid2rah0]h.]h/]h4]uh6Nh7hh8]r(jZ )r}r(hX.. figure:: images/screenshots/image035.jpg :align: center An example of the Registry home page (with the default skin). h,}r(UuriXimages/screenshots/image035.jpgrh1]h0]h.]h/]j_ }rU*jsh4]uh j h8]h*ja ubjb )r}r(hX=An example of the Registry home page (with the default skin).rh j h(h)h*jf h,}r(h.]h/]h0]h1]h4]uh6Kh8]rhCX=An example of the Registry home page (with the default skin).rr}r(hjh jubaubeubeubh(h)h*Usystem_messagerh,}r (h.]UlevelKh1]h0]Usourceh)h/]h4]UlineKUtypeUINFOr!uh6Kh7hh8]r"hd)r#}r$(hX:Enumerated list start value not ordinal-1: "2" (ordinal 2)h,}r%(h.]h/]h0]h1]h4]uh hh8]r&hCX:Enumerated list start value not ordinal-1: "2" (ordinal 2)r'r(}r)(hUh j#ubah*hsubaubh)r*}r+(hUh h"h(h)h*jh,}r,(h.]UlevelKh1]h0]Usourceh)h/]h4]UlineKUtypej!uh6Kh7hh8]r-hd)r.}r/(hX:Enumerated list start value not ordinal-1: "4" (ordinal 4)h,}r0(h.]h/]h0]h1]h4]uh j*h8]r1hCX:Enumerated list start value not ordinal-1: "4" (ordinal 4)r2r3}r4(hUh j.ubah*hsubaubh)r5}r6(hUh h"h(h)h*jh,}r7(h.]UlevelKh1]h0]Usourceh)h/]h4]UlineKUtypej!uh6Kh7hh8]r8hd)r9}r:(hX:Enumerated list start value not ordinal-1: "6" (ordinal 6)h,}r;(h.]h/]h0]h1]h4]uh j5h8]r<hCX:Enumerated list start value not ordinal-1: "6" (ordinal 6)r=r>}r?(hUh j9ubah*hsubaubh)r@}rA(hUh jVh(h)h*jh,}rB(h.]UlevelKh1]h0]Usourceh)h/]h4]UlineKUtypej!uh6Kh7hh8]rChd)rD}rE(hX:Enumerated list start value not ordinal-1: "2" (ordinal 2)h,}rF(h.]h/]h0]h1]h4]uh j@h8]rGhCX:Enumerated list start value not ordinal-1: "2" (ordinal 2)rHrI}rJ(hUh jDubah*hsubaubh)rK}rL(hUh jVh(h)h*jh,}rM(h.]UlevelKh1]h0]Usourceh)h/]h4]UlineKUtypej!uh6Kh7hh8]rNhd)rO}rP(hX:Enumerated list start value not ordinal-1: "3" (ordinal 3)h,}rQ(h.]h/]h0]h1]h4]uh jKh8]rRhCX:Enumerated list start value not ordinal-1: "3" (ordinal 3)rSrT}rU(hUh jOubah*hsubaubeUcurrent_sourcerVNU decorationrWNUautofootnote_startrXKUnameidsrY}rZ(hhhj9hjh jh hh hh hh jrhhhhhjhj&hh3hjhjhjLhj_hhOuh8]r[h&ahUU transformerr\NU footnote_refsr]}r^Urefnamesr_}r`j]rajasUsymbol_footnotesrb]rcUautofootnote_refsrd]reUsymbol_footnote_refsrf]rgU citationsrh]rih7hU current_linerjNUtransform_messagesrk]rlUreporterrmNUid_startrnKU autofootnotesro]rpU citation_refsrq}rrUindirect_targetsrs]rtUsettingsru(cdocutils.frontend Values rvorw}rx(Ufootnote_backlinksryKUrecord_dependenciesrzNU rfc_base_urlr{Uhttps://tools.ietf.org/html/r|U tracebackr}Upep_referencesr~NUstrip_commentsrNU toc_backlinksrjU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNh>NUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsrNUsectsubtitle_xformrU source_linkrNUrfc_referencesrNUoutput_encodingrUutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrUUTF-8rU_sourcerh)Ugettext_compactrU generatorrNUdump_internalsrNU smart_quotesrU pep_base_urlrU https://www.python.org/dev/peps/rUsyntax_highlightrUlongrUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformrUstrip_elements_with_classesrNU _config_filesr]Ufile_insertion_enabledrU raw_enabledrKU dump_settingsrNubUsymbol_footnote_startrKh1}r(jjhjhh"hOhHj8j4hjj&jw j8 j4 jjj j hjVjX jR j j jj jGjCjjhAhjjjehhhhj_j hhhhhhjjhhj9j jj* jrj j%j!jjjjtjqjmh3h&jjjjj j jKjGjLjn hjj^jZhh$hhuUsubstitution_namesr}rh*h7h,}r(h.]h1]h0]Usourceh)h/]h4]uU footnotesr]rUrefidsr}rub.