2.6 sddsalarmlog

• description: sddsalarmlog logs changes of alarm status for process variables named in an input file.
• examples: The status of the positron accumulator ring process variables are logged for a one day duration.
  sddsalarmlog PAR.along PAR.along.sdds -timeDuration=1,day

  where the file PAR.along is the input file containing the names of the process variables, and the file PAR.along.sdds is the output file.

• synopsis:
  usage: sddsalarmlog <input> <output>  
  -timeDuration=<realValue>[,<time-units>] [-offsetTimeOfDay]  
  [-append[=recover] | -eraseFile | -generations[=digits=<integer>][,delimiter=<string>] |  
   -dailyFiles[=verbose]]  
  [-pendEventTime=<seconds>] [-durations] [-connectTimeout=<seconds>]  
  [-explicit[=only]] [-verbose] [-comment=<parameterName>,<text>]  
  [-requireChange[=severity][,status][,both]]  
  [-inhibitPV=name=<name>,pendIOTime=<seconds>]  
  [-watchInput]  
  [-runControlPV=string=<string>,pingTimeout=<value>]  
  [-runControlDescription=string=<string>]

• files:
  • input file:

    The input file is an SDDS file with the required string column ControlName which contains the names of the process variables whose status is to be monitored.

  • output file:

    The output file contains information on the process variable alarm status change, such as the time of occurrence, the alarm designation, the severity of the alarm, and the row location of the previous alarm status change.

    In order to save disk space sddsalarmlog logs integer codes (indexes) instead of the actual string values for the control name, the alarm status and the alarm severity. The integer codes are indices into one of three string arrays written to the output file. The logging information can be recovered using SDDS tool sddsderef.

    As an option, and for a direct interpretation of the output file, the control name, alarm status and alarm severity can be written explicitly as string columns with or without the integer codes. However this option uses up a lot more disk space.

    In either case the following columns are defined:

    • PreviousRow — Long column of row numbers. For each process variables alarm status change, the row location of the previous alarm status change is written.
    • TimeOfDay — Float column of system time in units of hours. The time does not wrap around at 24 hours.

    By default these columns are defined (except when the option -explicit=only is specified):

    • ControlNameIndex — Long column indicating the process variable whose alarm status changed. The value of this data is the index into the string array ControlNameString, which is the list of all process variables monitored.
    • AlarmStatusIndex — Short column indicating the alarm status. The value of this data is the index into the string array AlarmStatusString, which is the list of all possible alarm status values.
    • AlarmSeverityIndex — Short column indicating the alarm status. The value of this data is the index into the string array AlarmSeverityString, which is the list of all possible alarm severity values.

    These columns are created by the option -explicit:

    • ControlName — String column for the process variable whose alarm status just changed.
    • AlarmStatus — String column for the alarm status.
    • AlarmSeverity — String column for the alarm severity.

    This column is created with option -durations:

    • Duration — String column for the duration of the previous alarm state.

    These arrays are created by default except when the option -explicit=only is specified:

    • ControlNameString — String colunm of all process variables to be monitored.
    • AlarmStatusString — String colunm of all possible alarm status values.
    • AlarmSeverityString — String colunm of all possible alarm severity values.

    These parameters are defined:

    • InputFile — String parameter for the name of the input file.
    • TimeStamp — String parameter for time stamp for file.
    • PageTimeStamp — String parameter for time stamp for each page. When data is appended to an existing file, the new data is written to a new page. The PageTimeStamp value for the new page is the creation date of the new page. The TimeStamp value for the new page is the creation date of the very first page.
    • StartTime — Double parameter for start time from the C time call cast to type double.
    • YearStartTime — Double parameter for start time of present year from the C time call cast to type double.
    • StartYear — Short parameter for the year when the file was started.
    • StartJulianDay — Short parameter for the day when the file was started.
    • StartMonth — Short parameter for the month when the file was started.
    • StartDayOfMonth — Short parameter for the day of month when the file was started.
    • StartHour — Short parameter for the hour when the file was started.
• switches:
  • -timeDuration=<realValue>[,<time-units>] — Specifies time duration for logging. The default time units are seconds; one may also specify days, hours, or minutes.
  • -offsetTimeOfDay — Adjusts the starting TimeOfDay value so it corresponds to the day for which most data is taken.
  • -append[=recover] — Specifies appending to the file <output> if it exists already. If the recover qualifier is given, recovery of a corrupted file is attempted using sddsconvert.
  • -eraseFile — If the output file already exists, then it will be overwritten.
  • -generations[=digits=<integer>][,delimiter=<string>] — Sends output to <output>-<N>, where <N> is the smallest positive integer such that the file does not already exist. By default, four digits are used for formatting <N>.
  • -dailyFiles[=verbose] — Uses daily generation filenames of the form <output>-YYYY-JJJ-MMDD.<N>. If verbose is given, a message is printed when a new file is started.
  • -pendEventTime=<seconds> — Specifies the CA pend event time in seconds. The default is 10.
  • -durations — Includes state duration and previous row reference data in the output.
  • -connectTimeout=<seconds> — Specifies maximum time in seconds to wait for a connection before issuing an error message. The default is 60.
  • -explicit[=only] — Specifies that explicit columns with control name, alarm status, and alarm severity strings be output in addition to the integer codes. If the only qualifier is given, the integer codes are omitted.
  • -verbose — Prints a message when data is taken.
  • -comment=<parameterName>,<text> — Adds a comment parameter with the given text to the output file.
  • -requireChange[=severity][,status][,both] — Requires the specified changes before an event is logged.
  • -inhibitPV=name=<name>,pendIOTime=<seconds> — Checks this process variable periodically and aborts data collection if it is nonzero.
  • -watchInput — Monitors the input file for modifications and exits if it changes.
  • -runControlPV=string=<string>,pingTimeout=<value> — Specifies a run control PV name and optional ping timeout in seconds.
  • -runControlDescription=string=<string> — Specifies a run control PV description record.
• see also:
  • sddslogger()
  • sddslogonchange()
• author: Michael Borland, ANL/APS.