# Kommentare

Siehe auch:

# Konzept

Kommentare sind ein zentraler Aspekt des MDA aufgrund ihrer Verwendung in der Adressierung von Ereignissen sowie anderen Datenobjekten (wie z.B. Messstellen und Zeitreihen). Die Konfiguration von speziellen Metadaten-Schlüssel und Kommentar-Kategorien erlaubt es, verschiedene Daten für verschiedene Arten von Kommentaren zu speichern.

# Datenstruktur

Um diese Flexibilität zu ermöglichen, machen Kommentar einen großen Teil der Datenbankstruktur aus und sind stark mit den anderen Datenobjekten vernetzt (z.B. über Links auf diese Datenobjekte). Im Folgenden werden diese Beziehungen im Detail beschrieben.

# Thema (Subjekt / Detail)

Jedem Kommentar muss exakt eine Kategorie (Thema) zugewiesen werden, welche wiederum in "Subjekt" und "Detail" eingeteilt werden. Wir empfehlen, das "Subjekt"-Feld zur breiteren Einteilung von Kommentaren zu nutzen und dann im "Detail" feiner zu granulieren. Beispiele für volle Themen wären etwa "Beobachtung / Erosion" oder "Wartung / Elektrik".

Auf der Kommentar-Hauptseite kann anschließend ein Filter angewandt werden, um nur Kommentare einer bestimmten Kategorie anzuzeigen.

Die Kategorie bestimmt auch, welche zusätzlichen Eigenschaften (Metadaten) für Kommentare, die dieser Kategorie angehören, angezeigt werden. In der zugehörigen Administrationssektion können Kategorien erstellt und Metadaten-Felder zugewiesen werden.

# Kommentar-Metadaten

Um dem Anspruch gerecht zu werden, für alle möglichen Ereignisse und Anlässe die notwendigen Informationen inkludieren zu können, erlaubt MDA die Konfiguration von zusätzlichen Feldern (Metadaten) für Kommentare. Beispiele hierfür wären etwa, wer eine Wartung durchgeführt hat, an welchem Datum die nächste Inspektion geplant ist o.Ä. .

Metadaten bestehen immer aus Schlüssel-Wert-Paaren. Schlüssel sind immer definiert durch die folgenden Komponenten:

  • Name: Muss eindeutig sein in Kombination mit dem Datentyp.
  • Datentyp: Welche Art von Werte diesem Schlüssel zugewiesen werden. Momentan sind drei Datentypen definiert: "Text", "Datum" und "Dezimalzahl", wobei dies nach Anfrage erweitert werden kann.
  • Platzhalter: Ein Hinweis, der für Nutzer im leeren Datenfeld angezeigt wird, wenn dieses Feld im Kommentardialog auftaucht.

WARNING

Platzhalter dienen ausschließlich als Hinweis, und bieten keine Eingabe-Validierung an (z.B. für Textfelder, die einem gewissen Format folgen sollen). Nur Datentypen werden forciert.

Metadaten-Schlüssel können auf der Kommentar-Metadaten-Sektion der Administrationsseite gemanagt werden. Diese Schlüssel können anschließend in der Kommentar-Kategorien-Sektion zu Kategorien (Themen) zugewiesen werden.

TIP

Es ist möglich, den selben Eigenschafts-Schlüssel mehreren Kategorien/Typen zuzuordnen. Dadurch kann es vermieden werden, semantisch äquivalente Schlüssel für verschiedene Kategorien anlegen zu müssen.

# Anhänge / Bilder

Es ist möglich, Dateien (Bilder, Text, PDFs,...), and Kommentare anzuhängen.

Alle standardmäßigen MIME-Typen (opens new window) werden akzeptiert, und dieselbe Datei kann an verschiedene Kommentare angehängt werden. Ein Anhang kann (und soll) eine Beschreibung haben, sowie einen Upload-Zeitstempel.

Sie können diese Bilder auch in TISGraph einbinden, wenn die MIME-Types von TISGraph unterstützt werden.

Dateien, die asynchron von einer externen Quelle stammen, kann die Datenbank eine textuelle 'id' dieser Quelle speichern. MDA-intern angelegte Kommentare sind hiervon ausgenommen.

Beispiele für diese externen Quellen und die üblichen Verwendungszwecke:

  • HWE: Bilder aufnehmen
  • MDA-API: Attachments zuweisen und später hochladen

# Standard-Eigenschaften

Standard-Eigenschaften im Kommentardialog

Alle Kommentare haben bestimmte Standard-Eigenschaften, die meisten davon notwendig:

  • Thema: Die Kommentar-Kategorie. Jeder Kommentar braucht genau eine Kategorie.
  • Ereignis Wann?: Optional. Standardmäßig wird hier der aktuelle Zeitstempel eingetragen.
  • Ereignis-Zeitzone: Optional. Die Zeitzone, auf der der Ereignis-Zeitstempel basiert. Wenn diese im Nachhinein geändert wird, wird der Ereignis-Zeitstempel der Änderung angepasst.
  • Erstellt: Wann dieser Kommentar erstellt wurde. Wird automatisch eingefüllt.
  • Zuletzt bearbeitet: Wird überschrieben, sobald erfolgreich gespeichert wurde.
  • Erstellende Benutzer: Der Urheber dieses Kommentars. Format: {Anzeigename} {Domain}/{Benutzer-ID}
  • Text: Der eigentliche Inhalt des Kommentars. In der Filtermaske können Inhalte dieses Felds durchsucht werden.
  • Kurztext: Eine konzisere Beschreibung, wird u.A. in TISGraph-Dokumenten verwendet.

Siehe Kommentar-Metadaten für die Funktionalität, zusätzliche Felder zu definieren.

# Verlinkungen

Kommentare können zu verschiedenen MDA-Datenobjekten verlinken, hauptsächlich um wiederzugeben, dass der Inhalt des Kommentars sich auf diese (s) Objekt (e) bezieht. Diese Links können außerdem verwendet werden, um Kommentare zu filtern, die auf eine Messrunde verlinken und demnach Messrunden-Kommentare sind.

Die Objekt-Typen, denen ein Kommentar zugewiesen sein kann, sind:

Jede Verlinkung ist eine m:n Beziehung, und ein Kommentar kann auf unterschiedliche Objekttypen verlinken. Siehe Kommentar-Hauptseite für mehr Informationen dazu.

Auf den jeweiligen Unterseiten des MDA, die für Datenobjekte zuständig sind, gibt es oft auch die Möglichkeit, Kommentare anzulegen die automatisch auf das ausgewählte Datenobjekt verlinken. Siehe "Kommentare finden / anlegen" für Details.

# HWE "Anmerkungen"

Im Zuge der Handwerterfassung (HWE) werden automatisch Kommentare("Anmerkungen") für die Messungen angelegt, nämlich:

  • Generelle Anmerkungen zu einer Messrunde. Diese verlinken automatisch die Messrunde und das zugehörige Protokoll.
  • Anmerkungen spezifisch zu einer Messstelle verlinken die Messstelle und Messrunde.

Wenn ein Parameterkommentar in der HWE angegeben wird, der mit "Trocken", "Feucht" oder "Tropft" beginnt, wird dies als Kennung gewertet. Falls nach diesen Kennwörtern noch zusätzlicher Text gesendet wurde, wird zusätzlich noch ein normaler Kommentar angelegt mit Link auf Zeitreihe und Messrunde. "Trocken" erstellt keinen Extra-Kommentar, "Trocken; Unüblich für diese Messstation" erzeugt eines.

WARNING

kalkulierte Kommentarzuordnungen werden nicht mehr aktualisiert, selbst wenn in der entsprechenden Zeitreihe ein "Neuberechnen" angestoßen wird.

# Kommentare finden / anlegen

Es gibt mehrere Möglichkeiten, auf MDA-Kommentare zuzugreifen:

  • Die Hauptseite zugänglich direkt über das Menü
  • Bestimmte Unterseiten für Datenobjekte (z.B. Tagesprotokoll-Seite,...)
  • HWE API

# Kommentar-Hauptseite

Erreichbar über das Menü unter diesem Icon: Comments sidebar icon

Diese Seite verfügt über keinen Standard-Filter, der automatisch Ergebnisse eingrenzen würde und kann somit alle Kommentare abrufen, auf die der eingeloggte Benutzer Zugriff hat. Gefundene Ergebnisse können dann je nach Rechte bearbeitet sowie neue Kommentare erstellt werden.

# Kommentar-Tab für Messstellen / Zeitreihen

Nachdem ein Messpunkt oder eine Zeitreihe im Messstellen-Baum ausgewählt wurde, standardmäßig der "Messwerte"-Tab geöffnet. Auf dem "Kommentar"-Tab findet man dieselbe Filtermaske wie auf der Hauptseite, allerdings wird hier automatisch ein Filter auf die ausgewählte Messstelle/Zeitreihe bei jeder Suche angewandt.

MP comment page

Kommentare, die hier erstellt werden, verlinken automatisch auf das ausgewählte Element.

# Tagesprotokolle und Messrundenprotokolle

Auf der Tagesprotokoll-Seite werden etwaige Kommentare zu den einzelnen Zeitreihen in der dazugehörigen Spalte in verkürzter Form angezeigt. Neue Kommentare, die über Plus-Zeichen angelegt werden, verlinken automatisch auf das aktuelle Protokoll und die jeweilige Zeitreihe.

Der Editierdialog für Messrunden auf der Messrunden-Seite erlaubt die Zuweisung sowohl eines Gesamtkommentars (zusammenfassendes Kommentar) als auch einzelnen Kommentaren zu den jeweiligen Messstellen, falls gewünscht.

Tagesprotokoll Kommentarspalte

# HWE (siehe oben)

HWE-Einheiten laden beim Erstellen einer neuen Messrunde automatisch auch historische Kommentare zu der zugehörigen Messstelle herunter. Das als letztes aufgezeichnete Kommentar findet man in der Sektion für historische Daten.

"Historische Daten"-Sektion im HWE

# Einbindung in ein TISGraph-Dokument

Es ist möglich, in TISGraph-Dokumenten zu einem Graphen MDA-Kommentare einzubinden, was ein Kommentarobjekt an den Graphen am durchschnittlichen Zeitpunkt des Kommentars hängt. Der Kurztext wird dann in TISGraph angezeigt und verschiebt sich mit der Änderung des Beobachtungzeitraumes, so lange die Durchschnittszeit noch im Anzeigebereich liegt.