Occurrence
Provides flows with the ability to raise alarm state, update existing alarms and even run actions when an alarm state is cleared.
Actions
Occurrence
Action responsible for raising, updating and clearing alarm state based on a given match string UID.
Input
| Name | Description | Type | Required | Syntax |
|---|---|---|---|---|
| occurrenceMatchString | input | False | False | |
| lullTime | input | False | False | |
| lullTimeExpiredCount | input | False | False | |
| dbSlowUpdate | checkbox | False | False | |
| maxDuration | input | False | False |
Output
| Name | Description | Type | always_present | values |
|---|---|---|---|---|
| result | Returns True when successful. | boolean | True | {"True": {"description": "Successful."}, "False": {"description": "Failure."}} |
| rc | Returns the exit code for the action. | number | True | {"0": {"description": "Successful."}} |
Occurrence Update
Provides the ability to update variables held within the alarm objects data field.
Input
| Name | Description | Type | Required | Syntax |
|---|---|---|---|---|
| occurrenceVarData | json-input | False | False | |
| occurrenceIndex | input | False | False | |
| updateMode | input | False | False |
Output
| Name | Description | Type | always_present | values |
|---|---|---|---|---|
| result | Returns True when successful. | boolean | True | {"True": {"description": "Successful."}, "False": {"description": "Failure."}} |
| rc | Returns the exit code for the action. | number | True | {"0": {"description": "Successful."}} |
Occurrence Clean
Occurrence core functionality responsible for clearing raised alarms.
Output
| Name | Description | Type | always_present | values |
|---|---|---|---|---|
| result | Returns True when successful. | boolean | True | {"True": {"description": "Successful."}, "False": {"description": "Failure."}} |
| rc | Returns the exit code for the action. | number | True | {"0": {"description": "Successful."}} |