cdocutils.nodes document q)q}q(U nametypesq}q(X(harvester properties and their functionsqNX:configuring a harvest site (instructions for site contact)qNX%running harvester in a command windowqNX0compose a harvest list (the harvest list editor)q NXunregister with harvesterq NXreview harvester reportsq NXregister with harvesterq NXrunning harvesterq NXconfiguring harvesterqNXreviewing harvest reportsqNX!harvester and harvest list editorqNXrunning harvester as a servletqNX!prepare eml documents for harvestqNuUsubstitution_defsq}qUparse_messagesq]qcdocutils.nodes system_message q)q}q(U rawsourceqUUparentqcdocutils.nodes section q)q}q(hUhh)q}q (hUhh)q!}q"(hUhhUsourceq#Xc/var/lib/jenkins/jobs/Metacat_stable/workspace/METACAT_2_8_4/docs/user/metacat/source/harvester.rstq$Utagnameq%Usectionq&U attributesq'}q((Udupnamesq)]Uclassesq*]Ubackrefsq+]Uidsq,]q-U!harvester-and-harvest-list-editorq.aUnamesq/]q0hauUlineq1KUdocumentq2hUchildrenq3]q4(cdocutils.nodes title q5)q6}q7(hX!Harvester and Harvest List Editorq8hh!h#h$h%Utitleq9h'}q:(h)]h*]h+]h,]h/]uh1Kh2hh3]q;cdocutils.nodes Text q}q?(hh8hh6ubaubcdocutils.nodes paragraph q@)qA}qB(hXBMetacat's Harvester is an optional feature that can be used to automatically retrieve EML documents from one or more custom data management system (e.g., SRB or PostgreSQL) and to insert (or update) those documents to the home repository. The local sites control when they are harvested, and which documents are harvested.qChh!h#h$h%U paragraphqDh'}qE(h)]h*]h+]h,]h/]uh1Kh2hh3]qFh/WEB_INF/metacat.propertieshhZh#h$h%U literal_blockq{h'}q|(U xml:spaceq}Upreserveq~h,]h+]h)]h*]h/]uh1K!h2hh3]qh/WEB_INF/metacat.propertiesqq}q(hUhhyubaubh@)q}q(hXPThe Harvester properties are grouped together and begin after the comment line::qhhZh#h$h%hDh'}q(h)]h*]h+]h,]h/]uh1K#h2hh3]qh(h)r?}r@(hUh'}rA(h)]h*]h+]h,]h/]uhj;h3]rBh@)rC}rD(hXharvesterAdministratorrEhj?h#h$h%hDh'}rF(h)]h*]h+]h,]h/]uh1K>h3]rGhh3]rR(hr?}r@(hj;hj9ubaubh)rA}rB(hUhj*h#h$h%h&h'}rC(h)]h*]h+]h,]rDUrunning-harvester-as-a-servletrEah/]rFhauh1Mh2hh3]rG(h5)rH}rI(hXRunning Harvester as a ServletrJhjAh#h$h%h9h'}rK(h)]h*]h+]h,]h/]uh1Mh2hh3]rLh/WEB-INF). :: hjYh#h$h%U list_itemreh'}rf(h)]h*]h+]h,]h/]uh1Nh2hh3]rg(cdocutils.nodes definition_list rh)ri}rj(hUh'}rk(h)]h*]h+]h,]h/]uhjch3]rlcdocutils.nodes definition_list_item rm)rn}ro(hXRemove the comment symbols around the HarvesterServlet entry in the deployed Metacat web.xml ($TOMCAT_HOME/webapps//WEB-INF). hjih#h$h%Udefinition_list_itemrph'}rq(h)]h*]h+]h,]h/]uh1M h3]rr(cdocutils.nodes term rs)rt}ru(hXCRemove the comment symbols around the HarvesterServlet entry in thervhjnh#h$h%Utermrwh'}rx(h)]h*]h+]h,]h/]uh1M h3]ryh/WEB-INF).rhj~h#h$h%hDh'}r(h)]h*]h+]h,]h/]uh1M h3]rh/WEB-INF).rr}r(hjhjubaubah%U definitionrubeubah%Udefinition_listrubhx)r}r(hXhjch%h{h'}r(h}h~h,]h+]h)]h*]h/]uh1M h3]rh HarvesterServlet edu.ucsb.nceas.metacat.harvesterClient.HarvesterServlet debug 1 listings true 1 -->rr}r(hUhjubaubeubjb)r}r(hXSave the edited file.rhjYh#h$h%jeh'}r(h)]h*]h+]h,]h/]uh1Nh2hh3]rh@)r}r(hjhjh#h$h%hDh'}r(h)]h*]h+]h,]h/]uh1Mh3]rhh3]rh(hXRRun the appropriate Harvester shell script, as determined by the operating system:r?hj9h#h$h%hDh'}r@(h)]h*]h+]h,]h/]uh1MJh3]rAhh elements that specify the information that Harvester needs to retrieve a pair of EML documents and upload them to Metacat.rihj#h#h$h%hDh'}rj(h)]h*]h+]h,]h/]uh1Kh2hh3]rkh elements that specify the information that Harvester needs to retrieve a pair of EML documents and upload them to Metacat.rlrm}rn(hjihjgubaubhx)ro}rp(hX  demoDocument 1 5 eml://ecoinformatics.org/eml-2.0.0 http://www.lternet.edu/~dcosta/document1.xml demoDocument 2 1 eml://ecoinformatics.org/eml-2.0.0 http://www.lternet.edu/~dcosta/document2.xml hj#h#h$h%h{h'}rq(h}h~h,]h+]h)]h*]h/]uh1Kh2hh3]rrh demoDocument 1 5 eml://ecoinformatics.org/eml-2.0.0 http://www.lternet.edu/~dcosta/document1.xml demoDocument 2 1 eml://ecoinformatics.org/eml-2.0.0 http://www.lternet.edu/~dcosta/document2.xml rsrt}ru(hUhjoubaubh@)rv}rw(hXRather than formatting the list by hand, you may wish to use Metacat's Harvest List Editor to compose and edit it. The Harvest List Editor displays a Harvest List as a table of rows and fields. Each table row corresponds to a single element in the corresponding Harvest List file (i.e., one EML document). The row numbers are used only for visual reference and are not editable.rxhj#h#h$h%hDh'}ry(h)]h*]h+]h,]h/]uh1Kh2hh3]rzh element in the corresponding Harvest List file (i.e., one EML document). The row numbers are used only for visual reference and are not editable.r{r|}r}(hjxhjvubaubh@)r~}r(hXTo add a new document to the Harvest List, enter values for all five editable fields (all fields except the "Row #" field). Partially filled-in rows will cause errors that will result in an invalid Harvest List.rhj#h#h$h%hDh'}r(h)]h*]h+]h,]h/]uh1Kh2hh3]rh(h}h~h,]h+]h)]h*]h/]uh1M?h2hh3]r?h}r?(hUh'}r@(h)]h*]h+]h,]h/]uhj:h3]rAh@)rB}rC(hXdefaultDocumentTyperDhj>h#h$h%hDh'}rE(h)]h*]h+]h,]h/]uh1Mvh3]rFh This module defines the required information for the harvester to collect documents from the local site. The local system containing this document must give the Metacat Harvester read access to this document. This represents the local document information that is used to inform the Harvester of the docid, document type, and location of the document to be harvested. The complete document identifier to be used by metacat. The docid is a compound element that gives a scope for the identifier, an integer local identifer that is unique within that scope, and a revision. Each revision is assumed to specify a unique, non-changing document, so once a particular revision is harvested, there is no need for it to be harvested again. To trigger a harvest of a document that has been updated, increment the revision number for that identifier. The system prefix of a metacat docid that defines the scope within which the identifier is unique. The local (site specific) portion of the identifier (docid) that is unique within the context of the scope. The revision identifier for this document, indicating a unique document version. The type of document to be harvested, indicated by a namespace string, formal public identifier, mime type, or other type indicator. The documentURL field contains the URL of the document to be harvested. The Metacat Harvester must be given read access to the contents at this URL. hj#h#h$h%h{h'}r(h}h~h,]h+]h)]h*]h/]uh1Mh2hh3]rh This module defines the required information for the harvester to collect documents from the local site. The local system containing this document must give the Metacat Harvester read access to this document. This represents the local document information that is used to inform the Harvester of the docid, document type, and location of the document to be harvested. The complete document identifier to be used by metacat. The docid is a compound element that gives a scope for the identifier, an integer local identifer that is unique within that scope, and a revision. Each revision is assumed to specify a unique, non-changing document, so once a particular revision is harvested, there is no need for it to be harvested again. To trigger a harvest of a document that has been updated, increment the revision number for that identifier. The system prefix of a metacat docid that defines the scope within which the identifier is unique. The local (site specific) portion of the identifier (docid) that is unique within the context of the scope. The revision identifier for this document, indicating a unique document version. The type of document to be harvested, indicated by a namespace string, formal public identifier, mime type, or other type indicator. The documentURL field contains the URL of the document to be harvested. The Metacat Harvester must be given read access to the contents at this URL. rr}r(hUhjubaubeubh)r}r(hUhhh#h$h%h&h'}r(h)]h*]h+]h,]rU!prepare-eml-documents-for-harvestrah/]rhauh1Mh2hh3]r(h5)r}r(hX!Prepare EML Documents for Harvestrhjh#h$h%h9h'}r(h)]h*]h+]h,]h/]uh1Mh2hh3]rh`` element in the site's Harvest Listrhjh#h$h%jeh'}r(h)]h*]h+]h,]h/]uh1Nh2hh3]rh@)r}r(hjhjh#h$h%hDh'}r(h)]h*]h+]h,]h/]uh1Mh3]r(h``h'}r(h)]h*]h+]h,]h/]uhjh3]rhrr}r(hUhjubah%jubh(h)]h*]h+]h,]h/]uh1Mh3]r?h}r?(hXmyname@institution.eduh'}r@(UrefuriXmailto:myname@institution.eduh,]h+]h)]h*]h/]uhj"h3]rAhubah%j^ubh