Introduction

Below are the commonly required or used paths, objects and settings for the configuration files.

Paths

• defaultPath
  A default path to be prepended to all other paths in the object and below
• metadataPath
  Used to point to a database file or directory for metadata concerning the object
• databasePath
  Used in store objects to point to a database file or directory
• tempPath
  For when temporary file(s) are required.
• schemaPath
  Used in Parsers to point to a validation document (eg xsd, dtd, rng)
• xsltPath
  Used in XsltTransformers to point to the XSLT document to use.
• sortPath
  Used in IndexStores to refer to the local 'sort' utility

Objects

• object type
  Common required objects are recordStore on database, functionLogger anywhere,
• onIndexRecord
  A transformer to call when a record is being indexed. For example to extract cluster information.
• inTransformer
  A transformer to use before storing a record in a recordStore, eg to turn it into a storable string
• outParser
  A parser to turn the data extracted from the store back into the record.
• idNormaliser
  A normaliser to turn record ids into a form suitable for using as keys in the database

Settings

• log
  This contains a space separated list of function names to log on invocation. The functionLogger object referenced in paths will be used to do this.
• digest
  Used in recordStores to name a digest algorithm to determine if a record is already present in the store. Currently supported are 'sha' and 'md5'.