Changes for page Entwicklung eines ACMP Connectors für die ISS

Summary

• Page properties (1 modified, 0 added, 0 removed)
• Attachments (0 modified, 0 added, 3 removed)
  • PowerShell-Modul implementeren.png
  • Schema_ISSAssetImporter.png
  • Schema_ISSRestConnector.png

Details

Page properties

Content

...	...	@@ -98,12 +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 Konfiguration der Microservices benötigen Sie die IDs des Assettyps und der benutzerdefinierten Felder.
106		-
107	107	= Entwicklung der Microservices =
108	108
109	109	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:
...	...	@@ -395,9 +395,9 @@
395	395	1. Wählen Sie die PowerShell-Vorlage //ISSRestConnector //aus und klicken Sie in der Ribbonleiste auf den Button //Module//.
396	396	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}}
397	397	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.
398		-1. Wiederholen Sie die Schritte für den Microservice ISSAssetImporter mit den Modulen //ISSAssetImporter.psm1 //und //ACMP Public API// (Änderung des Modul-Typs erforderlich).
	395	+1. Wiederholen Sie die Schritte für den Microservice ISSAssetImporter mit dem Modul //ISSAssetImporter.psm1 //und dem Modul //ACMP Public API// (Modul-Typ ändern).
399	399
400		-[[PowerShell-Modul implementieren>>image:PowerShell-Modul implementeren.png||alt="PowerShell-Modul implementieren" data-xwiki-image-style-alignment="center" height="355" width="800"]]
	397	+-> Bild einfügen
401	401
402	402	=== PowerShell-Module in Microservice-Skripten aufrufen ===
403	403
...	...	@@ -408,185 +408,65 @@
408	408	{{/aagon.warnungsbox}}
409	409
410	410	(% class="wikigeneratedid" %)
411		-**ISSRestConnector - Skript**
	408	+**ISSRestConnector**
412	412
413	413	(% class="wikigeneratedid" %)
414		-Der ISSRestConnector soll zu einstellbaren Zeiten die Daten von der Rest API holen. Dafür werden die Skript-Events //.OnStart// und //.OnExecute //entsprechend angepasst.
	411	+Der ISSRestConnector soll zu einstellbaren Zeiten die Daten von der Rest API holen. Daher werden die Skript-Events //.OnStart// und //.OnExecute //entsprechend angepasst.
415	415
416	416	1. Wählen Sie den Microservice //ISSRestConnector //aus und klicken Sie in der Ribbonleiste auf den Button //Skript//.
417	417	1. Wechseln Sie in den Skript-Tab //OnStart //und fügen Sie den nachfolgenden Code in die Datei ein.
418	418	1. Wechseln Sie in den Skript-Tab //OnExecute //und fügen Sie den nachfolgenden Code in die Datei ein.
419		-1. Drücken Sie Strg + S, um die Datei zu speichern.
420		-1. Schließen Sie den Skript-Editor.
421	421
422		-{{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnector.OnStart**"}}
	417	+|(% style="width:698px" %){{code}}#
	418	+# This gets executed perpetually by the scheduler. Main business logic should go here.
423	423	#
424		-# This gets executed once the Microservice has started.
425		-#
426		-
427		-$message = "Starting ISS2ACMP.REST"
428	428
429		-Write-Host $message
430		-Write-BusinessLog $message
431		-
432		-# Registering Alias
433		-Set-AESBSelfAsAlias -Alias $configuration.Alias -RemoveExistingAlias
434		-{{/code}}
435		-
436		-{{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnector.OnExecute**"}}
437		-#
	421	+try {
	422	+ # Trying to fetch new data
	423	+ Write-Host "Fetching new data from the api."
	424	+ $result = Get-ISSData -ApiUrl $configuration.ApiUrl
	425	+
	426	+ # Converting the data to icql
	427	+ $icql = ConvertTo-AESBIcql $result
	428	+
	429	+ # Sending the data to the next microserice
	430	+ Publish-AESBMessage -Alias $configuration.Target -Message $icql
	431	+}
	432	+catch {
	433	+ Write-Error $_
	434	+}{{/code}}|(% style="width:928px" %){{code}}#
438	438	# This gets executed perpetually by the scheduler. Main business logic should go here.
439	439	#
440		-
441		-try {
442		- # Trying to fetch new data
443		- Write-Host "Fetching new data from the api."
444		- $result = Get-ISSData -ApiUrl $configuration.ApiUrl
445	445
446		- # Converting the data to icql
447		- $icql = ConvertTo-AESBIcql $result
448		-
449		- # Sending the data to the next microserice
450		- Publish-AESBMessage -Alias $configuration.Target -Message $icql
	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
451	451	}
452	452	catch {
453		- Write-Error $_
454		-}
455		-{{/code}}
	450	+ Write-Error $_
	451	+}{{/code}}
456	456
457	457	(% class="wikigeneratedid" %)
458		-**ISSAssetImporter - Skript**
	454	+**ISSAssetImporter**
459	459
460		-(% class="wikigeneratedid" %)
461		-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.
462	462
463		-1. Wählen Sie den Microservice //ISSAssetImporter //aus und klicken Sie in der Ribbonleiste auf den Button //Skript//.
464		-1. Wechseln Sie in den Skript-Tab //OnStart //und fügen Sie den nachfolgenden Code in die Datei ein.
465		-1. Wechseln Sie in den Skript-Tab //OnMessage //und fügen Sie den nachfolgenden Code in die Datei ein.
466		-1. Drücken Sie Strg + S, um die Datei zu speichern.
467		-1. Schließen Sie den Skript-Editor.
468	468
469		-{{code language="PowerShell" layout="LINENUMBERS" title="**ISSAssetImporter.OnStart**"}}
470		-#
471		-# This gets executed once the Microservice has started.
472		-#
473		-
474		-$message = "Starting ISS2ACMP.ACMPImporter"
	458	+(% class="wikigeneratedid" %)
475	475
476		-Write-Host $message
477		-Write-BusinessLog $message
478	478
479		-# Registering Alias
480		-Set-AESBSelfAsAlias -Alias $configuration.Alias -RemoveExistingAlias
481		-{{/code}}
482		-
483		-{{code language="PowerShell" layout="LINENUMBERS" title="**ISSAssetImporter.OnMessage**"}}
484		-#
485		-# This gets executed when a message is received.
486		-#
487		-# The received message can be accessed via $msg
488		-# To retrieve only the body from the message use $body
489		-#
490		-
491		-# Getting msg data
492		-$msg = New-Message -Args $args
493		-$body = New-MessageBody -Args $args
494		-
495		-# Converting from icql to PSCustomObject
496		-$data = ConvertFrom-AESBIcql -Icql $body
497		-Write-Host $data
498		-
499		-# Getting the AssetTypeId
500		-$assetTypeId = Get-AssetTypeId -AssetTypeName $configuration.Acmp.AssetTypeName
501		-
502		-# Trying to get the asset if it is already present in acmp
503		-$asset = Get-ISSAsset -AssetTypeId $assetTypeId -AssetTypeName $configuration.Acmp.AssetTypeName -AssetStateId $configuration.Acmp.AssetStateId -ISS $data
504		-
505		-# Saving the asset
506		-Save-ISSAsset -ISSAsset $asset
507		-
508		-# Creating the custom fields
509		-$customFieldList = @()
510		-$customFieldList += New-CustomField -Id $configuration.Acmp.CustomFields.Latitude -Value $data.Latitude
511		-$customFieldList += New-CustomField -Id $configuration.Acmp.CustomFields.Longitude -Value $data.Longitude
512		-$customFieldList += New-CustomField -Id $configuration.Acmp.CustomFields.Altitude -Value $data.Altitude
513		-$customFieldList += New-CustomField -Id $configuration.Acmp.CustomFields.Velocity -Value $data.Velocity
514		-
515		-# Saving the custom fields
516		-Save-CustomFieldList -AssetId $asset.Id -CustomFieldList $customFieldList
517		-{{/code}}
518		-
519	519	== Microservice-Schema erstellen ==
520	520
521		-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.
522		-
523		-{{aagon.infobox}}
524		-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.
525		-{{/aagon.infobox}}
526		-
527		-(% class="wikigeneratedid" %)
528		-**ISSRestConnector - Schema**
529		-
530		-(% class="wikigeneratedid" %)
531		-Für den ISSRestConnector müssen drei Datenfelder angelegt werden.
532		-
533		-1. Wählen Sie den Microservice //ISSRestConnector //aus und klicken Sie in der Ribbonleiste auf den Button //Schema//.
534		-1. Klicken Sie im Schema-Designer auf //Hinzufügen, //um den SchemaString //Alias// anzulegen.
535		-1. Konfigurieren Sie den Schemaknoten //Alias //entsprechend den Daten in der nachfolgenden Tabelle.
536		-1. Wiederholen Sie die Schritte 1 bis 3 für die weiteren SchemaStrings //ApiUrl //und //Target//.
537		-1. Klicken Sie im Schema-Designer auf //Speichern//, um das Schema zu speichern.
538		-1. Schließen Sie den Schema-Designer.
539		-
540		-|=(% style="width: 225px;" %)Datenfeld/Schemaknoten|=(% style="width: 430px;" %)Alias|=(% style="width: 415px;" %)ApiUrl|=(% style="width: 370px;" %)Target
541		-|=(% style="width: 225px;" %)Anzeigename|(% style="width:430px" %)Alias|(% style="width:415px" %)API Url|(% style="width:370px" %)Target
542		-|=(% 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
543		-|=(% style="width: 225px;" %)Erforderlich|(% style="width:430px" %)Ja|(% style="width:415px" %)Ja|(% style="width:370px" %)Ja
544		-|=(% style="width: 225px;" %)Initialwert|(% style="width:430px" %)ISS2ACMP.ISSRestConnector|(% style="width:415px" %)https:~/~/api.wheretheiss.at/v1/satellites/25544|(% style="width:370px" %)ISS2ACMP.ISSAcmpAssetImporter
545		-
546		-[[Schema mit Datenfeldern für den ISSRestConnector>>image:Schema_ISSRestConnector.png||alt="Schema mit Datenfeldern für den ISSRestConnector"]]
547		-
548		-**ISSAssetImporter - Schema**
549		-
550		-(% class="wikigeneratedid" %)
551		-Für den ISSAssetImporter müssen zwei Schema-Objekte und insgesamt sieben Datenfelder angelegt werden
552		-
553		-1. Wählen Sie den Microservice //ISSAssetImporter //aus und klicken Sie in der Ribbonleiste auf den Button //Schema//.
554		-1. Klicken Sie im Schema-Designer auf //Hinzufügen, //um den SchemaString //Alias //anzulegen.
555		-1. Konfigurieren Sie den Schemaknoten //Alias //entsprechend den Daten in der nachfolgenden Tabelle.
556		-
557		-__Acmp: SchemaObject__
558		-
559		-Nun wird das erste SchemaObject erstellt. Alle weiteren SchemaStrings und auch das zweite SchemaObject werden unter dem SchemaObject //Acmp// untergliedert.
560		-
561		-1. Klicken Sie im Schema-Designer auf //Hinzufügen, //um das SchemaObject //Acmp// anzulegen.
562		-1. Wählen Sie das angelegte SchemaObject //Acmp //aus und legen Sie alle weiteren Schemaknoten innerhalb dieses SchemaObjects an.
563		-1. Klicken Sie im Schema-Designer auf //Hinzufügen //und legen Sie nacheinander die SchemaStrings //AssetTypeName //und //AssetStateId// an.
564		-1. Klicken Sie im Schema-Designer auf //Hinzufügen //und legen Sie das SchemaObject //CustomFields //an.
565		-1. Klicken Sie im Schema-Designer auf //Hinzufügen //und legen Sie nacheinander die SchemaStrings //Latitude, Longitude, Altitude //und //Velocity //an.
566		-1. Konfigurieren Sie alle SchemaStrings// //entsprechend den Daten in der nachfolgenden Tabelle.
567		-1. Klicken Sie in der Ribbonleiste des Schema-Designers auf //Speichern//, um das Schema zu speichern.
568		-1. Schließen Sie den Schema-Designer.
569		-
570		-|=(% 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
571		-|=(% 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
572		-|=(% 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
573		-|=(% 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
574		-|=(% 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="IDsderbenutzerdefiniertenFelderabfragen"]]|(% style="width:114px" %)[[//{ID des benutzerdefinierten Feldes}//>>doc:||anchor="IDsderbenutzerdefiniertenFelderabfragen"]]|(% style="width:169px" %)[[//{ID des benutzerdefinierten Feldes}//>>doc:||anchor="IDsderbenutzerdefiniertenFelderabfragen"]]|(% style="width:177px" %)[[//{ID des benutzerdefinierten Feldes}//>>doc:||anchor="IDsderbenutzerdefiniertenFelderabfragen"]]
575		-
576		-[[Schema mit Datenfeldern für den ISSRestConnector>>image:Schema_ISSAssetImporter.png||alt="Schema mit Datenfeldern für den ISSRestConnector"]]
577		-
578	578	= Fehlerbehandlung =
579	579
580		-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.
	465	+- Language-Einstellungen in VS Code -> Syntax
581	581
582		-|=(% style="width: 715px;" %)Fehler|=(% style="width: 724px;" %)Ansätze zur Fehlerbehandlung
583		-|(% 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.
584		-|(% 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.
585		-|(% 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.
586		-|(% 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.
	467	+- SICS-Verbindung in ACMP + Zugriffsberechtigung aktiviert
587	587
588	588	= Orchestrierung =
589		-
590		-= Datei-Download =
591		-
592		-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,1 +1,0 @@
1		-XWiki.jklein

Size

...	...	@@ -1,1 +1,0 @@
1		-29.6 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