getWorkflowClassesAsString

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi desde aplicaciones externas > API de Bizagi para aplicaciones externas > Servicios web disponibles > Métodos Web de WorkflowEngineSOA >

getWorkflowClassesAsString

Introducción

Este método se utiliza para obtener un listado de los Procesos que pertencen a cierta categoría de negocio en Bizagi (desde una aplicación externa).

 

Este método recibe un único parámetro de entrada el cual contiene el nombre de la categoría a la que pertenecen los Procesos.

 

Los Procesos están clasificados por categorías, como se define en Bizagi Studio en el módulo de Procesos, para cada aplicación y categoría (jerárquicamente):

 

getProcesses

 

 

Nótese que para la categoría Travel (Viajes), encontramos 2 Procesos: Solicitud de viajes (Travel Request) y Reporte de gastos (Expenses report).

 

note_pin

La descripción en este artículo aplica también para el método Web getWorkflowClasses, el cual está disponible en la edición Bizagi .NET.

Para el método getWorkflowClasses, el XML que se maneja en la solicitud (request) y en la respuesta (response) son del tipo XmlDocument (nativa de .NET).

Para el método getWorkflowClassesAsString la misma estructura de XMLs se maneja, sin embargo este parámetro es de tipo cadena (string).

 

Datos de entrada

 

Esquema de entrada

La estructura del XML que se envia a Bizagi debe ser cumplir con este XSD:

<?xml version="1.0" encoding="utf-8"?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">

 <xs:element name="BizAgiWSParam">

         <xs:complexType>

                 <xs:sequence>

                         <xs:element name="category" type="xs:string"/>

                 </xs:sequence>

         </xs:complexType>

 </xs:element>

</xs:schema>

 

Parámetros de entrada

BizAgiWSParam: Nodo raíz.

category: Contiene el nombre de la categoría que será consultada (ingrese el nombre, no el nombre a mostrar).

 

 

Ejemplo

Con el siguiente ejemplo, se obtienen los Procesos para la categoría Travel:

<?xml version="1.0" encoding="utf-8"?>

<BizAgiWSParam>

 <category>Travel</category>

</BizAgiWSParam>

 

Datos de salida

 

Esquema de salida

La estructura del XML que se retorna en Bizagi cumple con este XSD:

<?xml version="1.0" encoding="utf-8"?>

<xs:schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">

 <xs:element name="workflowClasses">

         <xs:complexType>

                 <xs:sequence>

                         <xs:element name="workflowClass" maxOccurs="unbounded">

                                 <xs:complexType>

                                         <xs:sequence>

                                                 <xs:element name="workflowClassId" type="xs:unsignedByte"/>

                                                 <xs:element name="workflowClassName" type="xs:string"/>

                                                 <xs:element name="workflowClassDisplayName" type="xs:string"/>

                                                 <xs:element name="workflowClassDescription"/>

                                                 <xs:element name="workflowClassHelpText"/>

                                                 <xs:element name="workflowClassHelpURL"/>

                                                 <xs:element name="workflowClassDisplayOrder" type="xs:unsignedByte"/>

                                                 <xs:element name="workflowClassCreationDate" type="xs:dateTime"/>

                                                 <xs:element name="workflowClassGlobalForm" type="xs:unsignedByte"/>

                                                 <xs:element name="workflowClassAllocationPrinciple" type="xs:string"/>

                                                 <xs:element name="workflowClassProcessType" type="xs:string"/>

                                                 <xs:element name="workflowClassDisplay" type="xs:boolean"/>

                                                 <xs:element name="workflowClassUseParentRadicationNumber" type="xs:boolean"/>

                                                 <xs:element name="workflowClassSupportsScopes" type="xs:boolean"/>

                                                 <xs:element name="caseAccessType" type="xs:string"/>

                                         </xs:sequence>

                                 </xs:complexType>

                         </xs:element>

                 </xs:sequence>

         </xs:complexType>

 </xs:element>

</xs:schema>

 

 

Parámetros de salida

workflowClasses: Nodo raíz. Contiene un nodo workflowClass por cada proceso dentro de la categoría dada.

workflowClass: La información en este nodo es básicamente información del proceso (metadata).

workflowClassId: Número de identificación (o llave) del proceso.

workflowClassName: Nombre del proceso.

workflowClassDisplayName: Nombre a mostrar del proceso.

workflowClassDescription: Descripción del proceso.

workflowClassHelpText: Texto de ayuda del proceso.

workflowClassHelpURL: URL de ayuda para el proceso.

workflowClassDisplayOrder: El orden en el cual aparece el proceso dentro de la aplicación web.

workflowClassCreationDate: Fecha de creación del proceso.

workflowClassGlobalForm: Número de identificación de la froma global del proceso (cero si no se encuentra configurada).

workflowClassAllocationPrinciple: Reservado para uso futuro.

workflowClassProcessType: Tipo de proceso.

workflowClassDisplay: Indica si el proceso es visible o no.

workflowClassUseParentRadicationNumber: Indica si un caso de este proceso utiliza su propio número de creación o el mismo número que el proceso padre (en caso de ser subproceso).

workflowClassSupportScopes: Indica si el proceso soporta los "scopes" de Bizagi; los cuales son un método más eficiente de persistencia de datos.

 

 

Ejemplo

Con el siguiente ejemplo, se ilustra la respuesta que retorna la invocación de este método en Bizagi;

 

 

getProcessesOutput

 

 

Nótese que dentro de la categoría de Travel (Viajes), tenemos 2 Procesos: Travel Request (Solicitud de Viaje) y Expenses report (Reporte de gastos).

 

Métodos Web relacionados

Es posible que se desee utilizar los métodos getCategoriesAsString o getCategories previamente para obtener la categoría a la que pertenecen estos Processes.

Para más información sobre esta opción, consulte getCategoriesAsString.

 

Otra opción para obtener los Procesos es utilizando el método getWorkflowClassesFromCategoryName. La diferencia en este otro método es que el dato de entrada es una única cadena que no contiene formato XML.

Para más información sobre esta opción, consulte getWorkflowClassesFromCategoryName.