Overview
During the automation of processes, there are situations where the execution needs to be traced or debugged. Bizagi offers the possibility to trace errors in the Processes Work flows (for their control and diagnosis) so that you can validate if the business rules, validations, interfaces invocations, or even the Process needs to be tuned up.
How does tracing work?
Traces monitor the project at various levels, such as the process and its activities, the business rules, validations and business policies, interface invocations, and forms controls.
Bizagi offers tracing capabilities at different levels:
Traces at the environment level
To enable and configure tracing, you may enable each object/component separately and set a filter so that the generated logs include levels of detail (e.g. warnings and errors, or errors only).
The steps to accomplish this are:
1. Acknowledging which traces to enable (from the different objects and components).
2. Defining their trace detail.
|
In addition to the trace detail, it is also recommended to view the events and log of your server. This logs will help you to find error detail whenever you are debugging your processes. |
1. Acknowledging which traces to enable
Enabling the traces for the automation stages of the project is done from Bizagi Studio or the Management Console through the Tracing option:
To learn how to activate traces in your Automation Services environments, click here.
|
Even though the trace feature is available for all environments, it should be used mainly for debugging purposes (e.g traces for expressions) is mainly intended for the Development environment. It is strongly recommended to exploit this feature while testing the Processes so that in the Production environment this is only required if strictly necessary. For example, when an external web service has changed and no considerations were taken for this scenario, it can be useful to enable the traces in the Production environment to help detect unplanned behaviors. |
Once you click on the Tracing configuration window, you will see the objects and components available:
It is important to acknowledge and plan which traces you wish to enable.
The following table describes the possibilities regarding these objects and components:
ELEMENT |
DESCRIPTION |
|---|---|
Authentication |
Logs when a user is being authenticated in the System (User Request) and when the System is automatically validating a Request Session (Validation of Request Session). All the details such as date, level, trace name, trace type and sub-type, type and sub-type of authentication and message, will be added in the log file. |
Bizagi API / SOA / Entity manager |
Logs when an EntityManagerSOA web method is invoked. This option traces requests and responses.
There are three log files printed:
BizagiAPI_SOA_EntityManager[TimeStamp].log Prints the method of the SOA layer executed.
BizagiAPI_SOA_EntityManager_Request[TimeStamp].log Prints the input when executing the method.
BizagiAPI_SOA_EntityManager_Response[TimeStamp].log Prints the response of the method. |
Bizagi API / SOA / Workflow Engine |
Logs when a WorkflowEngineSOA web method is invoked. This option traces requests and responses.
There are three log files printed:
BizagiAPI_SOA_WorkFlowManager[TimeStamp].log Prints the method executed.
BizagiAPI_SOA_WorkFlowManager_Request[TimeStamp].log Prints the input when executing the method.
BizagiAPI_SOA_WorkFlowManager_Response[TimeStamp].log Prints the response of the method. |
Bizagi API / SOA / Query |
Logs when a QuerySOA web method is invoked. This option traces requests and responses.
There are three log files printed:
BizagiAPI_SOA_QueryManager[TimeStamp].log Prints the method executed.
BizagiAPI_SOA_QueryManager_Request[TimeStamp].log Prints the input when executing the method.
BizagiAPI_SOA_QueryManager_Response[TimeStamp].log Prints the response of the method. |
Connectors / WS Connector |
Logs when an external interface is invoked. This option traces requests and responses. For more information about tracing Web service invocations, refer to WS Connector traces. |
Connectors / SAP |
Logs when an SAP BAPI is invoked. This option traces inputs and outputs parameters. For more information about tracing SAP invocations, refer to SAP traces. |
Connectors / External Connectors |
Logs when a Connector Action is executed. This option traces Inputs, Outputs, data transformation and connector logic of the Connector. refer to Connector traces. |
Connectors / SAP Cloud Platform |
Logs when the SAP Cloud Connector is invoked. This option traces input and output parameters. For more information about tracing SAP invocations, refer to SAP traces. |
Connectors / Connectors.FormsRecogizer |
Logs when the Forms Recognizer connector is executed. Refer to Form Recognizer. This option traces Inputs, Outputs, and data transformation of the Connector. |
Data replication |
These logs register every time that a replication schema has been started and ended. Refer to Replication. Because the Scheduler executes replications, these logs are found with the following structure:
BATrace_Scheduler_[timeStamp].log |
ECM |
Logs the integration with ECM systems. For more information about tracing ECM integration, refer to ECM traces. |
Entity manager |
Logs the execution of EntityManager activity (database access). |
LDAP |
Logs the execution of the scheduled synchronization of LDAP users into Bizagi. Refer to Importing LDAP users. |
Render (Control) |
Logs the construction of a form in the Work Portal (rendering forms and their controls). |
RPA |
Logs when a RPA bot is invoked. This option traces input and output parameters. For more information about tracing RPA invocations, refer to RPA traces. |
Rules and expressions |
Logs the execution and evaluation of business rules and policies.
When the Custom sub-item is selected, it logs the user-defined traces which are manually included in Business Rules (by using the CHelper.trace function). For more information refer to Validating my business rules. |
Scheduler |
Logs the execution of the Scheduler's jobs. |
Workflow |
Logs when a transaction begins, when the information is saved in the database, when a case is created and the execution of each shape.
When the Assignment sub-item is selected, it logs the assignment rules execution as well. |
2. Defining the trace detail
To decide what alerts exactly to trace (the detail level), in the selected Tracing option in the Standard Menu, click on the trace type and define its detail level (Error, Warning, All).
By default, None is selected (an empty box is shown) for all trace objects/components.
When Error is selected, the trace file will only log errors.
When Warning is selected, the trace file will log both warnings and errors.
When All is selected, the trace file will log: warnings, errors and step-by-step information about the executed commands.
Notice that you may select each trace type (and its subtypes) and select a trace detail configuration for each.
After saving changes on these items, it may be required to restart your Bizagi server's service (e.g. IISreset command in IIS).
Traces location
Once enabled, traces will be saved as plain text files on the Bizagi Server.
They will be located under a different path, according to the specific web and application server used as the Bizagi Server.
ELEMENTS |
LOCATION |
|---|---|
Authentication |
C:\Bizagi\Projects\[project_name]\Trace\ |
Data Replication |
|
Entity manager |
|
LDAP |
|
Render (Control) |
|
Rules and expressions |
|
Scheduler |
|
Workflow |
|
Bizagi API - SOA - Entity manager |
C:\Bizagi\Projects\[project_name]\Temporary\BizagApi\SOA |
Bizagi API - SOA - Workflow Engine |
|
Bizagi API - SOA - Query |
|
Connectors - WS Connector |
C:\Bizagi\Projects\[project_name]\Temporary\SOA\
For Asynchronous SOA Interfaces configured to retry on fail, the traces of each retry will be located in:
C:\Bizagi\Projects\[project_name]\Temporary\Scheduler\SOA\ |
Connectors - SAP |
C:\Bizagi\Projects\[project_name]\Temporary\SAP\ |
Connectors - External Connectors |
Logs for inputs and outputs: C:\Bizagi\Projects\[project_name]\Temporary\Connectors\
Log for the connectors' framework: [Bizagi_installation_path]\ConnectorsService\framework\Logs\Connectors\[project_name]\ Bizagi's default installation path, which is usually at C:\Program Files\Bizagi\Bizagi Studio |
Connectors - SAP Cloud Platform |
C:\Bizagi\Projects\[project_name]\Temporary\SAPCloudPlatform\ |
Connectors - Connectors.FormsRecogizer |
C:\Bizagi\Projects\[project_name]\Temporary\FormsRecognizer\ |
ECM |
C:\Bizagi\Projects\[project_name\Temporary\ECM\ |
RPA |
Logs for inputs and outputs: C:\Bizagi\Projects\[project_name]\Temporary\Rpa\
Log for the robot execution: C:\Bizagi\Projects\[project_name]\Trace\ |
When Bizagi Studio or automation runs on an on-premises server, Bizagi registers some events from the different components of a Bizagi project, such as:
•Work Portal (web application)
•Scheduler
Server traces are located in the Bizagi folder installation. Usually located at: C:\Bizagi\Trace
Work Portal (web application) trace
The Work Portal trace logs the detail executions at the Web application.
These logs are found at the .\Trace folder as split logs named BATrace_Web_[date].log.
The following example illustrates the logged information in these files:
Scheduler trace
The Scheduler trace logs the detail executions carried out by this thread.
These logs are found at the .\Trace folder as split logs named BATrace_Scheduler_[date].log.
The following example illustrates the logged information in these files:
Authentication traces
Whenever you integrate a SAML-compliant Identity provider for Bizagi to delegate authentication to it, logged detail you may rely on, include:
•USERREQUEST: Provides a message applicable to the information sent from Bizagi to the Identity provider (regarding the user's request to log in).
•VALIDATESESSIONREQUEST: Provides a message applicable to the response received by Bizagi, as issued by the Identity provider.
The following image illustrates an example of an authentication tracing file:
