**************************************************************************
 *                                                                        *
 * Copyright (c) 1992 MCNC, CONCERT Network                               *
 * All rights reserved.                                                   *
 *                                                                        *
 * Permission to use, copy, modify, and distribute this software and      *
 * its documentation for any purpose and without fee is hereby granted,   *
 * provided that the above copyright notice appears in all copies and     *
 * that both the copyright notice and this permission notice appear in    *
 * supporting documentation.  MCNC makes no representations about the     *
 * suitability of this software for any purpose. It is provided "as is"   *
 * without express or implied warranty.                                   *
 *                                                                        *
 **************************************************************************

INSTALLATION NOTES
------------------

The CONCERT trouble ticket system was obviously developed to meet the needs 
of the CONCERT NOC. Before installing it at another site, several variables 
will need to be changed to tailor it to the local environment. 

It is assumed that the postgres database software is already installed, as
well as the shell form software, and the Tk/Tcl additions to the X Window
software.  Note that there is a postgres patch file included with this
distribution. It should be used to update the postgres source to partially 
fix some security problems. Read the WARNING file for more details. The 
current trouble ticket software runs successfully with postgres version 4.0
and Tk version 3.2. 

A makefile is provided in the src subdirectory that will compile and install
the database access routines used by the trouble ticket scripts. The Makefile
will install the access programs in the /home/postgres/bin directory unless 
DBDESTDIR is modified. The Makefile will also install the trouble ticket 
scripts in /usr/local/bin unless DESTDIR is modified. The helpfile for the X 
window interface will be installed in the directory specified by HELPDESTDIR.

In all of the interface scripts (tt, xticket, ttalarm), there is a section 
defining lists, pathnames, etc. that will need to be changed to tailor the 
menus and to reflect the local site's parameters. The pathnames to the 
postgres (MONITOR, DBACCESS and DBALARM) and shell form (SF) utilities need 
to be set here. 

The lists define the valid entries for the selection fields in the ticket 
forms. The selection fields are:

	sites	- list of valid sites connected to the network, will need 
		  to be tailored for each network.

	sources	- list of means by which the network problem was noticed, 
		  can be changed to suit the local environment.

	scopes	- list of how wide an area the problem affected, can be 
		  changed to suit the local environment.

	close_codes - list of codes relating to the point of failure, can 
		      be changed to suit the local environment.

	types	- list of problem types (e.g., planned, unplanned), can be
		  changed to suit the local environment.

	states	- list of possible states of the ticket, tied into the 
		  operation of the system. Generally, the ticket functions
		  are tied to a particular state, and changes may require 
		  changes to the shell scripts.

	priorities - list of priorities that can be assigned to the ticket,
		     tied into the alarm mechanism, and changes here will
		     require modifying the scripts. 

There are also variable names that need to be set to the site name (SITE) 
and the name of the ticket database (DBASE).

The TICKETHOME parameter defines the directory where files related to the 
trouble tickets are kept. Each file has an update record file associated
with it, and also, any files which are specified to be included via the 
update form. There also needs to be the file "ttnumber" which contains only
the next available ticket number. NOTE - the "ttnumber" file must be put in
place and initialized before starting the trouble ticket system. Files in 
this directory are owned by the person entering the ticket, with group
permissions set for TICKETGROUP. Users of the system (i.e., those who can
enter or update the tickets) should be in the TICKETGROUP group.

The ticket system will send mail to the list specified by MAILLIST. The
berkeley mail program is used to send out the mail message. If you use 
another mailer, you may need to make some changes.

The postgres database must be created (using the postgres "createdb" 
utility), with the database name specified matching the "DBASE" parameter.
The file "createdb.script" contains the postgres monitor command to create
the ticket class entry within the database. 

There is also a modified "finger" that allows a user to query the trouble
ticket system remotely using the standard finger mechanism. It enables a 
user to list open tickets and to look at specific tickets, in addition
to the normal finger facilities. If this version of the finger program is 
desired, it should be installed of the current finger program.