Last modified by jklein on 2025/02/13 13:15
From version 27.2
edited by jklein
on 2025/02/11 10:41
Change comment: There is no comment for this version
To version 31.1
edited by jklein
on 2025/02/12 15:47
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -98,9 +98,28 @@
98 98  
99 99  Der Assettyp //Spacestation //ist nun in der Liste verfügbar und hat die entsprechenden benutzerdefinierten Felder.
100 100  
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"]]
101 +[[Neuer Assettyp mit benutzerdefinierten Feldern für die ISS-Daten>>image:Assettyp_ISS Connector.png]]
103 103  
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 +
104 104  = Entwicklung der Microservices =
105 105  
106 106  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:
... ... @@ -521,8 +521,6 @@
521 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 522  {{/aagon.infobox}}
523 523  
524 -
525 -
526 526  (% class="wikigeneratedid" %)
527 527  **ISSRestConnector - Schema**
528 528  
... ... @@ -530,38 +530,50 @@
530 530  Für den ISSRestConnector müssen drei Datenfelder angelegt werden.
531 531  
532 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.
550 +1. Klicken Sie im Schema-Designer auf //Hinzufügen, //um den SchemaString //Alias// anzulegen.
534 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.
552 +1. Wiederholen Sie die Schritte 1 bis 3 für die weiteren SchemaStrings //ApiUrl //und //Target//.
553 +1. Klicken Sie im Schema-Designer auf //Speichern//, um das Schema zu speichern.
537 537  1. Schließen Sie den Schema-Designer.
538 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
556 +|=(% style="width: 225px;" %)Datenfeld/Schemaknoten|=(% style="width: 430px;" %)Alias|=(% style="width: 415px;" %)ApiUrl|=(% style="width: 370px;" %)Target
557 +|=(% style="width: 225px;" %)Anzeigename|(% style="width:430px" %)Alias|(% style="width:415px" %)API Url|(% style="width:370px" %)Target
558 +|=(% 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
559 +|=(% style="width: 225px;" %)Erforderlich|(% style="width:430px" %)Ja|(% style="width:415px" %)Ja|(% style="width:370px" %)Ja
560 +|=(% style="width: 225px;" %)Initialwert|(% style="width:430px" %)ISS2ACMP.ISSRestConnector|(% style="width:415px" %)https:~/~/api.wheretheiss.at/v1/satellites/25544|(% style="width:370px" %)ISS2ACMP.ISSAcmpAssetImporter
544 544  
562 +[[Schema mit Datenfeldern für den ISSRestConnector>>image:Schema_ISSRestConnector.png||alt="Schema mit Datenfeldern für den ISSRestConnector"]]
545 545  
546 -
547 547  **ISSAssetImporter - Schema**
548 548  
549 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.
567 +Für den ISSAssetImporter müssen zwei Schema-Objekte und insgesamt sieben Datenfelder angelegt werden
551 551  
552 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.
570 +1. Klicken Sie im Schema-Designer auf //Hinzufügen, //um den SchemaString //Alias //anzulegen.
554 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//.
572 +
573 +__Acmp: SchemaObject__
574 +
575 +Nun wird das erste SchemaObject erstellt. Alle weiteren SchemaStrings und auch das zweite SchemaObject werden unter dem SchemaObject //Acmp// untergliedert.
576 +
577 +1. Klicken Sie im Schema-Designer auf //Hinzufügen, //um das SchemaObject //Acmp// anzulegen.
578 +1. Wählen Sie das angelegte SchemaObject //Acmp //aus und legen Sie alle weiteren Schemaknoten innerhalb dieses SchemaObjects an.
579 +1. Klicken Sie im Schema-Designer auf //Hinzufügen //und legen Sie nacheinander die SchemaStrings //AssetTypeName //und //AssetStateId// an.
580 +1. Klicken Sie im Schema-Designer auf //Hinzufügen //und legen Sie das SchemaObject //CustomFields //an.
581 +1. Klicken Sie im Schema-Designer auf //Hinzufügen //und legen Sie nacheinander die SchemaStrings //Latitude, Longitude, Altitude //und //Velocity //an.
582 +1. Konfigurieren Sie alle SchemaStrings// //entsprechend den Daten in der nachfolgenden Tabelle.
556 556  1. Klicken Sie in der Ribbonleiste des Schema-Designers auf //Speichern//, um das Schema zu speichern.
557 557  1. Schließen Sie den Schema-Designer.
558 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" %)
586 +|=(% 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
587 +|=(% 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
588 +|=(% 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
589 +|=(% 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
590 +|=(% 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"]]
564 564  
592 +[[Schema mit Datenfeldern für den ISSRestConnector>>image:Schema_ISSAssetImporter.png||alt="Schema mit Datenfeldern für den ISSRestConnector"]]
593 +
565 565  = Fehlerbehandlung =
566 566  
567 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.
... ... @@ -574,6 +574,32 @@
574 574  
575 575  = Orchestrierung =
576 576  
606 +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.
607 +
608 +== Ausführungslogik testen ==
609 +
610 +1. Wählen Sie den Microservice //ISSAssetImporter //aus und klicken Sie in der Ribbonleiste auf den Button //Skript//.
611 +1. Wechseln Sie im Skript-Editor in den Tab //Testen//.
612 +1. Klicken Sie auf den Button //Testkonfiguration hinzufügen.//
613 +1. Geben Sie das Passwort für den aktiven Benutzer ein.
614 +1. Klicken Sie auf den Button //Starten//, um die Testkonfiguration zu starten.
615 +1. Wählen Sie den Microservice //ISSRestConnector //aus und klicken Sie in der Ribbonleiste auf den Button //Skript//.
616 +1. Wechseln Sie im Skript-Editor in den Tab //Testen//.
617 +1. Klicken Sie auf den Button //Testkonfiguration hinzufügen.//
618 +1. Geben Sie das Passwort für den aktiven Benutzer ein.
619 +1. Wählen Sie den Eintrag //Zeitplanung //aus und klicken Sie auf den Button //Bearbeiten//.
620 +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.
621 +1. Klicken Sie auf den Button //Speichern.//
622 +1. Klicken Sie auf den Button //Starten//, um die Testkonfiguration zu starten.
623 +
624 +{{aagon.warnungsbox}}
625 +Beachten Sie, dass für eine korrekte Test-Ausführung beide Microservices als Testkonfigurationen gestartet sein müssen. Ansonsten schlägt die Testkonfiguration fehl.
626 +{{/aagon.warnungsbox}}
627 +
628 +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.
629 +
630 +[[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"]]
631 +
577 577  = Datei-Download =
578 578  
579 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.
AESB Shell_Custom Fields abfragen.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.jklein
Size
... ... @@ -1,0 +1,1 @@
1 +47.3 KB
Content
Ausgeführte Testkonfiguration.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.jklein
Size
... ... @@ -1,0 +1,1 @@
1 +93.0 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
© Aagon GmbH 2025
Besuchen Sie unsere neue Aagon-Community