Overview

The Harvester tools all have a shared set of arguments and layout, both as a library and as command-line tools.

Command-Line

All the command-line tools share these arguments

Short Option

Long Option

Parameter Value Map

Description

Required

w

wordiness

LOG_LEVEL

Set the console log level

false

h

help

 

Help Message

false

X

config

CONFIG_FILE

XML Configuration File

false

When the h/-help argument is provided to any of the harvester tools, it will print a usage statement listing all the arguments it takes and a brief description (much like the above table).

The w/-wordiness argument will override settings for logging and print messages above and including the specified log level (all, trace, debug, info, warn, error, off)

Config File

The X/-config argument

Library

  • getParser()
  • execute()
  • static methods

Example Tools

The harvester is a collection of tools. Each of the following pages has detailed information about how to use that tool, what parameters it takes, and what methods it exposes. Please refer to these pages for more information on how to use each of the tools for the VIVO Harvester.