Understand Anomaly Detect Batch Tracking Compiler (BTC) attributes

ADETECT

Record name.

Yes.

ADETECTTYPE

The anomaly detect type can be set to one of the following options:

• Unspecified

• Launcher

• Detector

• Receiver

No. Defaults to Unspecified.

TRIGGERPOINT

Two values are present:

1. The path to the status, multistate or Advanced Logic Processor (ALP) record to be used as the trigger for the anomaly detection. The format is:

   tableName.recordName

2. The message set state of the status, multistate or ALP result required to signal the anomaly detection.

   Note: The order of the path entered is important. For example, status.statusName123 OPEN is valid, but OPEN status.statusName123 is not valid.

   The configured TRIGGERPOINT must hold its trigger state (as configured above—for example, OPEN) for a minimum of one minute. If the trigger state is held for a duration that is less than the minimum, the detection of the anomaly may be missed by the minutely Batch Tracking process. Undetected anomalies can happen, for example, when the configured TRIGGERPOINT pulses for five seconds. To resolve issues with the TRIGGERPOINT's state length duration:

• Initially, determine if the configured telemetry point’s pulse length can be changed to at least one (1) minute

• Alternatively, create a manual shadow status point for the TRIGGERPOINT and have a Reflex point trigger on the original telemetered TRIGGERPOINT to start an Action Sequence.

  The Action Sequence steps, when started, will:

  • set the shadow status point to the required trigger state (for example, OPEN),

  • wait at least 60 seconds,

  • set the shadow status point back to a non-trigger state (CLOSED).

No.

GROUP

Group.

No. If not specified, group will be inherited from pipeline record.

DESCRIPTION

Description.

No.

SEVERITY

Severity of alarms issued against the detect record. The severity can be set to one of the following states:

• Low

• Medium

• High

No. Defaults to lowest severity possible.

INH

This field can be set to one or two states:

• True

• False

  If true, processing of record is inhibited.

No.

VDEADBAND

Two values are present:

3. Volume zone upstream of the detector location.

4. Volume zone downstream of the detector location.

   If the anomaly is detected outside of this zone, detection is early or late.

Note: VDEADBAND applies when the Anomaly Detect Type is set to Unspecified.

No. If not present both values default to zero (0). Zero disables this check.

AUTOLAUNCHRECEIVER

The point name of adetect of type Receiver.

No. If not present the value will be blank.

VNORMDETECT

Two values are present:

Upstream normal detection volume—positive value. The value should be less than the one for VELDETECT if specified and not exceed the segment linepack upstream of the adetect.

Downstream normal detection volume—negative value. The absolute value should be less than the one for VELDETECT if specified and not exceed the segment linepack downstream of the adetect.

Note: VNORMDETECT only applies when the Anomaly Detect Type is set to Detector or Receiver.
The order of the values entered is important. For example, 100 -100 is valid, but -100 100 is not valid.

No. If not present, both values default to zero (0). Zero disables this check.

VELDETECT

Two values are present:

Upstream early detection volume—positive value. The value should be greater than the one for VNORMDETECT if specified and not exceed the segment linepack upstream of the adetect.

Downstream late detection volume—negative value. The absolute value should be greater than the one for VNORMDETECT if specified and not exceed the segment linepack downstream of the adetect.

Note: VELDETECT only applies when the Anomaly Detect Type is set to Detector or Receiver.
The order of the values entered is important. For example, 200 -200 is valid, but -200 200 is not valid.

No. If not present, both values default to zero (0). Zero disables this check.

VNORMDETECTINH

This field can be set to one or two states:

• True

• False

  If True, alarms associated with detection within the VNORMDETECT window are inhibited.

No. Default is False.

VELDETECTINH

This field can be set to one or two states:

• True

• False

  If True, alarms associated with detection within the VELDETECT window are inhibited.

No. Default is False.

V2ELDETECTINH

This field can be set to one or two states:

• True

• False

  If True, alarms associated with detection outside the VELDETECT window are inhibited.

No. Default is False.

MISSETAINH

This field can be set to one or two states:

• True

• False

  If True, the alarm is inhibited when a detection occurs but there is no anomaly in the segment that can be associated with the detection (that is, no Estimated Time of Arrival (ETA) record is found for this anomaly).

No. Default is False.

MISSSIGNALINH

This field can be set to one or two states:

• True

• False

  If True, the alarm is inhibited when the anomaly leaves the late detection window without a signal.

No. Default is False.

TDEADBAND

Early time limit. If anomaly is not predicted to have arrived yet and estimated time of arrival for the anomaly is greater than this value, detection is early.

No. Default is zero (0). Zero disables this check.

EVTINH

This field can be set to one or two states:

• True

• False

  If True, alarm events are inhibited.

No. Default is False.

ALMINH

This field can be set to one or two states:

• True

• False

  If True, alarms are inhibited.

No. Default is False.

ANMTYPE

Type of anomaly to detect.

Yes. If not present an anomaly cannot be created to mark the early or late detection.

RECEIVEINH

This field can be set to one or two states:

• True

• False

  If True, the alarm is inhibited when an anomaly is received.

No. Default is False.

LAUNCHINH

This field can be set to one or two states:

• True

• False

If True, the alarm is inhibited when an anomaly is launched.

No. Default is False.

BMSG

This is the standard RealTime database (RTDB) field flag.bmsg. If ADETECTTYPE is set to Unspecified (for basic anomaly detection deadbands), use adetect. If ADETECTTYPE is set to Launcher, Detector, or Receiver (for enhanced anomaly detection deadbands), use adetectEnhanced.

No.