Lista de Funciones

De

<keywords content="keywords">setEvent, CHelper, suspendprocess, resumeprocess, newcase, getsubprocessid, abortprocess, getassignedworkitems, funciones, CMailer, sendEmail, trace</keywords>

Funciones Bizagi Relacionadas a Eventos

setEvent

Esta función dispara la ejecución de un evento dentro del proceso.

Parámetros de Entrada:

Me: Contexto de la Actividad

iCaseId: Id de Caso donde el evento a ser disparado es encontrado.

sEventName: Nombre de la tarea (evento) a ser disparado

htProperties: null

 

setEvent

Esta función dispara la ejecución de un evento dentro del proceso.

Parámetros de Entrada:

Me: Contexto de la Actividad

iCaseId: Id de Caso donde el evento a ser disparado es encontrado.

iEventTaskId: Id de la Tarea Evento.

htProperties: null

Funciones Bizagi Relacionadas a Procesos

Las opciones que definen el comportamiento del proceso padre y sub-procesos para las funciones que suspenden o reactivan un proceso son las siguientes:

• EProcessSuspendResumeOptions.OnlyProcess: Suspende o reactiva los procesos y sus sub-procesos.
• EProcessSuspendResumeOptions.ProcessAndParentProcess: Suspende o reactiva los procesos y sus sub-procesos y al proceso padre y sus sub-procesos, que también puede ser definido como los "hermanos" del procesos que esta siendo suspendido o reactivado.
• EProcessSuspendResumeOptions.NotProcessAndParentProcess: Suspende o reactiva el proceso padre y sus sub-procesos, específicamente, a los "hermanos" del procesos que esta siendo suspendido o reactivado, pero no el proceso a sí mismo.
  
  

CHelper.suspendProcess

Esta función suspende un proceso.

Parámetros de Entrada:

Me: Contexto de la Actividad

iCaseId: Id del caso a suspender

eSuspendResumeOptions: Este parámetro debe corresponder a uno de los valores de las opciones definidas previamente.

CHelper.suspendProcess

Esta función suspende un proceso y notifica a los procesos, asignados actualmente y previamente, sobre la suspensión.

Parámetros de Entrada:

Me: Contexto de la Actividad

iCaseId: Id del caso a ser suspendido

eSuspendResumeOptions: Este parámetro debe corresponder a uno de los valores de las opciones definidas previamente.

iTemplateId: Id de la Plantilla de Notificación.

CHelper.suspendProcess

Esta función suspende un proceso y notifica a los procesos actualmente y previamente asignados sobre la suspensión. El valor especificado para la plantilla y la entidad es usado para la notificación.

Parámetros de Entrada:

Me: Contexto de la Actividad

iCaseId: Id del caso a ser suspendido

eSuspendResumeOptions: Este parámetro debe corresponder a uno de los valores de las opciones definidas previamente.

iTemplateId: Id de la plantilla de notificación.

sRootEntityName: Nombre de la entidad contextual usada para resolver la plantilla.

oSurrogateKey: Valor de la llave de la entidad contextual.

CHelper.resumeProcess

Esta función reactiva un proceso suspendido.

Parámetros de Entrada:

Me: Contexto de la Actividad

iCaseId: Id del caso a ser reactivado.

eSuspendResumeOptions: Este parámetro debe corresponder a uno de los valores de las opciones definidas previamente.

CHelper.resumeProcess

Esta función reactiva un proceso y notifica a los procesos asignados actualmente o previamente sobre la reactivación.

Parámetros de Entrada:

Me: Contexto de la Actividad

iCaseId: Id del caso a ser reactivado.

eSuspendResumeOptions: Este parámetro debe corresponder a uno de los valores de las opciones definidas previamente..

iTemplateId: Id de la plantilla de notificación.

CHelper.resumeProcess

Esta función reactiva un proceso y notifica a los procesos asignados actualmente y previamente sobre la suspensión. El valor especificado para la plantilla, de la entidad, está especificado para la notificación.

Parámetros de Entrada:

Me: Contexto de la Actividad

iCaseId: Id del caso a ser reactivado.

eSuspendResumeOptions: Este parámetro debe corresponder a uno de los valores de las opciones definidas previamente.

iTemplateId: Id de la plantilla de notificación.

sRootEntityName: Nombre de la entidad contextual usado para resolver la plantilla.

oSurrogateKey: Valor de la llave de la entidad contextual.

CHelper.NewCase

Esta función crea un nuevo caso para el tipo especificado y devuelve la entidad de la aplicación del nuevo caso.

Parámetros de Entrada:

Me: Contexto de la Actividad

idWFClass: Id de la Clase del flujo a ser creado.

CHelper.NewCase

Esta función crea un nuevo caso del tipo especificado. El creado del caso corresponde al usuario especificado. Esta función también devuelve la entidad de la aplicación del nuevo caso.

Parámetros de Entrada:

to idUser: Id del usuario creador del caso.

idWFClass: Id de la Clase del flujo a ser creado..

CHelper.NewCase

Esta función permite crear un nuevo caso basándose en información incluida en el parámetro de entrada (string XML). En este parámetro, es posible incluir información sobre el usuario creador del caso así como información de negocio. Por ejemplo, si se va a crear un caso de Actualización De Datos, los datos de nombre de cliente y otros podrían incluirse en el parámetro (string xml) de entrada.

Esta función también retorna un string con la información acerca del estado del caso como actividades, eventos activos así como errores durante la creación del mismo.

Los esquemas de los parámetros de entrada y salida de esta función pueden encontrarse en este link.

Parámetros de entrada:

Xml string : Es posible crear el string con el formato XML en la misma expresión que crea el caso, como en el siguiente ejemplo :

CHelper.getSubProcessesId

Esta función devuelve un conjunto con los id's de los sub-procesos del caso actual.

Parámetros de Entrada:

Me: Contexto de la Entidad

CHelper.getSubProcessesId

Esta función devuelve un conjunto con los id's de los sub-procesos del caso actual, que pertenecen a la clase de flujo especificado.

Parámetros de Entrada:

Me: Contexto de la organización

sWfClassName: Nombre de la clase del flujo de trabajo de los sub-procesos a ser obtenidos.

CHelper.getSubProcessesId

Esta función devuelve un conjunto con los id's de los sub-procesos del caso actual, que pertenecen a la clase de flujo especificado.

Parámetros de Entrada:

Me: Contexto de la Entidad

iWfClassId: Nombre de la clase del flujo de trabajo de los sub-procesos a ser obtenidos.

CHelper.abortProcess

Anula el caso especificado. La anulación de un caso consiste en cerrar el caso con un estado abortado.

Parámetros de Entrada:

Me: Contexto de la Actividad

iCaseId: Id del caso a ser anulado.

eAbortOptions: Este parámetro corresponde a uno de las siguientes opciones:

• EProcessAbortOptions.OnlyProcess: Anula los procesos y sus-procesos.
  
• EProcessAbortOptions.ProcessAndParentProcess: Anula los procesos y sus sub-procesos y al proceso padre y sus sub-procesos, específicamente, a los "hermanos" del proceso abortado.
  
• EProcessAbortOptions.NotProcessAndParentProcess: Anula al proceso padre y sus sub-procesos, específicamente, a los "hermanos" del proceso abortado, pero no el proceso a sí mismo.
  

CHelper.abortProcess

Esta función aborta el caso especificado. La anulación de un caso consiste en cerrar el caso con un estado abortado.

Parámetros de Entrada:

Me: Contexto de la Actividad.

iCaseId: Id del caso a ser abortado.

eAbortOptions: Este parámetro debe corresponder a uno de las siguientes opciones

• EProcessAbortOptions.OnlyProcess: Anula los procesos y sus sub-procesos.
  
• EProcessAbortOptions.ProcessAndParentProcess: Anula a los procesos y sus sub-procesos y al proceso padre y sus sub-procesos, específicamente, a los "hermanos" del proceso abortado, pero no el proceso a sí mismo.
  
• EProcessAbortOptions.NotProcessAndParentProcess: Anula al proceso padre y sus sub-procesos, específicamente, a los "hermanos" del proceso abortado.
  
• sAbortReason: Razón por la cual el proceso es anulado
  

CHelper.getAssignedWorkItems

Esta función devuelve un conjunto con ítems de trabajo del caso especificado, que son asignados para el usuario especificado.

Parámetros de Entrada:

Me: Contexto de la Actividad.

iCaseId: Id del Caso.

iCurrAssigneeId: Id del Usuario.

bIncludeSubProcs: Determina si las actividades encontradas dentro de los sub-procesos del caso son incluidos en los resultados.

Funciones de Bizagi Relacionadas a Notificaciones

CMailer.sendEmail

Esta función envía una notificación usando la plantilla especificada.

Parámetros de Entrada:

sMail: Dirección de correo electrónico del destinatario.

iTemplateId: Id de la plantilla del mensaje.

sEntityName: Entidad contextual para la resolución de la plantilla.

iEntityKey: Valor de la Llave de la entidad contextual.

<comments />