De

<keywords content="keywords">abortCases, abortCasesAsString, abort Cases, Capa SOA, WorkflowEngineSOA, Workflow Engine SOA</keywords> 

abortCases

Este método del servicio web WorkflowEngineSOA, es utilizado para abortar o cancelar uno o más casos en Bizagi. Este artículo aplica también para el método abortCasesAsString.

Descripción

Este método recibe un XML indicando el número de creación para un caso y el motivo de cancelación. Para el método abortCases, los parmámetros de entrada y salida son XML's del tipo XmlDocument, mientras que para el método abortCasesAsString, los mismos XML son de tipo string.

Parámetros de Entrada

El XML que se envía a Bizagi debe ser generado de acuerdo a este esquema XSD:

Parámetro 1 (XmlDocument o Tipo String)

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 XML, se cancelarán dos casos por el usuario admon (usuario por defecto de Bizagi).

Parámetros de Salida 

El XML de respuesta debe ser generado de acuerdo al siguiente esquema XSD:

La respuesta incluye información básica del caso (y del proceso) que se acaba de cancelar. A continuación encontrará una descripción de la información contenida en el XML de respuesta.

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

workflowClassSupportScopes:

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

A continuación encontrará el XML de respuesta al ejemplo mostrado ateriormente: 

En este ejemplo, se puede apreciar que para el caso número 8951, la operación de cancelación se ejecutó de manera satisfactoria. Sin embargo, para el caso 9001, el cual se había cancelado previamente, el mensaje de respuesta explíca que este caso ya no se encuentra disponible para ser cancelado o abortado. <comments />