The MicroLCS server is managed through the server console, an easy to use command line interface. Here is an overview of server commands and what they do:

Backs up all data and configuration to an archive file. This s used for data recovery as well as creating a portable archive Archive files can be used to port a library to another MicroLCS system. Archive files are stored in the microlcs/data/archive/ directory. Archive files may be copied to another location or media. You may specify any file name though it is recommended that you use the .arc file extension. To list all files in the archive directory type

   backup ?

at the server command prompt. Files in this directory can be copied or moved to another machine or copies to tape for futher safekeeping. It is recommended that you run the backup command to create archives periodically to guard against data loss.

NOTE: The backup command will only work when the system is down (offline.)

Exports the title database as a delimited text file.

help

This command lists available server commands and their syntax. This can also be invoked by typing ? at the server command prompt.

Imports a delimited text file into the titles database.

init

Initializes the system and clears all databases. Returns MicroLCS to its default state.

WARNING: The init command wipes out all data in MicroLCS databases!

Restores catalog databases and configuration from the specified archive file created by the backup command. Archive files are found in microlcs/data/archive/.

To list all files in the archive directory type

   restore ?

at the server command prompt.

NOTE: The restore command will work only when the system is down (offline.)

WARNING: Any data or settings in MicroLCS is cleared and replaced by the contents of the archive file!

Brings MicroLCS databases online. The reindex option forces a reindexing of all indexed fields.

Shows the current status of the MicroLCS server.

Prints version information for MicroLCS server.

To start MicroLCS and bring the database online type 'start' at the console command line. The 'reindex' option forces a reindexing of all indexed fields. Normally when you bring the system online indexes are loaded into memory from disk which greatly speeds up the start process. However if you add and delete records these changes will not be reflected in the stored indexes until thet are reindexed. Reindexing may take many minutes if you have a large number of indexes fields. You should use the reindex option if you have made a large number of changes to the catalog.

Starting the server can be done directly from the operating system. For example:

    microlcs start

   microlcs start reindex

The reindex option to the start command rebuilds the title record indexes. New records that have been added to the system will not be searchable until a reindexing has been done.

Backing Up the Database to an Archive

Running periodic backups on the server to guard against data loss is essential in any server based system. You could do this by backing up the entire microlcs directory using a backup and restore utility. MicroLCS also has its own backup and restore archiving system that backs up the catalog and configuration to an archive file. Archive files contain only your data and system configuration. They do not contain the MicroLCS program itself. You can copy archive files to a safe location on you computer or network or copy them to a tape or disk. archive files can also be used to export the entire library system to another computer with an install of MicroLCS.

Backups to archive files are done using the 'backup' command on the MicroLCS server. To back up the system to an archive file called 'backup.arc', type

 
   backup backup.arc

in the server console. The system will immediately begin creating the archive file. This may take several minutes if your system is large. When the sonsole comand prompt returns the backup is complete.

Archive files are always stored in the microlcs/data/archive/ directory. To get a listing archive files from the server console type

 
   backup ?

at the server command prompt.

Restoring data and configuration from an archive file is done using the 'restore' command. To restore the system from an archive file called backup.arc first make sure that the system hasn't been started up. Then type

 
   restore backup.arc

at the server command prompt. The system will then load all data and configuration from the archive file. This may take several minutes. When the operation is complete the system command prompt will appear. You are now ready to start your restored system.

NOTE: Backups and restores must be done while the system is offline. If the system has already started, exit the server by typing 'quit' and then restart the server.


Customizing the Server

Customizing server options should be done through the setup program. The setup program allows you set the network name and port that MicroLCS is running on, the stopword list and which fields are indexed and searchable.

Another way to customize the server is to edit the configuration directly using a text editor. The server configuration is stored in the text file microlcs/etc/system.cfg. There are many parameters that are set in this file not accessible through the setup program. Parameters such as database definitions, record formats, field definitions, etc. All attributes of databases and fields are found in the configuration file. This makes MicroLCS very customizable. None of the fields in MicroLCS are hard-coded in the system. You could define record formats for Titles and Items that are completely different from those defined in the default configuration. The only absolute limit is 255 fields per record. What these fields are doesn't matter.

CAVEAT:   Editing the configuration directly in a production system is not recommended. You could inadvertently make a change that could result in data loss. Record and field formats are static. Once the record formats have been defined and data is entered it is difficult in version 1.0 to add, delete, rename fields or change their sizes. This capability is currently under development and will be included in a future release.


Home     << Catalog Maintenance     Appendices >>