Skip to main content

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

Note
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 OrderTrace TypeDescription
1ImportLeaves a JSON file with the inputs sent to the Form Recognizer connector before the execution of its logic.
Name convention: [timestamp]_forms-recognizer_IN0_[case_identifier]_[action name].json
Timestamp format: yyyyMMddHHmmss
2Import TransformedLeaves a JSON file with the inputs sent to the Form Recognizer connector after the execution of its logic.
Name convention: [timestamp]_forms-recognizer_IN1_[case_identifier]_[action name].json
Timestamp format: yyyyMMddHHmmss
3ExportLeaves a JSON file with the outputs received from the external system before any transformation done by Bizagi.
Name convention: [timestamp]_forms-recognizer_OU0_[case_identifier]_[action name].json
Timestamp format: yyyyMMddHHmmss
4Export TransformedLeaves a JSON file with the outputs received from the external system after all transformations done by Bizagi.
Name convention: [timestamp]_forms-recognizer_OU1_[case_identifier]_[action name].json
Timestamp format: yyyyMMddHHmmss

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

Import

Import Example


Export

Export Example


Export Transformed

Export Transformed Example