Elements of the flow - Trigger alarm
The element Trigger alarm, triggers an alarm in the organisation in which the flow is executed.
Configuration.
Basic configuration of the alarm.
1️⃣ Trigger in an existing event: By default, each new alarm also automatically creates a new event. This function allows you to trigger an alarm in an existing event. Thus, no new event is then created when the alarm is triggered.
Instead of the event name, it is mandatory to enter the event ID. Only in this way can a unique assignment be made.
2️⃣ Event name: Defines the name of the event when it is triggered. If the function Trigger in an existing event is active, this field becomes the input for the event ID.
The Input function (rectangular symbol to the left of the input fields) allows you to access functions where data can be obtained automatically, e.g. from previous elements.
3️⃣ Event Severity: Sets the severity of the event. You can define the severity level in the organisation settings.
4️⃣ Alarm text: Defines the alarm text for the alarm. The document icon to the right of the input field allows you to select a text template.
5️⃣ Alarm Mode: Makes it possible to define the alerting mode for the alerting.
Resources
Resources or participants to be alerted.
⚠️ At least one of the resources must be specified in order to trigger an alarm. A multiple selection is also possible.
1️⃣ Alert all participants: This function allows you to alert all participants of your organisation within the scope of the alarm.
2️⃣ Scenarios: Allows you to alert scenarios.
3️⃣ Units: Enables alerting of units.
4️⃣ Unit with external ID: Enables alerting of a unit using the external ID.
For documentation on units, see here.
5️⃣ Label: Enables the alerting of participants with certain labels and the desired headcount. Additional labels can be added via the Add Label button.
6️⃣ Participants: Allows specific participants to be alerted.
7️⃣ Alarm template: Enables alerting of alarm templates.
Additional information
1️⃣ Close event after: Allows you to have the alarm event automatically closed by the system after a defined time in seconds.
2️⃣ Address: If you enter the address in combination with the longitude and latitude, GroupAlarm can display the corresponding position on a map in the GroupAlarm App, the monitor or the reports.
3️⃣ Coordinate format: Specify the format of the coordinates. This is particularly helpful if the data is to be received from an external system that only supports a certain format.
4️⃣ Latitude and longitude: In addition to the address, the system requires the latitude and longitude in order to be able to display a position on the map.
💡 The fields for the address and coordinates are only visible if the geocoordinates extension has been activated in the organisation.
5️⃣ Document Key: Use the input field for the document key to enter the key for the corresponding documents in your document storage. These are then displayed to participants in the GroupAlarm App when an alarm is triggered. To do this, select the previously defined document key by clicking in the field. Use this field if you want to permanently assign the document key.
6️⃣ Name of document keys: The input function for the names of the document keys allows you to set document keys dynamically based on their names. This allows you to enter the names of the keys when triggering the flows.
Configuration.
Basic configuration of the alarm.
1️⃣ Trigger in an existing event: By default, each new alarm also automatically creates a new event. This function allows you to trigger an alarm in an existing event. Thus, no new event is then created when the alarm is triggered.
Instead of the event name, it is mandatory to enter the event ID. Only in this way can a unique assignment be made.
2️⃣ Event name: Defines the name of the event when it is triggered. If the function Trigger in an existing event is active, this field becomes the input for the event ID.
The Input function (rectangular symbol to the left of the input fields) allows you to access functions where data can be obtained automatically, e.g. from previous elements.
3️⃣ Event Severity: Sets the severity of the event. You can define the severity level in the organisation settings.
4️⃣ Alarm text: Defines the alarm text for the alarm. The document icon to the right of the input field allows you to select a text template.
5️⃣ Alarm Mode: Makes it possible to define the alerting mode for the alerting.
Resources
Resources or participants to be alerted.
⚠️ At least one of the resources must be specified in order to trigger an alarm. A multiple selection is also possible.
1️⃣ Alert all participants: This function allows you to alert all participants of your organisation within the scope of the alarm.
2️⃣ Scenarios: Allows you to alert scenarios.
3️⃣ Units: Enables alerting of units.
4️⃣ Unit with external ID: Enables alerting of a unit using the external ID.
For documentation on units, see here.
5️⃣ Label: Enables the alerting of participants with certain labels and the desired headcount. Additional labels can be added via the Add Label button.
6️⃣ Participants: Allows specific participants to be alerted.
7️⃣ Alarm template: Enables alerting of alarm templates.
Additional information
1️⃣ Close event after: Allows you to have the alarm event automatically closed by the system after a defined time in seconds.
2️⃣ Address: If you enter the address in combination with the longitude and latitude, GroupAlarm can display the corresponding position on a map in the GroupAlarm App, the monitor or the reports.
3️⃣ Coordinate format: Specify the format of the coordinates. This is particularly helpful if the data is to be received from an external system that only supports a certain format.
4️⃣ Latitude and longitude: In addition to the address, the system requires the latitude and longitude in order to be able to display a position on the map.
💡 The fields for the address and coordinates are only visible if the geocoordinates extension has been activated in the organisation.
5️⃣ Document Key: Use the input field for the document key to enter the key for the corresponding documents in your document storage. These are then displayed to participants in the GroupAlarm App when an alarm is triggered. To do this, select the previously defined document key by clicking in the field. Use this field if you want to permanently assign the document key.
6️⃣ Name of document keys: The input function for the names of the document keys allows you to set document keys dynamically based on their names. This allows you to enter the names of the keys when triggering the flows.
Updated on: 16/12/2024
Thank you!