Version 9.1 by jklein on 2025/01/28 16:03
Show last authors
1 {{aagon.floatingbox/}}
2
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
5 = Entwicklungsumgebung =
6
7 Als Entwicklungsumgebung für die Umsetzung dieses Beispiel-Projekts benötigen Sie:
8
9 * Eine aktuelle Version von Visual Studio Code
10 * Eine installierte PowerShell-Erweiterung in Visual Studio Code
11 * Eine installierte AESB Shell
12 * Eine erreichbare AESB Console
13
14 == Entwicklungsumgebung einrichten ==
15
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
18 Wenn Sie Visual Studio Code mit der PowerShell-Erweiterung installiert haben, können Sie die AESB Shell in Visual Studio Code einrichten:
19
20 1. Legen Sie einen neuen Ordner mit dem Namen //ISS_ACMP_Connector// im Datei-Explorer an.
21 1. Klicken Sie mit einem Rechtsklick auf den neuen Ordner, um das Kontextmenü zu öffnen.
22 1. Wählen Sie im Kontextmenü den Eintrag //Mit Code öffnen //aus, damit direkt das richtige Verzeichnis geöffnet wird.
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}}
24 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.
25 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.
26 1. Drücken Sie Strg + S, um die Datei zu speichern.
27 1. Starten Sie Visual Studio Code anschließend neu.
28
29 {{code language="PowerShell" layout="LINENUMBERS" title="**Code für Microsoft.VSCode_profile.ps1**"}}
30 try {
31 $aesbShellPath = "C:\Program Files (x86)\Aagon\AESB Shell"
32 [System.Environment]::CurrentDirectory = $aesbShellPath
33 Import-Module "$aesbShellPath\Aagon.Shell.Core.dll", "$aesbShellPath\Aagon.Sis.Sics.Powershell.Cmdlets.dll" -Prefix AESB -Force -Global
34 New-AESBShell
35 }
36 catch {
37 Write-Error "No AESBShell installed!"
38 }
39 {{/code}}
40
41 [[AESB Shell in Visual Studio Code einrichten>>image:Visual Studio Code einrichten.png||alt="AESB Shell in Visual Studio Code einrichten"]]
42
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
45 = Aufgabenteilung =
46
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
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
51 1. **Microservice 1: Datenabruf von der REST API **
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 1. **Microservice 2: Integration in ACMP**
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.
55
56 [[Schematische Darstellung der aufgeteilten Services für den ACMP Connector für ISS-Daten>>image:Schema_ISS Connector_Microservices.png||alt="Schematische Darstellung der aufgeteilten Services für den ACMP Connector für ISS-Daten" data-xwiki-image-style-alignment="center" height="360" width="800"]]
57
58 = Vorbereitungen =
59
60 Nachdem die Hauptaufgabe aufgeteilt und die modularen Microservices für die einzelnen Aufgaben definiert wurden, ist es ggf. notwendig, das bestehende System vorzubereiten. In diesem Beispiel müssen für ACMP als das bestehende System, in das die Daten integriert werden sollen, einige Ressourcen neu angelegt werden. Das ist notwendig, damit Sie bei der anschließenden Entwicklung der Microservices direkt auf die Ressourcen zugreifen können.
61
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
64 == Benutzerdefinierte Felder erstellen ==
65
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
68 1. Öffnen Sie die ACMP Console und navigieren Sie zur Solution //System > Einstellungen > Benutzerdefinierte Felder > Assets.//
69 1. Klicken Sie mit einem Rechtsklick auf den Ordner //Custom Fields //und wählen Sie den Eintrag //Tabelle hinzufügen// aus (Umschalt+Alt+N).
70 1. Ändern Sie den Namen der neuen Tabelle zu //Spacestation //und bestätigen Sie die Erstellung mit dem Button //Fertig//.
71 1. Klicken Sie mit einem Rechtsklick auf die Tabelle //Spacestation// und wählen Sie den Eintrag //Feld hinzufügen// aus (Strg+N).
72 1. Ändern Sie den Namen in //Latitude //und klicken Sie auf den Button //Weiter.//
73 1. Legen Sie als Feldtyp die Option //Text// fest und ändern Sie den Wert der Feldgröße auf 50.
74 1. Bestätigen Sie die Erstellung des Feldes mit dem Button //Fertig.//
75 1. Wiederholen Sie Schritt 4 bis Schritt 7 für die weiteren Datenfelder.
76 1. Klicken Sie abschließend in der Ribbonleiste auf den Button //Speichern.//
77
78 [[Benutzerdefinierte Felder für die ISS-Daten>>image:Benutzerdefinierte Felder_ISS Connector.png||alt="Benutzerdefinierte Felder für die ISS-Daten"]]
79
80 == Assettypen erstellen ==
81
82 Nun können Sie den benötigten Assettypen erstellen:
83
84 1. Navigieren Sie in der ACMP Console zur Solution //Asset Management > Hardware Assets.//
85 1. Klicken Sie in der Ribbonleiste auf den Button //Assettypen.//
86 1. Klicken Sie im Dialogfenster auf den Button //Assettypen hinzufügen.//
87 1. Wählen Sie im Dialogfenster als Zielordner //Hauptebene// aus und ändern Sie den Namen in //Spacestation.//
88 1. Klicken Sie zwei Mal auf den Button //Weiter//, um Schritt 3 //Benutzerdefinierte Felder //zu öffnen.
89 1. Öffnen Sie den Ordner //Custom Fields// und ziehen Sie die Tabelle //Spacestation// per Drag-and-Drop in das rechte Fenster.
90 1. Klicken Sie auf den Button //Fertig//.
91
92 Der Assettyp //Spacestation //ist nun in der Liste verfügbar und hat die entsprechenden benutzerdefinierten Felder.
93
94 (% style="width: 500px;" %)
95 [[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"]]
96
97 = Entwicklung der Microservices =
98
99 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:
100
101 1. Erstellen der PowerShell-Module
102 1. Testen der PowerShell-Module
103 1. Erstellen der PowerShell-Microservices in AESB
104 1. Integrieren der PowerShell-Module in die PowerShell-Microservices
105
106 === Erstellen der PowerShell-Module ===
107
108 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:
109
110 * ISSRestConnector - Modul zum Abfragen der ISS-Daten
111 * ISSAssetImporter - Modul zum Speichern des Assets und der zugehörigen Custom Fields
112
113 **ISSRestConnector**
114
115 Das Modul zum Abfragen der ISS-Daten besteht aus einer einfachen Funktion, welche die REST API aufruft und das Ergebnis in ein PSCustomObject konvertiert.
116
117 1. Klicken Sie mit einem Rechtsklick auf den Ordner //ISS_ACMP_Connector//, um das Kontextmenü zu öffnen.
118 1. Wählen Sie im Kontextmenü den Eintrag //Mit Code öffnen //aus, damit direkt das richtige Verzeichnis geöffnet wird.
119 1. Erstellen Sie eine neue Datei mit dem Namen //ISSRestConnector.psm1//. Alternativ können Sie auch die anfangs erstellte, leere Datei //Microservice.psm1// umbenennen.
120 1. Fügen Sie den nachfolgenden Code in die Datei ein.
121 1. Drücken Sie Strg + S, um die Datei zu speichern.
122
123 {{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnector.psm1**"}}
124 function Get-ISSData {
125 <#
126 .SYNOPSIS
127 Queries the "Where the ISS at?" API to retrieve satellite data.
128
129 .DESCRIPTION
130 This function fetches the data for the International Space Station (ISS) from the REST API endpoint
131 https://api.wheretheiss.at/v1/satellites/25544 and returns the parsed response.
132
133 .OUTPUTS
134 [PSCustomObject] - A custom object containing the ISS data.
135
136 .EXAMPLE
137 Get-ISSData
138 # Retrieves the current data for the ISS.
139 #>
140
141 param (
142 [string]$ApiUrl = "https://api.wheretheiss.at/v1/satellites/25544"
143 )
144
145 try {
146 # Perform the API request
147 $response = Invoke-RestMethod -Uri $ApiUrl -Method Get
148
149 # Convert the response into a PowerShell object
150 $result = [PSCustomObject]@{
151 Name = $response.name
152 Latitude = $response.latitude.ToString()
153 Longitude = $response.longitude.ToString()
154 Altitude = $response.altitude.ToString()
155 Velocity = $response.velocity.ToString()
156 }
157
158 return $result
159 } catch {
160 Write-Error "Failed to fetch ISS data: $_"
161 }
162 }
163 {{/code}}
164
165 **ISSAssetImporter**
166
167 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.
168
169 1. Erstellen Sie eine neue Datei mit dem Namen //ISSAssetImporter.psm1//.
170 1. Fügen Sie den nachfolgenden Code in die Datei ein.
171 1. Drücken Sie Strg + S, um die Datei zu speichern.
172
173 {{code language="PowerShell" layout="LINENUMBERS" title="**ISSAssetImporter.psm1**"}}
174 function Get-AssetTypeId {
175 param (
176 [string] $AssetTypeName
177 )
178 $assetTypesResult = Acmp-GetAssetTypeList_V1
179 if ($assetTypesResult.ResultCode -ne 0) {
180 Throw "Error while fetching asset types: $($assetTypesResult.ResultMessage)"
181 }
182 $assetType = $assetTypesResult.AssetTypes | Where-Object { $_.Name -eq $assetTypeName }
183 $id = [guid]::Parse($assetType.Id).ToString()
184 Write-Output $id
185 }
186
187 function New-ISSAsset {
188 param (
189 [PSCustomObject] $Data,
190 [string] $AssetTypeId,
191 [string] $AssetTypeName,
192 [string] $AssetStateId
193 )
194 $newAsset = New-TAsset_V4
195 $newAsset.Id = [guid]::NewGuid().ToString()
196 $newAsset.Name = $Data.Name
197 $newAsset.AssetType = $AssetTypeName
198 $newAsset.AssetTypeId = $AssetTypeId
199 $newAsset.AssetStateId = $AssetStateId
200
201 Write-Output $newAsset
202 }
203
204 function Get-ISSAsset {
205 param(
206 [string] $AssetTypeId,
207 [string] $AssetTypeName,
208 [string] $AssetStateId,
209 $ISS
210 )
211 $assetListResult = Acmp-GetAssetList_V3 -AssetTypeId $AssetTypeId -FilterText "iss"
212 if ($assetListResult.ResultCode -ne 0) {
213 Throw "Error while fetching the asset: $($assetListResult.ResultMessage)"
214 }
215 $assetInfo = $assetListResult.Assets | Where-Object { $_.Name -eq $ISS.Name }
216 if ($null -eq $assetInfo) {
217 $asset = New-ISSAsset -Data $ISS -AssetTypeName $AssetTypeName -AssetTypeId $AssetTypeId -AssetStateId $AssetStateId
218 }
219 else {
220 $assetResult = Acmp-GetAsset_V4 -Id $assetInfo.Id
221 if ($assetResult.ResultCode -ne 0) {
222 Throw "Error while fetching the asset: $($assetResult.ResultMessage)"
223 }
224 $asset = $assetResult.Asset
225 }
226 Write-Output $asset
227 }
228
229 function New-CustomField {
230 param (
231 [string] $Id,
232 [string] $Value
233 )
234 $customfield = New-TCustomFieldValue_V1
235 $customfield.FieldId = $Id
236 $customfield.Value = $Value
237
238 Write-Output $customfield
239 }
240
241 function Save-CustomFieldList {
242 param (
243 $AssetId,
244 $CustomFieldList
245 )
246 $customFieldResult = Acmp-SaveSingleCustomFieldValues_V1 -QueryBase AssetManagement -ObjectId $AssetId -FieldValues $CustomFieldList
247 if ($customFieldResult.ResultCode -ne 0) {
248 Throw "Error while fetching the asset: $($customFieldResult.ResultMessage)"
249 }
250 Write-Host "Success!"
251 }
252
253 function ConvertTo-AssetV1 {
254 param (
255 [PSCustomObject] $AssetV4
256 )
257 $assetv1 = New-TAsset_V1
258 $assetv1.Id = $AssetV4.Id
259 $assetv1.Name = $AssetV4.Name
260 $assetv1.AssetType = $AssetV4.AssetType
261 $assetv1.AssetTypeId = $AssetV4.AssetTypeId
262 $assetv1.AssetStateId = $AssetV4.AssetStateId
263
264 Write-Output $assetv1
265 }
266
267 function Save-ISSAsset {
268 param(
269 [PSCustomObject] $ISSAsset
270 )
271 $convertedAsset = ConvertTo-AssetV1 -AssetV4 $ISSAsset
272 $saveAssetResult = Acmp-SaveAssets_V1 -Assets $convertedAsset
273 if ($saveAssetResult.ResultCode -ne 0) {
274 Throw "Error while saving the asset: $($saveAssetResult.ResultMessage)"
275 }
276 Write-Host "Success!"
277 }
278 {{/code}}
279
280 === Testen der PowerShell-Module ===
281
282 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. Das Modul //ISSRestConnector.psm1// können Sie mit Pester (5.5.0) beispielsweise folgendermaßen testen:
283
284 1. Erstellen Sie eine neue Datei mit dem Namen //ISSRestConnectorTests.ps1//.
285 1. Fügen Sie den nachfolgenden Code in die Datei ein.
286 1. Drücken Sie Strg + S, um die Datei zu speichern.
287 1. Führen Sie das Script
288
289 {{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnectorTest.ps1**"}}
290 Import-Module -Name Pester -MinimumVersion 5.5.0
291 Remove-Module ".\Modules\ISSRestConnector.psm1" -Force -ErrorAction SilentlyContinue
292 Import-Module -Name ".\Modules\ISSRestConnector.psm1" -Force
293
294 Describe "Get-ISSData Function Tests" {
295 BeforeAll {
296 # Mock the API response
297 $global:MockApiResponse = @{
298 Name = "iss"
299 Id = 25544
300 Latitude = 12.34
301 Longitude = 56.78
302 Altitude = 408.5
303 Velocity = 27600.0
304 Visibility = "daylight"
305 Timestamp = [datetime]::Now.ToUniversalTime().Subtract([datetime]::UnixEpoch).TotalSeconds
306 }
307 }
308
309 Context "When the API responds successfully" {
310 BeforeEach {
311 # Mock the API call
312 Mock -CommandName Invoke-RestMethod -ParameterFilter { $Method -eq 'GET' } -MockWith {
313 return $global:MockApiResponse
314 } -ModuleName "ISSRestConnector"
315 }
316
317 It "Should return a PSCustomObject with expected properties" {
318 $result = Get-ISSData
319 $result | Should -BeOfType PSCustomObject
320 $result.Name | Should -Not -BeNullOrEmpty
321 $result.Latitude | Should -Not -BeNullOrEmpty
322 $result.Longitude | Should -Not -BeNullOrEmpty
323 $result.Altitude | Should -Not -BeNullOrEmpty
324 $result.Velocity | Should -Not -BeNullOrEmpty
325 }
326
327 It "Should correctly map the API response to the output object" {
328 $result = Get-ISSData
329 $result.Name | Should -Be "iss"
330 $result.Latitude | Should -Be 12.34
331 $result.Longitude | Should -Be 56.78
332 $result.Altitude | Should -Be 408.5
333 $result.Velocity | Should -Be 27600.0
334 }
335 }
336
337 Context "When the API fails" {
338
339 It "Should log an error when the API fails" {
340 # Mock a failure in the API call
341 Mock -CommandName Invoke-RestMethod -ParameterFilter { $Method -eq 'GET' } -MockWith {
342 throw "API error"
343 } -ModuleName "ISSRestConnector"
344
345 $error.Clear() # Clear any pre-existing errors
346 Get-ISSData
347 $error[1].Exception.Message | Should -Contain "API error"
348 }
349 }
350 }
351 {{/code}}
352
353 === Erstellen der PowerShell-Microservices in AESB ===
354
355 === Integrieren der PowerShell-Module in die PowerShell-Microservices ===
356
357
358
359 = Fehlerbehandlung =
360
361 = Orchestrierung =
© Aagon GmbH 2025
Besuchen Sie unsere neue Aagon-Community