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

Summary

• Page properties (1 modified, 0 added, 0 removed)
• Attachments (0 modified, 7 added, 0 removed)
  • 1738156789994-903.png
  • Ausgeführte Testkonfiguration.png
  • Output_Pester Testing.png
  • PowerShell-Modul implementeren.png
  • Schema_ISSAssetImporter.png
  • Schema_ISSRestConnector.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,16 +11,16 @@
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		-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}}
	27	+1. Erstellen Sie eine neue Datei mit der Endung **//.psm1 //**(z.B. Modul.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	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	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	26	1. Drücken Sie Strg + S, um die Datei zu speichern.
...	...	@@ -42,6 +42,9 @@
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	+
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**
	58	+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 ===
	71	+== 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 ===
	87	+== Assettypen erstellen ==
81	81
82	82	Nun können Sie den benötigten Assettypen erstellen:
83	83
...	...	@@ -91,13 +91,537 @@
91	91
92	92	Der Assettyp //Spacestation //ist nun in der Liste verfügbar und hat die entsprechenden benutzerdefinierten Felder.
93	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"]]
	101	+[[Neuer Assettyp mit benutzerdefinierten Feldern für die ISS-Daten>>image:Assettyp_ISS Connector.png]]
96	96
	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	+
97	97	= Entwicklung der Microservices =
98	98
	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:
99	99
	127	+1. Erstellen der PowerShell-Module
	128	+1. Testen der PowerShell-Module
	129	+1. Erstellen der PowerShell-Microservices in AESB
	130	+1. Integrieren der PowerShell-Module in die PowerShell-Microservices
100	100
	132	+== PowerShell-Module erstellen ==
	133	+
	134	+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:
	135	+
	136	+* ISSRestConnector - Modul zum Abfragen der ISS-Daten
	137	+* ISSAssetImporter - Modul zum Speichern des Assets und der zugehörigen Custom Fields
	138	+
	139	+=== **ISSRestConnector** ===
	140	+
	141	+Das Modul zum Abfragen der ISS-Daten besteht aus einer einfachen Funktion, welche die REST API aufruft und das Ergebnis in ein PSCustomObject konvertiert.
	142	+
	143	+1. Klicken Sie mit einem Rechtsklick auf den Ordner //ISS_ACMP_Connector//, um das Kontextmenü zu öffnen.
	144	+1. Wählen Sie im Kontextmenü den Eintrag //Mit Code öffnen //aus, damit direkt das richtige Verzeichnis geöffnet wird.
	145	+1. Erstellen Sie einen neuen Unterordner mit dem Namen //Modules.//
	146	+1. Erstellen Sie im Unterordner //Modules //eine neue Datei mit dem Namen //ISSRestConnector.psm1//. Alternativ können Sie auch die anfangs erstellte, leere Datei //Modul.psm1// umbenennen und in den Ordner verschieben.
	147	+1. Fügen Sie den nachfolgenden Code in die Datei ein.
	148	+1. Drücken Sie Strg + S, um die Datei zu speichern.
	149	+
	150	+{{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnector.psm1**"}}
	151	+function Get-ISSData {
	152	+ <#
	153	+ .SYNOPSIS
	154	+ Queries the "Where the ISS at?" API to retrieve satellite data.
	155	+
	156	+ .DESCRIPTION
	157	+ This function fetches the data for the International Space Station (ISS) from the REST API endpoint
	158	+ https://api.wheretheiss.at/v1/satellites/25544 and returns the parsed response.
	159	+
	160	+ .OUTPUTS
	161	+ [PSCustomObject] - A custom object containing the ISS data.
	162	+
	163	+ .EXAMPLE
	164	+ Get-ISSData
	165	+ # Retrieves the current data for the ISS.
	166	+ #>
	167	+
	168	+ param (
	169	+ [string]$ApiUrl = "https://api.wheretheiss.at/v1/satellites/25544"
	170	+ )
	171	+
	172	+ try {
	173	+ # Perform the API request
	174	+ $response = Invoke-RestMethod -Uri $ApiUrl -Method Get
	175	+
	176	+ # Convert the response into a PowerShell object
	177	+ $result = [PSCustomObject]@{
	178	+ Name = $response.name
	179	+ Latitude = $response.latitude.ToString()
	180	+ Longitude = $response.longitude.ToString()
	181	+ Altitude = $response.altitude.ToString()
	182	+ Velocity = $response.velocity.ToString()
	183	+ }
	184	+
	185	+ return $result
	186	+ } catch {
	187	+ Write-Error "Failed to fetch ISS data: $_"
	188	+ }
	189	+}
	190	+{{/code}}
	191	+
	192	+=== **ISSAssetImporter** ===
	193	+
	194	+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.
	195	+
	196	+1. Erstellen Sie im Unterordner //Modules //eine neue Datei mit dem Namen //ISSAssetImporter.psm1//.
	197	+1. Fügen Sie den nachfolgenden Code in die Datei ein.
	198	+1. Drücken Sie Strg + S, um die Datei zu speichern.
	199	+
	200	+{{code language="PowerShell" layout="LINENUMBERS" title="**ISSAssetImporter.psm1**"}}
	201	+function Get-AssetTypeId {
	202	+ param (
	203	+ [string] $AssetTypeName
	204	+ )
	205	+ $assetTypesResult = Acmp-GetAssetTypeList_V1
	206	+ if ($assetTypesResult.ResultCode -ne 0) {
	207	+ Throw "Error while fetching asset types: $($assetTypesResult.ResultMessage)"
	208	+ }
	209	+ $assetType = $assetTypesResult.AssetTypes | Where-Object { $_.Name -eq $assetTypeName }
	210	+ $id = [guid]::Parse($assetType.Id).ToString()
	211	+ Write-Output $id
	212	+}
	213	+
	214	+function New-ISSAsset {
	215	+ param (
	216	+ [PSCustomObject] $Data,
	217	+ [string] $AssetTypeId,
	218	+ [string] $AssetTypeName,
	219	+ [string] $AssetStateId
	220	+ )
	221	+ $newAsset = New-TAsset_V4
	222	+ $newAsset.Id = [guid]::NewGuid().ToString()
	223	+ $newAsset.Name = $Data.Name
	224	+ $newAsset.AssetType = $AssetTypeName
	225	+ $newAsset.AssetTypeId = $AssetTypeId
	226	+ $newAsset.AssetStateId = $AssetStateId
	227	+
	228	+ Write-Output $newAsset
	229	+}
	230	+
	231	+function Get-ISSAsset {
	232	+ param(
	233	+ [string] $AssetTypeId,
	234	+ [string] $AssetTypeName,
	235	+ [string] $AssetStateId,
	236	+ $ISS
	237	+ )
	238	+ $assetListResult = Acmp-GetAssetList_V3 -AssetTypeId $AssetTypeId -FilterText "iss"
	239	+ if ($assetListResult.ResultCode -ne 0) {
	240	+ Throw "Error while fetching the asset: $($assetListResult.ResultMessage)"
	241	+ }
	242	+ $assetInfo = $assetListResult.Assets | Where-Object { $_.Name -eq $ISS.Name }
	243	+ if ($null -eq $assetInfo) {
	244	+ $asset = New-ISSAsset -Data $ISS -AssetTypeName $AssetTypeName -AssetTypeId $AssetTypeId -AssetStateId $AssetStateId
	245	+ }
	246	+ else {
	247	+ $assetResult = Acmp-GetAsset_V4 -Id $assetInfo.Id
	248	+ if ($assetResult.ResultCode -ne 0) {
	249	+ Throw "Error while fetching the asset: $($assetResult.ResultMessage)"
	250	+ }
	251	+ $asset = $assetResult.Asset
	252	+ }
	253	+ Write-Output $asset
	254	+}
	255	+
	256	+function New-CustomField {
	257	+ param (
	258	+ [string] $Id,
	259	+ [string] $Value
	260	+ )
	261	+ $customfield = New-TCustomFieldValue_V1
	262	+ $customfield.FieldId = $Id
	263	+ $customfield.Value = $Value
	264	+
	265	+ Write-Output $customfield
	266	+}
	267	+
	268	+function Save-CustomFieldList {
	269	+ param (
	270	+ $AssetId,
	271	+ $CustomFieldList
	272	+ )
	273	+ $customFieldResult = Acmp-SaveSingleCustomFieldValues_V1 -QueryBase AssetManagement -ObjectId $AssetId -FieldValues $CustomFieldList
	274	+ if ($customFieldResult.ResultCode -ne 0) {
	275	+ Throw "Error while fetching the asset: $($customFieldResult.ResultMessage)"
	276	+ }
	277	+ Write-Host "Success!"
	278	+}
	279	+
	280	+function ConvertTo-AssetV1 {
	281	+ param (
	282	+ [PSCustomObject] $AssetV4
	283	+ )
	284	+ $assetv1 = New-TAsset_V1
	285	+ $assetv1.Id = $AssetV4.Id
	286	+ $assetv1.Name = $AssetV4.Name
	287	+ $assetv1.AssetType = $AssetV4.AssetType
	288	+ $assetv1.AssetTypeId = $AssetV4.AssetTypeId
	289	+ $assetv1.AssetStateId = $AssetV4.AssetStateId
	290	+
	291	+ Write-Output $assetv1
	292	+}
	293	+
	294	+function Save-ISSAsset {
	295	+ param(
	296	+ [PSCustomObject] $ISSAsset
	297	+ )
	298	+ $convertedAsset = ConvertTo-AssetV1 -AssetV4 $ISSAsset
	299	+ $saveAssetResult = Acmp-SaveAssets_V1 -Assets $convertedAsset
	300	+ if ($saveAssetResult.ResultCode -ne 0) {
	301	+ Throw "Error while saving the asset: $($saveAssetResult.ResultMessage)"
	302	+ }
	303	+ Write-Host "Success!"
	304	+}
	305	+{{/code}}
	306	+
	307	+== PowerShell-Module testen ==
	308	+
	309	+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.
	310	+
	311	+{{aagon.infobox}}
	312	+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||rel="noopener noreferrer" target="_blank"]]__.
	313	+{{/aagon.infobox}}
	314	+
	315	+Sie können das PowerShell-Modul folgendermaßen testen:
	316	+
	317	+1. Erstellen Sie im Unterordner //Modules //einen neuen Unterordner mit dem Namen //Tests.//
	318	+1. Erstellen Sie im Unterordner //Tests// eine neue Datei mit dem Namen //ISSRestConnectorTests.ps1//.
	319	+1. Fügen Sie den nachfolgenden Code in die Datei ein.
	320	+1. Drücken Sie Strg + S, um die Datei zu speichern.
	321	+1. Führen Sie das Script aus
	322	+
	323	+{{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnectorTest.ps1**"}}
	324	+Import-Module -Name Pester -MinimumVersion 5.5.0
	325	+Remove-Module ".\Modules\ISSRestConnector.psm1" -Force -ErrorAction SilentlyContinue
	326	+Import-Module -Name ".\Modules\ISSRestConnector.psm1" -Force
	327	+
	328	+Describe "Get-ISSData Function Tests" {
	329	+ BeforeAll {
	330	+ # Mock the API response
	331	+ $global:MockApiResponse = @{
	332	+ Name = "iss"
	333	+ Id = 25544
	334	+ Latitude = 12.34
	335	+ Longitude = 56.78
	336	+ Altitude = 408.5
	337	+ Velocity = 27600
	338	+ Visibility = "daylight"
	339	+ Timestamp = [datetime]::Now.ToUniversalTime().Subtract([datetime]::UnixEpoch).TotalSeconds
	340	+ }
	341	+ }
	342	+
	343	+ Context "When the API responds successfully" {
	344	+ BeforeEach {
	345	+ # Mock the API call
	346	+ Mock -CommandName Invoke-RestMethod -ParameterFilter { $Method -eq 'GET' } -MockWith {
	347	+ return $global:MockApiResponse
	348	+ } -ModuleName "ISSRestConnector"
	349	+ }
	350	+
	351	+ It "Should return a PSCustomObject with expected properties" {
	352	+ $result = Get-ISSData
	353	+ $result | Should -BeOfType PSCustomObject
	354	+ $result.Name | Should -Not -BeNullOrEmpty
	355	+ $result.Latitude | Should -Not -BeNullOrEmpty
	356	+ $result.Longitude | Should -Not -BeNullOrEmpty
	357	+ $result.Altitude | Should -Not -BeNullOrEmpty
	358	+ $result.Velocity | Should -Not -BeNullOrEmpty
	359	+ }
	360	+
	361	+ It "Should correctly map the API response to the output object" {
	362	+ $result = Get-ISSData
	363	+ $result.Name | Should -Be "iss"
	364	+ $result.Latitude | Should -Be "12,34"
	365	+ $result.Longitude | Should -Be "56,78"
	366	+ $result.Altitude | Should -Be "408,5"
	367	+ $result.Velocity | Should -Be "27600"
	368	+ }
	369	+ }
	370	+
	371	+ Context "When the API fails" {
	372	+
	373	+ It "Should log an error when the API fails" {
	374	+ # Mock a failure in the API call
	375	+ Mock -CommandName Invoke-RestMethod -ParameterFilter { $Method -eq 'GET' } -MockWith {
	376	+ throw "API error"
	377	+ } -ModuleName "ISSRestConnector"
	378	+
	379	+ $error.Clear() # Clear any pre-existing errors
	380	+ Get-ISSData
	381	+ $error[1].Exception.Message | Should -Contain "API error"
	382	+ }
	383	+ }
	384	+}
	385	+{{/code}}
	386	+
	387	+(% class="wikigeneratedid" %)
	388	+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.
	389	+
	390	+(% class="wikigeneratedid" %)
	391	+[[image:Output_Pester Testing.png||alt="Ergebnis des Modul-Tests mit Pester" data-xwiki-image-style-alignment="center"]]
	392	+
	393	+== PowerShell-Microservices erstellen ==
	394	+
	395	+Da die benötigten PowerShell-Module nun erstellt und getestet sind, kann mit der Erstellung der Microservices begonnen werden.
	396	+
	397	+1. Öffnen Sie die AESB Console und navigieren Sie zum Workspace //Creator - PowerShell//.
	398	+1. Klicken Sie in der Ribbonleiste im Bereich //Ordner //auf den Button //Hinzufügen// und erstellen Sie den Ordner// ISS ACMP Connector.//
	399	+1. Wählen Sie den Ordner aus und klicken Sie in der Ribbonleiste im Bereich //PowerShell-Vorlagen //auf den Button //Hinzufügen.//
	400	+1. Erstellen Sie die Vorlage// ISSRestConnector. //Klicken Sie in der Ribbonleiste auf den Button //Speichern.//
	401	+1. Wiederholen Sie Schritt 3 und Schritt 4 für die Erstellung der Vorlage //ISSAssetImporter//.
	402	+
	403	+== PowerShell-Module implementieren ==
	404	+
	405	+Die Implementierung der Module in die PowerShell-Microservices erfolgt an zwei Stellen: In der Modul-Verwaltung und im Skript-Editor.
	406	+
	407	+=== PowerShell-Module in der Modul-Verwaltung hochladen ===
	408	+
	409	+Zunächst müssen Sie den einzelnen PowerShell-Vorlagen die jeweiligen Module zuweisen:
	410	+
	411	+1. Wählen Sie die PowerShell-Vorlage //ISSRestConnector //aus und klicken Sie in der Ribbonleiste auf den Button //Module//.
	412	+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}}
	413	+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.
	414	+1. Wiederholen Sie die Schritte für den Microservice ISSAssetImporter mit den Modulen //ISSAssetImporter.psm1 //und //ACMP Public API// (Änderung des Modul-Typs erforderlich).
	415	+
	416	+[[PowerShell-Modul implementieren>>image:PowerShell-Modul implementeren.png||alt="PowerShell-Modul implementieren" data-xwiki-image-style-alignment="center" height="355" width="800"]]
	417	+
	418	+=== PowerShell-Module in Microservice-Skripten aufrufen ===
	419	+
	420	+Die PowerShell-Module sind nun in der Modul-Verwaltung hochgeladen und können aus Microservice-Skripten heraus aufgerufen werden. Dafür werden nun die Skripte im Skript-Editor angepasst.
	421	+
	422	+{{aagon.warnungsbox}}
	423	+In diesem Beispiel werden nur die Event-Skripte angepasst, bei denen für dieses Beispiel eine Anpassung notwendig ist. Die nicht erwähnten Event-Skripte bleiben unverändert. Für allgemeine Informationen zu den Event-Skripten, lesen Sie den Abschnitt [[Aufbau des Skript-Editors>>doc:AESB.110.Workspaces.Powershell.Skript-Editor.WebHome]].
	424	+{{/aagon.warnungsbox}}
	425	+
	426	+(% class="wikigeneratedid" %)
	427	+**ISSRestConnector - Skript**
	428	+
	429	+(% class="wikigeneratedid" %)
	430	+Der ISSRestConnector soll zu einstellbaren Zeiten die Daten von der Rest API holen. Dafür werden die Skript-Events //.OnStart// und //.OnExecute //entsprechend angepasst.
	431	+
	432	+1. Wählen Sie den Microservice //ISSRestConnector //aus und klicken Sie in der Ribbonleiste auf den Button //Skript//.
	433	+1. Wechseln Sie in den Skript-Tab //OnStart //und fügen Sie den nachfolgenden Code in die Datei ein.
	434	+1. Wechseln Sie in den Skript-Tab //OnExecute //und fügen Sie den nachfolgenden Code in die Datei ein.
	435	+1. Drücken Sie Strg + S, um die Datei zu speichern.
	436	+1. Schließen Sie den Skript-Editor.
	437	+
	438	+{{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnector.OnStart**"}}
	439	+#
	440	+# This gets executed once the Microservice has started.
	441	+#
	442	+
	443	+$message = "Starting ISS2ACMP.REST"
	444	+
	445	+Write-Host $message
	446	+Write-BusinessLog $message
	447	+
	448	+# Registering Alias
	449	+Set-AESBSelfAsAlias -Alias $configuration.Alias -RemoveExistingAlias
	450	+{{/code}}
	451	+
	452	+{{code language="PowerShell" layout="LINENUMBERS" title="**ISSRestConnector.OnExecute**"}}
	453	+#
	454	+# This gets executed perpetually by the scheduler. Main business logic should go here.
	455	+#
	456	+
	457	+try {
	458	+ # Trying to fetch new data
	459	+ Write-Host "Fetching new data from the api."
	460	+ $result = Get-ISSData -ApiUrl $configuration.ApiUrl
	461	+
	462	+ # Converting the data to icql
	463	+ $icql = ConvertTo-AESBIcql $result
	464	+
	465	+ # Sending the data to the next microserice
	466	+ Publish-AESBMessage -Alias $configuration.Target -Message $icql
	467	+}
	468	+catch {
	469	+ Write-Error $_
	470	+}
	471	+{{/code}}
	472	+
	473	+(% class="wikigeneratedid" %)
	474	+**ISSAssetImporter - Skript**
	475	+
	476	+(% class="wikigeneratedid" %)
	477	+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.
	478	+
	479	+1. Wählen Sie den Microservice //ISSAssetImporter //aus und klicken Sie in der Ribbonleiste auf den Button //Skript//.
	480	+1. Wechseln Sie in den Skript-Tab //OnStart //und fügen Sie den nachfolgenden Code in die Datei ein.
	481	+1. Wechseln Sie in den Skript-Tab //OnMessage //und fügen Sie den nachfolgenden Code in die Datei ein.
	482	+1. Drücken Sie Strg + S, um die Datei zu speichern.
	483	+1. Schließen Sie den Skript-Editor.
	484	+
	485	+{{code language="PowerShell" layout="LINENUMBERS" title="**ISSAssetImporter.OnStart**"}}
	486	+#
	487	+# This gets executed once the Microservice has started.
	488	+#
	489	+
	490	+$message = "Starting ISS2ACMP.ACMPImporter"
	491	+
	492	+Write-Host $message
	493	+Write-BusinessLog $message
	494	+
	495	+# Registering Alias
	496	+Set-AESBSelfAsAlias -Alias $configuration.Alias -RemoveExistingAlias
	497	+{{/code}}
	498	+
	499	+{{code language="PowerShell" layout="LINENUMBERS" title="**ISSAssetImporter.OnMessage**"}}
	500	+#
	501	+# This gets executed when a message is received.
	502	+#
	503	+# The received message can be accessed via $msg
	504	+# To retrieve only the body from the message use $body
	505	+#
	506	+
	507	+# Getting msg data
	508	+$msg = New-Message -Args $args
	509	+$body = New-MessageBody -Args $args
	510	+
	511	+# Converting from icql to PSCustomObject
	512	+$data = ConvertFrom-AESBIcql -Icql $body
	513	+Write-Host $data
	514	+
	515	+# Getting the AssetTypeId
	516	+$assetTypeId = Get-AssetTypeId -AssetTypeName $configuration.Acmp.AssetTypeName
	517	+
	518	+# Trying to get the asset if it is already present in acmp
	519	+$asset = Get-ISSAsset -AssetTypeId $assetTypeId -AssetTypeName $configuration.Acmp.AssetTypeName -AssetStateId $configuration.Acmp.AssetStateId -ISS $data
	520	+
	521	+# Saving the asset
	522	+Save-ISSAsset -ISSAsset $asset
	523	+
	524	+# Creating the custom fields
	525	+$customFieldList = @()
	526	+$customFieldList += New-CustomField -Id $configuration.Acmp.CustomFields.Latitude -Value $data.Latitude
	527	+$customFieldList += New-CustomField -Id $configuration.Acmp.CustomFields.Longitude -Value $data.Longitude
	528	+$customFieldList += New-CustomField -Id $configuration.Acmp.CustomFields.Altitude -Value $data.Altitude
	529	+$customFieldList += New-CustomField -Id $configuration.Acmp.CustomFields.Velocity -Value $data.Velocity
	530	+
	531	+# Saving the custom fields
	532	+Save-CustomFieldList -AssetId $asset.Id -CustomFieldList $customFieldList
	533	+{{/code}}
	534	+
	535	+== Microservice-Schema erstellen ==
	536	+
	537	+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.
	538	+
	539	+{{aagon.infobox}}
	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	+{{/aagon.infobox}}
	542	+
	543	+(% class="wikigeneratedid" %)
	544	+**ISSRestConnector - Schema**
	545	+
	546	+(% class="wikigeneratedid" %)
	547	+Für den ISSRestConnector müssen drei Datenfelder angelegt werden.
	548	+
	549	+1. Wählen Sie den Microservice //ISSRestConnector //aus und klicken Sie in der Ribbonleiste auf den Button //Schema//.
	550	+1. Klicken Sie im Schema-Designer auf //Hinzufügen, //um den SchemaString //Alias// anzulegen.
	551	+1. Konfigurieren Sie den Schemaknoten //Alias //entsprechend den Daten in der nachfolgenden Tabelle.
	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.
	554	+1. Schließen Sie den Schema-Designer.
	555	+
	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
	561	+
	562	+[[Schema mit Datenfeldern für den ISSRestConnector>>image:Schema_ISSRestConnector.png||alt="Schema mit Datenfeldern für den ISSRestConnector"]]
	563	+
	564	+**ISSAssetImporter - Schema**
	565	+
	566	+(% class="wikigeneratedid" %)
	567	+Für den ISSAssetImporter müssen zwei Schema-Objekte und insgesamt sieben Datenfelder angelegt werden
	568	+
	569	+1. Wählen Sie den Microservice //ISSAssetImporter //aus und klicken Sie in der Ribbonleiste auf den Button //Schema//.
	570	+1. Klicken Sie im Schema-Designer auf //Hinzufügen, //um den SchemaString //Alias //anzulegen.
	571	+1. Konfigurieren Sie den Schemaknoten //Alias //entsprechend den Daten in der nachfolgenden Tabelle.
	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.
	583	+1. Klicken Sie in der Ribbonleiste des Schema-Designers auf //Speichern//, um das Schema zu speichern.
	584	+1. Schließen Sie den Schema-Designer.
	585	+
	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"]]
	591	+
	592	+[[Schema mit Datenfeldern für den ISSRestConnector>>image:Schema_ISSAssetImporter.png||alt="Schema mit Datenfeldern für den ISSRestConnector"]]
	593	+
101	101	= Fehlerbehandlung =
102	102
	596	+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.
	597	+
	598	+|=(% style="width: 715px;" %)Fehler|=(% style="width: 724px;" %)Ansätze zur Fehlerbehandlung
	599	+|(% 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.
	600	+|(% 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.
	601	+|(% 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.
	602	+|(% 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.
	603	+
103	103	= Orchestrierung =
	605	+
	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	+
	632	+= Datei-Download =
	633	+
	634	+Das komplette Dateiverzeichnis mit allen Dateien, die Sie in diesem Best Practice selbstständig erstellt haben, finden Sie ebenfalls zum Herunterladen in unserer Community.

1738156789994-903.png

Author

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

Size

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

Content

Ausgeführte Testkonfiguration.png

Author

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

Size

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

Content

Output_Pester Testing.png

Author

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

Size

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

Content

PowerShell-Modul implementeren.png

Author

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

Size

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

Visual Studio Code_AESB Shell.png

Author

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

Size

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

Content