Error control and diagnostics

<< Click to Display Table of Contents >>

Navigation:  Bizagi PaaS Management > Management console >

Error control and diagnostics



In the production environment, there are situations where execution needs to be traced, or debugged.


Bizagi Management Console offers the possibility to trace errors in the Processes workflows (for their control and diagnose) so that administrators can determine whether the business rules, validations, interfaces invocations, or even the Process needs to be retuned.


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




This is a powerful option that aids in the understanding and detection of issues that require adjustment, and ensures 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.



In addition to Bizagi traces, you can also take a look at your Server's log when using Bizagi Engine.


Bizagi will write event logs at the Server, which can be looked at via the event viewer.


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 can enable each object/component separately and set a filter so that the generated logs include different 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, we also recommend viewing 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 in a Test or Production environment is done from the Management Console.





The trace feature for debugging purposes (e.g. traces for expressions) is mainly oriented to the Development environment.

We strongly recommend exploiting this feature while testing the Processes so that in the Production environment this will only be 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:




It is important to acknowledge and plan which traces you wish to enable.

The following table describes the possibilities regarding these objects and components:




Connectors / WS Connector

Logs when an external interface is invoked. This option traces requests and responses.

Connectors / External Connectors

Logs when a Connector Action is executed. This option traces Inputs, Outputs, data transformation and the 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 to trace, and to what level of 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 and 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.


Please note that you can select each trace type (and its subtypes) and select a trace detail configuration for each.


After saving changes to these items, you may need to restart your Work Portal service.



For now, whenever you need to check your traces please contact us trough our support platform and create a ticket requesting said traces.