|
Operating
Record Builder on UNIX
Contents
Introduction
Document Conventions
Requirements
Record Builder in a SiteSearch Environment
Starting the Record Builder Application
Starting and Stopping the Apache Server
Starting and Stopping the MySQL Server (beginning with
SiteSearch 4.1.2)
Starting and Stopping the mSQL Server (SiteSearch 4.1.1
and earlier)
Using the ssadmin Interface
Shutting Down the Record Builder Application
Starting and Stopping Individual Record Builder Components
Introduction
This topic provides
procedures for operating OCLC Database Builder's Record Builder application
on UNIX platforms (AiX, DIGITAL UNIX, IRIX, Solaris, HP-UX (versions 4.1.1
and earlier), or Linux (beginning with version 4.1.2).
| Note: |
If
you are using the Netscape Web server, refer to Netscape documentation
for instructions regarding server administration. |
Document
Conventions
- <WebZ_root>
is the location of the environment that contains the Record Builder
application.
- Commands you
type appear in quotes, like this: "poll".
- 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)
- 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)
Requirements
Before
starting these procedures, complete the following tasks:
Because Record
Builder is an application included with Open SiteSearch Database
Builder, it is installed concurrently with Database
Builder.
Record
Builder in a SiteSearch Environment
In a SiteSearch environment
that includes Record Builder, a single OpServe manages both WebZ and Record
Builder. Record Builder has its own Web server port and Web server extension,
JaSSI, ZBase, and Access servers (JaSSIRB, ZBaseRB, and AccessServerRB,
respectively), and a Lock server. This is the usual configuration, although
it is possible to set up a Record Builder-only environment.
The procedures in
this document assume that you are using a SiteSearch environment with
both WebZ and Record Builder.
Return
to Contents
Starting
the Record Builder Application
Follow these steps
to start Record Builder (and WebZ, if desired):
|
1. Verify
that that the Web server for Record Builder is running. If
you are using the Apache server included with the Database
Builder installation, see Starting and Stopping
the Apache Server. Otherwise,
see your Web server's documentation.
|
| 2. Shut
down WebZ if it is currently running. |
|
3. Do you want
to restart WebZ when you start Record Builder?
- Yes.
Verify
that the Web server for WebZ is running. If you are using the
Apache server that was included with the WebZ installation, refer
to Starting and Stopping
the Apache Server (for WebZ). Otherwise, see your Web server's
documentation.
- No.
Go directly to step 4.
|
|
4. Are
you using the Access component
to provide staff authentication and and authorization for Record
Builder (and WebZ, if applicable)?
- Yes.
Assuming that you configured
the Access component for Record Builder, start
the SQL server:
| Note: |
WebZ
and Record Builder share the same SQL server, but use separate
databases for storing authentication and authorization data.
You must configure the Access component separately for WebZ
and Record Builder.
|
- No.
Go directly to step 5.
|
|
5. Start
the ssadmin utility. In the <WebZ_root>/scripts
directory, type "ssadmin_rb" and press Enter. This
starts the JaSSIRB, ZBaseRB, Lock, and AccessRB servers for Record
Builder and the JaSSI, ZBase, and Access servers for WebZ.
| Note: |
The
ssadmin_rb command starts the ssadmin utility, which starts
the OpServe if it is not already running. OpServe then starts
the Record Builder and WebZ servers listed in the OpServe_rb.ini
configuration file. |
|
| 6. After displaying
a series of messages, the ssadmin interface
opens and you see the SSAdmin Cmd> prompt. |
7. Use the
ssadmin poll command to
verify that the JaSSIRB, ZBaseRB, AccessRB, and Lock servers for Record
Builder and the OpServe, JaSSI, ZBase, and Access servers for WebZ
have started.
| Note: |
If
you did not start the SQL server software or configure the
Access component for Record Builder, the AccessRB server shuts
down immediately after starting up.
|
|
Return
to Contents
Using
the ssadmin Interface
The ssadmin utility
has an interface to the Operations server, OpServe, for both WebZ and
the Record Builder application. This interface allows you to monitor system
status and issue commands directly to the system components.
While you are
working in ssadmin, the command prompt changes to "SSAdmin Cmd>".
Some commonly-used ssadmin commands are:
- poll,
which lists the servers that are currently running
- help,
which lists and briefly describes all ssadmin commands
- quit,
which closes the ssadmin interface without shutting down any servers
- term,
which shuts down all currently-running servers
For detailed information
about all ssadmin commands, refer to the ssadmin
Command Reference.
Return
to Contents
Starting
and Stopping the Apache Server
Issue the following
commands to start and stop the Apache Web server included with your Database
Builder installation:
Starting Apache
- In the <WebZ_root>/scripts
directory, type "apache_rb start" and press Enter. This starts the Apache
server for Record Builder.
Stopping Apache
- In the <WebZ_root>/scripts
directory, type "apache_rb stop" and press Enter. This command stops
the Apache server for Record
Builder.
Starting
and Stopping the MySQL Server (beginning with SiteSearch 4.1.2)
follow the instructions
below to start and stop the MySQL
AB's MySQL server to allow you to use the SiteSearch Access
component with Record Builder. If you do not use the Access component
for authentication and authorization for Record Builder staff, you do
not need to start the mSQL server.
Starting
the MySQL Server
- In the <WebZ_root>/scripts
directory, type "mysql start" and press Enter.
| Note: |
You must
issue this command before you start the Record Builder application
for the Access component to function correctly. If the Record Builder
application and WebZ are already running, use the term
command to stop the system in ssadmin, start
the MySQL server, and then restart Record Builder.
|
Stopping
the MySQL Server
- In the <WebZ_root>/scripts
directory, type "mysql stop" and press Enter.
| Note: |
If you
stop the MySQL server without stopping the Access component or the
Record Builder application, the Access component cannot authenticate
staff members before they start a session; they will have search,
write, delete, view, and admin privileges for all local databases
populated and maintained with Record Builder.
|
Return
to Contents
Starting
and Stopping the mSQL Server (SiteSearch 4.1.1 and earlier)
Follow the instructions
below to start and stop the Hughes
Technologies Pty. Ltd.'s Mini Structured Query Language (mSQL) server
to allow you to use the Site Search Access component. If you do not use
the Access component for authentication and authorization for Record Builder
staff, you do not need to start the mSQL server.
Starting
the mSQL Server
- In the <WebZ_root>/scripts
directory, type "msql start" and press Enter.
| Note: |
You must
issue this command before you start the Record Builder application
for the Access component to function correctly. If the Record Builder
application and WebZ are already running, use the term
command to stop the system in ssadmin, start
the mSQL server, and then restart Record Builder.
|
Stopping
the mSQL Server
- In the <WebZ_root>/scripts
directory, type "msql stop" and press Enter.
| Note: |
If you
stop the mSQL server without stopping the Access component or the
Record Builder application, the Access component cannot authenticate
staff members before they start a session; they will have search,
write, delete, view, and admin privileges for all local databases
populated and maintained with Record Builder.
|
Return
to Contents
Shutting
Down the Record Builder Application
Perform the following
procedure to shut down the Record Builder application (and WebZ as well
if it is currently running):
|
1. Start
the ssadmin utility.
From the <WebZ_root>/scripts directory, type "ssadmin_rb"
and press Enter.
| Note: |
Because
OpServe is already running, no servers start up this time when
you issue the ssadmin_rb command. |
|
| 2. After displaying
a series of messages, the ssadmin interface
opens and you see the SSAdmin Cmd> prompt. |
|
3. To shut
down all of the Record Builder servers (JaSSIRB, ZBaseRB, AccessRB,
and Lock) and all WebZ servers, type "term" and press Enter from
the "SSAdmin Cmd>" command prompt. The
OpServe terminates each of the Record Builder and WebZ servers and
returns you to the system command prompt.
Refer to
Starting and Stopping Individual Record Builder
Components for instructions about stopping a single Record Builder
or WebZ component. It is also possible to shut down the Record Builder
application without shutting down WebZ or vice versa.
|
Return
to Contents
Starting
and Stopping Individual Record Builder Components
Use the ssadmin
start and stop
commands to start or stop individual Record
Builder components (JaSSIRB, ZBaseRB, and AccessRB). For
example, you can stop all Record Builder servers individually and leave
the WebZ servers running or just shut down a specific server(s).
Return
to Contents
See Also
Operating
the WebZ System on UNIX
mSQL Scripts and Templates
|