alarm-PrinterRecipient

This component can be used to print alarms to most types of printers (including laser printers) attached to a station running on a Windows platform, or to remote (networked) printers known to its Windows OS. It is available in the Recipients folder of the alarm module palette.

PrinterRecipient differs from the older LinePrinterRecipient component, originally intended to work only with line printers, where alarms print without a new page feed on each alarm, and the native font of the target printer is always used.

Like the LinePrinterRecipient, PrinterRecipient applies to Windows hosted stations only. The printer must be known to the host platform’s Windows OS and selected from the printer drop down-list. Alerts may be generated if the printing of an alarm fails, but the printer recipient does not print alarms that it generates itself.

The main differences between the LinePrinterRecipient and PrinterRecipient are additional font property settings, which allow the selection of font type, size, and various style overrides. Combined with multi-line alarm message text properties that are available in various alarm extensions, the PrinterRecipient provides flexibility for alarm printing.

Image
Property Value Description
Time Range Start Time and End Time [hours of the day (defaults to 24 hours)]
Specify when during the day (start and stop times) this recipient receives alarms.
Days of the Week or Days of Week check boxes
Specifies the days of the week to include.
Transitions drop-down list
Selects which alarm transitions to display in the console. Only those transitions selected display although the station saves all transitions in alarm history.

Options are: toOffnormal, toFault, toNormal, toAlert

Route Acks true (default) or false
Enables (true) and disables (false) the routing of alarm acknowledgements to the recipient. The framework does not route trap (event notification) acknowledgements if you select false.
Printer drop-down list
Shows the printers that are available (both locally attached and remotely networked) through the host platform’s Windows operating sys on the first line.
 NOTE: For more information about how to format this information, click on the help icon to the right of the field. 
tem.
Print Format text
Defines the print format. These field definitions determine what prints for each alarm beginning with the Source.

Source: %alarmData.sourceName% prints the name of the entity that is responsible for generating the alarm on the first line.

For more information about how to format this information, click on the help icon to the right of this property.

Timestamp: %timestamp% prints the time the alarm occurred on the second line.

State: %sourceState% / %ackState% prints the current alarm state on the third line.

Priority: %priority% prints the alarm priority on the fourth line.

Alarm Class: %alarmClass% prints the alarm class on the fifth line.

Text: %alarmData.msgText% prints any text associated with the alarm on the sixth line.

Alert On Failure true (default) or false
Enables (true) and disables (false) the generation of an alert if the printer fails to print an alarm.