Zum Hauptinhalt springen
Version: 5.6

Solution erstellen

Mit einer Solution stellen Sie ein vorkonfiguriertes OPC-Router-Projekt oder einen wiederverwendbaren Teil davon so bereit, dass andere Projektierer es mit wenigen Eingaben in ihre eigene Konfiguration übernehmen können.

Das Erstellen einer Solution besteht im Kern aus drei Aufgaben:

  • Geeignete Projektbestandteile auswählen
  • Die Dateien in die vorgegebene Solution-Gallery-Struktur überführen
  • Variable Werte als Parameter definieren, damit die Solution in unterschiedlichen Projekten wiederverwendbar ist

Voraussetzungen​

Bevor Sie eine Solution erstellen, prüfen Sie folgende Punkte:

  • Verwenden Sie die YAML-Konfiguration eines normalen OPC-Router-Projekts als Ausgangsbasis. Eine RPE-Datei kann nicht als Grundlage für eine Solution verwendet werden.
  • Im einfachsten Fall enthält Ihr Projekt nur die Dateien, die tatsächlich für Ihre Solution wiederverwendet werden sollen, zum Beispiel Verbindungen, Plug-in-Konfigurationen oder Programmdaten.
  • Identifizieren Sie projektspezifische Werte, die beim Einfügen in ein anderes Projekt angepasst werden müssen, zum Beispiel URLs, Pfade, Zugangsdaten, Dateinamen oder Plug-in-spezifische Bezeichner.
  • Prüfen Sie, ob zusätzliche Programme, Treiber oder Bibliotheken benötigt werden. Diese Dateien müssen zusammen mit der Solution bereitgestellt werden.

Empfohlener Ablauf​

1. Ausgangsprojekt vorbereiten​

Erstellen Sie zunächst Ihr Projekt. Wir empfehlen, dass Sie Ihr OPC-Router-Projekt so vorbereiten, dass es genau den Stand enthält, den Sie als Vorlage bereitstellen möchten. Aus diesem Projekt übernehmen Sie später die benötigten Dateien in die Solution.

Entfernen Sie dazu alles, was nicht Teil der wiederverwendbaren Lösung sein soll, zum Beispiel testweise Verbindungen, nicht mehr benötigte Plug-ins oder projektspezifische Hilfskonfigurationen.

2. Solution-Ordner anlegen​

Erstellen Sie einen neuen Ordner als Arbeitsordner für die Solution.

3. Relevante Dateien übernehmen​

Kopieren Sie anschließend nur die tatsächlich benötigten Projektdateien aus dem vorbereiteten Ausgangsprojekt in die passende Zielstruktur der Solution. Erweitern Sie dabei die Ordnerstruktur nur so weit, wie sie für diese Dateien erforderlich ist.

Wenn Sie die YAML-Struktur des aktuellen OPC-Router-Projekts suchen, finden Sie diese standardmäßig unter C:\ProgramData\inray\OPC Router 5\config\versioned.

Übernehmen Sie unter Plugins ausschließlich die Plug-ins, die bereitgestellt werden sollen, und unter ConnectionGroups nur die Gruppen und Unterstrukturen, die dafür tatsächlich benötigt werden. Eine vollständige Kopie der gesamten Projektstruktur ist nicht erforderlich.

Typische Inhalte sind:

  • Dateien unter config für Verbindungen, Plug-ins und weitere Projektkonfigurationen
  • Dateien unter program für zusätzliche Programme oder Bibliotheken, die mit der Solution ausgeliefert werden müssen

Die vollständige Datei- und Ordnerstruktur ist unter Datei- und Ordnerstruktur der Solution beschrieben.

4. solution.yaml erstellen​

Legen Sie auf Solution-Ebene eine solution.yaml-Datei an. In dieser Datei beschreiben Sie die Solution fachlich und technisch und definieren die Werte, die der Anwender beim Import anpassen soll.

Definieren Sie dort insbesondere:

  • Anzeigename und Kurzbeschreibung
  • optionale Tags und ein Icon
  • kompatible OPC-Router-Versionen
  • Parameter für projektspezifische Werte

Die vollständige Feldbeschreibung finden Sie unter Felder der solution.yaml und Parametrisierung.

5. Projektdateien parametrisieren​

Ersetzen Sie in den übernommenen Projektdateien alle variablen Werte durch die in der solution.yaml definierten Parameter.

Die Referenz auf einen Parameter erfolgt im Format ${parameter_id}. Verwenden Sie Parameter überall dort, wo beim Import eigene Werte eingegeben oder ausgewählt werden sollen.

Beispiel für die Parametrisierung der Host-Adresse eines REST-Client-Transferobjekts mit dem Parameter hostname:

HostAddress: http://${hostname}:51779/api/ProductionData

Typische Kandidaten für Parameter sind:

  • Server- und Endpunktadressen
  • Zugangsdaten oder Secret-Referenzen
  • Dateinamen und Pfade
  • Bezeichner, die im Zielprojekt eindeutig sein müssen

6. Beschreibung für Anwender ergänzen​

Ergänzen Sie bei Bedarf eine Markdown-Beschreibung auf Solution-Ebene, zum Beispiel description_de.md. Diese Beschreibung wird in der Solution Gallery angezeigt und unterstützt Anwender bei der Verwendung der Solution.

Beschreiben Sie dort mindestens:

  • welchen Zweck die Solution erfüllt
  • welche Voraussetzungen im Zielprojekt erfüllt sein müssen
  • welche Parameter beim Import anzugeben sind
  • welche Anpassungen nach dem Import üblicherweise noch erforderlich sind

Empfehlung für die Qualitätssicherung​

Prüfen Sie die Solution vor der Veröffentlichung oder internen Bereitstellung mit einem Testimport in ein separates OPC-Router-Projekt.

Verifizieren Sie dabei insbesondere:

  • Die Solution wird in der Solution Gallery angezeigt.
  • Die Beschreibung ist verständlich und vollständig.
  • Alle erforderlichen Parameter werden abgefragt.
  • Die Parameterwerte werden in den Ziel-Dateien korrekt ersetzt.
  • Nach dem Import ist das Projekt fachlich nachvollziehbar und technisch lauffähig.

Weiterführende Informationen​