Analytics Builder 10.14.0 | Using 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 parameter is Active, then the alarms are reordered based on the timestamp (and dropped if they are too old), unless the Ignore Timestamp parameter is set. Otherwise, data is processed as it is received.
The parameters that define the input stream of the block are "Device or Device Group" and "Alarm Type". If this block is configured with the same "Device or Device Group" and "Alarm Type" parameters as an Alarm Output block in another model, then a connection between the models is formed, as each block refers to the same stream of Alarm objects.
Note: When running in simulation mode, because only the creation time of the alarm is stored, the 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
Notification Mode
Filters Alarm events such that only new alarms, updated alarms, or all alarms are processed. The default is that all alarms are processed.
Option - one of:
*All
*Updates only
*New alarms only
Default: All
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