Ver código fuente

<keywords content="keywords">
capa SOA, SOA, capa, metodos de la capa SOA, metodos SOA, workflowenginesoa, entitymanagersoa
</keywords>&nbsp; 

= Capa SOA de Bizagi  =

== Introducción  ==

La capa SOA de Bizagi es una respuesta a uno de los requerimientos de evolución de Bizagi:&nbsp;que las operaciones fundamentales del producto puedan ser integradas con otras aplicaciones (sistemas core, mainframes, sistemas de reporte, CRM, etc.) ofreciendo así una integración B2B que cumple los principios de SOA. 

<br>A través de ella, aplicaciones y sistemas externos pueden invocar la funcionalidad completa de los procesos en Bizagi, bajo el estándar de servicios SOAP para la interoperabilidad entre plataformas heterogéneas. 

<br>

== Modelo de datos de Bizagi  ==

Para usar la Capa SOA de Bizagi, es útil previamente consultar sobre cómo representa Bizagi el modelo de datos del proyecto en una estructura XML. 

De esta manera, en cualquier método web que se desee invocar de Bizagi, podrá enviar la información desde su sistema externo de una manera consistente a cómo Bizagi la espera. 

La opción de Bizagi de [[Entidades Esquemas Xml|<u>Generar esquemas XML</u>]] permite visualizar la estructura XSD de cualquier entidad o del modelo de datos del proceso. 

<br>

Adicional a lo anterior, tenga en cuenta que al enviar o actualizar información a Bizagi, puede usar la [[Llaves_de_Negocio_Predefinidas|<u>definición de llaves de negocio</u>]] para registros existentes.


== Servicios web de la Capa SOA Bizagi  ==

Algunas de las características que permiten los servicios web expuestos por la Capa SOA de Bizagi son:<br>

[[Image:Bulletrojo.gif]] Acceder al administrador de entidades de Bizagi: 

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[[Image:Bulletazul.gif]] Consultar las instancias de las entidades Bizagi.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[[Image:Bulletazul.gif]] Añadir o modificar las instancias de las entidades&nbsp;Bizagi. 

[[Image:Bulletrojo.gif]] Acceder al motor de flujo de trabajo (workflow) para: 

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[[Image:Bulletazul.gif]] Crear nuevos casos de negocio.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 

[[Image:Bulletazul.gif]] Avanzar actividades de negocio.<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 

[[Image:Bulletazul.gif]] Ejecutar eventos. 

Adicionalmente, los servicios relacionados con el administrador de entidades pueden ser invocados por reglas de negocio, lo cual incrementa las oportunidades de modelamiento; adaptándose&nbsp;a las necesidades específicas de cada implementación.<br>

<br>

=== Métodos para manipular el administrador de entidades  ===

El Servicio Web '''EntityManagerSOA.asmx''' ofrece los siguientes métodos: 

[[Image:Bulletazul.gif]] [[GetCaseDataUsingSchema|<u>getCaseDataUsingSchema</u>]]: Obtiene toda la información del caso. Los parámetros de este método son el idCase y un&nbsp;XSD con formato XmlDocument. 

[[Image:Bulletazul.gif]]&nbsp;[[GetCaseDataUsingSchema|<u>getCaseDataUsingSchemaAsString</u>]]: Obtiene toda la información del caso. Los parámetros de este método son el idCase y un XSD&nbsp;con formato string XML. 

[[Image:Bulletazul.gif]] [[GetCaseDataUsingSchema|<u>getCaseDataUsingSchemaLite</u>]]: Obtiene toda la información del caso. Los parámetros de este método son el idCase y un XSD con formato XmlDocument. La respuesta a este método no incluye el contenido de los atributos tipo of archiv. 

[[Image:Bulletazul.gif]] [[GetCaseDataUsingSchema|<u>getCaseDataUsingSchemaLiteAsString</u>]]: Obtiene toda la información del caso. Los parámetros de este método son el idCase y un XSD con formato string XML. La respuesta a este método no incluye el contenido de los atributos tipo of archivo. 

[[Image:Bulletazul.gif]]&nbsp;[[GetCaseDataUsingXPaths|<u>getCaseDataUsingXPaths</u>]]: Obtiene toda la información del caso. El parámetro de este método es un XmlDocument con los XPaths de Bizagi deseados. 

[[Image:Bulletazul.gif]]&nbsp;[[GetCaseDataUsingXPaths|<u>getCaseDataUsingXPathsAsString</u>]]: Obtiene toda la información del caso. El parámetro de este método es un String Xml con los XPaths de Bizagi deseados. 

[[Image:Bulletazul.gif]] [[GetEntities|<u>getEntities</u>]]: Obtiene la información de una entidad en formato XmlDocument. 

[[Image:Bulletazul.gif]] [[GetEntities|<u>getEntitiesAsString</u>]]: Obtiene la información de una entidad en formato string XML. 

[[Image:Bulletazul.gif]] [[GetEntitiesUsingSchema|<u>getEntitiesUsingSchema</u>]]: Obtiene información de una entidad (or entidades), especificando la información requerida en un XSD, en formato XmlDocument. 

[[Image:Bulletazul.gif]] [[GetEntitiesUsingSchema|<u>getEntitiesUsingSchemaAsString</u>]]: Obtiene la Información de una entidad (o entidades), especificando la información requerida en un XSD, en formato string XML. 

[[Image:Bulletazul.gif]] [[GetEntitySchema|<u>getEntitySchema</u>]]: Extrae el esquema de una entidad en un XmlDocument usando el nombre de la entidad. 

[[Image:Bulletazul.gif]] [[GetEntitySchema|<u>getEntitySchemaStr</u>]]: Extrae el esquema de una entidad en un string Xml usando el nombre de la entidad. 

[[Image:Bulletazul.gif]] [[SaveEntity|<u>saveEntity</u>]]: Este metodo se utiliza para almacenar y actualizar información en Bizagi usando un documento Xml (XmlDocument). 

[[Image:Bulletazul.gif]] [[SaveEntity|<u>saveEntityAsString</u>]]: Este metodo se utiliza para almacenar y actualizar información en Bizagi usando un string Xml. 

<br>

=== Métodos para manipular el motor de flujo de trabajo  ===

El Servicio Web '''WorkflowEngineSOA.asmx''' ofrece los siguientes métodos: 

[[Image:Bulletazul.gif]] [[AbortCases|<u>abortCases</u>]]: Cancela uno o mas casos basado en el número de caso recibido en un XML con formato XmlDocument. 

[[Image:Bulletazul.gif]] [[AbortCases|<u>abortCasesAsString</u>]]: Cancela uno o mas casos basado en el número de caso recibido en un XML con formato string. 

[[Image:Bulletazul.gif]] [[CreateCases|<u>createCases</u>]]: Crea uno o mas casos de un proceso Bizagi. Es posible crear un caso vacío o con información requerida por el caso. Este método envía y recibe un XmlDocument. 

[[Image:Bulletazul.gif]] [[CreateCases|<u>createCasesAsString</u>]]: Crea uno o mas casos de un proceso Bizagi. Es posible crear un caso vacío o con información requerida por el caso. Este método envía y recibe un string XML. 

[[Image:Bulletazul.gif]] [[GetActivities|<u>getActivities</u>]]: Puede ser usada para obtener un listado de todas las actividades sin completar (pendientes, suspendidas o inactivas). Envía y recibe un XmlDocument. 

[[Image:Bulletazul.gif]] [[GetActivities|<u>getActivitiesAsString</u>]]: Puede ser usada para obtener un listado de todas las actividades sin completar (pendientes, suspendidas o inactivas). Envía y recibe un string XML. 

[[Image:Bulletazul.gif]] [[GetApplications|<u>getApplications</u>]]: Obtiene todas las aplicaciones disponibles en Bizagi; no tiene parámetros de entrada. 

[[Image:Bulletazul.gif]] [[GetCases|<u>getCases</u>]]: Obtiene información de los casos basado en algunos filtros incluidos en un XmlDocument, la respuesta también tiene este mimo tipo de dato. 

[[Image:Bulletazul.gif]] [[GetCases|<u>getCasesAsString</u>]]: Obtiene información de los casos basado en algunos filtros incluidos en un XmlDocument con formato string, la respuesta también tiene este mimo tipo de dato. 

[[Image:Bulletazul.gif]] [[GetCategories|<u>getCategories</u>]]: Retorna las categorías dentro de una aplicación dada. Envía y recibe un XML con formato XmlDocument. 

[[Image:Bulletazul.gif]] [[GetCategories|<u>getCategoriesAsString</u>]]: Retorna las categorías dentro de una aplicación dada. Envía y recibe un XML con formato string. 

[[Image:Bulletazul.gif]] [[GetCategoriesFromApplicationName|<u>getCategoriesFromApplicationName</u>]]: Retorna las categorías dentro de una aplicación dada.&nbsp;Este método envía un&nbsp;string y recibe un XML con formato XmlDocument. 

[[Image:Bulletazul.gif]] [[GetClosedActivities|<u>getClosedActivities</u>]]: Obtiene un listado de todas las actividades completadas. El XML de envío y recepción se encuentra en formato XmlDocument. 

[[Image:Bulletazul.gif]] [[GetClosedActivities|<u>getClosedActivitiesAsString</u>]]: Obtiene un listado de todas las actividades completadas. El XML de envío y recepción se encuentra en formato string XML. 

[[Image:Bulletazul.gif]] [[GetEvents|<u>getEvents</u>]]: Retorna todos los eventos intermedios disponibles en un proceso, usando XMLs con formato XmlDocument. 

[[Image:Bulletazul.gif]] [[GetEvents|<u>getEventsAsString</u>]]: Retorna todos los eventos intermedios disponibles en un proceso, usando XMLs con formato string. 

[[Image:Bulletazul.gif]] [[GetWorkflowClasses|<u>getWorkflowClasses</u>]]: Obtiene información acerca de los procesos dentro de una categoría. Este método envía y recibe un XmlDocument. 

[[Image:Bulletazul.gif]] [[GetWorkflowClasses|<u>getWorkflowClassesAsString</u>]]: Obtiene información acerca de los procesos dentro de una categoría. Este método envía y recibe un string XML. 

[[Image:Bulletazul.gif]] [[GetWorkflowClassesFromCategoryName|<u>getWorkflowClassesFromCategoryName</u>]]: Este método retorna los procesos dentro de una categoría dada. Este método envía un string y recibe un XML con formato XmlDocument. 

[[Image:Bulletazul.gif]]&nbsp;[[PerformActivity|<u>perfomActivity</u>]]: Este método se utiliza para avanzar o continuar una actividad manual (como si se presionara el botón siguiente). Los parámetros de entrada y salida para este método son del tipo XmlDocument. 

[[Image:Bulletazul.gif]]&nbsp;[[PerformActivity|<u>perfomActivityAsString</u>]]: Este método se utiliza para avanzar o continuar una actividad manual (como si se presionara el botón siguiente). Los parámetros de entrada y salida para este método son del tipo string XML. 

[[Image:Bulletazul.gif]]&nbsp;[[Resume Cases|<u>resumeCases</u>]]: Cuando uno o varios casos han sido suspendidos, este método se usa para continuarlos. Envía y recibe un XML con formato XmlDocument. 

[[Image:Bulletazul.gif]]&nbsp;[[Resume Cases|<u>resumeCasesAsString</u>]]: Cuando uno o varios casos han sido suspendidos, este método se usa para continuarlos. Envía y recibe un XML con formato string. 

[[Image:Bulletazul.gif]]&nbsp;[[SaveActivity|<u>saveActivity</u>]]: Este método se usa para simular el evento salvar o guardar en actividades manuales. Envía y recibe un XmlDocument. 

[[Image:Bulletazul.gif]]&nbsp;[[SaveActivity|<u>saveActivityAsString</u>]]: Este método se usa para simular el evento salvar o guardar en actividades manuales. Envía y recibe un string XML. 

[[Image:Bulletazul.gif]]&nbsp;[[SetEvent|<u>setEvent</u>]]: Use este método para avanzar un evento intermedio, usando XMLs con formato XmlDocument. 

[[Image:Bulletazul.gif]]&nbsp;[[SetEvent|<u>setEventAsString</u>]]: Use este método para avanzar un evento intermedio, usando XMLs con formato string. 

[[Image:Bulletazul.gif]]&nbsp;[[SuspendCases|<u>suspendCases</u>]]: Pone un caso en espera de tal forma que el estado de la tarea (on time, expires today and overdue) no se ve afectado. Este método envía y recibe un XmlDocument. 

[[Image:Bulletazul.gif]]&nbsp;[[SuspendCases|<u>suspendCasesAsString</u>]]: Pone un caso en espera de tal forma que el estado de la tarea (on time, expires today and overdue) no se ve afectado. Este método envía y recibe un string XML. 

[[Image:Bulletazul.gif]] [[AssignActivity|<u>assignActivity</u>]]: Asigna/reasigna la actividad de un caso a un usuario específico. Este método envía y recibe un XmlDocument. 

[[Image:Bulletazul.gif]] [[AssignActivity|<u>assignActivityAsString</u>]]: Asigna/reasigna la actividad de un caso a un usuario específico. Este método envía y recibe un string con formato XML. 


=== Métodos para Manejar la Metadata de las Formas  ===

El servicio web '''RenderSOA.asmx''' ofrece los siguientes métodos: 

[[Image:Bulletazul.gif]] [[GetActivityForm|<u>GetActivityForm</u>]]: Retorna las formas de una actividad o evento (pendiente) en un caso. 

[[Image:Bulletazul.gif]] [[GetFormById|<u>GetFormById</u>]]: Obtiene una forma particular dado su número de identificación. 

[[Image:Bulletazul.gif]] [[GetQueryForms|<u>GetQueryForms</u>]]: Este método se usa para obtener las formas de [[Reportes o Consultas|Consulta]] asociadas a un proceso. 

[[Image:Bulletazul.gif]] [[GetSummaryForms|<u>GetSummaryForms</u>]]: Con este método es posible obtener la [[Formas Globales de Resumen y Asistentes#Formas_de_Resumen|Forma de Resúmen]] de un caso. 

<br>

=== Métodos para Ejecutar las formas de consulta Bizagi  ===

El servicio web '''QuerySOA.asmx''' ofrece los siguiente métodos: 

[[Image:Bulletazul.gif]] [[QueryCases|<u>QueryCases</u>]]: Ejecuta una búsqueda usando una forma de consulta de aplicación para obtener información de casos. Este método envía y recibe un documento XML (XmlDocument). 

[[Image:Bulletazul.gif]] [[QueryCases|<u>QueryCasesAsString</u>]]: Ejecuta una búsqueda usando una forma de consulta de aplicación para obtener información de casos. Este método envía y recibe una cadena con formato XML (string). 

[[Image:Bulletazul.gif]] [[QueryEntities|<u>QueryEntities</u>]]: Ejecuta una búsqueda usando una forma de consulta de entidad para obtener información al nivel de dicha entidad. Este método envía y recibe un documento XML (XmlDocument). 

[[Image:Bulletazul.gif]] [[QueryEntities|<u>QueryEntitiesAsString</u>]]: Ejecuta una búsqueda usando una forma de consulta de entidad para obtener información al nivel de dicha entidad. Este método envía y recibe una cadena con formato XML (string). 

<br><br>
<div align="center">
{| class="MsoNormalTableNota" border="1" cellspacing="0" cellpadding="0" width="600"
|-
| valign="top" width="100%" | 
<span>'''Nota:''' Los métodos Obsoletos son funcionalidades que ya no debe utilizase pero que permanecen únicamente para compatibilidad con versiones anteriores. </span>

|}
</div>
<br>

<br>

== Usando los Métodos de la Capa SOA de Bizagi  ==

Cada aplicación web en Bizagi contiene publicados los servicios web mencionados previamente. 

Vea mayor información sobre la ubicación de la [[Consideraciones y URL de la Capa SOA de Bizagi|<u>URL de estos servicios y consideraciones adicionales para el uso de la Capa SOA de Bizagi</u>]]. 

<br>

<br>

=== Ejemplo en .Net  ===

En un ambiente .NET estas URLs se usan para crear Referencias Weba los servicios web. 

<br>

[[Image:Integration SOA1 Image003.jpg|center]] 

<br>

Por lo tanto, se puede escribir un código similar al que se encuentra a continuación para consumir cualquiera de los servicios web(este ejemplo invoca el método getEntities): 
<pre>//An object reference to the web service EntityManagerSOA is created
EntityManagerSOA.EntityManagerSOA emSOA = new EntityManagerSOA.EntityManagerSOA();

//An XmlDocument object that will contain the XML is created as input
XmlDocument xDoc = new XmlDocument();
xDoc.Load(@"D:\SOA\Inputs\GetEntityRequest.xml");

//The method getEntities of the SOA layer is invoked
XmlNode node = emSOA.getEntities(xDoc);

//Operations are performed to save the results to disk
XmlDocument resp = new XmlDocument();
resp.LoadXml(node.OuterXml);
resp.Save(@"D:\SOA\Outputs\GetEntitiesOutput.xml");
</pre>
A continuación encontrará el mismo ejemplo pero para el método getEntitiesAsString: 
<pre>//An object reference to the web service EntityManagerSOA is created
EntityManagerSOA.EntityManagerSOA emSOA = new EntityManagerSOA.EntityManagerSOA();

//An XmlDocument object that will contain the XML is created as input
XmlDocument xDoc = new XmlDocument();
xDoc.Load(@"D:\SOA\Inputs\GetEntityRequest.xml");

//The method getEntitiesAsString of the SOA layer is invoked
string resp = emSOA.getEntitiesAsString(xDoc.OuterXml);

//Operations are performed to save the results to disk
XmlDocument xResp = new XmlDocument();
xResp.LoadXml(resp);
xResp.Save(@"D:\SOA\Outputs\GetEntitiesOutput.xml");
</pre>
<br><br>
<div align="center">
{| class="MsoNormalTableAlert" border="1" cellspacing="0" cellpadding="0" width="600"
|-
| valign="top" width="100%" | 
<span>'''Alerta: '''Un XML tiene una serie de caracteres especiales&nbsp;que no pueden ser usados en un texto normal, como las cadenas dentro de tags. Estos caracteres son: </span>

#Doble comilla(") 
#Ampersan (&amp;) 
#Apostrofe (') 
#Menor que (&lt;) 
#Mayor que(&gt;)

<span>Si se necesita utilizar una sección '''CDATA '''con estos caracteres (vea [[GetEntities#Ejemplo|<u>getEntities</u>]]).</span> 

<span>Por ejemplo: En lugar de &lt;Company&gt;Johnson &amp; Johnson&lt;/Company&gt; use &lt;Company&gt;&lt;![CDATA[Johnson &amp; Johnson]]&gt;&lt;/Company&gt;</span>

|}
</div>
<br>

== Temas Relacionados&nbsp;  ==

*[[Asuntos de la Capa SOA#Manejo_de_Error_en_la_Invocaci.C3.B3n_de_Servicios_Web|Error manejando la invocacíon de Servicios web]] 
*[[Asuntos de la Capa SOA#Otras_Ventajas_de_Usar_Llaves_de_Negocio|Otras ventajas del uso de las llaves de negocio]] 
*[[Subir Archivos Usando la Capa SOA|Cargando archivos usando la capa&nbsp;SOA]] 
*[[Esquemas Entity Manager Para Servicios Web|Esquemas de Entity Manager para Servicios Web]] 
*[[Esquemas Workflow Engine Para Servicios Web|Esquemas del motor de flujo de procesos para Servicios Web]]

<comments />