Subdirección de las Tecnologías de la Información y Comunicaciones

Área de Gobernanza y Calidad

Esta página tiene como objetivo describir las recomendaciones a la hora de crear y enviar Informes en los servicios corporativos. En el caso de precisar plantilla, como en los informes en XML estructurado, también se incluyen recomendaciones para su creación.

Con ello se quiere garantizar que todos los informes generados por las departamentales sean visualizables correctamente desde cualquier visor de informes, independientemente de la tecnología o codificación de la departamental o del visor. Además, se pretende reducir los conflictos que pueda producir sobre otras aplicaciones, evitar problemas se seguridad o referencias a archivos inaccesibles.

Recomendaciones Informes XML

Contenido del Informe

El contenido del informe debe seguir la codificación UTF-8.

Escapar todos los caracteres especiales como entities 

Dado que los informes pueden estar codificados de distinto modo; para garantizar que sean visualizables todos los caracteres se recomienda que, antes de incluir el informe en el DOC_T12, se aplique un filtro/función para convertir los caracteres especiales en Entities.

Los Entities consisten en convertir los caracteres reservados por XML y los caracteres especiales a su nombre o número de entidad.

Por ejemplo: El carácter "<" es reservado por XML, se ha de escapar como "<" (por nombre) o "<" (por número). El carácter especial "ó" se puede escapar como "ó" o "ó". Estos "entities" son independientes de la codificación, son válidos para HTML y XML, y la mayoría de las tecnologías disponen de funciones para escapar un texto con entities><" es reservado por XML, se ha de escapar como "<" (por nombre) o "<" (por número).

El carácter especial "ó" se puede escapar como "ó" o "ó". Estos "entities" son independientes de la codificación, son válidos para HTML y XML, y la mayoría de las tecnologías disponen de funciones para escapar un texto con entities.

Contenido de la Plantilla XSLT

El contenido de la plantilla debe estar codificado en UTF-8.

Escapar todos los caracteres especiales como entities

Es muy recomendable que las plantillas proporcionadas para formatear los informes tengan los caracteres especiales escapados como entities.

Se puede dar el caso que el informe llegue en una codificación, la plantilla en otra y el sistema que las una trabaje con otra distinta. El resultado es que se puede dar problemas en la visualización de los caracteres, producido por alguno de estos puntos. El escapar la plantilla es un punto crítico para evitar este problema.

Más información en el subapartado con este mismo nombre anterior.

No usar comillas simples

Las plantillas se insertan en una BBDD, dado que las comillas simples son un carácter especial en SQL, su presencia puede dificultar el mantenimiento de dichas plantillas. Dado que XSLT soporta acotar cadenas con comillas simples (`) y dobles ("), se recomienda usar en las plantillas únicamente comillas dobles. 

No usar Javascript 

Se recomienda que no exista Javascript en el HTML resultante de aplicar la plantilla. En el caso de ser necesario su uso, se recomienda seguir las indicaciones del documento "SAS ¿ Recomendaciones Javascript para Informes". Indicado en documentos anexos.

No usar referencias a archivos externos excepto imágenes

No se permite importar archivos externos en el HTML resultante, tales como archivos CSS o Javascript.

Como excepción, las imágenes estáticas (cabecera, pie, iconos ¿) si están permitidas, pero se han de facilitar junto a la plantilla para poder ponerlas a disposición de las estaciones. Estas imágenes se han de referenciar con rutas relativas.

Recomendaciones Informes HTML

Este tipo de informes solo se permite publicarlo en casos excepcionales y tras una causa justificada. De forma general el formato en el que se deben publicar los informes es el anterior descrito.

El documento HTML devuelto debe estar codificado en UTF-8.

Escapar todos los caracteres especiales como entities

Se recomienda que los textos de los informes, dentro del HTML, estén escapados como entities para garatizar que se puedan visualizar en cualquier navegador o visor desde el que se requiera visualizar. 

Más información en subapartados con este mismo nombre anteriores.

No Usar Javascript

Se recomienda que el documento HTML, devuelto en la consulta de informe, no contenga Javascript. En el caso de ser necesario se recomienda seguir las indicaciones del documento SAS Recomendaciones Javascript para Informes.

No usar referencias a archivos externos excepto imágenes

No se permite referenciar archivos externos dentro del HTML, tales como archivos CSS o Javascript. Como excepción, las imágenes estáticas si están permitidas, pero se han de facilitar con antelación para poder ponerlas a disposición de las estaciones. Estas imágenes se han de referenciar con rutas relativas.