Informes Autodocumentados¶

Descripción General¶

Como novedad en Vinyl 2.4, Vinyl introduce funciones de autodocumentación en forma de informes. Áreas específicas de Vinyl tienen nuevas ofertas de informes disponibles que, cuando se ejecutan, enumeran y describen información de configuración relacionada con el área en la que está disponible el informe. Los informes para esta función están disponibles en las siguientes áreas de Vinyl: Documento API por Extremo, Notas de Lanzamiento por aplicación, Informes de auditoría por capa de Vinyl (capa de interfaz de usuario, capa de lógica empresarial, capa de almacenamiento de datos).

A continuación se detallan los nuevos informes específicos disponibles:

Documento API por Extremo¶

Cuando expone su aplicación como API, hay un nuevo informe Documento API por Extremo disponible que enumera todas las claves y usuarios de API, así como las conexiones externas (enumera las URLs utilizadas para conectarse a sistemas externos), incluidos los extremos de notificación y extremos REST. La documentación incluida en este informe también genera llamadas API de ejemplo y CURL de muestra en un formato que puede utilizar para copiar, pegar y comenzar a realizar pruebas directamente desde el resultado del informe. Las operaciones admitidas también se incluyen en este informe.

Para Ejecutar el Documento API por Informe de Extremo¶

Navegue hasta Vinyl IDE
Haga clic en Amplíe su empresa en el menú Conectar.
Seleccione la opción del menú de navegación Publicar.
Para la aplicación para la que está ejecutando un informe, haga clic en el icono de PDF en Doc:
La información resultante de Crystal Report incluye la información descrita anteriormente, así como una lista de operaciones admitidas:

Notas de Lanzamiento por Aplicación¶

Cuando generas una versión en Vinyl, hay un nuevo icono de documento que genera un informe Notas de Lanzamiento por aplicación para el paquete. El informe de Notas de Lanzamiento enumera todas las fuentes de datos, solicitudes de gestión de cambios, paquetes de traducción y configuración de exportación de tablas. La información incluida en este informe se deriva de la información proporcionada a medida que recorre el Generador de plantillas de versión.

Para Ejecutar el Informe de Notas de Lanzamiento por Aplicación¶

Navegue hasta Vinyl IDE
Haga clic en Desplegar su aplicación en el menú Construir.
Después de haber configurado su paquete de versión utilizando la plantilla Release Builder, haga clic en el icono de PDF en Doc:
El Informe Crystal resultante incluye la información descrita anteriormente:

Informes de Auditoría por Capa de Vinyl: Interfaz de Usuario, Lógica Empresarial y Capas de Almacenamiento de Datos¶

Hay nuevos informes de auditoría disponibles para todas las capas de Vinyl: capa UI, capa de lógica empresarial y capa de almacenamiento de datos. Además, los informes de roles y puentes recibieron una actualización de la interfaz de usuario para que coincida con las otras capas de Vinyl y parezcan consistentes.

Informe de Páginas y Menús de Capa de Interfaz de Usuario¶

Existe un nuevo informe de páginas y menús de la capa de la interfaz de usuario para proporcionar un informe imprimible de la configuración de la aplicación en la capa de la interfaz de usuario. La información del informe incluye: menús, un desglose de todas las páginas de la aplicación, incluida información sobre los detalles de la página, el panel y los controles de cada página, si la página está activa o no y una auditoría sobre quién fue el último usuario en realizar cambios.

Para Ejecutar el Informe de Páginas y Menús de la Capa de la Interfaz de Usuario¶

Navegue hasta Vinyl IDE
Haga clic en Crea tu aplicación en el menú Generar.
Ubique su aplicación desde el panel de Aplicaciones, en la capa UI
Haga clic en el icono de PDF debajo de Doc:
El Informe Crystal resultante incluye la información descrita anteriormente:

Informes de Lógica Empresarial¶

En la capa de lógica empresarial, hay dos nuevos informes disponibles. El informe Objetos y reglas por tabla enumera todos los objetos comerciales basados en tabla e incluye el estado. El informe Ejecución de eventos por tabla proporciona información sobre eventos intrínsecos y personalizados que se ejecutan en tablas de la aplicación.

Para Ejecutar el Informe de Objetos y Reglas por Tabla¶

Navegue hasta Vinyl IDE
Haga clic en Crea tu aplicación en el menú Generar.
Seleccione la Capa de lógica empresarial en el menú de navegación.
Ubique la fuente de datos de su capa empresarial. Por ejemplo: MySQL - Vientos del Norte
Haga clic en el ícono de PDF debajo de Doc:
El Informe Crystal resultante incluye la información descrita anteriormente:

Para Ejecutar el Informe de Ejecución de Eventos por Tabla¶

Navegue hasta Vinyl IDE
Haga clic en Crea tu aplicación en el menú Generar.
Seleccione la Capa de lógica empresarial en el menú de navegación.
Ubique la fuente de datos de su capa empresarial. Por ejemplo: MySQL - Vientos del Norte
Haga clic en el icono de lista numerada en Documento de ejecución:
El Informe Crystal resultante incluye la información descrita anteriormente:

Informe de Capa de Almacenamiento de Datos por Tabla¶

Existe un nuevo informe para el almacenamiento de datos, llamado Capa de almacenamiento de datos por tabla. Este informe le brinda información sobre el esquema básico de la base de datos, por tabla. La información del informe incluye: configuración de la tabla, restricciones clave, relaciones clave y columnas que existen para la tabla. La información de las columnas capturada en el informe incluye índice, nombre, tipo lógico, tipo de almacenamiento, uso, auditoría, generación automática y si la columna es obligatoria.

Para Ejecutar el Informe de Capa de Almacenamiento de Datos por Tabla¶

Navegue hasta Vinyl IDE
Haga clic en Crea tu aplicación en el menú Generar.
Seleccione la Capa de almacenamiento de datos en el menú de navegación.
Ubique la fuente de datos de su capa empresarial. Por ejemplo: MySQL - Vientos del Norte
Haga clic en el ícono de PDF debajo de Doc:
El Informe Crystal resultante incluye la información descrita anteriormente: