Informes

Un informe es una consulta guardada sobre una sección: qué columnas salen, con qué condiciones, en qué orden y agrupadas cómo. Lo abre una persona desde el menú, lo muestra un panel de Play, lo ejecuta una integración por la API o lo consume el SDK. En la Flex API es el tipo FlexObjectTypes.Reports; sus columnas son FlexObjectTypes.ReportColumns.

Antes de empezar

• Un informe pertenece a una sección principal activa: no a una plantilla base, a una tabla de líneas ni a una sección obsoleta. La sección no se cambia después de crearlo.
• La pantalla donde se crea y se edita: FlexHub → Informes. Desde el SDK, Flex_CreateObjectAsync(FlexObjectTypes.Reports, sectionId, patch).
• Un informe no se elimina desde FlexHub. Sus columnas sí.

Las familias

La columna destino guarda el enum TipoInformeE. Todo informe hecho a mano es Ordinario (12) y no cambia de tipo; los otros valores los crea el motor para su propio uso y no se editan a mano.

El servidor envía el tipo resuelto en IsOrdinaryReport y su etiqueta legible en KindLabel, para que ningún cliente tenga que interpretar el enum.

FlexHub reparte los informes en tres pestañas con esos datos: Negocio (los ordinarios que abre una persona), API (los de la categoría Funcionalidad, que consumen integraciones, SDK y procesos internos) y * (todos, incluidos los que genera el motor). Ver Informes API.

Identidad

En FlexHub, el Nombre va encima de las pestañas y el resto en la pestaña General, card Datos del informe.

Diseño

En FlexHub están en la pestaña Diseño, que sale con el informe ya creado.

Orden y agrupación

El orden son hasta nueve niveles, colorden1 a colorden9, cada uno con su columna y su sentido (colorden1desc a colorden9desc). El primero ordena todas las filas y el segundo solo ordena las que empatan en el primero. Sin niveles, las filas salen en el orden que devuelva la base de datos, que no está garantizado.

La agrupación son hasta nueve niveles, campoagrupacion1 a campoagrupacion9, cada uno con su modo en campoagrupacionmodo1 a campoagrupacionmodo9.

En FlexHub son las cards Cómo se ordena y Cómo se agrupa de la pestaña Diseño. Añadir un nivel elige una columna del informe; en un nivel de orden, De mayor a menor da el sentido, y en uno de agrupación, Qué se considera lo mismo da el modo, enum AgrupacionesCriteriosE:

La lista sale entera aunque no todos los modos encajen con todas las columnas: agrupar un texto por trimestre no significa nada.

Filtrado

Tres mecanismos determinan qué filas salen. En FlexHub están en la pestaña Filtrado:

Las comprobaciones son el enum TipoFiltradoE. Cuáles admite cada clase de dato lo publica el servidor en su catálogo; la familia de esta tabla sigue el nombre del miembro:

Una condición con lista admite hasta 20 valores: la fila sale si coincide con cualquiera.

Un valor de condición puede ser una constante o un valor que se calcula al abrir el informe: el usuario que lo abre, o la respuesta a una pregunta. FlexHub conserva y muestra esos valores calculados, con la nota Se calcula al abrir el informe., pero no los edita ni ofrece uno nuevo. Una condición que el servidor no puede descomponer se conserva tal cual y sale marcada Solo lectura.

Columnas

Una columna es un dato que el informe saca por pantalla. Al crear el informe, el servidor pone la primera, la de identidad (id de la sección); el resto las añade quien lo diseña. Un informe no tiene dos columnas con el mismo dato. En FlexHub, la ventana de una columna lleva el Título encima de las pestañas General, Cómo se ve y Agrupación. Su contrato, Flex_GetEditablesAsync(FlexObjectTypes.ReportColumns), más el dato con el que se crea:

Visibilidad (InfCol_VisibilidadE):

Rol (InfCol_RolE):

Resumen en la fila de grupo (ModoRepresentacionGrupalE): No agrupar (0), Sumar (1), Contar (2), Valor máximo (3), Valor mínimo (4), Media (5), Primero (6), Último (14), Contar distintos (7), Media distintos (8) y Sumar distintos (9). Los cuatro últimos solo valen con constantes: Contar vacíos (10), Contar sí (11), Contar no (12) y Contar Rellenado (13).

Una columna oculta sigue formando parte del informe: se calcula y sirve para ordenar, agrupar o filtrar. Quitar una columna no borra ningún dato y se puede restaurar; si el informe ordena o agrupa por ella, esas referencias se limpian y hay que volver a ponerlas.

Añadir columnas

La pestaña Columnas del informe tiene dos botones:

• Nueva columna abre la ventana de una columna. Al elegir el Dato, FlexHub propone el Título.
• Varias columnas abre Nuevas columnas: una fila por columna, con su Dato y su Título. Columna añade una fila. Agregar todos pone una fila por cada campo de datos de la sección que el informe todavía no muestra, el identificador incluido. Deja fuera los de formato Botón y los que rellena el motor: ubicacion, posicion, fecha, fecham, fechasyn, usuarioid y modificado. Aceptar crea las columnas una detrás de otra y consolida una sola vez.

El título propuesto es la etiqueta del campo. Si el dato es un campo de una relación, como su nombre, se propone la etiqueta de la relación: «Cliente», no «Nombre». Si el dato es la relación entera, el título termina en «ID»: «Cliente ID». Esto último es una regla de FlexHub: una columna cuyo dato es una relación no se crea si su título no termina en «ID», y el aviso es Falta «ID» en el título. Así se distingue de la columna del nombre.

Por la Flex API, Flex_CreateObjectAsync(FlexObjectTypes.ReportColumns, informeId, patch): el padre es el informe, no la sección. El patch lleva dato (la ruta) o campoid, y titulo. Con consolidar a 0, la columna se crea sin consolidar y el motor no la muestra hasta la siguiente consolidación: crea así todas las columnas y llama una vez a Flex_ConsolidateAsync.

Preguntas

Una pregunta es lo que el informe pide a quien lo abre antes de sacar las filas: una fecha, un importe, un registro. Es FlexQuestionDTO, el mismo tipo en informes, documentos y algoritmos; se lee con Flex_GetQuestionsAsync y se escribe con Flex_SetQuestionsAsync.

En FlexHub, las preguntas van al final de la pestaña Filtrado. Añadir pregunta abre la ventana Añadir pregunta. Añadir intervalo crea de una vez dos preguntas de tipo Fecha, «Desde» y «Hasta», con los nombres internos dinaup_desdef y dinaup_hastaf: el motor las reconoce por ese nombre. Solo cabe un intervalo por informe.

Las preguntas se pasan por posición (p1, p2, p3), no por nombre. Por eso un informe publicado o en uso llega con FlexQuestionsDTO.Frozen = true: no se añade, quita ni mueve ninguna, ni se cambia su formato, su sección o su rango de fechas. Se cambian la etiqueta, la ayuda, el desplegable y, por la Flex API, el rol; FlexHub no ofrece el rol.

Para un informe por periodo, la pregunta es de tipo Fecha con el rango activado, y la condición del filtro compara el campo de fecha con esa pregunta. Filtra por un campo de tipo Fecha (sin hora): el corte del periodo no depende de la zona horaria del usuario. Un campo Fecha y hora se guarda en UTC, y un registro de las 23:00 del último día cae en el día siguiente para un usuario con otra zona horaria. Por la API, cada pregunta se responde con su Keyword en el diccionario variables de POST /api/reports.

Consumir un informe

Siguiente: Informes API.