Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Objetivo

El objetivo de esta funcionalidad es soportar dentro de Onesait Platform el desarrollo de aplicaciones Web con un enfoque NoCode. Así, desde el Control Panel podrás crear formularios, asignarles Entidades (y datasources) y hacer navegación entre formularios.

Estos formularios podrán integrarse en tu aplicación Web, sea cual sea la tecnología UI que uses, por ejemplo en los dashboards de Plataforma o en las aplicaciones Vue de ODS.

Para construir esta funcionalidad nos hemos basado en http://Form.io que es una librería JavaScript que incluye un Builder y un Renderer, y la hemos extendido e integrado con las capacidades de plataforma permitiendo manejar de forma muy sencilla las Entidades de plataforma y sus DataSources

Funcionalidad principal

Listado de OP Forms

En el menú del Control Panel se ha añadido una nueva entrada:

Ésta da acceso al listado de formularios:

Desde este listado se tiene acceso a las siguientes opciones:

  • Búsqueda de formulario: A partir de la lupa se pueden realizar búsquedas en el listado.

  • Creación de formulario: Este botón permite acceder a la pantalla de creación.

  • Vista: Este botón da acceso a la pantalla de carga de datos y vista del formulario.

  • Edición: Este acceso a la pantalla de edición del formulario.

  • Borrado: con este se borrará.

  • Clonado: Este botón permite clonar un formulario.

Creación de un OP Form

Tras acceder con el botón de creación desde el listado, aparece la pantalla de creación de formularios

Se pueden ir siguiendo los consejos para elaborar el formulario.

Los pasos necesarios serían:

  • Dar un nombre al formulario.

  • Seleccionar la entidad en la que se almacenarán los registros creados a partir del formulario.

  • Arrastrar desde el panel izquierdo de componentes al lienzo los elementos necesarios para componer el formulario. Lo ideal es primero arrastrar componentes del layout para dar la estructura que se tiene diseñada y luego ir arrastrando los distintos elementos como campos de texto, de selección, ….

  • Mientras se van arrastrando los distintos elementos se muestra una ventana modal. Ésta por ejemplo es la del campo texto.

Tiene dos secciones, la izquierda para la configuración y la derecha la previsualización. Todo se realiza mediante drag and drop y rellenando las propiedades de los componentes. Al pasar el cursor sobre los símbolos con interrogación, mostrarán un tooltip, que sirve de guía a los usuarios para saber el funcionamiento de cada campo.

Finalmente presionando el botón CREATE se creará un nuevo formulario.

Generación de formulario para una entidad

Tanto en la pantalla de creación de formulario como de edición de formulario existe el botón Build form from entity, el cual tras seleccionar una entidad generará los campos del tipo pertinente en el formulario para cada campo de la entidad.

Por ejemplo para la entidad HelsinkiPopulation cuyos campos son todos de tipo number, éste sería el resultado:

Éste sería uno de los campos:

Carga de datos

Desde el listado al pulsar en el botón VIEW de alguno de los formularios se accede a la pantalla de visualización y carga de datos.

En ésta se aprecia en primer lugar el formulario vacío y espacio con consejos para el usuario y enlaces a documentación para dar facilidades de uso.

El formulario podrá rellenarse desde esta pantalla y enviarse para registrar los datos en la entidad definida para el formulario.

Navegación entre formularios

A los botones se les pueden asignar distintas acciones en la pestaña Display, una de ellas es la del envío del formulario submit.

Para seguir con las prácticas no code de la plataforma, se han mejorado los botones de los formularios añadiendo el campo Redirect, el cual, tras realizarse el envío con éxito de los datos del formulario, cargará en la página actual la url que se indica en este campo.

Este campo se puede escribir de dos formas una la url completa host + path como https://<instancia onesaitplatform.com>/path o sólo el path como /path, esta última en caso de que estemos trabajando en una aplicación en la que tengas definida la variable "appbase".

Carga de datos en un combo (SELECT)

Existen muchas formas de cargar los datos en el componente SELECT pero la más sencilla es usando los datasources de Onesait Platform.

Para esto en primer lugar se crea el datasource. Éstos son consultas sobre una o varias entidades.

Luego en el formulario se arrastraría el SELECT y aparece la ventana con la configuración:

Se accede a la pestaña "Data" y:

  • En el campo "Data Source Type" se selecciona el valor "Datasource".

  • Campo "Datasource", el name del datasource en este caso sería catalogo.

  • "Value Property", el valor de cada opción del selector, debe coincidir con el path de los elementos que devuelve el datasource por ejemplo:

Si los elementos devueltos por el datasource tienen esta forma:

{catalogo:{nombre:"indef001",descripcion:"contrato indefinido"}}

para usar como valor nombre se rellenaría con catalogo.nombre

En “item Template” se rellena la descripción. Al igual que antes, se debe poner el path completo, para la descripción se pondría por ejemplo de la forma más básica:
<span>{{ item.catalogo.descripcion }}</span>

  • Finalmente en la pestaña "API" se rellenará "Property Name" con el path de la propiedad de la entidad donde se almacenará la selección realizada.

Carga de datos en un SELECT para usuarios expertos

Para el caso de usuarios más expertos se pueden utilizar los datasources de Plataforma en una función JavaScript predefinida que permite las operaciones project, filters, group, sort, offset, limit, param. Con esto se permite, sin modificar el datasource, obtener los datos de la forma deseada proyectando los campos, ordenándolos, …

Esto se consigue accediendo a la pestaña Data en el Campo Data Source Type seleccionar el valor Custom, entonces aparece el campo Custom Values el cual debes rellenar con esta funcion:

from('catalogo').exec().then(function( msg ) {
    values =  msg.map((x) => x.catalogo) ;  
    instance.setItems(values);
  });

Donde 'catalogo' sería el nombre del datasource que se pretende utilizar para obtener los datos.

El restos de campos como en la carga básica anterior.

Tips para los usuarios

Tanto la pantalla de creación como de vista tienen un espacio donde se muestran consejos para que sea más sencillo elaborar los formularios a los usuarios.

Internacionalización

Es posible de forma sencilla internacionalizar los formularios. Para esto hay que seleccionar una internacionalización previamente definida.

Estas internacionalizaciones se definen desde esta entrada del menú.

Tecnología base

Los OP Forms se basan en la tecnología open-source Formio.js que es una librería Javascript que incluye un Form Builder para la creación de formularios

Y un renderizador y un SDK que permite renderizar los formularios de esquema JSON producidos por http://Form.io dentro de su aplicación utilizando JavaScript plano, así como proporciona un SDK de interfaz para comunicarse con las API de http://Form.io.

Además se incluyen numerosos ejemplos: https://formio.github.io/formio.js/app/examples/ y documentación sobre su uso: https://help.form.io/developers/form-development/form-renderer

  • No labels