|
Configuring
the Access Component for WebZ (UNIX)
Contents
Introduction
Document Conventions
Requirements
Procedure
Using the Access Component with Your Patron Data
Introduction
This document
explains how to configure the Access component
for WebZ 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 MySQL or mSQL database called accessdb
from a sample data file and configure the Access component to start with
the WebZ system. This is a sample database for testing your Access component
configuration that illustrates some of the possibilities for patron authentication,
authorization, and initialization.
Document
Conventions
- <WebZ_root>
refers to the location of your installed WebZ environment.
- sql_dir
is the your SQL server's top-level directory:
- <WebZ_root>/mysql
for MySQL (beginning with SiteSearch 4.1.2)
- <WebZ_root>/msql
for mSQL (SiteSearch 4.1.1 and earlier versions
- Version 4.0.x
refers to any SiteSearch version prior to 4.1.0; that is 4.0.2, 4.0.1,
4.0.0a, and 4.0.0.
- Commands you
enter appear in quotes, such as "mysql create". Type the command
without the quotes.
Requirements
Before completing
the steps below, you must install
the Open SiteSearch WebZ Extension and WebZ. See these Web sites for
MySQL or mSQL documentation, which contains information about creating
and administering MySQL or mSQL databases:
Procedure
Follow the instructions
below to configure the Access component to work with the WebZ system and
to set up a sample database for testing the configuration.
|
1. Start
your SQL server:
- Beginning
with version 4.1.2: MySQL.
- Version
4.1.1 and earlier: mSQL.
|
|
2. Does
the <WebZ_root>/mysql/data/accessdb directory (beginning
with SiteSearch 4.1.2) or <WebZ_root>/msql/msqldb/accessdb
directory (SiteSearch 4.1.1 or earlier) exist in your WebZ directory
structure?
- Yes.
You will delete the existing accessdb database and create a database
from a sample data file for testing purposes. If you wish to retain
the data in your existing accessdb 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 accessdb 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 "accessdb" database? [Y/N]
|
- Type
"y" and press Enter.
- You
see this message:
Database "accessdb" 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 "accessdb" dropped.
|
- Version
4.0.x:
- Move
to the <WebZ_root>/msql/bin directory.
- At the
command prompt, type "msqladmin -f ../msql.conf drop
accessdb" and press Enter.
- You
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 "accessdb" database? [Y/N]
|
- Type
"y" and press Enter.
|
|
4. Stop
and restart your SQL server:
|
|
5.
Create the accessdb sample SQL database.
Database "accessdb" created.
|
This creates
the directory <WebZ_root>/msql/msqldb/accessdb.
- Version
4.0.x: At
the command prompt in
<WebZ_root>/msql/bin, type "msqladmin -f ../msql.conf
create accessdb" and press Enter. You receive this message:
Database "accessdb" created.
|
This creates
the directory <WebZ_root>/msql/msqldb/accessdb.
|
|
6. Import
the accessdb.dump sample data file into the accessdb database.
- Beginning
with version 4.1.2:
- At the
command prompt in <WebZ_root>/scripts/,
type "mysql load"
and press Enter.
- The
file <WebZ_root>/mysql/accessdb.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 load"
and press Enter.
- The file
<WebZ_root>/msql/accessdb.out
contains a record of the database load.
- Version
4.0.x:
- At the
command prompt in
<WebZ_root>/msql/bin, type "msql -f../msql.conf
accessdb < accessdb.dump" and press Enter.
- A
series of prompts rapidly appears on the screen during the
database load.
This creates six (version 4.1.1 or earlier) seven database tables
(beginning with version 4.1.2) that comprise accessdb and adds sample
data to each table.
|
|
7.
Create and then review the contents of a database "dump" from accessdb
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 dump"
and press Enter.
- This
creates a text file named <WebZ_root>/mysql/accessdb.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 dump"
and press Enter.
- This
creates a text file named <WebZ_root>/msql/accessdb.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.0.x:
- At the
command prompt in
<WebZ_root>/msql/bin, type
"msqldump
-f ../msql.conf accessdb > accessdb.newdump" and press Enter.
- This
creates a text file named <WebZ_root>/msql/bin/accessdb.newdump.
All versions:
View the text file in a text editor to see the contents of the database.
The text file should show that the accessdb database has these tables:
authos, dbs, inst, resources, userdb, userresource, and beginning
with version 4.1.2, instdbill. See accessdb
for details about the structure of each table.
|
|
8. Turn
on the user name and password authorization for the JaSSI Access
client in the Access.ini configuration
file:
|
|
9. Verify
the port for the SQL server. You
were prompted for this port during the WebZ 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.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) If your SiteSearch environment includes Record Builder,
the port must also have the same value as the URL variable in
the [JDBC] section of the AccessServer_rb.ini configuration
file. In other words, the port must have the same value in my.conf
or msql.conf, AccessServer.ini, and AccessServer_rb.ini. |
|
(3) If
you change the SQL port, stop and restart the SQL server:
|
|
|
10. Shut
down the WebZ system.
If the WebZ
system is running, stop all of the servers (JaSSI, ZBase, and OpServe).
| Note: |
You
do not need to stop the Web server or the SQL server.
|
|
|
11. Start
the WebZ system.
|
|
12. Test
the Access configuration for WebZ.
|
Return
to Contents
Using
the Access Component with Your Patron Data
After you successfully
test your Access component configuration with the sample accessdb database,
use the schema specified in the accessdb.dump data file or the accessdb
Database topic to create a new, empty copy of the accessdb database.
However, keep the accessdb.dump sample data file intact to be able to
recreate the sample accessdb database if necessary.
Then populate your
new accessdb database with patron access data relevant to your site and
retest the Access configuration. In SiteSearch 4.1.1 and earlier, there
are mSQL template files in <WebZ_root>/msql/templates
to assist you with creating an empty accessdb database and loading data
into each table. See Sample Data
for accessdb in the accessdb Database topic for ways that the sample
data illustrates possible uses of the Access component.
Return
to Contents
See Also
Operating
the WebZ System
Installing the Open SiteSearch Software
Testing the Access Component Configuration
for WebZ
Access Server Configuration Files
Access Client Configuration Files
accessdb Database
mSQL Scripts and Templates (UNIX)
The updateSQL.pl Utility
|