2
Administration Tools

This chapter introduces and describes the administration tools provided by the ConText Workbench.

The following topics are covered in this chapter:

System Administration Tool
Configuration Manager

See Also:

For more information about ConText administration, see Oracle8 ConText Cartridge Administrator's Guide

System Administration Tool

This section provides setup and usage information for the System Administration tool.

About the System Administration Tool

Figure 2-1

The System Administration Tool is a client-side Visual Basic application that provides a graphical user interface (GUI) for ConText administrators (i.e. users with the CTXADMIN role) to manage ConText servers, users, and queues for multiple Oracle8 databases.

It also can be used by ConText designers (i.e. users with the CTXAPP role) to perform the following tasks:

manage indexes policies, preferences, and sections
create setting labels for use with the ConText Linguistics.
view and create thesauri in a graphical environment for use in text queries
perform batch index operations, such as index creation and optimization, via a Batch Queue available only through the System Administration tool.

The System Administration Tool can be installed on any client PC running Microsoft Windows NT or Windows 95 and connects to Oracle8 using Net8.

Configuring the System Administration Tool

The following tasks may be required for using the System Administration tool.

Enable User Login

Before Oracle users with the CTXADMIN or CTXAPP role can connect to a database from the System Administration tool, the CTXSYS user may have to connect once to the database. If this is required, the System Administration tool will notify you.

Note:

CTXSYS needs to connect only once per database. Once CTXSYS connects to a database for the first time, the database is enabled thereafter for all users with the appropriate ConText roles.

Identify Databases

The TNSNAMES.ORA file lists all of the available databases to which an Oracle user can connect via Net8. If a user wants to connect to a database that does not appear in the list of known database in the System Administration tool, an alias for the database must be added to TNSNAMES.ORA and the System Administration tool restarted.

Using the System Administration Tool

To start the System Administration tool, simply click on the System Administration icon in the ConText Cartridge Workbench program group or choose Start > Programs > ConText Cartridge Workbench > System Administration.

Full usage information for the System Administration Tool is provided online as a WinHelp file.

Configuration Manager

This section provides set-up and usage information for the Configuration Manager.

About the Configuration Manager

Figure 2-2

The Configuration Manager is a platform-independent, Web-based application that allows the CTXSYS user to quickly and easily manage ConText servers, users, and queues for a single database. It also provides a simple ad-hoc query interface and an application generator for quickly and easily creating prototype ConText applications

There is one installation of the Configuration Manager per database; each installation runs under the CTXSYS user.

The Configuration Manager utilizes a generic PL/SQL package for processing HTML pages extended with special tags that allow transparent interaction with a database.

Note:

The Configuration Manager is installed with the ConText Workbench via the Oracle Installer; however, the Installer does not automatically configure the Configuration Manager.

Following the installation of the ConText Workbench, the Configuration Manager is configured by means of an icon which launches a separate Oracle Installer session.

About the Application Generator

The Configuration Manager includes an application generator that lets you build prototype ConText applications and then run them, using the querying facilities and theme and Gist viewing. You can access this tool by clicking Applications on the Configuration Manager Menu page.

See Also:

For more information about ConText administration, see Oracle8 ConText Cartridge Administrator's Guide

Configuration Requirements

Before you configure the Configuration Manager, ensure the following requirements are met:

Oracle8 is installed and a database instance started
if the Oracle8 database is installed on a different machine than the current machine (i.e. the machine from which you are performing the Configuration Manager configuration), a Net8 alias for the Oracle8 database must be created on the current machine
Oracle8 ConText Cartridge is installed and at least one ConText server with the DDL (D) personality is started
Oracle WebServer (or Web Application Server), release 2.1.0.3.2 or higher, is installed and at least one runtime listener and one admin listener is started
if Oracle WebServer (or Web Application Server) is installed on a different machine than Oracle8, a Net8 alias for the Oracle8 database must be created on the WebServer machine

Configuring the Configuration Manager

Configuration of the Configuration Manager involves:

creating database packages in the Oracle8 database (performed by Installer)
configuring WebServer or Web Application Server and specifying database connection information (performed by Installer)
copying required files from the current machine to the machine on which WebServer or Web Application Server is installed (performed either by you or the Installer)

Note:

If creation of the PL/SQL packages fails or configuration of WebServer/Web Application Server for the Configuration Manager fails, you can manually create the packages and configure WebServer/Web Application Server.

In addition, deconfiguration procedures can be applied to manually remove the Configuration Manager from the appropriate release of WebServer/Web Application Server.

For more information, see Appendix B, "Configuration Manager: Manual Configuration".

Local and Remote Configurations

If WebServer/Web Application Server is installed on the current machine (i.e. the machine from which Configuration Manager configuration is performed), this is considered a 'local' configuration.

If WebServer/Web Application Server is not installed on the current machine, this is considered a 'remote' configuration.

Configuration Procedure

Configuration is carried out via two Oracle Installer dialog boxes:

Oracle8 ConText Cartridge Configuration Manager Setup
Remote Web Application Server (appears only for remote configurations)

Note:

Configuration Manager configuration is identical regardless of whether Oracle WebServer or Web Application Server is installed. For convenience purposes, the following configuration procedure assumes Web Application Server is installed; however, WebServer can be inserted wherever Web Application Server appears.

To configure the ConText Configuration Manager:

Click on the 'Configuration Manager Setup' icon in the ConText Cartridge Workbench program group

Choose Start > Programs > ConText Cartridge Workbench - [HOME_NAME] > Configuration Manager Setup.

The Oracle Installer starts and the Oracle8 ConText Cartridge Configuration Manager Setup dialog box appears:

Enter the appropriate information in each of the fields, and click OK:

Field¹ Description

Web Application Server

Machine name

Enter the machine name on which Web Application Server is installed. By default, the name of the current machine appears.
If you are performing a local configuration (i.e. Web Application Server is installed on the current machine), use the default.
If you are performing a remote configuration, enter the name of the remote machine on which Web Application Server is installed.

Admin listener port

Enter the port number of the admin listener for Web Application Server. The default ('8888') is the default admin listener port for Oracle Web Application Server 3.0.

Admin listener user and password

Enter the username and password for the admin listener. The default username ('admin') is the default for Oracle Web Application Server 3.0.

Listener name : port

Enter the name and port of an existing runtime listener for Web Application Server. The defaults ('www' and '80') are the default runtime listener name and port for Oracle Web Application Server 3.0 on NT.
Other runtime listener name defaults include:
weblsn (WebServer 2.1 on Unix)
websvr (WebServer 2.1 on Unix)

Database

User/Password

Enter the password for CTXSYS, the owner of the Configuration Manager installation.

Password Type

Specify the type ('database' or 'Operating system') for the CTXSYS password.

Database Connection

Select the connection type that will be used between Web Application Server and Oracle8:

local - Web Application Server and Oracle8 are installed on the same machine.

If you select this option, you must also provide the SID of the Oracle8 database.
remote - Web Application Server and Oracle8 are installed on different machines

If you select this option, you must also provide the Net8 alias (database connection) to the Oracle8 database for Web Application Server.

Note: The alias that you enter here is not the alias between the current machine and Oracle8 machine.

NLS_LANG

Enter the NLS_LANG value for the Oracle8 database.

¹ Ask your web server administrator for assistance with these values.

If a local configuration is being performed (i.e. Web Application Server is installed on the current machine), go to Step 9. Otherwise, the Remote Web Application Server dialog box appears:

Select the platform of the remote machine on which Web Application Server is installed.
In a remote configuration, certain files required by the Configuration Manager must be copied from the current machine to the remote machine on which Web Application Server is installed. The files are initially located in the following directory on the current machine:

Field¹	Description
Web Application Server
Machine name	Enter the machine name on which Web Application Server is installed. By default, the name of the current machine appears. If you are performing a local configuration (i.e. Web Application Server is installed on the current machine), use the default. If you are performing a remote configuration, enter the name of the remote machine on which Web Application Server is installed.
Admin listener port	Enter the port number of the admin listener for Web Application Server. The default ('8888') is the default admin listener port for Oracle Web Application Server 3.0.
Admin listener user and password	Enter the username and password for the admin listener. The default username ('admin') is the default for Oracle Web Application Server 3.0.
Listener name : port	Enter the name and port of an existing runtime listener for Web Application Server. The defaults ('www' and '80') are the default runtime listener name and port for Oracle Web Application Server 3.0 on NT. Other runtime listener name defaults include: weblsn (WebServer 2.1 on Unix) websvr (WebServer 2.1 on Unix)
Database
User/Password	Enter the password for CTXSYS, the owner of the Configuration Manager installation.
Password Type	Specify the type ('database' or 'Operating system') for the CTXSYS password.
Database Connection	Select the connection type that will be used between Web Application Server and Oracle8: local - Web Application Server and Oracle8 are installed on the same machine. If you select this option, you must also provide the SID of the Oracle8 database. remote - Web Application Server and Oracle8 are installed on different machines If you select this option, you must also provide the Net8 alias (database connection) to the Oracle8 database for Web Application Server. Note: The alias that you enter here is not the alias between the current machine and Oracle8 machine.
NLS_LANG	Enter the NLS_LANG value for the Oracle8 database.

ORACLE_HOME\ctxw\middle\cfgmgr\remote

The files must be copied to the following directory on the remote machine:

ORACLE_HOME/ctxw/middle/cfgmgr

Note:

The 'remote' subdirectory is not required on the remote machine.

Select how you want to copy the required files to the Web Application Server machine:

Automatically - the Oracle Installer copies the required files to the appropriate directory for you

You can select 'Automatically' only if Web Application Server is installed on a machine that is mounted to the current machine. If you select this option, you must also specify the directory on the current machine to which the ORACLE_HOME on the Web Application Server remote machine is mounted.

Manually - you must copy the files manually to the appropriate directory on the remote machine after configuration is completed

Note:

If the remote machine is not running Windows NT, all file and directory names must be in lowercase on the remote machine.

Enter the Net8 alias between the current machine and the machine on which Oracle8 is installed. Note that this alias is not the alias between the Web Application Server machine and the Oracle8 machine.
Click OK.
If you chose 'Manually' in Step 5, copy the required files from the current machine to the remote machine.
Shut down and restart all Web Application Server listeners and services.

Using the Configuration Manager

An HTML-based help system is delivered as part of the Configuration Manager. The help system utilizes ConText to generate a text index that enables you to search the help system; therefore, detailed usage information for the Configuration Manager is not included in this user's guide.