Configuración de Traces

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Bizagi Studio > Interfaz de Bizagi Studio en detalle > Ajustes avanzados > Configuración >

Configuración de Traces

Introducción

Durante la automatización de procesos, hay situaciones en las que es necesario crear trazas o depurar la ejecución. Bizagi ofrece la posibilidad de crear trazas de errores en los flujo de los Procesos (para su control y diagnóstico) para que pueda validar si las reglas de negocio, validaciones, invocaciones de interfaces o incluso el Proceso necesita ser corregido.

 

¿Cómo funciona el rastreo?

Las trazas monitorean el proyecto en varios niveles, como el proceso y sus actividades, las reglas de negocio, las validaciones y las políticas de negocio, las invocaciones de interfaces y los controles de formularios.

 

Bizagi ofrece capacidades de rastreo en diferentes niveles:

Nivel de ambiente

Nivel de servidor

 

Trazas a nivel del ambiente

Para activar y configurar las trazas, 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.

 

note_pin

Adicional al detalle del trace, se recomienda revisar los eventos y logs de su servidor. Estos logs lo ayudarán a encontrar el detalle del error cuando se encuentre depurando su proceso.

 

1. Reconocer qué Traces activar

Para habilitar los Traces en una fase de automatización, utilice la opción Tracing desde Bizagi Studio:

 

tracing00_bas

 

Para aprender cómo activar las trazas en sus ambientes de Automation Service, haga clic acá.

 

note_pin

Tenga en cuenta que la función de Traces para el uso de troubleshooting (debug) está orientada principalmente al entorno de desarrollo.

Es 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:

 

WSTrace_all

 

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 Solicitud 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.

Bizagi API / SOA / Manejador de entidades

Registra cuando se invoca un método web de EntityManagerSOA. Esta opción rastrea peticiones y respuestas.

 

Hay tres archivos de registros impresos:

 

BizagiAPI_SOA_EntityManager[TimeStamp].log

Muestra el método de la capa soa ejecutado.

 

BizagiAPI_SOA_EntityManager_Request[TimeStamp].log

Muestra las entradas cuando se ejecutó el método.

 

BizagiAPI_SOA_EntityManager_Response[TimeStamp].log

Muestra la respuesta de la ejecución del método.

Bizagi API / SOA / Workflow engine

Registra cuando se invoca un método web de WorkflowEngineSOA. Esta opción rastrea peticiones y respuestas.

 

Hay tres archivos de registros impresos:

 

BizagiAPI_SOA_WorkFlowManager[TimeStamp].log

Muestra el método de la capa soa ejecutado.

 

BizagiAPI_SOA_WorkFlowManager_Request[TimeStamp].log

Muestra las entradas cuando se ejecutó el método.

 

BizagiAPI_SOA_WorkFlowManager_Response[TimeStamp].log

Muestra la respuesta de la ejecución del método.

Bizagi API / SOA / Consulta

Registra cuando se invoca un método web de QuerySOA. Esta opción rastrea peticiones y respuestas.

 

Hay tres archivos de registros impresos:

 

BizagiAPI_SOA_QueryManager[TimeStamp].log

Muestra el método de la capa soa ejecutado.

 

BizagiAPI_SOA_QueryManager_Request[TimeStamp].log

Muestra las entradas cuando se ejecutó el método.

 

BizagiAPI_SOA_QueryManager_Response[TimeStamp].log

Muestra la respuesta de la ejecución del método.

Conectores / Conectores WS

Registra cuando una interfaz externa se invoca. Rastrea las peticiones y respuestas.

Para más información sobre los Traces para la invocación de servicios web, consulte los Traces para el WS Connector.

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.  Para más información sobre como los Traces para la invocación de los conectores externos, consulte trazas de conectores.

Conectores / SAP Cloud Platform

Registra cuando el conector SAP Cloud Connector se invoca. Rastrea los parámetros de entradas y salidas.

Para más información sobre los Traces para la invocación SAP, consulte los Traces para SAP.

Conectores / SAP

Registra cuando una BAPI de SAP se invoca. Rastrea los parámetros de entradas y salidas.

Para más información sobre los Traces para la invocación de BAPIs de SAP, consulte los Traces para SAP.

Conectores / Connectors.FormsRecogizer

Registra cuando se ejecuta el Conector Form Recognizer. Refierase a Form Recognizer. Esta opción rastrea Inputs, Outputs y la transformación de los datos del conector.

ECM

Registra la integración con sistemas de ECM.

Para más información sobre los traces de la integración con ECM, consulte traces para ECM.

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.

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 . Para más información consulte a Validar mis reglas de negocio.

Renderizador

Registra la construcción Formas en el Portal de Trabajo (y sus campos).

Replicación de datos

Estos registros se registran cada vez que se inicia y finaliza un esquema de replicación. Consulte Replicación. Debido a que el Programador ejecuta replicaciones, estos registros se encuentran con la siguiente estructura:

 

BATrace_Scheduler_ [marca de tiempo] .log

RPA

Registra cuando una acción de robot es ejecutada. Esta opción rastrea entradas, salidas, transformación de los datos y los intentos de la ejecución del robot. Refierase a traces para RPA.

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.

 

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

 

tracing02_step2

 

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 servidor Bizagi (p.ej. IISreset en IIS).

 

Ubicación de los Traces

Una vez activados, los Traces se guardan como archivos de texto sin formato en el servidor Bizagi.

Estos estarán ubicados en una ruta diferente, de acuerdo con el servidor web específico y la aplicación utilizada como servidor Bizagi.

 

ELEMENTO

UBICACIÓN

Autenticación

C:\Bizagi\Projects\[project_name]\Trace\

Replicación de Datos

Entity manager

LDAP

Render (Control)

Reglas y expresiones

Scheduler

Workflow

Bizagi API - SOA - Manejador de entidades

C:\Bizagi\Projects\[project_name]\Temporary\BizagApi\SOA

Bizagi API - SOA - Workflow Engine

Bizagi API - SOA - Consulta

Conectores - Conector WS

C:\Bizagi\Projects\[project_name]\Temporary\SOA\

 

Para las interfaces SOA asíncronas configuradas para reintentar en caso de error, los traces de cada reintento se ubicarán en:

 

C:\Bizagi\Projects\[project_name]\Temporary\Scheduler\SOA\

Conectores - SAP

C:\Bizagi\Projects\[project_name]\Temporary\SAP\

Conectores - Conectores externos

Deja cuatro archivos .log:

Logs del Conector

[Nombre_Conector].[Nombre_Conector].log almacena todos los comandos LOG encontrados durante la ejecución de la lógica del conector. Más información sobre estos comandos se puede encontrar en este artículo.

Logs del servicio

bz-facade.log almacena el historial de métodos invocados por el servicio de conector.

facade-exceptions.log Almacena los errores provocados por funciones asíncronas. Por ejemplo, error en la devolución de llamada de una solicitud REST.

[Nombre_Conector]-bz-ctrl.log almacena los registros del controlador de servicio del conector.

Tenga en cuenta que la fecha y hora es yyyyMMddHHmm.

Conectores - SAP Cloud Platform

C:\Bizagi\Projects\[project_name\Temporary\SAPCloudPlatform\

Conectores / Connectors.FormsRecogizer

C:\Bizagi\Projects\[project_name]\Temporary\FormsRecognizer\

ECM

C:\Bizagi\Projects\[project_name\Temporary\ECM\

RPA

Logs de entradas y salidas:

C:\Bizagi\Projects\[nombre_proyecto]\Temporary\Rpa\

 

Log de la ejecución del robot:

C:\Bizagi\Projects\[nombre_proyecto]\Trace\

 

Trazas a nivel del servidor

Cuando Bizagi Studio o Automation se ejecuta en un servidor local, Bizagi registra algunos eventos de los diferentes componentes de un proyecto de Bizagi, tales como:

Portal de trabajo (aplicación web)

Scheduler

 

Los rastreos del servidor se encuentran en la carpeta de instalación de Bizagi. Normalmente se encuentra en: C:\Bizagi\Trace

 

Trace 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:

 

BATrace_Web

 

Trace del Scheduler  

El servicio del Scheduler 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:

 

BATrace_Scheduler

 

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 envía 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:

 

SAML_authtrace