The OAIB Configuration Wizard February 8, 2005 OAIB provides an easy-to-use configuration wizard allowing the user to set a number of important OAIB parameters and write templates for transforming SQL results into metadata records. Joel Plutchak OAIB provides an easy-to-use configuration wizard allowing the user to set a number of important OAIB parameters and write templates for transforming SQL results into metadata records.

Configuration Wizard Reference

The configuration wizard consists of a set of tabs, each of which reveals a panel with various configuration options. This document describes what the tabs and their options mean.

Connection

The Connection tab allows you to specify options needed in order to connect to your SQL database.

Option Definition Required? Default Value
driver The class name for the JDBC driver of the database. yes none
url The URL for connection to the JDBC database. yes none
user The username for accessing the JDBC database. no none
password The password for accessing the JDBC database. no none

Server

The Server tab allows you to specify parameters that affect how the OAI server responds to client requests.

Option Definition Required? Default Value
max-clients The maximum number of clients allowed to connect to the server at any one time. no unlimited
chunk-size The number of records to return for individual ListIdentifiers and ListRecords requests. If more records exist in the database the OAI flow control mechanism is used. no 100

Identity

The Identity tab allows you to specify parameters that describe the OAI server.

.
Option Definition Required? Default Value
repositoryName The name of the OAI repository, returned in the Identify request. yes none
deletedRecords The way deleted records are handled in the repository. yes none
granularity The granularity of the timestamp on OAI records in the repository. yes none
earliestDatestamp The earliest timestamp on OAI records in the repository.yes none
adminEmail The name of the OAI service administrator, returned in the Identify request. yes none
compression A compression scheme that is supported by the repository. It is recommended that these are from the set defined for HTML content encoding (RFC 2616 Section 14.11). no none
description A description of this repository. It is required that these are described by an XSD schema. no none

Database

The Database tab allows you to specify information that is needed to form queries to the SQL database in order to locate records by identifier or date range, and to collect information to be used in constructing metadata records.

Option Definition Required? Default Value
id-column The database column and table used as the OAI unique identifier. yes none
date-column The database column and table used as the OAI "date modified" field. yes none
set-column The database column and table used to determine set membership for each record. no none
deleted-column The database column and table used to determine whether a record has been marked as deleted. no none
id-query The SQL query used to generate a list of OAI identifiers. if specified, the id-query must contain any columns used for the id and date fields, and if sets or deleted records are supported, must contain the columns used to specify those fields. no none
record-query The SQL query used to retrieve data records. The 'select' clause must contain any columns used in the "Dublin Core" pane and any user-specified metadata format templates. yes none

Dublin Core

The Dublin Core tab allows entry of template segments that allow Dublin Core metadata elements to be constructed from the results of the record query. There is a field for each Dublin Core element. The meanings of Dublin Core elements are defined in the Dublin Core element set. Dublin Core elements are all optional and have no default values.

Template segments are text strings which may optionally contain column elements. These elements have a single attribute, name, which indicates which database column's value to insert into the metadata template when constructing a metadata record. For instance, the template

Mr. <column name="last_name"/>
Will produce the string "Mr. " followed by the contents of the last_name column of the database for the record being retrieved. Any number of column elements may be used anywhere in a template segment.

Option Definition
title A name given to the resource.
creator An entity primarily responsible for making the content of the resource.
subject The topic of the content of the resource.
description An account of the content of the resource.
publisher An entity responsible for making the resource available
contributor An entity responsible for making contributions to the content of the resource.
date A date associated with an event in the life cycle of the resource.
type The nature or genre of the content of the resource.
format The physical or digital manifestation of the resource.
identifier An unambiguous reference to the resource within a given context.
source A Reference to a resource from which the present resource is derived.
relation A reference to a related resource.
coverage The extent or scope of the content of the resource.
rights Information about rights held in and over the resource.

User-specified Formats

You can add additional tabs to the configuration wizard in order to include templates for other metadata formats besides Dublin Core. There are several required options for each such tab:

Option Definition
Metadata prefix The metadata prefix identifying this metadata format.
Namespace Location The URL of the namespace in which this metadata format is defined.
Schema Location The URL for the XML Schema Definition file defining this metadata format.
Record An XML element containing tags and templates used to form the metadata record from database field contents. This may contain arbitrary XML, into which you may insert record elements that will be filled in with data from database columns as in Dublin Core.