Interfaces¶

Las interfaces documentan los flujos lógicos de datos entre sus aplicaciones. Cada interfaz representa una integración de negocio (el "por qué" y el "qué" del intercambio de datos), independiente de cómo se implementa técnicamente. El espacio de trabajo le permite describir la interfaz, definir los tramos que mueven datos a través de su panorama, configurar enlaces específicos por entorno, capturar las reglas de mapeo a nivel de campo y vincular interfaces, documentos y adjuntos relacionados.

Primeros pasos¶

Navegue a Panorama IT > Interfaces para ver su registro de integraciones. Haga clic en Añadir interfaz para crear una nueva entrada, o abra una existente para editarla.

Añadir interfaz abre la página de la interfaz en la pestaña Flujo, donde están sus campos obligatorios:

El título: un nombre descriptivo para la integración
Aplicación de origen y Aplicación de destino, en la pestaña Flujo
Categoría de datos, en el panel de propiedades: el tipo de datos transferidos

Puede rellenarlos en cualquier orden. No se guarda nada hasta que los cuatro estén rellenados. En cuanto lo están, Kadratis crea la interfaz con todo lo que contiene el borrador y le asigna su referencia (INT-4). La página pasa a la interfaz, y Entornos, Mapeo de datos, Relaciones e Historial se abren.

Consejo: Defina pronto el Tipo de ruta. Controla qué tramos se generan automáticamente y qué aparece en la pestaña Flujo y en la matriz de Entornos.

Crear o cancelar¶

Mientras la interfaz se está creando, su encabezado muestra Crear y Cancelar. Permanecen hasta que salga de la interfaz.

Crear conserva la interfaz y le devuelve al punto de partida. Si todavía falta algo, un mensaje lo indica, y el título o el primer campo que falta recibe el foco. Si el borrador está completo, Kadratis crea la interfaz y le devuelve al instante
Cancelar elimina la interfaz. Si añadió algo después de su creación, una confirmación enumera lo que se eliminará. Puede cancelar su propia creación sin el derecho a eliminar interfaces

Si sale de la interfaz de otra forma (el menú, la flecha de retroceso), se conserva: está completa.

Antes de que se cree la interfaz, Cancelar, la flecha de retroceso o Escape en el título salen sin guardar. Cuando el borrador contiene algo, una confirmación pregunta antes de descartarlo. Un enlace del menú pregunta lo mismo.

Trabajar con la lista¶

La cuadrícula de Interfaces muestra su registro de integraciones de un vistazo.

Columnas predeterminadas:

Referencia: La referencia que asigna Kadratis (INT-4)
Código de interfaz: Su propio código corto, si lo ha definido
Nombre: Nombre de la interfaz
Entornos: Puntos de colores que muestran qué entornos ya tienen enlaces configurados (p. ej., PROD, QA, DEV)
App de origen y App de destino: Las aplicaciones conectadas
Ciclo de vida: Estado actual
Criticidad: Importancia para el negocio
Creado: Cuándo se creó el registro

Columnas adicionales (mediante el selector de columnas):

Proceso de negocio: Proceso de negocio vinculado
Categoría de datos: Tipo de datos transferidos
Contiene PII: Si la interfaz maneja datos personales
Cobertura de entornos: Número de entornos con al menos un enlace
Enlaces: Número total de enlaces de entorno

Filtrado:

Búsqueda rápida en todas las columnas de texto
Filtros de columna en las columnas de texto
Ciclo de vida, Criticidad, Proceso de negocio, Categoría de datos y Contiene PII usan filtros de casillas, así que puede elegir varios valores a la vez. El filtro Criticidad ofrece también (Vacío) para las interfaces sin criticidad

Ordenación:

Criticidad se ordena por gravedad, en el orden de los niveles de Clasificaciones y continuidad. Las interfaces sin valor van al final

Acciones:

Añadir interfaz: Crear una nueva interfaz (requiere applications:member)
Duplicar interfaz: Crear una copia de una interfaz seleccionada (requiere applications:member). Seleccione exactamente una fila para activar esta acción. Un diálogo le permite elegir si copiar los enlaces de entorno; consulte Copiar interfaces más abajo.
Eliminar seleccionadas: Eliminar interfaces seleccionadas (requiere applications:admin). Antes de la confirmación, la ventana muestra como conservadas las interfaces que tienen enlaces, con su número de enlaces. Marque Eliminar también los enlaces relacionados para eliminarlas con sus enlaces; sus conexiones se conservan. El mensaje nombra después las interfaces eliminadas y las conservadas, con el motivo.

El espacio de trabajo de Interfaces¶

Haga clic en cualquier fila para abrir el espacio de trabajo. El espacio de trabajo tiene seis pestañas, con las propiedades de la interfaz en un panel lateral a la derecha. El nombre de la cabecera se puede editar en el mismo lugar. La última, Historial, lista los cambios hechos en la interfaz (vea Historial de los registros).

La cabecera lleva Eliminar, un icono de papelera con su nombre en una información emergente (applications:admin). La confirmación usa la misma comprobación que Eliminar seleccionadas. Indica que esta acción no se puede deshacer. Cuando la interfaz tiene enlaces, los explica y ofrece Eliminar también los enlaces relacionados: la eliminación está disponible una vez marcada esa opción, los enlaces se van con la interfaz y las conexiones se conservan. La lista se abre de nuevo después.

Propiedades de la interfaz (panel lateral)¶

El panel lateral permanece visible en cada pestaña. Haga clic en su pestaña Propiedades para plegarlo o desplegarlo. Contiene tres grupos de campos:

Identificación:

Referencia: Asignada por Kadratis, de solo lectura
Código de interfaz: Su propio código corto
Proceso de negocio: Vínculo a un proceso de negocio de los datos maestros
Ciclo de vida
Creado el y Actualizado el: Fechas de solo lectura

Equipo:

Responsables de negocio: Partes interesadas del negocio responsables de la integración
Responsables de IT: Miembros del equipo técnico responsables del mantenimiento
Empresas afectadas: Las empresas a las que afecta la integración

Datos y conformidad:

Criticidad: Importancia para el negocio
Categoría de datos (obligatoria): El tipo de datos transferidos
Clasificación de datos: Nivel de sensibilidad
Contiene PII: Cuando está activado, aparece un campo Descripción de PII para que pueda detallar qué PII está incluido
Residencia de los datos: Países por donde fluyen los datos

Los cambios en los campos del panel lateral se guardan automáticamente, de modo que puede actualizar propiedades desde cualquier pestaña sin cambiar de contexto. Las aplicaciones de origen y destino, el tipo de ruta y el middleware se definen en la pestaña Flujo.

Vista general¶

La pestaña Vista general contiene la Especificación, un documento de texto enriquecido gestionado donde describe la interfaz de principio a fin: contexto de negocio, alcance, contrato, ejemplos. Es el documento narrativo principal de la interfaz.

Consejo: Use esta pestaña como su única fuente de verdad para la prosa. Las reglas de mapeo y los tramos técnicos viven en las pestañas dedicadas a continuación; mantenga este documento centrado en la intención, el alcance y el resumen legible para humanos.

Flujo¶

La pestaña Flujo define la ruta de la interfaz y, después, los tramos compartidos que la componen.

Flujo lógico:

Aplicación de origen y Aplicación de destino (obligatorias)
Tipo de ruta: Directo o Vía middleware
Aplicaciones middleware: Solo se muestra cuando el tipo de ruta es Vía middleware. La lista se restringe a las aplicaciones marcadas como ETL/middleware.

Plantilla de tramos: Los tramos describen lo que hace cada paso en general (la misma definición se aplica en todos los entornos). Para cada tramo puede editar:

Tipo de tramo: Extracción, Transformación, Carga o Directo (definido automáticamente según la ruta de integración)
De -> A: Qué rol maneja cada paso (App de origen, App de destino o Middleware)
Tipo de disparador: Qué inicia este tramo (p. ej., programado, basado en eventos, manual)
Patrón: El patrón de integración (p. ej., lote, tiempo real, pub/sub)
Formato: El formato de datos (p. ej., JSON, XML, CSV, archivo plano)
Nombre de trabajo: Un nombre opcional de trabajo o proceso predeterminado

Si aún no aparecen tramos, seleccione las aplicaciones de origen y destino. Los tramos se generan a partir de Aplicación de origen, Aplicación de destino y Tipo de ruta.

Entornos¶

La pestaña Entornos gestiona los enlaces por entorno que convierten las plantillas de tramos en configuraciones reales. Presenta una matriz con una fila por tramo y una columna por entorno, para que pueda configurar cada combinación de forma independiente.

Entornos:

Añadir entorno (applications:member) ofrece los entornos donde las aplicaciones de origen y destino (y el middleware, en una ruta vía middleware) tienen todas un despliegue. Los despliegues se crean en el espacio de trabajo Aplicaciones.
Un entorno aparece en la matriz cuando usted lo añade o cuando tiene un enlace.
Para eliminar un entorno, haga clic en el icono de papelera de la cabecera de su columna. La confirmación indica el número de enlaces que se eliminan con él.
Una banda encima de la matriz muestra cada entorno con el número de tramos configurados sobre el total, por ejemplo QA 2/3. El punto es verde cuando todos los tramos están configurados, naranja cuando lo están algunos y gris cuando no lo está ninguno.

Celdas: Cada celda muestra el estado del enlace y sus puntos de conexión de origen y destino. Una vez abierto un enlace, su celda muestra también su conexión de infraestructura: la primera, con el número de las demás cuando hay más (+2). Un enlace Activo sin conexión de infraestructura muestra entonces Falta la conexión en naranja. Haga clic en una celda vacía para añadir un enlace, o en una celda configurada para editarlo. El icono de papelera de una celda elimina su enlace, tras una confirmación.

Panel del enlace: Al hacer clic en una celda se abre un panel junto a la matriz.

Para un enlace nuevo, rellene los campos y haga clic en Añadir enlace. Los selectores Despliegue de origen y Despliegue de destino aparecen cuando la aplicación tiene más de un despliegue en ese entorno. Si no, se usa el único despliegue. El selector Herramienta de integración aparece, y es obligatorio, en una ruta vía middleware cuando más de una aplicación middleware tiene un despliegue en el entorno.
Para un enlace existente, cada cambio se guarda sobre la marcha. La cabecera del panel indica cuándo se ha guardado el cambio.

Campos del enlace:

Estado: Los estados del ciclo de vida: Propuesto, Activo, Obsoleto, Retirado, más los que añada su administrador
Modo de autenticación: Cómo autentica el enlace
Conexión de infraestructura: La conexión de infraestructura de su registro de conexiones, para que pueda trazar la ruta completa desde la interfaz lógica hasta la conexión de red física. El panel edita una conexión. Cuando el enlace tiene más, las demás se indican con un número y se mantienen sin cambios.
Punto de conexión de origen y Punto de conexión de destino: Puntos de conexión técnicos (URLs, rutas, nombres de cola, etc.)
Detalles del disparador: Configuración del disparador específica del entorno
Nombre de job específico: Sustituye el nombre de trabajo de la plantilla de tramo en este entorno
URL de supervisión: Enlace a la supervisión u observabilidad de este enlace
Notas: Notas específicas del entorno

Mapeo de datos¶

La pestaña Mapeo de datos es donde describe cómo los campos de origen se convierten en campos de destino. Está organizada alrededor de dos conceptos:

Las reglas de mapeo describen una única decisión de mapeo: uno o más campos de origen, uno o más campos de destino, una operación (copia directa, transformación, búsqueda, división, fusión, filtro, valor predeterminado o una operación personalizada) y notas opcionales de condición / negocio / middleware.
Los grupos de mapeo son carpetas que organizan las reglas en secciones temáticas (por ejemplo "Cabecera", "Bloque del cliente", "Líneas de detalle", "Pie"). Las reglas pueden asignarse a un grupo o dejarse sin agrupar. Dos grupos base, Head e Item, están siempre presentes; puede añadir más.

La pestaña trabaja sobre el conjunto de mapeo predeterminado de la interfaz. La barra del encabezado muestra el nombre del conjunto, el número de revisión actual, los conteos de reglas y grupos.

Filtrado de reglas:

Use el desplegable Vista de grupo encima de la tabla de reglas para centrarse en:

Todas las reglas (predeterminado)
Reglas Sin agrupar (con el conteo)
Un grupo específico (mostrando el orden, el título y el conteo de reglas)

Gestionar grupos:

Haga clic en Gestionar grupos para abrir el gestor de grupos. Desde ahí puede:

Añadir un nuevo grupo (título, descripción opcional, orden)
Editar un grupo existente
Eliminar un grupo no base (las reglas asignadas a él pasan a Sin agrupar)

Los grupos base Head e Item pueden seleccionarse pero no editarse ni eliminarse.

Añadir o editar una regla:

Haga clic en Añadir regla o haga clic en cualquier fila de regla para abrir el panel de regla a la derecha. Campos de la regla:

Título de la regla (obligatorio) y Clave de regla opcional (un identificador técnico estable para exportaciones o sistemas posteriores)
Grupo: Asignar a un grupo o dejar Sin agrupar
Campo(s) de origen: Una fila por enlace de origen. Cada fila tiene una ruta (p. ej., origin.customerId) y un tipo opcional (cadena, número, fecha, etc., o cualquier descriptor de texto libre). Use múltiples filas para modelar mapeos 1:N o N:1.
Campo(s) de destino: Misma estructura, una fila por enlace de destino
Operación: Copia directa, Transformación, Búsqueda, División, Fusión, Filtro, Valor predeterminado u Otra (con una etiqueta de texto libre)
Se aplica al tramo: Restringir la regla a un tramo específico (p. ej., solo el tramo EXTRACT) o dejar como Todos los tramos
Orden: Orden de visualización dentro del grupo
Condición: Cuándo se aplica la regla
Regla de negocio: Explicación en lenguaje claro de la lógica de negocio
Nota de middleware / transformación: Notas de implementación para el equipo de middleware o ETL
Observaciones: Cualquier otra cosa que valga la pena anotar

La tabla de mapeo resume cada regla listando los enlaces de origen, una flecha y los enlaces de destino, además de la operación, el grupo al que pertenece y el alcance del tramo. Haga clic en una fila para editarla, o use los iconos de la fila para editar o eliminar.

Consejo: Mantenga una regla por decisión lógica en lugar de una regla por campo. Una regla que toma tres campos de origen y produce un campo de destino concatenado es más clara que tres filas casi idénticas, y el campo de operación hace explícita la intención.

Relaciones¶

La pestaña Relaciones muestra de qué depende esta interfaz y qué depende de ella, junto con sus enlaces y archivos. Primero aparecen los documentos de conocimiento vinculados a la interfaz, después las interfaces anteriores, las interfaces posteriores, y los enlaces y archivos. La insignia de la pestaña cuenta las interfaces anteriores y posteriores, y los enlaces y archivos. Los documentos de conocimiento no se cuentan.

Interfaces anteriores e Interfaces posteriores: una tabla cada una, con la referencia (INT-4), el nombre, la aplicación de origen, la aplicación de destino y el ciclo de vida. Haga clic en una fila para abrir la interfaz. Una interfaz retirada sigue en la lista, con su fila en gris. Use estas secciones para documentar un orden, por ejemplo "La sincronización de pedidos debe ejecutarse antes que la sincronización de facturas".

Una dependencia va en un solo sentido. Si añade la interfaz B como anterior a la interfaz A, B aparece como anterior solo en A. A no aparece como posterior en B.

Añadir y quitar interfaces (applications:member): Añadir, a la derecha de una sección, abre una búsqueda de interfaces. Escriba un nombre o una referencia y elija un resultado: el vínculo se guarda al instante. La búsqueda excluye esta interfaz y las interfaces que ya están en la sección. Para quitar un vínculo, pase el cursor sobre la fila y haga clic en la cruz del final. Quitar un vínculo no elimina ninguna de las dos interfaces. Los lectores ven las tablas en solo lectura.

Enlaces y archivos: los enlaces web de la interfaz (especificaciones, páginas de documentación, paneles de monitorización) y sus archivos, una fila cada uno con su nombre, el dominio del enlace o el tamaño del archivo, y la fecha en que se añadió. Haga clic en un enlace para abrirlo en una pestaña nueva, o en un archivo para descargarlo. Con applications:member:

Añadir enlace abre un diálogo para una URL y un nombre opcional; el enlace se guarda al instante. Para cambiar un enlace, pase el cursor sobre su fila y haga clic en el lápiz.
Adjuntar archivo abre el selector de archivos. También puede soltar archivos en la sección.
Para quitar un enlace o un archivo, pase el cursor sobre la fila y haga clic en la cruz. Quitar un enlace muestra un mensaje y ofrece Deshacer, que vuelve a crear el enlace. Eliminar un archivo pide confirmación antes.

Consejo: Adjunte la especificación y los documentos de mapeo a la interfaz, para que las personas que la operan los encuentren en un solo lugar.

Copiar interfaces¶

Hay dos formas de copiar interfaces en Kadratis.

Duplicar Interfaz (desde la cuadrícula de Interfaces)¶

Use esto cuando desee una copia independiente de una interfaz, típicamente para crear una integración similar entre las mismas o diferentes aplicaciones.

Seleccione una interfaz en la cuadrícula
Haga clic en Duplicar interfaz
Elija si copiar los enlaces de entorno:
Sin enlaces: Una copia limpia: solo la definición de la interfaz, los tramos, los responsables y los metadatos
Con enlaces: También copia los enlaces de entorno, pero borra los detalles específicos del entorno (puntos finales, autenticación, nombres de trabajo) para que pueda configurarlos de nuevo

Qué se copia:

Datos	Copiado
Definición de la interfaz (nombre, apps, tipo de ruta)	Sí
Tramos (extract / transform / load / direct)	Sí
Aplicaciones middleware	Sí
Responsables (negocio e IT)	Sí
Empresas afectadas	Sí
Dependencias	Sí
Identificadores clave	Sí
Enlaces a URLs externas	Sí
Residencia de datos	Sí
Especificación	Sí, con sus imágenes
Enlaces	Opcional
Grupos y reglas de mapeo	No
Adjuntos	No

Nomenclatura: La copia recibe " - copia" añadido tanto al nombre como al código de interfaz. Un código de interfaz vacío permanece vacío. La copia recibe su propia referencia.

Migración de versión (desde el versionado de aplicaciones)¶

Use esto al actualizar una aplicación a una nueva versión y necesite migrar interfaces a la nueva versión. Consulte Aplicaciones > Gestión de versiones para más detalles.

Diferencias clave respecto a Duplicar:

Aspecto	Duplicar	Migración de versión
Propósito	Crear copia independiente	Migrar a nueva versión de la app
Referencias de app	Sin cambios	Actualizadas a la nueva versión
Referencias de middleware	Sin cambios	Actualizadas si la app es middleware
Dependencias	Copiadas	No copiadas
Enlaces	Opcional (instancias sin cambios)	Opcional (instancias mapeadas a la nueva app)
Ciclo de vida	Preservado	Restablecido a Propuesto
Sufijo de nombre	" - copia"	" (nueva versión)"

Consejos¶

Documente primero el "por qué": Use la Especificación de la pestaña Vista general para capturar la intención antes de sumergirse en tramos y enlaces.
Use el panel lateral desde cualquier pestaña: Responsables, criticidad, indicador PII y el resto persisten inmediatamente, de modo que puede actualizarlos mientras revisa reglas o enlaces.
Una interfaz, muchos entornos: No cree interfaces separadas para cada entorno. Use una interfaz y configure cada entorno en la pestaña Entornos.
Agrupe sus reglas de mapeo: Para interfaces con más de un puñado de campos, organice las reglas en grupos de mapeo (Cabecera, Líneas de detalle, Pie, etc.). Hace que la revisión y el análisis de impacto sean mucho más fáciles.
Mantenga el middleware explícito: Si los datos fluyen a través de middleware, defina el tipo de ruta como Vía middleware en la pestaña Flujo y elija las aplicaciones middleware. El Mapa de interfaces renderizará entonces la ruta de datos real.
Duplique para interfaces similares: Al crear una nueva interfaz que es similar a una existente, use Duplicar interfaz para copiar todas las configuraciones, luego modifique lo que sea diferente. Opcionalmente incluya enlaces para obtener una ventaja en la configuración del entorno.
Vincule enlaces a conexiones de infra: En la pestaña Entornos, vincule cada enlace a su conexión de infraestructura subyacente para que pueda trazar la ruta completa desde la interfaz de negocio hasta la conexión de red.