Apama Analytics Builder 10.7.0 | Using Apama Analytics Builder for Cumulocity IoT | Block Reference | Input | Alarm Input
 
Alarm Input
apama.analyticskit.blocks.cumulocity.AlarmInput
Receives Alarm objects from a device or device group and reorders them based on the timestamp.
If the Alarm Status is "Active" then the Alarms are re-ordered based on timestamp (and dropped if too old), unless Ignore Timestamp is set. Otherwise, data is processed as it is received.
Note: when running in simulation mode, because only the Alarm's created time is stored, Alarm Status must be "Active".
Parameters
Name
Description
Type
Notes
Alarm Type
The alarm type for which the block will listen.
string
Device or Device Group
The device or device group from which the alarm has been received.
The model editor uses the current device or asset name. This is mapped internally to the inventory identifier.
string
Severity
The severity of the alarm. If not specified, the block will listen for all alarm severities.
Option - one of:
*Critical
*Major
*Minor
*Warning
Optional
Alarm Status
The status of the alarm. If not specified, the block will listen for alarms with any status.
Option - one of:
*Active
*Acknowledged
*Cleared
Optional
Ignore Timestamp
If selected, the timestamp of the incoming alarm is ignored. Note: when running in simulation mode, because historical input data is used, timestamps are not ignored.
boolean
Default: false
Output Port Details
Name
Description
Type
Alarms
Generates a pulse output for each Alarm object received, with extra properties.
pulse