Esta documentación está en fase de desarrollo y puede contener errores.

Informes API

Informes que cumplen requisitos de nombre y categoría para consumirse de forma estandarizada por sistemas externos, divididos en sincronizables y no sincronizables.

Un informe API es un informe normal que cumple tres requisitos para que un sistema externo lo consuma:

  • Nombre: debe empezar por el prefijo API -.
  • Categoría: Funcionalidad.
  • Subcategoría: API.

Los informes API se clasifican en dos tipos:

  • Syncable (Sincronizable)
  • Non-Syncable (No sincronizable)

Ten cuidado al modificarlos: un cambio inapropiado puede generar incompatibilidades con los sistemas conectados. Recomendaciones:

  • Agregar columnas: incorporar columnas nuevas no debería afectar a la compatibilidad, aunque puede afectar al rendimiento.
  • Editar columnas: modificar columnas existentes puede provocar incompatibilidades con otros sistemas que ya usan el informe.
  • Ampliación de informes: si necesitas agregar una columna, valora crear un informe nuevo. En informes pequeños puede bastar con añadir la columna: mantener menos informes simplifica su administración.

Syncable (Sincronizable)

Informe Syncable

Los informes sincronizables incluyen, además de las columnas necesarias, las columnas requeridas para la sincronización (por ejemplo ID, Eliminado o FechaIA). No contienen datos relacionados. En términos SQL, corresponden a consultas sencillas del tipo:

SELECT a, b, c FROM xx;

(sin JOIN, GROUP BY ni subconsultas)

Ejemplo: en un informe sincronizable de ventas, se puede incluir la columna Ventas > Cliente ID, pero no se deben incluir niveles adicionales como Ventas > Cliente ID > Nombre.

Estos informes son compatibles con Dinaup PG Sync.

Non-Syncable (No sincronizable)

Informe No Sincronizable

Los informes no sincronizables contienen datos complejos, como relaciones, filtros avanzados, agrupaciones, algoritmos o datos indirectos.

Debido a esta complejidad, estos informes no son compatibles con Dinaup PG Sync.

On this page