<< Clic para mostrar Tabla de Contenidos >> 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 |
---|---|---|
Aborta los casos y aquellos relacionados (casos padre, hermano e hijo). |
CHelper.abortProcess(Me, CaseId, AbortOption, AbortReason) |
|
Concatena documentos de un arreglo de archivos a un documento Word o PDF, dependiendo de la función seleccionada. |
CHelper.ConcatDocumentsFromFilesArrayToPDF(filesArray)
Word CHelper.ConcatDocumentsFromFilesArrayToWord(filesArray) |
|
Devuelve un atributo de fecha y hora convertido de una zona horaria de usuario, por ejemplo, UTC - 5, a la zona horaria del servidor donde se ejecuta el proyecto, por ejemplo, UTC. |
ConvertUserTimetoServerTime(UserId,Date); |
|
Cuenta el número de elementos de una entidad. |
CHelper.entityListCount(String entityName, String filter) |
|
Concatena documentos de dos XPaths diferentes a un documento Word o PDF, dependiendo de la función seleccionada.
|
CHelper.ConcatDocumentsFromTwoXpathsToPDF(Me, Xpath1, Xpath2)
Word CHelper.ConcatDocumentsFromTwoXpathsToWord(Me, Xpath1, Xpath2) |
|
Concatena documentos de un XPath a un documento Word o PDF, dependiendo de la función seleccionada. |
CHelper.ConcatDocumentsFromXpathFileToPDF(Me, XPath)
Word CHelper.ConcatDocumentsFromXpathFileToWord(Me, XPath) |
|
Esta función toma como parámetro el id de la actividad asíncrona que usted desea habilitar y la habilita. |
CHelper.EnableAsynchExecution(WorkitemId) |
|
Esta función toma como parámetro el id de la tarea temporizada que usted desea habilitar y la habilita. |
CHelper.EnableWaitJob(WaitJobId) |
|
Esta función traerá todas las actividades asíncronas bloqueadas. |
CHelper.GetAllStuckAsyncWorkitems() |
|
Esta función le traerá todos los trabajos temporizados bloqueados. |
CHelper.GetAllStuckWaitJobs() |
|
Retorna todos los WorkItems que tienen una asignación activa con el usuario dado. |
CHelper.getAssignedWorkItems(Me, CaseId, CurrentAsigneeId, IncludeSubProcesses) |
|
Obtiene el valor del atributo dado de un registro en específico de una entidad. |
CHelper.getAttrib(sEntityName, oEntityKey, sAttribName) |
|
Retorna verdadero si el parámetro es igual a 1 o true, falso de lo contrario. |
CHelper.getBoolean(value) |
|
Retorna el objeto caso sin la necesidad de contexto. |
CHelper.getCaseById(CaseId) |
|
Obtiene todos los usuarios que han trabajado en el caso. |
CHelper.getCaseUsers(CaseNumber) |
|
Obtiene la hora del usuario actual. |
CHelper.GetCurrentTimeForUser(idUser) |
|
Entrega la diferencia de tiempo, en minutos, teniendo en cuenta sólo los días hábiles. |
CHelper.getEffectiveDuration(Me, Start, End) |
|
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) |
|
Obtiene el valor de una atributo de una entidad que no esté relacionada con el Modelo de Datos. |
CHelper.getEntityAttrib(Entity, ValueToReturn, filter, filterParameters) |
|
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) |
|
Entrega una fecha, dados el ID de usuario, una fecha de inicio y el número de minutos. |
CHelper.getEstimatedDateForUser(idUser, dtFromDate, iDuration) |
|
Calcula una fecha considerando el esquema y zona horaria. |
CHelper.getEstimatedDateFromUserDateTime(UserId,iDuration) |
|
Devuelve el valor de un atributo de entidad localizado utilizando el idioma del usuario actual. |
CHelper.GetLocalizedValue(EntityName, AttribName, SurrogateKeyValue) |
|
Obtiene el siguiente valor de una secuencia. |
CHelper.GetNextSeqValueStr("SequenceName") |
|
Obtiene el valor de un parámetro personalizado. |
CHelper.getParameterValue(parameterName) |
|
Entrega el identificador de el padre de un proceso hijo, sin necesidad de contexto. |
CHelper.getParentProcessId(caseId, wfclassName) |
|
Devuelve una colección con los casos de los Subprocesos hermanos, |
CHelper.getSiblingProcessesId(Me,WfClassName) |
|
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) |
|
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) |
|
Obtiene los usuarios, dado una Persona |
CHelper.GetUsersForPersona("PersonaName" |
|
Obtiene la información de la Persona, dado un usuario. |
GetPersonasForUser("User Id") CHelper.GetPersonasForUser(UserId, "PersonaName") |
|
Recupera el valor almacenado en un objeto extendido. |
CHelper.GetStringExtended("ExtendedObjectName",Default value,Culture) |
|
Devuelve una colección con todos los Subprocesos del caso actual. |
CHelper.getSubProcessesId(Me) |
|
Obtiene los identificadores de todos los procesos hijo del tipo dado. |
CHelper.getSubProcessesId(Me, WfClassName) |
|
Obtiene una lista de los usuarios que tienen cierta Posición en la empresa. |
CHelper.getUsersForPosition(posName) |
|
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) |
|
Obtiene una lista de los usuarios que tienen cierto Rol en la empresa. |
CHelper.getUsersForRole(roleName) |
|
Obtiene una lista de los usuarios activos que tienen cierto Rol en la empresa, si el filtro se encuentra activo. |
CHelper.getUsersForRole(roleName, filterActive) |
|
Obtiene una lista de los usuarios que tienen cierta Habilidad en la empresa. |
CHelper.getUsersForSkill(skillName) |
|
Obtiene una lista de los usuarios activos que tienen cierta Habilidad en la empresa, si el filtro se encuentra activo.. |
CHelper.getUsersForSkill(skillName, filterActive) |
|
Obtiene todos los usuarios de una Persona dada. |
CHelper.GetUsersForPersona("PersonaName") |
|
Obtiene el esquema predefinido para cualquier entidad, como se configuró en Bizagi Studio. |
CHelper.getXSD(entityName, xsdName) |
|
Obtiene el archivo de transformación predefinido registrado para cualquier entidad, como se configuró en Bizagi Studio. |
CHelper.getXSL(entityName, xslName) |
|
Otorga acceso al usuario al caso dado. |
CHelper.GrantCaseAccess(idCase, idUser) |
|
Retorna verdadero si el objeto entregado como parámetro es vacío, falso de lo contrario. |
CHelper.IsEmpty(Variable) |
|
Retorna verdadero si el objeto entregado como parámetro es nulo, falso de lo contrario.. |
CHelper.IsNull(Variable) |
|
Verifica si una fecha es un día de trabajo. |
CHelper.IsWorkingDay(Me,Date) |
|
Verifica si una fecha es un día de trabajo para un usuario en específico. |
CHelper.IsWorkingDayForUser(idUser, Date) |
|
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) |
|
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) |
|
Retorna el id del siguiente usuario disponible en la asignación por carga. |
CHelper.LoadAssig(AssigneeList, Me) |
|
Crea un nuevo caso con el usuario creador definido. |
CHelper.NewCase(idUser,WFClassName) |
|
Crea un nuevo caso basado en la información proveída en el parámetro de entrada (cadena XML). |
CHelper.NewCase(XML) |
|
Ejecuta una actividad, es el equivalente de hacer clic sobre el botón SIGUIENTE. |
CHelper.PerformActivity(XML_ActivityInfo) |
|
Levanta una cancelación y agrega un log de cancelación. |
CHelper.RaiseCancelIntermediateEvent(message) |
|
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) |
|
Interrumpe el proceso transaccional y desvía el camino hacia el de cancelación. |
CHelper.RaiseCancelEndEvent(message) |
|
Interrumpe el proceso transaccional y desvía el camino hacia el de error. |
CHelper.RaiseErrorEndEvent(message) |
|
Obtiene el valor guardado en el vocabulario. |
CHelper.resolveVocabulary(Me, VocabularyName) |
|
Retorna el id del siguiente usuario disponible en la asignación secuencial. |
CHelper.SecuentialAssig(AssigneeList, Me) |
|
Modifica valores específicos de registros específicos de una entidad. Antes de usar CHelper.setAttib lea este artículo cuidadosamente, pues tiene consideraciones importantes. |
CHelper.setAttrib(sEntityName, oEntityKey, sAttribName, oAttribValue) |
|
Ejecuta el evento intermedio disponible en Bizagi. |
CHelper.setEvent(Me, Caseid, eventName, null)
CHelper.setEvent(xml) |
|
Evalúa si hay casos abiertos para un número de creación de caso específico. |
CHelper.thereAreOpenProcesses(CaseNumber) |
|
Evalúa si hay casos abiertos para un número de creación de caso Y WfClassName específicos. |
CHelper.thereAreOpenProcesses(caseNumber, wfclassName) |
|
Muestra un mensaje de error en el Portal de Trabajo. |
CHelper.ThrowValidationError(message) |
|
Muestra un mensaje de alerta personalizado en el Portal de Trabajo. |
CHelper.ThrowValidationAlert(message) |
|
Lleva el log de trazas definidas por el usuarios que se incluyen manualmente en las Reglas de Negocio. |
CHelper.trace(sFileName, sText) |
|
Convierte archivos a base64. |
CHelper.ToBase64(data) |
|
Convierte una cadena de texto a un número entero. |
CHelper.ToInt(sText) |
|
Mapea información de negocio a un documento que será almacenado en ECM. |
CHelper.UpdateECMMetadata(Me, data, XPath) |
|
Obliga a Bizagi a incluir atributos que no están incluidos en en deployment. |
CHelper.usingXPath(XPath) CHelper.usingXPath(EntityName, XPath) |
Last Updated 5/15/2024 9:55:54 AM