Tracing configuration

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi Studio user interface explained > Advanced settings >

Tracing configuration


During the automation of processes, there are situations where execution needs to be traced, or debugged.


Bizagi offers the possibility to trace errors in the Processes Workflows (for their control and diagnose) so that you can validate if the business rules, validations, interfaces invocations, or even the Process needs to be tuned up.


For a project's error control and diagnostic options, Bizagi presents its Tracing Configuration.

This is a powerful option to aid in the understanding and detection of those behaviors that require adjustment, or to make sure that the Process works as expected (while testing).

Note that traces should not be left enabled and should only be turned on to gather detail when processes are not working as expected.


How does tracing work?

Traces monitor the Process at various levels, such as: the Process and its Activities, the business rules, validations and business policies, interfaces invocations, and forms controls.

In other words, it is possible to track the entire Process and the objects and components that make up the Work Portal.


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 either if you are using WebSphere, Weblogic, JBoss or IIS. 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 through the Tracing option:






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 oriented to 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 these 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:




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.

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 Import and Export parameters.

For more information about tracing SAP BAPI 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.


Logs the execution of EntityManager activity (database access).


Logs the execution of the scheduled synchronization of LDAP users into Bizagi.

Render (Control)

Logs the construction of a form in the Work Portal (rendering forms and their controls).


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


Logs the execution of the Scheduler's jobs.


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.


The following image illustrates all types of traces in Bizagi:



2. Defining the trace detail

In order 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.







Render (Control)





Connectors - WS Connector



For Asynchronous SOA Interfaces configured to retry on fail, the traces of each retry will be located in:



Connectors - SAP


Connectors - External Connectors

Logs for inputs and outputs:



Log for the connectors' framework:


Bizagi's default installation path, which is usually at C:\Program Files\Bizagi\Bizagi Studio


Examples and more information

Refer to the following for examples and detailed information for the most common traces.


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:




Expression traces (Business rules)

For this option, in addition to activating the corresponding trace option and levels, it is also necessary to include a trace command line at each of the Expression's code (business rule) to trace.

This approach will record in a separate log, any customized information that the user wants to trace within the rule.

For more information refer to Validating my business rules.


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:




Connector traces

For more information about tracing Web service invocations, refer to WS Connector traces.

For more information about tracing Connectors invocations, refer to Connector traces.

For more information about tracing SAP BAPI invocations, refer to SAP traces.