Consideraciones y URL de la Capa SOA de Bizagi
De
<keywords content="keywords">http URL, Bizagi web services, servicios web de Bizagi, capa soa, integracion, integración, portal, SOA, asmx, ?wsdl, wsdl, capa de integracion, capa de integración </keywords>
Contenido |
Consideraciones y URL de la Capa SOA de Bizagi
Introducción
Cada proyecto en Bizagi cuenta con los servicios web (SOAP) ya disponibles y publicados para exponer la funcionalidad de los procesos para la integración con aplicaciones externas.
Estos servicios web de la Capa SOA de Bizagi se encuentran accesibles desde la aplicación misma pero su URL puede variar ligeramente de acuerdo al servidor utilizado para la aplicación web del proyecto.
Este artículo enumera este y otros detalles sobre consideraciones para la interoperabilidad de los servicios web, entre plataformas heterogéneas.
URL y consideraciones
Tenga en cuenta lo siguiente para la integración de Bizagi con sistemas y aplicaciones externas.
URL de la Capa SOA de Bizagi
Los servicios web de la Capa SOA de Bizagi se publican en la siguiente URL (http).
Para Bizagi Enterprise .Net y Bizagi Xpress
En los proyectos de Bizagi que utilizan el IIS de Microsoft (en soluciones .Net creadas en Bizagi Enterprise .Net o Bizagi Xpress), los servicios se ubican como:
http://[Server_name]/[Bizagi_project]/WebServices/[internal_component].asmx
Nótese que:
- [Server_name] es el nombre del servidor donde se encuentra el proyecto.
- [Bizagi_project] es el nombre del proyecto Bizagi (la aplicación web).
- [internal_component] es el nombre del componente interno de Bizagi. Existen 4 posibles servicios web: EntityManagerSOA, WorkflowEngineSOA, QuerySOA y RenderSOA.
Ejemplo:
http://localhost/CreditApplication/WebServices/EntityManagerSOA.asmx
Para Bizagi Enterprise JEE
En los proyectos de Bizagi Enterprise JEE, los servicios web de la Capa SOA se ubican como:
http://[Server_name]:[port_number]/Bizagi-war/WebServices/[internal_component].asmx
Nótese que:
- [Server_name] es el nombre del servidor donde se encuentra el proyecto.
- [port_number] es el número del puerto sobre el cual el servidor de aplicaciones JEE atiende las solicitudes.
- [internal_component] es el nombre del componente interno de Bizagi. Existen 4 posibles servicios web: EntityManagerSOA, WorkflowEngineSOA, QuerySOA y RenderSOA.
Ejemplo:
http://localhost:8080/Bizagi-war/WebServices/EntityManagerSOA?wsdl
Los métodos web de Bizagi
Los métodos de la Capa SOA de Bizagi disponibles son aquellos que reciben una cadena (String) con formato XML como parámetro de entrada. Estos métodos son iguales para todas las ediciones de Bizagi.
Esto quiere decir que en las ediciones Bizagi Enterprise JEE edition, Bizagi Enterprise .Net, t Bizagi Xpress, existen los métodos que terminan con "AsString" (por ejemplo: createCasesAsString, getEntitiesAsString, queryCasesAsString, performActivityAsString, saveEntityAsString, etc).
Adicional a esto, para los procesos de Bizagi en plataformas .Net (creados con Bizagi Enterprise .Net y Bizagi Xpress), la Capa SOA de Bizagi también ofrece los mismos métodos pero que reciban un documento XML como parámetro de entrada (tales como: createCases, getEntities, queryCases, performActivity, saveEntity, etc). Este parámetro de entrada es de tipo XMLDocument, el cual es nativo para .Net.
Usando CDATA
Al usar los métodos web de Bizagi, que reciben un string o un documento XML, se recomienda utilizar el elemento CDATA para las cadenas contenidas en la información enviada.
Esto aplica para todas las ediciones Bizagi, dado que garantiza que cualquier caracter especial de la notación XML se reciba correctamente como contenido por el servicio web, y obedece a las mejores prácticas al usar XMLs.
El siguiente ejemplo muestra el uso del elemento CDATA para la invocación del método getActivitiesAsString :
<![CDATA[<BizAgiWSParam><domain>domain</domain><userName>admon</userName><BizAgiWSParam>]]>
El siguiente ejemplo muestra el uso del elemento CDATA para la invocación del método getEntities :
<BizAgiWSParam><EntityData><EntityName>Customer</EntityName><Filters><![CDATA[ Active=1 ]]></Filters> </EntityData><BizAgiWSParam>
Usando clientes Java para un ambiente de .Net
Cuando se quiera utilizar un cliente en Java para consumir los servicios web de Bizagi, la URL que se referencia debe contener explícitamente la terminación ?wsdl.
Por ejemplo si los procesos de Bizagi se encuentran en IIS (es decir, en una plataforma de .Net con Bizagi Enterprise .Net o Bizagi Xpress), entonces los servicios web para estos procesos se publican como:
http://[Server_name]/[Bizagi_project]/webservices/WorkflowEngineSOA.asmx
Al utilizar un cliente Java para invocarlos, se debe referenciar explícitamente como:
http://[Server_name]/[Bizagi_project]/webservices/WorkflowEngineSOA.asmx?wsdl
Usando un nodo raíz
Al enviar información XML a Bizagi via servicios web; sea cuando se invoca un método de la capa SOA, o cuando se recibe información de respuesta de una invocación externa, el XML resultante y/o su transformación, debe considerar siempre el nodo raíz.
Esto nuevamente va de acuerdo a las mejores prácticas del uso de XML, en donde este tipo de archivos bien formados considera siempre un nodo raíz.
En Bizagi, es frecuente encontrar que se debe usar sea <Entities>, <BizAgiWSResponse>, o la entidad de aplicación como nodo raíz.
Usando fechas
Al enviar o usar fechas en los XML, se requiere y se recomienda utilizar el formato XML estándar (universal).
Este formato es:
YYYY-MM-DDTHH:mm:ss
Artículos Relacionados
- Vea mayor información sobre la Capa SOA de Bizagi.
- Vea información sobre la arquitectura de Bizagi.
<comments />