Conceptos preliminares para utilizar el API de Bizagi

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Bizagi Studio > Bizagi desde aplicaciones externas > API de Bizagi para aplicaciones externas > Servicios web SOAP >

Conceptos preliminares para utilizar el API de Bizagi

Introducción

Bizagi presenta un API para que las aplicaciones externas puedan acceder la funcionalidad de los procesos y la información de negocio que se encuentra en el modelo de datos, como se describe en API de Bizagi para aplicaciones externas.

Aunque el API de Bizagi provee un conjunto representativo de servicios web SOAP los cuales ya vienen generados y publicados, considere los siguientes conceptos antes de utilizar dicho API.

 

note_pin

En este punto se espera (como requisito) que por lo menos cuente con un proceso ya modelado e implementado en su proyecto (con diagrama de flujo, modelo de datos, etc), de manera que pueda sacar provecho del API de Bizagi.

Aunque algunos métodos web no requieran estrictamente de un proceso, por lo menos utilizarán las definiciones y entidades de su modelo de datos.

 

Es igualmente importante que haya verificado y validado que su proceso se comporte como es esperado.

Esto se debe a que Bizagi maneja las transacciones de manera consistente a través de sus componentes, al momento de garantizar la integridad en la información. Esto significa que por ejemplo, Bizagi lanzará una excepción y hará rollback de una invocación de servicio web que active una siguiente actividad del flujo si esa actividad ejecuta una regla de negocio que falla.

 

Requisitos

Para comenzar a utilizar estos servicios web, asegúrese de habilitarlos para sus ambientes a través de Bizagi Studio.

 

Para hacerlo, ubique la opción de ambiente (Environment) bajo la pestaña de configuración (Configuration) en la cinta superior, y revise que alguna de las siguientes casillas esté marcada para habilitar uno de los servicios:

Servicios web legado: Enable legacy web services (asmx)

Servicios web con WS-Security: Enable WS-Security checkbox.

 

Considere que se recomienda enfáticamente habilitar la alternativa Enable WS-Security debido a su nivel superior de seguridad para la cual usted configuraría el uso de certificados.

De lo contrario, será su responsabilidad configurar las restricciones de acceso para estos servicios web, como se instruye en el capítulo de administración del sistema Bizagi, de acuerdo a su servidor de aplicaciones.

 

EnablingWS

 

Para información completa sobre este paso, consulte Habilitar el API de Bizagi.

 

Definiciones en el modelo de datos

El API de Bizagi maneja estructuras XML estándar para sus datos de entrada y de salida (http requests y responses).

Por lo tanto, considere estos 2 conceptos antes de empezar a utilizar dicho API.

 

1. Esquema XML del modelo de datos

Al enviar información de negocio a Bizagi (sea para crear nuevos casos, completar una actividad, o actualizar registros en el modelo de datos), usted deberá asegurarse que la información sea enviada bajo una estructura XML estándar que sea acorde a los conceptos Xpath de Bizagi del esquema XML de su modelo de datos.

 

EntitiesXmlSchemas_Image004

 

Para mayor información sobre cómo ver y entender la representación del modelo de datos de su proceso a manera de esquema XML, consulte Esquemas XML del modelo de datos.

 

2. Definición de llaves de negocio

Al igual que como en cualquier integración entre 2 aplicaciones, es una buena práctica apoyarse en códigos únicos para identificar registros (en vez de usar IDs internos del sistema).

Un código único representará la información que distingue de manera inequívoca a cada registro, y por ello, su uso permite asegurarse que Bizagi y su aplicación externa puedan intercambiar efectivamente la información de los registros, sobretodo cuando haya la necesidad de actualizar o referenciar alguno en particular.

 

En Bizagi, usted podrá pre definir los códigos únicos a través de las llaves de negocio.

Para cada entidad usted podrá especificar el atributo o conjunto de atributos que almacena la información que representa el código único (constraints de unicidad).

Incluso, al mantener una definición adecuada de llaves en negocio, Bizagi podrá validar y evitar que se creen registros duplicados.

 

BusinessKeys01

 

Para mayor información sobre el concepto de llaves de negocio en Bizagi, consulte Usando llaves de negocio en archivos XML.