Eigene Felder
Referenz zu eigenen Feldern für Geräte und Kunden in octoja — die Feldtypen, wie du sie definierst und wie Regeln, Checks und Automatisierungen sie nutzen.
Mit eigenen Feldern erfasst du an deinen Geräten und deinen Kunden Informationen, die octoja nicht von sich aus sammelt — eine Inventarnummer, eine Kostenstelle, ein Vertragsende, eine Raumnummer. Du definierst ein Feld einmal zentral, danach erscheint es an jedem Gerät oder an jedem Kunden, bereit zum Ausfüllen von Hand und zum Abgleich in der regelbasierten Zuweisung. Auch ein Monitoring-Check oder eine Automatisierung kann in Geräte- und Kundenfelder schreiben.
octoja führt zwei unabhängige Sätze von Definitionen: Gerätefelder und Kundenfelder. Es sind getrennte Listen, derselbe Schlüssel kann also je einmal in beiden Sätzen vorkommen, ohne dass es zu Konflikten kommt.
Eigene Felder sind nicht die festen Felder, aus denen ein Benutzerkonto besteht. Das ist eine andere Funktion, sie wird unter Benutzerfelder beschrieben.
Wo du diese Seite findest
Felddefinitionen verwaltest du unter Administration → Eigene Felder. Die Seite hat einen Tab pro Satz — Geräte und Kunden. Zum Öffnen brauchst du die Berechtigung Verwaltung eigener Felder (custom-fields.manage); wie jede Berechtigung wird sie über Gruppen unter Administration → Gruppen erteilt — siehe Berechtigungen zuweisen.
Diese Berechtigung steuert nur die Definitionen. Um eine Definition zu lesen und ihren Wert an einem Gerät oder einem Kunden auszufüllen, brauchst du überhaupt keine Berechtigung für eigene Felder — siehe Werte ausfüllen weiter unten.
Jeder Tab listet die Felder seines Satzes in vier Spalten: Bezeichnung (mit der Beschreibung des Felds darunter), Typ, Gruppe und Details — der Schlüssel, die Optionen der Auswahlliste und der Standardwert, angezeigt als Badges. Das Suchfeld filtert nach Bezeichnung, Schlüssel und Gruppe, und die Liste lässt sich wie jede andere Tabelle in octoja als CSV exportieren.
Feldtypen
Der Typ eines Felds entscheidet, welches Eingabeelement octoja anzeigt, wie der Wert geprüft und wie er gespeichert wird.
Ein Wert, der nicht zu seinem Typ passt, wird beim Speichern abgelehnt: Ein Wert einer Auswahlliste muss einer der definierten Optionen entsprechen, ein Datum muss ein echtes Datum sein, und eine Zahl muss eine Zahl sein. Leerst du ein Feld, wird der Wert entfernt.
Wähle zum Beispiel Auswahlliste für eine einzelne Vertragsart und Mehrfach-Auswahlliste für mehrere vereinbarte Leistungen. Bei der Mehrfach-Auswahlliste kann auch der Standardwert mehrere Optionen enthalten. Bestehende Felder mit Mehrfachwerten bleiben als Mehrfach-Auswahllisten erhalten. In Check-Platzhaltern werden Mehrfachwerte als JSON-Liste ausgegeben, etwa ["Backup","Monitoring"], nicht als einzelner Optionsname.
Ein Feld definieren
Öffne den Tab für den Satz, den du erweitern willst — Geräte oder Kunden — und klicke auf Feld hinzufügen. Der Dialog für das neue Feld fragt drei Dinge ab:
Klicke auf Erstellen. octoja legt das Feld an und öffnet seine Detailseite, auf der die übrigen Einstellungen liegen:
- Optionen — nur bei Auswahllisten. Eine Option pro Zeile; leere Zeilen und Duplikate werden beim Speichern verworfen. Mindestens eine Option muss übrig bleiben, sonst wird das Speichern abgelehnt.
- Standardwert — der Wert, mit dem ein neu angelegtes Gerät oder ein neu angelegter Kunde startet. Das Eingabeelement richtet sich nach dem Typ: ein Schalter, eine Optionsauswahl, eine Datumsauswahl oder ein Zahlen- oder Textfeld. Der Wert wird vor dem Speichern gegen den Typ geprüft.
- Beschreibung — freier Text, der im Info-Hinweis neben dem Feld angezeigt wird.
- Gruppe — eine optionale Überschrift. Felder mit derselben Gruppe werden zusammen in einem eigenen Kasten angezeigt, und octoja schlägt dir Gruppen vor, die im selben Satz bereits verwendet werden.
Klicke auf Speichern, um deine Änderungen zu übernehmen (Strg + S funktioniert ebenfalls). Schlüssel und Typ bleiben auf der Detailseite sichtbar, sind aber gesperrt.
Ein Feld löschen
Am Ende der Detailseite steht der Bereich Kritische Aktionen. Feld löschen entfernt die Definition nach einer Rückfrage. Bereits bei Kunden und Geräten gespeicherte Werte bleiben erhalten, werden aber nicht mehr angezeigt, und das Feld verschwindet aus den Regel-Editoren, aus der Feldauswahl für das Rückschreiben von Checks und aus der Variablenliste der Automatisierungen.
Werte ausfüllen
Werte bearbeitest du am Datensatz selbst, nicht auf der Seite der Definition.
Auf keinem der beiden Tabs gibt es einen eigenen Speichern-Button. Ein Text-, Zahlen- oder Datumswert wird geschrieben, sobald du das Feld verlässt; ein Schalter oder eine Auswahlliste, sobald du etwas auswählst.
Die Felder sind nach Gruppen angeordnet, Felder ohne Gruppe stehen zuerst in einem Kasten namens Allgemein. Das Info-Symbol neben jeder Bezeichnung zeigt die Beschreibung des Felds, seinen Typ, seinen Schlüssel, seine Optionen, seinen Standardwert und seine Gruppe. Hast du die Berechtigung Verwaltung eigener Felder, trägt die Karte zusätzlich einen Button Felder verwalten, der direkt zum passenden Tab von Administration → Eigene Felder springt.
Kundenfelder tauchen außerdem in der Kundenliste auf. Jedes steht über das Spaltenmenü der Tabelle als eigene Spalte bereit, ausgeschaltet, bis du sie einschaltest, und sie kommt beim CSV-Export der Tabelle mit. Zahlenfelder werden als Zahlen sortiert und Datumsfelder als Datum, nicht als Text.
Gerätefelder kannst du in der Geräteliste über Weitere Aktionen → Spalten einblenden. Diese Spalten sind zunächst ausgeblendet und werden mit den sichtbaren Spalten als CSV exportiert. Anders als die Kundenfeld-Spalten lassen sie sich nicht per Überschrift sortieren.
Die Suchfelder der Kunden- und Geräteliste sowie die globale Suche in der Befehlsleiste (Ctrl+K, auf dem Mac ⌘K) durchsuchen auch gespeicherte Werte eigener Felder. So findest du beispielsweise ein Gerät über seine Inventarnummer oder einen Kunden über eine Vertragskennung, ohne zuerst die passende Spalte einzublenden. Durchsucht werden die Werte, nicht die technischen Feldschlüssel; die üblichen Kunden- und Gerätezugriffsregeln gelten weiterhin.
Links aus Textfeldern öffnen
Enthält ein Feld vom Typ Text oder Mehrzeiliger Text eine Webadresse, erscheint daneben ein Link-Symbol. Bei einer Adresse öffnet es den Link direkt in einem neuen Tab; bei mehreren Adressen wählst du den gewünschten Link aus einem Menü. Nutze vollständige Adressen wie https://example.com oder www.example.com — ein bloßes example.com wird nicht erkannt.
Auch Anwendungslinks wie teamviewer10://control?device=123456789 werden unterstützt, wenn auf deinem Computer eine passende Anwendung registriert ist. Lokale Dateilinks (file://) werden nicht angeboten. Das Öffnen eines Links ändert den Feldwert nicht.
Wie Standardwerte angewendet werden
Ein Standardwert wird beim Anlegen des Datensatzes angewendet — wenn sich ein Agent registriert, wenn du ein Netzwerkgerät ohne Agent hinzufügst, wenn ein Gerät sein erstes Inventar meldet und wenn ein Kunde von Hand oder über den CSV- oder Excel-Import angelegt wird. Fügst du einem bestehenden Feld einen Standardwert hinzu, wird er nicht nachträglich in bereits vorhandene Datensätze eingetragen. Dort zeigt das Feld zwar den Standardwert an, bleibt aber ungesetzt, bis du tatsächlich etwas änderst.
Die Werte nutzen
Ein Feld lohnt sich nur, wenn etwas es ausliest. Sobald ein Wert gesetzt ist, können drei Bereiche von octoja damit arbeiten: Die regelbasierte Zuweisung gleicht ihn ab, Monitoring-Checks können ihn schreiben, und Automatisierungen können ihn lesen und schreiben.
In der regelbasierten Zuweisung
Überall dort, wo octoja Geräte über Regeln adressiert — Konfigurationspakete, Tag-Regeln, die Ringe einer Patch-Richtlinie, die Gerätezuordnung einer Automatisierung und der Gerätezugriff einer Gruppe — bietet die Feldauswahl Eigenes Feld (Gerät) an, sobald mindestens ein Gerätefeld definiert ist. Sobald es Kundenfelder gibt, bietet sie zusätzlich Eigenes Feld (Kunde) an, sodass eine Geräteregel auf ein Feld des Kunden abgleichen kann, zu dem das Gerät gehört. Wähle daneben das Feld aus, wähle einen Operator und tippe dann den Wert ein, gegen den verglichen wird. Eine Bedingung, in der noch kein Feld ausgewählt wurde, wird ignoriert und mit einem Warnsymbol markiert.
Die Regeln für den Kundenzugriff einer Gruppe adressieren Kunden statt Geräte. Sie akzeptieren Kunden-Tags und eine Bedingung auf ein eigenes Feld, die dort die Kundenfelder abgleicht.
Eigene Felder werden als Text verglichen, mit den Operatoren ist gleich, ist nicht gleich, enthält, enthält nicht, beginnt mit und beginnt nicht mit. Der Vergleich unterscheidet nicht zwischen Groß- und Kleinschreibung. Im erweiterten (OQL-)Editor lautet dieselbe Bedingung customField.cost_center EQUALS "4711"; ein Kundenfeld lautet customerCustomField.industry EQUALS "Retail".
Weil die Zuweisung bei jeder Wertänderung neu ausgewertet wird, kann das Bearbeiten eines eigenen Felds ein Gerät in ein Konfigurationspaket, einen Patch-Ring oder die Reichweite einer Gruppe hinein- oder herausbewegen.
Fehlt ein gespeicherter Wert, vergleicht die Regel den Standardwert der Felddefinition. Auch eine Änderung dieses Standards kann daher Zuweisungen verändern. Ein Kundenfeld setzt voraus, dass das Gerät einem Kunden zugeordnet ist.
In Checks
Geräte- und Kundenfelder sind in zwei Richtungen mit Monitoring-Checks verbunden.
- Einen Wert in einen Check geben. In der Konfiguration eines Checks tragen Texteingabefelder einen Button Eigenes Feld einfügen, der einen Platzhalter wie
{{device.customField.install_path}}anhängt. octoja ersetzt den Platzhalter vor dem Lauf durch den Wert des jeweiligen Geräts, so kann ein gemeinsam genutztes Paket gerätespezifische Parameter tragen. Zahlen- und Ja / Nein-Einstellungen tragen denselben Button, listen aber nur Felder mit passendem Typ — eine Zahleneinstellung die Felder vom Typ Ganzzahl und Dezimalzahl, eine Ganzzahl-Einstellung nur die vom Typ Ganzzahl, ein Schalter nur die vom Typ Ja / Nein — und dort ersetzt deine Auswahl den Wert, statt ihn anzuhängen. Listen- und Passworteingaben bieten das nicht an. - Ein Check-Ergebnis in ein Feld zurückschreiben. Im Ausgabe-Schema eines eigenen Checks und in den OID-Zeilen eines SNMP-Checks kannst du ein Geräte- oder Kundenfeld als Ziel wählen. octoja schreibt den Ausgabewert bei jedem Ergebnis in das gewählte Feld. Ohne Ziel bleibt es unangetastet. Hat das Gerät keinen Kunden, wird das Schreiben in ein Kundenfeld übersprungen.
Für Kundenfelder nutzt du denselben Einfüge-Button und einen Platzhalter wie {{customer.customField.install_path}}. Er liest den Wert des Kunden, dem das Gerät zugeordnet ist. Für beide Feldsätze gilt: Fehlt ein gespeicherter Wert, verwendet octoja den Standardwert der Definition; ohne Standard bleibt der Platzhalter leer. Ohne zugeordneten Kunden bleibt ein Kundenplatzhalter auch dann leer, wenn die Definition einen Standard hat.
Besteht der Eingabewert ausschließlich aus einem erkannten Feldplatzhalter, zeigt die Konfiguration ihn als verknüpftes Feld mit Bezeichnung und Herkunft Gerät oder Kunde. Klicke darauf, um ein anderes Feld zu wählen; das X entfernt die Verknüpfung und leert den Wert. Text mit eingebetteten Platzhaltern bleibt als Text bearbeitbar.
Ein Kundenfeld wird von allen Geräten dieses Kunden gemeinsam genutzt. Schreiben mehrere Checks hinein, überschreibt das zuletzt verarbeitete Ergebnis den bisherigen Wert. Verwende für gerätespezifische Ergebnisse ein Gerätefeld.
Wie Checks überhaupt zugewiesen werden, liest du unter Checks mit Konfigurationspaketen zuweisen.
In Automatisierungen
Jedes definierte Gerätefeld steht einer Automatisierung als Variable mit dem Namen trigger.customFields.<key> zur Verfügung. Über Variable einfügen fügst du zum Beispiel ${{ trigger.customFields.asset_tag }} ein. Fehlt ein gespeicherter Wert, gilt der Standardwert der Definition; ohne Standard bleibt die Zeichenkette leer. Dieselben Variablen stehen dir auch in Schrittbedingungen zur Verfügung.
Die Aktion Eigenes Feld schreiben setzt wahlweise ein Gerätefeld am aktuellen Gerät oder ein Kundenfeld an dessen Kunden. Der Wert akzeptiert dieselben Platzhalter und wird gegen den Feldtyp geprüft; lässt du ihn leer, wird das Feld geleert. Ohne Kundenzuordnung schlägt ein Schreibschritt für ein Kundenfeld fehl.
Trigger stellen beide Sätze als Variablen bereit — Gerätefelder unter Eigene Felder (Geräte) und die Kundenfelder des Geräts unter Eigene Felder (Kunden), benannt trigger.customerFields.<key>. Auch Kundenvariablen berücksichtigen Standards, aber nur bei vorhandener Kundenzuordnung.
Verwandte Artikel
- Benutzerfelder — die Felder eines Benutzerkontos, eine andere Funktion mit ähnlichem Namen
- Checks mit Konfigurationspaketen zuweisen
- Eine Automatisierung erstellen
- Tag-Regeln konfigurieren
- Gruppen & Berechtigungen – Referenz
- Berechtigungen zuweisen