Last modified by jklein on 2025/02/13 13:15
From version 14.1
edited by jklein
on 2025/02/06 09:28
Change comment: There is no comment for this version
To version 27.1
edited by jklein
on 2025/02/10 14:58
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -24,7 +24,7 @@
24 24  1. Legen Sie einen neuen Ordner mit dem Namen //ISSACMPConnector// 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 -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}}
27 +1. Erstellen Sie eine neue Datei mit der Endung **//.psm1 //**(z.B. Modul.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}}
28 28  1. Geben Sie im Terminal den Befehl //{{code language="PowerShell"}}code $profile{{/code}} //ein und bestätigen Sie mit der Eingabetaste. Nun öffnet sich die Datei //Microsoft.VSCode_profile.ps1//,// //mit der Sie das verwendete PowerShell-Profil anpassen können.
29 29  1. Fügen Sie den nachfolgenden Code in die Datei //Microsoft.VSCode_profile.ps1// ein. Beachten Sie, dass der angegebene Pfad für die AESB Shell korrekt ist.
30 30  1. Drücken Sie Strg + S, um die Datei zu speichern.
... ... @@ -46,6 +46,9 @@
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 +
49 49  = Aufgabenteilung =
50 50  
51 51  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.
... ... @@ -107,7 +107,7 @@
107 107  1. Erstellen der PowerShell-Microservices in AESB
108 108  1. Integrieren der PowerShell-Module in die PowerShell-Microservices
109 109  
110 -=== PowerShell-Module erstellen ===
113 +== PowerShell-Module erstellen ==
111 111  
112 112  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:
113 113  
... ... @@ -114,7 +114,7 @@
114 114  * ISSRestConnector - Modul zum Abfragen der ISS-Daten
115 115  * ISSAssetImporter - Modul zum Speichern des Assets und der zugehörigen Custom Fields
116 116  
117 -**ISSRestConnector**
120 +=== **ISSRestConnector** ===
118 118  
119 119  Das Modul zum Abfragen der ISS-Daten besteht aus einer einfachen Funktion, welche die REST API aufruft und das Ergebnis in ein PSCustomObject konvertiert.
120 120  
... ... @@ -121,7 +121,7 @@
121 121  1. Klicken Sie mit einem Rechtsklick auf den Ordner //ISS_ACMP_Connector//, um das Kontextmenü zu öffnen.
122 122  1. Wählen Sie im Kontextmenü den Eintrag //Mit Code öffnen //aus, damit direkt das richtige Verzeichnis geöffnet wird.
123 123  1. Erstellen Sie einen neuen Unterordner mit dem Namen //Modules.//
124 -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.
127 +1. Erstellen Sie im Unterordner //Modules //eine neue Datei mit dem Namen //ISSRestConnector.psm1//. Alternativ können Sie auch die anfangs erstellte, leere Datei //Modul.psm1// umbenennen und in den Ordner verschieben.
125 125  1. Fügen Sie den nachfolgenden Code in die Datei ein.
126 126  1. Drücken Sie Strg + S, um die Datei zu speichern.
127 127  
... ... @@ -167,7 +167,7 @@
167 167  }
168 168  {{/code}}
169 169  
170 -**ISSAssetImporter**
173 +=== **ISSAssetImporter** ===
171 171  
172 172  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.
173 173  
... ... @@ -282,12 +282,12 @@
282 282  }
283 283  {{/code}}
284 284  
285 -=== PowerShell-Module testen ===
288 +== PowerShell-Module testen ==
286 286  
287 287  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.
288 288  
289 289  {{aagon.infobox}}
290 -Beachten Sie, dass Sie Pester für diesen Test ggf. vorher installieren oder updaten müssen. Weitere Informationen dazu finden Sie in der __[[Dokumentation von Pester>>https://pester.dev/docs/introduction/installation]]__.
293 +Beachten Sie, dass Sie Pester für diesen Test ggf. vorher installieren oder updaten müssen. Weitere Informationen dazu finden Sie in der __[[Dokumentation von Pester>>https://pester.dev/docs/introduction/installation||rel="noopener noreferrer" target="_blank"]]__.
291 291  {{/aagon.infobox}}
292 292  
293 293  Sie können das PowerShell-Modul folgendermaßen testen:
... ... @@ -368,7 +368,7 @@
368 368  (% class="wikigeneratedid" %)
369 369  [[image:Output_Pester Testing.png||alt="Ergebnis des Modul-Tests mit Pester" data-xwiki-image-style-alignment="center"]]
370 370  
371 -=== PowerShell-Microservices in AESB erstellen ===
374 +== PowerShell-Microservices erstellen ==
372 372  
373 373  Da die benötigten PowerShell-Module nun erstellt und getestet sind, kann mit der Erstellung der Microservices begonnen werden.
374 374  
... ... @@ -375,19 +375,151 @@
375 375  1. Öffnen Sie die AESB Console und navigieren Sie zum Workspace //Creator - PowerShell//.
376 376  1. Klicken Sie in der Ribbonleiste im Bereich //Ordner //auf den Button //Hinzufügen// und erstellen Sie den Ordner// ISS ACMP Connector.//
377 377  1. Wählen Sie den Ordner aus und klicken Sie in der Ribbonleiste im Bereich //PowerShell-Vorlagen //auf den Button //Hinzufügen.//
378 -1. Erstellen Sie eine Vorlage// ISSRestConnector. //Klicken Sie in der Ribbonleiste auf den Button //Speichern.//
381 +1. Erstellen Sie die Vorlage// ISSRestConnector. //Klicken Sie in der Ribbonleiste auf den Button //Speichern.//
379 379  1. Wiederholen Sie Schritt 3 und Schritt 4 für die Erstellung der Vorlage //ISSAssetImporter//.
380 380  
381 -=== PowerShell-Module in die PowerShell-Microservices integrieren ===
384 +== PowerShell-Module implementieren ==
382 382  
386 +Die Implementierung der Module in die PowerShell-Microservices erfolgt an zwei Stellen: In der Modul-Verwaltung und im Skript-Editor.
383 383  
388 +=== PowerShell-Module in der Modul-Verwaltung hochladen ===
384 384  
390 +Zunächst müssen Sie den einzelnen PowerShell-Vorlagen die jeweiligen Module zuweisen:
391 +
392 +1. Wählen Sie die PowerShell-Vorlage //ISSRestConnector //aus und klicken Sie in der Ribbonleiste auf den Button //Module//.
393 +1. 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}}
394 +1. 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.
395 +1. Wiederholen Sie die Schritte für den Microservice ISSAssetImporter mit den Modulen //ISSAssetImporter.psm1 //und //ACMP Public API// (Änderung des Modul-Typs erforderlich).
396 +
397 +[[PowerShell-Modul implementieren>>image:PowerShell-Modul implementeren.png||alt="PowerShell-Modul implementieren" data-xwiki-image-style-alignment="center" height="355" width="800"]]
398 +
399 +=== PowerShell-Module in Microservice-Skripten aufrufen ===
400 +
401 +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.
402 +
385 385  {{aagon.warnungsbox}}
386 -In diesem Beispiel werden nur die
404 +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]].
387 387  {{/aagon.warnungsbox}}
388 388  
407 +(% class="wikigeneratedid" %)
408 +**ISSRestConnector**
389 389  
410 +(% class="wikigeneratedid" %)
411 +Der ISSRestConnector soll zu einstellbaren Zeiten die Daten von der Rest API holen. Dafür werden die Skript-Events //.OnStart// und //.OnExecute //entsprechend angepasst.
390 390  
413 +1. Wählen Sie den Microservice //ISSRestConnector //aus und klicken Sie in der Ribbonleiste auf den Button //Skript//.
414 +1. Wechseln Sie in den Skript-Tab //OnStart //und fügen Sie den nachfolgenden Code in die Datei ein.
415 +1. Wechseln Sie in den Skript-Tab //OnExecute //und fügen Sie den nachfolgenden Code in die Datei ein.
416 +1. Drücken Sie Strg + S, um die Datei zu speichern.
417 +1. Schließen Sie den Skript-Editor.
418 +
419 +{{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnector.OnStart**"}}
420 +#
421 +# This gets executed once the Microservice has started.
422 +#
423 +
424 +$message = "Starting ISS2ACMP.REST"
425 +
426 +Write-Host $message
427 +Write-BusinessLog $message
428 +
429 +# Registering Alias
430 +Set-AESBSelfAsAlias -Alias $configuration.Alias -RemoveExistingAlias
431 +{{/code}}
432 +
433 +{{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnector.OnExecute**"}}
434 +#
435 +# This gets executed perpetually by the scheduler. Main business logic should go here.
436 +#
437 +
438 +try {
439 + # Trying to fetch new data
440 + Write-Host "Fetching new data from the api."
441 + $result = Get-ISSData -ApiUrl $configuration.ApiUrl
442 +
443 + # Converting the data to icql
444 + $icql = ConvertTo-AESBIcql $result
445 +
446 + # Sending the data to the next microserice
447 + Publish-AESBMessage -Alias $configuration.Target -Message $icql
448 +}
449 +catch {
450 + Write-Error $_
451 +}
452 +{{/code}}
453 +
454 +(% class="wikigeneratedid" %)
455 +**ISSAssetImporter**
456 +
457 +(% class="wikigeneratedid" %)
458 +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.
459 +
460 +1. Wählen Sie den Microservice //ISSAssetImporter //aus und klicken Sie in der Ribbonleiste auf den Button //Skript//.
461 +1. Wechseln Sie in den Skript-Tab //OnStart //und fügen Sie den nachfolgenden Code in die Datei ein.
462 +1. Wechseln Sie in den Skript-Tab //OnMessage //und fügen Sie den nachfolgenden Code in die Datei ein.
463 +1. Drücken Sie Strg + S, um die Datei zu speichern.
464 +1. Schließen Sie den Skript-Editor.
465 +
466 +{{code language="PowerShell" layout="LINENUMBERS" title="**ISSAssetImporter.OnStart**"}}
467 +#
468 +# This gets executed once the Microservice has started.
469 +#
470 +
471 +$message = "Starting ISS2ACMP.ACMPImporter"
472 +
473 +Write-Host $message
474 +Write-BusinessLog $message
475 +
476 +# Registering Alias
477 +Set-AESBSelfAsAlias -Alias $configuration.Alias -RemoveExistingAlias
478 +{{/code}}
479 +
480 +{{code language="PowerShell" layout="LINENUMBERS" title="**ISSAssetImporter.OnMessage**"}}
481 +#
482 +# This gets executed when a message is received.
483 +#
484 +# The received message can be accessed via $msg
485 +# To retrieve only the body from the message use $body
486 +#
487 +
488 +# Getting msg data
489 +$msg = New-Message -Args $args
490 +$body = New-MessageBody -Args $args
491 +
492 +# Converting from icql to PSCustomObject
493 +$data = ConvertFrom-AESBIcql -Icql $body
494 +Write-Host $data
495 +
496 +# Getting the AssetTypeId
497 +$assetTypeId = Get-AssetTypeId -AssetTypeName $configuration.Acmp.AssetTypeName
498 +
499 +# Trying to get the asset if it is already present in acmp
500 +$asset = Get-ISSAsset -AssetTypeId $assetTypeId -AssetTypeName $configuration.Acmp.AssetTypeName -AssetStateId $configuration.Acmp.AssetStateId -ISS $data
501 +
502 +# Saving the asset
503 +Save-ISSAsset -ISSAsset $asset
504 +
505 +# Creating the custom fields
506 +$customFieldList = @()
507 +$customFieldList += New-CustomField -Id $configuration.Acmp.CustomFields.Latitude -Value $data.Latitude
508 +$customFieldList += New-CustomField -Id $configuration.Acmp.CustomFields.Longitude -Value $data.Longitude
509 +$customFieldList += New-CustomField -Id $configuration.Acmp.CustomFields.Altitude -Value $data.Altitude
510 +$customFieldList += New-CustomField -Id $configuration.Acmp.CustomFields.Velocity -Value $data.Velocity
511 +
512 +# Saving the custom fields
513 +Save-CustomFieldList -AssetId $asset.Id -CustomFieldList $customFieldList
514 +{{/code}}
515 +
391 391  = Fehlerbehandlung =
392 392  
518 +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.
519 +
520 +|=(% style="width: 715px;" %)Fehler|=(% style="width: 724px;" %)Ansätze zur Fehlerbehandlung
521 +|(% 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.
522 +|(% 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.
523 +|(% 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.
524 +|(% 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.
525 +
393 393  = Orchestrierung =
527 +
528 +
PowerShell-Modul implementeren.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.jklein
Size
... ... @@ -1,0 +1,1 @@
1 +29.6 KB
Content
Visual Studio Code_AESB Shell.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.jklein
Size
... ... @@ -1,0 +1,1 @@
1 +21.5 KB
Content
© Aagon GmbH 2025
Besuchen Sie unsere neue Aagon-Community