Changes for page Entwicklung eines ACMP Connectors für die ISS

Last modified by jklein on 2025/02/13 13:15

From 21.1 to 21.2 From 30.1 to 31.1

From version 21.2

edited by jklein
on 2025/02/06 14:05

Change comment: There is no comment for this version

To version 30.1

edited by jklein
on 2025/02/12 15:46

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (0 modified, 4 added, 0 removed)

Details

Page properties

Content

@@ -98,9 +98,28 @@
  Der Assettyp //Spacestation //ist nun in der Liste verfügbar und hat die entsprechenden benutzerdefinierten Felder.
--(% style="width: 500px;" %)
--[[Neuer Assettyp mit benutzerdefinierten Feldern für die ISS-Daten>>image:Assettyp_ISS Connector.png||alt="Neuer Assettyp mit benutzerdefinierten Feldern für die ISS-Daten" data-xwiki-image-style-alignment="center"]]
++[[Neuer Assettyp mit benutzerdefinierten Feldern für die ISS-Daten>>image:Assettyp_ISS Connector.png]]
++== IDs der benutzerdefinierten Felder abfragen ==
++
++Für die spätere [[Erstellung der Microservices-Schemas>>doc:||anchor="HErstellungderMicroservice-Schemas"]] benötigen Sie die IDs der benutzerdefinierten Felder. Diese können Sie mit Hilfe der AESB Shell in Visual Studio Code abfragen. Für die Abfrage ist es notwendig, dass Sie in der AESB Shell eine SICS-Verbindung angelegt und geöffnet haben. Außerdem müssen die ACMP Public Api Cmdlets importiert sein
++
++{{aagon.infobox}}
++Weitere Informationen zur Nutzung der AESB Shell finden Sie im Abschnitt __[[Verbindungen in der AESB Shell einrichten>>doc:AESB.110.AESB Shell.Verbindungen einrichten.WebHome]]__.
++{{/aagon.infobox}}
++
++Wenn diese Voraussetzungen erfüllt sind, können Sie folgendes Cmdlet ausführen:
++
++{{code language="PowerShell"}}
++$response = Acmp-GetCustomFieldList_V2
++$response.CustomFields | Where-Object {@("Latitude", "Longitude", "Altitude", "Velocity") -contains $_.Caption_EN} | select Caption_EN, Id
++{{/code}}
++
++(% class="wikigeneratedid" %)
++Als Ausgabe sollten Sie die IDs der benutzerdefinierten Felder erhalten. Diese sollten Sie sich in einem separaten Dokument notieren, um später wieder drauf zugreifen zu können. Im nachfolgenden Screenshot ist noch einmal die gesamte Abfrage inklusive der Einrichtung einer SICS-Verbindung in der AESB Shell zu sehen.
++
++[[Einrichtung der AESB Shell mit anschließender Abfrage von den IDs der benutzerdefinierten Felder>>image:AESB Shell_Custom Fields abfragen.png||alt="Einrichtung der AESB Shell mit anschließender Abfrage von den IDs der benutzerdefinierten Felder"]]
++
  = Entwicklung der Microservices =
  Die Entwicklung der PowerShell-Microservices stellt den umfangreichsten Teil bei der Entwicklung dieses ACMP Connectors dar. Für die Entwicklung wird die eingangs beschriebene [[Entwicklungsumgebung >>doc:||anchor="HEntwicklungsumgebung"]]benötigt. Zur Sicherstellung eine sauberen, modularen und effizienten Umsetzung, wird für die Entwicklung von PowerShell-Microservices folgende Vorgehensweise empfohlen:
@@ -392,9 +392,9 @@
 . Wählen Sie die PowerShell-Vorlage //ISSRestConnector //aus und klicken Sie in der Ribbonleiste auf den Button //Module//.
 . Klicken Sie auf //DLL-/PSM1-/Public API-Module hinzufügen //und geben Sie bei //Dateipfad //den Pfad der Modul-Datei //ISSRestConnector.psm1// an, indem Sie die Datei im Datei-Explorer öffnen.{{aagon.infobox}}Bei korrekter Ordnerstruktur, sollte der Pfad 0000 angegeben werden.{{/aagon.infobox}}
 . Klicken Sie auf den Button //Hinzufügen//, um das Modul hochzuladen und klicken Sie in der Modul-Verwaltung auf //OK//, um die Modul-Verwaltung zu schließen.
--1. Wiederholen Sie die Schritte für den Microservice ISSAssetImporter mit dem entsprechenden Modul //ISSAssetImporter.psm1//.
++1. Wiederholen Sie die Schritte für den Microservice ISSAssetImporter mit den Modulen //ISSAssetImporter.psm1 //und //ACMP Public API// (Änderung des Modul-Typs erforderlich).
---> Bild einfügen
++[[PowerShell-Modul implementieren>>image:PowerShell-Modul implementeren.png||alt="PowerShell-Modul implementieren" data-xwiki-image-style-alignment="center" height="355" width="800"]]
  === PowerShell-Module in Microservice-Skripten aufrufen ===
@@ -401,12 +401,215 @@
  Die PowerShell-Module sind nun in der Modul-Verwaltung hochgeladen und können aus Microservice-Skripten heraus aufgerufen werden. Dafür werden nun die Skripte im Skript-Editor angepasst.
  {{aagon.warnungsbox}}
--In diesem Beispiel werden nur die Event-Skripte angepasst, bei denen für dieses Beispiel eine Anpassung notwendig ist. Die nicht erwähnten Event-Skripte bleiben unverändert.
++In diesem Beispiel werden nur die Event-Skripte angepasst, bei denen für dieses Beispiel eine Anpassung notwendig ist. Die nicht erwähnten Event-Skripte bleiben unverändert. Für allgemeine Informationen zu den Event-Skripten, lesen Sie den Abschnitt [[Aufbau des Skript-Editors>>doc:AESB.110.Workspaces.Powershell.Skript-Editor.WebHome]].
  {{/aagon.warnungsbox}}
  (% class="wikigeneratedid" %)
++**ISSRestConnector - Skript**
++
++(% class="wikigeneratedid" %)
++Der ISSRestConnector soll zu einstellbaren Zeiten die Daten von der Rest API holen. Dafür werden die Skript-Events //.OnStart// und //.OnExecute //entsprechend angepasst.
++
++1. Wählen Sie den Microservice //ISSRestConnector //aus und klicken Sie in der Ribbonleiste auf den Button //Skript//.
++1. Wechseln Sie in den Skript-Tab //OnStart //und fügen Sie den nachfolgenden Code in die Datei ein.
++1. Wechseln Sie in den Skript-Tab //OnExecute //und fügen Sie den nachfolgenden Code in die Datei ein.
++1. Drücken Sie Strg + S, um die Datei zu speichern.
++1. Schließen Sie den Skript-Editor.
++
++{{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnector.OnStart**"}}
++#
++# This gets executed once the Microservice has started.
++#
++
++$message = "Starting ISS2ACMP.REST"
++Write-Host $message
++Write-BusinessLog $message
++# Registering Alias
++Set-AESBSelfAsAlias -Alias $configuration.Alias -RemoveExistingAlias
++{{/code}}
++
++{{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnector.OnExecute**"}}
++#
++# This gets executed perpetually by the scheduler. Main business logic should go here.
++#
++
++try {
++ # Trying to fetch new data
++ Write-Host "Fetching new data from the api."
++ $result = Get-ISSData -ApiUrl $configuration.ApiUrl
++
++ # Converting the data to icql
++ $icql = ConvertTo-AESBIcql $result
++
++ # Sending the data to the next microserice
++ Publish-AESBMessage -Alias $configuration.Target -Message $icql
++}
++catch {
++ Write-Error $_
++}
++{{/code}}
++
++(% class="wikigeneratedid" %)
++**ISSAssetImporter - Skript**
++
++(% class="wikigeneratedid" %)
++Der ISSAssetImporter soll eingehende Nachrichten des ISSRestConnectors in ein gültiges Asset umwandeln und dieses mit den definierten Custom Fields in das Asset Management von ACMP eintragen. Dafür werden die Skript-Events //.OnStart// und //.OnMessage //entsprechend angepasst.
++
++1. Wählen Sie den Microservice //ISSAssetImporter //aus und klicken Sie in der Ribbonleiste auf den Button //Skript//.
++1. Wechseln Sie in den Skript-Tab //OnStart //und fügen Sie den nachfolgenden Code in die Datei ein.
++1. Wechseln Sie in den Skript-Tab //OnMessage //und fügen Sie den nachfolgenden Code in die Datei ein.
++1. Drücken Sie Strg + S, um die Datei zu speichern.
++1. Schließen Sie den Skript-Editor.
++
++{{code language="PowerShell" layout="LINENUMBERS" title="**ISSAssetImporter.OnStart**"}}
++#
++# This gets executed once the Microservice has started.
++#
++
++$message = "Starting ISS2ACMP.ACMPImporter"
++
++Write-Host $message
++Write-BusinessLog $message
++
++# Registering Alias
++Set-AESBSelfAsAlias -Alias $configuration.Alias -RemoveExistingAlias
++{{/code}}
++
++{{code language="PowerShell" layout="LINENUMBERS" title="**ISSAssetImporter.OnMessage**"}}
++#
++# This gets executed when a message is received.
++#
++# The received message can be accessed via $msg
++# To retrieve only the body from the message use $body
++#
++
++# Getting msg data
++$msg = New-Message -Args $args
++$body = New-MessageBody -Args $args
++
++# Converting from icql to PSCustomObject
++$data = ConvertFrom-AESBIcql -Icql $body
++Write-Host $data
++
++# Getting the AssetTypeId
++$assetTypeId = Get-AssetTypeId -AssetTypeName $configuration.Acmp.AssetTypeName
++
++# Trying to get the asset if it is already present in acmp
++$asset = Get-ISSAsset -AssetTypeId $assetTypeId -AssetTypeName $configuration.Acmp.AssetTypeName -AssetStateId $configuration.Acmp.AssetStateId -ISS $data
++
++# Saving the asset
++Save-ISSAsset -ISSAsset $asset
++
++# Creating the custom fields
++$customFieldList = @()
++$customFieldList += New-CustomField -Id $configuration.Acmp.CustomFields.Latitude -Value $data.Latitude
++$customFieldList += New-CustomField -Id $configuration.Acmp.CustomFields.Longitude -Value $data.Longitude
++$customFieldList += New-CustomField -Id $configuration.Acmp.CustomFields.Altitude -Value $data.Altitude
++$customFieldList += New-CustomField -Id $configuration.Acmp.CustomFields.Velocity -Value $data.Velocity
++
++# Saving the custom fields
++Save-CustomFieldList -AssetId $asset.Id -CustomFieldList $customFieldList
++{{/code}}
++
++== Microservice-Schema erstellen ==
++
++Nachdem die Microservice-Skripte nun angepasst wurden und die benötigten Funktionalitäten enthalten, müssen für die Möglichkeit der Konfiguration noch die Schemas für die Microservices erstellt werden. Dazu wird der Schema-Designer verwendet.
++
++{{aagon.infobox}}
++Mit dem Schema-Designer haben Sie die Möglichkeit, die Eingabe-Felder anzulegen, welche für die Konfiguration benötigt werden. Alternativ ist es auch möglich, die benötigte Konfiguration statisch im Microservice-Skript zu integrieren.
++{{/aagon.infobox}}
++
++(% class="wikigeneratedid" %)
++**ISSRestConnector - Schema**
++
++(% class="wikigeneratedid" %)
++Für den ISSRestConnector müssen drei Datenfelder angelegt werden.
++
++1. Wählen Sie den Microservice //ISSRestConnector //aus und klicken Sie in der Ribbonleiste auf den Button //Schema//.
++1. Klicken Sie im Schema-Designer auf //Hinzufügen, //um den SchemaString //Alias// anzulegen.
++1. Konfigurieren Sie den Schemaknoten //Alias //entsprechend den Daten in der nachfolgenden Tabelle.
++1. Wiederholen Sie die Schritte 1 bis 3 für die weiteren SchemaStrings //ApiUrl //und //Target//.
++1. Klicken Sie im Schema-Designer auf //Speichern//, um das Schema zu speichern.
++1. Schließen Sie den Schema-Designer.
++
++|=(% style="width: 225px;" %)Datenfeld/Schemaknoten|=(% style="width: 430px;" %)Alias|=(% style="width: 415px;" %)ApiUrl|=(% style="width: 370px;" %)Target
++|=(% style="width: 225px;" %)Anzeigename|(% style="width:430px" %)Alias|(% style="width:415px" %)API Url|(% style="width:370px" %)Target
++|=(% style="width: 225px;" %)Beschreibung|(% style="width:430px" %)Der Alias des Microservice.|(% style="width:415px" %)Die URL der Rest API der ISS(https:~/~/wheretheiss.at/w/developer).|(% style="width:370px" %)Der Ziel-Microservice
++|=(% style="width: 225px;" %)Erforderlich|(% style="width:430px" %)Ja|(% style="width:415px" %)Ja|(% style="width:370px" %)Ja
++|=(% style="width: 225px;" %)Initialwert|(% style="width:430px" %)ISS2ACMP.ISSRestConnector|(% style="width:415px" %)https:~/~/api.wheretheiss.at/v1/satellites/25544|(% style="width:370px" %)ISS2ACMP.ISSAcmpAssetImporter
++
++[[Schema mit Datenfeldern für den ISSRestConnector>>image:Schema_ISSRestConnector.png||alt="Schema mit Datenfeldern für den ISSRestConnector"]]
++
++**ISSAssetImporter - Schema**
++
++(% class="wikigeneratedid" %)
++Für den ISSAssetImporter müssen zwei Schema-Objekte und insgesamt sieben Datenfelder angelegt werden
++
++1. Wählen Sie den Microservice //ISSAssetImporter //aus und klicken Sie in der Ribbonleiste auf den Button //Schema//.
++1. Klicken Sie im Schema-Designer auf //Hinzufügen, //um den SchemaString //Alias //anzulegen.
++1. Konfigurieren Sie den Schemaknoten //Alias //entsprechend den Daten in der nachfolgenden Tabelle.
++
++__Acmp: SchemaObject__
++
++Nun wird das erste SchemaObject erstellt. Alle weiteren SchemaStrings und auch das zweite SchemaObject werden unter dem SchemaObject //Acmp// untergliedert.
++
++1. Klicken Sie im Schema-Designer auf //Hinzufügen, //um das SchemaObject //Acmp// anzulegen.
++1. Wählen Sie das angelegte SchemaObject //Acmp //aus und legen Sie alle weiteren Schemaknoten innerhalb dieses SchemaObjects an.
++1. Klicken Sie im Schema-Designer auf //Hinzufügen //und legen Sie nacheinander die SchemaStrings //AssetTypeName //und //AssetStateId// an.
++1. Klicken Sie im Schema-Designer auf //Hinzufügen //und legen Sie das SchemaObject //CustomFields //an.
++1. Klicken Sie im Schema-Designer auf //Hinzufügen //und legen Sie nacheinander die SchemaStrings //Latitude, Longitude, Altitude //und //Velocity //an.
++1. Konfigurieren Sie alle SchemaStrings// //entsprechend den Daten in der nachfolgenden Tabelle.
++1. Klicken Sie in der Ribbonleiste des Schema-Designers auf //Speichern//, um das Schema zu speichern.
++1. Schließen Sie den Schema-Designer.
++
++|=(% style="width: 224px;" %)Datenfeld/Schemaknoten|=(% style="width: 214px;" %)Alias|=(% style="width: 173px;" %)AssetTypeName|=(% style="width: 154px;" %)AssetStateId|=(% style="width: 125px;" %)Latitude|=(% style="width: 114px;" %)Longitude|=(% style="width: 169px;" %)Altitude|=(% style="width: 177px;" %)Velocity
++|=(% style="width: 224px;" %)Anzeigename|(% style="width:214px" %)Alias|(% style="width:173px" %)AssetTypeName|(% style="width:154px" %)AssetStateId|(% style="width:125px" %)Latitude|(% style="width:114px" %)Longitude|(% style="width:169px" %)Altitude|(% style="width:177px" %)Velocity
++|=(% style="width: 224px;" %)Beschreibung|(% style="width:214px" %)- |(% style="width:173px" %)Name des Assettypes, welcher für die ISS verwendet werden soll.|(% style="width:154px" %)-|(% style="width:125px" %)ID des Custom Fields|(% style="width:114px" %)ID des Custom Fields|(% style="width:169px" %)ID des Custom Fields|(% style="width:177px" %)ID des Custom Fields
++|=(% style="width: 224px;" %)Erforderlich|(% style="width:214px" %)Ja|(% style="width:173px" %)Ja|(% style="width:154px" %)Ja|(% style="width:125px" %)Ja|(% style="width:114px" %)Ja|(% style="width:169px" %)Ja|(% style="width:177px" %)Ja
++|=(% style="width: 224px;" %)Initialwert|(% style="width:214px" %)ISS2ACMP.ISSAcmpAssetImporter|(% style="width:173px" %)Spacestation|(% style="width:154px" %){7BDAC345-C25E-44C9-B220-CBA3CCCD19A7}|(% style="width:114px" %)[[//{ID des benutzerdefinierten Feldes}//>>doc:||anchor="HIDsderbenutzerdefiniertenFelderabfragen"]]|(% style="width:114px" %)[[//{ID des benutzerdefinierten Feldes}//>>doc:||anchor="HIDsderbenutzerdefiniertenFelderabfragen"]]|(% style="width:169px" %)[[//{ID des benutzerdefinierten Feldes}//>>doc:||anchor="HIDsderbenutzerdefiniertenFelderabfragen"]]|(% style="width:177px" %)[[//{ID des benutzerdefinierten Feldes}//>>doc:||anchor="HIDsderbenutzerdefiniertenFelderabfragen"]]
++
++[[Schema mit Datenfeldern für den ISSRestConnector>>image:Schema_ISSAssetImporter.png||alt="Schema mit Datenfeldern für den ISSRestConnector"]]
++
  = Fehlerbehandlung =
++Die Fehlerbehandlung unterscheidet sich je nach System, in welches die Daten integriert werden sollen. Abhängig vom Zeitpunkt der Entwicklung, an dem ein Fehler auftritt, gibt es in diesem Beispiel mehrere Ansätze zur Fehlerbehandlung. Außerdem ist es immer hilfreich, die Informationen aus dem Logging der AESB Console zu beachten.
++
++|=(% style="width: 715px;" %)Fehler|=(% style="width: 724px;" %)Ansätze zur Fehlerbehandlung
++|(% style="width:715px" %)Die AESB Shell lässt sich nicht in Visual Studio Code einrichten.|(% style="width:724px" %)Überprüfen Sie die Korrektheit des Pfads der AESB Shell, der in der Datei //Microsoft.VSCode_profile.ps1 //angegeben ist.
++|(% style="width:715px" %)Der Test der PowerShell-Module schlägt fehl.|(% style="width:724px" %)Beachten Sie den Fehlercode in Visual Studio Code. Überprüfen Sie ggf. die eingestellte Sprache in Visual Studio Code, da bei falscher Spracheinstellung möglicherweise Syntaxfehler auftreten können.
++|(% style="width:715px" %)Die Verbindung zur ACMP Console kann nicht hergestellt werden.|(% style="width:724px" %)Überprüfen und testen Sie die [[Konfiguration der SICS-Verbindung und die Zugriffsberechtigung in ACMP>>doc:AESB.110.AESB installieren, konfigurieren und aktualisieren.SICS-Verbindung konfigurieren.WebHome]]. Prüfen Sie außerdem, ob die SICS-Verbindung möglicherweise ausgefallen ist.
++|(% style="width:715px" %)Die Werte wurden nicht in die benutzerdefinierten Felder importiert.|(% style="width:724px" %)Überprüfen Sie das Logging in der AESB Console. Möglicherweise wurden die benutzerdefinierten Felder nicht gefunden, da sie fehlerhaft angelegt wurden.
++
  = Orchestrierung =
++
++Abschließend müssen Sie noch die Ausführungslogik festlegen. In diesem Beispiel beinhaltet die Ausführungslogik nur die zeitliche Abfrage der Daten der ISS über den ISSRestConnector, da die restliche Logik (z.B. die IDs der benutzerdefinierten Felder) bereits im Microservice-Schema mit den Initialwerten festgelegt wurde. Sie können die Ausführungslogik entweder erst mit einer Testkonfiguration im Skript-Editor testen oder die PowerShell-Microservices direkt als Microservice-Pakete bereitstellen.
++
++== Ausführungslogik testen ==
++
++1. Wählen Sie den Microservice //ISSAssetImporter //aus und klicken Sie in der Ribbonleiste auf den Button //Skript//.
++1. Wechseln Sie im Skript-Editor in den Tab //Testen//.
++1. Klicken Sie auf den Button //Testkonfiguration hinzufügen.//
++1. Geben Sie das Passwort für den aktiven Benutzer ein.
++1. Klicken Sie auf den Button //Starten//, um die Testkonfiguration zu starten.
++1. Wählen Sie den Microservice //ISSRestConnector //aus und klicken Sie in der Ribbonleiste auf den Button //Skript//.
++1. Wechseln Sie im Skript-Editor in den Tab //Testen//.
++1. Klicken Sie auf den Button //Testkonfiguration hinzufügen.//
++1. Geben Sie das Passwort für den aktiven Benutzer ein.
++1. Wählen Sie den Eintrag //Zeitplanung //aus und klicken Sie auf den Button //Bearbeiten//.
++1. Legen Sie fest, nach welcher Zeitplanung der Microservice ausgeführt werden soll. Für den Test genügt eine einmalige Ausführung mit wenigen Sekunden Vorlaufzeit.
++1. Klicken Sie auf den Button //Speichern.//
++1. Klicken Sie auf den Button //Starten//, um die Testkonfiguration zu starten.
++
++{{aagon.warnungsbox}}
++Beachten Sie, dass für eine korrekte Test-Ausführung beide Microservices als Testkonfigurationen gestartet sein müssen. Ansonsten schlägt die Testkonfiguration fehl.
++{{/aagon.warnungsbox}}
++
++Nach dem Starten der Testkonfigurationen öffnen sich jeweils die Skript-Consolen und die Skripte werden ausgeführt. Entsprechend der eingestellten Zeitplanung wird das Skript //ISSRestConnector.OnExecute //ausgeführt und löst das Skript //ISSAssetImporter.OnMessage// aus. Das Ergebnis sollte eine erfolgreiche Auführung zeigen und im ACMP Asset Management sollte nun das Asset //ISS //im Assettyp //Spacestation //angelegt worden sein. Dazu sollten im Tab //Benutzerdefinierte Felder (1:1) //alle Werte der ISS eingetragen sein.
++
++[[Ausgeführte Testkonfiguration mit erfolgreichem Abschluss und eingetragenen Werten im Asset Management>>image:Ausgeführte Testkonfiguration.png||alt="Ausgeführte Testkonfiguration mit erfolgreichem Abschluss und eingetragenen Werten im Asset Management"]]
++
++= Datei-Download =
++
++Das komplette Dateiverzeichnis mit allen Dateien, die Sie in diesem Best Practice selbstständig erstellt haben, finden Sie ebenfalls zum Herunterladen in unserer Community.

Ausgeführte Testkonfiguration.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.jklein

Size

...	...	@@ -1,0 +1,1 @@
	1	+93.0 KB

Content

PowerShell-Modul implementeren.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.jklein

Size

...	...	@@ -1,0 +1,1 @@
	1	+29.6 KB

Content

Schema_ISSAssetImporter.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.jklein

Size

...	...	@@ -1,0 +1,1 @@
	1	+71.4 KB

Content

Schema_ISSRestConnector.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.jklein

Size

...	...	@@ -1,0 +1,1 @@
	1	+48.1 KB

Content