cdocutils.nodes
document
q)q}q(U nametypesq}q(X using the registryqNX searching metacatqNX supported actionsqNX creating your own clientq NX installing the registryq
NX% using html forms (the http interface)q NX customizing the registryq NX% using the earthgrid api (aka ecogrid)q
NX ldap account managementqNX, a brief note about how information is storedqNX javadocqX8 inserting, updating, and deleting xml and data documentsqNX* accessing and submitting metadata and dataqNX
logging inqNX using morphoqNX paged query returnsqNX reading data and metadataqNX contentsqNuUsubstitution_defsq}qUparse_messagesq]q(cdocutils.nodes
system_message
q )q }q (U rawsourceq U Uparentq cdocutils.nodes
section
q!)q"}q#(h U h h!)q$}q%(h U h h!)q&}q'(h U h hUsourceq(Xd /var/lib/jenkins/jobs/Metacat_stable/workspace/METACAT_2_5_1/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<(h X* 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(h h=h h;ubaubcdocutils.nodes
topic
qG)qH}qI(h U h h&h(h)h*UtopicqJh,}qK(h.]h/]qLUcontentsqMah0]h1]qNUcontentsqOah4]qPhauh6Kh7hh8]qQ(h:)qR}qS(h U h,}qT(h.]h/]h0]h1]h4]uh hHh8]qUhCX ContentsqVqW}qX(h U h hRubah*h>ubcdocutils.nodes
bullet_list
qY)qZ}q[(h U h hHh(Nh*U bullet_listq\h,}q](h.]h/]h0]h1]h4]uh6Nh7hh8]q^cdocutils.nodes
list_item
q_)q`}qa(h U h,}qb(h.]h/]h0]h1]h4]uh hZh8]qc(cdocutils.nodes
paragraph
qd)qe}qf(h U h,}qg(h.]h/]h0]h1]h4]uh h`h8]qhcdocutils.nodes
reference
qi)qj}qk(h U h,}ql(h1]qmhAah0]h.]h/]h4]Urefidh3uh heh8]qnhCX* Accessing and Submitting Metadata and Dataqoqp}qq(h h=h hjubah*U referenceqrubah*U paragraphqsubhY)qt}qu(h U h,}qv(h.]h/]h0]h1]h4]uh h`h8]qw(h_)qx}qy(h U h,}qz(h.]h/]h0]h1]h4]uh hth8]q{hd)q|}q}(h U h,}q~(h.]h/]h0]h1]h4]uh hxh8]qhi)q}q(h U h,}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(h X, A Brief Note about How Information is Storedqh hubah*hrubah*hsubah*U list_itemqubh_)q}q(h U h,}q(h.]h/]h0]h1]h4]uh hth8]q(hd)q}q(h U h,}q(h.]h/]h0]h1]h4]uh hh8]qhi)q}q(h U h,}q(h1]qUid12qah0]h.]h/]h4]UrefidUusing-the-registryquh hh8]qhCX Using the Registryqq}q(h X Using the Registryqh hubah*hrubah*hsubhY)q}q(h U h,}q(h.]h/]h0]h1]h4]uh hh8]q(h_)q}q(h U h,}q(h.]h/]h0]h1]h4]uh hh8]qhd)q}q(h U h,}q(h.]h/]h0]h1]h4]uh hh8]qhi)q}q(h U h,}q(h1]qUid13qah0]h.]h/]h4]UrefidUinstalling-the-registryquh hh8]qhCX Installing the Registryqq}q(h X Installing the Registryqh hubah*hrubah*hsubah*hubh_)q}q(h U h,}q(h.]h/]h0]h1]h4]uh hh8]qhd)q}q(h U h,}q(h.]h/]h0]h1]h4]uh hh8]qhi)q}q(h U h,}q(h1]qUid14qah0]h.]h/]h4]UrefidUcustomizing-the-registryquh hh8]qhCX Customizing the RegistryqŅq}q(h X Customizing the Registryqh hubah*hrubah*hsubah*hubh_)q}q(h U h,}q(h.]h/]h0]h1]h4]uh hh8]qhd)q}q(h U h,}q(h.]h/]h0]h1]h4]uh hh8]qhi)q}q(h U h,}q(h1]qUid15qah0]h.]h/]h4]UrefidUldap-account-managementquh hh8]qhCX LDAP account managementqq}q(h X LDAP account managementqh hubah*hrubah*hsubah*hubeh*h\ubeh*hubh_)q}q(h U h,}q(h.]h/]h0]h1]h4]uh hth8]q(hd)q}q(h U h,}q(h.]h/]h0]h1]h4]uh hh8]qhi)q}q(h U h,}q(h1]qUid16qah0]h.]h/]h4]UrefidU#using-html-forms-the-http-interfacequh hh8]qhCX% Using HTML Forms (the HTTP Interface)q녁q}q(h X% Using HTML Forms (the HTTP Interface)qh hubah*hrubah*hsubhY)q}q(h U h,}q(h.]h/]h0]h1]h4]uh hh8]q(h_)q}q(h U h,}q(h.]h/]h0]h1]h4]uh hh8]qhd)q}q(h U h,}q(h.]h/]h0]h1]h4]uh hh8]qhi)q}q(h U h,}q(h1]qUid17qah0]h.]h/]h4]UrefidUsupported-actionsr uh hh8]r hCX Supported Actionsr r }r (h X Supported Actionsr h hubah*hrubah*hsubah*hubh_)r }r (h U h,}r (h.]h/]h0]h1]h4]uh hh8]r hd)r
}r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r
hi)r }r (h U h,}r (h1]r Uid18r ah0]h.]h/]h4]UrefidU
logging-inr uh j
h8]r hCX
Logging Inr r }r (h X
Logging Inr h j ubah*hrubah*hsubah*hubh_)r }r (h U h,}r (h.]h/]h0]h1]h4]uh hh8]r hd)r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hi)r! }r" (h U h,}r# (h1]r$ Uid19r% ah0]h.]h/]h4]UrefidU6inserting-updating-and-deleting-xml-and-data-documentsr& uh j h8]r' hCX8 Inserting, Updating, and Deleting XML and Data Documentsr( r) }r* (h X8 Inserting, Updating, and Deleting XML and Data Documentsr+ h j! ubah*hrubah*hsubah*hubh_)r, }r- (h U h,}r. (h.]h/]h0]h1]h4]uh hh8]r/ hd)r0 }r1 (h U h,}r2 (h.]h/]h0]h1]h4]uh j, h8]r3 hi)r4 }r5 (h U h,}r6 (h1]r7 Uid20r8 ah0]h.]h/]h4]UrefidUsearching-metacatr9 uh j0 h8]r: hCX Searching Metacatr; r< }r= (h X Searching Metacatr> h j4 ubah*hrubah*hsubah*hubh_)r? }r@ (h U h,}rA (h.]h/]h0]h1]h4]uh hh8]rB hd)rC }rD (h U h,}rE (h.]h/]h0]h1]h4]uh j? h8]rF hi)rG }rH (h U h,}rI (h1]rJ Uid21rK ah0]h.]h/]h4]UrefidUpaged-query-returnsrL uh jC h8]rM hCX Paged Query ReturnsrN rO }rP (h X Paged Query ReturnsrQ h jG ubah*hrubah*hsubah*hubh_)rR }rS (h U h,}rT (h.]h/]h0]h1]h4]uh hh8]rU hd)rV }rW (h U h,}rX (h.]h/]h0]h1]h4]uh jR h8]rY hi)rZ }r[ (h U h,}r\ (h1]r] Uid22r^ ah0]h.]h/]h4]UrefidUreading-data-and-metadatar_ uh jV h8]r` hCX Reading Data and Metadatara rb }rc (h X Reading Data and Metadatard h jZ ubah*hrubah*hsubah*hubeh*h\ubeh*hubh_)re }rf (h U h,}rg (h.]h/]h0]h1]h4]uh hth8]rh hd)ri }rj (h U h,}rk (h.]h/]h0]h1]h4]uh je h8]rl hi)rm }rn (h U h,}ro (h1]rp Uid23rq ah0]h.]h/]h4]UrefidU#using-the-earthgrid-api-aka-ecogridrr uh ji h8]rs hCX% Using the EarthGrid API (aka EcoGrid)rt ru }rv (h X% Using the EarthGrid API (aka EcoGrid)rw h jm ubah*hrubah*hsubah*hubh_)rx }ry (h U h,}rz (h.]h/]h0]h1]h4]uh hth8]r{ hd)r| }r} (h U h,}r~ (h.]h/]h0]h1]h4]uh jx h8]r hi)r }r (h U h,}r (h1]r Uid24r ah0]h.]h/]h4]UrefidU using-morphor uh j| h8]r hCX Using Morphor r }r (h X Using Morphor h j ubah*hrubah*hsubah*hubh_)r }r (h U h,}r (h.]h/]h0]h1]h4]uh hth8]r hd)r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hi)r }r (h U h,}r (h1]r Uid25r ah0]h.]h/]h4]UrefidUcreating-your-own-clientr uh j h8]r hCX Creating Your Own Clientr r }r (h X Creating Your Own Clientr h j ubah*hrubah*hsubah*hubeh*h\ubeh*hubaubeubhd)r }r (h XV The Metacat repository can be accessed and updated using a number of tools,
including:r h h&h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh7hh8]r hCXV The Metacat repository can be accessed and updated using a number of tools,
including:r r }r (h j h j ubaubhY)r }r (h U h h&h(h)h*h\h,}r (Ubulletr X *h1]h0]h.]h/]h4]uh6K h7hh8]r (h_)r }r (h X. the Registry, Metacat's optional Web interfacer h j h(h)h*hh,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r hd)r }r (h j h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6K h8]r hCX. the Registry, Metacat's optional Web interfacer r }r (h j h j ubaubaubh_)r }r (h X user-created HTML formsr h j h(h)h*hh,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r hd)r }r (h j h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6K
h8]r hCX user-created HTML formsr r }r (h j h j ubaubaubh_)r }r (h X Metacat's EarthGrid APIr h j h(h)h*hh,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r hd)r }r (h j h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6K h8]r hCX Metacat's EarthGrid APIr r }r (h j h j ubaubaubh_)r }r (h Xq existing clients, such as KNB's Morpho application, designed to help
scientists create, edit, and manage metadatah j h(h)h*hh,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r hd)r }r (h Xq existing clients, such as KNB's Morpho application, designed to help
scientists create, edit, and manage metadatar h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6K h8]r hCXq existing clients, such as KNB's Morpho application, designed to help
scientists create, edit, and manage metadatar r }r (h j h j ubaubaubh_)r }r (h XH user-created desktop clients that take advantage of Metacat's Java API.
h j h(h)h*hh,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r hd)r }r (h XG user-created desktop clients that take advantage of Metacat's Java API.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh8]r hCXG user-created desktop clients that take advantage of Metacat's Java API.r r }r (h j h j ubaubaubeubhd)r }r (h Xn In this section, we will look at how to take advantage of these tools to
customize Metacat for your user-base.r h h&h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh7hh8]r hCXn In this section, we will look at how to take advantage of these tools to
customize Metacat for your user-base.r r }r (h j h j ubaubh!)r }r (h U h h&h(h)h*h+h,}r (h.]h/]h0]h1]r hah4]r hauh6Kh7hh8]r (h:)r }r (h hh j h(h)h*h>h,}r (h1]h0]h.]h/]h4]h@huh6Kh7hh8]r hCX, A Brief Note about How Information is Storedr r }r (h hh j ubaubhd)r }r (h X Metacat 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.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh7hh8]r hCX Metacat 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.r r }r (h j h j ubaubeubh$h!)r }r (h U h h&h(h)h*h+h,}r (h.]h/]h0]h1]r hah4]r h auh6Kh7hh8]r (h:)r
}r (h hh j h(h)h*h>h,}r (h1]h0]h.]h/]h4]h@huh6Kh7hh8]r
hCX% Using HTML Forms (the HTTP Interface)r r }r (h hh j
ubaubhd)r }r (h X Metacat'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.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh7hh8]r hCX Metacat'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.r r }r (h j h j ubaubhY)r }r (h U h j h(h)h*h\h,}r (j X *h1]h0]h.]h/]h4]uh6Kh7hh8]r (h_)r }r (h X Supported Actions (API)r h j h(h)h*hh,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r! hd)r" }r# (h j h j h(h)h*hsh,}r$ (h.]h/]h0]h1]h4]uh6Kh8]r% hCX Supported Actions (API)r& r' }r( (h j h j" ubaubaubh_)r) }r* (h X
Logging inr+ h j h(h)h*hh,}r, (h.]h/]h0]h1]h4]uh6Nh7hh8]r- hd)r. }r/ (h j+ h j) h(h)h*hsh,}r0 (h.]h/]h0]h1]h4]uh6Kh8]r1 hCX
Logging inr2 r3 }r4 (h j+ h j. ubaubaubh_)r5 }r6 (h X8 Inserting, Updating, and Deleting XML and Data Documentsr7 h j h(h)h*hh,}r8 (h.]h/]h0]h1]h4]uh6Nh7hh8]r9 hd)r: }r; (h j7 h j5 h(h)h*hsh,}r< (h.]h/]h0]h1]h4]uh6Kh8]r= hCX8 Inserting, Updating, and Deleting XML and Data Documentsr> r? }r@ (h j7 h j: ubaubaubh_)rA }rB (h X Searching MetacatrC h j h(h)h*hh,}rD (h.]h/]h0]h1]h4]uh6Nh7hh8]rE hd)rF }rG (h jC h jA h(h)h*hsh,}rH (h.]h/]h0]h1]h4]uh6Kh8]rI hCX Searching MetacatrJ rK }rL (h jC h jF ubaubaubh_)rM }rN (h X Paged Query ReturnrO h j h(h)h*hh,}rP (h.]h/]h0]h1]h4]uh6Nh7hh8]rQ hd)rR }rS (h jO h jM h(h)h*hsh,}rT (h.]h/]h0]h1]h4]uh6Kh8]rU hCX Paged Query ReturnrV rW }rX (h jO h jR ubaubaubh_)rY }rZ (h X Reading Data and Metadata
h j h(h)h*hh,}r[ (h.]h/]h0]h1]h4]uh6Nh7hh8]r\ hd)r] }r^ (h X Reading Data and Metadatar_ h jY h(h)h*hsh,}r` (h.]h/]h0]h1]h4]uh6Kh8]ra hCX Reading Data and Metadatarb rc }rd (h j_ h j] ubaubaubeubh!)re }rf (h U h j h(h)h*h+h,}rg (h.]h/]h0]h1]rh j ah4]ri hauh6Kh7hh8]rj (h:)rk }rl (h j h je h(h)h*h>h,}rm (h1]h0]h.]h/]h4]h@huh6Kh7hh8]rn hCX Supported Actionsro rp }rq (h j h jk ubaubhd)rr }rs (h X Metacat 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).rt h je h(h)h*hsh,}ru (h.]h/]h0]h1]h4]uh6Kh7hh8]rv hCX Metacat 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).rw rx }ry (h jt h jr ubaubhd)rz }r{ (h X Note 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 je h(h)h*hsh,}r| (h.]h/]h0]h1]h4]uh6Kh7hh8]r} (hCX Note 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 (h X Note that if Replication is enabled, Metacat recognizes several additional
actions, included in Table 4.2. For more information about replication,
please see h jz ubcsphinx.addnodes
pending_xref
r )r }r (h X :doc:`replication`r h jz h(h)h*U pending_xrefr h,}r (UreftypeX docr Urefwarnr U reftargetr X replicationU refdomainU h1]h0]U refexplicith.]h/]h4]Urefdocr X
submittingr uh6Kh8]r cdocutils.nodes
literal
r )r }r (h j h,}r (h.]h/]r (Uxrefr j eh0]h1]h4]uh j h8]r hCX replicationr r }r (h U h j ubah*Uliteralr ubaubhCX .r }r (h X .h jz ubeubcdocutils.nodes
table
r )r }r (h U h je h(h)h*Utabler h,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r cdocutils.nodes
tgroup
r )r }r (h U h,}r (h1]h0]h.]h/]h4]UcolsKuh j h8]r (cdocutils.nodes
colspec
r )r }r (h U h,}r (h1]h0]h.]h/]h4]UcolwidthKuh j h8]h*Ucolspecr ubj )r }r (h U h,}r (h1]h0]h.]h/]h4]UcolwidthMuh j h8]h*j ubcdocutils.nodes
thead
r )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r cdocutils.nodes
row
r )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (cdocutils.nodes
entry
r )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X Actionr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh8]r hCX Actionr r }r (h j h j ubaubah*Uentryr ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X Description and Parametersr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh8]r hCX Description and Parametersr r }r (h j h j ubaubah*j ubeh*Urowr ubah*Utheadr ubcdocutils.nodes
tbody
r )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X deleter h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh8]r hCX deleter r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X Delete the specified document from the database. For an
example, please see Inserting, Updating, and
Deleting XML and Data Documents.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh8]r hCX Delete the specified document from the database. For an
example, please see Inserting, Updating, and
Deleting XML and Data Documents.r r }r (h j h j ubaubhd)r }r (h X/ ``docid`` - the docid of the document to deleteh j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh8]r (j )r }r (h X ``docid``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX docidr r }r (h U h j ubah*j ubhCX& - the docid of the document to deleter r }r (h X& - the docid of the document to deleteh j ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r
}r (h X exportr h j h(h)h*hsh,}r
(h.]h/]h0]h1]h4]uh6Kh8]r hCX exportr r }r (h j h j
ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X$ Export a data package in a zip file.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh8]r hCX$ Export a data package in a zip file.r r }r (h j h j ubaubhd)r }r (h X/ ``docid`` - the docid of the document to deleteh j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh8]r! (j )r" }r# (h X ``docid``h,}r$ (h.]h/]h0]h1]h4]uh j h8]r% hCX docidr& r' }r( (h U h j" ubah*j ubhCX& - the docid of the document to deleter) r* }r+ (h X& - the docid of the document to deleteh j ubeubeh*j ubeh*j ubj )r, }r- (h U h,}r. (h.]h/]h0]h1]h4]uh j h8]r/ (j )r0 }r1 (h U h,}r2 (h.]h/]h0]h1]h4]uh j, h8]r3 hd)r4 }r5 (h X getaccesscontrolr6 h j0 h(h)h*hsh,}r7 (h.]h/]h0]h1]h4]uh6Kh8]r8 hCX getaccesscontrolr9 r: }r; (h j6 h j4 ubaubah*j ubj )r< }r= (h U h,}r> (h.]h/]h0]h1]h4]uh j, h8]r? (hd)r@ }rA (h X= Get the access control list (ACL) for the
specified document.rB h j< h(h)h*hsh,}rC (h.]h/]h0]h1]h4]uh6Kh8]rD hCX= Get the access control list (ACL) for the
specified document.rE rF }rG (h jB h j@ ubaubhd)rH }rI (h X/ ``docid`` - the docid of the document to deleteh j< h(h)h*hsh,}rJ (h.]h/]h0]h1]h4]uh6Kh8]rK (j )rL }rM (h X ``docid``h,}rN (h.]h/]h0]h1]h4]uh jH h8]rO hCX docidrP rQ }rR (h U h jL ubah*j ubhCX& - the docid of the document to deleterS rT }rU (h X& - the docid of the document to deleteh jH ubeubeh*j ubeh*j ubj )rV }rW (h U h,}rX (h.]h/]h0]h1]h4]uh j h8]rY (j )rZ }r[ (h U h,}r\ (h.]h/]h0]h1]h4]uh jV h8]r] hd)r^ }r_ (h X getalldocidsr` h jZ h(h)h*hsh,}ra (h.]h/]h0]h1]h4]uh6M h8]rb hCX getalldocidsrc rd }re (h j` h j^ ubaubah*j ubj )rf }rg (h U h,}rh (h.]h/]h0]h1]h4]uh jV h8]ri (hd)rj }rk (h X9 Retrieve a list of all docids registered with the system.rl h jf h(h)h*hsh,}rm (h.]h/]h0]h1]h4]uh6M h8]rn hCX9 Retrieve a list of all docids registered with the system.ro rp }rq (h jl h jj ubaubhd)rr }rs (h XL ``scope`` - a string used to match a range of docids in a SQL LIKE statementh jf h(h)h*hsh,}rt (h.]h/]h0]h1]h4]uh6Mh8]ru (j )rv }rw (h X ``scope``h,}rx (h.]h/]h0]h1]h4]uh jr h8]ry hCX scoperz r{ }r| (h U h jv ubah*j ubhCXC - a string used to match a range of docids in a SQL LIKE statementr} r~ }r (h XC - a string used to match a range of docids in a SQL LIKE statementh jr ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X0 getdataguide
DEPRECATED
Use getdtdschema insteadr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX0 getdataguide
DEPRECATED
Use getdtdschema insteadr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X1 Read a data guide for the specified document typer h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX1 Read a data guide for the specified document typer r }r (h j h j ubaubhd)r }r (h X9 ``doctype`` - the doctype for which to get the data guideh j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r (j )r }r (h X ``doctype``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX doctyper r }r (h U h j ubah*j ubhCX. - the doctype for which to get the data guider r }r (h X. - the doctype for which to get the data guideh j ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X getdoctypesr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX getdoctypesr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h XR Get all doctypes currently available in the Metacat Catalog System. No parameters.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCXR Get all doctypes currently available in the Metacat Catalog System. No parameters.r r }r (h j h j ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X getdtdschemar h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M
h8]r hCX getdtdschemar r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X9 Read the DTD or XMLSchema file for the specified doctype.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M
h8]r hCX9 Read the DTD or XMLSchema file for the specified doctype.r r }r (h j h j ubaubhd)r }r (h XB ``doctype`` - the doctype for which DTD or XMLSchema files to readh j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M h8]r (j )r }r (h X ``doctype``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX doctyper r }r (h U h j ubah*j ubhCX7 - the doctype for which DTD or XMLSchema files to readr r }r (h X7 - the doctype for which DTD or XMLSchema files to readh j ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X getlastdocidr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX getlastdocidr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X8 Get the latest docid with revision number used by scope.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX8 Get the latest docid with revision number used by scope.r r
}r (h j h j ubaubhd)r }r
(h X# ``scope`` - the scope to be queriedh j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r (j )r }r (h X ``scope``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX scoper r }r (h U h j ubah*j ubhCX - the scope to be queriedr r }r (h X - the scope to be queriedh j ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r! hd)r" }r# (h X getlogr$ h j h(h)h*hsh,}r% (h.]h/]h0]h1]h4]uh6Mh8]r& hCX getlogr' r( }r) (h j$ h j" ubaubah*j ubj )r* }r+ (h U h,}r, (h.]h/]h0]h1]h4]uh j h8]r- (hd)r. }r/ (h X7 Get the latest docid with revision number used by user.r0 h j* h(h)h*hsh,}r1 (h.]h/]h0]h1]h4]uh6Mh8]r2 hCX7 Get the latest docid with revision number used by user.r3 r4 }r5 (h j0 h j. ubaubhd)r6 }r7 (h X= ``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; (h X
``ipaddress``h,}r< (h.]h/]h0]h1]h4]uh j6 h8]r= hCX ipaddressr> r? }r@ (h U h j: ubah*j ubhCX/ - the internet protocol address for the event
rA rB }rC (h X/ - the internet protocol address for the event
h j6 ubj )rD }rE (h X
``principal``h,}rF (h.]h/]h0]h1]h4]uh j6 h8]rG hCX principalrH rI }rJ (h U h jD ubah*j ubhCX1 - the principal for the event (a username, etc)
rK rL }rM (h X1 - the principal for the event (a username, etc)
h j6 ubj )rN }rO (h X ``docid``h,}rP (h.]h/]h0]h1]h4]uh j6 h8]rQ hCX docidrR rS }rT (h U h jN ubah*j ubhCX= - the identifier of the document to which the event applies
rU rV }rW (h X= - the identifier of the document to which the event applies
h j6 ubj )rX }rY (h X ``event``h,}rZ (h.]h/]h0]h1]h4]uh j6 h8]r[ hCX eventr\ r] }r^ (h U h jX ubah*j ubhCX! - the string code for the event
r_ r` }ra (h X! - the string code for the event
h j6 ubj )rb }rc (h X ``start``h,}rd (h.]h/]h0]h1]h4]uh j6 h8]re hCX startrf rg }rh (h U h jb ubah*j ubhCX% - beginning of date-range for query
ri rj }rk (h X% - beginning of date-range for query
h j6 ubj )rl }rm (h X ``end``h,}rn (h.]h/]h0]h1]h4]uh j6 h8]ro hCX endrp rq }rr (h U h jl ubah*j ubhCX - end of date-range for queryrs rt }ru (h X - end of date-range for queryh j6 ubeubeh*j ubeh*j ubj )rv }rw (h U h,}rx (h.]h/]h0]h1]h4]uh j h8]ry (j )rz }r{ (h U h,}r| (h.]h/]h0]h1]h4]uh jv h8]r} hd)r~ }r (h X getloggedinuserinfor h jz h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX getloggedinuserinfor r }r (h j h j~ ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh jv h8]r hd)r }r (h X> Get user info for the currently logged in user. No parameters.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX> Get user info for the currently logged in user. No parameters.r r }r (h j h j ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X getpricipalsr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M h8]r hCX getpricipalsr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h XM Get all users and groups in the current authentication schema. No parameters.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M h8]r hCXM Get all users and groups in the current authentication schema. No parameters.r r }r (h j h j ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X getrevisionanddoctyper h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M h8]r hCX getrevisionanddoctyper r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h Xa Return the revision and doctype of a document.
The output is String that looks like "rev;doctype"r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M h8]r hCXa Return the revision and doctype of a document.
The output is String that looks like "rev;doctype"r r }r (h j h j ubaubhd)r }r (h X% ``docid`` - the docid of the documenth j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M"h8]r (j )r }r (h X ``docid``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX docidr r }r (h U h j ubah*j ubhCX - the docid of the documentr r }r (h X - the docid of the documenth j ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X
getversionr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M$h8]r hCX
getversionr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h XS Get Metacat version. Return the current version of Metacat as XML. No parameters.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M$h8]r hCXS Get Metacat version. Return the current version of Metacat as XML. No parameters.r r }r (h j h j ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X insertr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M&h8]r hCX insertr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X} Insert an XML document into the database. For an example, please see
Inserting, Updating, and Deleting XML and Data Documentsr
h j h(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 (h j
h j ubaubhd)r }r (h Xy ``docid`` - the user-defined docid to assign to the new XML document
``doctext`` - the text of the XML document to inserth j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M)h8]r (j )r }r (h X ``docid``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX docidr r }r (h U h j ubah*j ubhCX< - the user-defined docid to assign to the new XML document
r r }r (h X< - the user-defined docid to assign to the new XML document
h j ubj )r }r (h X ``doctext``h,}r (h.]h/]h0]h1]h4]uh j h8]r! hCX doctextr" r# }r$ (h U h j ubah*j ubhCX) - the text of the XML document to insertr% r& }r' (h X) - the text of the XML document to inserth j ubeubeh*j ubeh*j ubj )r( }r) (h U h,}r* (h.]h/]h0]h1]h4]uh j h8]r+ (j )r, }r- (h U h,}r. (h.]h/]h0]h1]h4]uh j( h8]r/ hd)r0 }r1 (h X insertmultipartr2 h j, h(h)h*hsh,}r3 (h.]h/]h0]h1]h4]uh6M,h8]r4 hCX insertmultipartr5 r6 }r7 (h j2 h j0 ubaubah*j ubj )r8 }r9 (h U h,}r: (h.]h/]h0]h1]h4]uh j( h8]r; (hd)r< }r= (h XB Insert an XML document using multipart encoding into the database.r> h j8 h(h)h*hsh,}r? (h.]h/]h0]h1]h4]uh6M,h8]r@ hCXB Insert an XML document using multipart encoding into the database.rA rB }rC (h j> h j< ubaubhd)rD }rE (h Xy ``docid`` - the user-defined docid to assign to the new XML document
``doctext`` - the text of the XML document to inserth j8 h(h)h*hsh,}rF (h.]h/]h0]h1]h4]uh6M.h8]rG (j )rH }rI (h X ``docid``h,}rJ (h.]h/]h0]h1]h4]uh jD h8]rK hCX docidrL rM }rN (h U h jH ubah*j ubhCX< - the user-defined docid to assign to the new XML document
rO rP }rQ (h X< - the user-defined docid to assign to the new XML document
h jD ubj )rR }rS (h X ``doctext``h,}rT (h.]h/]h0]h1]h4]uh jD h8]rU hCX doctextrV rW }rX (h U h jR ubah*j ubhCX) - the text of the XML document to insertrY rZ }r[ (h X) - the text of the XML document to inserth jD ubeubeh*j ubeh*j ubj )r\ }r] (h U h,}r^ (h.]h/]h0]h1]h4]uh j h8]r_ (j )r` }ra (h U h,}rb (h.]h/]h0]h1]h4]uh j\ h8]rc hd)rd }re (h X isregisteredrf h j` h(h)h*hsh,}rg (h.]h/]h0]h1]h4]uh6M1h8]rh hCX isregisteredri rj }rk (h jf h jd ubaubah*j ubj )rl }rm (h U h,}rn (h.]h/]h0]h1]h4]uh j\ h8]ro (hd)rp }rq (h X Check 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.rr h jl h(h)h*hsh,}rs (h.]h/]h0]h1]h4]uh6M1h8]rt hCX Check 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.ru rv }rw (h jr h jp ubaubhd)rx }ry (h X% ``docid`` - the docid of the documenth jl h(h)h*hsh,}rz (h.]h/]h0]h1]h4]uh6M4h8]r{ (j )r| }r} (h X ``docid``h,}r~ (h.]h/]h0]h1]h4]uh jx h8]r hCX docidr r }r (h U h j| ubah*j ubhCX - the docid of the documentr r }r (h X - the docid of the documenth jx ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X loginr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M6h8]r hCX loginr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X Log 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.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M6h8]r hCX Log 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.r r }r (h j h j ubaubhd)r }r (h XG ``username`` - the user's login name
``password`` - the user's passwordh j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M9h8]r (j )r }r (h X ``username``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX usernamer r }r (h U h j ubah*j ubhCX - the user's login name
r r }r (h X - the user's login name
h j ubj )r }r (h X ``password``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX passwordr r }r (h U h j ubah*j ubhCX - the user's passwordr r }r (h X - the user's passwordh j ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X logoutr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M<h8]r hCX logoutr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h XK Log the current user out and destroy the associated session. No parameters.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M<h8]r hCXK Log the current user out and destroy the associated session. No parameters.r r }r (h j h j ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X queryr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M>h8]r hCX queryr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h XH Perform a free text query. For an example, please see Searching Metacat.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M>h8]r hCXH Perform a free text query. For an example, please see Searching Metacat.r r }r (h j h j ubaubhd)r }r (h XL ``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 j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6M@h8]r (j )r }r (h X ``returndoctype``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX
returndoctyper r }r (h U h j ubah*j ubhCXV - the doctype to use for your Package View. For more information about packages, see r r }r (h XV - the doctype to use for your Package View. For more information about packages, see h j ubhi)r }r (h X< http://knb.ecoinformatics.org/software/metacat/packages.htmlr h,}r (Urefurij h1]h0]h.]h/]h4]uh j h8]r hCX< http://knb.ecoinformatics.org/software/metacat/packages.htmlr r }r (h U h j ubah*hrubhCX
r }r (h X
h j ubj )r
}r (h X ``qformat``h,}r (h.]h/]h0]h1]h4]uh j h8]r
hCX qformatr r }r (h U h j
ubah*j ubhCXv - the format of the returned result set. Possible values are html or xml or the name of your servlet's Metacat skin.
r r }r (h Xv - the format of the returned result set. Possible values are html or xml or the name of your servlet's Metacat skin.
h j ubj )r }r (h X ``querytitle``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX
querytitler r }r (h U h j ubah*j ubhCX% - OPTIONAL - the title of the query
r r }r (h X% - OPTIONAL - the title of the query
h j ubj )r }r (h X ``doctype``h,}r (h.]h/]h0]h1]h4]uh j h8]r! hCX doctyper" r# }r$ (h U h j ubah*j ubhCX - 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' (h X - 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 j ubj )r( }r) (h X ``returnfield``h,}r* (h.]h/]h0]h1]h4]uh j h8]r+ hCX returnfieldr, r- }r. (h U h j( ubah*j ubhCX6 - a custom field to be returned by any hit document.
r/ r0 }r1 (h X6 - a custom field to be returned by any hit document.
h j ubj )r2 }r3 (h X ``operator``h,}r4 (h.]h/]h0]h1]h4]uh j h8]r5 hCX operatorr6 r7 }r8 (h U h j2 ubah*j ubhCXW - the Boolean operator to apply to the query. Possible values are: union or intersect
r9 r: }r; (h XW - the Boolean operator to apply to the query. Possible values are: union or intersect
h j ubj )r< }r= (h X ``searchmode``h,}r> (h.]h/]h0]h1]h4]uh j h8]r? hCX
searchmoder@ rA }rB (h U h j< ubah*j ubhCX - 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.
rC rD }rE (h X - 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 j ubj )rF }rG (h X ``anyfield``h,}rH (h.]h/]h0]h1]h4]uh j h8]rI hCX anyfieldrJ rK }rL (h U h jF ubah*j ubhCXu - a free-text search variable. The value placed in this parameter will be searched for in any document in any node.
rM rN }rO (h Xu - a free-text search variable. The value placed in this parameter will be searched for in any document in any node.
h j ubj )rP }rQ (h X ``pagesize``h,}rR (h.]h/]h0]h1]h4]uh j h8]rS hCX pagesizerT rU }rV (h U h jP ubah*j ubhCX - 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.
rW rX }rY (h X - 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 j ubj )rZ }r[ (h X
``pagestart``h,}r\ (h.]h/]h0]h1]h4]uh j h8]r] hCX pagestartr^ r_ }r` (h U h jZ ubah*j ubhCXd - the displayed search results page (e.g, 1). Used with pagesize. See section 4.3.4 for an example.ra rb }rc (h Xd - the displayed search results page (e.g, 1). Used with pagesize. See section 4.3.4 for an example.h j ubeubeh*j ubeh*j ubj )rd }re (h U h,}rf (h.]h/]h0]h1]h4]uh j h8]rg (j )rh }ri (h U h,}rj (h.]h/]h0]h1]h4]uh jd h8]rk hd)rl }rm (h X readrn h jh h(h)h*hsh,}ro (h.]h/]h0]h1]h4]uh6MKh8]rp hCX readrq rr }rs (h jn h jl ubaubah*j ubj )rt }ru (h U h,}rv (h.]h/]h0]h1]h4]uh jd h8]rw (hd)rx }ry (h Xm Get a document from the database and return it in the specified format. See Searching Metacat for an example.rz h jt h(h)h*hsh,}r{ (h.]h/]h0]h1]h4]uh6MKh8]r| hCXm Get a document from the database and return it in the specified format. See Searching Metacat for an example.r} r~ }r (h jz h jx ubaubhd)r }r (h X ``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 jt h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6MMh8]r (j )r }r (h X ``docid``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX docidr r }r (h U h j ubah*j ubhCX' - the docid of the document to return
r r }r (h X' - the docid of the document to return
h j ubj )r }r (h X ``qformat``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX qformatr r }r (h U h j ubah*j ubhCX> - the format to return the document in. Possible values are: r r }r (h X> - the format to return the document in. Possible values are: h j ubj )r }r (h X ``html``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX htmlr r }r (h U h j ubah*j ubhCX , r r }r (h X , h j ubj )r }r (h X ``xml``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX xmlr r }r (h U h j ubah*j ubhCX7 ,or, if your Metacat uses a skin, the name of the skin.r r }r (h X7 ,or, if your Metacat uses a skin, the name of the skin.h j ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X readinlinedatar h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6MPh8]r hCX readinlinedatar r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X Read inline data only.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6MPh8]r hCX Read inline data only.r r }r (h j h j ubaubhd)r }r (h X4 ``inlinedataid`` - the id of the inline data to readh j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6MRh8]r (j )r }r (h X ``inlinedataid``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX inlinedataidr r }r (h U h j ubah*j ubhCX$ - the id of the inline data to readr r }r (h X$ - the id of the inline data to readh j ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X setaccessr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6MTh8]r hCX setaccessr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X= Change access permissions for a user on a specified document.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6MTh8]r hCX= Change access permissions for a user on a specified document.r r }r (h j h j ubaubhd)r }r (h XC ``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 j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6MVh8]r (j )r }r (h X ``docid``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX docidr r }r (h U h j ubah*j ubhCX- - the docid of the document to be modified.
r r }r (h X- - the docid of the document to be modified.
h j ubj )r }r (h X
``principal``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX principalr r }r (h U h j ubah*j ubhCX8 - the user or group whose permissions will be modified
r r }r (h X8 - the user or group whose permissions will be modified
h j ubj )r
}r (h X ``permission``h,}r (h.]h/]h0]h1]h4]uh j h8]r
hCX
permissionr r }r (h U h j
ubah*j ubhCX- - the permission to set (read, write, all)
r r }r (h X- - the permission to set (read, write, all)
h j ubj )r }r (h X ``permType``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX permTyper r }r (h U h j ubah*j ubhCX/ - the type of permission to set (allow, deny)
r r }r (h X/ - the type of permission to set (allow, deny)
h j ubj )r }r (h X
``permOrder``h,}r (h.]h/]h0]h1]h4]uh j h8]r! hCX permOrderr" r# }r$ (h U h j ubah*j ubhCXE - the order in which to apply the permission (allowFirst, denyFirst)r% r& }r' (h XE - the order in which to apply the permission (allowFirst, denyFirst)h j ubeubeh*j ubeh*j ubj )r( }r) (h U h,}r* (h.]h/]h0]h1]h4]uh j h8]r+ (j )r, }r- (h U h,}r. (h.]h/]h0]h1]h4]uh j( h8]r/ hd)r0 }r1 (h X
spatial_queryr2 h j, h(h)h*hsh,}r3 (h.]h/]h0]h1]h4]uh6M\h8]r4 hCX
spatial_queryr5 r6 }r7 (h j2 h j0 ubaubah*j ubj )r8 }r9 (h U h,}r: (h.]h/]h0]h1]h4]uh j( h8]r; (hd)r< }r= (h X Perform 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 j8 h(h)h*hsh,}r? (h.]h/]h0]h1]h4]uh6M\h8]r@ hCX Perform a spatial query. These queries may include any of the queries supported by the
WFS / WMS standards. For more information, see Spatial Queries.rA rB }rC (h j> h j< ubaubhd)rD }rE (h X ``xmax`` - max x spatial coordinate
``ymax`` - max y spatial coordinate
``xmin`` - min x spatial coordinate
``ymin`` - min y spatial coordinateh j8 h(h)h*hsh,}rF (h.]h/]h0]h1]h4]uh6M_h8]rG (j )rH }rI (h X ``xmax``h,}rJ (h.]h/]h0]h1]h4]uh jD h8]rK hCX xmaxrL rM }rN (h U h jH ubah*j ubhCX - max x spatial coordinate
rO rP }rQ (h X - max x spatial coordinate
h jD ubj )rR }rS (h X ``ymax``h,}rT (h.]h/]h0]h1]h4]uh jD h8]rU hCX ymaxrV rW }rX (h U h jR ubah*j ubhCX - max y spatial coordinate
rY rZ }r[ (h X - max y spatial coordinate
h jD ubj )r\ }r] (h X ``xmin``h,}r^ (h.]h/]h0]h1]h4]uh jD h8]r_ hCX xminr` ra }rb (h U h j\ ubah*j ubhCX - min x spatial coordinate
rc rd }re (h X - min x spatial coordinate
h jD ubj )rf }rg (h X ``ymin``h,}rh (h.]h/]h0]h1]h4]uh jD h8]ri hCX yminrj rk }rl (h U h jf ubah*j ubhCX - min y spatial coordinaterm rn }ro (h X - min y spatial coordinateh jD ubeubeh*j ubeh*j ubj )rp }rq (h U h,}rr (h.]h/]h0]h1]h4]uh j h8]rs (j )rt }ru (h U h,}rv (h.]h/]h0]h1]h4]uh jp h8]rw hd)rx }ry (h X squeryrz h jt h(h)h*hsh,}r{ (h.]h/]h0]h1]h4]uh6Mdh8]r| hCX squeryr} r~ }r (h jz h jx ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh jp h8]r (hd)r }r (h XI Perform a structured query. For an example, please see Searching Metacat.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mdh8]r hCXI Perform a structured query. For an example, please see Searching Metacat.r r }r (h j h j ubaubhd)r }r (h X ``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 j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mfh8]r (j )r }r (h X ``query``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX queryr r }r (h U h j ubah*j ubhCX9 - the text of the pathquery document sent to the server
r r }r (h X9 - the text of the pathquery document sent to the server
h j ubj )r }r (h X ``qformat``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX qformatr r }r (h U h j ubah*j ubhCX> - the format to return the results in. Possible values are: r r }r (h X> - the format to return the results in. Possible values are: h j ubj )r }r (h X ``xml``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX xmlr r }r (h U h j ubah*j ubhCX , or the name of the a skin.r r }r (h X , or the name of the a skin.h j ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X updater h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mih8]r hCX updater r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X Overwrite 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.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mih8]r hCX Overwrite 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.r r }r (h j h j ubaubhd)r }r (h Xl ``docid`` - the docid of the document to update
``doctext`` - the text with which to update the XML documenth j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mmh8]r (j )r }r (h X ``docid``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX docidr r }r (h U h j ubah*j ubhCX' - the docid of the document to update
r r }r (h X' - the docid of the document to update
h j ubj )r }r (h X ``doctext``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX doctextr r }r (h U h j ubah*j ubhCX1 - the text with which to update the XML documentr r }r (h X1 - the text with which to update the XML documenth j ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X uploadr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mph8]r hCX uploadr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X Upload (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.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mph8]r hCX Upload (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.r r }r (h j h j ubaubhd)r }r (h XW ``docid`` - the docid of the data file to upload
``datafile`` - the data file to uploadh j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Msh8]r (j )r }r (h X ``docid``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX docidr r }r (h U h j ubah*j ubhCX( - the docid of the data file to upload
r r
}r (h X( - the docid of the data file to upload
h j ubj )r }r
(h X ``datafile``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX datafiler r }r (h U h j ubah*j ubhCX - the data file to uploadr r }r (h X - the data file to uploadh j ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X validater h j h(h)h*hsh,}r! (h.]h/]h0]h1]h4]uh6Mvh8]r" hCX validater# r$ }r% (h j h j ubaubah*j ubj )r& }r' (h U h,}r( (h.]h/]h0]h1]h4]uh j h8]r) (hd)r* }r+ (h X. Validate a specified document against its DTD.r, h j& h(h)h*hsh,}r- (h.]h/]h0]h1]h4]uh6Mvh8]r. hCX. Validate a specified document against its DTD.r/ r0 }r1 (h j, h j* ubaubhd)r2 }r3 (h Xj ``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]uh6Mxh8]r5 (j )r6 }r7 (h X ``docid``h,}r8 (h.]h/]h0]h1]h4]uh j2 h8]r9 hCX docidr: r; }r< (h U h j6 ubah*j ubhCX) - the docid of the document to validate
r= r> }r? (h X) - the docid of the document to validate
h j2 ubj )r@ }rA (h X ``valtext``h,}rB (h.]h/]h0]h1]h4]uh j2 h8]rC hCX valtextrD rE }rF (h U h j@ ubah*j ubhCX- - the DTD by which to validate this documentrG rH }rI (h X- - the DTD by which to validate this documenth j2 ubeubeh*j ubeh*j ubeh*UtbodyrJ ubeh*UtgrouprK ubaubhd)rL }rM (h X Metacat Replication ParametersrN h je h(h)h*hsh,}rO (h.]h/]h0]h1]h4]uh6M}h7hh8]rP hCX Metacat Replication ParametersrQ rR }rS (h jN h jL ubaubj )rT }rU (h U h je h(h)h*j h,}rV (h.]h/]h0]h1]h4]uh6Nh7hh8]rW j )rX }rY (h U h,}rZ (h1]h0]h.]h/]h4]UcolsKuh jT h8]r[ (j )r\ }r] (h U h,}r^ (h1]h0]h.]h/]h4]UcolwidthKuh jX h8]h*j ubj )r_ }r` (h U h,}ra (h1]h0]h.]h/]h4]UcolwidthKuh jX h8]h*j ubj )rb }rc (h U h,}rd (h.]h/]h0]h1]h4]uh jX h8]re j )rf }rg (h U h,}rh (h.]h/]h0]h1]h4]uh jb h8]ri (j )rj }rk (h U h,}rl (h.]h/]h0]h1]h4]uh jf h8]rm hd)rn }ro (h X Actionrp h jj h(h)h*hsh,}rq (h.]h/]h0]h1]h4]uh6Mh8]rr hCX Actionrs rt }ru (h jp h jn ubaubah*j ubj )rv }rw (h U h,}rx (h.]h/]h0]h1]h4]uh jf h8]ry hd)rz }r{ (h X Description and Parametersr| h jv h(h)h*hsh,}r} (h.]h/]h0]h1]h4]uh6Mh8]r~ hCX Description and Parametersr r }r (h j| h jz ubaubah*j ubeh*j ubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh jX h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X forcereplicater h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX forcereplicater r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h XJ Force the local server to get the specified document from the remote host.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCXJ Force the local server to get the specified document from the remote host.r r }r (h j h j ubaubhd)r }r (h X ``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 j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r (j )r }r (h X
``server``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX serverr r }r (h U h j ubah*j ubhCX3 - The server to which this document is being sent
r r }r (h X3 - The server to which this document is being sent
h j ubj )r }r (h X ``docid``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX docidr r }r (h U h j ubah*j ubhCX% - The docid of the document to send
r r }r (h X% - The docid of the document to send
h j ubj )r }r (h X ``dbaction``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX dbactionr r }r (h U h j ubah*j ubhCXH - The action to perform on the document: insert or update (the default)r r }r (h XH - The action to perform on the document: insert or update (the default)h j ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X getallr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX getallr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h XW Force the local server to check all known servers for updated documents. No parameters.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCXW Force the local server to check all known servers for updated documents. No parameters.r r }r (h j h j ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X
getcatalogr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX
getcatalogr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h XI Send the contents of the xml_catalog table encoded in XML. No parameters.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCXI Send the contents of the xml_catalog table encoded in XML. No parameters.r r }r (h j h j ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X getlockr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX getlockr r
}r (h j h j ubaubah*j ubj )r }r
(h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X) 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 (h j h j ubaubhd)r }r (h XR ``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 (h X ``docid``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX docidr r! }r" (h U h j ubah*j ubhCX - the docid of the document
r# r$ }r% (h X - the docid of the document
h j ubj )r& }r' (h X
``updaterev``h,}r( (h.]h/]h0]h1]h4]uh j h8]r) hCX updaterevr* r+ }r, (h U h j& ubah*j ubhCX - the revision number of docidr- r. }r/ (h X - the revision number of docidh j ubeubeh*j ubeh*j ubj )r0 }r1 (h U h,}r2 (h.]h/]h0]h1]h4]uh j h8]r3 (j )r4 }r5 (h U h,}r6 (h.]h/]h0]h1]h4]uh j0 h8]r7 hd)r8 }r9 (h X gettimer: h j4 h(h)h*hsh,}r; (h.]h/]h0]h1]h4]uh6Mh8]r< hCX gettimer= r> }r? (h j: h j8 ubaubah*j ubj )r@ }rA (h U h,}rB (h.]h/]h0]h1]h4]uh j0 h8]rC hd)rD }rE (h X4 Return the local time on this server. No parameters.rF h j@ h(h)h*hsh,}rG (h.]h/]h0]h1]h4]uh6Mh8]rH hCX4 Return the local time on this server. No parameters.rI rJ }rK (h jF h jD ubaubah*j ubeh*j ubj )rL }rM (h U h,}rN (h.]h/]h0]h1]h4]uh j h8]rO (j )rP }rQ (h U h,}rR (h.]h/]h0]h1]h4]uh jL h8]rS hd)rT }rU (h X
servercontrolrV h jP h(h)h*hsh,}rW (h.]h/]h0]h1]h4]uh6Mh8]rX hCX
servercontrolrY rZ }r[ (h jV h jT ubaubah*j ubj )r\ }r] (h U h,}r^ (h.]h/]h0]h1]h4]uh jL h8]r_ (hd)r` }ra (h XD Perform the specified replication control on the Replication daemon.rb h j\ h(h)h*hsh,}rc (h.]h/]h0]h1]h4]uh6Mh8]rd hCXD Perform the specified replication control on the Replication daemon.re rf }rg (h jb h j` ubaubhd)rh }ri (h XF ``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 (h X ``add``h,}rn (h.]h/]h0]h1]h4]uh jh h8]ro hCX addrp rq }rr (h U h jl ubah*j ubhCX, - add a new server to the replication list
rs rt }ru (h X, - add a new server to the replication list
h jh ubj )rv }rw (h X
``delete``h,}rx (h.]h/]h0]h1]h4]uh jh h8]ry hCX deleterz r{ }r| (h U h jv ubah*j ubhCX- - remove a server from the replication list
r} r~ }r (h X- - remove a server from the replication list
h jh ubj )r }r (h X ``list``h,}r (h.]h/]h0]h1]h4]uh jh h8]r hCX listr r }r (h U h j ubah*j ubhCX8 - list all of the servers currently in the server list
r r }r (h X8 - list all of the servers currently in the server list
h jh ubj )r }r (h X
``replicate``h,}r (h.]h/]h0]h1]h4]uh jh h8]r hCX replicater r }r (h U h j ubah*j ubhCXj - a Boolean flag (1 or 0) which determines if this server should copy files from the newly added server.
r r }r (h Xj - a Boolean flag (1 or 0) which determines if this server should copy files from the newly added server.
h jh ubj )r }r (h X
``server``h,}r (h.]h/]h0]h1]h4]uh jh h8]r hCX serverr r }r (h U h j ubah*j ubhCX - the server to add/deleter r }r (h X - the server to add/deleteh jh ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X readr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX readr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X Sends docid to the remote host.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX Sends docid to the remote host.r r }r (h j h j ubaubhd)r }r (h X- ``docid`` - the docid of the document to readh j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r (j )r }r (h X ``docid``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX docidr r }r (h U h j ubah*j ubhCX$ - the docid of the document to readr r }r (h X$ - the docid of the document to readh j ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X startr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX startr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X< 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 (h j h j ubaubhd)r }r (h X ``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 (h X ``rate``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX rater r }r (h U h j ubah*j ubhCX - 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 (h X - 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*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X stopr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX stopr r
}r
(h j h j ubaubah*j ubj )r
}r
(h U h,}r
(h.]h/]h0]h1]h4]uh j h8]r
hd)r
}r
(h X+ 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
(h j
h j
ubaubah*j ubeh*j ubj )r
}r
(h U h,}r
(h.]h/]h0]h1]h4]uh j h8]r
(j )r
}r
(h U h,}r
(h.]h/]h0]h1]h4]uh j
h8]r
hd)r
}r
(h X updater
h j
h(h)h*hsh,}r
(h.]h/]h0]h1]h4]uh6Mh8]r
hCX updater
r
}r
(h j
h j
ubaubah*j ubj )r
}r
(h U h,}r
(h.]h/]h0]h1]h4]uh j
h8]r!
hd)r"
}r#
(h Xb Send 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&
hCXb Send a list of all documents on the local server along with their revision numbers. No parameters.r'
r(
}r)
(h j$
h j"
ubaubah*j ubeh*j ubeh*jJ ubeh*jK ubaubeubh!)r*
}r+
(h U h j h(h)h*h+h,}r,
(h.]h/]h0]h1]r-
j ah4]r.
hauh6Mh7hh8]r/
(h:)r0
}r1
(h j h j*
h(h)h*h>h,}r2
(h1]h0]h.]h/]h4]h@j uh6Mh7hh8]r3
hCX
Logging Inr4
r5
}r6
(h j h j0
ubaubhd)r7
}r8
(h X/ To log in to Metacat, use the ``login`` action.r9
h j*
h(h)h*hsh,}r:
(h.]h/]h0]h1]h4]uh6Mh7hh8]r;
(hCX To log in to Metacat, use the r<
r=
}r>
(h X To log in to Metacat, use the h j7
ubj )r?
}r@
(h X ``login``h,}rA
(h.]h/]h0]h1]h4]uh j7
h8]rB
hCX loginrC
rD
}rE
(h U h j?
ubah*j ubhCX action.rF
rG
}rH
(h X action.h j7
ubeubhd)rI
}rJ
(h X The 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
hCX The 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
(h jK
h jI
ubaubcdocutils.nodes
figure
rQ
)rR
}rS
(h U h j*
h(h)h*UfigurerT
h,}rU
(UalignrV
X centerh1]rW
Uid4rX
ah0]h.]h/]h4]uh6Nh7hh8]rY
(cdocutils.nodes
image
rZ
)r[
}r\
(h Xk .. figure:: images/screenshots/image039.jpg
:align: center
Logging into Metacat using an HTML form.
h,}r]
(UuriX images/screenshots/image039.jpgr^
h1]h0]h.]h/]U
candidatesr_
}r`
U*j^
sh4]uh jR
h8]h*Uimagera
ubcdocutils.nodes
caption
rb
)rc
}rd
(h X( 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
(h je
h jc
ubaubeubcdocutils.nodes
literal_block
rl
)rm
}rn
(h X-
h j*
h(h)h*U
literal_blockro
h,}rp
(U xml:spacerq
Upreserverr
h1]h0]h.]h/]h4]uh6Mh7hh8]rs
hCX-
rt
ru
}rv
(h U h jm
ubaubeubh!)rw
}rx
(h U h j h(h)h*h+h,}ry
(h.]h/]h0]h1]rz
j& ah4]r{
hauh6Mh7hh8]r|
(h:)r}
}r~
(h j+ h jw
h(h)h*h>h,}r
(h1]h0]h.]h/]h4]h@j% uh6Mh7hh8]r
hCX8 Inserting, Updating, and Deleting XML and Data Documentsr
r
}r
(h j+ h j}
ubaubhd)r
}r
(h X 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
(h j
h j
ubaubcdocutils.nodes
definition_list
r
)r
}r
(h U h jw
h(h)h*Udefinition_listr
h,}r
(h.]h/]h0]h1]h4]uh6Nh7hh8]r
(cdocutils.nodes
definition_list_item
r
)r
}r
(h X[ ``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
(h X
``insert``r
h j
h(h)h*Utermr
h,}r
(h.]h/]h0]h1]h4]uh6Mh8]r
j )r
}r
(h j
h,}r
(h.]h/]h0]h1]h4]uh j
h8]r
hCX insertr
r
}r
(h U h j
ubah*j ubaubcdocutils.nodes
definition
r
)r
}r
(h U h,}r
(h.]h/]h0]h1]h4]uh j
h8]r
hd)r
}r
(h XO Insert 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
hCXO Insert a new XML or data document into Metacat. You must specify a document ID.r
r
}r
(h j
h j
ubaubah*U
definitionr
ubeubj
)r
}r
(h Xe ``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
(h X
``update``r
h j
h(h)h*j
h,}r
(h.]h/]h0]h1]h4]uh6Mh8]r
j )r
}r
(h j
h,}r
(h.]h/]h0]h1]h4]uh j
h8]r
hCX updater
r
}r
(h U h j
ubah*j ubaubj
)r
}r
(h U h,}r
(h.]h/]h0]h1]h4]uh j
h8]r
hd)r
}r
(h XY Update 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
hCXY Update an existing Metacat document. The original document is archived,
then overwritten.r
r
}r
(h j
h j
ubaubah*j
ubeubj
)r
}r
(h XI ``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]uh6M
h7hh8]r
(j
)r
}r
(h X
``delete``r
h j
h(h)h*j
h,}r
(h.]h/]h0]h1]h4]uh6M
h8]r
j )r
}r
(h j
h,}r
(h.]h/]h0]h1]h4]uh j
h8]r
hCX deleter
r
}r
(h U h j
ubah*j ubaubj
)r
}r
(h U h,}r
(h.]h/]h0]h1]h4]uh j
h8]r
hd)r
}r
(h X= 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
(h j
h j
ubaubah*j
ubeubeubcdocutils.nodes
warning
r
)r
}r
(h Xc It 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
(h Xc It 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
hCXc It is not possible to "delete" one revision without "deleting" all
revisions of a given identifier.r
r
}r
(h j
h j
ubaubaubhd)r
}r
(h X The 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
hCX The 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 (h j
h j
ubaubjQ
)r }r (h U h jw
h(h)h*jT
h,}r (jV
X centerh1]r Uid5r ah0]h.]h/]h4]uh6Nh7hh8]r (jZ
)r }r (h X .. 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
(UuriX images/screenshots/image041.jpgr h1]h0]h.]h/]j_
}r U*j sh4]uh j h8]h*ja
ubjb
)r
}r (h XT An 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 hCXT An example of a Web form used to insert, delete, or update XML documents in Metacat.r r }r (h j h j
ubaubeubjl
)r }r (h X8
MetaCat
MetaCat XML Loader
Upload, Change, or Delete an XML document using this form.
h jw
h(h)h*jo
h,}r (jq
jr
h1]h0]h.]h/]h4]uh6M h7hh8]r hCX8
MetaCat
MetaCat XML Loader
Upload, Change, or Delete an XML document using this form.
r r }r (h U h j ubaubeubh!)r }r (h U h j h(h)h*h+h,}r (h.]h/]h0]h1]r j9 ah4]r hauh6M:h7hh8]r! (h:)r" }r# (h j> h j h(h)h*h>h,}r$ (h1]h0]h.]h/]h4]h@j8 uh6M:h7hh8]r% hCX Searching Metacatr& r' }r( (h j> h j" ubaubhd)r) }r* (h X: 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- (hCX To search Metacat use the r. r/ }r0 (h X To search Metacat use the h j) ubj )r1 }r2 (h X ``query``h,}r3 (h.]h/]h0]h1]h4]uh j) h8]r4 hCX queryr5 r6 }r7 (h U h j1 ubah*j ubhCX or r8 r9 }r: (h X or h j) ubj )r; }r< (h X
``squery``h,}r= (h.]h/]h0]h1]h4]uh j) h8]r> hCX squeryr? r@ }rA (h U h j; ubah*j ubhCX actions.rB rC }rD (h X actions.h j) ubeubj
)rE }rF (h U h j h(h)h*j
h,}rG (h.]h/]h0]h1]h4]uh6Nh7hh8]rH (j
)rI }rJ (h X ``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 (h X
``query``:rO h jI h(h)h*j
h,}rP (h.]h/]h0]h1]h4]uh6M?h8]rQ (j )rR }rS (h X ``query``h,}rT (h.]h/]h0]h1]h4]uh jM h8]rU hCX queryrV rW }rX (h U h jR ubah*j ubhCX :rY }rZ (h X :h jM ubeubj
)r[ }r\ (h U h,}r] (h.]h/]h0]h1]h4]uh jI h8]r^ hd)r_ }r` (h X Perform a free text query. Specify the returndoctype, qformat, returnfield,
operator, searchmode, anyfield, and (optionally) a querytitle and doctype.ra h j[ h(h)h*hsh,}rb (h.]h/]h0]h1]h4]uh6M>h8]rc hCX Perform a free text query. Specify the returndoctype, qformat, returnfield,
operator, searchmode, anyfield, and (optionally) a querytitle and doctype.rd re }rf (h ja h j_ ubaubah*j
ubeubj
)rg }rh (h Xg ``squery``:
Perform a structured query by submitting an XML pathquery document to the
Metacat server.
h jE h(h)h*j
h,}ri (h.]h/]h0]h1]h4]uh6MDh7hh8]rj (j
)rk }rl (h X ``squery``:rm h jg h(h)h*j
h,}rn (h.]h/]h0]h1]h4]uh6MDh8]ro (j )rp }rq (h X
``squery``h,}rr (h.]h/]h0]h1]h4]uh jk h8]rs hCX squeryrt ru }rv (h U h jp ubah*j ubhCX :rw }rx (h X :h jk ubeubj
)ry }rz (h U h,}r{ (h.]h/]h0]h1]h4]uh jg h8]r| hd)r} }r~ (h XY Perform a structured query by submitting an XML pathquery document to the
Metacat server.r h jy h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6MBh8]r hCXY Perform a structured query by submitting an XML pathquery document to the
Metacat server.r r }r (h j h j} ubaubah*j
ubeubeubhd)r }r (h X! 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]uh6MFh7hh8]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 (h j h j ubaubjQ
)r }r (h U h j h(h)h*jT
h,}r (jV
X centerh1]r Uid6r ah0]h.]h/]h4]uh6Nh7hh8]r (jZ
)r }r (h X .. 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 (UuriX images/screenshots/image043.jpgr h1]h0]h.]h/]j_
}r U*j sh4]uh j h8]h*ja
ubjb
)r }r (h Xn Example 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]uh6MRh8]r hCXn Example of a basic search form using a query action. The HTML code used to create the form is displayed below.r r }r (h j h j ubaubeubjl
)r }r (h Xa
Search
h j h(h)h*jo
h,}r (jq
jr
h1]h0]h.]h/]h4]uh6MVh7hh8]r hCXa
Search
r r }r (h U h j ubaubhd)r }r (h X Metacat'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]uh6Mrh7hh8]r hCX Metacat'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 (h j h j ubaubjl
)r }r (h X
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]uh6Mxh7hh8]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 (h U h j ubaubhd)r }r (h X Each ```` 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 (hCX Each r r }r (h X Each h j ubj )r }r (h X ````h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX
r r }r (h U h j ubah*j ubhCX 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 (h X 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 (h X The ```` 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 (hCX The r r }r (h X The h j ubj )r }r (h X ````h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX r r }r (h U h j ubah*j ubhCX 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 (h X 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 (h X6 A ```` 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 (hCX A r r }r (h X A h j ubj )r }r (h X ````h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX r r }r (h U h j ubah*j ubhCX> creates an AND or an OR statement that applies to the
nested r r }r (h X> creates an AND or an OR statement that applies to the
nested h j ubj )r }r (h X ````h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX r r }r (h U h j ubah*j ubhCX< tags. The querygroup operator can be UNION or INTERSECT.
A r r }r (h X< tags. The querygroup operator can be UNION or INTERSECT.
A h j ubj )r }r (h X ````h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX r r }r (h U h j ubah*j ubhCX( defines the actual field (contained in r r }r (h X( defines the actual field (contained in h j ubj )r }r (h X ````h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX
r r }r (h U h j ubah*j ubhCX1 tags)
against which the query (contained in the r r }r (h X1 tags)
against which the query (contained in the h j ubj )r }r (h X ````h,}r (h.]h/]h0]h1]h4]uh j h8]r
hCX r r }r
(h U h j ubah*j ubhCX tags) is being performed.r r }r (h X tags) is being performed.h j ubeubhd)r }r (h XF The ```` 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 (hCX The r r }r (h X The h j ubj )r }r (h X ````h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX
r r }r (h U h j ubah*j ubhCX7 can also contain a document type keyword contained in
r r }r! (h X7 can also contain a document type keyword contained in
h j ubj )r" }r# (h X ````h,}r$ (h.]h/]h0]h1]h4]uh j h8]r% hCX r& r' }r( (h U h j" ubah*j ubhCX 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+ (h X 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- (h XR After 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]r0 hCXR After Metacat has processed a Pathquery document, it returns a resultset document.r1 r2 }r3 (h j. h j, ubaubjl
)r4 }r5 (h X3
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,}r6 (jq
jr
h1]h0]h.]h/]h4]uh6Mh7hh8]r7 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
.....
r8 r9 }r: (h U h j4 ubaubhd)r; }r< (h X When 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? hCX When 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@ rA }rB (h j= h j; ubaubhd)rC }rD (h X Each 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,}rE (h.]h/]h0]h1]h4]uh6Mh7hh8]rF (hCX< Each XML document returned by the query is represented by a rG rH }rI (h X< Each XML document returned by the query is represented by a h jC ubj )rJ }rK (h X ````h,}rL (h.]h/]h0]h1]h4]uh jC h8]rM hCX
rN rO }rP (h U h jJ ubah*j ubhCX 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 rQ rR }rS (h X 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 jC ubj )rT }rU (h X ````h,}rV (h.]h/]h0]h1]h4]uh jC h8]rW hCX
rX rY }rZ (h U h jT ubah*j ubhCX` tags (e.g., dataset/title to return
the document title), the additional fields are returned in r[ r\ }r] (h X` tags (e.g., dataset/title to return
the document title), the additional fields are returned in h jC ubj )r^ }r_ (h X ````h,}r` (h.]h/]h0]h1]h4]uh jC h8]ra hCX rb rc }rd (h U h j^ ubah*j ubhCX tags.re rf }rg (h X tags.h jC ubeubhd)rh }ri (h XJ Metacat can return the XML resultset to your client as either XML or HTML.rj h j h(h)h*hsh,}rk (h.]h/]h0]h1]h4]uh6Mh7hh8]rl hCXJ Metacat can return the XML resultset to your client as either XML or HTML.rm rn }ro (h jj h jh ubaubeubh!)rp }rq (h U h j h(h)h*h+h,}rr (h.]h/]h0]h1]rs jL ah4]rt hauh6Mh7hh8]ru (h:)rv }rw (h jQ h jp h(h)h*h>h,}rx (h1]h0]h.]h/]h4]h@jK uh6Mh7hh8]ry hCX Paged Query Returnsrz r{ }r| (h jQ h jv ubaubhd)r} }r~ (h X Dividing 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 jp h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r hCX Dividing 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 (h j h j} ubaubjQ
)r }r (h U h jp h(h)h*jT
h,}r (jV
X centerh1]r Uid7r ah0]h.]h/]h4]uh6Nh7hh8]r (jZ
)r }r (h Xf .. figure:: images/screenshots/image045.jpg
:align: center
An example of paged search results.
h,}r (UuriX images/screenshots/image045.jpgr h1]h0]h.]h/]j_
}r U*j sh4]uh j h8]h*ja
ubjb
)r }r (h X# 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 (h j h j ubaubeubhd)r }r (h X# 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 jp 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 (h j h j ubaubjl
)r }r (h X
1
10
2
0
...
...
...
h jp h(h)h*jo
h,}r (jq
jr
h1]h0]h.]h/]h4]uh6Mh7hh8]r hCX
1
10
2
0
...
...
...
r r }r (h U h j ubaubhd)r }r (h X The 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 jp h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r hCX The 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 (h j h j ubaubjl
)r }r (h X Previous Page
Next Pageh jp h(h)h*jo
h,}r (jq
jr
h1]h0]h.]h/]h4]uh6Mh7hh8]r hCX Previous Page
Next Pager r }r (h U h j ubaubhd)r }r (h X In 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 jp h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r hCX In 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 (h j h j ubaubeubh!)r }r (h U h j h(h)h*h+h,}r (h.]h/]h0]h1]r j_ ah4]r hauh6Mh7hh8]r (h:)r }r (h jd h j h(h)h*h>h,}r (h1]h0]h.]h/]h4]h@j^ uh6Mh7hh8]r hCX Reading Data and Metadatar r }r (h jd h j ubaubhd)r }r (h X To 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 (h X/ To read data or metadata from Metacat, use the h j ubj )r }r (h X ``read``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX readr r }r (h U h j ubah*j ubhCX
action. The r r }r (h X
action. The h j ubj )r }r (h X ``read``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX readr r }r (h U h j ubah*j ubhCX action
takes two parameters: r r }r (h X action
takes two parameters: h j ubj )r }r (h X ``docid``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX docidr r }r (h U h j ubah*j ubhCXA , which specifies the document ID of the document
to return, and r r }r (h XA , which specifies the document ID of the document
to return, and h j ubj )r }r (h X ``qformat``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX qformatr r }r (h U h j ubah*j ubhCX6 , which specifies the return format for the document
(r r }r (h X6 , which specifies the return format for the document
(h j ubj )r }r (h X ``html``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX htmlr r }r
(h U h j ubah*j ubhCX or r
r
}r
(h X or h j ubj )r
}r
(h X ``xml``h,}r
(h.]h/]h0]h1]h4]uh j h8]r
hCX xmlr
r
}r
(h U h j
ubah*j ubhCX. or the name of a configured style-set, e.g., r
r
}r
(h X. or the name of a configured style-set, e.g., h j ubj )r
}r
(h X ``default``h,}r
(h.]h/]h0]h1]h4]uh j h8]r
hCX defaultr
r
}r
(h U h j
ubah*j ubhCX ). If r
r
}r
(h X ). If h j ubj )r
}r
(h X ``qformat``h,}r
(h.]h/]h0]h1]h4]uh j h8]r
hCX qformatr
r
}r
(h U h j
ubah*j ubhCX
is set to r
r
}r!
(h X
is set to h j ubj )r"
}r#
(h X ``xml``h,}r$
(h.]h/]h0]h1]h4]uh j h8]r%
hCX xmlr&
r'
}r(
(h U h j"
ubah*j ubhCXU , Metacat will return the XML document untransformed. If the
return format is set to r)
r*
}r+
(h XU , Metacat will return the XML document untransformed. If the
return format is set to h j ubj )r,
}r-
(h X ``html``h,}r.
(h.]h/]h0]h1]h4]uh j h8]r/
hCX htmlr0
r1
}r2
(h U h j,
ubah*j ubhCX , 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.r3
r4
}r5
(h X , 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
)r6
}r7
(h U h j h(h)h*jT
h,}r8
(jV
X centerh1]r9
Uid8r:
ah0]h.]h/]h4]uh6Nh7hh8]r;
(jZ
)r<
}r=
(h X .. 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>
(UuriX images/screenshots/image047.jpgr?
h1]h0]h.]h/]j_
}r@
U*j?
sh4]uh j6
h8]h*ja
ubjb
)rA
}rB
(h Xz The same document displayed using different qformat parameters (from left
to right: the default style-set, XML, and HTML).rC
h j6
h(h)h*jf
h,}rD
(h.]h/]h0]h1]h4]uh6M(h8]rE
hCXz The same document displayed using different qformat parameters (from left
to right: the default style-set, XML, and HTML).rF
rG
}rH
(h jC
h jA
ubaubeubhd)rI
}rJ
(h X Note 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,}rK
(h.]h/]h0]h1]h4]uh6M+h7hh8]rL
(hCX Note that the rM
rN
}rO
(h X Note that the h jI
ubj )rP
}rQ
(h X ``read``h,}rR
(h.]h/]h0]h1]h4]uh jI
h8]rS
hCX readrT
rU
}rV
(h U h jP
ubah*j ubhCXy action can be used to read both data files and metadata files.
To read a data file, you could use the following request:rW
rX
}rY
(h Xy action can be used to read both data files and metadata files.
To read a data file, you could use the following request:h jI
ubeubjl
)rZ
}r[
(h XT http://yourserver.com/yourcontext/metacat?action=read&docid=nceas.55&qformat=defaulth j h(h)h*jo
h,}r\
(jq
jr
h1]h0]h.]h/]h4]uh6M.h7hh8]r]
hCXT http://yourserver.com/yourcontext/metacat?action=read&docid=nceas.55&qformat=defaultr^
r_
}r`
(h U h jZ
ubaubhd)ra
}rb
(h X Where ``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,}rc
(h.]h/]h0]h1]h4]uh6M0h7hh8]rd
(hCX Where re
rf
}rg
(h X Where h ja
ubj )rh
}ri
(h X ``nceas.55``h,}rj
(h.]h/]h0]h1]h4]uh ja
h8]rk
hCX nceas.55rl
rm
}rn
(h U h jh
ubah*j ubhCX9 is the docid of the data file stored in the Metacat and
ro
rp
}rq
(h X9 is the docid of the data file stored in the Metacat and
h ja
ubj )rr
}rs
(h X ``default``h,}rt
(h.]h/]h0]h1]h4]uh ja
h8]ru
hCX defaultrv
rw
}rx
(h U h jr
ubah*j ubhCX` is the name of the style (you could also use "html" or "xml" or the
name of a customized skin).ry
rz
}r{
(h X` is the name of the style (you could also use "html" or "xml" or the
name of a customized skin).h ja
ubeubjl
)r|
}r}
(h Xr
Read Document
h j h(h)h*jo
h,}r~
(jq
jr
h1]h0]h.]h/]h4]uh6M6h7hh8]r
hCXr
Read Document
r
r
}r
(h U h j|
ubaubeubeubh!)r
}r
(h U h h&h(h)h*h+h,}r
(h.]h/]h0]h1]r
jr ah4]r
h
auh6MEh7hh8]r
(h:)r
}r
(h jw h j
h(h)h*h>h,}r
(h1]h0]h.]h/]h4]h@jq uh6MEh7hh8]r
hCX% Using the EarthGrid API (aka EcoGrid)r
r
}r
(h jw h j
ubaubcdocutils.nodes
note
r
)r
}r
(h X The 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
(h X The 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]uh6MIh8]r
(hCX) The EarthGrid/EcoGrid web service API is r
r
}r
(h X) The EarthGrid/EcoGrid web service API is h j
ubcdocutils.nodes
emphasis
r
)r
}r
(h X *deprecated*h,}r
(h.]h/]h0]h1]h4]uh j
h8]r
hCX
deprecatedr
r
}r
(h U h 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
(h X 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
(h Xl The 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]uh6MNh7hh8]r
hCXl The 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
(h j
h j
ubaubhd)r
}r
(h X Because 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]uh6MTh7hh8]r
hCX Because 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
(h j
h j
ubaubhd)r
}r
(h X For 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]uh6MXh7hh8]r
(hCX For more information about each EarthGrid service and its WSDL file, navigate
to the "services" page on your Metacat server
(e.g., r
r
}r
(h X For 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
(h X. 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
(h U h j
ubah*hrubhCXe ).
Note that the AdminService and Version service that appear on this page are
not part of EarthGrid.r
r
}r
(h Xe ).
Note that the AdminService and Version service that appear on this page are
not part of EarthGrid.h j
ubeubhd)r
}r
(h X EarthGrid/EcoGrid API Summaryr
h j
h(h)h*hsh,}r
(h.]h/]h0]h1]h4]uh6M^h7hh8]r
hCX EarthGrid/EcoGrid API Summaryr
r
}r
(h j
h j
ubaubj )r
}r
(h U h j
h(h)h*j h,}r
(h.]h/]h0]h1]h4]uh6Nh7hh8]r
j )r
}r
(h U h,}r
(h1]h0]h.]h/]h4]UcolsKuh j
h8]r
(j )r
}r
(h U h,}r
(h1]h0]h.]h/]h4]UcolwidthK uh j
h8]h*j ubj )r
}r
(h U h,}r
(h1]h0]h.]h/]h4]UcolwidthKeuh j
h8]h*j ubj )r
}r
(h U h,}r
(h.]h/]h0]h1]h4]uh j
h8]r
j )r
}r
(h U h,}r
(h.]h/]h0]h1]h4]uh j
h8]r
(j )r
}r
(h U h,}r
(h.]h/]h0]h1]h4]uh j
h8]r
hd)r
}r
(h X Servicer
h j
h(h)h*hsh,}r
(h.]h/]h0]h1]h4]uh6Mah8]r
hCX Servicer
r
}r
(h j
h j
ubaubah*j ubj )r
}r
(h U h,}r
(h.]h/]h0]h1]h4]uh j
h8]r
hd)r
}r
(h X Descriptionr
h j
h(h)h*hsh,}r
(h.]h/]h0]h1]h4]uh6Mah8]r
hCX Descriptionr
r
}r (h j
h j
ubaubah*j ubeh*j ubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j
h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r
(h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r
}r (h X AuthenticationQueryServicer h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mch8]r hCX AuthenticationQueryServicer r }r (h j h j
ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X` Search for and retrieve protected metadata and data from the EarthGrid as an authenticated user.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mch8]r hCX` Search for and retrieve protected metadata and data from the EarthGrid as an authenticated user.r r }r (h j h j ubaubhd)r! }r" (h X Methods: ``query``, ``get``h j h(h)h*hsh,}r# (h.]h/]h0]h1]h4]uh6Meh8]r$ (hCX Methods: r% r& }r' (h X Methods: h j! ubj )r( }r) (h X ``query``h,}r* (h.]h/]h0]h1]h4]uh j! h8]r+ hCX queryr, r- }r. (h U h j( ubah*j ubhCX , r/ r0 }r1 (h X , h j! ubj )r2 }r3 (h X ``get``h,}r4 (h.]h/]h0]h1]h4]uh j! h8]r5 hCX getr6 r7 }r8 (h U h j2 ubah*j ubeubeh*j ubeh*j ubj )r9 }r: (h U h,}r; (h.]h/]h0]h1]h4]uh j h8]r< (j )r= }r> (h U h,}r? (h.]h/]h0]h1]h4]uh j9 h8]r@ hd)rA }rB (h X AuthenticationServicerC h j= h(h)h*hsh,}rD (h.]h/]h0]h1]h4]uh6Mgh8]rE hCX AuthenticationServicerF rG }rH (h jC h jA ubaubah*j ubj )rI }rJ (h U h,}rK (h.]h/]h0]h1]h4]uh j9 h8]rL (hd)rM }rN (h X Log in and out of the EarthGridrO h jI h(h)h*hsh,}rP (h.]h/]h0]h1]h4]uh6Mgh8]rQ hCX Log in and out of the EarthGridrR rS }rT (h jO h jM ubaubhd)rU }rV (h X Methods: ``login``, ``logout``h jI h(h)h*hsh,}rW (h.]h/]h0]h1]h4]uh6Mih8]rX (hCX Methods: rY rZ }r[ (h X Methods: h jU ubj )r\ }r] (h X ``login``h,}r^ (h.]h/]h0]h1]h4]uh jU h8]r_ hCX loginr` ra }rb (h U h j\ ubah*j ubhCX , rc rd }re (h X , h jU ubj )rf }rg (h X
``logout``h,}rh (h.]h/]h0]h1]h4]uh jU h8]ri hCX logoutrj rk }rl (h U h jf ubah*j ubeubeh*j ubeh*j ubj )rm }rn (h U h,}ro (h.]h/]h0]h1]h4]uh j h8]rp (j )rq }rr (h U h,}rs (h.]h/]h0]h1]h4]uh jm h8]rt hd)ru }rv (h X IdentifierServicerw h jq h(h)h*hsh,}rx (h.]h/]h0]h1]h4]uh6Mkh8]ry hCX IdentifierServicerz r{ }r| (h jw h ju ubaubah*j ubj )r} }r~ (h U h,}r (h.]h/]h0]h1]h4]uh jm h8]r (hd)r }r (h XQ List, lookup, validate, and add Life Science Identifiers (LSIDs) to the EarthGridr h j} h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mkh8]r hCXQ List, lookup, validate, and add Life Science Identifiers (LSIDs) to the EarthGridr r }r (h j h j ubaubhd)r }r (h X] Methods: ``isRegistered``, ``addLSID``, ``getNextRevision``, ``getNextObject``, ``getAllIds``h j} h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mmh8]r (hCX Methods: r r }r (h X Methods: h j ubj )r }r (h X ``isRegistered``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX isRegisteredr r }r (h U h j ubah*j ubhCX , r r }r (h X , h j ubj )r }r (h X ``addLSID``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX addLSIDr r }r (h U h j ubah*j ubhCX , r r }r (h X , h j ubj )r }r (h X ``getNextRevision``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX getNextRevisionr r }r (h U h j ubah*j ubhCX , r r }r (h X , h j ubj )r }r (h X ``getNextObject``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX
getNextObjectr r }r (h U h j ubah*j ubhCX , r r }r (h X , h j ubj )r }r (h X
``getAllIds``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX getAllIdsr r }r (h U h j ubah*j ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X
PutServicer h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Moh8]r hCX
PutServicer r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X Write metadata to the EarthGridr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Moh8]r hCX Write metadata to the EarthGridr r }r (h j h j ubaubhd)r }r (h X Methods: ``put``h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mqh8]r (hCX Methods: r r }r (h X Methods: h j ubj )r }r (h X ``put``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX putr r }r (h U h j ubah*j ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X QueryServicer h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Msh8]r hCX QueryServicer r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X3 Search for and retrieve metadata from the EarthGridr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Msh8]r hCX3 Search for and retrieve metadata from the EarthGridr r }r (h j h j ubaubhd)r }r (h X Methods: ``query``, ``get``h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Muh8]r (hCX Methods: r r
}r (h X Methods: h j ubj )r }r
(h X ``query``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX queryr r }r (h U h j ubah*j ubhCX , r r }r (h X , h j ubj )r }r (h X ``get``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX getr r }r (h U h j ubah*j ubeubeh*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r (j )r! }r" (h U h,}r# (h.]h/]h0]h1]h4]uh j h8]r$ hd)r% }r& (h X RegistryServicer' h j! h(h)h*hsh,}r( (h.]h/]h0]h1]h4]uh6Mwh8]r) hCX RegistryServicer* r+ }r, (h j' h j% ubaubah*j ubj )r- }r. (h U h,}r/ (h.]h/]h0]h1]h4]uh j h8]r0 (hd)r1 }r2 (h X Add, 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,}r3 (h.]h/]h0]h1]h4]uh6Mwh8]r4 (hCXs Add, update, remove, and search for registered EarthGrid services.
Note: The WSDL for this service is found under r5 r6 }r7 (h Xs Add, update, remove, and search for registered EarthGrid services.
Note: The WSDL for this service is found under h j1 ubhi)r8 }r9 (h X3 http://ecogrid.ecoinformatics.org/registry/servicesr: h,}r; (Urefurij: h1]h0]h.]h/]h4]uh j1 h8]r< hCX3 http://ecogrid.ecoinformatics.org/registry/servicesr= r> }r? (h U h j8 ubah*hrubeubhd)r@ }rA (h X= Methods: ``add``, ``update``, ``remove``, ``list``, ``query``h j- h(h)h*hsh,}rB (h.]h/]h0]h1]h4]uh6Mzh8]rC (hCX Methods: rD rE }rF (h X Methods: h j@ ubj )rG }rH (h X ``add``h,}rI (h.]h/]h0]h1]h4]uh j@ h8]rJ hCX addrK rL }rM (h U h jG ubah*j ubhCX , rN rO }rP (h X , h j@ ubj )rQ }rR (h X
``update``h,}rS (h.]h/]h0]h1]h4]uh j@ h8]rT hCX updaterU rV }rW (h U h jQ ubah*j ubhCX , rX rY }rZ (h X , h j@ ubj )r[ }r\ (h X
``remove``h,}r] (h.]h/]h0]h1]h4]uh j@ h8]r^ hCX remover_ r` }ra (h U h j[ ubah*j ubhCX , rb rc }rd (h X , h j@ ubj )re }rf (h X ``list``h,}rg (h.]h/]h0]h1]h4]uh j@ h8]rh hCX listri rj }rk (h U h je ubah*j ubhCX , rl rm }rn (h X , h j@ ubj )ro }rp (h X ``query``h,}rq (h.]h/]h0]h1]h4]uh j@ h8]rr hCX queryrs rt }ru (h U h jo ubah*j ubeubeh*j ubeh*j ubeh*jJ ubeh*jK ubaubeubh!)rv }rw (h U h h&h(h)h*h+h,}rx (h.]h/]h0]h1]ry j ah4]rz hauh6M~h7hh8]r{ (h:)r| }r} (h j h jv h(h)h*h>h,}r~ (h1]h0]h.]h/]h4]h@j uh6M~h7hh8]r hCX Using Morphor r }r (h j h j| ubaubhd)r }r (h XH Morpho 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.r h jv h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r hCXH Morpho 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.r r }r (h j h j ubaubhd)r }r (h X Morpho 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.r h jv h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r hCX Morpho 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.r r }r (h j h j ubaubjQ
)r }r (h U h jv h(h)h*jT
h,}r (jV
X centerh1]r Uid9r ah0]h.]h/]h4]uh6Nh7hh8]r (jZ
)r }r (h X .. figure:: images/screenshots/image049.png
:align: center
Set the Metacat URL in the Morpho preferences to point to your Metacat.
h,}r (UuriX images/screenshots/image049.pngr h1]h0]h.]h/]j_
}r U*j sh4]uh j h8]h*ja
ubjb
)r }r (h XG Set the Metacat URL in the Morpho preferences to point to your Metacat.r h j h(h)h*jf
h,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCXG Set the Metacat URL in the Morpho preferences to point to your Metacat.r r }r (h j h j ubaubeubhd)r }r (h XM For more information about Morpho, please see: http://knb.ecoinformatics.org/r h jv h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r (hCX/ For more information about Morpho, please see: r r }r (h X/ For more information about Morpho, please see: h j ubhi)r }r (h X http://knb.ecoinformatics.org/r h,}r (Urefurij h1]h0]h.]h/]h4]uh j h8]r hCX http://knb.ecoinformatics.org/r r }r (h U h j ubah*hrubeubeubh!)r }r (h U h h&h(h)h*h+h,}r (h.]h/]h0]h1]r j ah4]r h auh6Mh7hh8]r (h:)r }r (h j h j h(h)h*h>h,}r (h1]h0]h.]h/]h4]h@j uh6Mh7hh8]r hCX Creating Your Own Clientr r }r (h j h j ubaubj
)r }r (h X NOTE: 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 j h(h)h*j
h,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r hd)r }r (h X NOTE: 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.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX NOTE: 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.r r }r (h j h j ubaubaubhd)r }r (h X Metacat'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.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r hCX Metacat'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.r r }r (h j h j ubaubhd)r }r (h X~ 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 j h(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 r r }r (h X~ The Client API is defined by the interface edu.ucsb.nceas.metacat.client.Metacat,
and all operations are fully defined in the h j ubhi)r }r (h X javadoc_Uresolvedr Kh j h*hrh,}r (UnameX javadocr Urefurir XA http://knb.ecoinformatics.org/software/metacat/dev/api/index.htmlr h1]h0]h.]h/]h4]uh8]r hCX javadocr r }r (h U h j ubaubhCX3 documentation. To use the
client API, include the r r }r (h X3 documentation. To use the
client API, include the h j ubj )r }r (h X ``metacat-client.jar``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX metacat-client.jarr r }r (h U h j ubah*j ubhCX , r r }r (h X , h j ubj )r }r (h X ``utilities.jar``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX
utilities.jarr r }r (h U h j ubah*j ubhCX , r r }r (h X , h j ubj )r }r (h X ``commons-io-2.0.jar``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX commons-io-2.0.jarr r }r (h U h j ubah*j ubhCX , and
r r }r (h X , and
h j ubj )r
}r (h X ``httpclient.jar``h,}r (h.]h/]h0]h1]h4]uh j h8]r
hCX httpclient.jarr r }r (h U h j
ubah*j ubhCXl in your classpath. After including these classes, you can
begin using the API methods (see the next table).r r }r (h Xl in your classpath. After including these classes, you can
begin using the API methods (see the next table).h j ubeubcdocutils.nodes
target
r )r }r (h XN .. _javadoc: http://knb.ecoinformatics.org/software/metacat/dev/api/index.htmlU
referencedr Kh j h(h)h*Utargetr h,}r (j j h1]r Ujavadocr ah0]h.]h/]h4]r hauh6Mh7hh8]ubhd)r }r (h Xr The following code block displays a typical session for reading a document
from Metacat using the Java client API.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh7hh8]r! hCXr The following code block displays a typical session for reading a document
from Metacat using the Java client API.r" r# }r$ (h j h j ubaubjl
)r% }r& (h X String 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 j h(h)h*jo
h,}r' (jq
jr
h1]h0]h.]h/]h4]uh6Mh7hh8]r( hCX String 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+ (h U h j% ubaubj )r, }r- (h U h j h(h)h*j h,}r. (h.]h/]h0]h1]h4]uh6Nh7hh8]r/ j )r0 }r1 (h U h,}r2 (h1]h0]h.]h/]h4]UcolsKuh j, h8]r3 (j )r4 }r5 (h U h,}r6 (h1]h0]h.]h/]h4]UcolwidthKuh j0 h8]h*j ubj )r7 }r8 (h U h,}r9 (h1]h0]h.]h/]h4]UcolwidthKuh j0 h8]h*j ubj )r: }r; (h U h,}r< (h1]h0]h.]h/]h4]UcolwidthKuh j0 h8]h*j ubj )r= }r> (h U h,}r? (h.]h/]h0]h1]h4]uh j0 h8]r@ j )rA }rB (h U h,}rC (h.]h/]h0]h1]h4]uh j= h8]rD (j )rE }rF (h U h,}rG (h.]h/]h0]h1]h4]uh jA h8]rH hd)rI }rJ (h X MethodrK h jE h(h)h*hsh,}rL (h.]h/]h0]h1]h4]uh6Mh8]rM hCX MethodrN rO }rP (h jK h jI ubaubah*j ubj )rQ }rR (h U h,}rS (h.]h/]h0]h1]h4]uh jA h8]rT hd)rU }rV (h X Parameters and ThrowsrW h jQ h(h)h*hsh,}rX (h.]h/]h0]h1]h4]uh6Mh8]rY hCX Parameters and ThrowsrZ r[ }r\ (h jW h jU ubaubah*j ubj )r] }r^ (h U h,}r_ (h.]h/]h0]h1]h4]uh jA h8]r` hd)ra }rb (h X Descriptionrc h j] h(h)h*hsh,}rd (h.]h/]h0]h1]h4]uh6Mh8]re hCX Descriptionrf rg }rh (h jc h ja ubaubah*j ubeh*j ubah*j ubj )ri }rj (h U h,}rk (h.]h/]h0]h1]h4]uh j0 h8]rl (j )rm }rn (h U h,}ro (h.]h/]h0]h1]h4]uh ji h8]rp (j )rq }rr (h U h,}rs (h.]h/]h0]h1]h4]uh jm h8]rt hd)ru }rv (h X deleterw h jq h(h)h*hsh,}rx (h.]h/]h0]h1]h4]uh6Mh8]ry hCX deleterz r{ }r| (h jw h ju ubaubah*j ubj )r} }r~ (h U h,}r (h.]h/]h0]h1]h4]uh jm h8]r hd)r }r (h Xy ``public String delete(String docid) throws InsufficientKarmaException, MetacatException, MetacatInaccessibleException;``r h j} h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r j )r }r (h j h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXu public String delete(String docid) throws InsufficientKarmaException, MetacatException, MetacatInaccessibleException;r r }r (h U h j ubah*j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh jm h8]r hd)r }r (h X) Delete an XML document in the repository.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX) Delete an XML document in the repository.r r }r (h j h j ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh ji h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X getAllDocidsr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX getAllDocidsr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h XE ``public Vector getAllDocids(String scope) throws MetacatException;``r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r j )r }r (h j h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXA public Vector getAllDocids(String scope) throws MetacatException;r r }r (h U h j ubah*j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h Xs Return a list of all docids that match a given scope. If scope is null, return all docids registered in the system.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCXs Return a list of all docids that match a given scope. If scope is null, return all docids registered in the system.r r }r (h j h j ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh ji h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X getLastDocidr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX getLastDocidr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h XE ``public String getLastDocid(String scope) throws MetacatException;``r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r j )r }r (h j h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXA public String getLastDocid(String scope) throws MetacatException;r r }r (h U h j ubah*j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X Return the highest document ID for a given scope. Used by clients to determine the next free identifier in a sequence for a given scope.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX Return the highest document ID for a given scope. Used by clients to determine the next free identifier in a sequence for a given scope.r r }r (h j h j ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh ji h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X getloggedinuserinfor h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX getloggedinuserinfor r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h XL ``public String getloggedinuserinfo() throws MetacatInaccessibleException;``r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r j )r
}r (h j h,}r (h.]h/]h0]h1]h4]uh j h8]r
hCXH public String getloggedinuserinfo() throws MetacatInaccessibleException;r r }r (h U h j
ubah*j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X+ Return the logged in user for this session.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX+ Return the logged in user for this session.r r }r (h j h j ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh ji h8]r (j )r! }r" (h U h,}r# (h.]h/]h0]h1]h4]uh j h8]r$ hd)r% }r& (h X getNewestDocRevisionr' h j! h(h)h*hsh,}r( (h.]h/]h0]h1]h4]uh6Mh8]r) hCX getNewestDocRevisionr* r+ }r, (h j' h j% ubaubah*j ubj )r- }r. (h U h,}r/ (h.]h/]h0]h1]h4]uh j h8]r0 hd)r1 }r2 (h XJ ``public int getNewestDocRevision(String docId) throws MetacatException;``r3 h j- h(h)h*hsh,}r4 (h.]h/]h0]h1]h4]uh6Mh8]r5 j )r6 }r7 (h j3 h,}r8 (h.]h/]h0]h1]h4]uh j1 h8]r9 hCXF public int getNewestDocRevision(String docId) throws MetacatException;r: r; }r< (h U h j6 ubah*j ubaubah*j ubj )r= }r> (h U h,}r? (h.]h/]h0]h1]h4]uh j h8]r@ hd)rA }rB (h XA Return the latest revision of specified the document from MetacatrC h j= h(h)h*hsh,}rD (h.]h/]h0]h1]h4]uh6Mh8]rE hCXA Return the latest revision of specified the document from MetacatrF rG }rH (h jC h jA ubaubah*j ubeh*j ubj )rI }rJ (h U h,}rK (h.]h/]h0]h1]h4]uh ji h8]rL (j )rM }rN (h U h,}rO (h.]h/]h0]h1]h4]uh jI h8]rP hd)rQ }rR (h X getSessonIdrS h jM h(h)h*hsh,}rT (h.]h/]h0]h1]h4]uh6Mh8]rU hCX getSessonIdrV rW }rX (h jS h jQ ubaubah*j ubj )rY }rZ (h U h,}r[ (h.]h/]h0]h1]h4]uh jI h8]r\ hd)r] }r^ (h X! ``public String getSessionId();``r_ h jY h(h)h*hsh,}r` (h.]h/]h0]h1]h4]uh6Mh8]ra j )rb }rc (h j_ h,}rd (h.]h/]h0]h1]h4]uh j] h8]re hCX public String getSessionId();rf rg }rh (h U h jb ubah*j ubaubah*j ubj )ri }rj (h U h,}rk (h.]h/]h0]h1]h4]uh jI h8]rl hd)rm }rn (h X/ Return the session identifier for this session.ro h ji h(h)h*hsh,}rp (h.]h/]h0]h1]h4]uh6Mh8]rq hCX/ Return the session identifier for this session.rr rs }rt (h jo h jm ubaubah*j ubeh*j ubj )ru }rv (h U h,}rw (h.]h/]h0]h1]h4]uh ji h8]rx (j )ry }rz (h U h,}r{ (h.]h/]h0]h1]h4]uh ju h8]r| hd)r} }r~ (h X insertr h jy h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX insertr r }r (h j h j} ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh ju h8]r hd)r }r (h X ``public String insert(String docid, Reader xmlDocument, Reader schema) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;``r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r j )r }r (h j h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX public String insert(String docid, Reader xmlDocument, Reader schema) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;r r }r (h U h j ubah*j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh ju h8]r hd)r }r (h X+ Insert an XML document into the repository.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX+ Insert an XML document into the repository.r r }r (h j h j ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh ji h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X isRegisteredr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX isRegisteredr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h XF ``public boolean isRegistered(String docid) throws MetacatException;``r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r j )r }r (h j h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXB public boolean isRegistered(String docid) throws MetacatException;r r }r (h U h j ubah*j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X7 Return true if given docid is registered; false if not.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX7 Return true if given docid is registered; false if not.r r }r (h j h j ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh ji h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X loginr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX loginr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h Xt ``public String login(String username, String password) throws MetacatAuthException, MetacatInaccessibleException;``r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r j )r }r (h j h,}r (h.]h/]h0]h1]h4]uh j h8]r hCXp public String login(String username, String password) throws MetacatAuthException, MetacatInaccessibleException;r r }r (h U h j ubah*j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X Log in to a Metacat server.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX Log in to a Metacat server.r r }r (h j h j ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh ji h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X logoutr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX logoutr r }r (h j h j ubaubah*j ubj )r }r
(h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r
}r (h XQ ``public String logout() throws MetacatInaccessibleException, MetacatException;``r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r j )r }r (h j h,}r (h.]h/]h0]h1]h4]uh j
h8]r hCXM public String logout() throws MetacatInaccessibleException, MetacatException;r r }r (h U h j ubah*j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X Log out of a Metacat server.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r! hCX Log out of a Metacat server.r" r# }r$ (h j h j ubaubah*j ubeh*j ubj )r% }r& (h U h,}r' (h.]h/]h0]h1]h4]uh ji h8]r( (j )r) }r* (h U h,}r+ (h.]h/]h0]h1]h4]uh j% h8]r, hd)r- }r. (h X queryr/ h j) h(h)h*hsh,}r0 (h.]h/]h0]h1]h4]uh6Mh8]r1 hCX queryr2 r3 }r4 (h j/ h j- ubaubah*j ubj )r5 }r6 (h U h,}r7 (h.]h/]h0]h1]h4]uh j% h8]r8 hd)r9 }r: (h XZ ``public Reader query(Reader xmlQuery) throws MetacatInaccessibleException, IOException;``r; h j5 h(h)h*hsh,}r< (h.]h/]h0]h1]h4]uh6Mh8]r= j )r> }r? (h j; h,}r@ (h.]h/]h0]h1]h4]uh j9 h8]rA hCXV public Reader query(Reader xmlQuery) throws MetacatInaccessibleException, IOException;rB rC }rD (h U h j> ubah*j ubaubah*j ubj )rE }rF (h U h,}rG (h.]h/]h0]h1]h4]uh j% h8]rH hd)rI }rJ (h XC Query the Metacat repository and return the result set as a Reader.rK h jE h(h)h*hsh,}rL (h.]h/]h0]h1]h4]uh6Mh8]rM hCXC Query the Metacat repository and return the result set as a Reader.rN rO }rP (h jK h jI ubaubah*j ubeh*j ubj )rQ }rR (h U h,}rS (h.]h/]h0]h1]h4]uh ji h8]rT (j )rU }rV (h U h,}rW (h.]h/]h0]h1]h4]uh jQ h8]rX hd)rY }rZ (h X queryr[ h jU h(h)h*hsh,}r\ (h.]h/]h0]h1]h4]uh6Mh8]r] hCX queryr^ r_ }r` (h j[ h jY ubaubah*j ubj )ra }rb (h U h,}rc (h.]h/]h0]h1]h4]uh jQ h8]rd hd)re }rf (h Xj ``public Reader query(Reader xmlQuery, String qformat) throws MetacatInaccessibleException, IOException;``rg h ja h(h)h*hsh,}rh (h.]h/]h0]h1]h4]uh6Mh8]ri j )rj }rk (h jg h,}rl (h.]h/]h0]h1]h4]uh je h8]rm hCXf public Reader query(Reader xmlQuery, String qformat) throws MetacatInaccessibleException, IOException;rn ro }rp (h U h jj ubah*j ubaubah*j ubj )rq }rr (h U h,}rs (h.]h/]h0]h1]h4]uh jQ h8]rt hd)ru }rv (h Xr Query the Metacat repository with the given metacat-compatible query format and return the result set as a Reader.rw h jq h(h)h*hsh,}rx (h.]h/]h0]h1]h4]uh6Mh8]ry hCXr Query the Metacat repository with the given metacat-compatible query format and return the result set as a Reader.rz r{ }r| (h jw h ju ubaubah*j ubeh*j ubj )r} }r~ (h U h,}r (h.]h/]h0]h1]h4]uh ji h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j} h8]r hd)r }r (h X readr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX readr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j} h8]r hd)r }r (h X ``public Reader read(String docid) throws InsufficientKarmaException, MetacatInaccessibleException, DocumentNotFoundException, MetacatException;``r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r j )r }r (h j h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX public Reader read(String docid) throws InsufficientKarmaException, MetacatInaccessibleException, DocumentNotFoundException, MetacatException;r r }r (h U h j ubah*j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j} h8]r hd)r }r (h X- Read an XML document from the Metacat server.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX- Read an XML document from the Metacat server.r r }r (h j h j ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh ji h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X readInlineDatar h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX readInlineDatar r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X ``public Reader readInlineData(String inlinedataid) throws InsufficientKarmaException, MetacatInaccessibleException, MetacatException;``r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r j )r }r (h j h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX public Reader readInlineData(String inlinedataid) throws InsufficientKarmaException, MetacatInaccessibleException, MetacatException;r r }r (h U h j ubah*j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X1 Read inline data from the Metacat server session.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX1 Read inline data from the Metacat server session.r r }r (h j h j ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh ji h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X setAccessr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX setAccessr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X ``public String setAccess(String _docid, String _principal, String _permission, String _permType, String _permOrder ); throws InsufficientKarmaException, MetacatException, MetacatInaccessibleException;``r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r j )r }r (h j h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX public String setAccess(String _docid, String _principal, String _permission, String _permType, String _permOrder ); throws InsufficientKarmaException, MetacatException, MetacatInaccessibleException;r r }r (h U h j ubah*j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X> Set permissions for an XML document in the Metacat repository.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX> Set permissions for an XML document in the Metacat repository.r r }r (h j h j ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh ji h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r
(h X
setMetacatUrlr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r
hCX
setMetacatUrlr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X1 ``public void setMetacatUrl(String metacatUrl);``r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r j )r }r (h j h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX- public void setMetacatUrl(String metacatUrl);r r }r (h U h j ubah*j ubaubah*j ubj )r! }r" (h U h,}r# (h.]h/]h0]h1]h4]uh j h8]r$ hd)r% }r& (h X7 Set the MetacatUrl to which connections should be made.r' h j! h(h)h*hsh,}r( (h.]h/]h0]h1]h4]uh6Mh8]r) hCX7 Set the MetacatUrl to which connections should be made.r* r+ }r, (h j' h j% ubaubah*j ubeh*j ubj )r- }r. (h U h,}r/ (h.]h/]h0]h1]h4]uh ji h8]r0 (j )r1 }r2 (h U h,}r3 (h.]h/]h0]h1]h4]uh j- h8]r4 hd)r5 }r6 (h X setSessionIdr7 h j1 h(h)h*hsh,}r8 (h.]h/]h0]h1]h4]uh6Mh8]r9 hCX setSessionIdr: r; }r< (h j7 h j5 ubaubah*j ubj )r= }r> (h U h,}r? (h.]h/]h0]h1]h4]uh j- h8]r@ hd)rA }rB (h X/ ``public void setSessionId(String sessionId);``rC h j= h(h)h*hsh,}rD (h.]h/]h0]h1]h4]uh6Mh8]rE j )rF }rG (h jC h,}rH (h.]h/]h0]h1]h4]uh jA h8]rI hCX+ public void setSessionId(String sessionId);rJ rK }rL (h U h jF ubah*j ubaubah*j ubj )rM }rN (h U h,}rO (h.]h/]h0]h1]h4]uh j- h8]rP hd)rQ }rR (h X, Set the session identifier for this session.rS h jM h(h)h*hsh,}rT (h.]h/]h0]h1]h4]uh6Mh8]rU hCX, Set the session identifier for this session.rV rW }rX (h jS h jQ ubaubah*j ubeh*j ubj )rY }rZ (h U h,}r[ (h.]h/]h0]h1]h4]uh ji h8]r\ (j )r] }r^ (h U h,}r_ (h.]h/]h0]h1]h4]uh jY h8]r` hd)ra }rb (h X updaterc h j] h(h)h*hsh,}rd (h.]h/]h0]h1]h4]uh6Mh8]re hCX updaterf rg }rh (h jc h ja ubaubah*j ubj )ri }rj (h U h,}rk (h.]h/]h0]h1]h4]uh jY h8]rl hd)rm }rn (h X ``public String update(String docid, Reader xmlDocument, Reader schema) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;``ro h ji h(h)h*hsh,}rp (h.]h/]h0]h1]h4]uh6Mh8]rq j )rr }rs (h jo h,}rt (h.]h/]h0]h1]h4]uh jm h8]ru hCX public String update(String docid, Reader xmlDocument, Reader schema) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;rv rw }rx (h U h jr ubah*j ubaubah*j ubj )ry }rz (h U h,}r{ (h.]h/]h0]h1]h4]uh jY h8]r| hd)r} }r~ (h XX Update an XML document in the repository by providing a new version of the XML document.r h jy h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCXX Update an XML document in the repository by providing a new version of the XML document.r r }r (h j h j} ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh ji h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X uploadr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX uploadr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X ``public String upload(String docid, File file) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;``r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r j )r }r (h j h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX public String upload(String docid, File file) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;r r }r (h U h j ubah*j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X+ Upload a data document into the repository.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX+ Upload a data document into the repository.r r }r (h j h j ubaubah*j ubeh*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh ji h8]r (j )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X uploadr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX uploadr r }r (h j h j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X ``public String publicupload(String docid, String fileName, InputStream fileData, int size) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;``r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r j )r }r (h j h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX public String publicupload(String docid, String fileName, InputStream fileData, int size) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;r r }r (h U h j ubah*j ubaubah*j ubj )r }r (h U h,}r (h.]h/]h0]h1]h4]uh j h8]r hd)r }r (h X+ Upload a data document into the repository.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Mh8]r hCX+ Upload a data document into the repository.r r }r (h j h j ubaubah*j ubeh*j ubeh*jJ ubeh*jK ubaubeubeubh(h)h*h+h,}r (h.]h/]h0]h1]r hah4]r hauh6K!h7hh8]r (h:)r }r (h hh h$h(h)h*h>h,}r (h1]h0]h.]h/]h4]h@huh6K!h7hh8]r hCX Using the Registryr r }r (h hh j ubaubhd)r }r (h X Metacat'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 (hCXo Metacat'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
(r r }r (h Xo Metacat'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 j ubhi)r }r (h X http://knb.ecoinformatics.org/r h,}r (Urefurij h1]h0]h.]h/]h4]uh j h8]r hCX http://knb.ecoinformatics.org/r r }r (h U h j ubah*hrubhCX_ ). Please note that at this time, the Registry
interface has only been tested on Linux systems.r r }r (h X_ ). Please note that at this time, the Registry
interface has only been tested on Linux systems.h j ubeubjQ
)r }r (h U h h$h(h)h*jT
h,}r (jV
X centerh1]r Uid1r ah0]h.]h/]h4]uh6Nh7hh8]r (jZ
)r }r (h X .. 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 (UuriX images/screenshots/image033.jpgr h1]h0]h.]h/]j_
}r U*j sh4]uh j h8]h*ja
ubjb
)r }r (h X An example installation of the Register's web interface. Customize the
displayed and required modules with the Skins Configuration settings.r h j h(h)h*jf
h,}r (h.]h/]h0]h1]h4]uh6K0h8]r hCX An example installation of the Register's web interface. Customize the
displayed and required modules with the Skins Configuration settings.r
r }r (h j h j ubaubeubhd)r
}r (h X You 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]r hCX You 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 r }r (h j h j
ubaubh"h!)r }r (h U h h$h(h)h*h+h,}r (h.]h/]h0]h1]r hah4]r h auh6Kh7hh8]r (h:)r }r (h hh j h(h)h*h>h,}r (h1]h0]h.]h/]h4]h@huh6Kh7hh8]r hCX Customizing the Registryr r }r! (h hh j ubaubhd)r" }r# (h X Before 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 j h(h)h*hsh,}r$ (h.]h/]h0]h1]h4]uh6Kh7hh8]r% (hCX Before 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( (h X Before 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* (h X http:/r+ h,}r, (Urefurij+ h1]h0]h.]h/]h4]uh j" h8]r- hCX http:/r. r/ }r0 (h U h 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.r1 r2 }r3 (h X //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)r4 }r5 (h X Once 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 j h(h)h*hsh,}r6 (h.]h/]h0]h1]h4]uh6Kh7hh8]r7 (hCXq Once you have saved your changes, you must restart Tomcat for them to come
into effect. To restart Tomcat, type: r8 r9 }r: (h Xq Once you have saved your changes, you must restart Tomcat for them to come
into effect. To restart Tomcat, type: h j4 ubj )r; }r< (h X$ ``sudo /etc/init.d/tomcat7 restart``h,}r= (h.]h/]h0]h1]h4]uh j4 h8]r> hCX sudo /etc/init.d/tomcat7 restartr? r@ }rA (h U h j; ubah*j ubhCX? or an
equivalent command appropriate to your operating system.rB rC }rD (h X? or an
equivalent command appropriate to your operating system.h j4 ubeubjQ
)rE }rF (h U h j h(h)h*jT
h,}rG (jV
X centerh1]rH Uid3rI ah0]h.]h/]h4]uh6Nh7hh8]rJ (jZ
)rK }rL (h XL .. 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,}rM (UuriX images/screenshots/image037.jpgrN h1]h0]h.]h/]j_
}rO U*jN sh4]uh jE h8]h*ja
ubjb
)rP }rQ (h X 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.rR h jE h(h)h*jf
h,}rS (h.]h/]h0]h1]h4]uh6Kh8]rT hCX 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.rU rV }rW (h jR h jP ubaubeubeubh!)rX }rY (h U h h$h(h)h*h+h,}rZ (h.]h/]h0]h1]r[ hah4]r\ hauh6Kh7hh8]r] (h:)r^ }r_ (h hh jX h(h)h*h>h,}r` (h1]h0]h.]h/]h4]h@huh6Kh7hh8]ra hCX LDAP account managementrb rc }rd (h hh j^ ubaubhd)re }rf (h X If you intend to use Metacat's built-in LDAP account management feature,
you will need public and private keys for the reCaptcha widget.rg h jX h(h)h*hsh,}rh (h.]h/]h0]h1]h4]uh6Kh7hh8]ri hCX If you intend to use Metacat's built-in LDAP account management feature,
you will need public and private keys for the reCaptcha widget.rj rk }rl (h jg h je ubaubhd)rm }rn (h X} 1. Get private and public recaptcha keys from Google using your Google account:
https://www.google.com/recaptcha/admin/createh jX h(h)h*hsh,}ro (h.]h/]h0]h1]h4]uh6Kh7hh8]rp (hCXP 1. Get private and public recaptcha keys from Google using your Google account:
rq rr }rs (h XP 1. Get private and public recaptcha keys from Google using your Google account:
h jm ubhi)rt }ru (h X- https://www.google.com/recaptcha/admin/createrv h,}rw (Urefurijv h1]h0]h.]h/]h4]uh jm h8]rx hCX- https://www.google.com/recaptcha/admin/createry rz }r{ (h U h jt ubah*hrubeubcdocutils.nodes
enumerated_list
r| )r} }r~ (h U h jX h(h)h*Uenumerated_listr h,}r (Usuffixr U.Ustartr Kh1]h0]h.]Uprefixr U h/]h4]Uenumtyper Uarabicr uh6Kh7hh8]r h_)r }r (h XD Configure Metacat to use those keys in the metacat.properties file:
h j} h(h)h*hh,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r hd)r }r (h XC Configure Metacat to use those keys in the metacat.properties file:r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh8]r hCXC Configure Metacat to use those keys in the metacat.properties file:r r }r (h j h j ubaubaubaubcdocutils.nodes
block_quote
r )r }r (h U h jX h(h)h*U block_quoter h,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r jl
)r }r (h XW ldap.recaptcha.publickey=
ldap.recaptcha.privatekey=h j h*jo
h,}r (jq
jr
h1]h0]h.]h/]h4]uh6Kh8]r hCXW ldap.recaptcha.publickey=
ldap.recaptcha.privatekey=r r }r (h U h j ubaubaubj| )r }r (h U h jX h(h)h*j h,}r (j U.j Kh1]h0]h.]j U h/]h4]j j uh6Kh7hh8]r h_)r }r (h X Restart Tomcat
h j h(h)h*hh,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r hd)r }r (h X Restart Tomcatr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh8]r hCX Restart Tomcatr r }r (h j h j ubaubaubaubeubeubh(h)h*h+h,}r (h.]h/]h0]h1]r hah4]r h
auh6K8h7hh8]r (h:)r }r (h hh h"h(h)h*h>h,}r (h1]h0]h.]h/]h4]h@huh6K8h7hh8]r hCX Installing the Registryr r }r (h hh j ubaubhd)r }r (h X In 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).r h h"h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6K9h7hh8]r hCX In 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).r r }r (h j h j ubaubhd)r }r (h X To install and run the Registry:r h h"h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6K=h7hh8]r hCX To install and run the Registry:r r }r (h j h j ubaubj| )r }r (h U h h"h(h)h*j h,}r (j U.h1]h0]h.]j U h/]h4]j j uh6K@h7hh8]r h_)r }r (h X\ Install the required system libraries using Ubuntu/Debian (instructions
Red Hat in sidebar)
h j h(h)h*hh,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r hd)r }r (h X[ Install the required system libraries using Ubuntu/Debian (instructions
Red Hat in sidebar)r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6K@h8]r hCX[ Install the required system libraries using Ubuntu/Debian (instructions
Red Hat in sidebar)r r }r (h j h j ubaubaubaubj )r }r (h U h h"h(Nh*j h,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r hY)r }r (h U h,}r (j X *h1]h0]h.]h/]h4]uh j h8]r (h_)r }r (h X Install 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 j h8]r (hd)r }r (h X Install the librariesr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6KCh8]r hCX Install the librariesr r }r (h j h j ubaubjl
)r }r (h X 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 -yh j h*jo
h,}r (jq
jr
h1]h0]h.]h/]h4]uh6KGh8]r hCX 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 -yr r }r (h U h j ubaubeh*hubh_)r }r (h X Install 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
h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X# Install two more package using cpanr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6KLh8]r hCX# Install two more package using cpanr r }r (h j h j ubaubjl
)r }r (h X sudo cpan -i Digest::SHA1
sudo cpan -i Config::Properties
sudo cpan -i Scalar::Util
sudo cpan -i Captcha:reCAPTCHA
sudo cpan -i DateTimeh j h*jo
h,}r (jq
jr
h1]h0]h.]h/]h4]uh6KPh8]r hCX sudo cpan -i Digest::SHA1
sudo cpan -i Config::Properties
sudo cpan -i Scalar::Util
sudo cpan -i Captcha:reCAPTCHA
sudo cpan -i DateTimer r }r (h U h j ubaubeh*hubeh*h\ubaubcdocutils.nodes
sidebar
r )r
}r (h X] * 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 DateTimeh h"h(Nh*Usidebarr h,}r
(h.]h/]h0]h1]h4]uh6Nh7hh8]r (h:)r }r (h X+ Instructions for Red Hat (Alternate Step 2)r h,}r (h.]h/]h0]h1]h4]uh j
h8]r hCX+ Instructions for Red Hat (Alternate Step 2)r r }r (h j h j ubah*h>ubhY)r }r (h U h,}r (j X *h1]h0]h.]h/]h4]uh j
h8]r (h_)r }r (h XU Install the libraries
::
sudo yum install gcc libxml2-devel libxslt-devel ant -y
h,}r (h.]h/]h0]h1]h4]uh j h8]r (hd)r }r (h X Install the librariesr! h j h(h)h*hsh,}r" (h.]h/]h0]h1]h4]uh6KZh8]r# hCX Install the librariesr$ r% }r& (h j! h j ubaubjl
)r' }r( (h X7 sudo yum install gcc libxml2-devel libxslt-devel ant -yh j h*jo
h,}r) (jq
jr
h1]h0]h.]h/]h4]uh6K^h8]r* hCX7 sudo yum install gcc libxml2-devel libxslt-devel ant -yr+ r, }r- (h U h j' ubaubeh*hubh_)r. }r/ (h X 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
h,}r0 (h.]h/]h0]h1]h4]uh j h8]r1 (hd)r2 }r3 (h X 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.r4 h j. h(h)h*hsh,}r5 (h.]h/]h0]h1]h4]uh6K`h8]r6 hCX 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.r7 r8 }r9 (h j4 h j2 ubaubjl
)r: }r; (h X$ 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@ (h U h j: ubaubeh*hubh_)rA }rB (h X; You should now see a prompt which looks like:
::
cpan>
h,}rC (h.]h/]h0]h1]h4]uh j h8]rD (hd)rE }rF (h X- You should now see a prompt which looks like:rG h jA h(h)h*hsh,}rH (h.]h/]h0]h1]h4]uh6Kih8]rI hCX- You should now see a prompt which looks like:rJ rK }rL (h jG h jE ubaubjl
)rM }rN (h X cpan>h jA h*jo
h,}rO (jq
jr
h1]h0]h.]h/]h4]uh6Kmh8]rP hCX cpan>rQ rR }rS (h U h jM ubaubeh*hubh_)rT }rU (h X 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
h,}rV (h.]h/]h0]h1]h4]uh j h8]rW (hd)rX }rY (h X 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.rZ h jT h(h)h*hsh,}r[ (h.]h/]h0]h1]h4]uh6Koh8]r\ hCX 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.r] r^ }r_ (h jZ h jX ubaubjl
)r` }ra (h X install Bundle::CPAN
reload cpanh jT h*jo
h,}rb (jq
jr
h1]h0]h.]h/]h4]uh6Kuh8]rc hCX install Bundle::CPAN
reload cpanrd re }rf (h U h j` ubaubeh*hubh_)rg }rh (h X 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 DateTimeh,}ri (h.]h/]h0]h1]h4]uh j h8]rj (hd)rk }rl (h X 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.rm h jg h(h)h*hsh,}rn (h.]h/]h0]h1]h4]uh6Kxh8]ro hCX 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.rp rq }rr (h jm h jk ubaubjl
)rs }rt (h X 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 DateTimeh jg h*jo
h,}ru (jq
jr
h1]h0]h.]h/]h4]uh6K~h8]rv hCX 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 DateTimerw rx }ry (h U h js ubaubeh*hubeh*h\ubeubj| )rz }r{ (h U h h"h(h)h*j h,}r| (j U.j Kh1]h0]h.]j U h/]h4]j j uh6Kh7hh8]r} (h_)r~ }r (h X Double-check that Metacat's temporary folder, application.tempDir, is
writable by the apache user, usually www-data or apache.
h jz h(h)h*hh,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r hd)r }r (h X~ Double-check that Metacat's temporary folder, application.tempDir, is
writable by the apache user, usually www-data or apache.r h j~ h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh8]r hCX~ Double-check that Metacat's temporary folder, application.tempDir, is
writable by the apache user, usually www-data or apache.r r }r (h j h j ubaubaubh_)r }r (h X Make sure that the following scripts (found in ``/webapps/metacat/cgi-bin``)
are executable: register-dataset.cgi and ldapweb.cgi.
h jz h(h)h*hh,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r hd)r }r (h X Make sure that the following scripts (found in ``/webapps/metacat/cgi-bin``)
are executable: register-dataset.cgi and ldapweb.cgi.h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh8]r (hCX/ Make sure that the following scripts (found in r r }r (h X/ Make sure that the following scripts (found in h j ubj )r }r (h X) ``/webapps/metacat/cgi-bin``h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX% /webapps/metacat/cgi-binr r }r (h U h j ubah*j ubhCX7 )
are executable: register-dataset.cgi and ldapweb.cgi.r r }r (h X7 )
are executable: register-dataset.cgi and ldapweb.cgi.h j ubeubaubeubj )r }r (h U h h"h(h)h*j h,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r jl
)r }r (h X9 sudo chmod +x /webapps/metacat/cgi-bin/*.cgih j h*jo
h,}r (jq
jr
h1]h0]h.]h/]h4]uh6Kh8]r hCX9 sudo chmod +x /webapps/metacat/cgi-bin/*.cgir r }r (h U h j ubaubaubj| )r }r (h U h h"h(h)h*j h,}r (j U.j Kh1]h0]h.]j U h/]h4]j j uh6Kh7hh8]r (h_)r }r (h X< Ensure apache CGI module is enabled
::
sudo a2enmod cgid
h j h(h)h*hh,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r (hd)r }r (h X# Ensure apache CGI module is enabledr h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh8]r hCX# Ensure apache CGI module is enabledr r }r (h j h j ubaubjl
)r }r (h X sudo a2enmod cgidh j h*jo
h,}r (jq
jr
h1]h0]h.]h/]h4]uh6Kh8]r hCX sudo a2enmod cgidr r }r (h U h j ubaubeubh_)r }r (h X Restart Apache.
h j h(h)h*hh,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r hd)r }r (h X Restart Apache.r h j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh8]r hCX Restart Apache.r r }r (h j h j ubaubaubeubj )r }r (h U h h"h(h)h*j h,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r jl
)r }r (h X sudo /etc/init.d/apache2 restarth j h*jo
h,}r (jq
jr
h1]h0]h.]h/]h4]uh6Kh8]r hCX sudo /etc/init.d/apache2 restartr r }r (h U h j ubaubaubj| )r }r (h U h h"h(h)h*j h,}r (j U.j Kh1]h0]h.]j U h/]h4]j j uh6Kh7hh8]r h_)r }r (h XX Visit 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 j h(h)h*hh,}r (h.]h/]h0]h1]h4]uh6Nh7hh8]r hd)r }r (h XW Visit 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 j h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh8]r (hCX Visit the resulting URL:
r r }r (h X Visit the resulting URL:
h j ubhi)r }r (h X http:/r h,}r (Urefurij h1]h0]h.]h/]h4]uh j h8]r hCX http:/r r }r (h U h j ubah*hrubhCXC //cgi-bin/register-dataset.cgi?cfg=default
Where r r }r (h XC //cgi-bin/register-dataset.cgi?cfg=default
Where h j ubj )r }r (h X ````h,}r (h.]h/]h0]h1]h4]uh j h8]r hCX r r }r (h U h j ubah*j ubhCX 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:
r r }r (h X 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 j ubhi)r }r (h X! http://knb.ecoinformatics.org/knbr h,}r (Urefurij h1]h0]h.]h/]h4]uh j h8]r hCX! http://knb.ecoinformatics.org/knbr r }r (h U h j ubah*hrubhCX .r }r (h X .h j ubeubaubaubhd)r }r (h XN If everything worked correctly, the registry home page will open (see figure).r h h"h(h)h*hsh,}r (h.]h/]h0]h1]h4]uh6Kh7hh8]r
hCXN If everything worked correctly, the registry home page will open (see figure).r r }r
(h j h j ubaubjQ
)r }r (h U h h"h(h)h*jT
h,}r (jV
X centerh1]r Uid2r ah0]h.]h/]h4]uh6Nh7hh8]r (jZ
)r }r (h X .. figure:: images/screenshots/image035.jpg
:align: center
An example of the Registry home page (with the default skin).
h,}r (UuriX images/screenshots/image035.jpgr h1]h0]h.]h/]j_
}r U*j sh4]uh j h8]h*ja
ubjb
)r }r (h X= An example of the Registry home page (with the default skin).r h j h(h)h*jf
h,}r (h.]h/]h0]h1]h4]uh6Kh8]r hCX= An example of the Registry home page (with the default skin).r r }r (h j h j ubaubeubeubh(h)h*Usystem_messager! h,}r" (h.]UlevelKh1]h0]Usourceh)h/]h4]UlineKUtypeUINFOr# uh6Kh7hh8]r$ hd)r% }r& (h U h,}r' (h.]h/]h0]h1]h4]uh h h8]r( hCX: Enumerated list start value not ordinal-1: "2" (ordinal 2)r) r* }r+ (h U h j% ubah*hsubaubh )r, }r- (h U h h"h(h)h*j! h,}r. (h.]UlevelKh1]h0]Usourceh)h/]h4]UlineKUtypej# uh6Kh7hh8]r/ hd)r0 }r1 (h U h,}r2 (h.]h/]h0]h1]h4]uh j, h8]r3 hCX: Enumerated list start value not ordinal-1: "4" (ordinal 4)r4 r5 }r6 (h U h j0 ubah*hsubaubh )r7 }r8 (h U h h"h(h)h*j! h,}r9 (h.]UlevelKh1]h0]Usourceh)h/]h4]UlineKUtypej# uh6Kh7hh8]r: hd)r; }r< (h U h,}r= (h.]h/]h0]h1]h4]uh j7 h8]r> hCX: Enumerated list start value not ordinal-1: "6" (ordinal 6)r? r@ }rA (h U h j; ubah*hsubaubh )rB }rC (h U h jX h(h)h*j! h,}rD (h.]UlevelKh1]h0]Usourceh)h/]h4]UlineKUtypej# uh6Kh7hh8]rE hd)rF }rG (h U h,}rH (h.]h/]h0]h1]h4]uh jB h8]rI hCX: Enumerated list start value not ordinal-1: "2" (ordinal 2)rJ rK }rL (h U h jF ubah*hsubaubh )rM }rN (h U h jX h(h)h*j! h,}rO (h.]UlevelKh1]h0]Usourceh)h/]h4]UlineKUtypej# uh6Kh7hh8]rP hd)rQ }rR (h U h,}rS (h.]h/]h0]h1]h4]uh jM h8]rT hCX: Enumerated list start value not ordinal-1: "3" (ordinal 3)rU rV }rW (h U h jQ ubah*hsubaubeUcurrent_sourcerX NU
decorationrY NUautofootnote_startrZ KUnameidsr[ }r\ (hhhj9 hj h j h
hh hh hh
jr hhhhhj hj& hh3hj hj hjL hj_ hhOuh8]r] h&ah U U transformerr^ NU
footnote_refsr_ }r` Urefnamesra }rb j ]rc j asUsymbol_footnotesrd ]re Uautofootnote_refsrf ]rg Usymbol_footnote_refsrh ]ri U citationsrj ]rk h7hU current_linerl NUtransform_messagesrm ]rn Ureporterro NUid_startrp KU
autofootnotesrq ]rr U
citation_refsrs }rt Uindirect_targetsru ]rv Usettingsrw (cdocutils.frontend
Values
rx ory }rz (Ufootnote_backlinksr{ KUrecord_dependenciesr| NU rfc_base_urlr} U https://tools.ietf.org/html/r~ U tracebackr Upep_referencesr NUstrip_commentsr NU
toc_backlinksr j U
language_coder Uenr U datestampr NU report_levelr KU _destinationr NU
halt_levelr KU
strip_classesr Nh>NU error_encoding_error_handlerr Ubackslashreplacer Udebugr NUembed_stylesheetr U output_encoding_error_handlerr Ustrictr U
sectnum_xformr KUdump_transformsr NU
docinfo_xformr KUwarning_streamr NUpep_file_url_templater Upep-%04dr Uexit_status_levelr KUconfigr NUstrict_visitorr NUcloak_email_addressesr U trim_footnote_reference_spacer Uenvr NUdump_pseudo_xmlr NUexpose_internalsr NUsectsubtitle_xformr U source_linkr NUrfc_referencesr NUoutput_encodingr Uutf-8r U
source_urlr NUinput_encodingr U utf-8-sigr U_disable_configr NU id_prefixr U U tab_widthr KUerror_encodingr UUTF-8r U_sourcer h)Ugettext_compactr U generatorr NUdump_internalsr NU smart_quotesr U pep_base_urlr U https://www.python.org/dev/peps/r Usyntax_highlightr Ulongr U input_encoding_error_handlerr j Uauto_id_prefixr Uidr Udoctitle_xformr Ustrip_elements_with_classesr NU
_config_filesr ]Ufile_insertion_enabledr U raw_enabledr KU
dump_settingsr NubUsymbol_footnote_startr K Uidsr }r (j j hj hh"hOhHj8 j4 hj j& jw
j:
j6
j j j j hjX jX
jR
j j j j jI jE j j hAhjj je hhhhj_ j hhhhhhj j hhj9 j j j*
jr j
j% j! j j j jv jq jm h3h&j j j j j j jK jG jL jp hj j^ jZ hh$hhuUsubstitution_namesr }r h*h7h,}r (h.]h1]h0]Usourceh)h/]h4]uU footnotesr ]r Urefidsr }r ub.