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

Summary

• Page properties (1 modified, 0 added, 0 removed)
• Attachments (0 modified, 3 added, 0 removed)
  • 1738156789994-903.png
  • Output_Pester Testing.png
  • Visual Studio Code_AESB Shell.png

Details

Page properties

Content

...	...	@@ -2,6 +2,10 @@
2	2
3	3	In diesem Best Practice möchten wir Ihnen anhand der Entwicklung eines ACMP Connectors aufzeigen, wie Sie PowerShell-Microservices für Ihre eigenen Projekte entwickeln und nutzen können. Als Beispiel-Projekt wird zur Veranschaulichung ein Connector entwickelt, mit dem die aktuellen Informationen zur Internationalen Raumstation (ISS) aus der öffentlichen REST API [[https:~~/~~/wheretheiss.at>>url:https://wheretheiss.at/]] abgerufen und über die ACMP Public API als Asset im ACMP angelegt bzw. aktualisiert werden. Ziel ist es, die Positions- und Statusdaten der ISS regelmäßig zu synchronisieren und damit immer auf die aktuellen Informationen im System zugreifen zu können.
4	4
	5	+{{aagon.infobox}}
	6	+Am Ende des Best Practice finden Sie das Verzeichnis ISSACMPConnector.zip mit allen Dateien dieses ACMP Connectors zum Herunterladen.
	7	+{{/aagon.infobox}}
	8	+
5	5	= Entwicklungsumgebung =
6	6
7	7	Als Entwicklungsumgebung für die Umsetzung dieses Beispiel-Projekts benötigen Sie:
...	...	@@ -11,13 +11,13 @@
11	11	* Eine installierte AESB Shell
12	12	* Eine erreichbare AESB Console
13	13
14		-=== Entwicklungsumgebung einrichten ===
	18	+== Entwicklungsumgebung einrichten ==
15	15
16	16	Sofern Sie Visual Studio Code mit der PowerShell-Erweiterung noch nicht installiert haben, befolgen Sie zunächst [[die Installationsanleitung von Microsoft>>https://learn.microsoft.com/de-de/powershell/scripting/dev-cross-plat/vscode/using-vscode?view=powershell-7.4#install-vs-code-and-the-powershell-extension]].
17	17
18	18	Wenn Sie Visual Studio Code mit der PowerShell-Erweiterung installiert haben, können Sie die AESB Shell in Visual Studio Code einrichten:
19	19
20		-1. Legen Sie einen neuen Ordner im Datei-Explorer an.
	24	+1. Legen Sie einen neuen Ordner mit dem Namen //ISSACMPConnector// im Datei-Explorer an.
21	21	1. Klicken Sie mit einem Rechtsklick auf den neuen Ordner, um das Kontextmenü zu öffnen.
22	22	1. Wählen Sie im Kontextmenü den Eintrag //Mit Code öffnen //aus, damit direkt das richtige Verzeichnis geöffnet wird.
23	23	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}}
...	...	@@ -42,6 +42,10 @@
42	42
43	43	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.
44	44
	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	+
	52	+
45	45	= Aufgabenteilung =
46	46
47	47	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.
...	...	@@ -48,7 +48,7 @@
48	48
49	49	Die Hauptaufgabe des ACMP Connector für die ISS ist es, die aktuellen Informationen zur Internationalen Raumstation (ISS) aus der öffentlichen REST API [[https:~~/~~/wheretheiss.at>>url:https://wheretheiss.at/]] abzurufen und über die ACMP Public API als Asset in dem ACMP anzulegen bzw. zu aktualisieren. Anhand dieser kurzen Projektdefinition lässt sich in diesem Beispiel erkennen, dass es zwei Teilaufgaben gibt: Erstens das Abrufen der Daten von der REST API und zweitens die Integration der bereitgestellten Daten in ACMP. Für jede Teilaufgabe wird ein eigener Service bzw. Microservice definiert:
50	50
51		-1. **Microservice 1: Datenabruf von der REST API**
	59	+1. **Microservice 1: Datenabruf von der REST API **
52	52	Der erste Service ruft die ISS-Daten (z.B. Position, Höhe, Geschwindigkeit) von der API ab und sendet diese an den zweiten Microservice.
53	53	1. **Microservice 2: Integration in ACMP**
54	54	Der zweite Service liest die vom ersten Service bereitgestellten Daten und überträgt sie mithilfe der Public API an den ACMP. Dabei wird entweder ein neues Asset für die ISS erstellt oder ein bestehendes Asset aktualisiert.
...	...	@@ -61,7 +61,7 @@
61	61
62	62	Die Daten für die ISS sollen in ACMP im Asset Management einem Asset hinzugefügt werden. Da es bislang allerdings keinen Assettypen für eine Raumstation gibt, muss dieser erst angelegt werden. Außerdem werden für die Daten der Raumstation neue benutzerdefinierte Felder benötigt, die ebenfalls erst angelegt werden müssen. So können Sie die Datenfelder dann direkt bei der Erstellung des neuen Assettypen hinzufügen.
63	63
64		-=== Benutzerdefinierte Felder erstellen ===
	72	+== Benutzerdefinierte Felder erstellen ==
65	65
66	66	Für die Erfassung von den Daten der Raumstation werden vier neue benutzerdefinierte Felder benötigt: //Latitude, Longitude, Altitude// und //Velocity//. Gehen Sie folgendermaßen vor, um das benutzerdefinierte Feld //Latitude// anzulegen:
67	67
...	...	@@ -77,7 +77,7 @@
77	77
78	78	[[Benutzerdefinierte Felder für die ISS-Daten>>image:Benutzerdefinierte Felder_ISS Connector.png||alt="Benutzerdefinierte Felder für die ISS-Daten"]]
79	79
80		-=== Assettypen erstellen ===
	88	+== Assettypen erstellen ==
81	81
82	82	Nun können Sie den benötigten Assettypen erstellen:
83	83
...	...	@@ -96,8 +96,294 @@
96	96
97	97	= Entwicklung der Microservices =
98	98
	107	+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:
99	99
	109	+1. Erstellen der PowerShell-Module
	110	+1. Testen der PowerShell-Module
	111	+1. Erstellen der PowerShell-Microservices in AESB
	112	+1. Integrieren der PowerShell-Module in die PowerShell-Microservices
100	100
	114	+=== PowerShell-Module erstellen ===
	115	+
	116	+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:
	117	+
	118	+* ISSRestConnector - Modul zum Abfragen der ISS-Daten
	119	+* ISSAssetImporter - Modul zum Speichern des Assets und der zugehörigen Custom Fields
	120	+
	121	+**ISSRestConnector**
	122	+
	123	+Das Modul zum Abfragen der ISS-Daten besteht aus einer einfachen Funktion, welche die REST API aufruft und das Ergebnis in ein PSCustomObject konvertiert.
	124	+
	125	+1. Klicken Sie mit einem Rechtsklick auf den Ordner //ISS_ACMP_Connector//, um das Kontextmenü zu öffnen.
	126	+1. Wählen Sie im Kontextmenü den Eintrag //Mit Code öffnen //aus, damit direkt das richtige Verzeichnis geöffnet wird.
	127	+1. Erstellen Sie einen neuen Unterordner mit dem Namen //Modules.//
	128	+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.
	129	+1. Fügen Sie den nachfolgenden Code in die Datei ein.
	130	+1. Drücken Sie Strg + S, um die Datei zu speichern.
	131	+
	132	+{{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnector.psm1**"}}
	133	+function Get-ISSData {
	134	+ <#
	135	+ .SYNOPSIS
	136	+ Queries the "Where the ISS at?" API to retrieve satellite data.
	137	+
	138	+ .DESCRIPTION
	139	+ This function fetches the data for the International Space Station (ISS) from the REST API endpoint
	140	+ https://api.wheretheiss.at/v1/satellites/25544 and returns the parsed response.
	141	+
	142	+ .OUTPUTS
	143	+ [PSCustomObject] - A custom object containing the ISS data.
	144	+
	145	+ .EXAMPLE
	146	+ Get-ISSData
	147	+ # Retrieves the current data for the ISS.
	148	+ #>
	149	+
	150	+ param (
	151	+ [string]$ApiUrl = "https://api.wheretheiss.at/v1/satellites/25544"
	152	+ )
	153	+
	154	+ try {
	155	+ # Perform the API request
	156	+ $response = Invoke-RestMethod -Uri $ApiUrl -Method Get
	157	+
	158	+ # Convert the response into a PowerShell object
	159	+ $result = [PSCustomObject]@{
	160	+ Name = $response.name
	161	+ Latitude = $response.latitude.ToString()
	162	+ Longitude = $response.longitude.ToString()
	163	+ Altitude = $response.altitude.ToString()
	164	+ Velocity = $response.velocity.ToString()
	165	+ }
	166	+
	167	+ return $result
	168	+ } catch {
	169	+ Write-Error "Failed to fetch ISS data: $_"
	170	+ }
	171	+}
	172	+{{/code}}
	173	+
	174	+**ISSAssetImporter**
	175	+
	176	+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.
	177	+
	178	+1. Erstellen Sie im Unterordner //Modules //eine neue Datei mit dem Namen //ISSAssetImporter.psm1//.
	179	+1. Fügen Sie den nachfolgenden Code in die Datei ein.
	180	+1. Drücken Sie Strg + S, um die Datei zu speichern.
	181	+
	182	+{{code language="PowerShell" layout="LINENUMBERS" title="**ISSAssetImporter.psm1**"}}
	183	+function Get-AssetTypeId {
	184	+ param (
	185	+ [string] $AssetTypeName
	186	+ )
	187	+ $assetTypesResult = Acmp-GetAssetTypeList_V1
	188	+ if ($assetTypesResult.ResultCode -ne 0) {
	189	+ Throw "Error while fetching asset types: $($assetTypesResult.ResultMessage)"
	190	+ }
	191	+ $assetType = $assetTypesResult.AssetTypes | Where-Object { $_.Name -eq $assetTypeName }
	192	+ $id = [guid]::Parse($assetType.Id).ToString()
	193	+ Write-Output $id
	194	+}
	195	+
	196	+function New-ISSAsset {
	197	+ param (
	198	+ [PSCustomObject] $Data,
	199	+ [string] $AssetTypeId,
	200	+ [string] $AssetTypeName,
	201	+ [string] $AssetStateId
	202	+ )
	203	+ $newAsset = New-TAsset_V4
	204	+ $newAsset.Id = [guid]::NewGuid().ToString()
	205	+ $newAsset.Name = $Data.Name
	206	+ $newAsset.AssetType = $AssetTypeName
	207	+ $newAsset.AssetTypeId = $AssetTypeId
	208	+ $newAsset.AssetStateId = $AssetStateId
	209	+
	210	+ Write-Output $newAsset
	211	+}
	212	+
	213	+function Get-ISSAsset {
	214	+ param(
	215	+ [string] $AssetTypeId,
	216	+ [string] $AssetTypeName,
	217	+ [string] $AssetStateId,
	218	+ $ISS
	219	+ )
	220	+ $assetListResult = Acmp-GetAssetList_V3 -AssetTypeId $AssetTypeId -FilterText "iss"
	221	+ if ($assetListResult.ResultCode -ne 0) {
	222	+ Throw "Error while fetching the asset: $($assetListResult.ResultMessage)"
	223	+ }
	224	+ $assetInfo = $assetListResult.Assets | Where-Object { $_.Name -eq $ISS.Name }
	225	+ if ($null -eq $assetInfo) {
	226	+ $asset = New-ISSAsset -Data $ISS -AssetTypeName $AssetTypeName -AssetTypeId $AssetTypeId -AssetStateId $AssetStateId
	227	+ }
	228	+ else {
	229	+ $assetResult = Acmp-GetAsset_V4 -Id $assetInfo.Id
	230	+ if ($assetResult.ResultCode -ne 0) {
	231	+ Throw "Error while fetching the asset: $($assetResult.ResultMessage)"
	232	+ }
	233	+ $asset = $assetResult.Asset
	234	+ }
	235	+ Write-Output $asset
	236	+}
	237	+
	238	+function New-CustomField {
	239	+ param (
	240	+ [string] $Id,
	241	+ [string] $Value
	242	+ )
	243	+ $customfield = New-TCustomFieldValue_V1
	244	+ $customfield.FieldId = $Id
	245	+ $customfield.Value = $Value
	246	+
	247	+ Write-Output $customfield
	248	+}
	249	+
	250	+function Save-CustomFieldList {
	251	+ param (
	252	+ $AssetId,
	253	+ $CustomFieldList
	254	+ )
	255	+ $customFieldResult = Acmp-SaveSingleCustomFieldValues_V1 -QueryBase AssetManagement -ObjectId $AssetId -FieldValues $CustomFieldList
	256	+ if ($customFieldResult.ResultCode -ne 0) {
	257	+ Throw "Error while fetching the asset: $($customFieldResult.ResultMessage)"
	258	+ }
	259	+ Write-Host "Success!"
	260	+}
	261	+
	262	+function ConvertTo-AssetV1 {
	263	+ param (
	264	+ [PSCustomObject] $AssetV4
	265	+ )
	266	+ $assetv1 = New-TAsset_V1
	267	+ $assetv1.Id = $AssetV4.Id
	268	+ $assetv1.Name = $AssetV4.Name
	269	+ $assetv1.AssetType = $AssetV4.AssetType
	270	+ $assetv1.AssetTypeId = $AssetV4.AssetTypeId
	271	+ $assetv1.AssetStateId = $AssetV4.AssetStateId
	272	+
	273	+ Write-Output $assetv1
	274	+}
	275	+
	276	+function Save-ISSAsset {
	277	+ param(
	278	+ [PSCustomObject] $ISSAsset
	279	+ )
	280	+ $convertedAsset = ConvertTo-AssetV1 -AssetV4 $ISSAsset
	281	+ $saveAssetResult = Acmp-SaveAssets_V1 -Assets $convertedAsset
	282	+ if ($saveAssetResult.ResultCode -ne 0) {
	283	+ Throw "Error while saving the asset: $($saveAssetResult.ResultMessage)"
	284	+ }
	285	+ Write-Host "Success!"
	286	+}
	287	+{{/code}}
	288	+
	289	+=== PowerShell-Module testen ===
	290	+
	291	+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.
	292	+
	293	+{{aagon.infobox}}
	294	+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]]__.
	295	+{{/aagon.infobox}}
	296	+
	297	+Sie können das PowerShell-Modul folgendermaßen testen:
	298	+
	299	+1. Erstellen Sie im Unterordner //Modules //einen neuen Unterordner mit dem Namen //Tests.//
	300	+1. Erstellen Sie im Unterordner //Tests// eine neue Datei mit dem Namen //ISSRestConnectorTests.ps1//.
	301	+1. Fügen Sie den nachfolgenden Code in die Datei ein.
	302	+1. Drücken Sie Strg + S, um die Datei zu speichern.
	303	+1. Führen Sie das Script aus
	304	+
	305	+{{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnectorTest.ps1**"}}
	306	+Import-Module -Name Pester -MinimumVersion 5.5.0
	307	+Remove-Module ".\Modules\ISSRestConnector.psm1" -Force -ErrorAction SilentlyContinue
	308	+Import-Module -Name ".\Modules\ISSRestConnector.psm1" -Force
	309	+
	310	+Describe "Get-ISSData Function Tests" {
	311	+ BeforeAll {
	312	+ # Mock the API response
	313	+ $global:MockApiResponse = @{
	314	+ Name = "iss"
	315	+ Id = 25544
	316	+ Latitude = 12.34
	317	+ Longitude = 56.78
	318	+ Altitude = 408.5
	319	+ Velocity = 27600
	320	+ Visibility = "daylight"
	321	+ Timestamp = [datetime]::Now.ToUniversalTime().Subtract([datetime]::UnixEpoch).TotalSeconds
	322	+ }
	323	+ }
	324	+
	325	+ Context "When the API responds successfully" {
	326	+ BeforeEach {
	327	+ # Mock the API call
	328	+ Mock -CommandName Invoke-RestMethod -ParameterFilter { $Method -eq 'GET' } -MockWith {
	329	+ return $global:MockApiResponse
	330	+ } -ModuleName "ISSRestConnector"
	331	+ }
	332	+
	333	+ It "Should return a PSCustomObject with expected properties" {
	334	+ $result = Get-ISSData
	335	+ $result | Should -BeOfType PSCustomObject
	336	+ $result.Name | Should -Not -BeNullOrEmpty
	337	+ $result.Latitude | Should -Not -BeNullOrEmpty
	338	+ $result.Longitude | Should -Not -BeNullOrEmpty
	339	+ $result.Altitude | Should -Not -BeNullOrEmpty
	340	+ $result.Velocity | Should -Not -BeNullOrEmpty
	341	+ }
	342	+
	343	+ It "Should correctly map the API response to the output object" {
	344	+ $result = Get-ISSData
	345	+ $result.Name | Should -Be "iss"
	346	+ $result.Latitude | Should -Be "12,34"
	347	+ $result.Longitude | Should -Be "56,78"
	348	+ $result.Altitude | Should -Be "408,5"
	349	+ $result.Velocity | Should -Be "27600"
	350	+ }
	351	+ }
	352	+
	353	+ Context "When the API fails" {
	354	+
	355	+ It "Should log an error when the API fails" {
	356	+ # Mock a failure in the API call
	357	+ Mock -CommandName Invoke-RestMethod -ParameterFilter { $Method -eq 'GET' } -MockWith {
	358	+ throw "API error"
	359	+ } -ModuleName "ISSRestConnector"
	360	+
	361	+ $error.Clear() # Clear any pre-existing errors
	362	+ Get-ISSData
	363	+ $error[1].Exception.Message | Should -Contain "API error"
	364	+ }
	365	+ }
	366	+}
	367	+{{/code}}
	368	+
	369	+(% class="wikigeneratedid" %)
	370	+Da in diesem Test kein Abruf der tatsächlichen API stattfindet, sondern die API-Daten simuliert werden, wird Ihnen als Ergebnis der beabsichtigte Error //Failed to fetch ISS data: API error //angezeigt. Darüber hinaus sollten die drei Tests erfolgreich gewesen sein.
	371	+
	372	+(% class="wikigeneratedid" %)
	373	+[[image:Output_Pester Testing.png||alt="Ergebnis des Modul-Tests mit Pester" data-xwiki-image-style-alignment="center"]]
	374	+
	375	+=== PowerShell-Microservices in AESB erstellen ===
	376	+
	377	+Da die benötigten PowerShell-Module nun erstellt und getestet sind, kann mit der Erstellung der Microservices begonnen werden.
	378	+
	379	+1. Öffnen Sie die AESB Console und navigieren Sie zum Workspace //Creator - PowerShell//.
	380	+1. Klicken Sie in der Ribbonleiste im Bereich //Ordner //auf den Button //Hinzufügen// und erstellen Sie den Ordner// ISS ACMP Connector.//
	381	+1. Wählen Sie den Ordner aus und klicken Sie in der Ribbonleiste im Bereich //PowerShell-Vorlagen //auf den Button //Hinzufügen.//
	382	+1. Erstellen Sie eine Vorlage// ISSRestConnector. //Klicken Sie in der Ribbonleiste auf den Button //Speichern.//
	383	+1. Wiederholen Sie Schritt 3 und Schritt 4 für die Erstellung der Vorlage //ISSAssetImporter//.
	384	+
	385	+=== PowerShell-Module in die PowerShell-Microservices integrieren ===
	386	+
	387	+
	388	+
	389	+{{aagon.warnungsbox}}
	390	+In diesem Beispiel werden nur die
	391	+{{/aagon.warnungsbox}}
	392	+
	393	+
	394	+
101	101	= Fehlerbehandlung =
102	102
103	103	= Orchestrierung =

1738156789994-903.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.jklein

Size

...	...	@@ -1,0 +1,1 @@
	1	+33.7 KB

Content

Output_Pester Testing.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.jklein

Size

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