Flows
Flows Overview
Our Flows are a function that allows you to map user-defined processes and workflows.
Basics:
Introduction Flows
Elements of the flow
Create / edit flow (https://docs.groupaPopularELS: iSE-Cobra 4
ELS: iSE-Cobra 4
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 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 pagers tSome readersHotline
Hotline
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 themselves in theirSome readersExtentions
Extensions
GroupAlarm can be further customized with extensions that add additional functionality in the areas of alerting and management within your organization.
Add extension
Select the tab "Extensions" and click on "Add extension".
In the pop-up window, you can now search for the desired extension, learSome readersPermissions
Permissions
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 this section, roles are defined for the organization, which can be assigned to individual participants.
A role assigns specific permissions (read, edit, create, delete) to the different functions of GroupAlarm (e.g. user, alarm, remote trigger).
The default roles "Organization Owner", "Some readersMessanger
Messenger
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" andSome 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 readersRemote Trigger
Remote 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 triggering" 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.
Call
0used as the alarm text in the generated alarm.
Confirm your entries with the "APFew readersElements 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 maFew 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 "AdministratFew 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 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 vpnkey API access by an organization token.
(https://storage.crisp.chat/users/helpdesk/website/606406d8d6f6d000/7eb11125-2f6bFew 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.Few readersElements of the Flow
Trigger
Triggers are events that can start a flow.Few readersIntroduction Flows
Introduction
In order to create or edit a flow, the appropriate administrative permissions for the service flows are required. As an organisation owner or organisation administrator, these permissions are automatically available.
Under the item Admin ⇾ Flows you will get an overview of all existing flows.
Using the sliders on the left side, the flow can be switched on or off. Disabled fFew 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.
Each variable receives a user-defined name and the path to the desired data in the XML document.
In addition, youFew 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 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!
LONG50.76382
LAT6.0793028
Address: GoethestraßFew 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 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 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 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 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 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.
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: 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 readersConfigure Flow: Send e-mail
Configure flow: Send e-mails
To send e-mails through a flow, you can use the "Send e-mail" function.
Here you can use the participants' email addresses or your own addresses as recipients.
For the already existing participants, use the suggested entries when you start typing.
For your own e-mail addresses, enter them completely and confirm the e-mail address with the Enter key.
To add an attachment from a URL to the e-mail, first select the option "Insert attachment".
In the following fiFew readersFlow Triggers
Flow Triggers
Flow triggers are events that can start a flow.
The following flow triggers are available:
Alarm Resolved
This trigger starts a flow when an alarm has been raised in the organization.
Alarm closed
This trigger starts a flow when an alarm in the organization has been closed.
DWD weathFew 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 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.
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 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 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 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.
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 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 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:Few readersFlow functions
Flow functions
Currently, the following functions are available within a flow:
Trigger alarm
Triggers an alarm with the configured resources.
Format Alarm
Format the details of an alarm with the configured string.
Load alarm (https://storage.crisp.chat/users/Few 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 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.Few readersElements of the flow - Close event
With the Close event element, events can be closed automatically.
Configuration
1️⃣ In order for the flow to close a corresponding event, it is mandatory to speciFew 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 cFew 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.
(https://storage.crisp.chat/users/helpdFew 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/flowalFew readersElements of the flow - HTTP Client
The HTTP Client allows you to submit 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 - 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 alFew 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 - 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 - Create event
The Create event element allows you to open an event automatically.
Configuration
1️⃣ Each new event requires a name. This can be defined in the input field for the name of the event. Via the input function (rectangular symbol) the name can also be obtained automatically from previous elementsFew 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.
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/91fefd8bFew 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 - 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 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 - 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 - 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 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.
2️⃣ The message to be sent can then be specifiedFew 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
InstructionsFew 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.
2️⃣ In the input field for the PDF, eitherFew 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 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 - 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-maFew 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.
An example would be checking the alarm text for the string "testalarm". In this way, for example, the events of alarms containing this specific string could be closed more quickly in an automated manner.
(https://storage.crisp.chat/users/helpdesk/website/91fefd8b4b0ac000/floFew 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 - 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 - 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 - 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 adFew readers