Alarmvorlagen
#Alarmvorlagen
Alarmvorlagen können für die Vorbereitung eines Alarms im Einsatz verwendet werden. In einer Alarmvorlage kann nicht, wie in den Textvorlagen, nur der Alarmtext vordefiniert werden, sondern auch alle anderen Felder eines Alarms. So können Sie zum Beispiel die Ressourcen, Alarmierungsmodus und weitere Informationen eines Alarms in einer Alarmvorlage konfigurieren. Alle gespeicherten Informationen werden dann bei der Auslösung automatisch ausgefüllt, was kostbare Zeit in einem Einsatzfall spart.
Bis auf den Namen einer Vorlage sind alle Felder einer Alarmvorlage optional. So können Sie bestimmen, welche Parameter eines Alarms vorbereitet werden sollen und welche zum Einsatzfall ausgefüllt werden müssen.
Sollte Ihre Alarmvorlage Alarm-Ressourcen enthalten (Szenarien, Einheiten oder Labels), so können diese nicht aus der Organisation entfernt werden, solange diese in einer Alarmvorlage verwendet werden. Beim Löschen einer solchen Ressource wird eine entsprechende Fehlermeldung ausgegeben, sofern diese in einer Vorlage verwendet werden.
Um eine Vorlage auszulösen, öffnen Sie das Menü der entsprechenden Alarmvorlage und klicken Sie auf "Auslösen". Mit einem Klick werden Sie nun auf das Formular zum Auslösen eines Alarms weitergeleitet. Das entsprechende Formular ist mit den konfigurierten Werten der Alarmvorlage ausgefüllt. Hier können Sie die letzten Anpassungen vor dem Auslösen vornehmen und zum Beispiel den Alarmtext anpassen.
Mächten Sie eine Alarmvorlage mithilfe der API auslösen, können Sie innerhalb des AlarmCreationPayloads das neue JSON-Feld alarmResourceTemplateID verwenden, um die Alarmvorlage mit der entsprechenden ID zu verwenden. Dadurch werden bei der Auslösung des Alarms alle Werte der Alarmvorlage im Alarm gesetzt. Sollten Werte im AlarmCreationPayload und innerhalb der Alarmvorlage zugleich konfiguriert sein, wird immer der konfigurierte Wert der Vorlage verwendet.
Ist der Alarm inklusive der übergebenen Parameter im AlarmCreationPayload unvollständig, kann dieser nicht ausgelöst werden. Achten Sie also auf die Vollständigkeit aller Alarmdetails innerhalb Ihrer Vorlage oder übergeben Sie die fehlenden Werte, wie zum Beispiel den Alarmtext, innerhalb des AlarmCreationPayload.
Weitere Informationen können Sie der API-Dokumentation entnehmen.
Alarmvorlagen einer Organisation können mit anderen Organisationen, die sich nicht im gleichen Organisationsbaum befinden müssen, geteilt werden. Dadurch kann die Organisation, mit der eine Vorlage geteilt wurde, einen Alarm mit vorgegebenen Ressourcen in der teilenden Organisation auslösen.
Dies ist besonders dann hilfreich, wenn Organisationen zusammenarbeiten wollen, sich allerdings nicht im gleichen Organisationsbaum befinden oder keinen Zugriff auf die eigene Organisation gewähren dürfen.
In der Alarmvorlage gibt die teilende Organisation alle Alarmressourcen (und ggf. weitere Informationen) vor, die unveränderbar sein sollen. Die empfangende Organisation kann anschließend bei der Auslösung eines Alarms nur noch Ereignisnamen, Alarmtext und die zusätzlichen Alarminformationen ändern, falls diese nicht durch die Alarmvorlage vorgegeben wurden.
Die Auslösung einer geteilten Alarmvorlage geschieht entweder über die API, die Liste der Alarmvorlagen oder über einen entsprechenden Flow. In jedem Fall müssen Sie sicherstellen, dass die notwendigen Alarmressourcen in der Alarmvorlage korrekt festgelegt sind und, falls nötig, Ereignisname und Alarmtext gesetzt sind. Die auslösende Organisation kann nur dann Ereignisnamen und Alarmtext festlegen, falls diese nicht in der Alarmvorlage vorgegeben sind. Andernfalls können nur die zusätzlichen Alarminformationen (u. a. Adresse) geändert werden. Alle weiteren Einstellungen kann aus Sicherheitsgründen ausschließlich die teilende Organisation festlegen.
Zur Auslösung eines Alarms mit einer geteilten Alarmvorlage benötigen Sie die gleichen Rechte wie bei der Auslösung einer organisationseigenen Alarmvorlage. Berechtigungen in der teilenden Organisation sind nicht erforderlich.
Um eine Alarmvorlage für andere Organisationen freizugeben, müssen Sie einen Sharing-Key anlegen. Diesen erhalten Sie durch einen Klick auf den Menüeintrag "Teilen" im Menü der jeweiligen Alarmvorlage. Dort sehen Sie in einer Liste alle aktuell verwendbaren Sharing-Keys mit ihrem Namen und können einen weiteren Key anlegen, bestehende Keys erneuern oder löschen.
Zum Einlösen eines bestehenden Keys verwenden Sie die Schaltfläche "SHARING-KEY EINLÖSEN" in der jeweiligen Organisation und kopieren Sie den Key in das Textfeld. Anschließend können Sie die Alarmvorlage in der Liste sehen und verwenden.
Wird ein Key erneuert, behalten alle Organisationen, die bereits Zugriff auf die Alarmvorlage haben, diesen Zugriff bei. Allerdings kann der bestehende Key nicht mehr verwendet werden und wird durch den neuen Key ersetzt. Dies ist besonders dann nützlich, wenn der Key in Umlauf geraten ist.
Wird ein Key gelöscht, verlieren alle Organisationen, die diesen Key eingelöst haben, den Zugriff auf die Alarmvorlage.
Alarmvorlagen können für die Vorbereitung eines Alarms im Einsatz verwendet werden. In einer Alarmvorlage kann nicht, wie in den Textvorlagen, nur der Alarmtext vordefiniert werden, sondern auch alle anderen Felder eines Alarms. So können Sie zum Beispiel die Ressourcen, Alarmierungsmodus und weitere Informationen eines Alarms in einer Alarmvorlage konfigurieren. Alle gespeicherten Informationen werden dann bei der Auslösung automatisch ausgefüllt, was kostbare Zeit in einem Einsatzfall spart.
Neue Vorlage anlegen und bearbeiten
Bis auf den Namen einer Vorlage sind alle Felder einer Alarmvorlage optional. So können Sie bestimmen, welche Parameter eines Alarms vorbereitet werden sollen und welche zum Einsatzfall ausgefüllt werden müssen.
Verwendung von Alarm-Ressourcen (Szenarien, Einheiten und Labels)
Sollte Ihre Alarmvorlage Alarm-Ressourcen enthalten (Szenarien, Einheiten oder Labels), so können diese nicht aus der Organisation entfernt werden, solange diese in einer Alarmvorlage verwendet werden. Beim Löschen einer solchen Ressource wird eine entsprechende Fehlermeldung ausgegeben, sofern diese in einer Vorlage verwendet werden.
Vorlage auslösen
Um eine Vorlage auszulösen, öffnen Sie das Menü der entsprechenden Alarmvorlage und klicken Sie auf "Auslösen". Mit einem Klick werden Sie nun auf das Formular zum Auslösen eines Alarms weitergeleitet. Das entsprechende Formular ist mit den konfigurierten Werten der Alarmvorlage ausgefüllt. Hier können Sie die letzten Anpassungen vor dem Auslösen vornehmen und zum Beispiel den Alarmtext anpassen.
API
Mächten Sie eine Alarmvorlage mithilfe der API auslösen, können Sie innerhalb des AlarmCreationPayloads das neue JSON-Feld alarmResourceTemplateID verwenden, um die Alarmvorlage mit der entsprechenden ID zu verwenden. Dadurch werden bei der Auslösung des Alarms alle Werte der Alarmvorlage im Alarm gesetzt. Sollten Werte im AlarmCreationPayload und innerhalb der Alarmvorlage zugleich konfiguriert sein, wird immer der konfigurierte Wert der Vorlage verwendet.
Ist der Alarm inklusive der übergebenen Parameter im AlarmCreationPayload unvollständig, kann dieser nicht ausgelöst werden. Achten Sie also auf die Vollständigkeit aller Alarmdetails innerhalb Ihrer Vorlage oder übergeben Sie die fehlenden Werte, wie zum Beispiel den Alarmtext, innerhalb des AlarmCreationPayload.
Weitere Informationen können Sie der API-Dokumentation entnehmen.
Vorlagen teilen
Alarmvorlagen einer Organisation können mit anderen Organisationen, die sich nicht im gleichen Organisationsbaum befinden müssen, geteilt werden. Dadurch kann die Organisation, mit der eine Vorlage geteilt wurde, einen Alarm mit vorgegebenen Ressourcen in der teilenden Organisation auslösen.
Dies ist besonders dann hilfreich, wenn Organisationen zusammenarbeiten wollen, sich allerdings nicht im gleichen Organisationsbaum befinden oder keinen Zugriff auf die eigene Organisation gewähren dürfen.
In der Alarmvorlage gibt die teilende Organisation alle Alarmressourcen (und ggf. weitere Informationen) vor, die unveränderbar sein sollen. Die empfangende Organisation kann anschließend bei der Auslösung eines Alarms nur noch Ereignisnamen, Alarmtext und die zusätzlichen Alarminformationen ändern, falls diese nicht durch die Alarmvorlage vorgegeben wurden.
Die Auslösung einer geteilten Alarmvorlage geschieht entweder über die API, die Liste der Alarmvorlagen oder über einen entsprechenden Flow. In jedem Fall müssen Sie sicherstellen, dass die notwendigen Alarmressourcen in der Alarmvorlage korrekt festgelegt sind und, falls nötig, Ereignisname und Alarmtext gesetzt sind. Die auslösende Organisation kann nur dann Ereignisnamen und Alarmtext festlegen, falls diese nicht in der Alarmvorlage vorgegeben sind. Andernfalls können nur die zusätzlichen Alarminformationen (u. a. Adresse) geändert werden. Alle weiteren Einstellungen kann aus Sicherheitsgründen ausschließlich die teilende Organisation festlegen.
Zur Auslösung eines Alarms mit einer geteilten Alarmvorlage benötigen Sie die gleichen Rechte wie bei der Auslösung einer organisationseigenen Alarmvorlage. Berechtigungen in der teilenden Organisation sind nicht erforderlich.
Freigabe verwalten
Um eine Alarmvorlage für andere Organisationen freizugeben, müssen Sie einen Sharing-Key anlegen. Diesen erhalten Sie durch einen Klick auf den Menüeintrag "Teilen" im Menü der jeweiligen Alarmvorlage. Dort sehen Sie in einer Liste alle aktuell verwendbaren Sharing-Keys mit ihrem Namen und können einen weiteren Key anlegen, bestehende Keys erneuern oder löschen.
Zum Einlösen eines bestehenden Keys verwenden Sie die Schaltfläche "SHARING-KEY EINLÖSEN" in der jeweiligen Organisation und kopieren Sie den Key in das Textfeld. Anschließend können Sie die Alarmvorlage in der Liste sehen und verwenden.
Wird ein Key erneuert, behalten alle Organisationen, die bereits Zugriff auf die Alarmvorlage haben, diesen Zugriff bei. Allerdings kann der bestehende Key nicht mehr verwendet werden und wird durch den neuen Key ersetzt. Dies ist besonders dann nützlich, wenn der Key in Umlauf geraten ist.
Wird ein Key gelöscht, verlieren alle Organisationen, die diesen Key eingelöst haben, den Zugriff auf die Alarmvorlage.
Aktualisiert am: 17/02/2022
Danke!