Paquete de informes

Informes plantilla

Nombre	Usa el registro de actividad	Requiere parámetros	Descripción
JavaReportPattern.jrxml	No.	No.	Patrón de plantilla que usa Java para obtener los datos.
SQLReportPattern.jrxml	No.	No.	Patrón de plantilla que usa SQL para obtener los datos.
subreport-sample.rep	No.	No.	Ejemplo de subinforme. El soporte para subinformes está disponible a partir de la versión 8.1.15.

Autenticación

Nombre	Usa el registro de actividad	Requiere parámetros	Descripción
UsersLogin.rep	Sí.	Sí.	Inicios de sesión de usuarios, filtrados por rango de fechas.
UsersLogout.rep	Sí.	Sí.	Cierres de sesión de usuarios, filtrados por rango de fechas.
UsersSessionExpiration.rep	Sí.	Sí.	Usuarios cuyas sesiones expiraron, filtrados por rango de fechas.

Documentos

Nombre	Usa el registro de actividad	Requiere parámetros	Descripción
DocumentCanceledCheckout.rep	Sí.	Sí.	Lista los documentos para los que se canceló la edición, filtrados por rango de fechas.
DocumentCheckin.rep	Sí.	Sí.	Lista los documentos que se actualizaron, filtrados por rango de fechas.
DocumentCheckout.rep	Sí.	Sí.	Lista los documentos que se están editando, filtrados por rango de fechas.
DocumentCreate.rep	Sí.	Sí.	Lista los documentos que se crearon, filtrados por rango de fechas.
DocumentDelete.rep	Sí.	Sí.	Lista los documentos que se eliminaron, filtrados por rango de fechas.
DocumentGetChildren.rep	Sí.	Sí.	Muestra cuándo los usuarios listaron documentos en una carpeta o expediente. Los resultados se filtran por rango de fechas. Para listar documentos en una carpeta, se llama a un método interno llamado “getChildren”.
DocumentContent.rep	Sí.	Sí.	Muestra cuándo los usuarios recuperaron el contenido de un documento. Los resultados se filtran por rango de fechas. Por ejemplo, cuando un usuario descarga o previsualiza un documento (entre otras acciones), está recuperando el contenido del documento.
DocumentContentByVersion.rep	Sí.	Sí.	Muestra cuándo los usuarios recuperaron una versión concreta del contenido de un documento. Los resultados se filtran por rango de fechas.
DocumentGetProperties.rep	Sí.	Sí.	Muestra cuándo un usuario recuperó las propiedades de un documento. Los resultados se filtran por rango de fechas. Por ejemplo, cuando se selecciona un documento, se llama a un método interno llamado “getProperties” para rellenar el contenido de la pestaña de propiedades en la interfaz de usuario.
DocumentGetVersionHistory.rep	Sí.	Sí.	Se muestra cuando los usuarios recuperan la lista de todas las versiones de un documento. Los resultados se filtran por rango de fechas.
DocumentGetPropertyGroupProperties.rep	Sí.	Sí.	Muestra cuándo se han recuperado los campos de un grupo de metadatos. Por ejemplo, cuando se muestra un grupo de metadatos en la interfaz de usuario, se llama a un método interno llamado “getPropertyGroupProperties” para rellenar los valores del grupo de metadatos.
DocumentLock.rep	Sí.	Sí.	Lista los documentos que se actualizaron, filtrados por rango de fechas.
DocumentMove.rep	Sí.	Sí.	Lista los documentos que se movieron, filtrados por rango de fechas.
DocumentPurge.rep	Sí.	Sí.	Lista los documentos que se purgaron, filtrados por rango de fechas. Cuando se purga un documento, desaparece de forma permanente del repositorio de la aplicación.
DocumentRenamed.rep	Sí.	Sí.	Lista los documentos que se renombraron, filtrados por rango de fechas.
DocumentUnlock.rep	Sí.	Sí.	Lista los documentos que se desbloquearon, filtrados por rango de fechas.
DocumentsAccessibleByUserOrdered.jrxml	No.	No.	Recupera una lista de documentos disponibles (filtrados por seguridad) ordenados por nombre de carpeta. Optimizado para formato CSV. No recomendado para repositorios grandes; puede tardar mucho tiempo.
DuplicatedFiles-v-7.1.23.jrxml	No.	No.	Este informe solo se puede usar con la versión 7.1.23 o superior. Lista de ficheros duplicados en el repositorio de la aplicación, basada en el checksum del documento.
DuplicatedFiles.jrxml	No.	No.	Este informe solo se puede usar con la versión 7.1.22 o inferior. Lista de ficheros duplicados en el repositorio de la aplicación, basada en el checksum del documento.
ListDocumentsWithChecksum.rep	No.	Sí.	Lista de todos los documentos en algunas carpetas y subcarpetas con sus valores de checksum.

Carpetas

Nombre	Usa el registro de actividad	Requiere parámetros	Descripción
FolderCopy.rep	Sí.	Sí.	Lista las carpetas copiadas, filtradas por rango de fechas.
FolderCreate.rep	Sí.	Sí.	Lista las carpetas creadas, filtradas por rango de fechas.
FolderDelete.rep	Sí.	Sí.	Lista las carpetas eliminadas, filtradas por rango de fechas.
FolderGetChildren.rep	Sí.	Sí.	Muestra cuándo los usuarios listaron carpetas en una carpeta o expediente. Los resultados se filtran por rango de fechas. Para listar carpetas en una carpeta, se llama a un método interno llamado “getChildren”.
FolderGetContentInfo.rep	Sí.	Sí.	Se muestra cuando se ha ejecutado el método interno llamado “getContentInfo”. Para realizar algunas operaciones, es necesario calcular la profundidad de la carpeta, por ejemplo antes de iniciar una descarga ZIP de una carpeta. Hay un método interno llamado “getContentInfo” que lo hace.
FolderGetProperties.rep	Sí.	Sí.	Muestra cuándo un usuario recuperó las propiedades de una carpeta. Los resultados se filtran por rango de fechas. Por ejemplo, cuando se selecciona una carpeta, se llama a un método interno llamado “getProperties” para rellenar el contenido de la pestaña de propiedades en la interfaz de usuario.
FolderMove.rep	Sí.	Sí.	Lista las carpetas que se movieron, filtradas por rango de fechas.
FolderPurge.rep	Sí.	Sí.	Lista las carpetas que se purgaron, filtradas por rango de fechas. Cuando se purga una carpeta, desaparece de forma permanente del repositorio de la aplicación.
FolderRename.rep	Sí.	Sí.	Lista las carpetas que se renombraron, filtradas por rango de fechas.
FolderSecurity.rep	No.	Sí.	Lista las carpetas y subcarpetas mostrando la configuración de seguridad respecto a roles y/o usuarios.
FolderGetSize.rep	No.	Sí.	Lista las carpetas y subcarpetas mostrando el tamaño de cada una.

Correos

Nombre	Usa el registro de actividad	Requiere parámetros	Descripción
MailCreate.rep	Sí.	Sí.	Lista los correos que se crearon, filtrados por rango de fechas.
MailGetProperties.rep	Sí.	Sí.	Se muestra cuando un usuario recupera las propiedades de un correo. Los resultados se filtran por rango de fechas. Por ejemplo, cuando se selecciona un correo, se llama a un método interno llamado “getProperties” para rellenar el contenido de la pestaña de propiedades en la interfaz de usuario.
MailPurge.rep	Sí.	Sí.	Lista los correos que se purgaron, filtrados por rango de fechas. Cuando se purga un correo, desaparece de forma permanente del repositorio de la aplicación.
MailRename.rep	Sí.	Sí.	Lista los correos que se renombraron, filtrados por rango de fechas.
MailMove.rep	Sí.	Sí.	Lista los correos que se movieron, filtrados por rango de fechas.
MailCopy.rep	Sí.	Sí.	Lista los correos que se copiaron, filtrados por rango de fechas.
MailGetChildren.rep	Sí.	Sí.	Muestra cuándo los usuarios listaron correos en una carpeta o expediente. Los resultados se filtran por rango de fechas. Para listar correos en una carpeta, se llama a un método interno llamado “getChildren”.

Otros

Nombre	Usa el registro de actividad	Requiere parámetros	Descripción
TenantUserQuota.jrxml	No.	No.	Tamaño de los documentos (en MB) por usuario y tenant.
WorkflowWorkload.jrxml	No.	No.	Cada tarea de workflow y el tiempo dedicado a ella.
RegisteredUsers.jrxml	No.	No.	Usuarios registrados.

Subinformes

Restricciones:

El nombre del subinforme siempre debe empezar por “subreport-”, por ejemplo, subreport-roles.jrxml.
En el informe principal, debe crear un parámetro con el mismo nombre que el subinforme (sin la extensión). Por ejemplo, si el subinforme se llama subreport-roles.jrxml, el parámetro debe llamarse subreport-roles, y la clase asociada debe ser net.sf.jasperreports.engine.JasperReport.
La expresión en el subinforme debe corresponder al valor del parámetro creado. Siguiendo el ejemplo del punto anterior, debe ser $P{subreport-roles}.
Ambos informes deben compartir la misma conexión de base de datos.

Ejemplo de secciones XML

En el JRXML principal, defina el parámetro del subinforme:

<parameter name="subreport-roles" class="net.sf.jasperreports.engine.JasperReport"/>

Luego, en el elemento subreport, use la referencia al parámetro:

<subreport>
    <reportElement x="0" y="0" width="200" height="100"/>
    <subreportExpression><![CDATA[$P{subreport-roles}]]></subreportExpression>
</subreport>

Los puntos clave son:

El nombre del parámetro debe coincidir con el nombre de fichero sin la extensión usado en el REP (fichero ZIP).
El tipo de parámetro debe ser JasperReport.
Use $P{nombre-del-parámetro} en el subreportExpression.
Elimine cualquier referencia a rutas de fichero del subreportExpression.

Cómo funciona por dentro:

El núcleo de OpenKM carga el subinforme desde el REP (fichero ZIP).
Lo añade al mapa de parámetros con el nombre correcto.
JasperReports lo encuentra mediante la referencia al parámetro en lugar de una ruta de fichero.

Capturas de pantalla

Parámetro de subinforme

Expresión de subinforme

Sugerencias durante el desarrollo

La configuración dinámica de subinformes mediante parámetros funcionará una vez que el informe esté desplegado en OpenKM, pero no funcionará en la aplicación Jasper Studio. Por otro lado, configurar los subinformes con rutas del sistema de ficheros funcionará en Jasper Studio pero probablemente no funcionará en OpenKM (no recomendamos usar rutas).

Durante el desarrollo, probablemente querrá probar el informe desde la aplicación Jasper Studio antes de desplegarlo en producción. Por este motivo, recomendamos establecer la ruta del informe directamente (ruta del sistema de ficheros) durante esta fase de desarrollo, y una vez completada, modificarla para usar el acceso dinámico mediante el parámetro mencionado anteriormente.