Descripción

Esta funcionalidad permite crear gadgets que ofrecen la funcionalidad CRUD (Create, Read, Update y Delete) sobre una Entidad sin tener que programar nada. La funcionalidad permite crear, editar, borrar y buscar elementos además de la exportación del listado a CSV.

Este gadget se ha construido como Gadget Template (sobre Vue y lib Elements) y nos sirve como interfaz de usuario para facilitar la vista, búsqueda y modificación de la información de las entidades de plataforma desde un dashboard.

Configuraciones del template disponibles

Tiene pre configuradas tres tipos de vista en función del valor que se le asigne al parámetro typeGadget.

Estas vistas están diseñadas para el tipo de uso al que está destinado:

• typeGadget : ‘withWizard’ Mostrará el wizard completo como en la imagen superior para poder realizar búsquedas en la entidad definiendo clausulas para el where, order by un máximo de valores y un offset. Este tipo está más encaminado al uso por parte de un rol tipo administrador, el cual tenga conocimientos técnicos para saber que es un where, etc.

• typeGadget : ‘searchOnly’ Mostrará el wizard parcialmente para poder realizar búsquedas en la entidad definiendo únicamente clausulas para el where este tipo está más encaminado al uso por parte de un rol usuario el cual necesite precisar filtros en las consultas a los datos.

• typeGadget : ‘noWizard’ con esta opción no se muestra el wizard. En este caso el template está encaminado al uso de un usuario final, facilitándole una herramienta sencilla para poder manipular y consultar datos de sus entidades.

• hideIdColumn : Además se puede indicar en los parámetros de la plantilla si preferimos que se muestre la columna con los ids o no.

hideIdColumn: false, // show or hide id column

Elementos del template

Selector de entidad, sobre la que van a realizarse las operaciones CRUD.

Interruptor que muestra u oculta el wizard.

Wizard para realizar consultas sobre los registros de la entidad.

Formulario para añadir elementos al where en la consulta.

Formulario para añadir elementos a la ordenación de la consulta.

Buscador para los registros de la tabla.

Botón que permite descargar los registros en formato csv o json, da la opción de descargar todos los registros de la entidad o sólo los seleccionados si se ha hecho una búsqueda previa desde el wizard.

Ejemplo descarga en csv.

Ejemplo descarga en json.

Botón para ocultar o mostrar columnas de la tabla.

Botón para crear nuevos registros.

Cada registro en la tabla cuenta con tres botones el primero para mostrar la información del registro en un formulario,

el segundo para editar dicho registro,

y el tercero para eliminar el registro de forma permanente.

La tabla cuenta con paginación para hacer más sencillo su uso,

pudiendo seleccionarse el total de registros a mostrar por página.

Internacionalización

La plantilla está internacionalizada con el estandar i18n implantado en la plataforma. Existe un registro en Manage Internationalizations donde está la internacionalización en ingles y castellano. Esta aplica a los elementos de la plantilla como botones, selectores,… y a las cabeceras de las columnas y formularios.

Entidad por parámetro

El gadget permite definir un parametro por url para tomarlo como entidad inicial. Con esto, se consigue que no se pueda seleccionar otra entidad desde que se accede al dashboard.

¿Cómo añadirlo a nuestros dashboards?

En primer lugar se creará un dashboard utilizando la configuración inicial y la internacionalización que se provee desde esta versión de la plataforma para estos gadgets.

En la pantalla de edición de dashboards pulsaremos el icono:

Y arrastraremos el elemento Custom gadget sobre nuestro dashboard:

Seleccionaremos el tipo de gadget que queremos añadir:

Pulsaremos sobre new gadget:

Al gadget custom le asignaremos un identificador y una descripción para poder localizarlo y usarlo en otras ocasiones.

Al estar parametrizado en esta pantalla podemos seleccionar las opciones explicadas anteriormente como si queremos que sólo acceda a una entidad, el tipo de wizard a mostrar o mostrar o no la columna de ids.

Tras pulsar OK aparecerá el gadget en el dashboard

Una vez creado, para reutilizarlo, tan sólo tenemos que seleccionar el tipo y la instancia recien creada del gadget custom y pulsar ADD GADGET