Esquemas XML del modelo de datos

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi desde aplicaciones externas > API de Bizagi para aplicaciones externas > Conceptos preliminares para utilizar el API de Bizagi >

Esquemas XML del modelo de datos

Introducción

En todo proyecto Bizagi es posible generar definiciones de esquema XML (XSDs) para una entidad.

Esta funcionalidad que genera esquemas XML o transformaciones es especialmente poderosa para propósitos de integración.

 

El esquema XML del modelo de datos describe la estructura que se maneja y se espera por los procesos en Bizagi (p.e cuando se invoca el API de Bizagi desde una aplicación externa).

De manera alternativa, estos esquemas (y archivos de transformación) también son útiles cuando se utilizan desde reglas de negocio para obtener información del modelo de datos en Bizagi o para actualizarla de vuelta.

 

A continuación se describen estas 2 opciones.

 

Generar XSD

La generación de esquemas XML del modelo de datos de Bizagi (cualquier entidad o modelo de datos de proceso) le servirá como referencia para conocer la estructura esperada del modelo de datos al momento de invocar el API de Bizagi.

 

Para generar un XSD siga los pasos que se describen a continuación:

 

1. En la vista de Experto, seleccione Entidades en el menú Bizagi y dé clic derecho en la entidad para la cual desea generar un esquema.

Observe que para utilizar la Capa SOA usted debería seleccionar una entidad de Aplicación en vez de una entidad Maestra.

Seleccionar Esquemas XML.

 

 

XMLSchemas01_EntitiesModule

 

 

2. En la ventana de esquemas XML de la entidad, dé clic en el botón Generar para abrir la ventana de Selección de Datos del Esquema.

 

 

EntitiesXmlSchemas_Image002

 

 

3. En esta ventana, seleccione toda la información que deba ser recuperada para insertar, actualizar o seleccionar.

Observe que es posible seleccionar información en entidades relacionadas utilizando la navegación de XPath, expandiendo los nodos asociados a las relaciones de entidad de nivel superior.

 

 

EntitiesXmlSchemas_Image003

 

4. Una vez finalizado, dé clic en OK.  El XSD generado se mostrará.

Este esquema representará la estructura del modelo de datos, tal como Bizagi lo espera, cuando se utilice la Capa SOA.

Por defecto, el nombre del XSD será el mismo de la entidad, pero se puede cambiar dando clic en el botón Editar (o doble clic en el XSD).

 

 

EntitiesXmlSchemas_Image004

 

 

 

Asociar XSL/XSLT

Los archivos de transformación (XSL/XSLT) pueden ser asociadas a esquemas (XSDs) para permitirle la posibilidad de interpretar los datos en Bizagi y obtenerlos bajo un formato diferente.

La asociación de XSLT a un esquema se utiliza mas que todo cuando se invocan servicios web desde Bizagi en reglas de negocio (aunque recuerde que la funcionalidad recomendada para hacerlo es mediante el conector de servicios web de Bizagi).

Bajo esta idea, las siguientes opciones son presentadas principalmente por compatibilidad hacia atrás.

 

note_pin

Para asociar una transformación usted debe generar un esquema previamente, y por lo tanto, partimos de los pasos descritos en la sección anterior: Generar un XSD.

Tenga en cuenta que el archivo de transformación necesita ser creado previamente y guardado en una carpeta local (crear un archivo de transformación XML estándar, que a su vez requiere de conocimiento técnico).

Para crear dicha transformación, existen herramientas de terceros que se especializan en la manipulación de archivos XML.

 

 

Para asociar una transformación existente, se deben llevar a cabo los siguientes pasos:

 

1. Después de generar un XSD, selecciónelo y dé clic en el botón Agregar.

 

EntitiesXmlSchemas_Image005

 

 

 

2. Una nueva ventana se abrirá para brinda la información básica. Ingrese un nombre y descripción.

Para la Dirección, seleccione "Entrada" o "Salida" dependiendo del uso de la transformación:

Salida: Si va a transformar información obtenida desde el modelo de datos de Bizagi, de manera que pueda ser enviada a otra aplicación o sistema.

Entrada: Si va a transformar información obtenida desde otro sistema, la cual serpa actualizada en Bizagi.

 

Luego, navegue en sus carpetas para seleccionar su archivo de transformación (dando clic en Seleccionar Archivo).

 

 

EntitiesXmlSchemas_Image006

 

3. Finalmente, dé clic en OK para guardar.

El archivo de transformación asociado se mostrará:

 

EntitiesXmlSchemas_Image007

 

 

 

Usar los XSDs y XSLTs generados

Como mencionamos anteriormente, los archivos de esquema XML son útiles para propósitos de integración, en los cuales una aplicación externa invocará el API de Bizagi.

De esta manera, usted podrá conocer cuál es la estructura XML esperada por Bizagi.

 

Nótese que aunque no es lo recomendado, los esquemas XML y sus transformaciones, también podrán ser utilizadas dentro de reglas de negocio.
Para mayor información sobre su uso desde reglas, consulte Métodos para interfaces.