User Tools

Site Tools


en:user_advanced:oai

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Last revisionBoth sides next revision
en:user_advanced:oai [2018/07/30 23:12] – [Downloading on the command line] kjdonen:user_advanced:oai [2018/07/30 23:20] – [Testing] kjdon
Line 20: Line 20:
 ^Option^Description^ ^Option^Description^
 |Source URL (''-url <string>'')|(REQUIRED) OAI repository URL| |Source URL (''-url <string>'')|(REQUIRED) OAI repository URL|
-|Metadata prefix (''-metadata_prefix <string>'')|The metadata format used in the exported metadata, e.g. oai_dc, qdc, etc. (//Default: oai_dc//)|+|Metadata prefix (''-metadata_prefix <string>'')|The metadata format used in the exported metadata, e.g. oai_dc, qdc, etc. The formats available depend on what is offered by the OAI server. All repositories must offer oai_dc. (//Default: oai_dc//)|
 |Restrict to set (''-set <string>'')| Restrict the download to the specified set in the repository| |Restrict to set (''-set <string>'')| Restrict the download to the specified set in the repository|
 |Get document (''-get_doc'')|Download the source document if one is specified in the record| |Get document (''-get_doc'')|Download the source document if one is specified in the record|
-|Only include file types (''-get_doc_exts <string>'')|Permissible filename extensions of documents to get (//Default: ''doc,pdf,ppt''//)|+|Only include file types (''-get_doc_exts <string>'')|If downloading source documents, only download those whose file extensions match this list. (//Default: ''doc,pdf,ppt''//)|
 |Max records (''-max_records <int>'')|Maximum number of records to download. If not specified, will download all records.| |Max records (''-max_records <int>'')|Maximum number of records to download. If not specified, will download all records.|
  
Line 64: Line 64:
 </code> </code>
  
-The options are the same as you can see in the GLI OAI download panel. They are: +The options are the same as you can see in the GLI OAI download panel, listed above
- +
-  * **-url <string>**: (Required) The OAI repository URL. +
-  * **-metadata_prefix <string>**: The metadata format to be used in the downloaded records. e.g. oai_dcqdc, etc. Formats available depend on what is offered by the OAI server. All repositories must offer oai_dc.  Default: oai_dc +
-  * **-set <string>**: Restrict the download to the specified set in the repository +
-  * **-get_doc**: Download source documents too, if available +
-  * **-get_doc_exts <string>**: If downloading source documents, only download those whose file extensions match this list.  Default: doc,pdf,ppt +
-  * **-max_records <int>**: Maximum number of records to download. If not specified, will download all records.+
  
   ***An example usage would be:**   ***An example usage would be:**
Line 88: Line 81:
   * [[oai_server_gs2|Greenstone 2 OAI server setup and configuration]]   * [[oai_server_gs2|Greenstone 2 OAI server setup and configuration]]
  
- 
-====Testing====  
- 
-Once you have your OAI service in place, testing can be done via online validation facilities such as the following: http://www.openarchives.org/data/registerasprovider.html or http://re.cs.uct.ac.za/. 
- 
-The former only verifies the Identify command, while extensive testing can be performed via the later one (called //Repository Explorer//). 
- 
-The Greenstone OAI server must be publically accessible over the Internet to use these validation tools. 
  
  
en/user_advanced/oai.txt · Last modified: 2023/03/13 01:46 by 127.0.0.1