Configurator

Benötigt: IP-Symcon >= 5.0

Beschreibt das Aussehen und Funktionalität eines Konfigurators.

Allgemeine Parameter

Sollen die Parameter columns, sort oder values per UpdateFormField verändert werden, so müssen die neuen Werte als JSON codiert werden.

Parameter für columns

Parameter für sort

Parameter für values

Parameter für create

Es gibt verschiedene Möglichkeiten die zu erstellenden Instanzen und deren initiale Konfiguration zu definieren.

Variante 1: Konfiguration einer einzelnen Instanz

In der ersten Variante wird eine einzelne Instanz und deren Konfiguration definiert. In diesem Fall ist create ein Objekt, welches Informationen über die verwendete ModulID und die initiale Konfiguration enthält:

Parameter für Einrichtung

Parameter für Statusvariablen

Wird eine Instanz erstellt, so wird sie mit der von der Einrichtung vorgegebenen ModulID und Konfiguration erstellt. Wie bei der Instanzerstellung üblich, wird die neue Instanz mit validen, physikalisch übergeordneten Instanzen verknüpft, wenn möglich. Hierbei wird bevorzugt die dem Konfigurator physikalisch übergeordnete Instanz verwendet.

Variante 2: Konfiguration einer Kette

Alternativ kann eine Kette von Konfigurationen übergeben werden. Diese definiert die gesamte physikalische Kette für die neu erstellte Instanz, üblicherweise also Gerät, Splitter und I/O. In dieser Variante stellt data.create eine Liste dar, deren Elemente wie in Variante 1 die Instanzen der physikalischen Kette definiert. Die Liste beginnt hierbei mit dem zu erstellenden Gerät und setzt dann mit der jeweils nächsten physikalisch übergeordneten Instanz fort.

Bei der Erstellung durch eine Kette, werden bevorzugt existierende übergeordnete Instanzen wiederverwendet, sofern diese und deren physikalisch übergeordneten Instanzen die Anforderungen der Kette erfüllen. Das Gerät selbst wird allerdings in jedem Falle neu erstellt.

Variante 3: Mehrere mögliche Konfigurationen

Als letzte Möglichkeit können mehrere Konfigurationen zur Auswahl gestellt werden. Hierbei wird create als Objekt mit Schlüssel/Wert-Paaren erstellt, wobei jeder Wert wieder einer Konfiguration wie in Variante 1 oder Variante 2 beschrieben entspricht. Soll bei dieser Darstellung eine Instanz erstellt werden, so wird dem Benutzer eine Auswahl der Bezeichnungen vorgegeben. Die Instanz wird mit den Einstellungen des ausgewählten Elements erstellt. Hierbei können die Schlüssel "moduleID" und "configuration" nicht verwendet werden.

Farben in der Konfigurationsliste

Was die einzelnen Farben bei Meldungen und im Konfigurator bedeuten kann unter den Farbcodes für Meldungen und Konfiguratoren nachgelesen werden. Vom Element werden diese Informationen folgendermaßen dargestellt:

Das Formularfeld Configurator in der Gerätesuche verwenden

Die Konsole bietet erstellbare Instanzen zentral über die Gerätesuche an. Dies geschieht, indem bei Instanzen des Typs Konfigurator und Discovery regelmäßig GetConfigurationForm aufgerufen wird und der Parameter values bei Configurator-Feldern ausgewertet wird. Es werden nur Konfigurator- und Discovery-Instanzen in der Gerätesuche angezeigt, welche mindestens ein Configurator-Feld beinhalten. In diesem darf values auch leer sein. Soll die eigene Instanz bei der Gerätesuche betrachtet werden, so müssen daher folgende Bedingungen erfüllt sein:

• Die Instanz muss vom Typ Konfigurator oder Discovery sein
• Die Suche nach Geräten muss automatisch beim Ausführen von GetConfigurationForm gestartet werden. Dauert die Suche länger, so sollte in einer initialen Rückgabe values leer gelassen werden, nach abgeschlossener Suche müssen die erstellbaren Geräte aber in der Rückgabe von GetConfigurationForm enthalten sein
• Die Suche sollte bei wiederholtem Aufruf von GetConfigurationForm nicht erneut gestartet werden sollte, falls diese aktuell schon läuft
• Eine Beispielimplementation kann hier gefunden werden: SymconTest

Ausgewählte Zeile als Variable in on-Aktionen

Die Verwendung der Werte des Konfigurators in Skripten erfolgt analog zu Listen. Dort stehen sämtliche Werte zur Verfügung, inklusive expanded, instanceID und create. Dennoch speichert der Konfigurator keine Werte in einer Eigenschaft ab.

Beispiel

{
        "type": "Configurator",
        "values": [{
            "name": "Rechenmodul (Umbenannte Statusvariablen)",
            "address": "Adresse",
            "create": {
                "moduleID": "{A7B0B43B-BEB0-4452-B55E-CD8A9A56B052}",
                "configuration": {},
                "statusVariables": {
                    "Minimum": {
                        "name": "Alternativer Name für Minimum"
                    },
                    "Maximum": {
                        "name": "Alternativer Name für Maximum"
                    }
                }
            }
        }]
    })