Informes Autodocumentados¶

Descripción General¶

App Builder tiene funciones de autodocumentación en forma de informes. Áreas específicas de App Builder dispone de informes que, cuando se ejecutan, enumeran y describen la 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 App Builder:Documento API por Extremo, Notas de Lanzamiento por aplicación, Informes de auditoría por App Builder capa (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 una API, hay un nuevo informe Documento de API por Extremo disponible que enumera todas las claves de API y los usuarios, así como las conexiones externas (enumera las URLs utilizadas para conectarse a sistemas externos), incluidos los extremos de notificación y los extremos de REST. La documentación incluida en este informe también genera ejemplos de llamadas de API y CURL de muestra en un formato que puede usar para copiar y 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 App Builder 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 ícono PDF debajo de Doc:
La información resultante del Informe Crystal incluye la información descrita anteriormente, así como una lista de operaciones admitidas:

Notas de la Versión por Aplicación¶

Cuando se genera un Release en App Builder hay un nuevo icono de documento que genera un informe de 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 avanza en el Generador de plantillas de versión.

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

Navegue hasta App Builder IDE
Haga clic en Desplegar su aplicación en el menú Generar
Después de haber configurado su paquete de lanzamiento utilizando la plantilla de Release Builder, haga clic en el ícono PDF debajo de Doc:
El informe Crystal Report resultante incluye la información descrita anteriormente:

Informes de Auditoría por App Builder capas: UI, Lógica Empresarial y Capas de Almacenamiento de Datos.¶

Hay nuevos informes de auditoría disponibles para todas las capas de App Builder– Capa de interfaz de usuario, capa de lógica empresarial y capa de almacenamiento de datos. Además, los roles y los informes de puente recibieron una actualización de la interfaz de usuario para que coincidan con los demás. App Builder capas y apariencia consistente.

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

Existe un nuevo informe de menús y páginas de la capa de interfaz de usuario para proporcionar un informe imprimible de la configuración de la aplicación en la capa de 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 que realizó cambios.

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

Navegue hasta App Builder IDE
Haz clic en Crear tu aplicación en el menú Crear
Busca tu aplicación en el panel Aplicaciones, en la capa de interfaz de usuario
Haz clic en el ícono PDF debajo de Doc:
El informe Crystal Report 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 empresariales por tabla e incluye el estado. El informe Ejecución de eventos por tabla proporciona información sobre los eventos intrínsecos y personalizados que se ejecutan en las tablas de la aplicación.

Para Ejecutar los Objetos y Reglas por Informe de Tabla¶

Navegue hasta App Builder IDE
Haga clic en Construir su aplicación en el menú Construir
Seleccione la Capa de lógica empresarial en el menú de navegación
Localice la fuente de datos de su capa empresarial. Por ejemplo: MySQL - Northwinds
Haga clic en el ícono PDF debajo de Doc:
El informe Crystal Report resultante incluye la información descrita anteriormente:

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

Navegue hasta App Builder IDE
Haga clic en Construir su aplicación en el menú Construir
Seleccione la Capa de lógica empresarial en el menú de navegación
Localice la fuente de datos de su capa empresarial. Por ejemplo: MySQL - Northwinds
Haga clic en el ícono de lista numerada debajo de Documento de ejecución:
El informe Crystal Report resultante incluye la información descrita anteriormente:

Informe de Capas de Almacenamiento de Datos por Tabla¶

Existe un nuevo informe para el almacenamiento de datos, denominado Capa de almacenamiento de datos por tabla. Este informe proporciona 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 de clave, relaciones de clave y columnas que existen para la tabla. La información de las columnas capturadas 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 la Capa de Almacenamiento de Datos por Tabla¶

Navegue hasta App Builder IDE
Haga clic en Construir su aplicación en el menú Construir
Seleccione la Capa de almacenamiento de datos en el menú de navegación
Localice la fuente de datos de su capa empresarial. Por ejemplo: MySQL - Northwinds
Haga clic en el ícono PDF debajo de Doc:
El informe Crystal Report resultante incluye la información descrita anteriormente: