{% load static %}

Formato de datos

Los reportes de ReportBro aceptan los datos mediante un diccionario o un contexto (como una función vista). Cada parámetro del contexto, por lo tanto, se define con su nombre (dato irrepetible y que debe coincidir con el definido durante el diseño del reporte) y su información (un texto, número, fecha, imagen, lista simple de elementos o de objetos.) Los Objetos dentro de una lista se deben definir como un diccionario para que el Reporte puede reconocer sus atributos.

Modos de Exportación

export_report_by_code(template_code, data, extension="pdf", file="reporte"): Esta función permite que el programador pueda renderizar un reporte (en la base de datos) usando principalmente su código (de registro que siempre es único) y los datos pasados como contexto.

Parámetros

# Nombre Descripción
1 template_code

Código de uso del reporte que fue insertado en la base de datos.

2 data

Contexto pasado como un diccionario. Esta constituye la información que será renderizada en el reporte. Cada nombre de las variables del contexto debe coincidir con su equivalente en los parámetros definidos en el diseño de la plantilla del modelo.

3 extension

Parámetro que solo admite dos valores de entrada (pdf - xlsx). Por defecto siempre es pdf. Es el formato con el cual será exportado el reporte.

4 file

Nombre del fichero del reporte al ser exportado. Por defecto se establece como "reporte".

export_report_by_name(template_code, data, extension="pdf", file="reporte"): Esta función permite que el programador pueda renderizar un reporte (en la base de datos) usando principalmente su nombre (de registro que siempre será único) y los datos pasados como contexto.

Parámetros

# Nombre Descripción
1 template_name

Nombre del reporte que fue insertado en la base de datos.

2 data

Contexto pasado como un diccionario. Esta constituye la información que será renderizada en el reporte. Cada nombre de las variables del contexto debe coincidir con su equivalente en los parámetros definidos en el diseño de la plantilla del modelo.

3 extension

Parámetro que solo admite dos valores de entrada (pdf - xlsx). Por defecto siempre es pdf. Es el formato con el cual será exportado el reporte.

4 file

Nombre del fichero del reporte al ser exportado. Por defecto se establece como "reporte".

export_report_from_JSON(path_json, data, extension="pdf", file="reporte"): Esta función permite que el programador pueda renderizar un reporte exportado en un fichero JSON independiente usando su ruta específica y los datos pasados como contexto.

Parámetros

# Nombre Descripción
1 path_json

Ruta específica del archivo con formato JSON. (Este fichero se genera con la función de "Exportación" de esta app). Se puede usar su path relativo según la estructura del proyecto.

2 data

Contexto pasado como un diccionario. Esta constituye la información que será renderizada en el reporte. Cada nombre de las variables del contexto debe coincidir con su equivalente en los parámetros definidos en el diseño de la plantilla del modelo.

3 extension

Parámetro que solo admite dos valores de entrada (pdf - xlsx). Por defecto siempre es pdf. Es el formato con el cual será exportado el reporte.

4 file

Nombre del fichero del reporte al ser exportado. Por defecto se establece como "reporte".

Funciones de Formato

convert_list_to_dict(): Esta función auxiliar recibe como parámetro una Query realizada con un Model de base de datos y lo convierte en una lista o colección de diccionarios para ser utilizada por un reporte. Solo permite la conversión de aquellos campos simples.

to_dict(): Esta función auxiliar puede convertir cada instancia de un clase Model pasada como parámetro en un diccionario de clave-valor entendible por el reporte. Solo permite la conversión de aquellos campos simples.

convert_to_base64(path, format_image): Esta función puede ser utilizada para convertir una imagen cualquiera a formato base 64. Este formato es necesario para que la imagen se muestre sin problemas en el reporte.

Parámetros

# Nombre Descripción
1 path

Ruta específica de la imagen. Solo se puede usar su path relativo según la estructura del proyecto.

2 format_image

Formato de la imagen, solo soportable .png y .jpg