Auditoría completa en Jitterbit App Builder

Descripción general

La función Auditoría completa del App Builder está activada de forma predeterminada para las fuentes de datos y tablas recién creadas. Auditoría completa es una función de auditoría añadida para complementar la función Auditoría ligera. La auditoría completa registra los cambios a nivel empresarial en sus datos y le permite visualizarlos. Cuando la auditoría completa está habilitada, se crea una tabla de registro de auditoría especial llamada App BuilderAuditLog en su fuente de datos. Los cambios se registran en la tabla de registro de auditoría de cualquier tabla con la auditoría completa habilitada.

De forma predeterminada, App Builder no limpia ni purga automáticamente los registros almacenados en la tabla de auditoría completa. Si desea cambiar este comportamiento, consulte la Configuración de auditoría función, que permite a un usuario administrador configurar un período de tiempo para conservar los datos, después del cual App Builder debe purgar los registros de auditoría más allá del período de tiempo definido.

Importante

Al botón Auditoría para ver los registros de auditoría solo se puede acceder desde los siguientes tipos de paneles:

• Formulario (Botón de auditoría en el marco del panel)
• Cuadrícula (ícono de auditoría cerca de los íconos de edición/eliminación)

Las reglas CRUD no capturan actualmente el valor anterior en la tabla de auditoría. Si la regla CRUD se ejecuta en la capa de negocio, la auditoría la capturará.

El App Builder puede generar un error al rellenar la línea base si encuentra campos que superen el valor Nvarchar(700) o una columna binaria. Como solución alternativa, puede eliminar manualmente los campos que superen el valor Nvarchar(700) o una columna binaria de la auditoría completa. En una versión posterior se abordará este problema.

Características

Cambios a nivel empresarial

La auditoría completa captura los cambios a nivel empresarial en las tablas habilitadas. Es decir, registrará cualquier evento de inserción, actualización o eliminación que pase por la capa empresarial de App Builder. Esto incluye:

• Ediciones desde la capa de aplicación
• Reglas de negocio CRUD

Modificaciones que no son compatibles:

• Reglas directas de CRUD
• Migraciones
• Manipulación directa de la base de datos
• Procedimientos almacenados

Resolución de lista

La auditoría completa intentará registrar los valores de búsqueda al realizar una edición desde la capa de interfaz de usuario mediante un control de tipo Lista. Por ejemplo, si tenemos una página de pedido que incluye un control de lista para seleccionar un producto, los valores de las columnas Clave y Título (p. ej., ProductID y ProductName) se registrarán en el registro de auditoría.

Resolución de clave externa

De forma similar a la resolución de listas, las tablas auditadas que contienen claves foráneas intentarán resolver sus valores. Las reglas de negocio CRUD no tienen controles de lista asociados (no se ejecutan a través de la interfaz de usuario), por lo que esta técnica permite que la auditoría completa continúe registrando los valores de título resueltos. Supongamos que tenemos dos tablas con las siguientes columnas:

Tabla de pedidos

• OrderID
• ProductID (Clave externa de la tabla de productos)

Tabla de productos

• ProductID
• Name (Uso de la columna Título)

La auditoría completa reconocerá la clave externa en la tabla Pedido al registrar las modificaciones en Order.ProductID e incluirá el valor "Nombre" de la columna Título en el registro.

Promoción del medio ambiente

Para habilitar la Auditoría completa, es necesario configurar la Fuente de datos (y las aplicaciones relacionadas) en el ambiente de Desarrollo y promoverla hacia arriba. Actualmente, App Builder no permite configurar la Auditoría arriba en la cadena (por ejemplo, en Control de calidad o Producción, pero no en Desarrollo).

Aunque la propia tabla de auditoría se creará en ambientes arriba en la cadena, ninguno de los datos del registro de auditoría se transferirá.

Población de referencia

App Builder permite al diseñador rellenar una línea base de todas las tablas con Auditoría completa habilitada en el Registro de Auditoría. Esto debe hacerse manualmente en cada ambiente. El rellenado de la línea base puede ejecutarse varias veces; solo se rellenarán los registros sin registro de auditoría previo.

App Builder incluye una auditoría completa

La mayoría de las tablas de App Builder tienen habilitada la auditoría completa. Esto permite a los desarrolladores ver los registros de auditoría de elementos como páginas, tablas, columnas, controles, servidores de notificaciones, etc.

Para configurar una auditoría completa en una aplicación de App Builder

La siguiente sección describe cómo configurar la Auditoría completa. Esta función está activada de forma predeterminada para las fuentes de datos y tablas recién creadas.

Para habilitar la auditoría completa de una fuente de datos

1. Vaya a App Workbench > haga clic en el botón Fuentes de datos.
2. Seleccione la Fuente de datos que desea configurar.
3. Haga clic en el botón Habilitar auditoría.
4. Haga clic en Continuar.

Para configurar opciones de auditoría completas para una fuente de datos

Para configurar las opciones de Auditoría completa para su fuente de datos:

1. Vaya a App Workbench > haga clic en el ficha Fuentes de datos
2. Seleccione la Fuente de datos que desea configurar
3. Haga clic en el botón Auditar configuración
4. Realice los cambios necesarios y haga clic en Guardar

Habilitar auditoría completa para una tabla

La auditoría completa está habilitada de forma predeterminada en las tablas de las fuentes de datos que la tienen habilitada. A continuación, se indican los pasos necesarios. Tras habilitar la auditoría completa en una fuente de datos, todas las tablas la tendrán habilitada de forma predeterminada. App Builder inserta un AppBuilder AuditRefId Columna a todas las tablas para acomodar los datos de auditoría.

Si es necesario, puede deshabilitar la Auditoría completa para tablas individuales que no deban auditarse. Para deshabilitar la Auditoría completa en una tabla, haga clic manualmente en el botón Deshabilitar Auditoría completa a nivel de tabla. Además, es posible que deba eliminar la AppBuilder AuditRefID Columna para cualquier tabla que no tenga una clave principal UUID de una sola parte. Es recomendable revisar y depurar las reglas de migración para evitar la creación y eliminación de... AppBuilder AuditRefID columna.

Clave principal UUID de una sola parte

Para una tabla con una clave principal UUID de una sola parte, habilitar la Auditoría completa es simple:

1. Vaya a App Workbench
2. Haga clic en el ficha Tablas
3. Localice la tabla en la que desea habilitar la auditoría completa y haga clic en el ícono de edición con forma de lápiz.
4. Desde el panel Tabla, haga clic en Más > Caso extremo > Habilitar auditoría completa

Si desea deshabilitar la auditoría completa en una tabla, siga las instrucciones anteriores hasta el Paso 3, haga clic en Caso extremo y luego haga clic en el botón Deshabilitar auditoría completa.

Otras configuraciones de clave principal

Las tablas que no tienen una clave principal UUID de una sola parte requieren un poco más de trabajo para habilitar la Auditoría completa. Dado que la Auditoría completa requiere un UUID único por registro de tabla, tendremos que agregar y completar una nueva columna. Esta nueva columna usará Audit Tipo de uso de la columna.

1. Vaya a App Workbench
2. Localice la tabla en la que desea habilitar la auditoría completa en Tablas
3. Haga clic en el icono de edición de la tabla (con forma de lápiz)

4. Haga clic en + Columna en el panel Columnas para agregar una nueva columna con las siguientes propiedades:

   1. Tipo: UUID.
   2. Permitir valores nulos: True
   3. Autogeneración: True
   4. Nombre: AuditID(Puedes usar el nombre que prefieras)

5. Crea una nueva Regla de Migración para rellenar la columna con tus registros existentes.

   1. Propósito: Migration
   2. Acción: Update
   3. Seleccione y oriente la tabla anterior.
   4. Use la función MVSQL NewUUID() como valor para la columna AuditID

6. Ejecute la regla de migración

7. Regrese a los detalles de la columna y configure lo siguiente:

   1. Permitir valores nulos: False
   2. Columna Uso Tipo: Audit

8. Navegue a la tabla y haga clic en Más > Caso Extremo > Habilitar Auditoría Completa y Continuar. App Builder muestra un mensaje de éxito al completar la tarea.

Habilitar auditoría completa en una página

Para que los usuarios puedan ver los registros de auditoría completos, el panel de la página debe habilitar el Enlace de auditoría:

1. Navegue hasta la página en la que desea habilitar la visualización de Auditoría completa
2. Vaya al Cajón de acciones > Diseñador en vivo
3. Seleccione el panel desde Diseño del panel de página
4. Desde la región Edición en vivo a la derecha, haga clic en la pestaña Integrado
5. Marque para habilitar Mostrar auditoría
6. Regrese a la vista de la aplicación, actualice el navegador web y confirme que ve los resultados esperados.

Seguridad

Para acceder al registro de Auditoría Completa el usuario deberá:

• Pertenecer al menos a uno de los siguientes roles:

  • App Builder - rol de administrador
  • App Builder - rol de auditoría

• Tener acceso de lectura al objeto de datos vinculado en el panel de página

• Tener acceso de lectura a la fila en sí

Población de la línea base

La auditoría completa permite rellenar una línea base para todos los registros de las tablas auditadas. Esto creará registros de auditoría con Populate Como nombre de operación para todos los registros existentes en la tabla auditada. Los registros de auditoría ya existentes para un registro no se duplicarán (por lo que es seguro ejecutar esto varias veces si es necesario).

1. Vaya a Action Drawer > IDE > Additional Settings
2. Haga clic en el botón Rellenar registros de auditoría
3. Localiza la fuente de datos de tu aplicación
4. Haga clic en el botón Rellenar todo en la fuente de datos o en Rellenar en tablas individuales
5. Haga clic en Continuar, esto iniciará una tarea en segundo plano que se ejecutará