Änderungen von Dokument Entwicklung eines ACMP Connectors für die ISS

Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Inhalt

...	...	@@ -17,7 +17,7 @@
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.
	20	+1. Legen Sie einen neuen Ordner mit dem Namen //ISS_ACMP_Connector// 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}}
...	...	@@ -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**
	51	+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.
...	...	@@ -96,8 +96,195 @@
96	96
97	97	= Entwicklung der Microservices =
98	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:
99	99
	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
100	100
	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	+=== Erstellen der PowerShell-Microservices in AESB ===
	283	+
	284	+=== Integrieren der PowerShell-Module in die PowerShell-Microservices ===
	285	+
	286	+
	287	+
101	101	= Fehlerbehandlung =
102	102
103	103	= Orchestrierung =