foxreports

Generador de reportes en VFP para uso general desde cualquier app

OBJETIVO

La idea general es poder ofrecer la potencia, versatilidad y facilidad de uso del generador de reportes de VFP a cualquier otra aplicacion capaz de utilizar ActiveX o ejecutar programas externos.

FUNCIONAMIENTO GENERAL

La solucion estaria compuesta de un EXE principal llamado FOXREPORTS.EXE el cual sera capaz de ejecutar distintas acciones segun los parametros pasados al invocarlo:

Comando	Accion
foxreports	Mostrar la UI principal para administracion de reportes
foxreports version	Mostrar la version actual de FoxReports
foxreports run reporte [-p=parametros] [-print] [-printer=impresora]	Ejecutar el reporte indicado en el parametro "reporte"
foxreports edit reporte	Crear/modificar un reporte con el nombre indicado en el parametro "reporte"
foxreports export reporte -pdf destino.pdf	Exportar el reporte "reporte" en formato PDF y almacenarlo en el archivo "destino.pdf"
foxreports export reporte -ds destino.dbf	Exportar la fuente de datos del reporte "reporte" en el archivo "destino.dbf"
foxreports config	Mostrar el dialogo de configuracion general de foxreports
foxreports set config value	Cambiar el valor de una configuracion especifica de foxreports
foxreports connection add -id=id -p=parametros	Define o actualiza una conexion de datos

COMPOSICION DE UN REPORTE

Todo reporte definido estaria compuesto de 3 archivos:

• reporte.frx
• reporte.frt
• reporte.cfg

Los archivos FRX y FRT almacenarian el formato del reporte, mientras que el archivo CFG almacenaria la configuracion del mismos. Este archivo CFG seria un archivo XML con la siguiente estructura:

<?xml version="1.0">
<report id="" dstype="">
    <title></title>
    <description></description>
    <datasource connId="">
      <query></query>
    </datasource>
</report

El parametro ''dstype'' determina el tipo de fuente de datos a utilizar:

dstype	descripcion
sql	Query SQL sobre datos remotos
fox	Base de datos fox

Por ejemplo:

foxreports connection add -id=mybd -p="c:\datos\datos.dbc"

<?xml version="1.0">
<report name="clientes" dstype="fox" caption="Clientes">
    <datasource id="mybd">
      <query>
        SELECT 0
        USE clientes ORDER BY xcodigo
      </query>
    </datasource>
</report


foxreports connection add -id=mybdsql -p=Driver={SQL Server};server=10.0.0.1;uid=ruser;pwd=ruser;dbname=datos;

<?xml version="1.0">
<report name="clientes" dstype="sql" caption="Clientes">
    <datasource id="mybdsql">
      <query>
        SELECT codigo,nombre,estatus
          FROM clientes
         ORDER BY codigo
      </query>
    </datasource>
</report    

PARAMETROS

Un reporte puede recibir uno o mas parametros para su operacion. Estos parametros serian pasados de dos formas posibles:

foxreports run mireporte -p=param="value"&param=value
foxreports run mireporte -pf=archivo.txt

archivo.txt
param="value"
param=value
param={value}

El valor de estos parametros estaran disponible en forma de variables al momento de ejecutar el reporte, y pueden ser usados directamente en el formato en al procesar la fuente de datos:

foxreports run clientes -p=status="ACTIVO"

<?xml version="1.0">
<report name="clientes" dstype="sql" caption="Clientes">
    <datasource id="mybdsql">
      <query>
        SELECT codigo,nombre,estatus
          FROM clientes
         WHERE status = ?status
         ORDER BY codigo
      </query>
    </datasource>
</report    

SALIDA DEL REPORTE

Por omision, el resultado de foxreports run sera una ventana con la previsualizacion del reporte y un toolbar para imprimir, exportar, guardar, etc. Si se desea enviar a imprimir el reporte directamente, se puede usar el parametro -print:

foxreports run reporte -print

En este caso el reporte sera enviado directamente a la impresora por omision sin mostrar ningun tipo de interfaz visual. Tambien sera posible enviar el reporte a una impresora especifica, usando el parametro -printer:

foxreports run reporte -print -printer=Nombre de la impresora

INTERFAZ ACTIVEX

Ademas de la interfaz de via de comando, foxreports tambien podria ser manejado usando una clase ActiveX en lenguajes que asi lo permitan. Para esto, foxreports expondria las siguientes clases:

clase	proposito
foxreports.engine	Clase principal de foxreports. La mayoria de los metodos estarian expuestos aqui
foxreports.report	Representa a un reporte
foxreports.connection	Representa una conexion de datos
foxReports.options	Opciones para ejecutar o exportar reportes

foxreports.engine

Seria la clase principal, encargada de registrar y procesar reportes

miembro	descripcion
version	Version actual de FoxReports
reports[]	Coleccion de reportes definidos
connections[]	Coleccion de conexiones definidas
lasterror]Descripcion del ultimo error ocurrido
object get(id)	Devuelve los datos de un reporte
bool run(id[,options])	Ejecuta un reporte dado (sin parametros)
bool run(report)	Ejecuta el reporte indicado
bool export(id[,options])	Exporta un reporte dado

foxreports.report

Define los datos de un reporte definido:

miembro	descripcion
id	ID interno del reporte
description	Descripcion del reporte
Title	Titulo del reporte
connId	ID de conexion a utilizar
parameters[]	Parameteros del reporte
datasource	Fuente de datos del reporte 1
options	Opciones del reporte
```void setParameter(param,value)	Establecer el valor de un parametro

foxreports.connection

Define los datos de una conexion de datos reutiliable:

miembro	descripcion
id	Id de la conexion
description	Descripcion de la conexion
type	sql, fox
connstr	Cadena de conexion 2
bool test()	Probar la conexion

foxreports.options

Opciones a utilizar en los metodos RUN y EXPORT:

miembro	descripcion
format	Formato de exportacion (PDF o DS)
print	Indica si el reporte sera enviado directamente a la impresora
printer	Indica el nombre de la impresora a utilizar
pages	Paginas a imprimir
filter	Filtro a aplicar a los datos a imprimir

El parametro pages puede contener los siguientes valores:

pages	resultado
all	Imprimir todas las paginas
n	Imprimir la pagina n
n,m	Imprimir las paginas n y m
n-m	Imprimir desde la pagina n a la pagina m

EJEMPLO DE USO DE LA INTERFFAZ ACTIVEX (CON C#)

// EJECUTAR UN REPORTE SIN PARAMETROS CON INTERFAZ VISUAL
public void runReporteClientes() {
    foxreports.engine foxreports = new foxreports.engine();
    foxreports.options options = new foxreports.options();
    bool result = foxreports.run("clientes",options);
}

// EJECUTAR UN REPORTE CON PARAMETROS E IMPRIMIR AUTOMATICAMENTE
public void runReporteClientes(string status) {
    foxreports.engine foxreports = new foxreports.engine();
    foxreports.report clientes = foxreports.getReport("clientes");
    clientes.setParameter("status",status);
    clientes.options.print = true;
    bool result = foxreports.run(clientes);
}    

Footnotes

1. Para conexiones SQL debe ser el SELECT a ejecutar; para conexiones FOX es un script a ejecutar, que puede ser un SELECT INTO CURSOR o una serie de comandos USE y SET RELATION TO. ↩

2. Para conexiones SQL debe ser "Drver={driver ODBC};parametros". Para conexiones con DBF debe ser c:\ruta\carpeta\contenedor.dbc o c:\ruta\carpeta ↩