Modelo de Objeto: CHelper
De
<keywords content="keywords"> CHelper, objeto CHelper, CHelper clase, clase, clases, funciones, funciones avanzadas, reglas avanzadas, modulo expresion, módulo expresión, modulo de expresiones, módulo de expresiones, modulo expresión, módulo expresion, modulo expresiones, módulo expresiones </keywords>
Contenido |
Ayudante de reglas en Bizagi (CHelper)
Este artículo lista las funciones disponibles del objecto ayudante de Bizagi (CHelper), para reglas de negocio avanzadas.
La clase CHelper contiene funciones que son útiles para la obtención de información y ejecución de comandos para los procesos. Dentro de estas posibilidades se presentan funciones para: generar trazas personalizadas de la ejecucion de las reglas, arrojar mensajes de error de validaciones, y evaluar los valores de atributos, entre otras.
La clase CHelper se utiliza dentro de un módulo de expresión en una regla de negocio de Bizagi, y sus funciones son sugeridas por la funcionalidad de auto-completar (intellisense):
Funciones del CHelper
En la siguiente tabla, las funciones principales y recomendadas de la clase CHelper se describen:
| Función | Sintaxis | Descripción |
|---|---|---|
| abortProcess | CHelper.abortProcess(Me, iCaseId, eAbortOptions) | Aborta el caso especificado. Abortar consiste en cerrar el caso abruptamente dejándolo en un estado abortado. Ejemplo |
| getAssignedWorkItems | CHelper.getAssignedWorkItems (Me, iCaseId, iCurrAssigneeId, bIncludeSubProcs) | Devuelve un arreglo de las actividades del caso especificado que estén asignadas al usuario especificado. |
| getAttrib | CHelper.getAttrib(sEntityName,oEntityKey,sAttribName) | Devuelve el valor del atributo dado, de un registro específico. Esta función está también disponible desde el CEntityManager. |
| getCaseUsers | CHelper.getCaseUsers(sRadNumber) | Devuelve un arreglo de ids de los usuarios que han sido participantes del caso (han trabajado en él). Ejemplo. |
| getEntityAttrib | CHelper.getEntityAttrib(sEntityName,sAttibute,sAttribWithFilter) | Devuelve el valor del atributo dado, de acuerdo al filtro establecido. |
| getEffectiveDuration | CHelper.getEffectiveDuration (Me, dtFromDate, dtToDate) | Devuelve la cantidad de minutos transcurridos entre dos fechas; el cálculo considera el esquema de horario de trabajo y los días festivos configurados para la organización. Ejemplo 1- Ejemplo 2 |
| getEffectiveDurationForUser | CHelper.getEffectiveDurationForUser(idUser,dtFromDate,dtToDate) | Devuelve la cantidad de minutos transcurridos entre dos fechas; el cálculo considera el esquema de horario de trabajo y los días festivos configurados para el usuario (idUser). Ejemplo |
| getEstimatedDate | CHelper.getEstimatedDate(Me,dtFromDate,iDuration) | Devuelve la fecha final dada una fecha de inicio; este cálculo es completado mediante la adición de minutos (iDuration) y basado en el esquema de horario de trabajo y festivos configurados para la organización. Esta función es similar a getSolutionDate. A diferencia de esta otra función, la duración acá puede ser especificada como un número negativo. Ejemplo |
| getEstimatedDateForUser | CHelper.getEstimatedDateForUser(idUser,dtFromDate,iDuration) | Devuelve la fecha final dada una fecha de inicio; este cálculo es completado mediante la adición de minutos (iDuration) y basado en el esquema de horario de trabajo y festivos configurados para el usuario (idUser). Esta función es similar a getSolutionDate. A diferencia de esta otra función, la duración acá puede ser especificada como un número negativo. Ejemplo |
| GetNextSeqValueStr | CHelper.GetNextSeqValueStr(Nombre Secuencia) | Genera automáticamente el siguiente número en la secuencia creada previamente por el usuario. Ejemplo |
| getOpenProcessesId | CHelper.getOpenProcessesId(sRadNumber) | Devuelve un arreglo de casos abiertos dado un número de creación. |
| getParentProcessId | CHelper.getParentProcessId(iProcId,iWfClassId) | Devuelve el id del caso padre dado el id del caso hijo y su wfclass |
| getSiblingProcessesId | CHelper.getSiblingProcessesId(Me, iWfClassId) | Devuelve un arreglo con los Id's de los casos relacionados dado un ítem de trabajo y una clase de flujo de trabajo (el id del wfclass). |
| getSolutionDate | CHelper.getSolutionDate (Me, dtFromDate, iDuration) | Devuelve la fecha final dada una fecha de inicio; este cálculo es completado mediante la adición de minutos (iDuration) y basado en el esquema de horario de trabajo y festivos configurados para la organización. Ejemplo |
| getSolutionDateForUser | CHelper.getSolutionDateForUser(idUser,dtFromDate,iDuration) | Devuelve la fecha final dada una fecha de inicio; este cálculo es completado mediante la adición de minutos (iDuration) y basado en el esquema de horario de trabajo y festivos configurados para el usuario (idUser). Ejemplo |
| getSubProcessesId | CHelper.getSubProcessesId(Me) | Devuelve un arreglo con un conjunto de los Id's de los sub procesos del caso actual. |
| getUsersForPosition | CHelper.getUsersForPosition(idPosition) | Devuelve un arreglo con los id de los usuarios con la posición dada. Ejemplo. |
| getUsersForRole | CHelper.getUsersForRole(idRole) | Devuelve un arreglo con los id de los usuarios con el role dado. Ejemplo. |
| getUsersForSkill | CHelper.getUsersForSkill(idSkill) | Devuelve un arreglo con los id de los usuarios con la habilidad dada. Ejemplo. |
| IsEmpty | CHelper.IsEmpty(oValue) | Devuelve true si oValue está vacío; de lo contrario, el método devuelve false. Ejemplo |
| IsNull | CHelper.IsNull(oValue) | Devuelve true si oValue es Nulo (Null); de lo contrario, el método devuelve false. Ejemplo |
| IsWorkingDay | CHelper.IsWorkingDay(Me,tDate) | Función que retorna verdadero si la fecha especificada (dtDate) cae en una fecha que es laboral (de lo contrario retorna falso). Éste cálculo considera el esquema de horario de trabajo y festivos configurados para la organización. Ejemplo |
| IsWorkingDayForUser | CHelper.IsWorkingDayForUser(idUser, tDate) | Función que retorna verdadero si la fecha especificada (dtDate) cae en una fecha que es laboral (de lo contrario retorna falso). Éste cálculo considera el esquema de horario de trabajo y festivos configurados para el usuario (idUser). Ejemplo |
| IsWorkingMinute | CHelper.IsWorkingMinute(Me,dtDate) | Función que retorna verdadero si la fecha especificada (dtDate) es un día con hora exacta laboral (de lo contrario retorna falso). Éste cálculo considera el esquema de horario de trabajo y festivos configurados para la organización. Ejemplo |
| IsWorkingMinuteForUser | CHelper.IsWorkingDayForUser(idUser,dtDate) | Función que retorna verdadero si la fecha especificada (dtDate) es un día con hora exacta laboral (de lo contrario retorna falso). Éste cálculo considera el esquema de horario de trabajo y festivos configurados para el usuario (idUser). Ejemplo |
| relateXPathFact | CHelper.relateXPathFact(Me, item, factName) | Permite la identificación de registros desde una entidad maestra sobre la cual múltiples sub procesos intentan ser lanzados. Disponible únicamente en la Edicion Enterprise .NET. |
| resolveVocabulary | CHelper.resolveVocabulary(Me, definitionName) | Obtiene el valor guardado en el vocabulario. Ejemplo 1- Ejemplo 2 |
| sendEmail | CMailer.sendEmail (sMail, iTemplateId, sEntityName, iEntityKey) | Envía una notificación usando la plantilla especificada de mensaje. Disponible únicamente en la Edición Enterprise .NET |
| setAttrib | CHelper.setAttrib(sEntityName,oEntityKey,sAttribName,oAttribValue) | Asigna un valor al atributo dado, de un registro específico. Esta función está también disponible desde el CEntityManager. |
| thereAreOpenProcesses | CHelper.thereAreOpenProcesses(sRadNumber) | Devuelve true cuando los casos son abiertos; de lo contrario, el método devuelve false. |
| ThrowValidationError | CHelper.ThrowValidationError(sMesage) | Despliega un mensaje de excepción personalizado al usuario en el portal de trabajo. Ejemplo |
| trace | CHelper.trace(sFileName, sText) | Crea un archivo de traza con la información para el seguimiento de la ejecución de una regla. Ejemplo |
Artículos Relacionados
- Concepto general de reglas en Bizagi.
- El uso de CEntityManager en reglas avanzadas.
- El módulo de asignación en reglas Bizagi.
- Módulos de validación y otros en reglas Bizagi.
<comments />
