Parser erstellen

In dieser Anleitung wird beschrieben, wie Sie einen Parser erstellen. Parser führen Datentransformationen und ‑zuordnungen durch. Die genauen Transformationsschritte sind in der Dokumentation zum „whistle“-Script für Manufacturing Data Engine (MDE) definiert.

Parser erstellen

Parser führen Quelle-zu-Ziel-Zuordnungen mithilfe eines Whistle-Skripts aus. Beim Erstellen eines Parsers müssen Sie drei Kernelemente definieren:

Die Nachrichtenklasse, deren Nachrichtenstream ein Parser abonniert (Eingabe).
Typversion des Proto-Datensatzstreams, der vom Parser ausgegeben wird.
Das Whistle-Script zum Transformieren von Quellnachrichten aus der angegebenen Nachrichtenklasse (Eingabe) in Proto-Datensätze der definierten Typversion (Ausgabe).

Das Whistle-Script wird auf jede Nachricht im Stream der Quellnachrichtenklasse angewendet und gibt Proto-Datensätze einer bestimmten Typ-Version aus. Wir empfehlen, die Quellnachrichtenklassen so zu modellieren, dass sie eine gemeinsame semantische und schematische Struktur haben. Gut definierte Quellnachrichtenklassen tragen dazu bei, komplexe bedingte Logik in Parsern zu minimieren. Weitere Informationen finden Sie im Abschnitt Quellnachricht-Klassen modellieren.

Sie können einen Parser mit der Configuration API oder der Console erstellen:

REST

POST /configuration/v1/parsers

{
  "name": "PARSER_NAME",
  "messageClassName": "SOURCE_MESSAGE_CLASS_NAME",
  "typeReference": {
    "name": "TYPE_NAME",
    "version": TYPE_VERSION
  },
  "script": "WHISTLE_SCRIPT"
}

Ersetzen Sie Folgendes:

PARSER_NAME: der Name des Parsers.
SOURCE_MESSAGE_CLASS_NAME: Der Name der Source Message Class (Quellnachrichtenklasse), für deren Nachrichtenstream dieser Parser abonniert ist.
TYPE_NAME: Der Name des Typs, der von den Proto-Datensätzen gemeinsam verwendet wird, die von diesem Parser ausgegeben werden.
TYPE_VERSION: die Version des Typs, die von den Proto-Datensätzen, die von diesem Parser ausgegeben werden, gemeinsam verwendet wird.
WHISTLE_SCRIPT: Das Whistle-Skript, das die Transformation definiert.

Console

Wenn Sie einen neuen Parser über die Console erstellen möchten, wählen Sie im oberen Menü den Bereich PARSERS (PARSER) aus. Eine Liste der verfügbaren Parser wird angezeigt:
Für jeden verfügbaren Parser werden in der Liste die folgenden Informationen angezeigt:
- Name:Name des Parsers.
- Message Class Name: Name der Nachrichtenklasse, aus der der Parser Daten bezieht.
- Type: Zieltyp, der vom Parser ausgegeben wird.
- Type Version: Version des Zieltyps, die vom Parser ausgegeben wird.
- Enabled: Status des Parsers (aktiviert oder deaktiviert).
- Actions: Verfügbare Aktionen für den Parser:
  - Ansehen/Bearbeiten: Öffnet das Bearbeitungsmenü für einen bestimmten Parser.
  - Deaktivieren/Aktivieren: Ermöglicht das Deaktivieren eines aktivierten Parsers oder das Aktivieren eines deaktivierten Parsers.
  - Parser testen: Öffnet eine spezielle Benutzeroberfläche, mit der Sie den Parser mit einer bestimmten JSON-Datei testen können.
  - Löschen: Der Parser wird aus MDE gelöscht.
Klicken Sie auf ADD NEW PARSER (NEUEN PARSER HINZUFÜGEN), um einen neuen Parser zu erstellen.
Wenn Sie den Bearbeitungsbereich eines bestimmten Parsers öffnen möchten, klicken Sie auf das Symbol Aktionen und dann auf Ansehen/Bearbeiten. Das Seitenmenü mit allen erforderlichen Parametern zum Erstellen eines neuen Parsers wird rechts auf dem Bildschirm angezeigt:
Zum Definieren des neuen Parsers müssen die folgenden Parameter angegeben werden:
- Name: Name des Parsers. Kann nach der Erstellung nicht mehr bearbeitet werden.
- Message Class: Name der Nachrichtenklasse, aus der der Parser Daten bezieht. Kann nach dem Erstellen des Parsers nicht mehr geändert werden. Wählen Sie die Nachrichtenklasse aus der Liste der verfügbaren Nachrichtenklassen aus.
- Parser Code: Whistle-Datei, in der die dem Parser zugeordnete Zuordnung definiert ist. Sie kann jederzeit geändert werden. Wenn Sie den Whistle-Code ändern, wird keine neue Version der Parser generiert. Parser werden nicht versioniert.
- Type: Der vom Parser ausgegebene Typ. Sie kann nach der Erstellung des Parsers nicht mehr geändert werden. Wählen Sie den Typ aus der Liste der verfügbaren Typen aus. Bei neuen Parsern wird standardmäßig die neueste Typversion ausgewählt.

Wenn Sie den Parser erstellen möchten, ändern Sie die Parserparameter und klicken Sie unten auf ERSTELLEN. Wenn der neue Parser erfolgreich erstellt wurde, wird eine Bestätigungsmeldung angezeigt.

Parser testen

Sie können einen Parser testen, indem Sie ein Whistle-Skript und eine Beispiel-Eingabenachricht angeben:

REST

POST /configuration/v1/parsers:test

{
  "script": "SCRIPT",
  "testMessage": TEST_MESSAGE
}

Ersetzen Sie Folgendes:

SCRIPT: Das zu testende Whistle-Skript (als String formatiert).
TEST_MESSAGE: Testnachricht als Eingabe (als JSON-Objekt formatiert).

Console

Sie können den Parser direkt über das Menü Aktionen sowie im Menü Parser bearbeiten testen.

Wenn Sie einen Parser testen möchten, klicken Sie auf TESTEN. Ein Testbildschirm wird geöffnet:
Geben Sie eine JSON-Beispielnachricht an, um den Parser zu testen.
Geben Sie die Nachricht in das Feld Eingabe ein und klicken Sie auf die Schaltfläche TEST AUSFÜHREN.

Wenn die Transformation erfolgreich ist, wird die Ausgabemeldung im Feld Ergebnis angezeigt.
Wenn die Transformation nicht erfolgreich ist, wird eine Fehlermeldung mit der wahrscheinlichen Ursache des Fehlers angezeigt.

Verwenden Sie eine gültige JSON-Datei als Testnachricht, die eine Struktur hat, die von der Whistle-Datei des Parsers verarbeitet werden kann. Hier ist ein Beispiel für eine numerische Nutzlast, die von Manufacturing Connect Edge generiert wird und im default-numeric-value-to-default-numeric-records-Parser getestet werden kann:

{
  "datatype": "int",
  "description": "",
  "deviceID": "0619E715-D1B8-438F-A1AB-E4D65D27EE83",
  "deviceName": "MicroLogix1100",
  "metadata": {
    "location": "ES-BCN-GRA",
    "manufacturer": "AllenBradley",
    "model": "MicroLogix1100",
    "os_revision": "Series B FRN 12.0",
    "source": "mce"
  },
  "registerId": "0997D2ED-B2AB-434C-9754-C1A3C2E9C165",
  "success": true,
  "tagName": "Manufactueing Connect edge_July_test_tag",
  "timestamp": 1691163012045,
  "value": 8004
}

Parser bearbeiten

Sie können einen vorhandenen Parser aktualisieren, einschließlich des Whistle-Scripts:

REST

PATCH /configuration/v1/parsers/NAME

{
  "disabled": DISABLED,
  "script": "SCRIPT",
  "typeReference": {
    "name": "TYPE_NAME",
    "version": TYPE_VERSION
  },
  "script": "WHISTLE_SCRIPT"
}

Ersetzen Sie Folgendes:

DISABLED: Status des Parsers (wahr oder falsch).
NAME: Name des Parsers.
TYPE_NAME: Name des Typs, der von den Proto-Datensätzen, die von diesem Parser ausgegeben werden, gemeinsam verwendet wird.
TYPE_VERSION: Version des Typs, die von den Proto-Datensätzen, die von diesem Parser ausgegeben werden, gemeinsam verwendet wird.
WHISTLE_SCRIPT: Whistle-Skript, das die Transformation definiert.

Console

Klicken Sie zum Öffnen des Bearbeitungsbereichs eines bestimmten Parsers auf das Symbol Aktionen und dann auf Anzeigen/Bearbeiten:
Das Seitenmenü Parser bearbeiten wird geöffnet und die erforderlichen Parameter zum Konfigurieren des Parsers werden angezeigt:

Name: Name des Parsers. Kann nach der Erstellung nicht mehr bearbeitet werden.
Message Class: Name der Nachrichtenklasse, aus der der Parser Daten bezieht. Kann nach dem Erstellen des Parsers nicht mehr geändert werden.
Parser Code: Whistle-Datei, in der die dem Parser zugeordnete Zuordnung definiert ist. Sie kann jederzeit geändert werden. Wenn Sie den Whistle-Code ändern, wird keine neue Version der Parser generiert. Parser werden nicht versioniert.
Type: Der vom Parser ausgegebene Typ. Sie kann nach der Erstellung des Parsers nicht mehr geändert werden.
Version: Ausgabetyp version, der vom Parser ausgegeben wird. Kann jederzeit für höhere Versionen geändert werden.

Wenn Sie einen Parser bearbeiten möchten, ändern Sie die Parserparameter und klicken Sie auf SPEICHERN.
Wenn der Parser erfolgreich erstellt wurde, wird eine Bestätigungsmeldung angezeigt.