Form Recognizer traces

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi Studio user interface explained > Advanced settings > Configuration > Tracing configuration >

Form Recognizer traces

Overview

When configuring the Form Recognizer connector in Bizagi, you may rely on several features for error control and diagnostics.

One of these features is the use of traces whenever you detect there is an issue with the execution of the connector, and you wish to retrieve further detail.

 

Form Recognizer connector traces

Whenever you are debugging a Form Recognizer connector execution (in Development environments) or whenever you wish to retrieve further detail about a failed execution, you may choose to turn on the Connectors.FormsRecognizer traces.

 

The Form Recognizer traces are located in the following folder: C:\Bizagi\Projects\[Project_Name]\Temporary\FormsRecognizer\

 

Form_Recognizer_trace_01

 

note_pin

Keep in mind that Form Recognizer traces can be enabled anytime, but it is strongly recommended to enable them temporarily only when needed (and afterward, disable them).

Changes in this configuration will most likely require a reset in your Bizagi server's services.

 

Enabling these traces is useful to track down, after an error in the application, the exact point where said error has happened. There are four points where detail is logged and you may diagnose if there is a problem when executing your Form Recognizer connector, or whenever transformations were being applied to the information.

 

Types of traces

The following traces are logged with a chronological order, as detailed in the table below.

 

Chronological order

Trace type

Description

1

Import

Leaves a JSON file with the inputs sent to the Form Recognizer connector before the execution of its logic.

Its name has the following convention:

[timestamp]_forms-recognizer_IN0_[case_identifier]_[action name].json

Note that timestamp is set as yyyyMMddHHmmss.

2

Import transformed

Leaves a JSON file with the inputs sent to the Form Recognizer connector after the execution of its logic.

Its name has the following convention:

[timestamp]_forms-recognizer_IN1_[case_identifier]_[action name].json

Note that timestamp is set as yyyyMMddHHmmss.

3

Export

Leaves a JSON file with the outputs received from the external system before any transformation done by Bizagi.

Its name has the following convention:

[timestamp]_forms-recognizer_OU0_[case_identifier]_[action name].json

Note that timestamp is set as yyyyMMddHHmmss.

4

Export transformed

Leaves a JSON file with the outputs received from the external system after all transformations done by Bizagi.

Its name has the following convention:

[timestamp]_forms-recognizer_OU1_[case_identifier]_[action name].json

Note that timestamp is set as yyyyMMddHHmmss.

 

The following images show an example of the generated log files.

 

Import

 

Form_Recognizer_trace_02

 

Export

 

Form_Recognizer_trace_03

 

Export transformed

 

Form_Recognizer_trace_04