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

Cancel Process

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

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

Concatenate documents from files array

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)

Convert a date from user time zone to server time zone

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

Count

Cuenta el número de elementos de una entidad.

CHelper.entityListCount(String entityName, String filter)

Concatenate documents from two 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)

Concatenate documents from 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)

Enable asynchronous execution

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

CHelper.EnableAsynchExecution(WorkitemId)

Enable wait job

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

CHelper.EnableWaitJob(WaitJobId)

Get all stuck asynchronous work items

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

CHelper.GetAllStuckAsyncWorkitems()

Get all stuck wait jobs

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

CHelper.GetAllStuckWaitJobs()

Get Assigned WorkItems

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

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

Get attribute

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

CHelper.getAttrib(sEntityName, oEntityKey, sAttribName)

Get Boolean

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

CHelper.getBoolean(value)

Obtain case object

Retorna el objeto caso sin la necesidad de contexto.

CHelper.getCaseById(CaseId)

Get case users

Obtiene todos los usuarios que han trabajado en el caso.

CHelper.getCaseUsers(CaseNumber)

Get current time for user

Obtiene la hora del usuario actual.

CHelper.GetCurrentTimeForUser(idUser)

Get effective duration

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

CHelper.getEffectiveDuration(Me, Start, End)

Get effective duration for user

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)

Get entity attribute

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

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

Get estimated date

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)

Get estimated date for user

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

CHelper.getEstimatedDateForUser(idUser, dtFromDate, iDuration)

Get estimated date from user date time

Calcula una fecha considerando el esquema y zona horaria.

CHelper.getEstimatedDateFromUserDateTime(UserId,iDuration)

Get localized value

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

CHelper.GetLocalizedValue(EntityName, AttribName, SurrogateKeyValue)

Get next sequence value

Obtiene el siguiente valor de una secuencia.

CHelper.GetNextSeqValueStr("SequenceName")

Get parameter value

Obtiene el valor de un parámetro personalizado.

CHelper.getParameterValue(parameterName)

Get parent process Id

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

CHelper.getParentProcessId(caseId, wfclassName)

Get sibling process Id

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

CHelper.getSiblingProcessesId(Me,WfClassName)

Get Solution date

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)

Get solution date for user

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)

Get user by Persona

Obtiene los usuarios, dado una Persona

CHelper.GetUsersForPersona("PersonaName"

Get Persona for user

Obtiene la información de la Persona, dado un usuario.

GetPersonasForUser("User Id")

CHelper.GetPersonasForUser(UserId, "PersonaName")

Get String Extended

Recupera el valor almacenado en un objeto extendido.

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

Get subprocess Id

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

CHelper.getSubProcessesId(Me)

Get given sub-processes' Id

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

CHelper.getSubProcessesId(Me, WfClassName)

Get users for Position

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

CHelper.getUsersForPosition(posName)

Get filtered users for position

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)

Get users for role

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

CHelper.getUsersForRole(roleName)

Get filtered users for role

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

CHelper.getUsersForRole(roleName, filterActive)

Get users for skill

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

CHelper.getUsersForSkill(skillName)

Get filtered users for skill

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

CHelper.getUsersForSkill(skillName, filterActive)

Get users by Persona

Obtiene todos los usuarios de una Persona dada.

CHelper.GetUsersForPersona("PersonaName")

Get XSD

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

CHelper.getXSD(entityName, xsdName)

Get XSL

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

CHelper.getXSL(entityName, xslName)

Grant case access

Otorga acceso al usuario al caso dado.

CHelper.GrantCaseAccess(idCase, idUser)

Is empty

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

CHelper.IsEmpty(Variable)

Is null

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

CHelper.IsNull(Variable)

Is working day

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

CHelper.IsWorkingDay(Me,Date)

Is working day for user

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

CHelper.IsWorkingDayForUser(idUser, Date)

Is working hour

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)

Is working hour for user

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)

Get the next assigned user by load

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)

Perform activity

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

CHelper.PerformActivity(XML_ActivityInfo)

Raise cancel intermediate event

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

CHelper.RaiseCancelIntermediateEvent(message)

Raise error intermediate event

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)

Raise cancel end event

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

CHelper.RaiseCancelEndEvent(message)

Raise error end event

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

CHelper.RaiseErrorEndEvent(message)

Resolve Vocabulary

Obtiene el valor guardado en el vocabulario.

CHelper.resolveVocabulary(Me, VocabularyName)

Get the next assigned user by sequence

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

CHelper.SecuentialAssig(AssigneeList, Me)

Set attribute

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)

Execute event

Ejecuta el evento intermedio disponible en Bizagi.

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

 

CHelper.setEvent(xml)

Evaluate if there are open processes

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

CHelper.thereAreOpenProcesses(CaseNumber)

Evaluate if there are open processes

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

CHelper.thereAreOpenProcesses(caseNumber, wfclassName)

Throw validation error

Muestra un mensaje de error en el Portal de Trabajo.

CHelper.ThrowValidationError(message)

Throw validation alert

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

CHelper.ThrowValidationAlert(message)

Trace

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

CHelper.trace(sFileName, sText)

To base64

Convierte archivos a base64.

CHelper.ToBase64(data)

To Integer

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

CHelper.ToInt(sText)

Update ECM metadata

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

CHelper.UpdateECMMetadata(Me, data, XPath)

Force attribute to deploy

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