Funciones CHelper

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Automatización de Procesos con poco código > Studio Cloud -ambiente de autoría > Bizagi Studio > Asistente de Procesos > Reglas de Negocio > Funciones de Bizagi >

Funciones CHelper

Introducción

CHelper es un objeto que contiene un grupo de funciones utilizadas para realizar operaciones u obtener información sobre información no contextualizada. No contextualizado significa que estas funciones no están necesariamente relacionadas con el caso o el elemento BPMN donde se ejecuta la regla. Por ejemplo operar dos números u obtener información de otros elementos  en el proyecto.

 

Vea nuestro API de Reglas de Negocio

 

La siguiente tabla contiene las diferentes funciones que puede encontrar dentro del objeto CHelper.

 

FUNCIÓN

DESCRIPCIÓN

SINTAXIS

Cancelar Proceso

Aborta los casos y aquellos relacionados (casos padre, hermano e hijo).

CHelper.abortProcess(Me, CaseId, AbortOption, AbortReason)

Concatenar documentos desde un arreglo de archivos

Concatena documentos de un arreglo de archivos a un documento Word o PDF, dependiendo de la función seleccionada.

PDF

CHelper.ConcatDocumentsFromFilesArrayToPDF(filesArray)

 

Word

CHelper.ConcatDocumentsFromFilesArrayToWord(filesArray)

Convertir una fecha de la zona horaria del servidor a la zona horaria del usuario

Convierte una fecha en UTC+0 (hora del servidor) a la fecha y hora equivalentes en la zona horaria del usuario.

CHelper.ConvertServerTimetoUserTime(idUser, serverTime)

Convertir una fecha de la zona horaria del usuario a la zona horaria del servidor

Convierte un valor de tipo fecha y hora relativo a la zona horaria de un usuario en la hora del servidor (UTC+0).

CHelper.ConvertUserTimetoServerTime(idUser, Date)

Convertir una fecha de la zona horaria del servidor a una zona horaria específica

Convierte una fecha en UTC+0 (hora del servidor) a la fecha equivalente en la zona horaria especificada.

CHelper.ConvertServerTimeToTimeZoneTime("sTimeZoneName", serverTime)

Convertir una fecha de una zona horaria específica a la zona horaria del servidor

Convierte un valor de fecha y hora desde una zona horaria especificada a la hora del servidor (UTC+0).

CHelper.ConvertTimeZoneTimeToServerTime(st"sTimeZoneName", timeZoneTime):

Contar

Cuenta el número de elementos de una entidad.

CHelper.entityListCount("entityName", filter)

Concatenar documentos desde dos XPaths

Concatena documentos de dos XPaths diferentes a un documento Word o PDF, dependiendo de la función seleccionada.

 

PDF

CHelper.ConcatDocumentsFromTwoXpathsToPDF(Me, Xpath1, Xpath2)

 

Word

CHelper.ConcatDocumentsFromTwoXpathsToWord(Me, Xpath1, Xpath2)

Concatenar documentos desde XPath

Concatena documentos de un XPath a un documento Word o PDF, dependiendo de la función seleccionada.

PDF

CHelper.ConcatDocumentsFromXpathFileToPDF(Me, XPath)

 

Word

CHelper.ConcatDocumentsFromXpathFileToWord(Me, XPath)

Habilitar ejecución asíncrona

Esta función toma como parámetro el id de la actividad asíncrona que usted desea habilitar y la habilita.

CHelper.EnableAsynchExecution(WorkitemId)

Habilitar trabajo en espera

Esta función toma como parámetro el id de la tarea temporizada que usted desea habilitar y la habilita.

CHelper.EnableWaitJob(WaitJobId)

Obtener todos los elementos de trabajo asíncronos atascados

Esta función traerá todas las actividades asíncronas bloqueadas.

CHelper.GetAllStuckAsyncWorkitems()

Obtener todos los trabajos en espera atascados

Esta función le traerá todos los trabajos temporizados bloqueados.

CHelper.GetAllStuckWaitJobs()

Obtener elementos de trabajo asignados

Retorna todos los WorkItems que tienen una asignación activa con el usuario dado.

CHelper.getAssignedWorkItems(Me, CaseId, CurrentAsigneeId, IncludeSubProcesses)

Obtener atributo

Obtiene el valor del atributo dado de un registro en específico de una entidad.

CHelper.getAttrib(sEntityName, oEntityKey, sAttribName)

Obtener Booleano

Retorna verdadero si el parámetro es igual a 1 o true, falso de lo contrario.

CHelper.getBoolean(value)

Obtener objeto caso

Retorna el objeto caso sin la necesidad de contexto.

CHelper.getCaseById(CaseId)

Obtener usuarios del caso

Obtiene todos los usuarios que han trabajado en el caso.

CHelper.getCaseUsers(CaseNumber)

Obtener la hora actual para el usuario

Obtiene la hora del usuario actual.

CHelper.GetCurrentTimeForUser(idUser)

Obtener duración efectiva

Entrega la diferencia de tiempo, en minutos, teniendo en cuenta sólo los días hábiles.

CHelper.getEffectiveDuration(Me, Start, End)

Obtener duración efectiva para el usuario

Entrega la diferencia de tiempo, en minutos, teniendo en cuenta sólo los días hábiles para el usuario especificado.

CHelper.getEffectiveDurationForUser(idUser, Start, End)

Obtener atributo de entidad

Obtiene el valor de una atributo de una entidad que no esté relacionada con el Modelo de Datos.

CHelper.getEntityAttrib(Entity, ValueToReturn, filter, filterParameters)

Obtener fecha estimada

Entrega una fecha a partir de una fecha inicial y un periodo de tiempo, teniendo en cuenta el esquema de tiempo de trabajo.

CHelper.getEstimatedDate(Me, dtFromDate, iDuration)

Obtener fecha estimada para el usuario

Entrega una fecha, dados el ID de usuario, una fecha de inicio y el número de minutos.

CHelper.getEstimatedDateForUser(idUser, dtFromDate, iDuration)

Obtener fecha estimada desde fecha y hora del usuario

Calcula una fecha considerando el esquema y zona horaria.

CHelper.getEstimatedDateFromUserDateTime(UserId,iDuration)

Obtener valor localizado

Devuelve el valor de un atributo de entidad localizado utilizando el idioma del usuario actual.

CHelper.GetLocalizedValue(EntityName, AttribName, SurrogateKeyValue)

Obtener siguiente valor de secuencia

Obtiene el siguiente valor de una secuencia.

CHelper.GetNextSeqValueStr("SequenceName")

Obtener valor de parámetro

Obtiene el valor de un parámetro personalizado.

CHelper.getParameterValue(parameterName)

Obtener Id del proceso padre

Entrega el identificador de el padre de un proceso hijo, sin necesidad de contexto.

CHelper.getParentProcessId(caseId, wfclassName)

Obtener Id de procesos hermanos

Devuelve una colección con los casos de los Subprocesos hermanos.

CHelper.getSiblingProcessesId(Me,WfClassName)

Obtener fecha de solución

Obtiene una fecha, dada una fecha inicial y un periodo de tiempo, teniendo en cuenta el esquema de tiempo de trabajo y días festivos.

CHelper.getSolutionDate(Me, dtFromDate, iDuration)

Obtener fecha de solución para el usuario

Obtiene una fecha, dado el Id de un usuario, una fecha de inicio, teniendo en cuenta el esquema de tiempo de trabajo y días feriados para el usuario.

CHelper.getSolutionDateForUser(idUser, dtFromDate, iDuration)

Obtener usuario por Persona

Retorna un arreglo de objetos tipo Persona para el nombre de entidad Persona dado.

CHelper.GetUsersForPersona("PersonaName")

Obtener String extendido

Recupera el valor almacenado en un objeto extendido.

CHelper.GetStringExtended("ExtendedObjectName",Default value,Culture)

Obtener Id del subproceso

Devuelve una colección con todos los Subprocesos del caso actual.

CHelper.getSubProcessesId(Me)

Obtener Id de subprocesos específicos

Obtiene los identificadores de todos los procesos hijo del tipo dado.

CHelper.getSubProcessesId(Me, WfClassName)

Obtener usuarios por Posición

Obtiene una lista de los usuarios que tienen cierta Posición en la empresa.

CHelper.getUsersForPosition(posName)

Obtener usuarios filtrados por Posición

Obtiene una lista de los usuarios activos que tienen cierta Posición en la empresa, si el filtro se encuentra activo.

CHelper.getUsersForPosition(posName, filterActive)

Obtener usuarios por Rol

Obtiene una lista de los usuarios que tienen cierto Rol en la empresa.

CHelper.getUsersForRole(roleName)

Obtener usuarios filtrados por Rol

Obtiene una lista de los usuarios activos que tienen cierto Rol en la empresa, si el filtro se encuentra activo.

CHelper.getUsersForRole(roleName, filterActive)

Obtener usuarios por Habilidad

Obtiene una lista de los usuarios que tienen cierta Habilidad en la empresa.

CHelper.getUsersForSkill(skillName)

Obtener usuarios filtrados por Habilidad

Obtiene una lista de los usuarios activos que tienen cierta Habilidad en la empresa, si el filtro se encuentra activo..

CHelper.getUsersForSkill(skillName, filterActive)

Obtener desfase por ubicación

Retorna la diferencia en minutos entre la zona horaria de una ubicación y la hora del servidor (UTC+0).

CHelper.GetOffsetForLocation(idLocation)

Obtener desfase por organización

Retorna la diferencia en minutos entre la zona horaria de una organización y la hora del servidor (UTC+0).

CHelper.GetOffsetForOrganization(idOrganization)

Obtener desfase por usuario

Retorna la diferencia en minutos entre la zona horaria definida para un usuario específico y la hora del servidor (UTC+0).

CHelper.GetOffsetForUser(idUser)

Obtener desfase por zona horaria laboral

Retorna la diferencia en minutos entre la zona horaria definida en la llave WorkingTimeZone y la hora del servidor (UTC+0).

CHelper.GetOffsetForWorkingTimeZone()

Obtener usuarios por Persona

Obtiene todos los usuarios de una Persona dada.

CHelper.GetUsersForPersona("PersonaName")

Obtener Personas de un usuario

Obtiene todas las Personas de un usuario determinado.

GetPersonasForUser("User Id")

CHelper.GetPersonasForUser(UserId, "PersonaName")

Obtener XSD

Obtiene el esquema predefinido para cualquier entidad, como se configuró en Bizagi Studio.

CHelper.getXSD(entityName, xsdName)

Obtener XSL

Obtiene el archivo de transformación predefinido registrado para cualquier entidad, como se configuró en Bizagi Studio.

CHelper.getXSL(entityName, xslName)

Conceder acceso al caso

Otorga acceso al usuario al caso dado.

CHelper.GrantCaseAccess(idCase, idUser)

Está vacío

Retorna verdadero si el objeto entregado como parámetro es vacío, falso de lo contrario.

CHelper.IsEmpty(Variable)

Es nulo

Retorna verdadero si el objeto entregado como parámetro es nulo, falso de lo contrario..

CHelper.IsNull(Variable)

Es día laborable

Verifica si una fecha es un día de trabajo.

CHelper.IsWorkingDay(Me,Date)

Es día laborable para el usuario

Verifica si una fecha es un día de trabajo para un usuario en específico.

CHelper.IsWorkingDayForUser(idUser, Date)

Es hora laborable

Retorna verdadero si la fecha se encuentra dentro del esquema de tiempo de trabajo de la empresa, falso de lo contrario.

CHelper.IsWorkingMinute(Me, Date)

Es hora laborable para el usuario

Retorna verdadero si la fecha se encuentra dentro del esquema de tiempo de trabajo de un usuario en específico, falso de lo contrario.

CHelper.IsWorkingMinuteForUser(idUser, Date)

Obtener el siguiente usuario asignado por carga

Retorna el id del siguiente usuario disponible en la asignación por carga.

CHelper.LoadAssig(AssigneeList, Me)

Nuevo caso

Crea un nuevo caso con el usuario creador definido.

CHelper.NewCase(idUser,WFClassName)

Nuevo caso con información de negocio

Crea un nuevo caso basado en la información proveída en el parámetro de entrada (cadena XML).

CHelper.NewCase(XML)

Ejecutar actividad

Ejecuta una actividad, es el equivalente de hacer clic sobre el botón SIGUIENTE.

CHelper.PerformActivity(XML_ActivityInfo)

Lanzar evento intermedio de cancelación

Levanta una cancelación y agrega un log de cancelación.

CHelper.RaiseCancelIntermediateEvent(message)

Lanzar evento intermedio de error

Interrumpe la actividad actual, y desvía el trayecto hacia el camino de error. Esta función agregará un archivo log de error.

CHelper.RaiseErrorIntermediateEvent(message)

Lanzar evento final de cancelación

Interrumpe el proceso transaccional y desvía el camino hacia el de cancelación.

CHelper.RaiseCancelEndEvent(message)

Lanzar evento final de error

Interrumpe el proceso transaccional y desvía el camino hacia el de error.

CHelper.RaiseErrorEndEvent(message)

Restablecer valor de secuencia

Restablece el valor de la semilla de una secuencia a su valor inicial, tomando como entrada el nombre de la secuencia.

 

Antes de usar CHelper.ResetSequenceValue, lea la información en la API de Reglas, ya que el uso de esta función conlleva consideraciones importantes.

CHelper.ResetSequenceValue("SequenceName")

Resolver Vocabulario

Obtiene el valor guardado en el vocabulario.

CHelper.resolveVocabulary(Me, VocabularyName)

Obtener el siguiente usuario asignado por secuencia

Retorna el id del siguiente usuario disponible en la asignación secuencial.

CHelper.SecuentialAssig(AssigneeList, Me)

Establecer atributo

Modifica valores específicos de registros específicos de una entidad.

 

Antes de usar CHelper.setAttib, lea este artículo cuidadosamente, ya que el uso de esta función conlleva consideraciones importantes.

CHelper.setAttrib(sEntityName, oEntityKey, sAttribName, oAttribValue)

Ejecutar evento

Ejecuta el evento intermedio disponible en Bizagi.

CHelper.setEvent(Me, Caseid, eventName, null)

 

CHelper.setEvent(xml)

Evaluar si hay procesos abiertos

Evalúa si hay casos abiertos para un número de creación de caso específico.

CHelper.thereAreOpenProcesses(CaseNumber)

Evaluar si hay procesos abiertos

Evalúa si hay casos abiertos para un número de creación de caso Y WfClassName específicos.

CHelper.thereAreOpenProcesses(caseNumber, wfclassName)

Lanzar error de validación

Muestra un mensaje de error en el Portal de Trabajo.

CHelper.ThrowValidationError(message)

Lanzar alerta de validación

Muestra un mensaje de alerta personalizado en el Portal de Trabajo.

CHelper.ThrowValidationAlert(message)

Trazar

Lleva el log de trazas definidas por el usuarios que se incluyen manualmente en las Reglas de Negocio.

CHelper.trace(sFileName, sText)

A base64

Convierte archivos a base64.

CHelper.ToBase64(data)

A Entero

Convierte una cadena de texto a un número entero.

CHelper.ToInt(sText)

Actualizar metadata ECM

Mapea información de negocio a un documento que será almacenado en ECM.

CHelper.UpdateECMMetadata(Me, data, XPath)

Forzar deployment de atributo

Obliga a Bizagi a incluir atributos que no están incluidos en en deployment.

CHelper.usingXPath(XPath)

CHelper.usingXPath(EntityName, XPath)


Last Updated 5/7/2025 1:30:19 PM