abortCasesAsString

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

abortCasesAsString

Introducción

Este método se utiliza para abortar (cancelar) uno o más casos en Bizagi (desde una aplicación externa).

 

Este método recibe un único parámetro de entrada el cual contiene principalmente: el identificador del caso (puede ser más de un caso) y una razón detallada del motivo de porqué abortar esos casos, de la misma manera como se presenta esta opción desde las opciones administrativas del Portal de Trabajo.

Para más información acerca de esta opción en el Portal, consulte Portal de Trabajo de Bizagi.

 

 

note_pin

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

Para el método abortCases, 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 abortCasesAsString la misma estructura de XMLs se maneja, sin embargo este parámetro es de tipo cadena (string).

Todos los casos que tengan el mismo radNumber serán abortados. Si hay procesos y subprocesos, todos se abortarán.

 

 

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="domain" type="xs:string" minOccurs="0"/>

                         <xs:element name="userName" type="xs:string" minOccurs="0"/>

                         <xs:element name="cases">

                                 <xs:complexType>

                                         <xs:sequence>

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

                                                         <xs:complexType>

                                                                 <xs:sequence>

                                                                         <xs:element name="radNumber" type="xs:unsignedShort"/>

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

                                                                 </xs:sequence>

                                                         </xs:complexType>

                                                 </xs:element>

                                         </xs:sequence>

                                 </xs:complexType>

                         </xs:element>

                 </xs:sequence>

         </xs:complexType>

 </xs:element>

</xs:schema>

 

 

Parámetros de entrada

BizAgiWSParam: Nodo raíz.

domain: Contiene el nombre del dominio del usuario Bizagi que será registrado como el usuario que cancela el caso.

userName: Contiene el nombre (usado en Bizagi) del usuario, que será registrado como el usuario que cancela el caso.

cases: Este elemento se incluye para agrupar varios elemento case dependiendo del número de casos que se van a cancelar.

case: Se incluye la información del caso que se va a cancelar.

radNumber: Se refiere al número de creación del caso.

abortReason: Contiene los motivos de la cancelación del caso.

 

 

Ejemplo

Con el siguiente ejemplo, se cancelarán dos casos por el domain\admon.

 

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

<BizAgiWSParam>

 <domain>domain</domain>

 <userName>admon</userName>

 <cases>

         <case>

                 <radNumber>8951</radNumber>

                 <abortReason>Invalid case</abortReason>

         </case>

         <case>

                 <radNumber>9001</radNumber>

                 <abortReason>Test case</abortReason>

         </case>                

 </cases>

</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:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="unqualified" attributeFormDefault="qualified">

 <xs:element name="Processes">

         <xs:complexType>

                 <xs:sequence>

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

                                 <xs:complexType>

                                         <xs:sequence>

                                                 <xs:element name="ProcessId" type="xs:integer"/>

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

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

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

                                                 <xs:element name="ProcessWorkflowClass">

                                                         <xs:complexType>

                                                                 <xs:sequence>

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

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

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

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

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

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

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

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

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

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

                                                         </xs:complexType>

                                                 </xs:element>

                                                 <xs:element name="ProcessError">

                                                         <xs:complexType>

                                                                 <xs:sequence>

                                                                         <xs:element name="errorCode" type="xs:integer"/>

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

                                                                 </xs:sequence>

                                                         </xs:complexType>

                                                 </xs:element>

                                         </xs:sequence>

                                 </xs:complexType>

                         </xs:element>

                 </xs:sequence>

         </xs:complexType>

 </xs:element>

</xs:schema>

 

Parámetros de salida

processes: Nodo raíz.

process: Este elemento se incluye para cada caso que se ha cancelado.

processId: Número de identificación del caso (idCase).

processRadNumber: Valor Alfanumérico que corresponde al número de creación del caso.

processCreationDate: Fecha de creación del caso.

processSolutionDate: Fecha de solución del caso.

processWorkflowClass: Este nodo contiene información del proceso (metadata). No es información del caso en particular.

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: El orden en el cual aparece el proceso en la aplicación web.

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: Reservado para una funcionalidad posterior.

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 si es el mismo número que el proceso padre (para subprocesos).

processError: Si se presentó un error en el momento de cancelar un caso, este elemento mostrará información del error.

errorCode: Código del error presentado, Si no hubo error, este nodo estará vacío.

errorMessage: Mensaje del error presentado. Si no hubo error, este nodo estará vacío.

 

 

Ejemplo

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

Para el caso con identificador 8951, abortar el caso es una operación exitosa.

Para el caso con identificador 9001, el cual fue abortado anteriormente, el mensaje de respuesta indica que la posibilidad de abortarlo no está disponible.

 

 

abortCases_Image004