Esquema
El explorador del esquema: IDs, nombres internos, columnas y variables de cada objeto, con código C#, JavaScript, Python y PHP por informe.
Desarrollo → Esquema muestra la estructura de datos de tu empresa tal como la ve la API: cada sección con sus campos, cada informe con sus columnas y variables, y cada documento dinámico con sus variables. Es donde se buscan los IDs y los nombres internos que van en el código.
Antes de empezar
- La aplicación Desarrollo en la licencia y el interruptor Desarrollador en tu usuario. Ver Desarrollo.
- El esquema se guarda en caché durante 24 horas. Una sección recién creada en FlexHub puede tardar hasta un día en aparecer.
La cabecera
Esquema de datos, con tres contadores (Secciones, Informes, Docs dinámicos) y un aviso que se puede cerrar: los campos personalizados usan el prefijo pr_ (por ejemplo pr_20040114079). Ese nombre interno es estable y no cambia aunque renombres el campo en la interfaz. Úsalo siempre en tu código.
Explorador de esquema
La tarjeta Explorador de esquema tiene tres pestañas con el número de elementos entre paréntesis. Cada pestaña es una tabla de 25 filas por página, con orden y filtro por columna. Pulsa una fila para abrir su ficha.
| Pestaña | Columnas | Si no hay nada |
|---|---|---|
| Secciones | Título, Etiqueta singular, Etiqueta plural, ID | No hay secciones en el esquema |
| Informes | Título, Categoría, Subcategoría, ID | No hay informes configurados |
| Docs Dinámicos | Título, Categoría, Subcategoría, ID | No hay documentos dinámicos |
La ficha de una sección
La ventana Sección muestra el icono, el título y el ID de la sección, y dos pestañas:
- Campos (N): los campos agrupados por la pestaña en la que salen en Flex (Sistema para los que no tienen). Cada campo lleva su etiqueta, su nombre interno entre paréntesis y su formato. Los obligatorios añaden Requerido; los de referencia, Se relaciona con sección ID y el ID de la sección destino.
- Tabla de campos: los mismos campos en una tabla con Label, Nombre interno, Formato, Tab, Req., Rol e ID, con orden y filtro.
Sin campos, las dos pestañas dicen No hay campos disponibles. Cerrar cierra la ventana.
La ficha de un informe
La ventana Informe muestra el título, el ID, la Categoría y, si la tiene, la Subcategoría. Debajo:
- Variables: las variables que admite el informe, con Etiqueta, Palabra clave e Información. Sin variables: No hay variables disponibles.
- Pestaña Columnas (N): Título, Datos, Formato e ID de cada columna. Sin columnas: No hay columnas disponibles.
- Pestaña Código: código generado a partir de las columnas, en siete pestañas. C#, JavaScript, Python y PHP declaran una clase de constantes, una por columna, con el ID de la columna como valor. C# DTO, JavaScript DTO y Python DTO declaran una clase con una propiedad por columna, con su tipo y su nombre JSON. Las clases toman el nombre de la palabra clave del informe. Sin columnas: No hay columnas para generar código.
Cerrar cierra la ventana.
La ficha de un documento dinámico
La ventana Documento dinámico muestra el título, el ID, la Categoría y, si la tiene, la Subcategoría, y la tabla Variables con Etiqueta, Palabra clave e Información. Sin variables: No hay variables disponibles. Con el ID y las palabras clave se llama al endpoint de documentos dinámicos desde Webhooks Entrantes.
Dónde se usan estos datos
- El ID de la sección y los nombres internos de los campos van en las WriteOperations del SDK .NET y del playground.
- El ID del informe y sus variables van en la llamada a
/api/Reports. Ver Referencia de endpoints. - Las secciones se diseñan en FlexHub. Su descripción está en Secciones, la de los informes en Informes y la de los documentos en Documentos dinámicos.