Changes between Version 2 and Version 3 of OAIHarvester

Timestamp:

11/04/15 09:01:58 (9 years ago)

Author:

Menzo Windhouwer

Comment:

Filled in some more sections.

OAIHarvester

@@ -65 +65 @@
 == Usage ==
 
+The deployment package contains a script to start the app, `run-harvester.sh` (for Unix systems including Mac OS X; we can add a Windows batch file if anyone wants it). The simplest usage is:
+
 {{{
-#!comment
-A short description of how the application/tool/service can be used and/or how to get started setting it up as a non-developer. It's useful to add a link to a live instance of the project, if available. If extended (end-user) documentation is available, place a link here.
+run-harvester.sh config.xml
 }}}
+
+where `config.xml` is the configuration file you wish to use. Additionally, parameters can be defined on the command line. For example:
+
+{{{
+run-harvester.sh timeout=30 config.xml
+}}}
+
+will set the connection timeout to 30 seconds. This value will override the timeout value defined in `config.xml`, if any. The first parameter that does not contain `=` is taken as the configuration file name.
+
+=== Configuration ===
+
+The behaviour of the app is determined by a single configuration file. The configuration file is composed of four sections:
+
+ * ''settings'', where options such as directory paths and timeouts are set;
+ * ''directories'', where output paths are defined;
+ * ''actions'', the most complex section, where actionSequences of actions can be defined for different metadata formats (actions include semantic transformations and saving intermediary or final results into a file); and
+ * ''providers'', where endpoints for the providers to be harvested are listed.
+
+To get a clear idea of the structure of the configuration file, see the sample configuration files.
 
 ----
@@ -77 +97 @@
 == Dependencies ==
 
-{{{
-#!comment
-What does this project depend on? Which other projects use (part of) this project?
-}}}
+This application does not itself contain an implementation of the OAI-PMH protocol; it uses the [https://code.google.com/p/oaiharvester2/ OCLC harvester2 library] for OAI-PMH requests.
 
 ----
 == Building and Deploying ==
+
+{{{
+mvn clean package assembly:assembly
+}}}
+
+The above build process creates a package named oai-harvest-manager-x.y.z.tar.gz (where x.y.z is a version number). This package can be deployed where needed.
 
 ----