Flows
The flows in GroupAlarm are a powerful tool for depicting and automating individual functions and processes. From the automated sending of reports or messenger messages to the connection of interfaces, many things are possible. The individual elements of the flow give you the flexibility you need. If you have an idea for a function in GroupAlarm, it is quite possible that it can be realised with the flows.
Table of contents
[Introduction FlowPopularMessenger
Messenger
| GroupAlarm Messenger allows direct and secure communication between the users of an organization via the mobile apps.
By default, each organization gets a room with the same name, which contains all users of the organization and is automatically kept in sync with them.
Dedicated rooms
Dedicated rooms are ideal to give subgroups, teams, or committees a simple communication channel.
The overview of all rooms is located in the menu under "Administration" > "Messenger" andPopularElements of the flow
Trigger
Triggers are events that can start a flow.
Name Description
Alarm triggered This trigger starts a flow when an alarm has been triggered in the organisation.
Alarm closed This trigger starts a flow when an alarm in the organisation has been closed.
| Cron trigger | This trigger startsPopularElements 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 maSome readersELS: iSE-Cobra 4
ELS: iSE-Cobra 4
| This module is an optional extension and must be activated first.
In addition to the webin.php interface, GroupAlarm can also be used with the mission control system iSE-Cobra 4 via the WDX3 interface.
For this, you have to specify a login server, generate client certificates as well as create corresponding service credentials. Only then can a secure connection to the ELS be established.
In addition, you must configure several kSome readersHotline
| 💡 This module is an optional extension and must be activated first.
With GroupAlarm you can start, manage and monitor a dynamic first responder hotline in a few steps.
How it works
You create a new hotline and automatically get assigned a phone number from your local area network. You now assign any number of agents to this hotline in the form of subscribers from your organization. These agents maintain their phone numbers tSome readersPager management
Pager management
This module is an optional extension and must be activated first.
In the pager management you can view statistics about your pagers, manage them as well as register new pagers.
Under "Statistics" the percentage of availabilities and the number of pagersSome readersPermissions
In the "Permissions" menu, you can configure access permissions and assign them to participants. In addition, you can generate API keys that can be used with third-party systems.
Roles
In the Roles tab, permission roles can be created and assigned to participants.
Such a permission role assigns certain permissions to the various GroupAlarm functions, such as participants, alarms or remote triggering.
The default roles Organization owner, Organization Administrator, ParticipantsSome readersExtentions
GroupAlarm can be supplemented with additional functions in the area of alerting and administration within your organisation through extensions. These extensions allow you to expand GroupAlarm according to your personal needs without overloading your interface with unnecessary functions.
| 💡 Extensions can be added under Admin → Extensions. There you will also find a list of all active extensions in your organisation.
To add an extension, please select the button of the same name. You will theSome readersElements of the flow - Check for string
The Check for string element is a Yes / No query that checks a given text for a defined string. If the string is found, the flow continues on the Yes path, whereas the No path is followed if the string is not found.
||| ❗️ If you move or delete the elements Check for string or Check for one or more strings, only the subsequent elements on the Yes pathSome readersElements of the flow - Send email
The element Send email allows you to automatically send an email from within the flow. For example, the alarm details or the alarm report for an alarm can be sent.
Configuration
1️⃣ In the input field for the recipient, you can add participants who will then receive the e-mail to the e-mail address stored in the system. Alternatively, e-mail addresses that do not exist in GroupAlarm can be stored directly.
2️⃣ The input field for the subject defines the subject of the e-mail. As an e-maSome readersElements of the flow - Send messenger message
The send messenger message element allows you to automatically send a message to the Messenger of the GroupAlarm app. This way, for example, additional information can be transferred to the emergency personnel.
Details about the Messenger and the individual rooms can be found here.
Configuration
1️⃣ The selection field for the room allows you to select a permanent messenger room in which the message is to be sent.
2️⃣ As an alSome readersElements of the flow - Merge strings
The merge strings element is used to combine certain results from previous elements or simple text into a new string. This merged string can then in turn be reused as a value in subsequent elements.
1️⃣ Input field
In the input field, the actual joining of the strings takes place. For this purpose, variables can be defined by entering them as text and masking them with % characters before and after the variable name (%Variable%). In addition to variables, simple text can also be used here to cSome readersRemote Trigger
GroupAlarm has the option of triggering an alarm via call or SMS.
For this purpose, a phone number has to be activated in the menu Remote Trigger and a triggering PIN has to be defined. Only if the triggering number and PIN match the data stored here, an alarm can be triggered.
| 💡 This module is an optional extension and must be activated first.
Call
To create a new trigger, enter the phone number in the format 0044123456789 and select a PIN (min.Some readersElements of the flow - Tag triggered
The trigger element Tag triggered can be used to start a flow automatically when a defined tag is triggered in the parent organisation.
| 💡 The tag does not have to be defined as an incoming tag in a scenario.
Configuration
1️⃣ In the selection field for the incoming tag, you can define the tags for which the flow is to start. It is possible to select several tags. The flow starts as soon as one of these tags is triggered.
![](https://storage.crisp.chat/users/helpdesk/website/91fefd8bSome readersElements of the flow - email received
The email received element can be used to start a flow when an email is sent to the email address generated in the element.
Configuration
1️⃣ The email address to which the email can be sent is created automatically by the system and can be taken from here.
2️⃣ Email addresses can be entered in the input field for the authorised senders, which are then used as the only authorised senders. In addition to the manual entry of email addresses, participants can also be selected. The email adSome readersElements of the flow - Alarm triggered
The trigger element Alarm triggered starts a flow as soon as an alarm has been triggered in the organisation.
With the exception of the name, which can be optionally assigned to the element, no configuration is necessary.Some readersSupport
Support
In the support section, you can find all options to contact our customer support.
By default, our support staff does not have access to your organization. We can assist you more efficiently with potential problems if you grant our team full access to your system. To do this, click the "Grant Access." buttonSome readersBilling
Billing
In the billing interface, you can manage your stored billing address and payment method.
Setup
All organizations need to have a billing method set. As a sub-organization, you can have your parent organization manage the billing, or you can set up your own payment method.
By clicking on the "Set up billing" button, you can store a new payment method. To do this, log in with an existing customer account. Alternatively, you can create a new customer account.
| An e-mail address lSome readersElements of the flow - Alarm closed
The Alarm closed trigger element starts a flow as soon as an alarm in the organisation has been closed. An alarm is closed if this is done manually in the alarm itself, as well as automatically if all positions in the alarm have been successfully filled or no further participants are available for an alarm.
With the exception of the name, which can be optionally assigned to the element, no configuration is necessary.
![](https://storage.crisp.chat/users/helpdesk/website/91fefd8b4b0ac000/flowalSome readersQuotas
Quotas
An organization's quotas limit the number of times a specific service, such as flows, can be executed. This highly set limit prevents accidental overuse of a service, which can lead to unexpectedly high costs in the billing process.
All of your organization's quotas can be found under "AdministratSome readersConnections - WDX3
Under Connections, you have the option of adding and managing connections to external interfaces. For example, you can connect the iSE-COBRA operations control system to GroupAlarm via the WDX3 interface. A corresponding trigger is available in the flows, which can accept and process the data from the WDX3 interface.
| 💡 Using this connection requires knowledge of WDX3.
In addition to WDX3, connections for MQTT and [IMAP](htSome readersFlow example - Send messenger message
A flow can be used to automatically send messages to the app's messenger. In our example, we send a message with additional information to an event-related messenger room.
Other triggers such as Email received or [DWD weather warning](https://docs.groupalarm.com/en/article/elements-of-the-flow-dwd-weather-warSome readersFlow example - Close event
To avoid having to close events manually, this can be done with a simple flow that closes events automatically after a set time.
The structure of the flow for the automated closing of events consists of the trigger element Event triggered, a Waiting element and the [Close event](https://docs.groupalarm.com/en/aFew readersElements of the flow - DWD weather warnings
The trigger DWD weather warning starts a flow when the German Weather Service issues a weather warning that meets the defined criteria.
The following objects can be used in the further course of the flow:
Internal alert ID
ID of the affected region
Name of affected region
State
State abbreviation
Start time
End time
Weather warning
Warning level
Event name
Headline
Description
Instructions
|| ⚠️ The objects contain data directly from the German Weather Service. ItFew readersElements of the flow - IMAP Email Trigger
The IMAP Email Trigger can be used to start a flow when a new email is received in the specified mailbox.
The mailbox itself is configured under Admin → Connections. You can find the documentation on IMAP connections here.
In the trigger, you then simply need to select the relevant connection.Few readersArrival time at the organization location is not displayed
Arrival time at the organization location is not displayed
In order for an arrival time to be determined and displayed, the following must be true:
The organization has a location set up ("Organization Settings" > "Location").
The app is running version 2.0.0 or higher
The app has the necessary permissions to retrieve the locationFew readersElements of the flow - Waiting
The Waiting element is used to force a pause in the flow. The flow then remains in the Waiting element for the defined period of time and only executes the subsequent elements afterwards. Examples for the use of the Waiting element would be the automated closing of events or time-delayed notifications to third parties such as press representatives.
Configuration
1️⃣ The amount of time the flow should stay in the element can be defined in seconds.
 the name can also be obtained automatically from previous elementsFew readersDocument storage
The document storage allows you to upload files to GroupAlarm so that they can be made available to participants in the context of alarms, for example. One possible application example would be site plans.
As an administrator, you can find the document storage under Admin ⇾ Documents.
The documentation to manage your document storage optional via the GroupAlarm API interface can be found here.
Participants can view the document storageFew readersAudit
Audit
The audit log lists all important events within your organization. This includes, for example, the creation and editing of elements, the addition, and removal of users and much more. If available, it displays the responsible trigger, the affected resource, the event itself, and the time.
Possible triggers of an event can be a person user, a flow or a vpn_key API access by an organization token. ![](https://storage.crisp.chat/users/helpdesk/website/606406d8d6f6d000/7eb11125-2f6bFew readersPausable Labels
Labels that can be paused allow participants to manage assigned labels themselves to a limited extent. For example, a participant who has the qualification and the label SCBA can pause this label if he is not in a position to perform the task due to health reasons. He will then not receive any further alarms for the label. Alarms for other labels that have not been paused remain unaffected by this and take place as usual.
Setting up and managing pausable labels
1️⃣ When creating or editFew readersElements of the flow - Close event
With the Close event element, events can be closed automatically.
||| ❗️ It is highly recommended to always combine the Close event element with a preceding Waiting element and a suitable time period. Otherwise, the flow will immediately close an event, which may result in not filling all positions in an alert or make it impossible for participants to provide feedback in response to an alert.
Configuration
1️⃣ In order for the flow to close a corresponding event, it is mandatory to speciFew readersElements of the flow - Websocket Trigger
With the Websocket Trigger, a flow can be started as soon as new data is received via a Websocket interface such as KATSYS. The received data can then be further processed, e.g. with a parser, to trigger alarms in the organisation.
Configuration
1️⃣ Defines the URL of the interface.
2️⃣ Via Add header-field, header information can be added, such as an API token for authentication.
3️⃣ In addition to the header fields, own CA certificates as well as a client certificate including key caFew readersElements of the flow - HTTP trigger
The HTTP trigger triggers a flow when an HTTP call is made to the URL generated in the element.
⚠️ The use of the HTTP trigger and in particular the optional components requires knowledge of URL and query strings.
Configuration
1️⃣ The URL that must be called to start the flow can be found in the field highlighted in blue.
2️⃣ Optionally, further information can be transmitted with the URL. In the selection field for the input, you can specify whether this information is to be obtainedFew readersElements of the Flow - Text Parser
The text parser allows you to process character strings. Values can be extracted from the character string and saved as variables, which can then be used later in the flow.
For example, a certain passage can be filtered out of the text of an e-mail in order to be able to use it later as an alarm text when an alarm is triggered.
Regular expressions are available as a tool for extracting the appropriate passagesFew readersCreate / edit flow
As described in detail in the previous article "Introduction Flows", please first click on "Create Flow" in the overview of flows. If you want to edit an existing flow, click on the three dots on the right side of the flow and select "Edit".
The mask for editing a flow is as follows.
1️⃣ Name and description
On the right side, you can enter a name for the flow and an additional description (_IllustratiFew readersElements of the flow - HTTP Client
The HTTP Client allows you to submit HTTP requests.
| 💡 The HTTP Client requires basic knowledge of handling HTTP requests.
Configuration
1️⃣ The HTTP method selection field allows you to specify the desired HTTP method.
2️⃣ The URL can either be entered manually or taken from previous elements using the input function (rectangular symbol on the left). The element Merge strings is suitable for this.
3️⃣Few readersElements of the flow - Event closed
The element Event closed starts a flow as soon as an event has been closed in the organisation. An event can be closed manually or automatically via a flow. See the element Close event.
With the exception of the name, which can be optionally assigned to the element, no configuration is necessary.Few readersElements of the flow - Event triggered
The trigger element Event triggered starts a flow as soon as an event has been created in the organisation. Among other things, events are created automatically, when an alarm has been triggered. Each alarm must be within an event.
With the exception of the name, which can be optionally assigned to the element, no configuration is necessary.Few readersElements of the flow - Send fax
The element Send Fax allows you to send a PDF as a fax from the flow. An example would be to send the alarm details. These can be included via the element Merge strings.
Configuration
1️⃣ One or more phone numbers can be stored in the input field for the recipient.
|| ⚠️ Please note the correct format of the phone number. See the example below the input field.
2️⃣ In the input field for the PDF, eitherFew readersElements of the flow - Cancel event
Allows the automated cancellation of events.
When an event is cancelled, the event and all alarms it contains are closed. The emergency forces are informed via the app and in any event-related messenger rooms. And the incident log receives a corresponding entry before it is closed.
Configuration
1️⃣ In order to be able to identify the event that is to be cancelled, the flow requires either the event ID or the external ID of the event. Both can be obtained from previous elements via the inFew readersEvent severity
The Event severity in GroupAlarm allows you to define the criticality of an event. To do this, you can define under Configuration → Alerting → Severity levels up to 10 different severity levels in the organisation settings. For optimum differentiation, you can name each severity level individually and assign a suitable icon and colour. The name and icon are then displayed to participants in the alarm, for example, as a correspondingly coloured badge.
| 💡 To add an icon, click on the plaFew readersElements of the flow - Load alarm
With the Load Alarm element, alarm details can be loaded during the runtime of a flow. In this way, updated details can be retrieved. An example of this would be whether an alarm was successful.
Configuration
For configuration, only the alarm ID is required. This can be obtained from previous elements via the input function (rectangular symbol).Few readersElements of the flow - JSON parser
The JSON Parser can be used to link data from a JSON object with variables in GroupAlarm. The variables can then be used in subsequent functions of the flow.
|| The use of the JSON Parser requires knowledge of handling JSON objects.
Configuration
1️⃣ The JSON object from which the data is to be retrieved is specified in the JSON:Input function. This can also be retrieved from previous elements, such as the HTTP trigger.
2️⃣ The variable name to be used for the data in GroupAlarm iFew readersElements of the flow - Conditional variable
The element conditional variable allows you to create variables to use them in the further course of the flow. In contrast to the variables that you can create, for example, in the context of the element merge strings or a parser, here the values of the variables can be linked to conditions.
Configuration
1️⃣ First, you aFew readersElements of the flow - Trigger tag
The element Trigger tag allows the automated triggering of tags and the associated scenarios of the sub-organizations. The tag that is to be addressed must exist in the organization in which the flow is executed.
Details about tags can be found here.
Configuration
1️⃣ The tag selection field allows you to specify the tag. As an alternative to selecting the tag directly, you can use the input function (rectangular icon) to get the ID of the tag from previous elements.
2️⃣ The input fielFew readersElements of the flow - JSON string
The JSON String element can be used to create a JSON string as part of the flow.
Configuration
1️⃣ The input field allows you to map the JSON string. To do this, you can define variables similar to the Merge strings element, which are then filled with corresponding values from the flow. The variables must be escaped with % before and after the variable name.
2️⃣ This is where the variables are filled. Data from previous elements can be retrieved via the input function (rectangular sFew readersElements of the flow - Send a message to pager
The element 'Send a message to pager' allows you to automatically transmit a message to a pager. In this way, for example, additional information can be transferred to the emergency services.
Configuration
1️⃣ In the input field for the pager, you can specify the device that is to be addressed.
|| ⚠️ Note that pagers must have been added in the pager management beforehand.
2️⃣ The message to be sent can then be specifiedFew readersOrganisation settings - Alarm settings
Under the Alarm settings, you can define general settings for the alarm process.
1️⃣ You can use the Participants booked in an event can be alerted again function to specify that participants are always alerted, even if they are bound in an open event.
If this setting is deactivated, participants are not available for further alarms if they have given a positive response in an open event. This means that participants who are in an operation are not alerted unnecessarily. The participantsFew readersElements of the flow - Connection status changed
The Connection status changed trigger allows you to start a flow as soon as the status of one of your connections such as WDX3 changes. You can then, for example, notify selected people about the incident during the course of the flow with Send email or Send messenger message. The type, name and status of the respectivFew readersElements of the flow - Check for one or more strings
The element Check for one or more strings is an extension of the element Check for string and allows checking text for multiple strings. Not only can the string to be searched be different, but also different texts can be searched.
The check itself is a YES / No query. If the string is found, the flow continues on the Yes path, whereas the No path is followed if the string is not fFew readersElements of the flow - Format alarm
The Format alarm element can be used to summarise alarm details in a character string so that they can be used later on during the flow. The element is used in particular to output the number of acknowledgements. For example, these can be sent as an e-mail with a time delay using the Send e-mail element.
| The other details available for selection, such as Start time, Event etc., can alteFew readersQuick-Actions
Use an organization's Quick Actions to quickly trigger a pre-made alert using tags or an alert template with just a few clicks. Note that to use tags within the Quick-Actions, you must have the Alerting sub-organisations extension enabled.
Please note the necessary permissions for the configuration and use of Quick-Actions within the organization, if they are to be used - besides the organization administraFew readersElements of the flow - Search event
The Search event element can be used to find existing events that originate from previous flow executions, for example. If an event is found, it can be used in the further course of the flow. This way, it is possible to check whether an event already exists with the same event name. If this is the case, further alarms could be triggered in the existing event instead of creating a new one.
Configuration
1️⃣ The Search by ... selection field can be used to specify whether the event to bFew readersCreate / edit flow old
Create / edit flow
The flow builder is used to create a flow. You can open it by either creating a new flow or editing an existing flow.
If you create a new flow, you will land on the following page:
Here you see only a dashed circle at the top, which is a placeholder for a trigger. Triggers are the starting point for every flow. To begin, drag any trigger from the function box at the bottom right ontFew readersElements of the flow - XML parser
The XML parser can be used to process XML input and save the data in variables, which can then be used later in the flow.
|| The use of the XML parser requires knowledge of XML objects.
Configuration
1️⃣ The XML object to be used for processing can be specified in the XML: Input function. This can be obtained from previous elements.
2️⃣ The book symbol on the right-hand side can be used to insert templates that already contain predefined variables.
3️⃣ To define a variable, the naFew readersOrganisation settings - Unit status
Under Unit status you can define the statuses in which units of your organisation can be present. You have the option of customizing the statuses according to your requirements.
A status defined in this way can then be assigned to a unit manually during processing, as part of a flow with Set unit status or automatically via anFew readersElements of the flow - WDX3 Trigger
The WDX3 Trigger starts a flow when an Operation Service event is received from ISE Cobra. To be able to use the trigger, you must first establish a connection to the respective server under Admin ⇾ Connections. How to do this is described in the following article.
1️⃣ You can name the triggers using the Name field. This can be particularly helpful if you are using multiple connections and therefore multiple flows with differentFew readersOrganisation settings - Avatar
You can give your organisation a personal touch with the avatar. For example, you can use your organisation's logo or a picture of your fire station. Among other things, the avatar is displayed in the GroupAlarm App for alarms.Few readersOrganisation settings - Time zone
Time zone allows you to specify the time zone to be used by your organisation. This affects the time specifications for appointment invitations and PDF reports such as alarm reports.Few readersFlow insights / Error diagnosis
The insights provide you with information about the individual runs of a flow. This makes the Insights ideal for error analysis in the event of undesirable behavior in a flow.
You can access the insights from the overview of the flows via the three dots on the right of the respective flow (see "Introduction flows"). Or alternatively from the Edit view of a flow via the "Flow Insights" button in the upper rigFew readersConfigure Flow: XML parser
Configure Flow: XML parser
To use data from an XML document within the flow, you can use the XML parser to specify your own variables, which are searched for and saved in the transferred XML document.
| For frequent use, we offer ready-made configurations as templates, which you can select by clicking on the book symbol.
Each variable receives a user-defined name and the path to the desired data in the XML document.
|| Use only ASCII characters for the variable name.
In addition, youFew readersFlow export / import
To make work easier when interacting with several organisations, it is possible to export a flow and then import it again in another organisation.
||| ❗️ Please note that personal information is also exported during an export. Therefore, before exporting, make sure that the flow only contains information that you actually want to share.
1️⃣ To export a flow, please click on the three dots on the right side of the flow in the flow overview (Picture 1). The corresponding flow will then be avaiFew readersOrganisation settings - Invitations
You can use the settings for Invitations to make adjustments that affect the process of inviting participants to your organisation.
To better protect the security of your organisation's data from unauthorised access, you have the option of obliging the participant to set up two-factor authentication for their personal user account. It will then not be possible for the participant to join witFew readersOrganisation settings - Delete
Deleting an organisation completely removes the organisation and all stored data from GroupAlarm.
To delete an organisation, the following three conditions must be met:
The organisation must have been cancelled beforehand. You can perform the cancellation under Admin ⇾ Billing. Details can be found here.
The last billing period after the cancellation must have elapsed.
The organisation must not have any affiliatedFew readersOrganisation settings - SMS settings
With the SMS settings, you have the option of defining a format for the alarm via SMS. You can choose whether the SMS should contain the Event name + Alarm text or just the Alarm text. As SMS messages can have a maximum length of 160 characters for technical reasons, several SMS messages are automatically sent for longer texts. As this is associated with higher costs, you also have the option of truncating the text at 160 characters for both formats.
||| ❗️ If you allow GroupAlarm to liFew readersOrganisation settings - Override tag trigger
| 💡 The setting Override tag trigger is only visible if you have added the extension Alerting of sub-organisations under Admin ⇾ Extensions.
By default, an alarm via tag is triggered with the alarm text that was transferred in the parent organisation. If you want to adapt this alarm text for certain organisations, you can store a fixed text in the organisation settings of the respective sub-organisation. This text replaces the alarm text that was transferred. This can be useful if, forFew readersConfigure Flow: HTTP trigger
Configure Flow: HTTP trigger
With this trigger, a flow can be triggered by executing an HTTP call to the stored URL.
The URL is generated automatically and can only trigger this flow.
You can use the common HTTP methods 'GET', 'POST', 'PUT', 'PATCH' and 'DELETE'. The following entities are available for the following functions in the flow:
HTTP method used
Header (list)
Query Parameters (List)
Body (Base64 Encoded)
Protocol used
IP and port of the sender
Since you cannot use lisFew readersConfigure Flow: Text Parser
Configure Flow: Text Parser
To be able to use values contained in a text as variables in the flow, you need the text parser.
With this, you can search directly for a so-called "key" and save the subsequent text of the same line as a variable.
The basic functioning is explained with the following text:
`Hello GroupAlarm,
I would like to trigger an alarm with the following parameters:
Event: TESTALARM
Alarm text: TEST Do not move out!
LONG##50.76382
LAT##6.0793028
Address: GoethestraßFew readersOrganisation settings - Override escalation
By default, participants define the escalation of their devices themselves in their profile. With Override escalation, you can override this participant-specific escalation explicitly for your organisation.
|| ⚠️ As long as an escalation has been defined in the organisation settings, this always overwrites the participant's escalation for alarms in this organisation.
1️⃣ The available devices are listed under `Set esFew readersIMAP Trigger
Configure flow: IMAP Trigger
With the IMAP Trigger, you trigger a flow when an e-mail is received in the configured mailbox.
The following information is available for the following functions in the flow:
Internal ID
ID of the e-mail message
Timestamp of processing
Subject
Sender
Recipient
Time stamp of the e-mail
Body (text)
Body (HTML)
Configured attachments
In order to use attachments in subsequent functions, you must explicitly provide them with a variable. To do thFew readersFlow list
Flow list
Within the flow list, you have a direct overview of the configured flows of the organization.
In the left column with the title "Valid" you can see whether the respective flow is valid. Only a valid flow will be executed.
In the column with the trigger icon, you can see the respective trigger of the flow.
On the right, you can use the context menu to edit or delete the flow or access tFew readersOrganisation settings - Time window for feedback
You can use the Time window for feedback to define the time you want to allow participants to provide feedback on an alarm. If a participant exceeds this time window, they are assigned the status no feedback. Such a participant is then not used to fill positions in the alarm.
The time window takes effect when all availabilities of the participant have been alerted. The Time window for feedback therefore also influences when another participant is alerted if you use alerting via `Best effFew readersOrganisation settings - Organisation
The name and description of your organisation will help you and your participants to identify the organisation. This is particularly useful if several organisations are used. The name of the organisation is displayed in many places in GroupAlarm. Examples of this are the GroupAlarm App, alarms or appointment invitations.Few readersOrganisation settings - Language
You can choose from various languages for your organisation. The language of your organisation has an effect on the language of your invitation emails, for example. However, it has no effect on the language in which the GroupAlarm WebApp is displayed in your browser. This is solely dependent on your personal language settings, which you can customise in your profile.Few readersElements of the flow - Status change
The Status change trigger starts a flow when the status of one of your units changes. Details on the status of units can be found here. It is not necessary to configure the trigger.
An application example in combination with the Check for string element would be an automated message to the responsible departments when a unFew readersFlow Insights
Flow Insights
The insights of a flow contain all triggered events of a flow. These are saved with the start and end time and show whether the execution of the flow was successful. Use the right button to access the live view of the entry.
Within the live view, you can see which functions theFew readersConfigure Flow: JSON parser
Configure Flow: JSON parser
To use JSON values within the flow, you can use the JSON parser to specify your own variables that are searched for and stored in the JSON payload passed.
Each variable is given a user-defined name and the path in your JSON payload.
| Use only ASCII characters for the variable name.
In addition, you can specify whether a variable is mandatory. If this is then not found in the JSON payload, the flow terminates with a corresponding error message and does not exFew readersInherit Flows
Inherit Flows
If your organization has further sub-organisations, you can inherit configured flows to them. The configuration you have made in the inheriting organization remains intact and cannot be overwritten by an inheriting organization. However, administrators of the inheriting organizations can see a preview of the flow. To inherit a flow to sub-organisations, select the button 'Inherit' within the edit mask on the right and finally click on 'SAVE'.
As the resources - e.g. labelsFew readersConfigure Flows: Format Alarm
Configure Flows: Format Alarm
Format the details of an alarm with a configured string. In this text, use the given variables to insert the details of the alarm into your text. The following variables are available for this purpose:
Variable Description
%EVENT% Name of the Event
%STARTTIME% Starttime dd.mm.yy hh.mm
%STARTTIME_SHORT% Starttime (short) dd.mm hh.mm
%STARTTIME_TECTICAL% Starttime (tactical) ddHHmmMMyy
| %ADRESS% | Adress ofFew readersConfigure Flow: DWD Weather Warning Trigger
Configure Flow: DWD Weather Warning Trigger
The trigger for DWD weather warnings triggers a flow when there is a new DWD weather warning for the configured area. Using the configurable warning criteria and warning level, you can specify at which DWD weather warnings your flow should be triggered.
In addition, you can specify a time period in which all incoming weather warnings are deduplicated based on the warning cell, warning type and warning level. A flow is only triggered if either tFew readersFlow functions
Flow functions
Currently, the following functions are available within a flow:
Triggers an alarm with the configured resources.
Format the details of an alarm with the configured string.
![Load alarm](https://storage.crisp.chat/users/Few readersFlow Triggers
Flow Triggers
Flow triggers are events that can start a flow.
The following flow triggers are available:
This trigger starts a flow when an alarm has been raised in the organization.
This trigger starts a flow when an alarm in the organization has been closed.
![DWD weathFew readersOrganisation settings - Data retention period
By setting up a data retention period, old events can be completely removed from GroupAlarm after a specified period of time. To do this, set the retention period to the desired number of months. You can choose between 1 / 3 / 6 / 12 / 18 / 24 months. The deletion is documented in the audit log. By default, no period is selected, and no data is deleted.
||| ❗️ The deletion is irrevocable and affects all data associated with the event, such as alarms including feedback, PDF reports, incident logFew readersOrganisation settings - Email settings
The Email settings allow you to customise the appearance of all emails sent by your organisation, such as alarm emails, invitation emails or appointment invitations. To do this, you can change the typical GroupAlarm blue background to a colour that suits your organisation. You can also customise the footer. For example, the data of your organisation, such as name and address, can be used here.
| 💡 How to add a logo, or more precisely an avatar, to your organisation, which is then also displayFew readersOrganisation settings - Owner
The creator of an organisation is automatically also the owner. As the owner, you have unlimited rights to the organisation itself and all affiliated sub-organisations.
Each organisation must have at least one owner. So if you want to change the owner, you must first add at least one more owner in order to be able to remove the original owner.
To add additional owners to an organisation, you can search for a participant using the input field or enter the email address of the person you want toFew readersConfigure Flow: Check for one or more strings
Configure Flow: Check for one or more strings
This function combines several "Check for string" conditions in an OR operation. The character string is thus checked for different contents.
This way, you can ensure that several wordings trigger the same alarm.Few readersConfigure Flow: Check for String
Configure Flow: Check for String
With the "Check for String" function, you can check whether a string is contained within an entity of a function that has already run.
For example, you can check whether the alarm message of a triggered alarm contains the string "TESTALARM" or whether the alarm was triggered by a defined tag.Few readersOrganisation settings - Enable devices
Under Enable devices, you can activate and deactivate the devices available for alerting participants globally for your organisation. Deactivating can be useful, for example, if you want to ensure that no additional costs are incurred for sending SMS or calls in the event of alerts. All devices are activated by default.
|| ⚠️ The settings you make only affect the devices of participants for your organisation. In other organisations, participants can continue to use the full range of their devFew readersConfigure Flow: Search Event
Configure Flow: Search Event
Use the Search Event feature to search for an event in your organisation.
Select either a Name to search for or an exact matching External ID of an event.
| Only one of the fields can be filled in at a time.
You can also specify the event state (open, closed, archived) that the event to be searched for should have.
If the event is found, it is located within the result of this function and can be used in the further course of the flow.Few readersConfigure Flow: Receive Email Trigger
Configure Flow: Receive Email Trigger
The "Receive Email" trigger initiates a flow when it receives an incoming email to an email address specified by the system. It is possible to specify a list of permitted senders so that not every participant can trigger flows. If this list is empty, any sender can trigger the flow.
The following entities are available for the following functions in the flow:
Sender
Subject
Message in plain text
Message as HTML
The message in HTMLFew readersOrganisation settings - Flow notifications
Under Flow notifications, you can specify people who should be notified if the execution of a flow fails. This is particularly helpful if you trigger an alarm via the flow. The people receive an email containing a direct link to the insights of the corresponding execution.
In the input field for Recipient, you can either search for and insert participants or enter the email addressesFew readersOrganisation settings - Permission settings
Under Permission settings, you can specify that participants can only assign a role to others if they have this role themselves.
| 💡 Owner and the Organisation Administrator role are not affected by this setting.
Information about permissions can be found here.Few readersElements of the flow - Position Change
The Position Change trigger starts a flow when the position of a unit changes. This allows you to transfer the position of a unit to external systems via a flow, for example. The trigger outputs all the important data of a unit as a result, such as ID, status or position. This data can then be used in the further course of the flow.Few readersOrganisation settings - Location
The location of an organisation is used to calculate the travel time of the participants in the event of a positive response. It is therefore best to select the location of your organisation, e.g. your station.
|| ⚠️ The calculation of the journey time requires that the participants use the GroupAlarm App and share their location.
The location can be specified via the input field for Address. The coordinates are then added automatically.
![](https://storage.crisp.chat/users/helpdesk/websiteFew readersInherit flow
This function allows a flow to be inherited by all connected sub-organisations. The structure of the flow cannot be adapted by the inheriting sub-organisations. However, you have the option of releasing certain parameters for editing as part of the configuration.
In the Insights of an inherited flow, you can also view the executions of the sub-organisations. This allows you to determine at a glance whether the flows in the sub-organisations are working as desired.
Resources such as participantFew readersEdit monitor
To add a new panel, click on the button "NEW PANEL". In the following window you will see all panels, these can be filtered by category or using the search bar.
Click on a panel and configure it according to the specifications, then confirm with "Save". The panel now appears on the monitor.
To move a panel, click in the upper-left corner of a panel and keep the mouse button presseFew readersMonitor - Panel Text area
The Text area panel allows you to display a simple, fixed text on the monitor. This can be used to display general information or announcements on the monitor, for example.
1️⃣ In addition to a title for the panel, you can adjust the font size and colour of the font and background for optimum display on your monitor.
| 💡 You can find information on the advanced formatting options here.
2️⃣ You can insertFew readersMonitor - Panel iFrame
The iFrame Panel allows you to display external content from a URL on your monitor. A common application example is the insertion of a monitor or parts of a monitor from another organisation.
| 💡 All adjustments to the panel are only applied when the editing view is exited using the Save button.
1️⃣ You can add a heading to the panel using the input field for the title. The font colour of the heading and the background colour of the panel can be adjusted for visual design purposes.
| 💡 YouFew readersMonitor - Panel Map
You can use the Map panel to display a map section with the location of the current alarm. The prerequisite for this is that the location is transferred with the address and coordinates when an alarm is triggered.
| 💡 All adjustments to the panel are only applied when the editing view is exited using the Save button.
1️⃣ The input field for the title allows you to add a heading to the panel. The font color of the heading and the background color of the panel can be adjusted for the visual deFew readersMonitor - Panel Recent Alerts
The Recent Alerts panel shows you a list of your organisation's most recent alarms. This also includes alarms for which the events have already been closed or even archived.
1️⃣ In addition to a title for the panel, you can adjust the font size and colour of the font and background for optimum display on your monitor.
| 💡 You can find information on the advanced formatting options here.
2️⃣ The FormatFew readersElements of the flow - Cron Trigger
The cronjob triggers a flow according to a schedule defined by the cronjob expression. This allows processes in GroupAlarm to be automated at specified times. A classic example of such a process is a regular test alarm.
| 💡 The cronjob for the flow can be added to your organisation via the Automated tasks extension under Admin ⇾ Extensions.
Configuration
1️⃣ In the schedule input field, specify the cron job expression to be executed. The expression contains all information regardingFew readersMonitor - Panel Manpower report (Event)
The Manpower report for Events panel shows you the Manpower report for the current Event. The feedback from all alarms is summarised in the respective event. The Manpower report provides a clear overview of the personnel structure to be expected for a deployment. To do this, the participants and their labels must be assigned to the corresponding positions beforehand. The Manpower report is configured under Configuration ⇾ Participants ⇾ Manpower report.
| 💡 The extension of the same name is reqFew readersMonitor - Panel Participating Organisations
The Participating organisations panel can show you the alarmed units with status and feedback from several of your organisations. The prerequisite for this is that the organisations are all in the same organisational structure. In addition, the events of the alarms must be provided with the identical external ID in all organisations. The external ID can be transferred via API interface or via flow using the [Few readersMonitor - Panel List of participants
The list of participants provides you with an overview of your participants and their availability, including the assigned labels.
1️⃣ You can adjust the size and colour of the font and background to optimise the graphic display of the panel on your monitor.
| 💡 You can find information on the advanced formatting options here.
2️⃣ If you have a large number of labels, it can be helpful to filter the labeFew readersMonitor - Panel Inactive pagers
The Inactive pagers panel shows you the total number of inactive pagers in your organisation. For optimum display on your monitor, you can adjust the font size and font colour as well as the background colour. By default, red is already set as the background colour.
| 💡 You can find information on the advanced formatting options here.
The Manpower report for alarms panel shows you the Manpower report for the current alarm. The Manpower report provides a clear overview of the personnel structure to be expected for a deployment. To do this, the participants and their labels must be assigned to the corresponding positions beforehand. The Manpower report is configured under Configuration ⇾ Participants ⇾ Manpower report.
| 💡 The extension of the same name is required for the Manpower report. This can be added under Admin ⇾ ExtenFew readersMonitor - Panel Headline
The Headline panel allows you to provide the monitor with a clear headline. You can adjust the font colour and font size as well as the background colour for better display.
| 💡 You can find information on the advanced formatting options here.Few readersMonitor - Panel Event
You can use the Event panel to add the event name to the monitor as text. In addition to options for customising the panel, a filter is also available which allows you to filter the displayed text using regular expressions. Further details on the topic of regular expressions can be found via the link below the input field.
| 💡 You can find information on the advanced formatting options here.
, shown in the image, for example, removes the country name from the displayed text for better clarity. Further details on the topic of regular expressions can be found via the link below the input field.
| 💡 You can find information onFew readersIncident Log / Guard Book
Although the Incident Log and the Guard Book are two different functions, they share the categories in which entries can be created. Therefore, this article will discuss both functions.
The Guard Book is primarily used to document general processes, while the Incident Log is intended to document duty-related processes. Entries in the Incident Log can therefore only be made in open events, while entries in the Guard Book can be made at any time.
Categories can be created under ConfigurationFew readersGroupAlarm Cockpit - Participants
The Participants module gives you an overview of all participants in your organisation.
|| ⚠️ The following permissions are required for this module: Create or Edit rights for the Participants service and Read rights for the Labels service. Details on permissions can be found here.
1️⃣ Participants are grouped according to status. By switching to the corresponding tab, all participants with this status are listed. In addFew readersGroupAlarm Cockpit - Quick-Actions
The Quick Actions in the GroupAlarm Cockpit allow you to trigger predefined alarms with just a few clicks. This also allows people without any special prior knowledge to trigger specific alarms. Details on configuring Quick Actions can be found here.
|| ⚠️ The following permissions are required for this module: Create rights for the Alarms service. Details on permissions can be found [here](https://docs.groupalarm.com/en/artFew readersGroupAlarm Cockpit
The GroupAlarm Cockpit replaces the GroupAlarm Quick Actions App and provides a separate interface, especially for decision-makers in your organisation. The Cockpit consists of various modules that can be activated for the respective participants through authorisations. The basic functions of the GroupAlarm Cockpit are available free of charge as standard. This includes triggering quick actions and alerting units. In addition to the standard functions, the GroupAlarm Cockpit offers additional moFew readersMonitor - Panel Incident Log
The Incident Log panel allows you to display the entries in your incident log on the monitor. In addition to the option to customise the formatting in order to display the panel optimally on your screen, the number of entries displayed can be defined individually. In addition, you can choose whether system events such as the transfer of write access and deleted entries should be displayed.
| 💡 You can find information on the advanced formatting options [here](https://docs.groupalarm.com/en/arFew readersComments
Comments in GroupAlarm allow your participants to select predefined comments when acknowledging alarms via app or email. These comments can be used to request additional information. One possible scenario for this is asking whether a participant is going directly to the scene or stopping by the station first.
Comments are configured under Configuration → Alarms. You can create new comments via CREATE COMMENT. In addition to the text for the comment, you can use the link to define whether theFew readersElements of the flow - Pager dead man's switch
The trigger Pager dead man's switch triggers a flow when the dead man's switch button on a pager triggers. This then allows you to take further steps, such as triggering an alarm. The trigger also supports the transmission of geo-coordinates, which makes it easier to locate the person concerned. Details of the pagers supported by GroupAlarm can be found here.
| 💡 If no pager is explicitly entered in the input field for the pager, the function aFew readersLabels - Coverage
The coverage helps you monitor operational readiness and gives you an overview of the current availability of your participants even before an alarm is triggered. The coverage is based on the minimum number of participants required per label. An optional input field is available for this purpose in the configuration of labels and smart labels.
Participants who are assigned to the respective label and are considered available globally/organisation-specifically are considered available. A label tFew readersElements of the flow - Coverage
The Coverage trigger helps you to monitor the coverage of your labels more easily. To do this, you can select one or more labels in the input field for the labels to be monitored in the trigger. The trigger is then activated when the coverage of one of the defined labels falls below, exactly reaches or exceeds the minimum occupancy you have defined. To do this, you must specify the value for Minimum available participants in the label.
Let's assume you are using a label for which the minimFew readersManpower report
The manpower report clearly shows the personnel structure that can be expected during an operation. You can choose which labels should be displayed per number of helpers. This helps you to get an overview of the additional labels or qualifications that participants bring with them in the event of a large-scale alarm. This makes it easier for you to change plans during an operation, for example, if the situation requires it. The manpower report can then be displayed, for example, on the GroupAlarFew readersGroupAlarm Cockpit - Incident log
The Incident Log module in the GroupAlarm Cockpit displays the incident log for your open and closed events. You can also create entries directly for the incident log of an open event.
|| ⚠️ The following permissions are required for this module: Read, Create, Edit and Delete rights for the Incident Log service and Read rights for the Events service. Details on permissions can be found here.
Using Create entry, you can create entries in Things entities. This allows you to automatically create entries in Things via a flow when certain events occur. In the example shown in the image, the Things entity is used to display the location on the monitor’s static map as well. To do this, we retrieve the relevant data from the alarm via the flow and feed it into Things via Create entry. Details on the entities and how to create them can be found here.
Under Entity ID, you specify theFew readersElements of the flow - Load entry (Things)
You can use ‘Load entry’ to load data entries into an entity in Things. The data can then be processed later in the flow. To do this, you will need the ID of the relevant entry. You can find this at the end of the URL when editing the data in the entity. The ID should look similar to the one shown in the screenshot.
| 💡 Further information on Things is available here.
You can use the ‘Delete entry’ function to delete data entries in an entity in Things. To do this, you will need the ID of the relevant entry. You can find this at the end of the URL when you edit the data in the entity. The ID should look similar to the one shown in the screenshot.
| 💡 Further information on Things is available here.
