Crea un analizador

En esta guía, se explica cómo crear un analizador. Los analizadores realizan la transformación y la asignación de datos. Los pasos exactos de la transformación se definen en la documentación de la secuencia de comandos whistle de Manufacturing Data Engine (MDE).

Crea un analizador

Los analizadores realizan asignaciones de origen a destino por medio de una secuencia de comandos de Whistle. Cuando crees un analizador, deberás definir tres elementos principales:

1. La clase de mensaje a cuyo flujo de mensajes se suscribe un analizador (entrada).
2. Versión del tipo del flujo de registros .proto que emite el analizador (salida).
3. Es el script de Whistle para transformar los mensajes fuente de la clase de mensaje especificada (entrada) en registros .proto de la versión de tipo definida (salida).

El script de Whistle se aplica a cada mensaje del flujo de la clase de mensajes fuente y genera registros proto de una versión de tipo específica. Te recomendamos que te tomes el tiempo necesario para modelar tus clases de mensajes fuente de modo que compartan una estructura semántica y esquemática común. Las clases de mensajes fuente bien definidas ayudan a minimizar la lógica condicional compleja en los analizadores. Consulta la sección sobre cómo modelar clases de mensajes fuente para obtener más orientación.

Importante: A partir de la versión 1.4.1 de Manufacturing Data Engine (MDE), los encabezados de los mensajes de Pub/Sub ahora se almacenan en un atributo reservado llamado mdeHeaders. Si tus mensajes de entrada contienen ese atributo, una expresión como embeddedMetadata: $root[where ($.field !=...)] reemplazará el atributo reservado y provocará la pérdida de los datos del encabezado de Pub/Sub que se proporcionaron con el mensaje perimetral. Asegúrate de usar la expresión de filtro genérica de Whistle con precaución para que no se pierdan datos.

Puedes crear un analizador con la API de configuración o la consola:

REST

POST /configuration/v1/parsers

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

Reemplaza lo siguiente:

• PARSER_NAME: Es el nombre del analizador.
• SOURCE_MESSAGE_CLASS_NAME: Es el nombre de la clase de mensaje fuente a cuyo flujo de mensajes se suscribe este analizador.
• TYPE_NAME: Es el nombre del tipo que comparten los registros de .proto que emite este analizador.
• TYPE_VERSION: Es la versión del tipo que comparten los registros de .proto que emite este analizador.
• WHISTLE_SCRIPT: Es el script de Whistle que define la transformación.

Console

1. Para crear un nuevo analizador con la consola, selecciona la sección ANALIZADORES en el menú superior. Se muestra una lista de los analizadores disponibles:

   

2. Para cada analizador disponible, se muestra la siguiente información en la lista:

   • Name:Nombre del analizador.
   • Message Class Name: Nombre de la clase de mensaje de la que se alimenta el analizador.
   • Type: Es el tipo de destino que emite el analizador.
   • Type Version: Es la versión del tipo de destino que emite el analizador.
   • Enabled: Estado del analizador (habilitado o inhabilitado).
   • Actions: Acciones disponibles para el analizador:
     • "Ver/Editar": Abre el menú de edición de un analizador determinado.
     • "Inhabilitar/Habilitar: Permite inhabilitar un analizador habilitado o habilitar uno inhabilitado.
     • "Test parser": Abre una interfaz dedicada para probar el analizador con un archivo JSON determinado.
     • "Borrar": Borra el analizador del MDE.

3. Para crear un nuevo analizador, haz clic en AGREGAR UN ANALIZADOR NUEVO.

4. Para abrir la sección de edición de un analizador determinado, haz clic en Ver/Editar en el ícono de Acciones. El menú lateral que expone todos los parámetros necesarios para crear un nuevo analizador se muestra en el lado derecho de la pantalla:

   

5. Para definir el nuevo analizador, se deben proporcionar los siguientes parámetros:

   • Name: Nombre del analizador. Una vez que se crea, no se puede editar.
   • Message Class: Es el nombre de la clase de mensaje de la que se alimenta el analizador. No se puede modificar una vez que se crea el analizador. Selecciona la clase de mensaje en la lista de clases de mensajes disponibles.
   • Parser Code: Archivo Whistle que define la asignación asociada al analizador. Se puede modificar en cualquier momento. Si modificas el código de Whistle, no se generará una nueva versión de los analizadores. De hecho, los analizadores no tienen versiones.
   • Type: Es el tipo de salida que emite el analizador. No se puede modificar después de crear el analizador. Selecciona el tipo de la lista de tipos disponibles. En el caso de los analizadores nuevos, se selecciona la versión de tipo más reciente de forma predeterminada.

Para crear el analizador, modifica los parámetros y haz clic en CREAR en la parte inferior. Si el nuevo analizador se creó correctamente, se mostrará un mensaje de confirmación.

Cómo probar un analizador

Para probar un analizador, proporciona una secuencia de comandos de Whistle y un mensaje de entrada de muestra:

REST

POST /configuration/v1/parsers:test

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

Reemplaza lo siguiente:

• SCRIPT: Es el código de Whistle que se probará (con formato de cadena).
• TEST_MESSAGE: Es el mensaje de prueba de entrada (con formato de objeto JSON).

Console

Puedes probar el analizador directamente desde el menú Actions, así como en el menú Edit Parser.

1. Para probar un analizador, haz clic en PROBAR. Se abrirá una pantalla de prueba:

   

2. Proporciona un mensaje JSON de muestra para probar el analizador.

3. Introduce el mensaje en el cuadro Input y haz clic en el botón RUN TEST.

• Si la transformación se realiza correctamente, el mensaje de salida se muestra en el cuadro Resultado.
• Si la transformación no se realiza correctamente, se muestra un mensaje de error con la posible causa del error.

1. Usa un archivo JSON válido como mensaje de prueba que tenga una estructura que pueda procesar el archivo Whistle del analizador. Por ejemplo, esta es una muestra de una carga útil numérica generada por el borde de Manufacturing Connect que se puede probar en el analizador default-numeric-value-to-default-numeric-records:

{
  "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
}

Cómo editar un analizador

Puedes actualizar un analizador existente, incluido el script de Whistle:

REST

PATCH /configuration/v1/parsers/NAME

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

Reemplaza lo siguiente:

• DISABLED: Estado del analizador (verdadero o falso).
• NAME: Es el nombre del analizador.
• TYPE_NAME: Nombre del tipo que comparten los registros de .proto que emite este analizador.
• TYPE_VERSION: Versión de tipo que comparten los registros de .proto que emite este analizador.
• WHISTLE_SCRIPT: Es el script de Whistle que define la transformación.

Console

1. Para abrir la sección de edición de un analizador determinado, haz clic en Ver/Editar en el ícono de Acciones:

   

2. Se abrirá el menú lateral Edit Parser, que expondrá los parámetros necesarios para configurar el analizador:

   

• Name: Nombre del analizador. Una vez que se crea, no se puede editar.
• Message Class: Es el nombre de la clase de mensaje de la que se alimenta el analizador. No se puede modificar una vez que se crea el analizador.
• Parser Code: Archivo Whistle que define la asignación asociada al analizador. Se puede modificar en cualquier momento. Si modificas el código de Whistle, no se generará una nueva versión de los analizadores. Los analizadores no tienen versiones.
• Type: Es el tipo de salida que emite el analizador. No se puede modificar después de crear el analizador.
• Version: Es la versión del tipo de salida que emite el analizador. Se puede modificar en cualquier momento para versiones superiores.

1. Para editar un analizador, modifica sus parámetros y haz clic en GUARDAR.
2. Se mostrará un mensaje de confirmación si el analizador se creó correctamente.