===========================================================================
           HP OpenView Event Correlation Services Version 3.0 (A.03.00)

                                 Release Notes

                                 18 Sept 1998

=============================================================================
  INSTALLATION

There are several bundles associated with the HP OpenView Event Correlation 
Services product:

    HP OV ECS Designer
    HP OV ECS Designer for Telecom DM
    HP OV ECS Designer for NNM and ITO
    HP OV ECS Development Kit
    HP OV ECS Runtime Engine
    HP OV ECS Runtime Engine for Telecom DM
    HP OV ECS Runtime Engine for NNM
    HP OV ECS Runtime Engine for NNM (Japanese)

These products are installed with the Software Distributor application on
HPUX and Solaris, and with InstallShield setup.exe on NT. Please use the
procedure described in the ECS Installation Guide to install these products.


=============================================================================
  SUPPORTED PLATFORMS

This release of ECS 3.0 is supported on the following platforms:

HP-UX 10.10             (standalone, DM 5.03)
HP-UX 10.20             (standalone, DM 5.03, NNM 6.0)
HP-UX 11.0              (standalone, NNM 6.0)
Solaris 2.5.1, 2.6      (standalone, DM 5.03, NNM 6.0)
Windows NT 4.0          (standalone, NNM 6.0)

=============================================================================
  RELEASE IDENTIFICATION

This release of HP OV ECS is identified as "ECS 3.0 (A.03.00)".
This identification can be found:

    - in HP OV ECS Engine:

	The output from the command

	    ecsmgr -info

	contains a line

            engine version - ECS 3.0 (A.03.00)

    - in HP OV ECS Designer:

	In the "Help" menu the command "About HP OV ECS Designer"
	opens a window which displays the ECS Designer version.


=============================================================================
  PRODUCT LICENSES
	ECS requires ovkey licenses when used with NNM and ITO, and flexlm 
	licenses otherwise.  If you are unclear about your licensing needs 
	please contact your HP sales representative.


=============================================================================
  PRODUCT DOCUMENTATION 

NOTE: Draft versions of the manuals have been included in this release

The product manuals for the HP OV ECS products are supplied as dynatext 
readable  files and pdf files.  These files are in separate filesets which 
are available in the documenation CD-ROM and may be installed independently.

There are different Document CDs for different platforms.The part numbers 
for the Document CDs are:

     	J1095-10800:  HP-UX 
	J1095-10801:  Solaris
	J1095-10802:  Windows NT

Manuals in the PDF format are installed in directory $OV_DOC/ecs.  This 
directory contains some or all of the following files (depending on the 
target platform and filesets installed.


	J1095-90301.pdf     HP OV ECS Installation Guide

	J1095-90304.pdf     HP OV ECS Designer's Guide

	J1095-90305.pdf     HP OV ECS Developer's Guide and Reference

	J1095-90303.pdf     HP OV ECS Designer's Reference

	J1095-90302.pdf     HP OV ECS Administrator's Guide

	J1095-90308.pdf     HP OV ECS ASCII Module

	J1095-90307.pdf     HP OV ECS SNMP Module

	J1095-90306.pdf     HP OV ECS CMIP Module

	J1095-90309.pdf     HP OV Configuring Circuits for NNM and ITO

     DynaText files are grouped into collections. There are four collections
     available for ECS. The collections are
         ECS Install/Admin Manuals
         ECS Designer Manuals
         ECS Developer Manuals
         ECS Manuls for NNM and ITO

    The DynaText collections are installed in directory $OV_DOC/dynatext

    The DynaText browser is installed when you install the product unlike
    Acrobat Reader.

          
=============================================================================
  TRAINING 

  HP OV ECS Designer:
  -------------------
  HP OpenView University offers training on the HP OV ECS Designer. 
  Email ovtraining@hp-ftcollins-gen4.om.hp.com for further 
  information about the course "Developing Event Correlation Circuits".


=============================================================================
  HP OV ECS DESIGNER SAMPLE SCENARIOS

Sample scenarios, including example circuits, compound nodes and functions
are provided in the Designer Demonstration fileset.

  $OV_DB/ecs/examples/circuits/mdl
    scen1
      This directory contains a circuit that correlates events associated
      with link and node failures.  The circuit uses the example MDL event 
      format used in the Developer's Guide and Reference.
    scen2
      This directory contains a circuit that demonstrates the use of the
      annotate node.  It is used in conjunction with the example annotation
      server described in the Developer's Guide and Reference.

  $OV_DB/ecs/examples/circuits/cmip
    scen1
      This directory contains a circuit that correlates events associated
      with link and node failures.  The circuit uses the example MDL event 
      format used in the Developer's Guide and Reference.
    scen2
      This directory contains a circuit that demonstrates the use of the
      annotate node.  It is used in conjunction with the example annotation
      server described in the Developer's Guide and Reference.
    scen3
      This directory contains a circuit that combines an alarm and a clear event 
      if the clear directly follows the alarm and their creation times are 
      close. (CMIP)
    scen4
      This directory contains an SDH-environment set of example compounds for:
        - simple suppression of consequential events
        - suppression of set/clear event pairs
        - creation of a major alarm when the number of minor alarms crosses
          some threshold
    scen5
      This directory contains a circuit that uses annotation.  The operation of 
      the circuit can be examined in the Circuit Simulator.  Included are the 
      input events file and annotation response file. (CMIP) 
    scen6
      This directory contains a circuit that suppresses sympathetic events in an
      SDH fibre-cut scenario. (CMIP)
    misc
      This directory contains a circuit that has examples of various functions
      (eg. table searching, event modification, combining of cmip and snmp
      events, extraction of events, etc.). (CMIP and SNMP)


=============================================================================
  HP OV ECS RUNTIME APIs

Sample programs demonstrating usage of the Event I/O and Annotation APIs are 
provided in the Development Kit bundle.

  $OV_PROG_SAMPLES/ecs
    mdl
      This directory contains the MDL event syntax definition for the 
      event format referred to in the product manuals.
    event_io      
      This directory contains three sample programs for sending/receiving 
      events via the C event I/O API. 
    annotate
      This directory contains a sample program for annotating events via
      the C annotation API.
    aio_api
      This directory contains sample programs for sending/receiving events
      via the C++ AIO APIs and a sample annotation server program that uses 
      the same C++ API.


=============================================================================
  YEAR 2000 COMPLIANCE

  ECS 3.0 has been tested for Year 200 Compliance according to the test cases
  described in "HP Year 2000 Compliance Definition" (see
  http://www.hp.com/year2000/compliance.html) and has been found to be Year
  2000 compliant.

=============================================================================
  SUMMARY OF CHANGES FROM ECS 2.1 to ECS 3.0

- Platform support changes:

	Added: HPUX 11.x, NT 4.0, Solaris 2.5.1, Solaris 2.6

	Removed: HPUX 9.x, Solaris 2.4, Solaris 2.5

- The ECS Engine now allows circuits to be enabled in multiple correlation
  streams, with each stream having a different output policy.

- The ECS circuit designer provides the ability to set the policy of the
  circuit in the external tab.

- The ECS Engine configuration can now be saved to, and restored from a
  file. The following information is stored:
  - stream names and policies
  - circuit names, files and states in each stream
  - data and fact stores associated with each circuit
  - logging and tracing masks
  - maximum engine log and event log sizes

- Engine-wide output event logging has been replaced by a per-stream
  event output model (ie. each stream will produce a log containing
  a list of events output from just that stream) (see ecsmgr(1m) or the ecsmgr
  section in the ECS.hlp Windows Help file on NT).

- The engine can now log input events not accepted by any circuit in
  each stream.

- ecsmgr now produces a detailed description of an engine's licensing
  mode, containing a list of enabled and disabled endecoders and
  features (see ecsmgr(1m) or the ecsmgr section in the ECS.hlp Windows Help
  file on NT). 

- ecsmgr -info now produces a description of each stream, and the
  state of automatic engine configuration saving. Datastores and
  factstores not associated with any circuit are now also listed.

- On NT platforms, all man pages are now provided in WinHelp format and
  are installed in $OV_HELP\C (ECS.hlp, ECSapi_c.hlp and ECSapi_CC.hlp).

- Improved source node filtering now makes it possible for a circuit
  designer to filter input events based on an ECDL expression instead
  of just being able to filter on event type or transit delay. This
  is configurable from within the External tab in the ECS Designer.

- Count and Rate nodes have been improved to maintain an ECDL dictionary
  containing counts and rates (respectively) keyed using the nodes
  key_spec parameter. This ECDL expression is evaluated each time an event
  enters the count/rate node, and the resultant key is used to determine
  which count/rate will be updated.

- A C++ Interface to the Annotation and Event I/O APIs has been provided. For
  details see the ECS C++ API reference on NT (in the WinHelp file
  ECSapi_CC.hlp) and the ECS(3) man pages on Unix platforms.

- ECDL Changes

  The alter function may be used in a dynamically evaluated node
  parameter to alter a dictionary that appears in the global definitions.

  Dictionaries may be used as values in data store entries.  The standard
  ECDL dictionary syntax is used.

  The built-in function 
	integerOf: String -> Integer
  has been added to convert a string of decimal digits to an integer value.

  A collection of built-in functions for manipulating Oids has been added.
  They are defined in a module called Oid.
	Oid.last:     Oid -> Integer
	Oid.join:     List Integer -> Oid
	Oid.split:    Oid -> List Integer 
	Oid.SplitNNM: Oid -> (Oid, Integer)
	Oid.SplitAt:  Integer -> Oid -> (Oid, Oid)
	Oid.Append:   Oid -> Integer -> Oid

  A collection of built-in functions for manipulating internet addresses
  has been added in a module called IP.
	IP.FromOctet: String -> String
	IP.ToOctet:   String -> String


- NNM Specific Changes

  An engine configuration Java applet has been created to simplify various
  aspects of engine management and circuit parameter editing.


=============================================================================
  CROSS-PLATFORM ISSUES

- Data store and fact store files:

  Data store and fact store files are created with a text editor. If they are
  created on Windows NT, the files will contain carriage-return/line-feed
  characters as line terminators. In order for ECS to load these file correctly
  on Unix, the carriage-return/line-feed pairs must be converted to a single
  line-feed character. There are a number of utilities that can perform this
  (e.g. dos2ux(1) on HP-UX). 

  Data stores and fact stores created on Unix can be loaded by ECS on NT
  without modification.

=============================================================================
  MIGRATION FROM ECS 2.X TO 3.0

- Circuit compatibility:
  
  The ECS 3.0 Designer is capable of loading circuits created using
  the ECS 1.X and ECS 2.X Designers. All circuits are saved in a
  format that is not backwards compatible (eg a circuit edited using
  the ECS 3.0 Designer is not loadable into a ECS 2.0 Designer).

  The ECS 3.0 correlation engine is capable of using circuits compiled
  using the ECS 2.X and ECS 3.0 Designers. ECS 1.X compiled circuits
  should be recompiled using the current Designer.

  The ECS 3.0 Designer will now attempt to load circuits written in a
  codeset different from the current locale. A warning will be displayed
  stating the results of doing this may be unpredictable.


- ecsmgr command changes:

  The following ecsmgr 2.X commands have been removed for 3.0:
  -log_events_in	functionality has been replaced by -log_events
  -log_events_out	functionality has been replaced by -log_events

  The following ecsmgr commands have been added for 3.0:
  -create_stream	creates a new correlation stream
  -remove_stream	removes an empty correlation stream
  -licinfo		displays licensing information
  -stream		modifies -enable/-disable/-policy, specifying
			the stream being affected
  -save_config		saves the engine configuration to a file
  -restore_config	restores the engine configuration from a file
  -merge_config		merges the contents of a engine configuration file
			into a running engine
  -auto_save_config	controls the automatic saving of configuration
			changes

  The following ecsmgr 2.X commands have been modified for 3.0:
  -enable, -disable, -policy
		can now all take an optional -stream directive which
		specifies the stream to modify. If the -stream modifier
		is not provided, the default stream 'default' is assumed.
  -stats	if 'verbose' is provided, detailed node information is
		displayed.
  -log_events	is now used to control the event logging 

- ecsd command changes for Windows NT:

  The following ecsd commands have been added for 3.0 on Windows NT only:
  -console      specifies that ecsd should run as a foreground console
                application
  -install      installs ecsd as a Windows NT service
  -remove	removes the ecsd service from a Windows NT system

- ECS Designer changes:

  The "Step by Activity" button functionality, has been moved into the
  "Simulate" menu.

- ECS Runtime APIs

  Several of the Annotation and Event I/O API functions have changed. Refer to
  the man pages for more information.
    - ESOK_getFdSet replaces ESOK_getFdMask
    - ESOK_buildRemote first parameter is now int instead of int32
    - EIO_open has a new parameter (stream name)
    - EIO_addFilter, EIO_removeFilter, EIO_sendEvent - "reserved" parameter has
      been removed.

=============================================================================
  KNOWN DEFECTS AND WORKAROUNDS


The correlation engine fails to correctly initialize circuits where there is a
feedback path from an output port on a count node to an input port.  This
results in undefined behaviour in the circuit 'downstream' of the count node.
In most cases this can be detected through a message inserted into the
Simulator and Engine log messages.
The circuit developer should not design circuits with feedback loops
involving count nodes.


If nodes are placed before Snap to Grid is enabled it is possible for the port
positions to be unreachable when placing connections with Snap to Grid enabled.


When using the Designer, you can only make connections between two nodes if 
they are visible on the Eventflow canvas.  This is because the canvas does 
not scroll when you drag the pointer past the edge of the display area.
A workaround for this problem is to zoom out before making the connection.

When using the Designer, if the edit window for a text item is first opened 
by a double-click the font of the text doesn't match the text editing font.

The Correlation Circuit compiler does not report an error when a token type 
code is the same as one of the reserved but unused type codes in the range 
0..20.

In ECDL, a non-function value cannot depend on itself, for example:
        val v = add v 1
is not legal.  This is not always detected gracefully by the compiler in 
complex expressions, especially when the search or list builder expressions
are used.  This construct may cause the compiler to stop with an 
internal error:
     codegen BindOut not expected for id at fg ??, file ..., line ...
where 'id' is the name of the identifier that is at fault. The file and
line number refer to the ECDL intermediate file generated by the Designer.



