Alarm Output
apama.analyticskit.blocks.cumulocity.CreateAlarm
Creates a new Alarm object for a specified device or for the current device with a pre-configured alarm name and parameters.
This block produces synchronous output. The parameters that define the output stream are "Device or Trigger Device" and "Alarm Type". Using another instance of this block with the same output stream is not allowed.
If createAlarm is provided repeatedly, then the count of the alarm is increased (unless it has been cleared). If the severity or status inputs are used and have changed, then the count is not increased - the existing alarm is modified instead.
Parameters
Name | Description | Type | Notes |
Device or Trigger Device | The device (or for models handling groups, Trigger Device) that the alarm is associated with. The model editor uses the device name. This is mapped internally to the device identifier. | any | |
Alarm Type | Identifies the type of this alarm, for example "com_cumulocity_events_TamperEvent". | string | |
Message | The text that is displayed if the alarm is triggered. The message is set either by parameter or input. If both are not set, the model name is used. You cannot set both. | string | Optional |
Severity | The severity of the alarm. The severity is set either by this parameter or the input port. You must set only one of them. | Option - one of:  Critical Major Minor Warning | Optional |
Input Port Details
Name | Description | Type |
Create Alarm | Creates an alarm when a signal is received. | pulse |
Clear Alarm | Sets the alarm status to CLEARED if true. | boolean |
Severity | The severity of the alarm - should be one of the severity values (WARNING, MINOR, MAJOR, CRITICAL) or CLEARED. | string |
Message | The message for the alarm. | string |
Time | The timestamp of the alarm. | float |