Main -> Documentation -> OCLC SiteSearch Record Builder -> Record Builder Administration -> Configuring the Access Component for Record Builder (UNIX)

Configuring the Access Component for Record Builder (UNIX)

 

Contents

Introduction
Requirements
Document Conventions
Procedure
Using the Access Component with Your User Data

Introduction

This document explains how to configure the Access component for Record Builder in UNIX operating systems, using MySQL AB's MySQL software (beginning with SiteSearch 4.1.2) or Hughes Technologies Pty. Ltd.'s Mini Structured Query Language (mSQL) software (SiteSearch 4.1.1 and erarlier versions.). The instructions below describe how to create a SQL database called rbdb from a sample data file and configure the Access component to start when Record Builder starts up.

Requirements

Before completing the steps below, you must install version 4.1.x of the Open SiteSearch WebZ Extension, WebZ, and Database Builder. See these Web sites for MySQL or mSQL documentation, which contains information about creating and administering MySQL or mSQL databases:

MySQL   

http://www.mysql.com/documentation/
mSQL http://www.hughes.com.au/

Document Conventions

  • <WebZ_root> refers to the location of your installed WebZ environment that includes Record Builder.
  • SQL server is the database server used in the Access component:
    • MySQL (beginning with SiteSearch 4.1.2)
    • mSQL (SiteSearch 4.1.1 and earlier versions)
  • Items you type appear in quotes, like this "mysql_rb drop". Type them without the quotes.
  • In some commands that contain "msql_rb" or "mysql_rb", a link may obscure the "_" (underscore) in this document.

Procedure

Follow the instructions below to configure the Access component to work with Record Builder and to set up a sample database for testing the configuration.

1. Start your SQL server:

2. Does the <WebZ_root>/mysql/data/rbdb directory (beginning with SiteSearch 4.1.2) or <WebZ_root>/msql/msqldb/accessdb directory (SiteSearch 4.1.0/4.1.1) exist in your WebZ directory structure?

  • Yes. You will delete the existing rbdb database and create a database from a sample data file for testing purposes. If you wish to retain any data in your existing rbdb database before continuing, dump its contents to a text file, as described in step 7. Then go to step 3.
  • No. Go to step 5.

3. Drop the rbdb database.

  • Beginning with version 4.1.2:
    • Move to the <WebZ_root>/scripts directory.
    • At the command prompt, type "mysql drop" and press Enter.
    • You see this message:

    • Dropping the database is potentially a very bad thing to do.
Any data stored in the database will be destroyed.

Do you really want to drop the "rbdb" database?  [Y/N]
    • Type "y" and press Enter.
    • You see this message:

    Database "rbdb" dropped.
  • Version 4.1.0/4.1.1:
    • Move to the <WebZ_root>/scripts directory.
    • At the command prompt, type "msql drop" and press Enter.
    • You see this message:

       
      Database "rbdb" dropped.

4. Stop and restart your SQL server:

5. Create the rbdb sample SQL database.

  • Beginning with version 4.1.2: At the command prompt in <WebZ_root>/scripts, type "mysql_rb create". You receive this message:

    <WebZ_root>/mysql/bin/mysqladmin
    --defaults-file=<WebZ_root>/mysql/data/my.cnf
    create rbdb

    This creates the directory <WebZ_root>/mysql/data/rbdb.

  • Version 4.1.0/4.1.1: At the command prompt in <WebZ_root>/scripts, type "msql_rb create". You receive this message: 
Database "rbdb" created.

This creates the directory <WebZ_root>/msql/msqldb/rbdb.

6. Import the rbdb.dump sample data file into the rbdb database.

  • Beginning with version 4.1.2:
    • At the command prompt in <WebZ_root>/scripts, type "mysql_rb load" and press Enter.
    • The file <WebZ_root>/mysql/rbdb.out contains the time the database load started and ended.
  • Version 4.1.0/4.1.1:
    • At the command prompt in <WebZ_root>/scripts, type "msql_rb load" and press Enter.
    • The file <WebZ_root>/msql/rbdb.out contains a record of the database load.

This creates the ten database tables that comprise rbdb and adds sample data to each table.

7. Create and then review the contents of a database "dump" from rbdb to ensure that the sample data was imported correctly.

  • Beginning with version 4.1.2:
    • At the command prompt in <WebZ_root>/scripts/, type "mysql_rb dump" and press Enter.
    • This creates a text file named <WebZ_root>/mysql/rbdb.dump.Dyyyymmdd.Thhmmss, where yyyymmdd is the current year, month, and day, and hhmmss is the current time in hours (on a 24-hour clock), minutes, and seconds.
  • Version 4.1.0/4.1.1:
    • At the command prompt in <WebZ_root>/scripts/, type "msql_rb dump" and press Enter.
    • This creates a text file named <WebZ_root>/msql/rbdb.dump.Dyyyymmdd.Thhmmss, where yyyymmdd is the current year, month, and day, and hhmmss is the current time in hours (on a 24-hour clock), minutes, and seconds.

All versions: View the text file in a text editor to see the contents of the database. The text file should show that the rbdb database has the following tables: authos, access, dbs, default_groups, groups, members, objects, pup, resources, and userresource. See rbdb Database for details about the structure of each table.

8. Turn on the user name and password authorization for the JaSSIRB Access client in the Access_rb.ini configuration file:

9. Verify the port for the SQL server. You were prompted for this port during the Database Builder installation. If you would like to change the SQL server port or view the current value of the port, edit/view the SQL server's configuration file and the AccessServer_rb.ini configuration file.

The port is defined in the SQL server's .conf file, as follows:

  • Beginning with version 4.1.2: In the port variable in the [mysqld] section of the <WebZ_root>/mysql/data/my.cnf file.
  • Version 4.1.1 and earlier: In the TCP_Port variable in the [general] section of the <WebZ_root>/msql/msql.conf file.

It is also defined in the URL variable in the [JDBC] section of the AccessServer.ini file located in the <WebZ_root>/ini directory.

Important
Notes: 		(1) The port values contained in these two variables MUST be identical for the Access component to run successfully through the SQL server.
(2) The port must also have the same value as the URL variable in the [JDBC] section in AccessServer.ini, the access server configuration file for WebZ. In other words, the port must have the same value in my.cnf or msql.conf, AccessServer_rb.ini and AccessServer.ini.
(3) If you change the SQL port, stop and restart the SQL server:

10. Shut down both Record Builder and WebZ.

If Record Builder or WebZ is running, stop all of the servers (JaSSIRB, ZBaseRB, JaSSI, ZBase, and OpServe).

Note:

You do not need to stop the Web server(s) or the SQL server.
11. Start Record Builder and WebZ.
12. Test the Access configuration for Record Builder.

Return to Contents

Using the Access Component with Your User Data

After you successfully test your Access component configuration with the sample rbdb database, use the schema specified in the rbdb.dump data file or the rbdb Database topic to create a new instance of the rbdb database. However, keep the rbdb.dump sample data file intact to be able to recreate the sample rbdb database if necessary.

Then populate your new rbdb database with user access data for your Record Builder users and retest the Access configuration. See Sample Data for rbdb in the rbdb Database topic for ways that the sample data illustrates possible uses of the Access component with Record Builder.

Return to Contents

See Also

Access Component Overview
Access Client Configuration Files
Access Server Configuration Files
rbdb Database
SQL Scripts and Templates
Operating Record Builder

[Main][Documentation][Support][Technical Reference][Community][Glossary][Search]

Last Modified: