Was sind ASAM ODS EXD-API Plugins?

Die Überführung von Bestandsdaten in Standarddatenformate erfordert häufig eine Datenkonvertierung. Dies kann zu einem erhöhten Datenvolumen durch Datenkopien und zu einer Unterbrechung bestehender Toolketten führen, die diese Daten nutzen.

Um diese Konflikte zu vermeiden, hat ASAM ODS mit der Version 6.2 die EXD-API Plugins eingeführt. EXD-API Plugins ermöglichen den Zugriff auf Bestandsdaten durch Microservices, die die enthaltenen Meta- und Massendaten offenlegen.

Peak Solution war als Mitglied der ASAM ODS Arbeitsgruppe maßgeblich an der Definition der EXD-API Plugins beteiligt und der Peak ASAM ODS Server unterstützt EXD-API Plugins von Anfang an.

Arbeitsprinzip der ASAM ODS EXD-API Plugins

EXD-API Plugins tauschen Daten über das Google gRPC Protokoll aus. 

Die von EXD-API Plugins bereitgestellten Daten werden in zwei verschiedene Operationen aufgeteilt: Abruf von Metadaten (GetStructure) und Abruf von Massen-/Kanaldaten (GetValue). Die Metadaten werden in Form von Name-Wert-Paaren zurückgegeben und dienen dazu, beschreibende und semantische Informationen über die Daten bereitzustellen und so erweiterte Suchmöglichkeiten zu bieten.

Betrachtet man eine typische Aufrufsequenz, so sieht man, dass des EXD-API Plugin, sobald eine neue Datei (oder ein neues Datenelement) erkannt wurde (1), vom Importeur aufgerufen wird (GetStructure), um die Metadaten dieser spezifischen Datei zu liefern (2). Das EXD-API Plugin liest dann die Datei (3), erstellt die Rückgabestruktur (4) und gibt die angeforderten Daten zurück (5). 

Ein Teil der zurückgegebenen Metadaten - oft in Kombination mit dem Datei- und Ordnernamen - wird dann zur Identifizierung und Erstellung des Datenkontextes bzw. der benötigten Datenhierarchie verwendet (6).

Der andere Teil wird dann verwendet, um die Datenstruktur im Server für den Empfang der Massen-/Kanaldaten in nachfolgenden Aufrufen und für die (optionale) Bereitstellung der Datei zum Download zu erstellen (7).

Nun sind alle benötigten Daten und Informationen auf dem ASAM ODS-Server verfügbar, so dass die Clients mit der Nutzung der Daten beginnen können.

Dazu stellen sie eine Verbindung zum ASAM ODS-Server her (8) und beginnen in der Regel mit der Erkundung der hierarchischen Datenstruktur (9), bis der Punkt erreicht ist, an dem sie auf die eigentlichen Kanaldaten zugreifen (10).

Um auf die Kanaldaten zuzugreifen, delegiert der ASAM ODS-Server den Client-Aufruf an das EXD-API Plugin (11), indem er GetValue aufruft - einschließlich Informationen über die Datei und den angeforderten Kanal/Kanäle. Das EXD-API Plugins verwendet diese Informationen, um die Datei zu öffnen, die Daten abzurufen (12) und sie an den ASAM ODS-Server zurückzugeben (13), der sie an den Client zurückleitet (14). Aus Sicht des Clients gibt es keinen Unterschied zwischen einem Aufruf, der direkt vom ASAM ODS-Server bearbeitet wird, und einem, der an ein EXD-API Plugin delegiert wird.

Entwicklung von ASAM ODS EXD-API Plugins

Die Entwicklung eines EXD-API Plugins beginnt mit dem Abrufen der gRPC-Definitionsdatei (.proto-Datei) aus dem ASAM GitHub Repository. Verwenden Sie die gRPC-Tools, um aus der .proto-Datei den initialen Servercode zu generieren. Die gRPC-Tools unterstützen viele verschiedene Programmiersprachen, und Sie wählen am besten eine Programmiersprache, die bereits eine Bibliothek für das Datei- oder Datenformat bereitstellt, für das Sie Ihren EXD-API Plugin erstellen möchten.

Die Benutzerfreundlichkeit und das reichhaltige Ökosystem machen Python zu einer beliebten Programmiersprache für die Erstellung von gRPC-Services. Einige Beispiele für Python-basierte EXD-API Plugins finden Sie unter totonga oder [Peak Solution GitHub repository].

Bitte beachten Sie, dass Ihr EXD-API Plugin nach der Programmierung beim ASAM ODS Server und dem entsprechenden Import Service registriert werden muss, damit Ihre Daten in einem ASAM ODS Server angezeigt werden.