getWorkflowClassesFromCategoryName

<< 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 >

getWorkflowClassesFromCategoryName

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.

A diferencia del método getWorkflowClassesAsString, el dato de entrada NO contiene formato de XML.

 

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).

 

Datos de entrada

Los datos de entrada se especifican en un parámetro de tipo cadena (string).

 

 

Parámetros de entrada

categoría: Contiene el nombre de la categoría de negocio para la cual vamos a obtener los Procesos (el nombre real, no el nombre de mostrar).

 

 

Ejemplo

Con el siguiente ejemplo, se envia como dato de entrada:

categoría: Travel

 

 

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 para cada proceso en 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 del proceso.

workflowClassDisplayOrder: Orden en el cual aparecerán los procesos dentro de la aplicación.

workflowClassCreationDate: Fecha de creación del proceso.

workflowClassGlobalForm: Número de identificación de la forma global del proceso (cero si no está configurada).

workflowClassAllocationPrinciple: Reserva a para uso futuro.

workflowClassProcessType: Tipo de proceso.

workflowClassDisplay: Indica si el proceso se encuentra visible.

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

workflowClassSupportScopes: Indica si el proceso soporta los "scopes" de Bizagi; los cuales constituyen un método 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, en donde;

getProcessesOutput

 

Nótese que para la categoría Travel (Viajes), encontramos 2 Procesos diferentes: 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 para obtener las categorías de negocio a la cuál pertenece un listado de Procesos.

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

 

Otra opción para obtener el listado de Procesos de una categoría dada, es utilizando los métodos getWorkflowClassesAsString o getWorkflowClasses. La diferencia con estos métodos es que los otros reciben una cadena con la información en formato XML.

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