Oracle8 ConText Cartridge Workbench User's Guide Release 2.3 A57700-01 |
Library | Product | Contents | Index

# 1
Introduction

This chapter introduces the Oracle8 ConText Cartridge Workbench components.

The topics covered in this chapter are:

- ConText Workbench Components
- Administration Tools
- Document Viewers
- I/O Utility
- CTXQUERY Forms Sample Application
- TextServer3 Dictionary Migration Tool

## ConText Workbench Components

The ConText Workbench consists of the following components:

- Administration Tools:
  - Configuration Manager (platform-independent)
  - System Administration Tool (Windows NT and 95 only)
- Document Viewers:
  - Viewer Plugin, in combination with Viewer Cartridge (Web-based)
  - Viewer Control (client/server-based)
- I/O Utility (Windows NT and 95 only)
- Samples
  - CTXQUERY Sample Forms application
  - Sample I/O Utility parameter file
- TextServer3 Dictionary Migration Tool

## Administration Tools

The ConText Workbench provides two separate tools for administering ConText

.

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

### Configuration Manager

The Configuration Manager is a Web-based application that allows a ConText administrator to manage various administration tasks quickly and easily. It also incorporates a simple ad-hoc query tool.

The Configuration Manager is platform-independent, whereas the System Administration Tool is for Windows NT and Windows 95 platforms only. Also, in contrast to the System Administration Tool, which may be installed on multiple client machines, there is one installation of the Configuration Manager per database; each installation runs under the CTXSYS user.

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

An HTML-based help system is delivered with the Configuration Manager. This incorporates full text indexing facilities that enable you to search the help system; therefore, usage information for the Configuration Manager is not included in this user's guide.

### System Administration Tool

The System Administration Tool is a client-based Visual Basic application that provides a graphical user interface (GUI) for administering ConText servers, text, and the Linguistic Services.

The System Administration Tool can be installed on any PC running Microsoft Windows NT or Windows 95.

A Windows-based help system is delivered with the System Administration Tool; therefore, usage information for the tool is not included in this user's guide.

## Document Viewers

The ConText Workbench provides two methods for viewing text retrieved by ConText:

- Viewer Plugin (in combination with WebServer-side Viewer Cartridge)
- Viewer Control

### Viewer Plugin

The client-side Viewer Plugin can display most documents on the World Wide Web just as they would appear in their native format.

The Viewer Plugin actually consists of a set of libraries. These provide the means for viewing the file. The plugin currently supports WYSIWYG viewing and query term highlighting in the following formats:

- WordPerfect 5.x, 6.x
- MS Word 2, 6

All other formats supported by ConText are displayed, by default, as plain (ASCII) text.

In the Configuration Manager, the View Data form uses the Viewer Plugin to view a hit from the available query hitlist.

See Also: For more information about using the Viewer Plugin, see Chapter 2, "Document Viewers".

### Viewer Cartridge

The Viewer Plugin requires the Viewer Cartridge. The Viewer Cartridge is installed separately on the WebServer-side. It is used to package data for the Viewer Plugin; that is, it generates the highlight information for a document, fetches the document from the ConText database, and then sends the document as a file (Mime-type "application/x-ctxv") to the Web browser, which uses the Viewer Plugin (if available) to display the document.

Alternatively, for other Mime-types, the Web browser can use its own mapping to invoke a helper application or plugin which can display the ConText-indexed documents. In such cases, Viewer Cartridge does not need the Viewer Plugin as long as suitable URLs have been specified.

See Also: For more information about using the Viewer Cartridge, see Chapter 2, "Document Viewers". For more information about manually configuring the Viewer Cartridge, see Appendix A, "Viewer Cartridge: Manual Configuration".

### Viewer Control

The Viewer Control is a 32-bit Windows custom control for use in client/server configurations. It can be embedded in Windows applications or in HTML pages (for display in Internet Explorer using the Object tag).

The Viewer Control is used to display retrieved documents using the intended layout and with search terms highlighted. It is delivered with a sample application implemented as a stand-alone container.

A viewed document can be in any of the supported server-side formats. For example, a Word document can be viewed in a way similar to how it appears within Microsoft Word. The user can scroll through the document using the Next and Previous buttons to jump to other occurrences of the search term(s).

A Windows-based help system is delivered with the Viewer Control; therefore, usage information for the viewer is not included in this user's guide.

See Also: For more information about using the Viewer Control, see Chapter 2, "Document Viewers". For more information about document viewing, see Oracle8 ConText Cartridge Application Developer's Guide

## I/O Utility

The I/O Utility enables you to load and unload data between database tables and client-side files.

The I/O Utility is a 32-bit, stand-alone executable that performs a series of operations carried out in sequence as defined by a parameter file.

Example parameter files are documented in this user's guide; in addition, one of the example parameter files is included in the ConText Workbench as a sample.

See Also: For more information about using the I/O Utility, see Chapter 3, "Input/Output (I/O) Utility".

## CTXQUERY Forms Sample Application

The CTXQUERY sample application is delivered with the ConText Workbench. This Oracle Forms 4.5 application demonstrates one way of developing Forms applications using ConText.

Note: An icon is not created for CTXQUERY during installation of the ConText Workbench because the sample application requires some setup tasks to be performed on the server before the application can be used.

See Also: For a complete description of CTXQUERY, including setup information, see Chapter 4, "CTXQUERY Forms Sample Application". For more information about developing ConText applications, see Oracle8 ConText Cartridge Application Developer's Guide

## TextServer3 Dictionary Migration Tool

The TextServer3 Dictionary Migration tool has been developed to assist users who are migrating from TextServer3 to ConText. It is not a complete migration tool, but it does allow you to:

- create a policy in ConText for each indexable column of a TextServer3 table
- migrate TextServer3 thesauri and synonym rings to ConText
- create a section group in ConText for each section group in TextServer3

The tool is delivered as a PL/SQL package called CTXWMG_MIGRATE. The package generates SQL scripts that you can customize to your requirements before running them.

This package must be created in the ConText database on the server after the ConText Workbench is installed on a client machine.

Note: The TextServer3 Dictionary Migration Tool is not listed, in the Oracle Installer, under the list of available components for the ConText Workbench. The scripts for creating the CTXWMG_MIGRATE package are automatically copied to the client machine during installation of the ConText Workbench. The scripts must then be run after installation to create the package.

See Also: For a complete description of the Migration Tool, see Chapter 5, "TextServer3 Dictionary Migration Tool". For more information about policies, thesauri, and section groups in ConText, see Oracle8 ConText Cartridge Administrator's Guide

Prev | Next
| Copyright © 1997 Oracle Corporation. All Rights Reserved. |
Library | Product | Contents | Index