Error control and diagnostics

<< Click to Display Table of Contents >>

Navigation:  Automation Service Management > Management Console Web > Management console RDP >

Error control and diagnostics

applies_enterprise

Overview

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

 

Bizagi Management Console RDP lets you trace errors in the Processes workflows (for their control and diagnosis) so administrators can determine whether the business rules, validations, interfaces invocations, or even the Process needs to be adjusted.

 

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

 

MC_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 information when processes are not working as expected.

 

note_pin

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

Bizagi will write event logs at the Server, and you can review them with 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, you can to track the entire Process and the objects and components that make up the Work Portal.

 

When you 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. Decide which traces to enable (from the different objects and components).

2. Define their trace detail.

 

note_pin

In addition to the trace detail, we also recommend viewing the events and errors logs of your server. This logs will help you find error details when you are debugging your processes.

 

1. Decide which traces to enable

You enable the traces in a Test or Production environment from the Management Console.

 

tracing01_mc

 

note_pin

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 without testing. For this scenario, it can be useful to enable the traces in the Production environment to help detect unplanned behaviors.

 

Click the Tracing configuration icon to see these objects and components:

 

tracing02_step2

 

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

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

 

ELEMENT

DESCRIPTION

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.

EntityManager

Logs the EntityManager activity (database access).

LDAP

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

Render (Control)

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

Rules

Logs the execution and evaluation of business rules and policies.

 

When the Custom sub-item is selected, it logs user-defined traces which are manually included in Business Rules (by using the CHelper.trace function).

Scheduler

Logs execution of the Scheduler's jobs.

Workflow

Logs when a transaction begins, when 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 assignment rules execution as well.

 

The following image illustrates all available traces in Bizagi:

 

WSTrace_all_a

 

2. Defining the trace detail

To decide what alerts to trace, and to what level of detail, in the selected Tracing option in the Standard Menu, click the trace type and define its detail level (Error, Warning, All).

 

tracing02_step2

 

By default, None is selected and an empty box appears for each trace object/component.

 

When Error is selected, the trace file only logs errors.

When Warning is selected, the trace file logs both warnings and errors.

When All is selected, the trace file logs warnings, errors and step-by-step information about the executed commands.

 

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.

 

Traces

For now, whenever you need to check your traces, refer to Tracing.