Loggerhead 1.0.0 Reference Manual

This document comprises the reference manual for Loggerhead version 1.0.0.

Requirements
Installation
Running Loggerhead
Loggerhead API

Requirements

The requirements to run Loggerhead are

Injun Application Server.
Oracle 8.1.5 (or later) database.
Oracle Net8 (SQL*Net) installed on server that Injun is installed on (if on different server from database).
Oracle Network Listener running on database server (if on different server from Injun).
Oracle account with execute access to Loggerhead API.

Installation

To install Loggerhead the following steps should be followed, customising to the installation environment where appropriate.

Refer to Injun Documentation for details on how to download and install the distribution file.

Run the Oracle installation scripts with values appropriate to the installation environment to create the supporting infrastructure and install the PL/SQL packages. Note: the package bodies are distributed wrapped, however the package specifications are readable.

The configurable values are found in
- create_schema_owner.sql
- create_schema_objects.sql
- create_schema_user.sql
eg.,
```
$ cd injun-1.0.0/modules/loggerhead/install
$ sqlplus system/manager
SQL> @create_schema_owner USERS TEMP
SQL> connect tortuga/tortuga
SQL> @create_schema_objects /opt/local/injun-1.0.0/modules/loggerhead/images
      
```
Users can now be set up to use the Loggerhead application. Either a new user can be created, eg.,
```
$ sqlplus system/manager
SQL> @create_schema_user guest USERS TEMP
      
```
or the appropriate privileges given to an existing user, eg.,
```
$ sqlplus tortuga/tortuga
SQL> @grant_role freddy
      
```
Ensure the ORACLE_HOME environment variable is defined as appropriate on the server that Injun is to run on. eg.,
```
$ export ORACLE_HOME=/opt/oracle/product/8.1.5
      
```

Running Loggerhead

Refer to Injun Documentation for details on how to start/stop Injun and load/unload the Loggerhead library.

Once Injun is started and the Loggerhead library loaded, the application is ready for use and can be accessed from the Apps option of Injun's main menu. Full help is available on the main menu of Loggerhead should more information on how to Login and use Loggerhead be required.

Loggerhead API

The following table summarises the packages that comprise the Loggerhead API. For further details on each package follow the appropriate link or refer to the package specification.

Package name	Description
TTPL_DEBUG	Provides the ability to debug PL/SQL procedures using the Oracle package utl_file to output to an file on the Oracle server.
TTPL_HTML	Provides a set of functions to provide a level of abstraction when building html pages.
TTPL_UTIL	Provides a set of general purpose functions, types, constants, etc that can be used when building any application.
LOGGERHEAD_UTIL	Provides a set of Loggerhead specific functions, types, constants, etc that can be used when building applications for use by Loggerhead.

last updated 18-February-2000