ALARM CONFIGURATION REPORT UTILITY

03/08/2002    Mark Dumond  (mdumond@feedforward.com)
              FeedForward, Inc. - Control Systems Applications Engineering
              Marietta, GA  30066
              770-426-4422
              http://www.feedforward.com
              Send bugs and comments to: mdumond@feedforward.com

DISCLAIMER: FeedForward, Inc. takes no responsibility for any problems that
may arise because of this utility.  Use at your own risk.

-----------------------------------------------------------------------
This program reports on configured alarms on a system.
The output format is comma-separated-values, to allow Excel import.

For each configured alarm (with its alarm option parameter ON), the utility lists:
   1. C:B name
   2. Block Type
   3. Block Description
   4. Alarm Type #1 (HLOP, HHAOPT, DALOPT, SAO, BAO, etc)
   5. Alarm Type #2 (Hi/Lo, Hi only, Lo Only)
   6. Priority
   7. Names of alarm destinations from group (printers, historians, WPs)
   8. Alarm Text Fields (ANM, NM0, NM1, etc)
   9. Other configured alarm parameters pertinent to the type of alarm,
      such as alarm levels and deadbands for analog alarms.

-----------------------------------------------------------------------
TO INSTALL:
1. Choose an install directory with plenty of room. Recommend /opt/foxind.
2. (copy almrep.tar to /tmp directory)
3. cd [directory you want to install it to, like /opt/foxind]
4. tar xvf /tmp/almrep.tar
5. rm /tmp/almrep.tar
6. This program only works on AW51x workstations!

-----------------------------------------------------------------------
 CONFIGURE:
1. cd [installdir]/config
2. Edit "cps" file to include lines of CP letterbugs to report on
3. OPTIONAL: Edit the "alarmtypes" file to add new alarm types that may not be 
   defined by default.  See the header of the alarmtypes file for file format.

   The default block types are:
   ACCUM   AIN     AINR    AOUT   AOUTR
   BIAS    BLNALM  CHARC   CIN    COUT
   DEP     DGAP    DPIDA   EVENT  EXC
   GDEV    IND     MDACT   MEALM  MOVLV
   MTR     MVL     PATALM  PID    PIDA
   PIDE    PIDX    PIDXE   PTC    RATIO
   REALM   STALM   VLV

4. You may change the default columns to report on by editting the "alarmtypes" file.
   Do not change the service of the first four columns though.

-----------------------------------------------------------------------
TO EXECUTE
1. Make sure that there are no Control Configurators currently active in
   any of the CPs to be reported on, nor are any of these CPs checkpointing
2. cd [installdir]
3. run
4. The utility will let you know its status as it is executing
5. You may have to wait a while.
   Sit back, relax, and have some coffee.
   This utility can take several hours on an AW51B with 4000 blocks.



-----------------------------------------------------------------------
OUTPUT
1. almrep.csv    Report File in .csv format. Import in to Excel.


-----------------------------------------------------------------------
NOTES:
1. If you break (CTL-C) while the utility is doing dumps on the CPs,
   you may lock the utility out of that CP until you go into the CP
   with the Control Configurator and override the lock.
2. This utility is not 100% perfect.  This utility has only been used in-house
   and not thoroughly tested.  If you have problems, email me.  
3. Since FeedForward is providing this utility at no charge,
   we appreciate keeping our company name lines in tact
   at the start of executing the utility, and at the top of this document.
4. FeedForward, Inc. takes no responsibility for any problems that
   may arise because of this utility.  Use at your own risk.