SIU-Guarani/Version3.11.0/personalizaciones/impresiones

De SIU
Revisión del 11:08 2 oct 2015 de Mchilczenko (discusión | contribuciones) (CASO 2: Personalizar un certificado existente)
Saltar a: navegación, buscar

Personalizar constancias y certificados

Guarani 3 realiza la impresión de comprobantes a partir de documentos PDF. Estos son generados a partir de JASPER, un motor de generación de reportes basado en JAVA soportado por SIU-Toba.

La personalización de constancias y certificados en Guarani 3 normalmente depende de lo que se quiera personalizar, aunque generalmente implica desarrollar una plantilla JASPER (.jasper) para la impresión del formato deseado del certificado. Para ser más específicos, vamos a dar ejemplos prácticos para personalizar y generar nuevos certificados en el sistema.

CASO 1: Agregar un nuevo certificado

Los pasos a seguir son:

  1. Desarrollar una plantilla JASPER en iReports para el certificado en cuestión. Para realizar esta tarea se recomienda tomar como partida alguna de las plantillas proporcionadas por el sistema y realizar todas las modificaciones deseadas. Tener en cuenta las siguientes cuestiones:
    • Guardar la constancia con un nombre diferente de los existentes en el directorio : $toba_dir/proyectos/guarani/personalizaciones/exportaciones/jasper
    • La constancia (plantilla JASPER) recibe como parámetros fijos siempre el logo (path) y el nro. de solicitud (registro de la tabla sga_constancias_solicitud). Este último se puede utilizar en una consulta de BD para obtener datos a mostrar en la constancia (ver constancias existentes). Recordar que además de los provistos, se pueden enviar mas parámetros que los anteriormente mencionados.
    • No hay restricción con ninguno de los objetos ni funcionalidades soportadas por la versión anteriormente mencionada de iReports (v5.6). Es importante utilizar ese editor y versión para el desarrollo del reporte, de lo contrario pueden ocurrir errores.
  2. Agregar la plantilla generada en el punto anterior al sistema a través de la operación "Administrar Plantillas". En el nombre del archivo no incluir el PATH.
    IMPORTANTE: Poner "Si" (valor por defecto) en el combo que indica si se permite asociar esta plantilla a una constancia para solicitud 'manual'. Como ejemplo, se recomienda analizar las constancias ya existentes en la instalación del sistema.
  3. Una Constancia o Certificado puede tener asociado un formulario donde se pidan mas datos de los que se le pasan por defecto (en caso de que sea necesario) o validaciones sobre las actividades académicas del alumno, etc. Para esto, se debe desarrollar un componente (CI) TOBA y agregar el código correspondiente. "Ver ANEXO A".
  4. Agregar la Constancia o Certificado nuevo asociándole la plantilla desarrollada y creada en el punto anterior en la operación "Administrar Constancias y Certificados" del sistema. Si se desarrollo un formulario especifico para este fin, asociarlo también mediante la operación mencionada.

CASO 2: Personalizar un certificado existente

Para dar un mayor detalle en esta tarea, a este caso lo vamos a dividir en 3 sub-casos.
IMPORTANTE: Si bien como el título de esta sección indica, la idea de realizar ésto es cambiar un certificado provisto por el sistema dándole otro formato o utilidad, para todos los casos especificados próximamente se recomienda en lugar de realizar los cambios sobre las plantillas enviadas, modificarlas desde el editor (iReport) pero grabarlas con otro nombre y agregarlas como una nueva plantilla del sistema a través de la opción "Administrar Plantillas". De esta forma se evitan conflictos con futuras versiones y actualizaciones del sistema que incluyan un cambio en las plantillas estándares.

Reemplazar la constancia o certificado provisto por el sistema por uno nuevo

Este proceso implica realizar algo similar a lo que se debe hacer cuando se desea agregar un certificado del sistema (se agrega una nueva plantilla pero en lugar de asociarla a un nuevo certificado, se la asocia a uno existente). Para esto, realizar los siguientes pasos:

  1. Realizar todos los pasos del "Caso 1" expuesto anteriormente (Agregar un nuevo certificado) a excepción del punto (4).
  2. En la operación "Administrar Constancias y Certificados" del sistema, ubicar la Constancia a remplazar y editarla eligiendo la nueva plantilla desarrollada en lugar de la que tiene asociada actualmente. ATENCION: Si la plantilla tiene un Formulario asociado, la nueva plantilla deberá tener como parámetros los que pase el formulario dinámicamente y envía a JASPER para la generación del PDF de la Constancia (lo mismo que lo señalado en el caso anterior).

Cambiar el logo o el texto de una constancia o certificado provisto por el sistema

Para cambiar el texto:
  1. Abrir la constancia que se desea modificar (archivo .jrxml desde iReport v5.6)
  2. Realizar las modificaciones correspondientes.
  3. Guardar la plantilla con otro nombre.
  4. Compilarla para generar el archivo .jasper que utiliza el sistema para la impresión de la constancia.
  5. Agregar la plantilla generada en el punto anterior al sistema a través de la operación "Administrar Plantillas". En el nombre del archivo no incluir el PATH.
    IMPORTANTE: Poner "Si" (valor por defecto) en el combo que indica si se permite asociar esta plantilla a una constancia para solicitud 'manual'. Como ejemplo, se recomienda analizar las constancias ya existentes en la instalación del sistema.
  6. En la operación "Administrar Constancias y Certificados" del sistema, ubicar la Constancia a remplazar y editarla eligiendo la nueva plantilla desarrollada en lugar de la que tiene asociada actualmente. ATENCION: Si la plantilla tiene un Formulario asociado, la nueva plantilla deberá tener como parámetros los que pase el formulario dinámicamente y envía a JASPER para la generación del PDF de la Constancia (lo mismo que lo señalado en el caso anterior).
Para cambiar el logo, hoy existen 3 formas de realizar esto:
  1. Realizar los mismos pasos enumerados anteriormente ("Para cambiar el texto") y elegir la imagen directamente desde la plantilla en lugar de utilizar el logo como parámetro. ATENCION: la imagen debe estar ubicada en un directorio donde apache tenga permisos para acceder.
  2. Agregar el archivo "logo_institucion.jpg" en el directorio: $toba_dir/proyectos/guarani/personalizacion/www/img/. #:ATENCION: Realizando esto la imagen sera adaptada al tamaño definido en la plantilla a modificar y ubicada en el lugar definido en la misma.
  3. Modificar el método personalizable: get_path_logo_impresion() de la clase "guarani" en el archivo "$toba_dir/proyectos/guarani/personalizacion/php/nucleo/_lib/guarani.php" indicándole el nombre del archivo que contiene la imagen. Este es el menos recomendado de los 3 puntos porque implica una redefinicion del código del sistema, además de contar con las mismas restricciones especificadas en el punto 2 (el tamaño y ubicación)

Agregar más datos a un certificado o constancia existente

Las constancias existentes, obtienen los datos a mostrar partir de consultas SQL. Para esto, si se desea obtener algún campo extra a mostrar en el reporte, se debe modificar la consulta editando el archivo .jrxml de la constancia deseada y agregando el campo a incluir en la misma. También se debe agregar como campo (Field) del reporte y luego incluirlo en la sección deseada del mismo. Si el dato que se desea agregar no fuera posible obtenerlo a partir de la consulta SQL, o se desea solicitar su valor al usuario, etc...se debe desarrollar un formulario y asociarlo a la constancia en cuestión. Para esto, ver el "Ver ANEXO A".
IMPORTANTE:

  • Recordar lo planteado al comienzo de esta sección: Si bien la idea de realizar esto es cambiar un certificado provisto por el sistema añadiendo nuevos campos, se recomienda en lugar de realizar los cambios sobre las plantillas enviadas, modificarlas desde el editor (iReport) pero grabarlas con otro nombre (por ej.: Constancia Alumno Regular - UNS) y agregarlas como una nueva plantilla del sistema a través de la opción "Administrar Plantillas". De esta forma se evitan conflictos con futuras versiones y actualizaciones del sistema que incluyan un cambio en las plantillas estándares. De hecho, si se desea, para limpiar el combo al asociar una plantilla a una constancia nueva o existente que utilice la plantilla recién creada en lugar de la original, se puede setear las constancia enviadas por el sistema y modificada por estas nuevas, como no habilitadas para la asociación a constancias que se permiten solicitarlas manualmente.
  • La constancia (plantilla JASPER) recibe como parámetros fijos siempre el logo (path) y el nro. de solicitud (registro de la tabla sga_constancias_solicitud). La idea seria realizar una consulta (o modificar la existente) obteniendo los datos a partir de cruzar las tablas pertinentes de la BD tomando como base el nro. de solicitud.
  • Una vez realizadas las modificaciones, recordar compilarla para generar el archivo .jasper que utiliza el sistema para la impresión de la constancia.