Solution Gallery Struktur

Damit eine Solution in der Solution Gallery verarbeitet werden kann, muss sie einer festen Datei- und Datenstruktur folgen. Diese Struktur legt fest,

• wo einzelne Solutions liegen
• welche Dateien auf Root-Ebene erlaubt sind
• wo Konfigurations- und Programmdaten abgelegt werden

Die Struktur ist unabhängig vom fachlichen Inhalt der Solution. Sie ist die technische Grundlage dafür, dass der OPC Router die Solution erkennen, beschreiben und importieren kann.

Dateistruktur

Für die Dateistruktur gelten folgende Regeln:

• Jede Solution liegt in einem eigenen Verzeichnis auf Root-Ebene.
• In jedem Solution-Verzeichnis befindet sich eine solution.yaml.
• Tags werden optional in einer gemeinsamen tags.yaml auf Root-Ebene definiert. Sie dienen in der Solution Gallery als Such- und Filterhilfe, um Solutions thematisch schneller zu finden, zum Beispiel für Inhalte wie REST.
• Projektdateien liegen innerhalb der Solution im Verzeichnis config.
• Zusätzliche Programmdaten liegen innerhalb der Solution im Verzeichnis program.

Beispiel einer Dateistruktur:

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

Formatversion

Die Formatversion muss in allen Solution-Gallery-relevanten Metadateien angegeben werden, also zum Beispiel in solution.yaml oder tags.yaml. Projekt- und Programmdaten sind davon ausgenommen.

Aktuell wird der Wert 1 erwartet.

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

Über Tags können Sie Solutions in der Solution Gallery thematisch kennzeichnen. Anwender können so gezielt nach fachlichen oder technischen Schwerpunkten suchen, zum Beispiel nach Solutions mit Bezug zu REST.

Feldname	Typ	Beschreibung
FormatVersion	int	Angabe der Formatversion
Tags	Mapping (Tag-Metadaten)	Mapping aus Tag-ID als Key und Tag-Metadaten als Wert

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"