Digital Alarm Block Fields

The following table lists the fields available for this block, what each field displays, as well as the valid entries for each field in the list.

The field...

Displays...

Valid Entry

A_AACK

A block and field name pair to use for alarm acknowledgment.

Block.field

A_ADI

The block's alarm areas.

N/A. This field is provided for backward compatibility.

A_ALMCK

The block's alarm condition.

None, Close, Open, or Change of State.

A_ALMEXT1
A_ALMEXT2

The text entered in the block's alarm extension fields.

Up to 79 characters.

A_ALMINTIME

The time and date at which the block generated the alarm.

N/A. This is a display only field.

A_ALMLASTTIME

The time and date at which the block last generated an alarm.

N/A. This is a display only field.

A_ALMOCCUR
F_ALMOCCUR

The number of times a block goes in and out of alarm before it is acknowledged.

N/A. This is a display only field.

A_ALMSHELFREMTIME

F_ALMSHELFREMTIME

The remaining time left for a shelved alarm. N/A. This is a display only field.

A_ALMSHELVED

F_ALMSHELVED

Indicates whether a specified alarm is shelved (YES/NO). N/A. This is a display only field.

A_ALMSHELVEPOLICY

The name of alarm shelving policy. N/A. This is a display only field.

A_ALMSHLVENAB

F_ALMSHLVENAB

Defines whether alarm shelving is enabled (YES/NO) for a block. N/A. This is a display only field.

A_IALMSHLVENAB

F_IALMSHLVENAB

The initial alarm shelving status (ENABLE/DISABLE) for a block. N/A. This is a display only field.

A_ALMSN

The serial number of the alarm area database.

N/A. This is a display only field.

A_ALM_SUSPENDMODE

F_ALM_SUSPENDMODE

Configures Event messaging (Suspend mode), which applies to the process alarm limit as an event.

Enable: Yes (1), or Disable: No (0).

A_AREA1 through A_AREA15

The alarm areas assigned to the block.

ALL or an alarm area name.

A_ASUSP

A block and field that controls whether the Digital Alarm block processes alarms.

NOTE: If you use this field, you subsequently cannot use the A_ENAB or F_ENAB field to disable or enable an alarm status. The A_ASUSP field takes precedence over the A_ENAB or F_ENAB fields.

Block.field

A_AUTO
F_AUTO

The current automatic/manual status of the block.

Automatic (1) or Manual (0).

A_CCALM

The digital block to close when an alarm occurs.

FIX32.node.block.field.

A_CCMOD

When to open the block's contact

Acknowledge, Return, All Clear, or Never.

A_CHALM

The chain's most severe alarm.

N/A. This is a display only field.

A_CLOSE

The first seven characters of the block's close label.

N/A. This field is provided for backward compatibility.

A_CLOSEDESC

Text in the block's Close field.

Up to 16 characters.

A_COMM_SURPRESS
F_COMM_SURPRESS

Sets whether COMM alarms are suppressed for this block.

When selected, this option separates the original alarm condition from the COMM alarm, and returns the block to the same state as it was prior to a COMM alarm. For example, if prior to the COMM alarm, the AA block was an active alarm but already acknowledged, that is the state it should return to after communication is restored.

If disabled, AA blocks handle one alarm at a time. As a result, it is possible that acknowledgement of a COMM alarm could cause the ACK bit in the PLC to be written, and the original alarm condition, if already acknowledged, could re-alarm.

Enable (1) or Disable (0).

A_CTK_PERSIST
F_CTK_PERSIST

Sets whether blocks allow write attempts to the contact(s) with every scan, even if the value being written is unchanged.

When disabled, the AA block only attempts to write to the defined contact tag when a value has changed and it needs to be written to the PLC. The write is a one-time attempt, so if it fails, the write will not be retried until the block needs to write a new value.

NOTE: There are four modes for the contacts - “Acknowledge”, “Return”, “All Clear”, and “Never” - that control when the contact is cleared. Since the contact mode of “Never” does not reset the contact, the Continuous Output option is not supported for this contact mode.

Enable (1) or Disable (0).

A_CUALM

The block's current alarm.

N/A. This is a display only field.

A_CV
F_CV

The block's current value.

A numeric value within the EGU range.

A_DALM
F_DALM

Whether to delete alarm from summary queue after acknowledgment.

0 (false) or 1 (true).

A_DELAY

The length of time to wait before generating an alarm.

Any time from 00:00:00:00 to 03:00:00:00 (up to 3 days, in the time format of  dd:hh:mm:ss).

A_DESC

The text in the block's Description field.

Up to 256 characters.

A_ENAB
F_ENAB

The block's alarm status.

NOTE: The A_ASUSP field takes precedence over the A_ENAB or F_ENAB fields. In other words, after you use the A_ASUSP field, you cannot use the A_ENAB or F_ENAB field to disable or enable an alarm status.

Enable: Yes (1), or Disable: No (0).

A_EOUT

Yes, if the block writes data to the process hardware or
No, if the block does not.

Yes or No.

A_ESIGACK
F_ESIGACK

Whether operators are allowed to acknowledge alarms for this tag without entering a signature, even if this tag requires electronic signatures for data entry.

Yes or No.

A_ESIGCONT
F_ESIGCONT

If allow continuous use is enabled for this tag.

Yes or No.

A_ESIGREQ_COMMENT

F_ESIGREQ_COMMENT

A comment is required when using an electronic signature.

Enable: Yes (1), or Disable: No (0).

A_ESIGTRAP
F_ESIGTRAP

Whether unsigned writes are accepted or rejected by this tag or accepted and logged.

ACCEPT, LOG, REJECT.

A_ESIGTYPE
F_ESIGTYPE

The signing requirements for this tag.

None, PERFONLY, or PERFVERI.

A_EVENT

The initial event messaging status.

N/A. This is a display only field.

A_HIST_COLLECT
F_HIST_COLLECT

Sets whether or not this block is under collection.

Yes (1) or No (0).

A_HIST_COMPRESS
F_HIST_COMPRESS

Sets whether or not compression is used by the Collector.

Enable (1) or Disable (0).

A_HIST_COMPTIME
F_HIST_COMPTIME

The Collector compression time out.

A positive numeric value (0 or greater), in milliseconds.

A_HIST_COMPTYPE
F_HIST_COMPTYPE

The type of Collector deadband setting.

Absolute (0) or Percentage (1).

A_HIST_DEADBAND
F_HIST_DEADBAND

The Collector deadband setting.

A positive numeric value (0 or greater).

A_HIST_DESC

The Proficy Historian description.

String; maximum of 128 characters.

A_HIST_INTERVAL
F_HIST_INTERVAL

The collection interval for this block. The value of this field must be greater than the value of the A_HIST_OFFSET and F_HIST_OFFSET fields.

Use the following formula to determine if the entered value is acceptable for this field.

A_/F_HIST_INTERVAL > A_/F_HIST_OFFSET * 1000

NOTE: The values for the A_HIST_OFFSET and F_HIST_OFFSET fields are in seconds.

A float value, in milliseconds. Values must be entered in increments of 100. Minimum value: 100 ms.

A_HIST_OFFSET
F_HIST_OFFSET

The collection offset time. The value of this field must be less than or equal to the value of the A_HIST_INTERVAL and F_HIST_INTERVAL fields.

Use the following formula to determine if the entered value is acceptable for this field.

A_/F_HIST_OFFSET ≤ A_/F_HIST_INTERVAL / 1000

NOTE: The values for the A_HIST_INTERVAL and F_HIST_INTERVAL fields are in milliseconds.

A numeric value, in seconds. Must use whole numbers.

A_HIST_TIMERES
F_HIST_TIMERES

The collection time resolution.

Milliseconds(0) or Seconds (1).

A_IAM

The initial Automatic/Manual status of the block.

Automatic or Manual.

A_IENAB

The initial alarm status.

N/A. This is a display only field.

A_INV

Yes, if the block inverts its output value or
No, if the block does not invert its output value.

Yes or No.

A_IOAD

The block's I/O address.

Depends on your driver. Refer to your driver manual for more information.

A_IODV

The name of the block's I/O driver.

Depends on your driver. Refer to your driver manual for more information.

A_IOHT

The I/O driver's hardware options.

Depends on your driver. Refer to your driver manual for more information.

A_ISCAN

The initial scan status (on or off) of the block.

On or Off.

A_LAALM

The block's most severe unacknowledged alarm. If no unacknowledged alarm exists, the current alarm is displayed.

N/A. This is a display only field.

A_NALM F_NALM

Yes or 1, if the block has unacknowledged alarms or
No or 0, if the block has no unacknowledged alarms.

N/A. This is a display only field.

A_NAME

The block's type, for example AI for an Analog Input block.

N/A. This is a display only field.

A_NAREA

Enters a new alarm area in the alarm area database.

N/A. This is a write only field.

A_NEXT

The name of the next block in the chain.

N/A. This is a display only field.

A_OPCLIMIT

The hardware options of the OPC server.

N/A. This is a display only field.

A_OPCQLTY

The quality status of the OPC server.

N/A. This is a display only field.

A_OPCSUBSTAT

The quality substatus of the OPC server.

N/A. This is a display only field.

A_OPCTIME

The time and date from the OPC server.

N/A. This is a display only field.

A_OPEN

The first seven characters of the block's open label.

N/A. This field is provided for backward compatibility.

A_OPENDESC

Text in the block's Open field.

Up to 16 characters.

A_PDR_ACCESSTIME
F_PDR_ACCESSTIME

Reserved. N/A.

A_PDR_ARRAYLENGTH
F_PDR_ARRAYLENGTH

Reserved. N/A.

A_PDR_DEADBAND
F_PDR_DEADBAND

Reserved. N/A.

A_PDR_DISABLEOUT
F_PDR_DISABLEOUT

Reserved. N/A.

A_PDR_LATCHDATA
F_PDR_LATCHDATA

Reserved. N/A.

A_PDR_UPDATERATE
F_PDR_UPDATERATE

Reserved. N/A.

A_PREV

The name of the previous block in the chain.

N/A. This is a display only field.

A_PRI

The block's alarm priority.

Low, Medium, or High.

A_PRIM

The block's name.

N/A. This is a display only field.

A_REALM

The length of time to wait before re-issuing an alarm.

Any time from 00:00:00:00 to 03:00:00:00 (up to 3 days, in the time format of  dd:hh:mm:ss).

A_SA1
through
A_SA3

The security areas assigned to the block.

Up to three security area names.

A_SCAN

The on/off scan status of the block.

On or Off.

A_SCANT

The block's scan time and phase.

E for exception-based processing, 0 for one shot processing, or time:phase for time-based processing.

A_TAG

The block's name.

N/A. This is a display only field.

A_WARM

Yes or No.

N/A. This is a display only field.

A_ALMACK
F_ALMACK

Reserved. N/A.

A_ALMCHANGE
F_ALMCHANGE

Reserved. N/A.

A_ALMDELETE
F_ALMDELETE

Reserved. N/A.

A_ALMGEN
F_ALMGEN

Reserved. N/A.

A_ALMRESET
F_ALMRESET

Reserved. N/A.

A_ALMUPDATE
F_ALMUPDATE

Reserved. N/A.

A_PUBLISH
F_PUBLISH

Reserved. N/A.

A_WRITABLE
F_WRITABLE

Reserved. N/A.