Introducción
Durante las fases de desarrollo de un proyecto (al automatizar los procesos), o en el ambiente de producción, hay ciertos escenarios en los que puede desear para rastrear, o hacer seguimiento a la ejecución de sus procesos (también para depurar).
Bizagi ofrece la posibilidad de hacer rastreo de los errores en los flujos de procesos (para su control y diagnóstico), de modo que los administradores puedan validar si las reglas del negocio, validaciones, invocaciones interfaces, o incluso el proceso necesita ser afinado.
Configuración de Traces
Para el control de errores de un proyecto, Bizagi presenta su configuración de Rastreo o Traces.
Esta es una opción poderosa para ayudar a la comprensión y la detección de aquellos comportamientos que requieren un ajuste, o para garantizar que el proceso funcione como se espera (durante las pruebas).
Tenga en cuenta que los traces no deben dejarse habilitados todo el tiempo, y que por el contrario se recomienda que se habiliten solo temporalmente para obtener detalle adicional cuando se detecta que los procesos no se comportan como se espera.
|
Además de la posibilidad de consultar Bizagi traces, también se puede revisar el log del Servidor para Automation Server. En sistemas operativos Windows, Bizagi registrará logs de eventos en el Servidor (los cuales pueden revisarse en el Visor de eventos). |
¿Cómo funcionan los traces?
Los Traces supervisan el proceso en varios niveles, tales como: el proceso y actividades, las reglas de negocio, validaciones y políticas de negocio, invocaciones interfaces y Formas (con sus campos).
En otras palabras, es posible realizar el seguimiento de todo el proceso y sus objetos / componentes que hacen parte del Portal de Trabajo.
Para activar y configurar los Traces, puede habilitar cada objeto / componente por separado y establecer un filtro para que los registros generados incluyan ciertos niveles de detalle (por ejemplo, las advertencias y los errores, o errores solamente).
Los pasos para esto son:
1. Reconocer cuales son los Traces que se deben activar (de los distintos objetos y componentes).
2. Definir sus detalles del Trace.
|
Adicional al detalle del trace, se recomienda revisar los eventos y logs de su servidor, ya sea para WebSphere, Weblogic, JBoss o IIS. Estos logs lo ayudarán a encontrar el detalle del error cuando se encuentre depurando su proceso. |
1. Reconocer qué Traces activar
La habilitación de Traces se realiza desde el Management Console (para un ambiente de pruebas o producción).
|
Tenga en cuenta que la función de Traces para el uso de troubleshooting (debug) está orientada principalmente al entorno de desarrollo. Es muy recomendable aprovechar esta característica mientras se realizan las pruebas de los procesos a fin de que en el entorno de producción sólo las utilice si es estrictamente necesario. Por ejemplo, cuando un servicio Web externo ha cambiado y no hubo consideraciones a este cambio frente a la configuración en Bizagi, puede ser útil habilitar los Traces en el ambiente de producción para ayudar a detectar comportamientos no deseados. |
Al abrir la ventana de configuración de rastreo (Traces) ya sea desde Bizagi Studio o desde el Management Console verá los objetos y componentes disponibles:
Es importante reconocer y planificar qué Traces desea habilitar.
La siguiente tabla describe las posibilidades:
ELEMENTO |
DESCRIPCIÓN |
|---|---|
Autenticación |
Registra cuando un usuario se está autenticando en el Sistema (Petición de Usuario) y cuando el Sistema revisa automáticamente las Solicitudes de Sesión (Validación de Solictud de Sesión). Todos los detalles incluyendo fecha, nivel, nombre de la traza, tipo y sub-tipo de la traza, tipo y sub-tipo de la autenticación y mensaje, son añadidos al archivo de texto. |
Conectores / WS Connector |
Registra cuando una interfaz externa se invoca. Rastrea las peticiones y respuestas. Para más información sobre como los Traces para la invocación de interfaces, consulte Diagnóstico y control de errores para servicios Web. Diagnostico de los errores en los servicos Web. |
Conectores / SAP |
Registra cuando una BAPI de SAP se invoca. Rastrea los parámetros de Importación y Exportación. Para más información sobre como los Traces para la invocación de interfaces, consulte Diagnóstico y control de errores para BAPIs de SAP. Diagnostico de los errores de SAP. |
Conectores / Conectores Externos |
Registra cuando una Acción de Conector es ejecutada. Esta opción rastrea Inputs, Outputs, transformación de los datos y lógica del Conector. |
EntityManager |
Registra la ejecución de EntityManager (acceso de base de datos). |
LDAP |
Registra la ejecución de la sincronización programada de usuarios de LDAP en Bizagi. |
Render |
Registra la construcción Formas en el Portal de Trabajo (y sus campos). |
Reglas y expresiones |
Registra la ejecución y la evaluación de las reglas de negocio y políticas. Los Traces en reglas son personalizados use la función CHelper.trace |
Scheduler |
Registra la ejecución de los trabajos programados. |
Workflow |
Registra cuando comienza una transacción, cuando la información se guarda en la base de datos, cuando un caso se crea y la ejecución de cada elemento.
Cuando la asignación está seleccionada, registra la ejecución de reglas de asignación. |
La imagen a continuación presenta la totalidad de traces disponibles de Bizagi:
2. Definir el detalle de los Traces
Con el fin de decidir lo se desea rastrear (el nivel de detalle), en la opción seleccionada en el menú de rastreo, haga clic en el tipo de rastreo y defina el nivel de detalle (Error, Advertencia, todo).
Por defecto está seleccionado Apagado (una caja vacía se muestra) para todos los objetos / componentes.
Cuando Error es seleccionado, el archivo de rastreo sólo registra los errores.
Cuando Advertencia se selecciona, el archivo de rastreo rastreará advertencias y errores.
Cuando Todo está seleccionado, el archivo de rastreo registrará: advertencias, errores y paso a paso la información sobre los comandos ejecutados.
Tenga en cuenta que puede seleccionar cada tipo de rastreo (y sus subtipos) y seleccionar una configuración de detalle de seguimiento para cada uno.
Después de guardar los cambios en estos elementos, debe reiniciar el servicio de su Portal de Trabajo (p.ej. IISreset en IIS).
Ubicación de los Traces
Una vez activado, los Traces se guardan como archivos de texto sin formato en el servidor de Bizagi.
Ellos estarán ubicados en una ruta diferente, de acuerdo con la plataforma y el componente de Bizagi.
ELEMENTO |
UBICACIÓN |
|---|---|
Authentication |
C:\Bizagi\Projects\[project_name]\Trace\ |
EntityManager |
|
LDAP |
|
Render (Control) |
|
Rules |
|
Scheduler |
|
Workflow |
|
Connectors / WS Connector |
C:\Bizagi\Projects\[project_name]\Temporary\SOA\
Para las interfaces SOA asíncronas configuradas para reintentar en caso de error, los rastros de cada reintento se ubicarán en:
C:\Bizagi\Projects\[project_name]\Temporary\Scheduler\SOA\ |
Connectors / SAP |
C:\Bizagi\Projects\[project_name]\Temporary\SAP\ |
Connectors - External Connectors |
Logs de entradas y salidas: C:\Bizagi\Projects\[project_name]\Temporary\Connectors\
Logs del frmawork del conector: [Ruta_instalación_Bizagi]\ConnectorsService\framework\Logs\Connectors\[project_name]\ La ruta de instalación de Bizagi normalmente se encuentra en C:\Program Files\Bizagi\Bizagi Studio |
Ejemplos y mayor información
Como se describió anteriormente, hay más de 1 tipo de objeto / componente para rastrear.
Lo siguiente describe los Traces más comúnmente usados.
Traces del Portal de Trabajo
El Portal de Trabajo graba unos logs con el detalle sobre lo que se ejecuta a nivel de aplicación (Web).
Estos logs se encuentran en la carpeta .\Trace como un archivo llamado BATrace_Web_[fecha].log.
El siguiente ejemplo ilustra la información que se graba en estos archivos:
Traces del Scheduler (Programador)
El servicio programador graba unos logs con el detalle sobre lo que ejecuta de manera offline.
Estos logs se encuentran en la carpeta .\Trace como un archivo llamado BATrace_Scheduler_[fecha].log.
El siguiente ejemplo ilustra la información que se graba en estos archivos:
Traces en Expresiones (reglas de negocio)
Para esta opción, además de activar la opción de rastreo correspondiente y sus niveles, también es necesario incluir una línea de comando de seguimiento en el código de la expresión (reglas de negocio) que se desea rastrear.
Este enfoque generará un registro separado, para cualquier información que el usuario desea rastrear.
Para más información, consulte Validar mi regla de negocio.
Traces de autenticación
Cuando se integra un proveedor de identidad compatible con SAML para que Bizagi le delegue la autenticación, el detalle de traces incluye:
•USERREQUEST: Provee un mensaje que aplica al momento en que Bizagi envia la información al proveedor de identidad (acerca de la solicitud hecha por el usuario para autenticarse).
•VALIDATESESSIONREQUEST: Provee un mensaje que aplica al momento en que Bizagi recibe una respuesta del proveedor de identidad.
La siguiente imagen ilustra un ejemplo de traces de autenticación:
Traces en interfaces
•Para más información sobrecomo funcionan los Traces para la invocación de interfaces Web, consulte Diagnostico de los errores en los servicos Web.
•Para más información sobrecomo funcionan los Traces para la invocación de SAP, consulte Diagnostico de los errores de SAP
•Para más información sobrecomo funcionan los Traces para la invocación de conectores, consulte Diagnostico de los errores de los Conectores.