======================================================================
                  Halcyon Monitoring Solutions
                      www.HalcyonInc.com

                Neuron Integration for IBM Tivoli
                         Version 1.1.2

                         README.config
======================================================================


Overview
======================================================================
This README.config file describes how to configure the Neuron
Integration for IBM Tivoli.

This file consists of the following sections:
   - Integration Configuration: Directory Structure
   - Integration Configuration: Configuration Files
   - Integration Configuration: Postemsg Binary
   - Integration Configuration: Tivoli Action Configuration
   - Integration Configuration: Baroc File
   - Integration Configuration: Rules File



Integration Configuration: Directory Structure
======================================================================
All necessary configuration, log, and data files can be found in the
[LOCALDIR] folder (where [LOCALDIR] is typically /var/opt/HMF).

The contents of this folder are as follows:
  [LOCALDIR]/
    + conf              - configuration files
    + logs              - log files



Integration Configuration: Configuration Files
======================================================================
In order to use the Neuron Integration for IBM Tivoli, a Tivoli action
must be defined within a Neuron Portal Rule that will tell the
Tivoli Integration of events to forward to IBM Tivoli.

The Halcyon Neuron Event Manager should be used to setup a Tivoli
Adapter action within a rule.  When the given rule matches an incoming
event, the Tivoli action will be triggered and the event will be
forwarded to the Tivoli server specified with the action.



Integration Configuration: Postemsg Binary
======================================================================
For the Neuron Integration for IBM Tivoli to get messages into Tivoli,
the "postemsg" binary has to be in [LOCALDIR]/bin.
Alternatively, a symbolic link can be created in [LOCALDIR]/bin
and pointed to the actual "postemsg" binary.



Integration Configuration: Tivoli Action Configuration 
======================================================================
The Neuron Integration for IBM Tivoli can be configured to send
messages to IBM Tivoli using the "postemsg" binary mentioned above in
one of two ways:

1) You can create an IBM TEC configuration file and provide a path to
this file when you setup the IBM Tivoli action (as outlined above).

OR

2) When creating the IBM Tivoli action, you can specify the IBM
Tivoli host to send the event to.


NOTE:  Depending on how you have IBM Tivoli configured, you may
       need to use a TEC configuration file.  For instance, you may
       need to specify a custom Tivoli cache file accessible by
       user "halcyon" by including a BufEvtPath in a TEC 
       configuration file.  For example:

           BufEvtPath=/var/opt/HMF/logs/HMFAdapterTivoli.cache

       If you are attempting to forward Neuron events to Tivoli you 
       will need to specify the configuration option above if you see
       this error message:

           error in opening cache file /etc/Tivoli/tec/cache



Integration Configuration: Baroc File
======================================================================
The Tivoli baroc file for the Neuron Integration for IBM Tivoli is
located at:

       [LOCALDIR]/conf/module/TivoliAdapter.baroc



Integration Configuration: Rules File
======================================================================
The Tivoli rules file for the Neuron Integration for IBM Tivoli is
located at:

       [LOCALDIR]/conf/module/TivoliAdapter.rls 


---//---