Last modified by jklein on 2025/02/13 13:15
From version 16.1
edited by jklein
on 2025/02/06 12:00
Change comment: There is no comment for this version
To version 11.1
edited by jklein
on 2025/01/29 09:29
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,10 +2,6 @@
2 2  
3 3  In diesem Best Practice möchten wir Ihnen anhand der Entwicklung eines ACMP Connectors aufzeigen, wie Sie PowerShell-Microservices für Ihre eigenen Projekte entwickeln und nutzen können. Als Beispiel-Projekt wird zur Veranschaulichung ein Connector entwickelt, mit dem die aktuellen Informationen zur Internationalen Raumstation (ISS) aus der öffentlichen REST API [[https:~~/~~/wheretheiss.at>>url:https://wheretheiss.at/]] abgerufen und über die ACMP Public API als Asset im ACMP angelegt bzw. aktualisiert werden. Ziel ist es, die Positions- und Statusdaten der ISS regelmäßig zu synchronisieren und damit immer auf die aktuellen Informationen im System zugreifen zu können.
4 4  
5 -{{aagon.infobox}}
6 -Am Ende des Best Practice finden Sie das Verzeichnis ISSACMPConnector.zip mit allen Dateien dieses ACMP Connectors zum Herunterladen.
7 -{{/aagon.infobox}}
8 -
9 9  = Entwicklungsumgebung =
10 10  
11 11  Als Entwicklungsumgebung für die Umsetzung dieses Beispiel-Projekts benötigen Sie:
... ... @@ -21,7 +21,7 @@
21 21  
22 22  Wenn Sie Visual Studio Code mit der PowerShell-Erweiterung installiert haben, können Sie die AESB Shell in Visual Studio Code einrichten:
23 23  
24 -1. Legen Sie einen neuen Ordner mit dem Namen //ISSACMPConnector// im Datei-Explorer an.
20 +1. Legen Sie einen neuen Ordner mit dem Namen //ISS_ACMP_Connector// im Datei-Explorer an.
25 25  1. Klicken Sie mit einem Rechtsklick auf den neuen Ordner, um das Kontextmenü zu öffnen.
26 26  1. Wählen Sie im Kontextmenü den Eintrag //Mit Code öffnen //aus, damit direkt das richtige Verzeichnis geöffnet wird.
27 27  1. Erstellen Sie eine neue Datei mit der Endung **//.psm1 //**(z.B. Microservice.psm1). Bei dieser Datei handelt es sich um ein PowerShell-Modul, in dem nun die Businesslogik implementiert werden kann.{{aagon.infobox}}Das Erstellen dieser Datei ist notwendig, damit eine PowerShell-Session mit dem Terminal in Visual Studio Code geöffnet wird.{{/aagon.infobox}}
... ... @@ -46,10 +46,6 @@
46 46  
47 47  Als Ergebnis wird in Visual Studio Code im Terminal-Bereich nun direkt die AESB Shell geladen. So können Sie ab jetzt einfach und effektiv neue Module entwickeln, um diese später in den Microservices zu nutzen.
48 48  
49 -[[Geladene AESB Shell in Visual Studio Code>>image:Visual Studio Code_AESB Shell.png||alt="Geladene AESB Shell in Visual Studio Code"]]
50 -
51 -
52 -
53 53  = Aufgabenteilung =
54 54  
55 55  Das Ziel der Aufgabenteilung ist es, die Hauptaufgabe auf kleinere Services aufzuteilen und damit zu modularisieren. Jeder Service soll dabei nur eine spezifische Funktion übernehmen. Somit wird gewährleistet, dass die verschiedenen Services unabhängig voneinander laufen.
... ... @@ -111,7 +111,7 @@
111 111  1. Erstellen der PowerShell-Microservices in AESB
112 112  1. Integrieren der PowerShell-Module in die PowerShell-Microservices
113 113  
114 -=== PowerShell-Module erstellen ===
106 +=== Erstellen der PowerShell-Module ===
115 115  
116 116  Zu Beginn werden die einzelnen PowerShell-Module entwickelt, welche die benötigte Logik für die Microservices enthalten. Für den ACMP Connector in diesem Beispiel werden folgende Module benötigt:
117 117  
... ... @@ -124,8 +124,7 @@
124 124  
125 125  1. Klicken Sie mit einem Rechtsklick auf den Ordner //ISS_ACMP_Connector//, um das Kontextmenü zu öffnen.
126 126  1. Wählen Sie im Kontextmenü den Eintrag //Mit Code öffnen //aus, damit direkt das richtige Verzeichnis geöffnet wird.
127 -1. Erstellen Sie einen neuen Unterordner mit dem Namen //Modules.//
128 -1. Erstellen Sie im Unterordner //Modules //eine neue Datei mit dem Namen //ISSRestConnector.psm1//. Alternativ können Sie auch die anfangs erstellte, leere Datei //Microservice.psm1// umbenennen und in den Ordner verschieben.
119 +1. Erstellen Sie eine neue Datei mit dem Namen //ISSRestConnector.psm1//. Alternativ können Sie auch die anfangs erstellte, leere Datei //Microservice.psm1// umbenennen.
129 129  1. Fügen Sie den nachfolgenden Code in die Datei ein.
130 130  1. Drücken Sie Strg + S, um die Datei zu speichern.
131 131  
... ... @@ -175,7 +175,7 @@
175 175  
176 176  Das Modul zum Speichern des Assets und der zugehörigen Custom Fields erstellt das Asset für die ISS, falls es noch nicht vorhanden ist. Außerdem konvertiert es das PSCustomObject zurück in ein integrierbares Datenformat.
177 177  
178 -1. Erstellen Sie im Unterordner //Modules //eine neue Datei mit dem Namen //ISSAssetImporter.psm1//.
169 +1. Erstellen Sie eine neue Datei mit dem Namen //ISSAssetImporter.psm1//.
179 179  1. Fügen Sie den nachfolgenden Code in die Datei ein.
180 180  1. Drücken Sie Strg + S, um die Datei zu speichern.
181 181  
... ... @@ -286,7 +286,7 @@
286 286  }
287 287  {{/code}}
288 288  
289 -=== PowerShell-Module testen ===
280 +=== Testen der PowerShell-Module ===
290 290  
291 291  Die Funktionalität des erstellten Moduls können Sie mithilfe von Pester (dem Standard-Framework für Unit-Testing in PowerShell) oder eines dedizierten PowerShell Scripts verifizieren. So stellen Sie sicher, dass die Logik fehlerfrei und robust ist. In diesem Beispiel wird das Modul //ISSRestConnector.psm1// mit Pester 5.5.0 getestet.
292 292  
... ... @@ -296,8 +296,7 @@
296 296  
297 297  Sie können das PowerShell-Modul folgendermaßen testen:
298 298  
299 -1. Erstellen Sie im Unterordner //Modules //einen neuen Unterordner mit dem Namen //Tests.//
300 -1. Erstellen Sie im Unterordner //Tests// eine neue Datei mit dem Namen //ISSRestConnectorTests.ps1//.
290 +1. Erstellen Sie eine neue Datei mit dem Namen //ISSRestConnectorTests.ps1//.
301 301  1. Fügen Sie den nachfolgenden Code in die Datei ein.
302 302  1. Drücken Sie Strg + S, um die Datei zu speichern.
303 303  1. Führen Sie das Script aus
... ... @@ -316,7 +316,7 @@
316 316   Latitude = 12.34
317 317   Longitude = 56.78
318 318   Altitude = 408.5
319 - Velocity = 27600
309 + Velocity = 27600.0
320 320   Visibility = "daylight"
321 321   Timestamp = [datetime]::Now.ToUniversalTime().Subtract([datetime]::UnixEpoch).TotalSeconds
322 322   }
... ... @@ -343,10 +343,10 @@
343 343   It "Should correctly map the API response to the output object" {
344 344   $result = Get-ISSData
345 345   $result.Name | Should -Be "iss"
346 - $result.Latitude | Should -Be "12,34"
347 - $result.Longitude | Should -Be "56,78"
348 - $result.Altitude | Should -Be "408,5"
349 - $result.Velocity | Should -Be "27600"
336 + $result.Latitude | Should -Be 12.34
337 + $result.Longitude | Should -Be 56.78
338 + $result.Altitude | Should -Be 408.5
339 + $result.Velocity | Should -Be 27600.0
350 350   }
351 351   }
352 352  
... ... @@ -367,27 +367,22 @@
367 367  {{/code}}
368 368  
369 369  (% class="wikigeneratedid" %)
370 -Da in diesem Test kein Abruf der tatsächlichen API stattfindet, sondern die API-Daten simuliert werden, wird Ihnen als Ergebnis der beabsichtigte Error //Failed to fetch ISS data: API error //angezeigt. Darüber hinaus sollten die drei Tests erfolgreich gewesen sein.
360 +Als Ergebnis des Tests ...
371 371  
372 -(% class="wikigeneratedid" %)
373 -[[image:Output_Pester Testing.png||alt="Ergebnis des Modul-Tests mit Pester" data-xwiki-image-style-alignment="center"]]
362 +=== Erstellen der PowerShell-Microservices in AESB ===
374 374  
375 -=== PowerShell-Microservices in AESB erstellen ===
376 376  
377 377  Da die benötigten PowerShell-Module nun erstellt und getestet sind, kann mit der Erstellung der Microservices begonnen werden.
378 378  
379 379  1. Öffnen Sie die AESB Console und navigieren Sie zum Workspace //Creator - PowerShell//.
380 -1. Klicken Sie in der Ribbonleiste im Bereich //Ordner //auf den Button //Hinzufügen// und erstellen Sie den Ordner// ISS ACMP Connector.//
381 -1. Wählen Sie den Ordner aus und klicken Sie in der Ribbonleiste im Bereich //PowerShell-Vorlagen //auf den Button //Hinzufügen.//
382 -1. Erstellen Sie eine Vorlage// ISSRestConnector. //Klicken Sie in der Ribbonleiste auf den Button //Speichern.//
383 -1. Wiederholen Sie Schritt 3 und Schritt 4 für die Erstellung der Vorlage //ISSAssetImporter//.
368 +1. Klicken Sie in der Ribbonleiste im Bereich //Ordner //auf den Button //Hinzufügen// und Erstellen Sie einen Ordner mit dem Namen// ISS_ACMP_Connector.//
369 +1.
384 384  
385 -=== PowerShell-Module in die PowerShell-Microservices integrieren ===
386 386  
387 -{{aagon.warnungsbox}}
388 -In diesem Beispiel werden nur die
389 -{{/aagon.warnungsbox}}
372 +=== Integrieren der PowerShell-Module in die PowerShell-Microservices ===
390 390  
374 +
375 +
391 391  = Fehlerbehandlung =
392 392  
393 393  = Orchestrierung =
1738156789994-903.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.jklein
Size
... ... @@ -1,1 +1,0 @@
1 -33.7 KB
Content
Output_Pester Testing.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.jklein
Size
... ... @@ -1,1 +1,0 @@
1 -28.5 KB
Content
Visual Studio Code_AESB Shell.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.jklein
Size
... ... @@ -1,1 +1,0 @@
1 -21.5 KB
Content
© Aagon GmbH 2025
Besuchen Sie unsere neue Aagon-Community