Solution Gallery Struktur

Die Solution Gallery hat eine fest definierte Datei- und Datenstruktur, die eingehalten werden muss, damit Solutions im OPC Router angezeigt werden können.

Dateistruktur

Im Folgenden befindet sich die Dateistruktur innerhalb einer Solution Gallery:

• Alle Solution-Einträge (solution.yaml) müssen sich in Verzeichnissen befinden, die auf der Root-Ebene liegen.
• Tags werden in einer optionalen tags.yaml auf Root-Ebene definiert und können in den einzelnen solution.yaml referenziert werden.
• Projektdaten liegen in einem config-Verzeichnis auf Solution-Ebene.
• Programmdaten liegen in einem program-Verzeichnis auf Solution-Ebene.

Beispiel einer Dateistruktur:

📁 Solution Gallery Root
┣ 📁 Beispiel Solution 1
┃  ┣ 📁 config
┃  ┃  ┗ 📁 versioned
┃  ┃     ┣ 📁 ConnectionGroups
┃  ┃     ┃  ┗ 📁 Connections
┃  ┃     ┃     ┗ 📄 example_connection.yaml
┃  ┃     ┗ 📁 Plugins
┃  ┃        ┗ 📁 RestApi
┃  ┃           ┗ 📄 example_rest_plugin.yaml
┃  ┣ 📁 program
┃  ┃  ┗ 📁 devices
┃  ┃     ┗ 📄 example.dll
┃  ┣ 📄 description_de.md
┃  ┣ 📄 description_en.md
┃  ┗ 📄 solution.yaml
┗ 📄 tags.yaml

Formatversion

Die Formatversion muss in allen Solution Gallery-relevanten Konfigurationsdateien (keine Projekt- oder Programmdaten) angegeben werden, um die Kompatibilität sicherstellen zu können. Aktuell liegt der geforderte Wert bei 1.

Weitere Informationen finden Sie in den nachfolgenden Definitionen und in der Solution Struktur.

Definitionen

TranslatableString

Ein übersetzbarer String bietet die Möglichkeit, Texte automatisch übersetzen zu lassen.

Die Angabe der einzelnen Felder ist nicht notwendig. Ein Wert ohne Angabe einer Sprache wird automatisch für alle Sprachen verwendet.

Feldname	Typ	Beschreibung	Standardwert
DE	string	Deutsche Übersetzung	Unbekannt
EN	string	Englische Übersetzung	Unknown

tags.yaml

Feldname	Typ	Beschreibung
FormatVersion	int	Angabe der Formatversion
Tags	Mapping (Tag-Metadaten)	Key: ID des Tags Wert: Tag-Metadaten

Tag-Metadaten

Feldname	Typ	Beschreibung
DisplayName	TranslatableString	Anzeigename des Tags
BackgroundColor	string	Angabe der Tag-Hintergrundfarbe (HEX, RGB)
TextColor	string	Angabe der Tag-Textfarbe (HEX, RGB)

Beispiel

Im Folgenden befindet sich ein Beispiel für eine tags.yaml-Datei.

tags.yaml

FormatVersion: 1
Tags:
  example_tag:
    DisplayName:
      DE: "Beispiel Tag"
      EN: "Example Tag"
    BackgroundColor: "#52856c"
    TextColor: "white"