Introducción

Para facilitar el proceso de creación de una Entidad, el Control Panel cuenta con un asistente de creación que simplifica y guía al usuario durante el proceso.

El proceso de creación de una Entidad se dividide en tres pasos:

• Rellenar la información general.

• Definir el esquema.

• Configurar las opciones avanzadas.

La información proporcionada en los dos primeros pasos es obligatoria (es información genérica que define a la Entidad), siendo la tercera opcional.

Pasos

Crear la Entidad

Desde el Control Panel, navegaremos al menú de Desarrollo > Mis Entidades.

Open

Esto nos llevará al listado de Entidades disponibles. Para crear la Entidad, pulsaremos en el botón de «+» situado en la parte superior derecha de la pantalla.

Open

De las distintas Entidades que vamos a poder crear, seleccionaremos la de «Creación paso a paso»:

Rellenar la información general

Esto nos abrirá el asistente de creación de Entidades, en donde tendremos que introducir una información básica:

• Identificación: el nombre único con el que identificar a la Entidad.

• Meta-Información: etiquetas con las que caracterizar la Entidad, que servirán para su filtrado a la hora de hacer búsquedas.

• Descripción: texto descriptivo extendido de la Entidad, como su uso, propiedades, características, etc.

Además, contamos con algunas opciones más de caracterización de la Entidad:

• Entidad activa: para que la Entidad funcione o se encuentre bloqueada.

• Entidad pública: si queremos que la Entidad sea pública, o si la queremos privada.

• Permite campos cifrados: si interesa que algunos campos almacenen información sensible y estén cifrados (más información).

• Habilita ContextData: si se quiere que la Entidad registre internamente los cambios de escritura y gestión (más información).

• Soporta JSON-LD: si interesa que la Entidad pueda trabajar con contexto (más información).

• Habilitar el preprocesamiento de clases de datos: opción que permite que la Entidad registre internamente los cambios de escritura y gestión.

Una vez definida la información general y las opciones de la Entidad, pulsaremos en el botón de «Continuar» para acceder a la definición del esquema de la Entidad.

Definir el esquema de la Entidad

En este paso, se solicitará al usuario que seleccione una plantilla de esquema o que cree una desde cero.

En caso de que se quiera utilizar una plantilla predefinida, ésta se seleccionará del listado de plantillas categorizadas. En la parte derecha de la pantalla se mostrarán los diferentes campos que tendrá la Entidad, así como las propiedades de cada uno de ellos.

Esta plantilla se podrá modificar según se necesite, añadiendo, modificando o borrando campos, así como cambiando sus propiedades.

Para crear un esquema propio, se seleccionará la plantilla de «EmptyBase» localizada en la categoría de «General»:

En este caso, en la parte derecha de la pantalla aparecerá el gestor de campos de la Entidad vacío.

Para crear un nuevo campo en la Entidad, se pulsará en el botón de «+».

Aparecerá entonces en el listado un nuevo registro, en donde se tendrá que indicar las siguientes opciones:

• Propiedad: el nombre del campo. Dicho nombre no podrá contar con espacios.

• Tipo: en este selector se tendrá que escoger el tipo de dato que será el campo.

  Se diferencian los siguientes:

  • string: para campos de texto.

  • object: para almacenar objetos de tipo JavaScript.

  • number: para guardar números en general (incluidos decimales).

  • integer: para usar números enteros.

  • geometry-{{type}}: los campos de tipo geometry se utilizan para almacenar datos con componente espacial (coordenadas). Cada tipo de campo correspondiente con una de las diferentes geometrías soportadas en la Plataforma (más información).

  • file: este tipo se utiliza para almacenar datos binarios en un campo (más información).

  • date: para almacenar fechas en formato ISO 8601 (yyyy-MM-dd).

  • timestamp-mongo: para guardar marcas temporales en formato de MongoDB.

  • timestamp: como el anterior, pero en formato ISO 8601 (yyyy-MM-dd HH:mm:ss).

  • array: para almacenar listas de datos.

  • boolean: si el campo será de tipo lógico.

  • email: para guardar campos de tipo correo electrónico.

• Requerido: marcando esta opción hará que el campo tenga que introducirse obligatoriamente al añadir un dato en la Entidad.

• Encriptado: si se ha habilitado la opción de permitir campos encriptados, hará que la información del campo se enmascare (encripte).

• Clase de datos: si se han creado previamente, permiten asignar operaciones de tratamiento del dato, como convertir el contenido del campo de tipo texto a mayúsculas, convertir el valor según un dominio, etc. (más información).

• Valor por defecto: se podrá indicar el valor por defecto que tendrá el campo en caso de que el usuario no indique ningún otro valor.

• Valores enumerados: es posible introducir una serie de valores para que a la hora de rellenar este campo, se tenga un listado de opciones entre las que elegir (más información).

• Descripción: texto descriptivo para poder caracterizar el campo.

• Borrar: pulsando en el icono de la papelera se podrá eliminar la propiedad que se está creando.

Una vez escogida la plantilla de por defecto que se quiere utilizar, o creado los campos que se precisen, se pulsará en el botón de «Actualizar Esquema» para que los cambios se registren en el esquema de la entidad.

Nada más pulsar, se visualizará una pantalla de código con la estructura de la Entidad en formato JSON:

Una vez comprobada que la estructura es la correcta, se pulsará en el botón de «Generar Instancia» para ver un ejemplo de dato de la Entidad:

Hecho esto, se pulsará en el botón de «Continuar» para pasar al último paso de la creación de la Entidad.

Configurar las opciones avanzadas

En este último apartado se podrán configurar ciertas opciones avanzadas de la Entidad.

Entre las opciones disponibles, la primera corresponde con el borrado de datos:

• Borrar de la base de datos: esta opción permite el borrado automático de los datos almacenados en la Entidad a partir de un tiempo definido.

• Borrar Entidades creadas anteriores a: si se ha habilitado la opción anterior, en este selector se podrá escoger la cantidad de tiempo a partir del cual se irán borrando los datos de la Entidad.

Las siguientes opciones hacen referencia a tópicos de comunicación de las Entidades:

• Permite crear un tópico Kafka de ingesta para la Entidad (más información).

• Permite crear un tópico Kafka de notificaciones (más información).

• Permite crear un tópuco MQTT de ingesta para la Entidad (más información).

• Habilita notificaciones al BPM (más información).

Por último, se puede indicar el tipo de instancia de base de datos que utilizará la Entidad. Esta opción sólo se puede configurar ahora, durante la creación de la Entidad, por lo que una vez definido el tipo de instancia, no se podrá cambiar en el futuro.

Desde el selector, se podrá escoger el tipo de instancia que se necesite:

Configuradas estas opciones, se pulsará el botón de «Crear» para terminar con la creación de la Entidad.

Se mostrará entonces una ventana con las opciones disponibles a realizar con la Entidad creada.

Pulsando en el botón de «Close» se volverá al listado de Entidades, en donde aparecerá la Entidad recién creada.