Objetivo

El objetivo de esta funcionalidad es soportar dentro de Onesait Platform el desarrollo de aplicaciones web con un enfoque no code. 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 la Plataforma o en las aplicaciones Vue de ODS (Onesait Design System).

Para construir esta funcionalidad nos hemos basado en 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 Onesait Platform permitiendo manejar de forma muy sencilla las Entidades de la 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 del Formulario.

  

• 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á el Formulario.

  

• 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 de «Layout» para dar la estructura que se tiene diseñada y luego ir arrastrando los distintos elementos como campos de texto, de selección, etc.

• 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 🛈, mostrarán un tooltip, que sirve de guía a los usuarios para saber el funcionamiento de cada campo.

Finalmente presionando el botón «Crear» 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, existe el botón «Usar Plantilla», 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 «Mostrar» (icono del ojo) 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».

• En el campo «Datasource», el nombre del Datasource. En este caso sería «catalogo».

• En el campo «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 la Plataforma en una función JavaScript predefinida que permite las operaciones project, filters, group, sort, offset, limit y 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» y en el campo «Data Source Type» seleccionar el valor «Custom», entonces aparece el campo «Custom Values», el cual debes rellenar con esta función:

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 Formularios se basan en la tecnología open source Form.io, que es una librería JavaScript que incluye un Form Builder para la creación de Formularios.

Incluye también un renderizador y un SDK que permite renderizar los Formularios de esquema JSON producidos por Form.io dentro de su aplicación utilizando JavaScript plano, así como proporciona un SDK de interfaz para comunicarse con las API de Form.io.

Además se incluyen numerosos ejemplos y documentación sobre su uso.