docutils.nodesdocument)}( rawsourcechildren]hsection)}(hhh](htitle)}(h$OAI Protocol for Metadata Harvestingh]hText$OAI Protocol for Metadata Harvesting}(hhparenthhhsourceNlineNuba attributes}(ids]classes]names]dupnames]backrefs]utagnamehhh hhhX/var/lib/jenkins/jobs/metacat_beta/workspace/metacat/docs/user/metacat/source/oaipmh.rsthKubh paragraph)}(hX-The Open Archives Initiative Protocol for Metadata Harvesting (`OAI-PMH`_) was first developed in the late 1990's as a standard for harvesting metadata from distributed metadata/data repositories. The current version of the OAI-PMH standard is 2.0 as of June 2002, with minor updates in December 2008.h](h?The Open Archives Initiative Protocol for Metadata Harvesting (}(h?The Open Archives Initiative Protocol for Metadata Harvesting (hh-hhhNhNubh reference)}(h `OAI-PMH`_h]hOAI-PMH}(hhhh8ubah}(h]h!]h#]h%]h']nameOAI-PMHrefuri http://www.openarchives.org/pmh/uh)h6hh-resolvedKubh) was first developed in the late 1990’s as a standard for harvesting metadata from distributed metadata/data repositories. The current version of the OAI-PMH standard is 2.0 as of June 2002, with minor updates in December 2008.}(h) was first developed in the late 1990's as a standard for harvesting metadata from distributed metadata/data repositories. The current version of the OAI-PMH standard is 2.0 as of June 2002, with minor updates in December 2008.hh-hhhNhNubeh}(h]h!]h#]h%]h']uh)h+hh*hKhh hhubhtarget)}(h-.. _OAI-PMH: http://www.openarchives.org/pmh/h]h}(h]oai-pmhah!]h#]oai-pmhah%]h']hHhIuh)hVhK hh hhhh* referencedKubh,)}(hThe OAI-PMH standard uses the Hypertext Transport Protocol (HTTP) as a transport layer and specifies six query methods (called verbs) that must be supported by an OAI-PMH compliant data provider (also referred to as a repository). These methods are:h]hThe OAI-PMH standard uses the Hypertext Transport Protocol (HTTP) as a transport layer and specifies six query methods (called verbs) that must be supported by an OAI-PMH compliant data provider (also referred to as a repository). These methods are:}(hhghhehhhNhNubah}(h]h!]h#]h%]h']uh)h+hh*hK hh hhubhenumerated_list)}(hhh](h list_item)}(hQ``GetRecord`` - retrieves zero or one complete metadata record from a repository;h]h,)}(hh|h](hliteral)}(h ``GetRecord``h]h GetRecord}(hhhhubah}(h]h!]h#]h%]h']uh)hhh~ubhD - retrieves zero or one complete metadata record from a repository;}(hD - retrieves zero or one complete metadata record from a repository;hh~ubeh}(h]h!]h#]h%]h']uh)h+hh*hKhhzubah}(h]h!]h#]h%]h']uh)hxhhuhhhh*hNubhy)}(h8``Identify`` - retrieves information about a repository;h]h,)}(hhh](h)}(h ``Identify``h]hIdentify}(hhhhubah}(h]h!]h#]h%]h']uh)hhhubh, - retrieves information about a repository;}(h, - retrieves information about a repository;hhubeh}(h]h!]h#]h%]h']uh)h+hh*hKhhubah}(h]h!]h#]h%]h']uh)hxhhuhhhh*hNubhy)}(h|``ListIdentifiers`` - retrieves zero or more metadata record "headers" (not the complete metadata record) from a repository;h]h,)}(hhh](h)}(h``ListIdentifiers``h]hListIdentifiers}(hhhhubah}(h]h!]h#]h%]h']uh)hhhubhm - retrieves zero or more metadata record “headers” (not the complete metadata record) from a repository;}(hi - retrieves zero or more metadata record "headers" (not the complete metadata record) from a repository;hhubeh}(h]h!]h#]h%]h']uh)h+hh*hKhhubah}(h]h!]h#]h%]h']uh)hxhhuhhhh*hNubhy)}(hj``ListMetadataFormats`` - retrieves a list of available metadata record formats supported by a repository;h]h,)}(hhh](h)}(h``ListMetadataFormats``h]hListMetadataFormats}(hhhhubah}(h]h!]h#]h%]h']uh)hhhubhS - retrieves a list of available metadata record formats supported by a repository;}(hS - retrieves a list of available metadata record formats supported by a repository;hhubeh}(h]h!]h#]h%]h']uh)h+hh*hKhhubah}(h]h!]h#]h%]h']uh)hxhhuhhhh*hNubhy)}(hY``ListRecords`` - retrieves zero or more complete metadata records from a repository; andh]h,)}(hjh](h)}(h``ListRecords``h]h ListRecords}(hhhjubah}(h]h!]h#]h%]h']uh)hhjubhJ - retrieves zero or more complete metadata records from a repository; and}(hJ - retrieves zero or more complete metadata records from a repository; andhjubeh}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)hxhhuhhhh*hNubhy)}(h>``ListSets`` - retrieves the set structure from a repository. h]h,)}(h=``ListSets`` - retrieves the set structure from a repository.h](h)}(h ``ListSets``h]hListSets}(hhhjBubah}(h]h!]h#]h%]h']uh)hhj>ubh1 - retrieves the set structure from a repository.}(h1 - retrieves the set structure from a repository.hj>ubeh}(h]h!]h#]h%]h']uh)h+hh*hKhj:ubah}(h]h!]h#]h%]h']uh)hxhhuhhhh*hNubeh}(h]h!]h#]h%]h']enumtypearabicprefixhsuffix.uh)hshh hhhh*hKubh,)}(hXThe OAI-PMH compliant data provider must accept requests from both HTTP GET and HTTP POST request methods. Responses from the data provider must be returned as an XML-encoded (version 1.0) stream. Error handling must be supported by the data provider and return the correct error response code back to the harvester. Detailed specifications and examples of all six verbs may be viewed in Section 4 of the `OAI-PMH standards document`_.h](hXThe OAI-PMH compliant data provider must accept requests from both HTTP GET and HTTP POST request methods. Responses from the data provider must be returned as an XML-encoded (version 1.0) stream. Error handling must be supported by the data provider and return the correct error response code back to the harvester. Detailed specifications and examples of all six verbs may be viewed in Section 4 of the }(hXThe OAI-PMH compliant data provider must accept requests from both HTTP GET and HTTP POST request methods. Responses from the data provider must be returned as an XML-encoded (version 1.0) stream. Error handling must be supported by the data provider and return the correct error response code back to the harvester. Detailed specifications and examples of all six verbs may be viewed in Section 4 of the hjlhhhNhNubh7)}(h`OAI-PMH standards document`_h]hOAI-PMH standards document}(hhhjuubah}(h]h!]h#]h%]h']nameOAI-PMH standards documenthH9http://www.openarchives.org/OAI/openarchivesprotocol.htmluh)h6hjlhJKubh.}(hjkhjlhhhNhNubeh}(h]h!]h#]h%]h']uh)h+hh*hKhh hhubhW)}(hY.. _OAI-PMH standards document: http://www.openarchives.org/OAI/openarchivesprotocol.htmlh]h}(h]oai-pmh-standards-documentah!]h#]oai-pmh standards documentah%]h']hHjuh)hVhKhh hhhh*hdKubh )}(hhh](h)}(hEML and Dublin Coreh]hEML and Dublin Core}(hjhjhhhNhNubah}(h]h!]h#]h%]h']uh)hhjhhhh*hK!ubh,)}(hXThe OAI-PMH requires that unqualified Dublin Core metadata be supported as a minimum. Although EML generally provides more fine-grained metadata than Dublin Core, the two metadata standards do share many of the same (or similar) content elements. Transformations from EML to Dublin Core performed by Metacat OAI-PMH produce *simple* or *unqualified* Dublin Core, which is associated with the reserved metadataPrefix symbol ``oai_dc`` in the OAI-PMH.h](hXDThe OAI-PMH requires that unqualified Dublin Core metadata be supported as a minimum. Although EML generally provides more fine-grained metadata than Dublin Core, the two metadata standards do share many of the same (or similar) content elements. Transformations from EML to Dublin Core performed by Metacat OAI-PMH produce }(hXDThe OAI-PMH requires that unqualified Dublin Core metadata be supported as a minimum. Although EML generally provides more fine-grained metadata than Dublin Core, the two metadata standards do share many of the same (or similar) content elements. Transformations from EML to Dublin Core performed by Metacat OAI-PMH produce hjhhhNhNubhemphasis)}(h*simple*h]hsimple}(hhhjubah}(h]h!]h#]h%]h']uh)jhjubh or }(h or hjhhhNhNubj)}(h *unqualified*h]h unqualified}(hhhjubah}(h]h!]h#]h%]h']uh)jhjubhJ Dublin Core, which is associated with the reserved metadataPrefix symbol }(hJ Dublin Core, which is associated with the reserved metadataPrefix symbol hjhhhNhNubh)}(h ``oai_dc``h]hoai_dc}(hhhjubah}(h]h!]h#]h%]h']uh)hhjubh in the OAI-PMH.}(h in the OAI-PMH.hjhhhNhNubeh}(h]h!]h#]h%]h']uh)h+hh*hK"hjhhubh,)}(hThe following table summarizes the element mappings of the EML to Dublin Core crosswalk performed by Metacat OAI-PMH, including notes specific to each element mapping.h]hThe following table summarizes the element mappings of the EML to Dublin Core crosswalk performed by Metacat OAI-PMH, including notes specific to each element mapping.}(hjhjhhhNhNubah}(h]h!]h#]h%]h']uh)h+hh*hK)hjhhubhtable)}(hhh]htgroup)}(hhh](hcolspec)}(hhh]h}(h]h!]h#]h%]h']colwidthK'uh)jhj ubj)}(hhh]h}(h]h!]h#]h%]h']colwidthK uh)jhj ubj)}(hhh]h}(h]h!]h#]h%]h']colwidthKuh)jhj ubhthead)}(hhh]hrow)}(hhh](hentry)}(hhh]h,)}(h EML Elementh]h EML Element}(hj@hj>ubah}(h]h!]h#]h%]h']uh)h+hh*hK.hj;ubah}(h]h!]h#]h%]h']uh)j9hj6ubj:)}(hhh]h,)}(h DC Elementh]h DC Element}(hjWhjUubah}(h]h!]h#]h%]h']uh)h+hh*hK.hjRubah}(h]h!]h#]h%]h']uh)j9hj6ubj:)}(hhh]h,)}(hNotesh]hNotes}(hjnhjlubah}(h]h!]h#]h%]h']uh)h+hh*hK.hjiubah}(h]h!]h#]h%]h']uh)j9hj6ubeh}(h]h!]h#]h%]h']uh)j4hj1ubah}(h]h!]h#]h%]h']uh)j/hj ubhtbody)}(hhh](j5)}(hhh](j:)}(hhh]h,)}(hTitleh]hTitle}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hK0hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(htitleh]htitle}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hK0hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(hCreatorh]hCreator}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hK2hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hcreatorh]hcreator}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hK2hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h[Use only the creator's name (givenName and surName elements); could be an organization nameh]h]Use only the creator’s name (givenName and surName elements); could be an organization name}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hK2hjubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(hkeywordh]hkeyword}(hj'hj%ubah}(h]h!]h#]h%]h']uh)h+hh*hK4hj"ubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hsubjecth]hsubject}(hj>hj<ubah}(h]h!]h#]h%]h']uh)h+hh*hK4hj9ubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h'One subject element per keyword elementh]h'One subject element per keyword element}(hjUhjSubah}(h]h!]h#]h%]h']uh)h+hh*hK4hjPubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(habstracth]habstract}(hjuhjsubah}(h]h!]h#]h%]h']uh)h+hh*hK6hjpubah}(h]h!]h#]h%]h']uh)j9hjmubj:)}(hhh]h,)}(h descriptionh]h description}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hK6hjubah}(h]h!]h#]h%]h']uh)j9hjmubj:)}(hhh]h,)}(h!Must extract text formatting tagsh]h!Must extract text formatting tags}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hK6hjubah}(h]h!]h#]h%]h']uh)j9hjmubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(h publisherh]h publisher}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hK8hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h publisherh]h publisher}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hK8hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h]Use only the publisher's name (givenName and surName elements); could be an organization nameh]h_Use only the publisher’s name (givenName and surName elements); could be an organization name}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hK8hjubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(hassociatedPartyh]hassociatedParty}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hK:hj ubah}(h]h!]h#]h%]h']uh)j9hj ubj:)}(hhh]h,)}(h contributorh]h contributor}(hj(hj&ubah}(h]h!]h#]h%]h']uh)h+hh*hK:hj#ubah}(h]h!]h#]h%]h']uh)j9hj ubj:)}(hhh]h,)}(hPUse only the party's name (givenName and surName); could be an organization nameh]hRUse only the party’s name (givenName and surName); could be an organization name}(hj?hj=ubah}(h]h!]h#]h%]h']uh)h+hh*hK:hj:ubah}(h]h!]h#]h%]h']uh)j9hj ubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(hpubDateh]hpubDate}(hj_hj]ubah}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(htypeh]htype}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hK>hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hZType value is determined by the type of EML document rather than by a specific field valueh]hZType value is determined by the type of EML document rather than by a specific field value}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hK>hjubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(hphysicalh]hphysical}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hK@hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hformath]hformat}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hK@hj ubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hUse a mime type as the Format value? For example, if EML has element within , then use 'text/plain' as the Format value?h]hUse a mime type as the Format value? For example, if EML has element within , then use ‘text/plain’ as the Format value?}(hj)hj'ubah}(h]h!]h#]h%]h']uh)h+hh*hK@hj$ubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]ht)}(hhh](hy)}(h packageId;h]h,)}(hjLh]h packageId;}(hjLhjNubah}(h]h!]h#]h%]h']uh)h+hh*hKBhjJubah}(h]h!]h#]h%]h']uh)hxhjGubhy)}(hURL to the EML documenth]h,)}(hjch]hURL to the EML document}(hjchjeubah}(h]h!]h#]h%]h']uh)h+hh*hKChjaubah}(h]h!]h#]h%]h']uh)hxhjGubeh}(h]h!]h#]h%]h']jgjhji(jj)uh)hshjDubah}(h]h!]h#]h%]h']uh)j9hjAubj:)}(hhh]h,)}(h identifierh]h identifier}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKBhjubah}(h]h!]h#]h%]h']uh)j9hjAubj:)}(hhh]h,)}(h|packageId can be used as the value of one identifier element; a second identifier element can hold a URL to the EML documenth]h|packageId can be used as the value of one identifier element; a second identifier element can hold a URL to the EML document}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKBhjubah}(h]h!]h#]h%]h']uh)j9hjAubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(h dataSourceh]h dataSource}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKEhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hsourceh]hsource}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKEhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h3Use the document URL of the referenced data source?h]h3Use the document URL of the referenced data source?}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKEhjubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(hCitationh]hCitation}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKGhj ubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hrelationh]hrelation}(hj'hj%ubah}(h]h!]h#]h%]h']uh)h+hh*hKGhj"ubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h0Use the document URL of the referenced citation?h]h0Use the document URL of the referenced citation?}(hj>hj<ubah}(h]h!]h#]h%]h']uh)h+hh*hKGhj9ubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(hgeographicCoverageh]hgeographicCoverage}(hj^hj\ubah}(h]h!]h#]h%]h']uh)h+hh*hKIhjYubah}(h]h!]h#]h%]h']uh)j9hjVubj:)}(hhh]h,)}(hcoverageh]hcoverage}(hjuhjsubah}(h]h!]h#]h%]h']uh)h+hh*hKIhjpubah}(h]h!]h#]h%]h']uh)j9hjVubj:)}(hhh]h,)}(hAdd separate coverage elements for geographic description and geographic bounding coordinates. For bounding coordinates, use minimal labeling, for example: 81.505000 W, 81.495000 W, 31.170000 N, 31.163000 Nh]hAdd separate coverage elements for geographic description and geographic bounding coordinates. For bounding coordinates, use minimal labeling, for example: 81.505000 W, 81.495000 W, 31.170000 N, 31.163000 N}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKIhjubah}(h]h!]h#]h%]h']uh)j9hjVubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(htaxonomicCoverageh]htaxonomicCoverage}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKNhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hcoverageh]hcoverage}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKNhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hTUse only genus/species binomials; place each binomial in a separate coverage elementh]hTUse only genus/species binomials; place each binomial in a separate coverage element}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKNhjubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(htemporalCoverageh]htemporalCoverage}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKPhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hcoverageh]hcoverage}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKPhj ubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hUInclude begin date and end date when available. For example: 1915-01-01 to 2004-12-31h]hUInclude begin date and end date when available. For example: 1915-01-01 to 2004-12-31}(hj(hj&ubah}(h]h!]h#]h%]h']uh)h+hh*hKPhj#ubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(hintellectualRightsh]hintellectualRights}(hjHhjFubah}(h]h!]h#]h%]h']uh)h+hh*hKShjCubah}(h]h!]h#]h%]h']uh)j9hj@ubj:)}(hhh]h,)}(hrightsh]hrights}(hj_hj]ubah}(h]h!]h#]h%]h']uh)h+hh*hKShjZubah}(h]h!]h#]h%]h']uh)j9hj@ubj:)}(hhh]h,)}(h!Must extract text formatting tagsh]h!Must extract text formatting tags}(hjvhjtubah}(h]h!]h#]h%]h']uh)h+hh*hKShjqubah}(h]h!]h#]h%]h']uh)j9hj@ubeh}(h]h!]h#]h%]h']uh)j4hjubeh}(h]h!]h#]h%]h']uh)jhj ubeh}(h]h!]h#]h%]h']colsKuh)j hjubah}(h]h!]h#]h%]h']uh)jhjhhhh*hNubh,)}(hMetacat OAI-PMH includes a set of XSLT stylesheets used for converting specific versions of EML to their Dublin Core equivalents.h]hMetacat OAI-PMH includes a set of XSLT stylesheets used for converting specific versions of EML to their Dublin Core equivalents.}(hjhjhhhNhNubah}(h]h!]h#]h%]h']uh)h+hh*hKVhjhhubeh}(h]eml-and-dublin-coreah!]h#]eml and dublin coreah%]h']uh)h hh hhhh*hK!ubh )}(hhh](h)}(h"Metacat OAI-PMH Service Interfacesh]h"Metacat OAI-PMH Service Interfaces}(hjhjhhhNhNubah}(h]h!]h#]h%]h']uh)hhjhhhh*hKZubh,)}(hMetacat includes support for two OAI-PMH service interfaces: a data provider (or repository) service interface and a harvester service interface.h]hMetacat includes support for two OAI-PMH service interfaces: a data provider (or repository) service interface and a harvester service interface.}(hjhjhhhNhNubah}(h]h!]h#]h%]h']uh)h+hh*hK[hjhhubh )}(hhh](h)}(h Data Providerh]h Data Provider}(hjhjhhhNhNubah}(h]h!]h#]h%]h']uh)hhjhhhh*hK_ubh,)}(hX,The Metacat OAI-PMH Data Provider service interface supports all six OAI-PMH methods (GetRecord, Identify, ListIdentifiers, ListMetadataFormats, ListRecords, and ListSets) as defined in the OAI-PMH Version 2 Specification through a standard HTTP URL that accepts both HTTP GET and HTTP POST requests.h]hX,The Metacat OAI-PMH Data Provider service interface supports all six OAI-PMH methods (GetRecord, Identify, ListIdentifiers, ListMetadataFormats, ListRecords, and ListSets) as defined in the OAI-PMH Version 2 Specification through a standard HTTP URL that accepts both HTTP GET and HTTP POST requests.}(hjhjhhhNhNubah}(h]h!]h#]h%]h']uh)h+hh*hK`hjhhubh,)}(hThe Metacat OAI-PMH Data Provider service was implemented using the Online Computer Library Center (OCLC) OAICat Open Source Software as the basis for its implementation, with customizations added to facilitate integration with Metacat.h]hThe Metacat OAI-PMH Data Provider service was implemented using the Online Computer Library Center (OCLC) OAICat Open Source Software as the basis for its implementation, with customizations added to facilitate integration with Metacat.}(hjhjhhhNhNubah}(h]h!]h#]h%]h']uh)h+hh*hKehjhhubh,)}(hSUsers of the Metacat OAI-PMH Data Provider should be aware of the following issues:h]hSUsers of the Metacat OAI-PMH Data Provider should be aware of the following issues:}(hjhjhhhNhNubah}(h]h!]h#]h%]h']uh)h+hh*hKjhjhhubh bullet_list)}(hhh](hy)}(hX'Deleted' Status - OAI-PMH repositories can optionally flag records with a 'deleted' status, indicating that a record in the metadata format specified by the metadataPrefix is no longer available. Since Metacat does not provide a mechanism for retrieving a list of deleted documents, the use of the 'deleted' status is not supported in this implementation of the OAI-PMH Data Provider. This represents a possible future enhancement.h]h,)}(hX'Deleted' Status - OAI-PMH repositories can optionally flag records with a 'deleted' status, indicating that a record in the metadata format specified by the metadataPrefix is no longer available. Since Metacat does not provide a mechanism for retrieving a list of deleted documents, the use of the 'deleted' status is not supported in this implementation of the OAI-PMH Data Provider. This represents a possible future enhancement.h]hX‘Deleted’ Status - OAI-PMH repositories can optionally flag records with a ‘deleted’ status, indicating that a record in the metadata format specified by the metadataPrefix is no longer available. Since Metacat does not provide a mechanism for retrieving a list of deleted documents, the use of the ‘deleted’ status is not supported in this implementation of the OAI-PMH Data Provider. This represents a possible future enhancement.}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKlhjubah}(h]h!]h#]h%]h']uh)hxhjhhhh*hNubhy)}(hXSets - OAI-PMH repositories can optionally support set hierarchies. Since it has not been determined how set hierarchies should be structured in Metacat, this implementation of the OAI-PMH repository does not support set hierarchies. This represents a possible future enhancement.h]h,)}(hXSets - OAI-PMH repositories can optionally support set hierarchies. Since it has not been determined how set hierarchies should be structured in Metacat, this implementation of the OAI-PMH repository does not support set hierarchies. This represents a possible future enhancement.h]hXSets - OAI-PMH repositories can optionally support set hierarchies. Since it has not been determined how set hierarchies should be structured in Metacat, this implementation of the OAI-PMH repository does not support set hierarchies. This represents a possible future enhancement.}(hj4hj2ubah}(h]h!]h#]h%]h']uh)h+hh*hKrhj.ubah}(h]h!]h#]h%]h']uh)hxhjhhhh*hNubhy)}(hXTDatestamp Granularity - When expressing datestamps for repository documents, OAI-PMH allows two levels of granularity: day granularity and seconds granularity. Since the Metacat database stores the value of its ``xml_documents.date_updated`` field in day granularity, it is the level that is supported by the Metacat OAI-PMH Data Provider. h]h,)}(hXSDatestamp Granularity - When expressing datestamps for repository documents, OAI-PMH allows two levels of granularity: day granularity and seconds granularity. Since the Metacat database stores the value of its ``xml_documents.date_updated`` field in day granularity, it is the level that is supported by the Metacat OAI-PMH Data Provider.h](hDatestamp Granularity - When expressing datestamps for repository documents, OAI-PMH allows two levels of granularity: day granularity and seconds granularity. Since the Metacat database stores the value of its }(hDatestamp Granularity - When expressing datestamps for repository documents, OAI-PMH allows two levels of granularity: day granularity and seconds granularity. Since the Metacat database stores the value of its hjJubh)}(h``xml_documents.date_updated``h]hxml_documents.date_updated}(hhhjSubah}(h]h!]h#]h%]h']uh)hhjJubhb field in day granularity, it is the level that is supported by the Metacat OAI-PMH Data Provider.}(hb field in day granularity, it is the level that is supported by the Metacat OAI-PMH Data Provider.hjJubeh}(h]h!]h#]h%]h']uh)h+hh*hKvhjFubah}(h]h!]h#]h%]h']uh)hxhjhhhh*hNubeh}(h]h!]h#]h%]h']bullet*uh)jhh*hKlhjhhubeh}(h] data-providerah!]h#] data providerah%]h']uh)h hjhhhh*hK_ubh )}(hhh](h)}(hMetacat OAI-PMH Harvesterh]hMetacat OAI-PMH Harvester}(hjhjhhhNhNubah}(h]h!]h#]h%]h']uh)hhjhhhh*hK}ubh,)}(hThe Metacat OAI-PMH Harvester service interface utilizes OAI-PMH methods to request metadata or related information from an OAI-PMH-compliant data provider using a standard HTTP URL in either an HTTP-GET or HTTP-POST request.h]hThe Metacat OAI-PMH Harvester service interface utilizes OAI-PMH methods to request metadata or related information from an OAI-PMH-compliant data provider using a standard HTTP URL in either an HTTP-GET or HTTP-POST request.}(hjhjhhhNhNubah}(h]h!]h#]h%]h']uh)h+hh*hK~hjhhubh,)}(hThe Metacat OAI-PMH Harvester client was implemented using OCLC's OAIHarvester2 open source code as its base implementation, with customizations as needed to support integration with Metacat.h]hThe Metacat OAI-PMH Harvester client was implemented using OCLC’s OAIHarvester2 open source code as its base implementation, with customizations as needed to support integration with Metacat.}(hjhjhhhNhNubah}(h]h!]h#]h%]h']uh)h+hh*hKhjhhubh,)}(hOUsers of the Metacat OAI-PMH Harvester should be aware of the following issues:h]hOUsers of the Metacat OAI-PMH Harvester should be aware of the following issues:}(hjhjhhhNhNubah}(h]h!]h#]h%]h']uh)h+hh*hKhjhhubj)}(hhh](hy)}(hHandling of 'Deleted' status - The Metacat OAI-PMH Harvester program does check to see whether a 'deleted' status is flagged for a harvested document, and if it is, the document is correspondingly deleted from the Metacat repository.h]h,)}(hHandling of 'Deleted' status - The Metacat OAI-PMH Harvester program does check to see whether a 'deleted' status is flagged for a harvested document, and if it is, the document is correspondingly deleted from the Metacat repository.h]hHandling of ‘Deleted’ status - The Metacat OAI-PMH Harvester program does check to see whether a ‘deleted’ status is flagged for a harvested document, and if it is, the document is correspondingly deleted from the Metacat repository.}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)hxhjhhhh*hNubhy)}(hXDatestamp Granularity - When expressing datestamps for repository documents, OAI-PMH allows two levels of granularity - day granularity and seconds granularity. Since the Metacat database stores the value of its ``xml_documents.last_updated`` field in day granularity, it is also the level that is supported by both the Metacat OAI-PMH Data Provider and the Metacat OAI-PMH Harvester. This has implications when Metacat OAI-PMH Harvester (MOH) interacts with data providers such as the Dryad repository, which stores its documents with seconds granularity. For example, consider the following sequence of events: 1. On January 1, 2010, MOH harvests a document from the Dryad repository with datestamp '2010-01-01T10:00:00Z', and stores its local copy with datestamp '2010-01-01'. 2. Later that same day, the Dryad repository updates the document to a newer revision, with a new datestamp such as '2010-01-01T20:00:0Z'. 3. On the following day, MOH runs another harvest. It determines that it has a local copy of the document with datestamp '2010-01-01' and does not re-harvest the document, despite the fact that its local copy is not the latest revision. h](h,)}(hXdDatestamp Granularity - When expressing datestamps for repository documents, OAI-PMH allows two levels of granularity - day granularity and seconds granularity. Since the Metacat database stores the value of its ``xml_documents.last_updated`` field in day granularity, it is also the level that is supported by both the Metacat OAI-PMH Data Provider and the Metacat OAI-PMH Harvester. This has implications when Metacat OAI-PMH Harvester (MOH) interacts with data providers such as the Dryad repository, which stores its documents with seconds granularity. For example, consider the following sequence of events:h](hDatestamp Granularity - When expressing datestamps for repository documents, OAI-PMH allows two levels of granularity - day granularity and seconds granularity. Since the Metacat database stores the value of its }(hDatestamp Granularity - When expressing datestamps for repository documents, OAI-PMH allows two levels of granularity - day granularity and seconds granularity. Since the Metacat database stores the value of its hjubh)}(h``xml_documents.last_updated``h]hxml_documents.last_updated}(hhhjubah}(h]h!]h#]h%]h']uh)hhjubhXr field in day granularity, it is also the level that is supported by both the Metacat OAI-PMH Data Provider and the Metacat OAI-PMH Harvester. This has implications when Metacat OAI-PMH Harvester (MOH) interacts with data providers such as the Dryad repository, which stores its documents with seconds granularity. For example, consider the following sequence of events:}(hXr field in day granularity, it is also the level that is supported by both the Metacat OAI-PMH Data Provider and the Metacat OAI-PMH Harvester. This has implications when Metacat OAI-PMH Harvester (MOH) interacts with data providers such as the Dryad repository, which stores its documents with seconds granularity. For example, consider the following sequence of events:hjubeh}(h]h!]h#]h%]h']uh)h+hh*hKhjubht)}(hhh](hy)}(hOn January 1, 2010, MOH harvests a document from the Dryad repository with datestamp '2010-01-01T10:00:00Z', and stores its local copy with datestamp '2010-01-01'.h]h,)}(hOn January 1, 2010, MOH harvests a document from the Dryad repository with datestamp '2010-01-01T10:00:00Z', and stores its local copy with datestamp '2010-01-01'.h]hOn January 1, 2010, MOH harvests a document from the Dryad repository with datestamp ‘2010-01-01T10:00:00Z’, and stores its local copy with datestamp ‘2010-01-01’.}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)hxhjubhy)}(hLater that same day, the Dryad repository updates the document to a newer revision, with a new datestamp such as '2010-01-01T20:00:0Z'.h]h,)}(hLater that same day, the Dryad repository updates the document to a newer revision, with a new datestamp such as '2010-01-01T20:00:0Z'.h]hLater that same day, the Dryad repository updates the document to a newer revision, with a new datestamp such as ‘2010-01-01T20:00:0Z’.}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)hxhjubhy)}(hOn the following day, MOH runs another harvest. It determines that it has a local copy of the document with datestamp '2010-01-01' and does not re-harvest the document, despite the fact that its local copy is not the latest revision. h]h,)}(hOn the following day, MOH runs another harvest. It determines that it has a local copy of the document with datestamp '2010-01-01' and does not re-harvest the document, despite the fact that its local copy is not the latest revision.h]hOn the following day, MOH runs another harvest. It determines that it has a local copy of the document with datestamp ‘2010-01-01’ and does not re-harvest the document, despite the fact that its local copy is not the latest revision.}(hj7 hj5 ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj1 ubah}(h]h!]h#]h%]h']uh)hxhjubeh}(h]h!]h#]h%]h']jgjhjihjjjkuh)hshjubeh}(h]h!]h#]h%]h']uh)hxhjhhhNhNubeh}(h]h!]h#]h%]h']jxjyuh)jhh*hKhjhhubeh}(h]metacat-oai-pmh-harvesterah!]h#]h%]metacat oai-pmh harvesterah']uh)h hjhhhh*hK}hdKubeh}(h]"metacat-oai-pmh-service-interfacesah!]h#]"metacat oai-pmh service interfacesah%]h']uh)h hh hhhh*hKZubh )}(hhh](h)}(h'Configuring and Running Metacat OAI-PMHh]h'Configuring and Running Metacat OAI-PMH}(hjp hjn hhhNhNubah}(h]h!]h#]h%]h']uh)hhjk hhhh*hKubh )}(hhh](h)}(h%Metacat OAI-PMH Data Provider Servleth]h%Metacat OAI-PMH Data Provider Servlet}(hj hj hhhNhNubah}(h]h!]h#]h%]h']uh)hhj| hhhh*hKubh,)}(h2To configure and enable the Data Provider servlet:h]h2To configure and enable the Data Provider servlet:}(hj hj hhhNhNubah}(h]h!]h#]h%]h']uh)h+hh*hKhj| hhubht)}(hhh](hy)}(hX%Stop Tomcat and edit the Metacat properties (``metacat.properties``) file in the Metacat context directory inside the Tomcat application directory. The Metacat context directory is the name of the application (usually ``knb``): :: //WEB-INF/metacat.properties h](h,)}(hStop Tomcat and edit the Metacat properties (``metacat.properties``) file in the Metacat context directory inside the Tomcat application directory. The Metacat context directory is the name of the application (usually ``knb``):h](h-Stop Tomcat and edit the Metacat properties (}(h-Stop Tomcat and edit the Metacat properties (hj ubh)}(h``metacat.properties``h]hmetacat.properties}(hhhj ubah}(h]h!]h#]h%]h']uh)hhj ubh) file in the Metacat context directory inside the Tomcat application directory. The Metacat context directory is the name of the application (usually }(h) file in the Metacat context directory inside the Tomcat application directory. The Metacat context directory is the name of the application (usually hj ubh)}(h``knb``h]hknb}(hhhj ubah}(h]h!]h#]h%]h']uh)hhj ubh):}(h):hj ubeh}(h]h!]h#]h%]h']uh)h+hh*hKhj ubh literal_block)}(h9//WEB-INF/metacat.propertiesh]h9//WEB-INF/metacat.properties}(hhhj ubah}(h]h!]h#]h%]h'] xml:spacepreserveuh)j hKhj ubeh}(h]h!]h#]h%]h']uh)hxhj hhhh*hNubhy)}(hChange the following properties appropriately: :: ``oaipmh.repositoryIdentifier`` - A string that identifies this repository ``Identify.adminEmail`` - The email address of the repository administrator h](h,)}(h.Change the following properties appropriately:h]h.Change the following properties appropriately:}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubj )}(h``oaipmh.repositoryIdentifier`` - A string that identifies this repository ``Identify.adminEmail`` - The email address of the repository administratorh]h``oaipmh.repositoryIdentifier`` - A string that identifies this repository ``Identify.adminEmail`` - The email address of the repository administrator}(hhhj ubah}(h]h!]h#]h%]h']j j uh)j hKhj ubeh}(h]h!]h#]h%]h']uh)hxhj hhhh*hNubhy)}(hXEdit the deployment descriptor (``web.xml``) file, also in the WEB-INF directory. Uncomment the servlet-name and servlet-mapping entries for the DataProvider servlet by removing the surroundin "" strings: :: DataProvider Processes OAI verbs for Metacat OAI-PMH Data Provider (MODP) edu.ucsb.nceas.metacat.oaipmh.provider.server.OAIHandler 4 DataProvider /dataProvider h](h,)}(hEdit the deployment descriptor (``web.xml``) file, also in the WEB-INF directory. Uncomment the servlet-name and servlet-mapping entries for the DataProvider servlet by removing the surroundin "" strings:h](h Edit the deployment descriptor (}(h Edit the deployment descriptor (hj ubh)}(h ``web.xml``h]hweb.xml}(hhhj" ubah}(h]h!]h#]h%]h']uh)hhj ubh) file, also in the WEB-INF directory. Uncomment the servlet-name and servlet-mapping entries for the DataProvider servlet by removing the surroundin “” strings:}(h) file, also in the WEB-INF directory. Uncomment the servlet-name and servlet-mapping entries for the DataProvider servlet by removing the surroundin "" strings:hj ubeh}(h]h!]h#]h%]h']uh)h+hh*hKhj ubj )}(hX DataProvider Processes OAI verbs for Metacat OAI-PMH Data Provider (MODP) edu.ucsb.nceas.metacat.oaipmh.provider.server.OAIHandler 4 DataProvider /dataProvider h]hX DataProvider Processes OAI verbs for Metacat OAI-PMH Data Provider (MODP) edu.ucsb.nceas.metacat.oaipmh.provider.server.OAIHandler 4 DataProvider /dataProvider }(hhhj; ubah}(h]h!]h#]h%]h']j j uh)j hKhj ubeh}(h]h!]h#]h%]h']uh)hxhj hhhh*hNubhy)}(hHSave the ``metacat.properties`` and ``web.xml`` files and start Tomcat. h]h,)}(hGSave the ``metacat.properties`` and ``web.xml`` files and start Tomcat.h](h Save the }(h Save the hjS ubh)}(h``metacat.properties``h]hmetacat.properties}(hhhj\ ubah}(h]h!]h#]h%]h']uh)hhjS ubh and }(h and hjS ubh)}(h ``web.xml``h]hweb.xml}(hhhjo ubah}(h]h!]h#]h%]h']uh)hhjS ubh files and start Tomcat.}(h files and start Tomcat.hjS ubeh}(h]h!]h#]h%]h']uh)h+hh*hKhjO ubah}(h]h!]h#]h%]h']uh)hxhj hhhh*hNubeh}(h]h!]h#]h%]h']jgjhjihjjjkuh)hshj| hhhh*hKubh,)}(h|The following table describes the complete set of ``metacat.properties`` settings that are used by the DataProvider servlet.h](h2The following table describes the complete set of }(h2The following table describes the complete set of hj hhhNhNubh)}(h``metacat.properties``h]hmetacat.properties}(hhhj ubah}(h]h!]h#]h%]h']uh)hhj ubh4 settings that are used by the DataProvider servlet.}(h4 settings that are used by the DataProvider servlet.hj hhhNhNubeh}(h]h!]h#]h%]h']uh)h+hh*hKhj| hhubj)}(hhh]j )}(hhh](j)}(hhh]h}(h]h!]h#]h%]h']colwidthK(uh)jhj ubj)}(hhh]h}(h]h!]h#]h%]h']colwidthKLuh)jhj ubj)}(hhh]h}(h]h!]h#]h%]h']colwidthKuh)jhj ubj0)}(hhh]j5)}(hhh](j:)}(hhh]h,)}(h Property Nameh]h Property Name}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hj ubj:)}(hhh]h,)}(h Sample Valueh]h Sample Value}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hj ubj:)}(hhh]h,)}(h Descriptionh]h Description}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hj ubeh}(h]h!]h#]h%]h']uh)j4hj ubah}(h]h!]h#]h%]h']uh)j/hj ubj)}(hhh](j5)}(hhh](j:)}(hhh]h,)}(hoaipmh.maxListSizeh]hoaipmh.maxListSize}(hj< hj: ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj7 ubah}(h]h!]h#]h%]h']uh)j9hj4 ubj:)}(hhh]h,)}(h5h]h5}(hjS hjQ ubah}(h]h!]h#]h%]h']uh)h+hh*hKhjN ubah}(h]h!]h#]h%]h']uh)j9hj4 ubj:)}(hhh]h,)}(h]Maximum number of records returned by each call to the ListIdentifiers and ListRecords verbs.h]h]Maximum number of records returned by each call to the ListIdentifiers and ListRecords verbs.}(hjj hjh ubah}(h]h!]h#]h%]h']uh)h+hh*hKhje ubah}(h]h!]h#]h%]h']uh)j9hj4 ubeh}(h]h!]h#]h%]h']uh)j4hj1 ubj5)}(hhh](j:)}(hhh]h,)}(hoaipmh.repositoryIdentifierh]hoaipmh.repositoryIdentifier}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hj ubj:)}(hhh]h,)}(hmetacat.lternet.eduh]hmetacat.lternet.edu}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hj ubj:)}(hhh]h,)}(h)An identifier string for the respository.h]h)An identifier string for the respository.}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hj ubeh}(h]h!]h#]h%]h']uh)j4hj1 ubj5)}(hhh](j:)}(hhh]h,)}(h#AbstractCatalog.oaiCatalogClassNameh]h#AbstractCatalog.oaiCatalogClassName}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hj ubj:)}(hhh]h,)}(hDedu.ucsb.nceas.metacat.oaipmh.provider.server.catalog.MetacatCatalogh]hDedu.ucsb.nceas.metacat.oaipmh.provider.server.catalog.MetacatCatalog}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hj ubj:)}(hhh]h,)}(hThe Java class that implements the AbstractCatalog interface. This class determines which records exist in the repository and their datestamps.h]hThe Java class that implements the AbstractCatalog interface. This class determines which records exist in the repository and their datestamps.}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hj ubeh}(h]h!]h#]h%]h']uh)j4hj1 ubj5)}(hhh](j:)}(hhh]h,)}(h&AbstractCatalog.recordFactoryClassNameh]h&AbstractCatalog.recordFactoryClassName}(hj& hj$ ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj! ubah}(h]h!]h#]h%]h']uh)j9hj ubj:)}(hhh]h,)}(hJedu.ucsb.nceas.metacat.oaipmh.provider.server.catalog.MetacatRecordFactoryh]hJedu.ucsb.nceas.metacat.oaipmh.provider.server.catalog.MetacatRecordFactory}(hj= hj; ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj8 ubah}(h]h!]h#]h%]h']uh)j9hj ubj:)}(hhh]h,)}(haThe Java class that extends the RecordFactory class. This class creates OAI-PMH metadata records.h]haThe Java class that extends the RecordFactory class. This class creates OAI-PMH metadata records.}(hjT hjR ubah}(h]h!]h#]h%]h']uh)h+hh*hKhjO ubah}(h]h!]h#]h%]h']uh)j9hj ubeh}(h]h!]h#]h%]h']uh)j4hj1 ubj5)}(hhh](j:)}(hhh]h,)}(hAbstractCatalog.secondsToLiveh]hAbstractCatalog.secondsToLive}(hjt hjr ubah}(h]h!]h#]h%]h']uh)h+hh*hKhjo ubah}(h]h!]h#]h%]h']uh)j9hjl ubj:)}(hhh]h,)}(h3600h]h3600}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hjl ubj:)}(hhh]h,)}(h1The lifetime, in seconds, of the resumptionToken.h]h1The lifetime, in seconds, of the resumptionToken.}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hjl ubeh}(h]h!]h#]h%]h']uh)j4hj1 ubj5)}(hhh](j:)}(hhh]h,)}(hAbstractCatalog.granularityh]hAbstractCatalog.granularity}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hj ubj:)}(hhh]h,)}(h"YYYY-MM-DD or YYYY-MM-DDThh:mm:ssZh]h"YYYY-MM-DD or YYYY-MM-DDThh:mm:ssZ}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hj ubj:)}(hhh]h,)}(haGranularity of datestamps. Either "days granularity" or "seconds granularity" values can be used.h]hiGranularity of datestamps. Either “days granularity” or “seconds granularity” values can be used.}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hj ubeh}(h]h!]h#]h%]h']uh)j4hj1 ubj5)}(hhh](j:)}(hhh]h,)}(hIdentify.repositoryNameh]hIdentify.repositoryName}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hj ubj:)}(hhh]h,)}(hMetacat OAI-PMH Data Providerh]hMetacat OAI-PMH Data Provider}(hj' hj% ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj" ubah}(h]h!]h#]h%]h']uh)j9hj ubj:)}(hhh]h,)}(hA name for the repository.h]hA name for the repository.}(hj> hj< ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj9 ubah}(h]h!]h#]h%]h']uh)j9hj ubeh}(h]h!]h#]h%]h']uh)j4hj1 ubj5)}(hhh](j:)}(hhh]h,)}(hIdentify.earliestDatestamph]hIdentify.earliestDatestamp}(hj^ hj\ ubah}(h]h!]h#]h%]h']uh)h+hh*hKhjY ubah}(h]h!]h#]h%]h']uh)j9hjV ubj:)}(hhh]h,)}(h2000-01-01T00:00:00Zh]h2000-01-01T00:00:00Z}(hju hjs ubah}(h]h!]h#]h%]h']uh)h+hh*hKhjp ubah}(h]h!]h#]h%]h']uh)j9hjV ubj:)}(hhh]h,)}(h/Earliest datestamp supported by this repositoryh]h/Earliest datestamp supported by this repository}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hjV ubeh}(h]h!]h#]h%]h']uh)j4hj1 ubj5)}(hhh](j:)}(hhh]h,)}(hIdentify.deletedRecordh]hIdentify.deletedRecord}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hj ubj:)}(hhh]h,)}(h yes or noh]h yes or no}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hj ubj:)}(hhh]h,)}(h\Use "yes" if the repository indicates the status of deleted records; use "no" if it doesn't.h]hfUse “yes” if the repository indicates the status of deleted records; use “no” if it doesn’t.}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hj ubeh}(h]h!]h#]h%]h']uh)j4hj1 ubj5)}(hhh](j:)}(hhh]h,)}(hIdentify.adminEmailh]hIdentify.adminEmail}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hj ubj:)}(hhh]h,)}(h!mailto:tech_support@someplace.orgh]h7)}(hjh]h!mailto:tech_support@someplace.org}(hhhjubah}(h]h!]h#]h%]h']refurijuh)h6hjubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hj ubj:)}(hhh]h,)}(h.Email address of the repository administrator.h]h.Email address of the repository administrator.}(hj2hj0ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj-ubah}(h]h!]h#]h%]h']uh)j9hj ubeh}(h]h!]h#]h%]h']uh)j4hj1 ubj5)}(hhh](j:)}(hhh]h,)}(hCrosswalks.oai_dch]hCrosswalks.oai_dc}(hjRhjPubah}(h]h!]h#]h%]h']uh)h+hh*hKhjMubah}(h]h!]h#]h%]h']uh)j9hjJubj:)}(hhh]h,)}(hBedu.ucsb.nceas.metacat.oaipmh.provider.server.crosswalk.Eml2oai_dch]hBedu.ucsb.nceas.metacat.oaipmh.provider.server.crosswalk.Eml2oai_dc}(hjihjgubah}(h]h!]h#]h%]h']uh)h+hh*hKhjdubah}(h]h!]h#]h%]h']uh)j9hjJubj:)}(hhh]h,)}(hIJava class that controls the EML 2.x.y to oai_dc (Dublin Core) crosswalk.h]hIJava class that controls the EML 2.x.y to oai_dc (Dublin Core) crosswalk.}(hjhj~ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj{ubah}(h]h!]h#]h%]h']uh)j9hjJubeh}(h]h!]h#]h%]h']uh)j4hj1 ubj5)}(hhh](j:)}(hhh]h,)}(hCrosswalks.eml2.0.0h]hCrosswalks.eml2.0.0}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h>edu.ucsb.nceas.metacat.oaipmh.provider.server.crosswalk.Eml200h]h>edu.ucsb.nceas.metacat.oaipmh.provider.server.crosswalk.Eml200}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h-Java class that furnishes EML 2.0.0 metadata.h]h-Java class that furnishes EML 2.0.0 metadata.}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hj1 ubj5)}(hhh](j:)}(hhh]h,)}(hCrosswalks.eml2.0.1h]hCrosswalks.eml2.0.1}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h>edu.ucsb.nceas.metacat.oaipmh.provider.server.crosswalk.Eml201h]h>edu.ucsb.nceas.metacat.oaipmh.provider.server.crosswalk.Eml201}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h-Java class that furnishes EML 2.0.1 metadata.h]h-Java class that furnishes EML 2.0.1 metadata.}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hj1 ubj5)}(hhh](j:)}(hhh]h,)}(hCrosswalks.eml2.1.0h]hCrosswalks.eml2.1.0}(hj<hj:ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj7ubah}(h]h!]h#]h%]h']uh)j9hj4ubj:)}(hhh]h,)}(h>edu.ucsb.nceas.metacat.oaipmh.provider.server.crosswalk.Eml210h]h>edu.ucsb.nceas.metacat.oaipmh.provider.server.crosswalk.Eml210}(hjShjQubah}(h]h!]h#]h%]h']uh)h+hh*hKhjNubah}(h]h!]h#]h%]h']uh)j9hj4ubj:)}(hhh]h,)}(h-Java class that furnishes EML 2.1.0 metadata.h]h-Java class that furnishes EML 2.1.0 metadata.}(hjjhjhubah}(h]h!]h#]h%]h']uh)h+hh*hKhjeubah}(h]h!]h#]h%]h']uh)j9hj4ubeh}(h]h!]h#]h%]h']uh)j4hj1 ubeh}(h]h!]h#]h%]h']uh)jhj ubeh}(h]h!]h#]h%]h']colsKuh)j hj ubah}(h]h!]h#]h%]h']uh)jhj| hhhh*hNubh )}(hhh](h)}(h Sample URLsh]h Sample URLs}(hjhjhhhNhNubah}(h]h!]h#]h%]h']uh)hhjhhhh*hKubh,)}(hMSample URLs that demonstrate use of the Metacat OAI-PMH Data Provider follow:h]hMSample URLs that demonstrate use of the Metacat OAI-PMH Data Provider follow:}(hjhjhhhNhNubah}(h]h!]h#]h%]h']uh)h+hh*hKhjhhubj)}(hhh]j )}(hhh](j)}(hhh]h}(h]h!]h#]h%]h']colwidthKuh)jhjubj)}(hhh]h}(h]h!]h#]h%]h']colwidthK>uh)jhjubj)}(hhh]h}(h]h!]h#]h%]h']colwidthKuh)jhjubj0)}(hhh]j5)}(hhh](j:)}(hhh]h,)}(h OAI-PMH Verbh]h OAI-PMH Verb}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h Descriptionh]h Description}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hURLh]hURL}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubah}(h]h!]h#]h%]h']uh)j/hjubj)}(hhh](j5)}(hhh](j:)}(hhh]h,)}(h GetRecordh]h GetRecord}(hj:hj8ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj5ubah}(h]h!]h#]h%]h']uh)j9hj2ubj:)}(hhh]h,)}(h1Get an EML 2.0.1 record using its LSID identifierh]h1Get an EML 2.0.1 record using its LSID identifier}(hjQhjOubah}(h]h!]h#]h%]h']uh)h+hh*hKhjLubah}(h]h!]h#]h%]h']uh)j9hj2ubj:)}(hhh]h,)}(hhttp:///dataProvider?verb=GetRecord&metadataPrefix=eml-2.0.1&identifier=urn:lsid:knb.ecoinformatics.org:knb-ltergce:26h](h7)}(hhttp:/h]hhttp:/}(hhhjjubah}(h]h!]h#]h%]h']refurijluh)h6hjfubh//dataProvider?verb=GetRecord&metadataPrefix=eml-2.0.1&identifier=urn:lsid:knb.ecoinformatics.org:knb-ltergce:26}(h//dataProvider?verb=GetRecord&metadataPrefix=eml-2.0.1&identifier=urn:lsid:knb.ecoinformatics.org:knb-ltergce:26hjfubeh}(h]h!]h#]h%]h']uh)h+hh*hKhjcubah}(h]h!]h#]h%]h']uh)j9hj2ubeh}(h]h!]h#]h%]h']uh)j4hj/ubj5)}(hhh](j:)}(hhh]h,)}(h GetRecordh]h GetRecord}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h/dataProvider?verb=GetRecord&metadataPrefix=oai_dc&identifier=urn:lsid:knb.ecoinformatics.org:knb-lter-gce:26h](h7)}(hhttp:/h]hhttp:/}(hhhjubah}(h]h!]h#]h%]h']refurijuh)h6hjubh//dataProvider?verb=GetRecord&metadataPrefix=oai_dc&identifier=urn:lsid:knb.ecoinformatics.org:knb-lter-gce:26}(h//dataProvider?verb=GetRecord&metadataPrefix=oai_dc&identifier=urn:lsid:knb.ecoinformatics.org:knb-lter-gce:26hjubeh}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hj/ubj5)}(hhh](j:)}(hhh]h,)}(hIdentifyh]hIdentify}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hIdentify this data providerh]hIdentify this data provider}(hj hj ubah}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h4http:///dataProvider?verb=Identifyh](h7)}(hhttp:/h]hhttp:/}(hhhj&ubah}(h]h!]h#]h%]h']refurij(uh)h6hj"ubh.//dataProvider?verb=Identify}(h.//dataProvider?verb=Identifyhj"ubeh}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hj/ubj5)}(hhh](j:)}(hhh]h,)}(hListIdentifiersh]hListIdentifiers}(hjThjRubah}(h]h!]h#]h%]h']uh)h+hh*hKhjOubah}(h]h!]h#]h%]h']uh)j9hjLubj:)}(hhh]h,)}(h0List all EML 2.1.0 identifiers in the repositoryh]h0List all EML 2.1.0 identifiers in the repository}(hjkhjiubah}(h]h!]h#]h%]h']uh)h+hh*hKhjfubah}(h]h!]h#]h%]h']uh)j9hjLubj:)}(hhh]h,)}(hThttp:///dataProvider?verb=ListIdentifiers&metadataPrefix=eml-2.1.0h](h7)}(hhttp:/h]hhttp:/}(hhhjubah}(h]h!]h#]h%]h']refurijuh)h6hjubhN//dataProvider?verb=ListIdentifiers&metadataPrefix=eml-2.1.0}(hN//dataProvider?verb=ListIdentifiers&metadataPrefix=eml-2.1.0hjubeh}(h]h!]h#]h%]h']uh)h+hh*hKhj}ubah}(h]h!]h#]h%]h']uh)j9hjLubeh}(h]h!]h#]h%]h']uh)j4hj/ubj5)}(hhh](j:)}(hhh]h,)}(hListIdentifiersh]hListIdentifiers}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hTList all oai_dc (Dublin Core) identifiers in the repository between a range of datesh]hTList all oai_dc (Dublin Core) identifiers in the repository between a range of dates}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hrhttp:///dataProvider?verb=ListIdentifiers&metadataPrefix=oai_dc&from=2006-01-01&until=2010-01-01h](h7)}(hhttp:/h]hhttp:/}(hhhjubah}(h]h!]h#]h%]h']refurijuh)h6hjubhl//dataProvider?verb=ListIdentifiers&metadataPrefix=oai_dc&from=2006-01-01&until=2010-01-01}(hl//dataProvider?verb=ListIdentifiers&metadataPrefix=oai_dc&from=2006-01-01&until=2010-01-01hjubeh}(h]h!]h#]h%]h']uh)h+hh*hKhjubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hj/ubj5)}(hhh](j:)}(hhh]h,)}(hListMetadataFormatsh]hListMetadataFormats}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hKhj ubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h2List metadata formats supported by this repositoryh]h2List metadata formats supported by this repository}(hj'hj%ubah}(h]h!]h#]h%]h']uh)h+hh*hKhj"ubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h?http:///dataProvider?verb=ListMetadataFormatsh](h7)}(hhttp:/h]hhttp:/}(hhhj@ubah}(h]h!]h#]h%]h']refurijBuh)h6hj<ubh9//dataProvider?verb=ListMetadataFormats}(h9//dataProvider?verb=ListMetadataFormatshj<ubeh}(h]h!]h#]h%]h']uh)h+hh*hKhj9ubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hj/ubj5)}(hhh](j:)}(hhh]h,)}(h ListRecordsh]h ListRecords}(hjnhjlubah}(h]h!]h#]h%]h']uh)h+hh*hMhjiubah}(h]h!]h#]h%]h']uh)j9hjfubj:)}(hhh]h,)}(h,List all EML 2.0.0 records in the repositoryh]h,List all EML 2.0.0 records in the repository}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hMhjubah}(h]h!]h#]h%]h']uh)j9hjfubj:)}(hhh]h,)}(hPhttp:///dataProvider?verb=ListRecords&metadataPrefix=eml-2.0.0h](h7)}(hhttp:/h]hhttp:/}(hhhjubah}(h]h!]h#]h%]h']refurijuh)h6hjubhJ//dataProvider?verb=ListRecords&metadataPrefix=eml-2.0.0}(hJ//dataProvider?verb=ListRecords&metadataPrefix=eml-2.0.0hjubeh}(h]h!]h#]h%]h']uh)h+hh*hMhjuba~]h}(h]h!]h#]h%]h']uh)j9hjfubeh}(h]h!]h#]h%]h']uh)j4hj/ubj5)}(hhh](j:)}(hhh]h,)}(h ListRecordsh]h ListRecords}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hMhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h7List all oai_dc (Dublin Core) records in the repositoryh]h7List all oai_dc (Dublin Core) records in the repository}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hMhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hMhttp:///dataProvider?verb=ListRecords&metadataPrefix=oai_dch](h7)}(hhttp:/h]hhttp:/}(hhhjubah}(h]h!]h#]h%]h']refurijuh)h6hjubhG//dataProvider?verb=ListRecords&metadataPrefix=oai_dc}(hG//dataProvider?verb=ListRecords&metadataPrefix=oai_dchjubeh}(h]h!]h#]h%]h']uh)h+hh*hMhjubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hj/ubj5)}(hhh](j:)}(hhh]h,)}(hListSetsh]hListSets}(hj*hj(ubah}(h]h!]h#]h%]h']uh)h+hh*hMhj%ubah}(h]h!]h#]h%]h']uh)j9hj"ubj:)}(hhh]h,)}(h&List sets supported by this repositoryh]h&List sets supported by this repository}(hjAhj?ubah}(h]h!]h#]h%]h']uh)h+hh*hMhj<ubah}(h]h!]h#]h%]h']uh)j9hj"ubj:)}(hhh]h,)}(h4http:///dataProvider?verb=ListSetsh](h7)}(hhttp:/h]hhttp:/}(hhhjZubah}(h]h!]h#]h%]h']refurij\uh)h6hjVubh.//dataProvider?verb=ListSets}(h.//dataProvider?verb=ListSetshjVubeh}(h]h!]h#]h%]h']uh)h+hh*hMhjSubah}(h]h!]h#]h%]h']uh)j9hj"ubeh}(h]h!]h#]h%]h']uh)j4hj/ubeh}(h]h!]h#]h%]h']uh)jhjubeh}(h]h!]h#]h%]h']colsKuh)j hjubah}(h]h!]h#]h%]h']uh)jhjhhhh*hNubeh}(h] sample-urlsah!]h#] sample urlsah%]h']uh)h hj| hhhh*hKubeh}(h]%metacat-oai-pmh-data-provider-servletah!]h#]%metacat oai-pmh data provider servletah%]h']uh)h hjk hhhh*hKubh )}(hhh](h)}(hMetacat OAI-PMH Harvesterh]hMetacat OAI-PMH Harvester}(hjhjhhhNhNubah}(h]h!]h#]h%]h']uh)hhjhhhh*hM ubh,)}(hKThe Metacat OAI-PMH Harvester (MOH) is executed as a command-line program::h]hJThe Metacat OAI-PMH Harvester (MOH) is executed as a command-line program:}(hJThe Metacat OAI-PMH Harvester (MOH) is executed as a command-line program:hjhhhNhNubah}(h]h!]h#]h%]h']uh)h+hh*hM hjhhubj )}(hXsh runHarvester.sh -dn \ -password \ -metadataPrefix \ [-from ] \ [-until ] \ [-setSpec ] \ h]hXsh runHarvester.sh -dn \ -password \ -metadataPrefix \ [-from ] \ [-until ] \ [-setSpec ] \ }(hhhjubah}(h]h!]h#]h%]h']j j uh)j hM hjhhhh*ubh,)}(haThe following example illustrates how the Metacat OAI-PMH Harvester is run from the command line:h]haThe following example illustrates how the Metacat OAI-PMH Harvester is run from the command line:}(hjhjhhhNhNubah}(h]h!]h#]h%]h']uh)h+hh*hMhjhhubht)}(hhh](hy)}(h0Open a system command window or terminal window.h]h,)}(hjh]h0Open a system command window or terminal window.}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hMhjubah}(h]h!]h#]h%]h']uh)hxhjhhhh*hNubhy)}(hSet the METACAT_HOME environment variable to the value of the Metacat installation directory. Some examples follow: :: export METACAT_HOME=/home/somePath/metacat h](h,)}(hsSet the METACAT_HOME environment variable to the value of the Metacat installation directory. Some examples follow:h]hsSet the METACAT_HOME environment variable to the value of the Metacat installation directory. Some examples follow:}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hMhjubj )}(h*export METACAT_HOME=/home/somePath/metacath]h*export METACAT_HOME=/home/somePath/metacat}(hhhj ubah}(h]h!]h#]h%]h']j j uh)j hMhjubeh}(h]h!]h#]h%]h']uh)hxhjhhhh*hNubhy)}(hBcd to the following directory: :: cd $METACAT_HOME/lib/oaipmh h](h,)}(hcd to the following directory:h]hcd to the following directory:}(hj%hj#ubah}(h]h!]h#]h%]h']uh)h+hh*hMhjubj )}(hcd $METACAT_HOME/lib/oaipmhh]hcd $METACAT_HOME/lib/oaipmh}(hhhj1ubah}(h]h!]h#]h%]h']j j uh)j hM#hjubeh}(h]h!]h#]h%]h']uh)hxhjhhhh*hNubhy)}(hX.Run the appropriate Metacat OAI-PMH Harvester shell script, as determined by the operating system: :: sh runHarvester.sh \ -dn uid=jdoe,o=myorg,dc=ecoinformatics,dc=org \ -password some_password \ -metadataPrefix oai_dc \ http://baseurl.repository.org/metacat/dataProvider h](h,)}(hbRun the appropriate Metacat OAI-PMH Harvester shell script, as determined by the operating system:h]hbRun the appropriate Metacat OAI-PMH Harvester shell script, as determined by the operating system:}(hjKhjIubah}(h]h!]h#]h%]h']uh)h+hh*hM%hjEubj )}(hsh runHarvester.sh \ -dn uid=jdoe,o=myorg,dc=ecoinformatics,dc=org \ -password some_password \ -metadataPrefix oai_dc \ http://baseurl.repository.org/metacat/dataProviderh]hsh runHarvester.sh \ -dn uid=jdoe,o=myorg,dc=ecoinformatics,dc=org \ -password some_password \ -metadataPrefix oai_dc \ http://baseurl.repository.org/metacat/dataProvider}(hhhjWubah}(h]h!]h#]h%]h']j j uh)j hM)hjEubeh}(h]h!]h#]h%]h']uh)hxhjhhhh*hNubeh}(h]h!]h#]h%]h']jgjhjihjjjkuh)hshjhhhh*hMubh,)}(hICommand line options and parameters are described in the following table:h]hICommand line options and parameters are described in the following table:}(hjshjqhhhNhNubah}(h]h!]h#]h%]h']uh)h+hh*hM0hjhhubj)}(hhh]j )}(hhh](j)}(hhh]h}(h]h!]h#]h%]h']colwidthKuh)jhjubj)}(hhh]h}(h]h!]h#]h%]h']colwidthK8uh)jhjubj)}(hhh]h}(h]h!]h#]h%]h']colwidthKeuh)jhjubj0)}(hhh]j5)}(hhh](j:)}(hhh]h,)}(hCommand Option or Parameterh]hCommand Option or Parameter}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hM3hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hExampleh]hExample}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hM3hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h Descriptionh]h Description}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hM3hjubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubah}(h]h!]h#]h%]h']uh)j/hjubj)}(hhh](j5)}(hhh](j:)}(hhh]h,)}(h-dnh]h-dn}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hM5hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h1``-dn uid=dryad,o=LTER,dc=ecoinformatics,dc=org``h]h)}(hjh]h--dn uid=dryad,o=LTER,dc=ecoinformatics,dc=org}(hhhjubah}(h]h!]h#]h%]h']uh)hhjubah}(h]h!]h#]h%]h']uh)h+hh*hM5hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hcFull distinguished name of the LDAP account used when harvesting documents into Metacat. (Required)h]hcFull distinguished name of the LDAP account used when harvesting documents into Metacat. (Required)}(hj<hj:ubah}(h]h!]h#]h%]h']uh)h+hh*hM5hj7ubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(h -passwordh]h -password}(hj\hjZubah}(h]h!]h#]h%]h']uh)h+hh*hM7hjWubah}(h]h!]h#]h%]h']uh)j9hjTubj:)}(hhh]h,)}(h``-password some_password``h]h)}(hjsh]h-password some_password}(hhhjuubah}(h]h!]h#]h%]h']uh)hhjqubah}(h]h!]h#]h%]h']uh)h+hh*hM7hjnubah}(h]h!]h#]h%]h']uh)j9hjTubj:)}(hhh]h,)}(hTPassword of the LDAP account used when harvesting documents into Metacat. (Required)h]hTPassword of the LDAP account used when harvesting documents into Metacat. (Required)}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hM7hjubah}(h]h!]h#]h%]h']uh)j9hjTubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(h-metadataPrefixh]h-metadataPrefix}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hM9hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h``-metadataPrefix oai_dc``h]h)}(hjh]h-metadataPrefix oai_dc}(hhhjubah}(h]h!]h#]h%]h']uh)hhjubah}(h]h!]h#]h%]h']uh)h+hh*hM9hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hLThe type of documents being harvested from the remote repository. (Required)h]hLThe type of documents being harvested from the remote repository. (Required)}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hM9hjubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(h-fromh]h-from}(hj hjubah}(h]h!]h#]h%]h']uh)h+hh*hM;hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h``-from 2000-01-01``h]h)}(hj!h]h-from 2000-01-01}(hhhj#ubah}(h]h!]h#]h%]h']uh)hhjubah}(h]h!]h#]h%]h']uh)h+hh*hM;hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hDThe lower limit of the datestamp for harvested documents. (Optional)h]hDThe lower limit of the datestamp for harvested documents. (Optional)}(hjAhj?ubah}(h]h!]h#]h%]h']uh)h+hh*hM;hj<ubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(h-untilh]h-until}(hjahj_ubah}(h]h!]h#]h%]h']uh)h+hh*hM=hj\ubah}(h]h!]h#]h%]h']uh)j9hjYubj:)}(hhh]h,)}(h``-until 2010-12-31``h]h)}(hjxh]h-until 2010-12-31}(hhhjzubah}(h]h!]h#]h%]h']uh)hhjvubah}(h]h!]h#]h%]h']uh)h+hh*hM=hjsubah}(h]h!]h#]h%]h']uh)j9hjYubj:)}(hhh]h,)}(hDThe upper limit of the datestamp for harvested documents. (Optional)h]hDThe upper limit of the datestamp for harvested documents. (Optional)}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hM=hjubah}(h]h!]h#]h%]h']uh)j9hjYubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(h-setSpech]h-setSpec}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hM?hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h``-setSpec someSet``h]h)}(hjh]h-setSpec someSet}(hhhjubah}(h]h!]h#]h%]h']uh)hhjubah}(h]h!]h#]h%]h']uh)h+hh*hM?hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h3Harvest documents belonging to this set. (Optional)h]h3Harvest documents belonging to this set. (Optional)}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hM?hjubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(hbase_urlh]hbase_url}(hjhj ubah}(h]h!]h#]h%]h']uh)h+hh*hMAhj ubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h6``http://baseurl.repository.org/metacat/dataProvider``h]h)}(hj&h]h2http://baseurl.repository.org/metacat/dataProvider}(hhhj(ubah}(h]h!]h#]h%]h']uh)hhj$ubah}(h]h!]h#]h%]h']uh)h+hh*hMAhj!ubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h!Base URL of the remote repositoryh]h!Base URL of the remote repository}(hjFhjDubah}(h]h!]h#]h%]h']uh)h+hh*hMAhjAubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubeh}(h]h!]h#]h%]h']uh)jhjubeh}(h]h!]h#]h%]h']colsKuh)j hjubah}(h]h!]h#]h%]h']uh)jhjhhhh*hNubeh}(h]id1ah!]h#]h%]ja ah']uh)h hjk hhhh*hM hdKubeh}(h]'configuring-and-running-metacat-oai-pmhah!]h#]'configuring and running metacat oai-pmhah%]h']uh)h hh hhhh*hKubh )}(hhh](h)}(hOAI-PMH Error Codesh]hOAI-PMH Error Codes}(hjhjhhhNhNubah}(h]h!]h#]h%]h']uh)hhjhhhh*hMFubj)}(hhh]j )}(hhh](j)}(hhh]h}(h]h!]h#]h%]h']colwidthKuh)jhjubj)}(hhh]h}(h]h!]h#]h%]h']colwidthKPuh)jhjubj)}(hhh]h}(h]h!]h#]h%]h']colwidthKuh)jhjubj)}(hhh](j5)}(hhh](j:)}(hhh]h,)}(h Error Codeh]h Error Code}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hMIhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h Descriptionh]h Description}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hMIhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hApplicable Verbsh]hApplicable Verbs}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hMIhjubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(h badArgumenth]h badArgument}(hjhj ubah}(h]h!]h#]h%]h']uh)h+hh*hMKhj ubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hThe request includes illegal arguments, is missing required arguments, includes a repeated argument, or values for arguments have an illegal syntax.h]hThe request includes illegal arguments, is missing required arguments, includes a repeated argument, or values for arguments have an illegal syntax.}(hj%hj#ubah}(h]h!]h#]h%]h']uh)h+hh*hMKhj ubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h all verbsh]h all verbs}(hj<hj:ubah}(h]h!]h#]h%]h']uh)h+hh*hMKhj7ubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(hbadResumptionTokenh]hbadResumptionToken}(hj\hjZubah}(h]h!]h#]h%]h']uh)h+hh*hMNhjWubah}(h]h!]h#]h%]h']uh)j9hjTubj:)}(hhh]h,)}(h@The value of the resumptionToken argument is invalid or expired.h]h@The value of the resumptionToken argument is invalid or expired.}(hjshjqubah}(h]h!]h#]h%]h']uh)h+hh*hMNhjnubah}(h]h!]h#]h%]h']uh)j9hjTubj:)}(hhh]h,)}(h$ListIdentifiers ListRecords ListSetsh]h$ListIdentifiers ListRecords ListSets}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hMNhjubah}(h]h!]h#]h%]h']uh)j9hjTubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(hbadVerbh]hbadVerb}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hMRhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hwValue of the verb argument is not a legal OAI-PMH verb, the verb argument is missing, or the verb argument is repeated.h]hwValue of the verb argument is not a legal OAI-PMH verb, the verb argument is missing, or the verb argument is repeated.}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hMRhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hN/Ah]hN/A}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hMRhjubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(hcannotDisseminateFormath]hcannotDisseminateFormat}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hMUhjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hThe metadata format identified by the value given for the metadataPrefix argument is not supported by the item or by the repository.h]hThe metadata format identified by the value given for the metadataPrefix argument is not supported by the item or by the repository.}(hjhj ubah}(h]h!]h#]h%]h']uh)h+hh*hMUhj ubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h%GetRecord ListIdentifiers ListRecordsh]h%GetRecord ListIdentifiers ListRecords}(hj&hj$ubah}(h]h!]h#]h%]h']uh)h+hh*hMUhj!ubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(hidDoesNotExisth]hidDoesNotExist}(hjFhjDubah}(h]h!]h#]h%]h']uh)h+hh*hMYhjAubah}(h]h!]h#]h%]h']uh)j9hj>ubj:)}(hhh]h,)}(hNThe value of the identifier argument is unknown or illegal in this repository.h]hNThe value of the identifier argument is unknown or illegal in this repository.}(hj]hj[ubah}(h]h!]h#]h%]h']uh)h+hh*hMYhjXubah}(h]h!]h#]h%]h']uh)j9hj>ubj:)}(hhh]h,)}(hGetRecord ListMetadataFormatsh]hGetRecord ListMetadataFormats}(hjthjrubah}(h]h!]h#]h%]h']uh)h+hh*hMYhjoubah}(h]h!]h#]h%]h']uh)j9hj>ubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(hnoRecordsMatchh]hnoRecordsMatch}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hM\hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hlThe combination of the values of the from, until, set and metadataPrefix arguments results in an empty list.h]hlThe combination of the values of the from, until, set and metadataPrefix arguments results in an empty list.}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hM\hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hListIdentifiers ListRecordsh]hListIdentifiers ListRecords}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hM\hjubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(hnoMetadataFormatsh]hnoMetadataFormats}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hM_hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(h?There are no metadata formats available for the specified item.h]h?There are no metadata formats available for the specified item.}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hM_hjubah}(h]h!]h#]h%]h']uh)j9hjubj:)}(hhh]h,)}(hListMetadataFormatsh]hListMetadataFormats}(hjhjubah}(h]h!]h#]h%]h']uh)h+hh*hM_hj ubah}(h]h!]h#]h%]h']uh)j9hjubeh}(h]h!]h#]h%]h']uh)j4hjubj5)}(hhh](j:)}(hhh]h,)}(hnoSetHierarchyh]hnoSetHierarchy}(hj0hj.ubah}(h]h!]h#]h%]h']uh)h+hh*hMahj+ubah}(h]h!]h#]h%]h']uh)j9hj(ubj:)}(hhh]h,)}(h%The repository does not support sets.h]h%The repository does not support sets.}(hjGhjEubah}(h]h!]h#]h%]h']uh)h+hh*hMahjBubah}(h]h!]h#]h%]h']uh)j9hj(ubj:)}(hhh]h,)}(h$ListSets ListIdentifiers ListRecordsh]h$ListSets ListIdentifiers ListRecords}(hj^hj\ubah}(h]h!]h#]h%]h']uh)h+hh*hMahjYubah}(h]h!]h#]h%]h']uh)j9hj(ubeh}(h]h!]h#]h%]h']uh)j4hjubeh}(h]h!]h#]h%]h']uh)jhjubeh}(h]h!]h#]h%]h']colsKuh)j hjubah}(h]h!]h#]h%]h']uh)jhjhhhh*hNubeh}(h]oai-pmh-error-codesah!]h#]oai-pmh error codesah%]h']uh)h hh hhhh*hMFubeh}(h]$oai-protocol-for-metadata-harvestingah!]h#]$oai protocol for metadata harvestingah%]h']uh)h hhhhhh*hKubah}(h]h!]h#]h%]h']sourceh*uh)hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksj9footnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerjerror_encodingUTF-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourceh* _destinationN _config_files]pep_referencesN pep_base_url https://www.python.org/dev/peps/pep_file_url_templatepep-%04drfc_referencesN rfc_base_urlhttps://tools.ietf.org/html/ tab_widthKtrim_footnote_reference_spacefile_insertion_enabled raw_enabledKsyntax_highlightlong smart_quotessmartquotes_localesNcharacter_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xformembed_stylesheetcloak_email_addressesenvNgettext_compactubreporterNindirect_targets]substitution_defs}substitution_names}refnames}(oai-pmh]h8aoai-pmh standards document]juaurefids}nameids}(jjhah^jjjjjh je jj|metacat oai-pmh harvesterNj}jzjjjjjju nametypes}(jNhajjNjh NjNjNj}NjNjNjNuh}(jh h^hXjjjjje jj|jj] jjzjk jj| jjjsjjju footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startKid_startKparse_messages]hsystem_message)}(hhh]h,)}(h