Introduction

The Harvest List Editor is a tool that assists in composing and editing a Harvest List. The Harvest List editor displays a Harvest List as a table of rows and fields. Each row in the table corresponds to a single <document> element in the corresponding Harvest List XML file, where a <document> represents a single document to be harvested. Each row contains the following fields:

• Row #
  Displays the table row number. This field is used for visual reference only; it is non-editable and its value is not included in the XML file that is generated when the Harvest List is saved to disk.
• Scope
  the value of the <scope> element for this document
• Identifier
  the value of the <identifier> element for this document
• Revision
  the value of the <revision> element for this document
• Document Type
  the value of the <documentType> element for this document
• Document URL
  the value of the <documentURL> element for this document

For each <document> element to be included in the Harvest List, edit a row in the table, filling in values for each of the five editable fields: Scope, Identifier, Revision, Document Type, and Document URL. When you have finished adding <document> elements to the Harvest List, save the Harvest List to disk. Each of these steps are explained in more detail below.

Configuring the Harvest List Editor

On Windows:

  echo %USERPROFILE%

• On Linux/Unix:

    echo $HOME
  

The following table summarizes the properties that can be configured in the .harvestListEditor file. Note that all properties are optional; setting them improves the convenience of using the Harvest List Editor but it is not a requirement.

Property	Description	Possible or default value
defaultHarvestList	This property determines the location of a Harvest List file that the Harvest List Editor will automatically open for editing on startup. Set this property to the path to the Harvest List file that you expect to edit most frequently.	Examples: /home/jdoe/public_html/harvestList.xml C:/temp/harvestList.xml
defaultScope	Determines the value that is pasted into the Scope field of the currently selected row when the Paste Defaults button is clicked. The Scope field should contain a symbolic identifer that indicates which family of documents this EML document belongs to.	Example:   xyz_dataset Default:    dataset
defaulIdentifer	Determines the value that is pasted into the Identifier field of the currently selected row when the Paste Defaults button is clicked. The Identifier field should contain a numeric value indicating the identifier for this particular EML document within the Scope.	Example:   2 Default:    1
defaultRevision	Determines the value that is pasted into the Revision field of the currently selected row when the Paste Defaults button is clicked. The Revision field should contain a numeric value indicating the revision number of this EML document within the Scope and Identifier.	Example:   2 Default:    1
defaultDocumentType	Determines the value that is pasted into the Document Type field of the currently selected row when the Paste Defaults button is clicked.	A document type specification Default: eml://ecoinformatics.org/eml-2.0.0
defaultDocumentURL	Determines the value that is pasted into the Document URL field of the currently selected row when the Paste Defaults button is clicked. Typically, this value would be set to the portion of the URL that all harvested EML documents at your site share in common.	A URL, or partial URL Example: http://somehost.institution.edu/somepath/ Default: http://

defaultHarvestList=C:/temp/harvestList.xml
defaultScope=demo_document
defaultIdentifier=1
defaultRevision=1
defaultDocumentURL=http://www.lternet.edu/~dcosta/
defaultDocumentType=eml://ecoinformatics.org/eml-2.0.0

Running the Harvest List Editor

1. Open a system command window or terminal window.
2. Set the METACAT_HOME environment variable to the value of the Metacat installation directory. Some examples follow:
   • On Windows:

     set METACAT_HOME=C:\somePath\metacat

   • On Linux/Unix (bash shell):

     export METACAT_HOME=/home/somePath/metacat

3. cd to the following directory:
   • On Windows:

     cd %METACAT_HOME%\lib\harvester

   • On Linux/Unix:

     cd $METACAT_HOME/lib/harvester

4. Run the appropriate Harvester shell script, as determined by the operating system:
   • On Windows:

     runHarvestListEditor.bat

   • On Linux/Unix:

     sh runHarvestListEditor.sh

The Harvest List Editor application will start executing, automatically opening the default Harvest List for editing if the defaultHarvestList property has been appropriately configured in the .harvestListEditor file in the user's home directory.

Using the Harvest List Editor

The File Menu

• New               Opens a new (empty) Harvest List file for editing.
• Open...       Opens an existing Harvest List file for editing.
• Save             Saves the Harvest List file to disk using its current file name.
• Save As... Saves the Harvest List file to disk, prompting for a different file name.
• Validate     Validates the currently open Harvest List and issues messages about any errors that are detected.
• Exit             Exits the Harvest List Editor.

The Button Pallette

• Cut                       Cut the currently selected row from the table and save the values to the clipboard.
• Copy                     Copy the values from the currently selected row into the clipboard.
• Paste                   Paste the values from the clipboard into the currently selected row.
• Paste Defaults Paste the default values into the currently selected row. The default values are specified in the .harvestListEditor configuration file.

Editing the Harvest List

To edit the Harvest List, enter values for each of the five editable fields (all fields except the "Row #" field) for a given row in the table. Each row in the table corresponds to a single document that you wish to add to the Harvest List.

Empty rows in the table are ignored when generating the Harvest List; therefore, "holes" in the table are allowed. For example, rows #1 and #3 may contain values while row #2 may be empty. However, if any one of the editable fields in a row contains a value, then all five of the editable fields should contain values. Partially filled-in rows will cause errors that will result in an invalid Harvest List.

You can Cut, Copy, and Paste rows from one location to another by selecting a row and clicking the corresponding button. You can paste the default values into the currently selected row by clicking the Paste Defaults button. Only one row may be selected at any given time: all cut, copy, and paste operations work on only a single row rather than on a range of rows.