> For the complete documentation index, see [llms.txt](https://docs.buildings.ability.abb/collection/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.buildings.ability.abb/collection/german/akademie/twig-templating-in-eliona.md).

# Twig-Templating in BuildingPro Suites

## Einführung in die Twig-Templating-Sprache

BuildingPro Suites verwendet [-> \[External Link\] Twig](https://twig.symfony.com/), eine leistungsstarke und flexible Templating-Engine für JavaScript und PHP, zur dynamischen Generierung von Nachrichteninhalten. Mit Twig können Sie Vorlagen definieren, die von externen Messaging-Diensten wie SMS, Google Chat, Slack oder E-Mail verwendet werden.

### Twig.js-Version

Die aktuell in BuildingPro Suites implementierte Version von Twig.js ist **1.17.1**. Die vollständige Dokumentation und Implementierungshinweise finden Sie unter den folgenden Links:

* [-> \[External Link\] Twig.js-Repository](https://github.com/twigjs/twig.js)
* [-> \[External Link\] Hinweise zur Twig.js-Implementierung](https://github.com/twigjs/twig.js/wiki/Implementation-Notes)

***

## Twig-Syntax und -Funktionen

Mit der Twig-Syntax können Sie dynamische Inhalte in Vorlagen einfügen und verarbeiten. Einige häufig verwendete Funktionen sind:

### Variablen ausgeben

```twig
{{ alarm.val }}  {# Outputs the value of the alarm #}
{{ asset.name }}  {# Displays the name of the affected asset #}
```

### Bedingungen verwenden

```twig
{% if alarm.prio == 1 %}
    Achtung: Hohe Priorität!
{% else %}
    Normaler Alarm.
{% endif %}
```

### Schleifen verwenden

```twig
{% for tag in alarm.tags %}
    - {{ tag }}
{% endfor %}
```

### Zeichenfolgen formatieren

```twig
{{ alarm.message.come.de | upper }}  {# Outputs the alarm text in uppercase #}
```

***

## Verfügbare Vorlagen und Variablen in BuildingPro Suites

BuildingPro Suites bietet verschiedene Vorlagentypen für unterschiedliche Anwendungsfälle:

* [Ticketvorlage](#ticket-template)
* [Alarmvorlage](#alarm-template)
* [Vorlage zum Zurücksetzen des Passworts](https://www.google.com/search?q=%23password-reset-template)
* [yAxis-Formatierungsvorlage](#yaxis-formatter)
* [Legendenvorlage](#legend-template)

Jede dieser Vorlagen unterstützt bestimmte Variablen, die dynamisch mit den jeweiligen Daten befüllt werden.

***

## Ticketvorlage

### Verfügbare Variablen

Die Ticketvorlage kann zur automatischen Erstellung von Ticketbenachrichtigungen verwendet werden. Folgende Variablen sind verfügbar:

```json
{
  "ticket": {
    "ticket_id": "Eindeutige ID des Tickets",
    "parent_id": "ID des übergeordneten Tickets, falls vorhanden",
    "title": "Titel des Tickets",
    "description": "Beschreibung des Tickets",
    "priority": "Priorität des Tickets",
    "reason": "Grund oder Ursache des Tickets",
    "state": "Aktueller Status des Tickets",
    "created_by": "Ersteller des Tickets",
    "created_at": "Zeitpunkt der Ticketerstellung",
    "assigned_to": "Zugewiesene Person oder Gruppe",
    "assigned_at": "Zeitpunkt der Zuweisung",
    "closed_at": "Zeitpunkt des Schließens",
    "proj_id": "Mandanten-ID",
    "asset_id": "Asset-ID",
    "alarm_id": "Alarm-ID, falls mit einem Alarm verknüpft",
    "alarm": "Details zum verknüpften Alarm",
    "modified_by": "Zuletzt bearbeitet von",
    "modified_at": "Zeitpunkt der letzten Änderung",
    "contact": "Kontaktinformationen",
    "tags": "Liste der dem Ticket zugeordneten Tags"
  }
}
```

### Beispiel einer Ticketvorlage

```twig
Neues Ticket: {{ ticket.title }}

Nachricht:
Ticket-ID: {{ ticket.ticket_id }}
Erstellt von: {{ ticket.created_by }}
Priorität: {{ ticket.priority }}
Beschreibung: {{ ticket.description }}
```

***

## Alarmvorlage

### Verfügbare Variablen

Die Alarmvorlage basiert auf einem Testdatensatz und enthält umfangreiche Details zu Alarmen und den zugehörigen Assets.

```json
{
  "alarm": {
    "low": "Unterer Grenzwert",
    "high": "Oberer Grenzwert",
    "tags": "Liste der dem Alarm zugeordneten Tags",
    "prio": "Prioritätsstufe des Alarms",
    "ack_p": "Gibt an, ob der Alarm bestätigt werden muss",
    "equal": "Gibt an, ob eine Gleichheitsprüfung durchgeführt wird",
    "enable": "Aktivierungsstatus des Alarms",
    "urldoc": "Dokumentations-URL",
    "func_id": "Funktions-ID des Alarms",
    "msg": "Die aufgelöste Alarmmeldung",
    "message": {
      "come": {
        "de": "{{asset.name}} ({{alarm.val}})",
        "en": "{{asset.name}} ({{alarm.val}})",
        "fr": "{{asset.name}} ({{alarm.val}})",
        "it": "{{asset.name}} ({{alarm.val}})"
      },
      "gone": "Meldung beim Ende des Alarms"
    },
    "subject": "Betreff des Alarms",
    "subtype": "Untertyp des Alarms",
    "alarm_id": "Eindeutige Alarm-ID",
    "asset_id": "ID des betroffenen Assets",
    "attribute": "Betroffenes Attribut des Assets",
    "dont_mask": "Maskierungsstatus des Alarms",
    "notify_on": "Benachrichtigungsauslöser (z. B. 'R' für Erinnerung)",
    "check_type": "Typ der Alarmprüfung",
    "created_at": "Zeitpunkt der Alarmerstellung",
    "created_by": "Ersteller des Alarms",
    "auto_ticket": "Gibt an, ob automatisch ein Ticket erstellt wird",
    "modified_at": "Zeitpunkt der letzten Änderung",
    "modified_by": "Zuletzt bearbeitet von",
    "ts": "Zeitstempel des Alarms",
    "val": "Wert des betroffenen Parameters",
    "multi": "Multiplikator für den Alarmwert",
    "ack_ts": "Zeitpunkt der Bestätigung",
    "gone_ts": "Zeitpunkt, zu dem der Alarm verschwand",
    "ack_text": "Bestätigungstext",
    "ack_user_id": "ID des bestätigenden Benutzers"
  },
  "locale":"Sprach- und Regionseinstellung",
  "domain_name": "Der Domainname der Umgebung",
  "asset": {
    "ar": "Aktivierungsstatus",
    "gai": "Globale Asset-ID",
    "lat": "Breitengrad des Assets",
    "lon": "Längengrad des Assets",
    "name": "Name des Assets",
    "tags": "Liste der Tags des Assets",
    "expert": "Expertenmodus aktiviert",
    "storey": "Etage des Assets",
    "urldoc": "Dokumentations-URL des Assets",
    "proj_id": "Mandanten-ID",
    "archived": "Archivierungsstatus",
    "asset_id": "Eindeutige Asset-ID",
    "acl_access": "Zugriffsstatus",
    "asset_type": "Typ des Assets",
    "tracker_id": "Tracker-ID",
    "description": "Beschreibung des Assets",
    "acl_permissions": "Zugriffsberechtigungen"
  }
}
```

### Beispiel einer Alarmvorlage

```twig
Alarm für {{ asset.name }}

Nachricht:
Der Alarm „{{ alarm.message.come.de }}“ wurde ausgelöst.
Attribut: {{ alarm.attribute }}
Wert: {{ alarm.val }}
```

***

## Benutzervorlage

Die *Benutzervorlage* ermöglicht den Zugriff auf benutzerspezifische Informationen – insbesondere für Benachrichtigungen (z. B. per E-Mail, Chat oder Alarmweiterleitung). Sie kann in allen Vorlagen verwendet werden, in denen Benutzerdaten verfügbar sind.

### Verfügbare Variablen

```json
"user": {
  "email": "E-Mail-Adresse des Benutzers",
  "user_id": "Eindeutige Benutzer-ID",
  "lastname": "Nachname des Benutzers",
  "firstname": "Vorname des Benutzers",
  "google_chat": "Google-Chat-Adresse (optional)",
  "slack": "Slack-Adresse (optional)",
  "mail2service": {
    "voice": "E-Mail-Adresse für Sprachnachrichten (z. B. eCall Voice)",
    "sms": "E-Mail-Adresse für SMS-Benachrichtigungen (z. B. eCall SMS)"
  }
}
```

### Beispiel einer Benutzervorlage

```twig
Benachrichtigung an: {{ user.firstname }} {{ user.lastname }} ({{ user.email }})

Sprachalarm weiterleiten an: {{ user.mail2service.voice }}
SMS-Alarm weiterleiten an: {{ user.mail2service.sms }}

Slack-Benutzer: {{ user.slack }}
Google Chat: {{ user.google_chat }}
```

***

## Vorlage zum Zurücksetzen des Passworts

### Verfügbare Variablen

Die Vorlage zum Zurücksetzen des Passworts wird in BuildingPro Suites verwendet, um Benutzern eine E-Mail mit einem Link zum Zurücksetzen ihres Passworts zu senden.

```json
{
    "host": "Domain der Umgebung, in der das System betrieben wird",
    "password_reset_token": "Eindeutiges Token zum Zurücksetzen des Passworts"
}
```

### Beispiel einer Vorlage zum Zurücksetzen des Passworts

```twig
Hallo,

Um Ihr Passwort zurückzusetzen, klicken Sie bitte auf den folgenden Link:

<a href="https://{{ host }}/password-reset/{{ password_reset_token }}">Passwort zurücksetzen</a>

Wenn Sie dies nicht angefordert haben, können Sie diese E-Mail ignorieren.

Achten Sie darauf, dass der Link unverändert bleibt, damit er weiterhin funktioniert:
href="https://{{ host }}/password-reset/{{ password_reset_token }}"
```

{% hint style="warning" %}
Achten Sie darauf, dass der Link unverändert bleibt, damit er weiterhin funktioniert: href="https\://{{host}}/password-reset/{{password\_reset\_token}}"
{% endhint %}

***

## yAxis-Formatierer

Der yAxis-Formatierer bestimmt die Anzeige der Achsenbeschriftung in Diagrammen. Er zeigt den aktuellen Wert der Datenreihe zusammen mit zusätzlichen Attributinformationen an.

### Verfügbare Variablen für den yAxis-Formatierer

* `{{unit}}` – Einheit des Werts (z. B. °C, %, kWh)
* `{{value}}` – Der aktuelle Wert der Datenreihe
* `{{attribute}}` – Name des Attributs
* `{{gai}}` – Globale Asset-ID
* `{{aggregatedDataField}}` – Datenfeld für die Aggregation
* `{{aggregatedDataRaster}}` – Raster, mit dem die Daten aggregiert wurden
* `{{aggregatedDataType}}` – Aggregationstyp (z. B. Durchschnitt, Summe)

#### Beispiel für einen yAxis-Formatierer

```twig
{{value}} {{unit}} ({{attribute}})
```

Ergebnis für Temperaturdaten: → `22.5 °C (Raumtemperatur)`

***

## Legendenvorlage

Die Legenden-Vorlage bestimmt die Anzeige der Legendenbeschriftung in Diagrammen. Sie beschreibt die Datenreihe, indem sie den Namen des Assets oder der Datenreihe mit Attributinformationen kombiniert.

### Verfügbare Variablen für die Legenden-Vorlage

* `{{unit}}` – Einheit des Werts (z. B. °C, %, kWh)
* `{{attribute}}` – Name des Attributs
* `{{gai}}` – Globale Asset-ID
* `{{name}}` – Name des Assets oder der Datenreihe
* `{{aggregatedDataField}}` – Datenfeld für die Aggregation
* `{{aggregatedDataRaster}}` – Raster, mit dem die Daten aggregiert wurden
* `{{aggregatedDataType}}` – Aggregationstyp (z. B. Durchschnitt, Summe)

### Beispiel für eine Legenden-Vorlage

```twig
{{name}} - {{attribute}} ({{unit}})
```

Ergebnis für einen Temperatursensor: → `Klimaanlage Büro 1 - Raumtemperatur (°C)`

***

## Fazit

Twig.js ermöglicht die flexible und effiziente Verwendung von Vorlagen in BuildingPro Suites. Mithilfe von Twig-Variablen und -Funktionen lassen sich personalisierte Inhalte für Tickets, Alarme und E-Mails erstellen. Weitere Informationen zur Twig-Syntax finden Sie in der offiziellen Dokumentation: [-> \[Externer Link\] Twig.js-Wiki](https://github.com/twigjs/twig.js/wiki/Implementation-Notes).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.buildings.ability.abb/collection/german/akademie/twig-templating-in-eliona.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
