|
Creating a New SiteSearch Database
The Open SiteSearch Database Builder software is used to create local databases that library patrons may access through the Out-of-the-Box (OBI) interface or through another Z39.50 client interface. Creating a new database is a multi-step process that requires careful planning and analysis. The following information describes the tasks you need to complete to create a SiteSearch database.
Requirements
Before creating a SiteSearch database, you should have the following:
- Open SiteSearch Database Builder software or the entire Open SiteSearch Suite.
- Existing source data in electronic form either in ASN.1/BER format or in a format that can be converted into ASN.1/BER format.
- A test environment to build and review your database in before moving the database to a production environment for users to access and search. When you install your Open SiteSearch software, you should install two separate environments with identical directory structures that will serve as your test and production environments.
Procedure
The following steps describe how to create a local database from existing source data:
|
1. Plan the database.
This step provides guidance in creating a schema to use as a planning map as you begin to create the foundation of the database. You will analyze your source data and users and define your indexes in preparation for creating a database description (.dsc) file.
Result: A list of fields and indexes for the database
|
|
2. Create a directory for the database called dbname in the <SystemRoot>/dbbuilder/dbs directory of the test environment, where dbname is the database name. Copy the source data for the database into the new directory. Use this directory to store the related database information that will be created in steps 3 through 6.
Result: A directory in the test environment to house your database
|
|
3. Convert your source data to ASN.1/BER format.
You will need to convert the existing source data into ASN.1/BER format before the database can be built using the Database Builder software. The software installation comes with two conversion utility programs. Follow the conversion steps listed below based on the type of source data you have for the database.
If you do not have MARC or SGML source data, you will need to develop a conversion program for your specific type of source data. If you need assistance developing a compatible conversion program, contact the SiteSearch Custom Services area at (800) 848-5878, extension 6039.
Result: ASN.1/BER formatted data for the database
|
|
4. Test the ASN.1/BER data with the ber2txt utility program.
Use the ber2txt utility program from the Unix command prompt to view the ASN.1/BER formatted data to ensure that the conversion in step 3 was successful.
Result: A successful review of the ASN.1/BER formatted data
|
|
5. Create a database description (.dsc) file.
You will need to create the database dbname.dsc file in the <SystemRoot>/dbbuilder/dbs/dbname directory, where dbname is the database name. The .dsc file is a text file that defines how the Database Builder software constructs your database. Attributes defined in the .dsc file include:
- database size
- specific indexes to generate
- index characteristics and associated routines
- stopwords
- restrictor definitions
Result: A dbname.dsc file which will be used by the database build utility programs to build the database from the ASN.1/BER source data
|
|
6. Build a test database.
In this step, the database utility programs use the ASN.1/BER data and the .dsc file to build a database in the test environment. You will register the database in the SiteSearch Database Operations Tool (SSDOT), and then use SSDOT as an interface to the database utility programs to initialize, update, and validate the database. Finally, you will test the database within the zclient utility program to ensure that the database was built properly.
Result: A searchable local database in the test environment created from the .dsc file and ASN.1/BER formatted data and tested using the zclient utility program
|
|
7. Repeat steps 1 through 6 if the test database you created is not accessible or searchable using the testing tool, zclient, in step 6.
|
|
8. Move the test database and configuration files into production.
- Create a dbname directory, where dbname is the name of your database, in the <SystemRoot>/dbbuilder/dbs/ directory of the production environment.
- Copy the five physical database files (HEDR, HDIR, POST, PDIR, and INDX) into this dbname directory.
- Edit the locations of the physical database files in the [database] section of this database configuration file using a text editor to reflect the files new locations in the production environment.
- Copy the database configuration file into the <SystemRoot>/ini/dbs directory in the production environment.
- Add the database to the list of databases included in the databases.ini file located in the <SystemRoot>/ini/ directory of the production environment.
- If the local server configuration file is not already in the production environment, copy the file into the <SystemRoot>/ini/servers/ directory.
Refer to Configuring Access to Databases and Servers for additional information about moving the database into production and adding the database to the OBI Topic Area(s).
Result: A searchable database that can be accessed by library patrons in the production environment using the OBI interface
|
See Also
Updating an Existing SiteSearch Database
Maintaining the Integrity of a SiteSearch Database
Configuring Access to Databases and Servers
|