Informes XML (XMLReport)

El plugin utiliza archivos XML como plantillas para definir la estructura jerárquica del informe a imprimir. La estructura se compone de bandas (header, detail y footer) que van agrupadas en una etiqueta group con un atributo name obligatorio, y que debe ser único pues identifica al conjunto de datos. Por tanto una plantilla puede incluir distintos grupos que se imprimen de manera secuencial, permitiendo distintas configuraciones de datos dentro de un mismo informe.

Cada banda agrupa cada uno de los objetos que debe imprimir. Dichos objetos por similitud y para faciliatar el uso se denominan Column al igual que en las XMLViews, y de la misma manera incluyen un widget que identifica el tipo de objeto a imprimir y su configuración.

Las plantillas XML con sus informes personalizados se deben almacenar en la carpeta XMLView/Report de su plugin.

Estructura del XML Report

El elemento raíz del archivo XML será report y se deben incluir obligatoriamente una etiqueta config y al menos un group.

La etiqueta config debe contener obligatoriamente las etiquetas:

  • page: indica la configuración del formato de impresión.
    • type: Especifica el tipo/tamaño de la página. Por ejemplo A4 o Letter.
    • orientation: Especifica la orientación de la página. Básicamente vertical (portrait) o horizontal (landscape).
  • font: Indica la configuración de la fuente por defecto a la hora de imprimir etiquetas de texto.
    • type: Especifica el nombre de la fuente de texto. Por ejemplo Arial.
    • size: Especifica el tamaño de la fuente de texto. Por ejemplo 12.

Las etiquetas group, además de estar identificados por un atributo name puede contener las etiquetas de bandas:

  • header: Datos de la cabecera del grupo. Se imprime una vez al comenzar el grupo y en cada salto de página.
  • detail: Datos de cada uno de los registros del dataset asignado al grupo.
  • footer: Datos del pie del grupo. Se imprime al terminar cada página y al finalizar la impresión del grupo.

Cada banda debe incluir el atributo height para especificar el alto que utiliza. El ancho de la misma viene dado por el tipo de página indicado en la configuración del informe.

Los objetos a imprimir en cada banda van declarados en etiquetas column que establecen la posición y el tamaño:

  • column: Cada uno de los objetos que se imprimen.
    • posx: (Obligatorio) Establece la posición en el eje horizontal donde imprimir dentro de la banda.
    • posy: Establece la posición en el eje vertical donde imprimir dentro de la banda. Por defecto 1.
    • width: Establece el ancho del objeto a imprimir.
    • height: Establece el alto del objeto a imprimir.

Cada column debe incluir un widget que establece mediante el atributo type "que" se va a imprimir en el rectángulo establecido por el column. La lista de widgets disponibles son:

  • line: Dibuja una línea.
  • label: Dibuja un texto fijo si se estableve el atributo value o el contenido de un campo del dataset si se establece el atributo fieldname.
  • calculated: (sólo banda Footer) Dibuja un valor calculado en base a los registros procesados en la banda de detalle hasta el momento de dibujar el objeto. El cálculo a realizar se establece mediante el atributo operator y es obligatorio indicar el atributo fieldname para saber el campo del dataset sobre el que se realizará la operación o cálculo.

Ejemplo:

Aquí podemos ver el archivo de demostración incluido en el plugin.

<?xml version="1.0" encoding="UTF-8"?>
<report>
    <config>
        <page type="A4" orientation="portrait" />
        <font type="Arial" size="12" />
        <default group="main" alter="other" />
    </config>

    <group name="main">
        <header height="80">
            <column posx="20" posy="45" width="50" height="10">
                <widget
                    type="label" translate="true" bold="true" size="13"
                    value="code"
                />
            </column>

            <column posx="80" posy="45" width="350" height="10">
                <widget
                    type="label" translate="true" bold="true" size="13"
                    value="description"
                />
            </column>

            <column posx="380" posy="45" width="60" height="10">
                <widget
                    type="label" translate="true" bold="true" align="center" size="13"
                    value="date"
                />
            </column>

            <column posx="460" posy="45" width="80" height="10">
                <widget
                    type="label" translate="true" bold="true" align="right" size="13"
                    value="total"
                />
            </column>

            <column posx="10" posy="55" width="550" height="1"> <!-- TODO: No funciona el height de las lineas -->
                <widget type="line" />
            </column>
        </header>

        <detail height="20">
            <column posx="20" width="50" height="15">
                <widget
                    type="label" fieldname="id"
                />
            </column>
            <column posx="80" width="250" height="15">
                <widget
                    type="label" fieldname="name" italic="true"
                />
            </column>
            <column posx="380" width="60" height="15">
                <widget
                    type="label" fieldname="date" align="center"
                />
            </column>
            <column posx="460" width="80" height="15">
                <widget
                    type="label" fieldname="amount" align="right"
                />
            </column>
        </detail>

        <footer height="65">
            <column posx="10" posy="1" width="550" height="1">
                <widget type="line" />
            </column>

            <column posx="15" posy="30" width="60" height="15">
                <widget
                    type="label" align="right" translate="true" bold="true" size="13"
                    value="count"
                />
            </column>

            <column posx="75" posy="30" width="10" height="15">
                <widget
                    type="label" align="center" bold="true" size="13"
                    value=":"
                />
            </column>

            <column posx="85" posy="30" width="80" height="15">
                <widget
                    type="calculated" operator="count"
                    align="left" bold="true"
                    fieldname="code"
                />
            </column>

            <column posx="100" posy="30" width="60" height="15">
                <widget
                    type="label" align="right" translate="true" bold="true" size="13"
                    value="min"
                />
            </column>

            <column posx="160" posy="30" width="10" height="15">
                <widget
                    type="label" align="center" bold="true" size="13"
                    value=":"
                />
            </column>

            <column posx="170" posy="30" width="80" height="15">
                <widget
                    type="calculated" operator="min"
                    align="left" bold="true"
                    fieldname="amount"
                />
            </column>

            <column posx="250" posy="30" width="60" height="15">
                <widget
                    type="label" align="right" translate="true" bold="true" size="13"
                    value="max"
                />
            </column>

            <column posx="310" posy="30" width="10" height="15">
                <widget
                    type="label" align="center" bold="true" size="13"
                    value=":"
                />
            </column>

            <column posx="320" posy="30" width="80" height="15">
                <widget
                    type="calculated" operator="max"
                    align="left" bold="true"
                    fieldname="amount"
                />
            </column>

            <column posx="380" posy="30" width="60" height="15">
                <widget
                    type="label" align="right" translate="true" bold="true" size="13"
                    value="total"
                />
            </column>

            <column posx="445" posy="30" width="10" height="15">
                <widget
                    type="label" align="center" bold="true" size="13"
                    value=":"
                />
            </column>

            <column posx="460" posy="30" width="80" height="15">
                <widget
                    type="calculated" operator="sum"
                    align="right" bold="true"
                    fieldname="amount"
                />
            </column>
        </footer>
    </group>
</report>

Siguiente

Necesita identificarse para continuar con esta acción. Haga clic en iniciar sesión o cree una cuenta.

Iniciar sesión
PRO
yopli2000_5
yopli2000_5

España, 4 años, nivel 59

ExtendedReport
ExtendedReport

Este plugin habilita poder generar informes en PDF en base a un archivo XML donde se define la estructura del informe, al estilo de las XMLView de los...

Patrocinadores

FacturaScripts avanza más rápido gracias al apoyo financiero de los patrocinadores, que contribuyen a que podamos dedicar más tiempo al desarrollo, testeo y documentación. Usted también puede poner su granito de arena y convertirse en patrocinador ;-)

ORO
elurk_3992
ORO
manel_11440
ORO
alexis_8932
ORO
informatica_13304
ORO
aj.garciolo_346
PLATA
adelantia_311
PLATA
s3rtec_4534
PLATA
oscar_10546
PLATA
nsat.pedidos_1235
PLATA
contacto_14936
PLATA
interiberica_795
PLATA
josepmp_2501
PLATA
ivan.gadea_16600
BRONCE
rexmaris_12857
BRONCE
flecamas_12738
BRONCE
jlgonzalezdiaz_12316
BRONCE
dani.eus79_11629
PRO
neorazorx_1
PRO
jmoreno_2610
PRO
yopli2000_5
PRO
civernet_11724
PRO
daniel89fg_739
Patrocinar

Amplíe sus conocimientos con los cursos oficiales

Curso básico de programación

Con este curso aprenderá cómo crear un plugin sencillo para FacturaScripts 2021: añadir nuevas páginas, tablas y columnas. Para entender este curso no se necesita mucha experiencia en programación, le enseñaremos los básico para modelar problemas sencillos. ¿A quién va dirigido? A cualquier persona con unos conocimientos muy básicos de programación. ¿Qué incluye? 18 lecciones con 14 vídeos explicativos.

301 9,99 €
Sesiones de programación

Esta es una recopilación de vídeos y documentación de pequeños desarrollos sobre FacturaScripts y sus plugins. Perfecto para expandir tus conocimientos de programación. ¿A quién va dirigido? A personas que ya hayan superado el curso básico de programación y busquen ampliar sus conocimientos. ¿Qué incluye? 17 lecciones con 17 vídeos explicativos (más de 8 horas de vídeos) y el código fuente de los ejemplos. Novedades mensuales: Este curso se amplía cada mes con nuevas lecciones.

84 19,99 €
Cookies
Usamos cookies en nuestro sitio web para brindarte la experiencia más relevante recordando tus preferencias y visitas repetidas. Al hacer clic en "Aceptar", aceptas el uso de TODAS las cookies necesarias.

Copyright (c) 2013-2022 FacturaScripts

Soporte