<< System Management     Home    

Appendices




Appendix A:  Files and Their Locations
Appendix B:  Default Server Configuration
Appendix C:  Default Client Configuration
Appendix D:  Support and contact




Appendix A:   Files and Their Locations.

The MicroLCS directory structure is organized as follows. Directories are indicated by a '/' suffix:

client/              Client program files.
   client.jar        The Java executable for the client.
   etc/              Client configuration files.
      client.cfg     The client configuration.
      logo.jpg       Main screen logo.
   setup             Client setup script for Unix.
   setup.bat         Client setup batch file for Windows.
   start             Unix client start script.
   start.bat         Windows client batch file.
data/                Where MicroLCS stores databases and user data.
   archive/          Archive files from OPAC backups.
   system/           Main database for the OPAC.
etc/                 Server configuration files.
   system.cfg        The server configuration.
   system.bak        Backup server configuration.
lib/                 Contains server java executables.
LICENSE.txt          License agreement.
logs/                Server log files are stored here.
manual/              User's Guide files.
microlcs             Server startup script for Unix.
microlcs.bat         Server startup batch file for Windows.
README.txt           The README file.
setup                Server setup script for Unix.
setup.bat            Server setup batch file for Windows.










Appendix B:    Default Server Configuration


// ---------------------------------------------------------------
// MicroLCS Server Configuration File
//
// This file is read by the MicroLCS server on startup.  The
// parameters can all be set and modified by the user.  HOWEVER
// you should understand exactly what these parameters are and how
// the work before proceeding to make changes to the configuration
// of an existing system.  Damage to the system may result.  The
// graphical setup program is a safe way to make changes to an
// existing MicroLCS system.
//
// Copyright (C) 2006 Peter Schlumpf
// Avanti Library Systems
// ---------------------------------------------------------------

//
// PORT:  This is the TCP port on which the server listens for
// client requests.  Default is 3925.
//
PORT 3925

//
// DBNAME:  The name of the library database system.
//
DBNAME system

//
// MAXFBR:  The maximum size of the FBR database.
//
MAXFBR 16000

//
// MAXITEMS:  The maximum size of the Item database.
//
MAXITEMS 32000

//
// MAXLOCATIONS:  The maximum size of the Location database.
//
MAXLOCATIONS 5000

//
// ARMS:  This sets the maximum limits of the ARMS parameters.  The
// first parameter is the number of tokens.  The second parameter is
// the number of link records.  The ARMS (Abstract Relationship
// Modeling System) is a data structure that maps arbitrary relationships
// between objects.  In MicroLCS it is used to define the relationship
// between title records and item records.
//
ARMS 78000 210000  // The number of tokens and links in the ARMS database.

//
// FBR Record format.
//
DEFINE fbr 19  // 19 is the number of fields.
   FIELD fbr "armsID" 4 int  // DO NOT CHANGE!  armsID is always field 0
   FIELD fbr "Title" 128 text
   FIELD fbr "Author" 80 text
   FIELD fbr "Additional_Authors" 80 text
   FIELD fbr "Call Number" 40 text
   FIELD fbr "Bib Number" 8 text
   FIELD fbr "Publisher" 80 text
   FIELD fbr "Pub Date" 16 text
   FIELD fbr "ISBN" 16 text
   FIELD fbr "ISSN" 16 text
   FIELD fbr "Subject" 255 text
   FIELD fbr "Series" 64 text
   FIELD fbr "Description" 128 text
   FIELD fbr "Edition" 32 text
   FIELD fbr "Notes" 255 text
   FIELD fbr "Contents" 128 text
   FIELD fbr "Format" 32 text
   FIELD fbr "Language" 16 text
   FIELD fbr "URL" 80 text

//
// Item record format.
//
DEFINE item 6
   FIELD item "armsID" 4 int   // DO NOT CHANGE!
   FIELD item "Call Number" 32 text
   FIELD item "Barcode" 16 text
   FIELD item "Copy" 6 text
   FIELD item "Volume" 6 text
   FIELD item "Location" 32 text

//
// Location record format.
//
DEFINE location 2
   FIELD location "armsID" 4 int  // DO NOT CHANGE!
   FIELD location "Name" 40 text


echo "MicroLCS is building and loading indexes."
echo "This may take several minutes."

//
// Set the stopword list.  These are words that are ignored in searches.
//
STOPWORDS "the a and an if of to"

//
// Reset and start MicroLCS.
//
RESET

//
// Create searchable indexes.
//
INDEX fbr "Author"
INDEX fbr "Title"
INDEX fbr "Subject"
INDEX fbr "Call Number"
INDEX fbr "ISBN"










Appendix C:   Default Client Configuration


// ***********************************************************
//  Avanti MicroLCS version 1.0
//
//  8 March 2006
//
// This is the configuration file for the standalone
// graphical client.
// **********************************************************

//
// This is the network address of the server.  Set it to the
// IP address or network name of the machine running the Avanti
// MicroLCS server.
//
serveraddress 127.0.0.1

//
// The default port for Avanti client-server network
// communication is 3925.
//
port 3925

//
// The privleges the client has.  Current possibilites
// are:  "search" and "cataloging."  In cataloging mode the client
// is able to add, modify and delete title and holdings records.
// In search mode the client can only search the opac.
//
// For a search only client set the userType to: search
// for a cataloging client set the userType to: cataloging
//
//
usertype search

//
// This string is the list of searchable fields in the
// titles database  This is what appears in the drop down
// field selector.  The order that they appear here is
// the order they appear in the drop down list.
//
// CAVEAT:  searchable fields MUST be indexed fields on
// the server.
//
searchfields "subject title author"

//
// The password for password protected shutdown.  This can
// be useful if the client is running in a public place and
// you don't want users to exit the application.  The password
// can be set to any string with no whitespaces.  The
// default is set to 'none' which disables the
// password protected shutdown feature.
//
// If the password feature is enabled, the user must type the
// password in the search text area and click on QUIT in order
// to terminate the client.
//
// default:  none
//
password none

//
// Mantissa
//
// This specifies the fields that are displayed in the brief
// listing of search results.  Any field in the titles database,
// whether indexed or not, can be used.  Specify these fields in
// a string, all elements separated by spaces, first the field
// label followed by the number of characters displayable for
// that field.  This parameter is called "mantissa" for lack of
// a better name.
//
mantissa "title 30 author 25"

//
// The screen width of the client in pixels.
// 
width 800

//
// The screen height of the client in pixels.
//
height 600

//
// The inactivity timeout metric in seconds.
//
timeout 300

//
// The location of the logo for the startup screen.
// Defaults to the Avanti logo.  This can be changed
// to display a different image if desired.
//
image logo.jpg

// **************************************************************
// User Interface Colors
//
// The following color parameters set the colors of elements in
// the user interface.  the default colors were carefully chosen
// for usability as well as general aesthetics.  These can be
// configured here by the user.  However, keep in mind that some 
// color combinations work much, much better or worse than others
// and can really affect the overall usability of the system.
//
// **************************************************************

//
// Sets background color.  The default background is a
// very subtle cream color.  This was chosen because it
// reduces glare and is much easier on the eyes. It also
// provides a certain rich warmth that is much less harsh
// than all white.
//
bgcolor		255 255 241

//
// The background color for edit screens.  Normally
// the default is the same as the regular background
// color.  It provides a subtle contrast from text
// fields and test areas.
//
editbgcolor		255 255 241

//
// Sets dark background color.  This is used in "dark"
// elements such as the control panel.  It differentiates
// such persistent elements from the work area.  The default 
// color is a much darker shade of the background color.
//
darkcolor		210 210 170

//
// This sets the color of "lighter" elements in the interface.
// These are things like alternating colors in lists, and to
// provide background to tools that appear in the non-persistent
// work area.  the default color is a couple shades darker than
// the bacground color.  Anything darker would be distracting.
//
lightcolor		245 245 215

//
// This sets the color of field labels in records.  A shade of
// grey is chosen as the default.  A fairly subdued but
// eminently readable shade of grey was chosen in order to
// emphasize the data from the labels.  Dark bold labels can
// be distracting.
//
labelcolor		128 128 128









Appendix D:   Support and Contact

For more information go to www.avantilibrarysystems.com



<< System Management     Home