Recipes

Descripción

Este endpoint muestra las configuraciones de los datapoints de los diferentes orígenes gestionados por la instancia de Netin DS-Zavod.

Se debe consultar cuando se desee conocer la configuración y las transformaciones que se realizan a los valores de los datapoints.

Podemos encontrar el listado de todos los origenes accediendo desde el navegador a la ruta :/v1/recipes.

Podemos consultar sobre un origin específico accediendo desde el navegador a la ruta <ip>:<Zavod_port>/v1/recipes?origin=<origin_a_consultar>.

Visualización

Al realizar una petición GET al endpoint nos devuelve una respuesta similar a la siguiente:

Aparece un listado de origenes. Dentro de cada origen encontramos un listado con los identificadores de los DatapointSet que contiene dicho origen.

Listado de campos

Para cada uno de los DatapointSet de un origen tenemos los siguientes campos: - uuid(string): Indica el identificador único del origen.

• datapointSetId(string): Indica el identificador del DatapointSet

• type(DatapointSetType): Indica el tipo de DatapointSet. Estos pueden ser map, tableStatic o tableDynamic.

• indexes(string[]|undefined): En el caso de que el DatapointSet sea de tipo tableStatic o tableDynamic se muestra el nombre identificador (clave) para las diferentes filas de la tabla.

• datapointList(string[]): Es una lista que contiene los datapoints contenidos en el DatapointSet.

• virtualDatapointList(string[]): Es una lista que de los datapoints generados por Zavod para el DatapointSet.

• timepoints(string[]): Es una lista de datapoints de tipo timepoint (TIMEPOINT, @DATAPOINT ó @TIMEPOINT) que deben ser tratado por Zavod.

• externalTimepoints(string[]): Lista de los datapoints de tipo (#TIMEPOINT), es decir, timepoints que son generados por un driver y que no necesita intervención de Zavod.

• broadcast(boolean): Indica si el datapointSet debe ser transmitido a Kafka.

• routing(IRouting| undefined): Es el objeto de configuración de enrutamiento a Kafka.

• absoluteReferencesList([string, string][]): Es una lista de pares, dónde el primer valor nos indica la ruta absoluta de un datapoint y el segundo valor es una referencia. Esta referencia es usada en la configuración de transformar/cálculo del valor de algún datapoint contenido en el datapointSet.

• relativeReferencesList([string, string][]): Es una lista de pares, dónde el primer valor nos indica la ruta absoluta de un datapoint y el segundo valor es una referencia. Esta referencia es usada en la configuración de transformar/cálculo del valor de algún datapoint contenido en el datapointSet. A diferencia del anterior, los valores que se indican aquí obligatoriamente son datapoints del mismo DatapointSet.

• templateVersion(string): Indica la versión de la plantilla de la cuál se extrae la información del DatapointSet.

• templateId(string): Es el identificador de la plantillade la cuál se extrae la información del DatapointSet.

• initialValues({[k: string]: IDataPoint}): Muestra un listado de los datapoints que son configurados con un defaultValueConfig y que o bien son valores constantes (no tienen un addresConfig ni un calcConfig) o tienen un valor inicial preestablecido (la propiedad del isDefault del defaultValueConfig es TRUE). Estos datapoints son iniciados y generados por la instancia de Zavod.

• elaborations({[k: string]: ZavodConfig}): Muestra un listado de las configuraciones de alerta (alertConfig) o conversión/transformación (convConfig, calcConfig, rowFilterConfig, defaultValieConfig, operandConfig) de los datapoints contenidos en el datapointSet.

• AlertConfig: muestra la información decisoria para la creación de una alerta:
  • evaluations(Evaluation[]): Es una lista de las posibles alarmas que pueden ser creadas. Cada una de las evaluaciones contiene los siguientes datos:
  • logic(string): Indica la lógica usada para determinar si el valor del datapoint debe causar una alarma.
  • severity(number): Indica la severidad con la que se va a crear la alarma en caso de que se cumpla la expresión de logic.
  • text(string): Es un texto descriptivo de la alarma.
  • textHelp(string): Aporta detalles adicionales acerca de la alarma, o de cómo solucionarlo.
  • onStartup(boolean): Indica que las alarmas deben estar levantadas en el primer ciclo de polling.
  • audited(boolean): Indica el hecho de que la alarma debe ser auditada por el usuario.
  • hidden(boolean): Indica el hecho de que la alarma debe estar oculta.
  • broadcast(boolean): Indica el hecho de que la alarma debe ser retransmitida.
  • facility(number): Indica la identificación de los grupos de recursos.
  • routing(Routing): Es el objeto de configuración del enrutado para su retransmisión. Este a su vez, posee los siguientes campos:
    • topic(string): Define el tópico o topic que será usado en NetinHub para el enrutado.
    • service(string): Define el servicio el cual consumirá los datos.
    • serviceConfig(Record): Es un objeto que define la configuración del servicio.
• CalcConfig: muestra la información relacionada al calculo del valor de un datapoint:
  • expression(string): Es la expresión a ser aplicada con el fin de calcular el valor del datapoint.
  • quality(string): Es la expresión que combina la calidad de todos los operandos en la configuración de la conversión y que da como resultado el quality del valor calculado.
  • operands(string[]): Es una lista con los distintos operandos de la expresión.
• ConvConfig: muestra la información relacionada a la conversión del valor de un datapoint:
  • expression(string): Es la expresión a ser aplicada con el fin de realizar una conversión al valor del datapoint.
  • quality(string): Es la expresión que combina la calidad de todos los operandos en la configuraciónde la conversión y que da como resultado el quality de la conversión de valor.
• DefaultValueConfig: muestra la información relacionada a un datapoint definido como una constante o con un valor inicial:
  • rawValue(unknown): valor del datapoint antes de sufrir cualquier tipo de transformación.
  • value(unknown): valor del datapoint después de sufrir cualquier tipo de transformación.
  • isDefault(boolean): Indica si es un valor por defecto o no.
• OperandConfig: muestra un listado con los datapointSets del mismo origen los cuales han calculado el valor de alguno de sus datapoints mediante la referencia de un datapoint perteneciente al datapointSet observado.