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, 0 added, 4 removed)
Details
- Page properties
-
- Content
-
... ... @@ -98,28 +98,9 @@ 98 98 99 99 Der Assettyp //Spacestation //ist nun in der Liste verfügbar und hat die entsprechenden benutzerdefinierten Felder. 100 100 101 -[[Neuer Assettyp mit benutzerdefinierten Feldern für die ISS-Daten>>image:Assettyp_ISS Connector.png]] 101 +(% style="width: 500px;" %) 102 +[[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"]] 102 102 103 -== IDs der benutzerdefinierten Felder abfragen == 104 - 105 -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 106 - 107 -{{aagon.infobox}} 108 -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]]__. 109 -{{/aagon.infobox}} 110 - 111 -Wenn diese Voraussetzungen erfüllt sind, können Sie folgendes Cmdlet ausführen: 112 - 113 -{{code language="PowerShell"}} 114 -$response = Acmp-GetCustomFieldList_V2 115 -$response.CustomFields | Where-Object {@("Latitude", "Longitude", "Altitude", "Velocity") -contains $_.Caption_EN} | select Caption_EN, Id 116 -{{/code}} 117 - 118 -(% class="wikigeneratedid" %) 119 -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. 120 - 121 -[[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"]] 122 - 123 123 = Entwicklung der Microservices = 124 124 125 125 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: ... ... @@ -540,6 +540,8 @@ 540 540 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. 541 541 {{/aagon.infobox}} 542 542 524 + 525 + 543 543 (% class="wikigeneratedid" %) 544 544 **ISSRestConnector - Schema** 545 545 ... ... @@ -583,15 +583,12 @@ 583 583 1. Klicken Sie in der Ribbonleiste des Schema-Designers auf //Speichern//, um das Schema zu speichern. 584 584 1. Schließen Sie den Schema-Designer. 585 585 586 -(% style="width:1397px" %) 587 -|=(% style="width: 224px;" %)Datenfeld/Schemaknoten|=(% style="width: 216px;" %)Alias|=(% style="width: 163px;" %)AssetTypeName|=(% style="width: 141px;" %)AssetStateId|=(% style="width: 143px;" %)Latitude|=(% style="width: 113px;" %)Longitude|=(% style="width: 118px;" %)Altitude|=(% style="width: 148px;" %)Velocity 588 -|=(% style="width: 224px;" %)Anzeigename|(% style="width:216px" %)Alias|(% style="width:163px" %)AssetTypeName|(% style="width:141px" %)AssetStateId|(% style="width:143px" %)Latitude|(% style="width:113px" %)Longitude|(% style="width:118px" %)Altitude|(% style="width:148px" %)Velocity 589 -|=(% style="width: 224px;" %)Beschreibung|(% style="width:216px" %)- |(% style="width:163px" %)Name des Assettypes, welcher für die ISS verwendet werden soll.|(% style="width:141px" %)-|(% style="width:143px" %)ID des Custom Fields|(% style="width:113px" %)ID des Custom Fields|(% style="width:118px" %)ID des Custom Fields|(% style="width:148px" %)ID des Custom Fields 590 -|=(% style="width: 224px;" %)Erforderlich|(% style="width:216px" %)Ja|(% style="width:163px" %)Ja|(% style="width:141px" %)Ja|(% style="width:143px" %)Ja|(% style="width:113px" %)Ja|(% style="width:118px" %)Ja|(% style="width:148px" %)Ja 591 -|=(% style="width: 224px;" %)Initialwert|(% style="width:216px" %)ISS2ACMP.ISSAcmpAssetImporter|(% style="width:163px" %)Spacestation|(% style="width:141px" %){7BDAC345-C25E-44C9-B220-CBA3CCCD19A7}|(% style="width:143px" %)[[//{ID des benutzerdefinierten Feldes}//>>doc:||anchor="HIDsderbenutzerdefiniertenFelderabfragen"]]|(% style="width:113px" %)[[//{ID des benutzerdefinierten Feldes}//>>doc:||anchor="HIDsderbenutzerdefiniertenFelderabfragen"]]|(% style="width:118px" %)[[//{ID des benutzerdefinierten Feldes}//>>doc:||anchor="HIDsderbenutzerdefiniertenFelderabfragen"]]|(% style="width:148px" %)[[//{ID des benutzerdefinierten Feldes}//>>doc:||anchor="HIDsderbenutzerdefiniertenFelderabfragen"]] 569 +|=(% style="width: 224px;" %)Datenfeld/Schemaknoten|=(% style="width: 214px;" %)Alias|=(% style="width: 173px;" %)AssetTypeName|=(% style="width: 120px;" %)AssetStateId|=(% style="width: 114px;" %)Latitude|=(% style="width: 370px;" %)Longitude|=(% style="width: 370px;" %)Altitude|=(% style="width: 370px;" %)Velocity 570 +|=(% style="width: 224px;" %)Anzeigename|(% style="width:214px" %)Alias|(% style="width:173px" %)AssetTypeName|(% style="width:120px" %)AssetStateId|(% style="width:114px" %) |(% style="width:370px" %) |(% style="width:370px" %) |(% style="width:370px" %) 571 +|=(% style="width: 224px;" %)Beschreibung|(% style="width:214px" %)- |(% style="width:173px" %)Name des Assettypes, welcher für die ISS verwendet werden soll.|(% style="width:120px" %)-|(% style="width:114px" %) |(% style="width:370px" %) |(% style="width:370px" %) |(% style="width:370px" %) 572 +|=(% style="width: 224px;" %)Erforderlich|(% style="width:214px" %)Ja|(% style="width:173px" %)Ja|(% style="width:120px" %)Ja|(% style="width:114px" %) |(% style="width:370px" %) |(% style="width:370px" %) |(% style="width:370px" %) 573 +|=(% style="width: 224px;" %)Initialwert|(% style="width:214px" %)ISS2ACMP.ISSAcmpAssetImporter|(% style="width:173px" %)Spacestation|(% style="width:120px" %) |(% style="width:114px" %) |(% style="width:370px" %) |(% style="width:370px" %) |(% style="width:370px" %) 592 592 593 -[[Schema mit Datenfeldern für den ISSRestConnector>>image:Schema_ISSAssetImporter.png||alt="Schema mit Datenfeldern für den ISSRestConnector"]] 594 - 595 595 = Fehlerbehandlung = 596 596 597 597 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. ... ... @@ -604,73 +604,6 @@ 604 604 605 605 = Orchestrierung = 606 606 607 -Abschließend müssen Sie noch die Ausführungslogik festlegen. Dafür können Sie die PowerShell-Microservices entweder erst in einer Testkonfiguration ausführen oder die PowerShell-Microservices direkt als Microservice-Pakete bereitstellen und die Ausführungslogik in den produktiven Microservices 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. 608 - 609 -== Microservices testen == 610 - 611 -Die Erstellung und Ausführung einer Testkonfiguration ist im Skript-Editor möglich. 612 - 613 -1. Wählen Sie den Microservice //ISSAssetImporter //aus und klicken Sie in der Ribbonleiste auf den Button //Skript//. 614 -1. Wechseln Sie im Skript-Editor in den Tab //Testen//. 615 -1. Klicken Sie auf den Button //Testkonfiguration hinzufügen.// 616 -1. Geben Sie das Passwort für den aktiven Benutzer ein. 617 -1. Klicken Sie auf den Button //Starten//, um die Testkonfiguration zu starten. 618 -1. Wählen Sie den Microservice //ISSRestConnector //aus und klicken Sie in der Ribbonleiste auf den Button //Skript//. 619 -1. Wechseln Sie im Skript-Editor in den Tab //Testen//. 620 -1. Klicken Sie auf den Button //Testkonfiguration hinzufügen.// 621 -1. Geben Sie das Passwort für den aktiven Benutzer ein. 622 -1. Wählen Sie den Eintrag //Zeitplanung //aus und klicken Sie auf den Button //Bearbeiten//. 623 -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. 624 -1. Klicken Sie auf den Button //Speichern.// 625 -1. Klicken Sie auf den Button //Starten//, um die Testkonfiguration zu starten. 626 - 627 -{{aagon.warnungsbox}} 628 -Beachten Sie, dass für eine korrekte Test-Ausführung beide Microservices als Testkonfigurationen gestartet sein müssen. Ansonsten schlägt die Testkonfiguration fehl. 629 -{{/aagon.warnungsbox}} 630 - 631 -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 schickt die Daten an den ISSAssetImporter-Microservice, wodurch das Skript //ISSAssetImporter.OnMessage// angestoßen wird. Das Ergebnis sollte eine erfolgreiche Ausfü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. 632 - 633 -[[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"]] 634 - 635 -== Microservices bereitstellen == 636 - 637 -Nach dem erfolgreichen Test oder auch ohne die Durchführung einer Testkonfiguration, können Sie die PowerShell-Microservices nun für die produktive Nutzung im Microservice-Workspace bereitstellen und dort die Ausführungslogik festlegen. 638 - 639 -1. Wählen Sie den PowerShell-Microservice //ISSRestConnector //aus und klicken Sie in der Ribbonleiste auf den Button //Bereitstellen//. 640 -1. Warten Sie bis der Microservice fertig importiert wurde. 641 -1. Wiederholen Sie beide Schritte für den //ISSAssetImporter//. 642 - 643 -(% class="wikigeneratedid" %) 644 -Beide Microservices sind nun im Microservice-Workspace als Microservice-Pakete verfügbar. 645 - 646 -== Microservice-Instanzen erstellen == 647 - 648 -Für die produktive Nutzung müssen aus den Microservice-Paketen abschließend noch die Microservice-Instanzen erstellt werden. 649 - 650 -**ISSAssetImporter - Microservice-Instanz** 651 - 652 -1. Wechseln Sie in den Microservice-Workspace. 653 -1. Klicken Sie mit Doppelklick auf das Microservice-Paket //ISSAssetImporter //und wählen Sie die untergeordnete Paket-Version aus. 654 -1. Klicken Sie in der Ribbonleiste auf den Button //Hinzufügen//, um eine Microservice-Vorlage zu erstellen. 655 -1. Vergeben Sie einen Vorlagennamen. 656 -1. Klicken Sie in der Ribbonleiste auf den Button //Speichern//. 657 -1. Klicken Sie in der Ribbonleiste auf den Button //Hinzufügen//, um eine Microservice-Instanz zu erstellen. 658 -1. Konfigurieren Sie die Microservice-Instanz im Dialogfenster. 659 -1. Klicken Sie auf den Button //Speichern//, um die Microservice-Instanz hinzuzufügen. 660 - 661 -(% class="wikigeneratedid" %) 662 -**ISSRestConnector - Microservice-Instanz** 663 - 664 -1. Klicken Sie mit Doppelklick auf das Microservice-Paket //ISSRestConnector //und wählen Sie die untergeordnete Paket-Version aus. 665 -1. Klicken Sie in der Ribbonleiste auf den Button //Hinzufügen//, um eine Microservice-Vorlage zu erstellen. 666 -1. Vergeben Sie einen Vorlagennamen und konfigurieren Sie die Zeitplanung für die Abfrage der Daten von der Rest Api. 667 -1. Klicken Sie in der Ribbonleiste auf den Button //Speichern//. 668 -1. Klicken Sie in der Ribbonleiste auf den Button //Hinzufügen//, um eine Microservice-Instanz zu erstellen. 669 -1. Konfigurieren Sie die Microservice-Instanz im Dialogfenster. 670 -1. Klicken Sie auf den Button //Speichern//, um die Microservice-Instanz hinzuzufügen. 671 - 672 -Nun sollten beide Microservice-Instanzen angelegt und gestartet sein. Entsprechend der festgelegten Zeitplanung vom ISSRestConnector werden nun die benutzerdefinierten Felder im Asset Management in ACMP regelmäßig aktualisiert. 673 - 674 674 = Datei-Download = 675 675 676 676 Das komplette Dateiverzeichnis mit allen Dateien, die Sie in diesem Best Practice selbstständig erstellt haben, finden Sie ebenfalls zum Herunterladen in unserer Community.
- AESB Shell_Custom Fields abfragen.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.jklein - Size
-
... ... @@ -1,1 +1,0 @@ 1 -47.3 KB - Content
- Ausgeführte Testkonfiguration.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.jklein - Size
-
... ... @@ -1,1 +1,0 @@ 1 -93.0 KB - Content
- Schema_ISSAssetImporter.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.jklein - Size
-
... ... @@ -1,1 +1,0 @@ 1 -71.4 KB - Content
- Schema_ISSRestConnector.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.jklein - Size
-
... ... @@ -1,1 +1,0 @@ 1 -48.1 KB - Content