Changes for page Entwicklung eines ACMP Connectors für die ISS
Last modified by jklein on 2025/02/13 13:15
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Attachments (0 modified, 1 added, 0 removed)
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. M icroservice.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. ... ... @@ -124,7 +124,7 @@ 124 124 1. Klicken Sie mit einem Rechtsklick auf den Ordner //ISS_ACMP_Connector//, um das Kontextmenü zu öffnen. 125 125 1. Wählen Sie im Kontextmenü den Eintrag //Mit Code öffnen //aus, damit direkt das richtige Verzeichnis geöffnet wird. 126 126 1. Erstellen Sie einen neuen Unterordner mit dem Namen //Modules.// 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 //M icroservice.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. 128 128 1. Fügen Sie den nachfolgenden Code in die Datei ein. 129 129 1. Drücken Sie Strg + S, um die Datei zu speichern. 130 130 ... ... @@ -381,12 +381,199 @@ 381 381 1. Erstellen Sie die Vorlage// ISSRestConnector. //Klicken Sie in der Ribbonleiste auf den Button //Speichern.// 382 382 1. Wiederholen Sie Schritt 3 und Schritt 4 für die Erstellung der Vorlage //ISSAssetImporter//. 383 383 384 -== PowerShell-Module int egrieren ==384 +== PowerShell-Module implementieren == 385 385 386 +Die Implementierung der Module in die PowerShell-Microservices erfolgt an zwei Stellen: In der Modul-Verwaltung und im Skript-Editor. 387 + 388 +=== PowerShell-Module in der Modul-Verwaltung hochladen === 389 + 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 + 386 386 {{aagon.warnungsbox}} 387 -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]]. 388 388 {{/aagon.warnungsbox}} 389 389 407 +(% class="wikigeneratedid" %) 408 +**ISSRestConnector - Skript** 409 + 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. 412 + 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 - Skript** 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 + 516 +== Microservice-Schema erstellen == 517 + 518 +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. 519 + 520 +{{aagon.infobox}} 521 +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. 522 +{{/aagon.infobox}} 523 + 524 + 525 + 526 +(% class="wikigeneratedid" %) 527 +**ISSRestConnector - Schema** 528 + 529 +(% class="wikigeneratedid" %) 530 +Für den ISSRestConnector müssen drei Datenfelder angelegt werden. 531 + 532 +1. Wählen Sie den Microservice //ISSRestConnector //aus und klicken Sie in der Ribbonleiste auf den Button //Schema//. 533 +1. Klicken Sie in der Ribbonleiste des Schema-Designers auf //Hinzufügen, //um den Schemaknoten //Alias //vom Typ //SchemaString// anzulegen. 534 +1. Konfigurieren Sie den Schemaknoten //Alias //entsprechend den Daten in der nachfolgenden Tabelle. 535 +1. Wiederholen Sie die Schritte 1 bis 3 für die weiteren Schemaknoten //ApiUrl //und //Target//. 536 +1. Klicken Sie in der Ribbonleiste des Schema-Designers auf //Speichern//, um das Schema zu speichern. 537 +1. Schließen Sie den Schema-Designer. 538 + 539 +|=(% style="width: 283px;" %)Datenfeld/Schemaknoten|=(% style="width: 372px;" %)Alias|=(% style="width: 415px;" %)ApiUrl|=(% style="width: 370px;" %)Target 540 +|=(% style="width: 283px;" %)Anzeigename|(% style="width:372px" %)Alias|(% style="width:415px" %)API Url|(% style="width:370px" %)Target 541 +|=(% style="width: 283px;" %)Beschreibung|(% style="width:372px" %)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 542 +|=(% style="width: 283px;" %)Erforderlich|(% style="width:372px" %)Ja|(% style="width:415px" %)Ja|(% style="width:370px" %)Ja 543 +|=(% style="width: 283px;" %)Initialwert|(% style="width:372px" %)ISS2ACMP.ISSRestConnector|(% style="width:415px" %)https:~/~/api.wheretheiss.at/v1/satellites/25544|(% style="width:370px" %)ISS2ACMP.ISSAcmpAssetImporter 544 + 545 + 546 + 547 +**ISSAssetImporter - Schema** 548 + 549 +(% class="wikigeneratedid" %) 550 +Der ISSRestConnector soll zu einstellbaren Zeiten die Daten von der Rest API holen. Dafür werden die Skript-Events //.OnStart// und //.OnExecute //entsprechend angepasst. 551 + 552 +1. Wählen Sie den Microservice //ISSAssetImporter //aus und klicken Sie in der Ribbonleiste auf den Button //Schema//. 553 +1. Klicken Sie in der Ribbonleiste des Schema-Designers auf //Hinzufügen, //um den Schemaknoten //Alias //vom Typ //SchemaString// anzulegen. 554 +1. Konfigurieren Sie den Schemaknoten //Alias //entsprechend den Daten in der nachfolgenden Tabelle. 555 +1. Wiederholen Sie die Schritte 1 bis 3 für die weiteren Schemaknoten //ApiUrl //und //Target//. 556 +1. Klicken Sie in der Ribbonleiste des Schema-Designers auf //Speichern//, um das Schema zu speichern. 557 +1. Schließen Sie den Schema-Designer. 558 + 559 +|=(% style="width: 283px;" %)Datenfeld/Schemaknoten|=(% style="width: 372px;" %)Alias|=(% style="width: 415px;" %)ApiUrl|=(% style="width: 370px;" %)Target 560 +|=(% style="width: 283px;" %)Anzeigename|(% style="width:372px" %) |(% style="width:415px" %) |(% style="width:370px" %) 561 +|=(% style="width: 283px;" %)Beschreibung|(% style="width:372px" %) |(% style="width:415px" %) |(% style="width:370px" %) 562 +|=(% style="width: 283px;" %)Erforderlich|(% style="width:372px" %) |(% style="width:415px" %) |(% style="width:370px" %) 563 +|=(% style="width: 283px;" %)Initialwert|(% style="width:372px" %) |(% style="width:415px" %) |(% style="width:370px" %) 564 + 390 390 = Fehlerbehandlung = 391 391 567 +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. 568 + 569 +|=(% style="width: 715px;" %)Fehler|=(% style="width: 724px;" %)Ansätze zur Fehlerbehandlung 570 +|(% 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. 571 +|(% 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. 572 +|(% 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. 573 +|(% 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. 574 + 392 392 = Orchestrierung = 576 + 577 += Datei-Download = 578 + 579 +Das komplette Dateiverzeichnis mit allen Dateien, die Sie in diesem Best Practice selbstständig erstellt haben, finden Sie ebenfalls zum Herunterladen in unserer Community.
- PowerShell-Modul implementeren.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.jklein - Size
-
... ... @@ -1,0 +1,1 @@ 1 +29.6 KB - Content