Status Messages from the Gateway Processing
- Last UpdatedMay 12, 2025
- 5 minute read
The log file contains all information, warnings, and errors relevant to a project’s processing of source data. However, this is often not a convenient format for you to assess whether the processing has proceeded as expected. A better way to monitor the status of a Gateway's processing is to use an additional option for generating a JavaScript Object Notation (JSON) report file.
This option is controlled by the project setting in the selected section of the Gateway (this option is set to false by default).
<GenerateCategorizedLog>true</GenerateCategorizedLog>
When set to true:
-
A JSON report file is written in the same location as the log file. The level of detail in the JSON report file depends on the project settings except that messages with level 'Verbose' are never added to the JSON report file.
-
If the Gateway process fails, then an additional JSON error report file containing details of the process and the error message is written in the same location, named "<InputFileName>_Error.json".
The JSON report contains headers with general information as listed below:
|
Field |
Value Example |
Description |
|---|---|---|
|
"Product" |
"AVEVA Components Reporting Utility" |
Reporter program name. |
|
"ReportingVersion" |
"X.X.X.X" |
Reporter program version. |
|
"ReportedProduct" |
"AVEVA Gateway for 2D Data" |
Gateway name. |
|
"ReportedProductVersion" |
"Y.Y.Y.Y" |
Gateway version number. |
|
"StartDateTime" |
"06-02-2020 19 06 43" |
Processing start time. |
|
"FinishDateTime" |
"06-02-2020 19 06 44" |
Processing end time. |
|
"ElapsedTime" |
"00 00 00 (0.97 seconds)" |
Time of the processing. |
|
"SourceName" |
"Sample.dwg" |
Name of source data. |
|
"SuccessfulObjectsNumber" |
1255 |
Number of successfully processed objects. |
|
"ProcessingResult" |
"Success" |
Overall result of the processing: Success/Failure/Timeout/Canceled |
|
"ProcessingResultNotes" |
"Warnings" |
Additional note about the result of the processing. |
|
"ReturnCode" |
0 |
Numeric code returned from the processing |
|
"Configurations" |
... |
List of configuration files. |
|
"OutputData" |
... |
List of output files. |
|
"Options" |
... |
Additional processing options. |
|
"Reports" |
... |
List of messages (see the following note). |
Note: The ProcessingResult field is set according to the following rules:
-
"Timeout", if processing is broken due to configured timeout and is set to be not reported as error.
-
"Canceled", if processing is broken due to the user’s cancellation.
-
"Failure", if a major error has caused the processing to be terminated early.
The ProcessingResultNotes field is set according to the following rules:
-
"No errors, no warnings", if processing is completed without any errors nor warnings.
-
"Warnings", if processing is completed with warnings.
-
"Minor errors", if processing is completed with errors.
-
"Minor errors, warnings", if processing is completed with minor errors and warnings.
-
"Processing Cancelled", if processing is broken due to the user’s cancellation.
-
"Timeout occurred", if processing is broken due to configured timeout.
-
"Failed in <module name>", if processing failed in specified module.
The ReturnCode field is set according to the exit code returned from the Gateway.
The JSON report then contains one or more status messages:
|
Field |
Value Example |
Description |
|---|---|---|
|
"ID" |
2 |
Number of the message. |
|
"DateTime" |
"06-02-2020 19 06 43" |
Timestamp of the message. |
|
"SubComponent" |
"AutoCAD 2D" |
Gateway's component of the generated message. |
|
"Severity" |
"Warning" |
Severity of the message: Debug/Information/Warning/Error/ErrorProcessingFailed/ErrorCritical. |
|
"Code" |
11644681 |
Unique ID of the message. |
|
"CodeName" |
"WAR_EXT_AUT_B1AF09" |
Unique name of the message. |
|
"Category" |
"Extract" |
Category of the message (see the following table.). |
|
"Message" |
"Could not write "document.csv"." |
Text message. |
|
"Remediation" |
"Check that the output CSV file isn't open in another application." |
Optional remediation |
The following table lists the Categories of the various JSON messages:
|
Category |
Internal Shortcut |
Available in Error JSON with Severity: ErrorProcessing Failed, Error Critical |
Description |
|
AccessError |
ACC |
Yes |
Issues connected with accessing provided location, file, database. |
|
BreakError |
BRE |
Yes |
Break of processing called by timeout when onErrorLevel is set to "Error". |
|
ExtractionError |
EXE |
Yes |
Problem with extracting some source data like wrong item or unrecognized API behaviour. |
|
InitializationError |
INE |
Yes |
Issues connected with initialization of the processing. |
|
InternalGatewayError |
IGE |
Yes |
Issue connected with program's code which is not yet recognized and categorized but protected by try-catch or condition block in specific place of the program. |
|
InvalidConfigError |
IVE |
Yes |
Issue with provided data: input file, configuration, connection string. |
|
LicenseError |
LIE |
Yes |
Issue with validating license. |
|
MissingDataError |
MIE |
Yes |
Expected data required for processing is missing in expected location. |
|
FormatNotSupportedError |
SUE |
Yes |
Limited or no support of source data or configuration item for example version of the document not handled by the program. |
|
TransformerError |
TRE |
Yes |
Issue about one of the transform mapping feature used on processed data. |
|
AccessWarning |
ACW |
No |
Issues connected with accessing provided location, file, database. This issue does not break the processing. |
|
BreakWarning |
BRK |
No |
Break of processing called by user of timeout when onErrorLevel is set to "Warning". |
|
Extraction |
EXT |
No |
Problem with extracting some source data like wrong item or unrecognised API behaviour. This issue does not break the processing. |
|
Information |
INF |
No |
Typical informational official message not connected with bug nor low level processing things. Only for severity Information. |
|
Initialization |
INI |
No |
Issues connected with initialization of the processing not breaking the processing. |
|
Internal |
INT |
No |
Issue connected with program's code which is not yet recognized and categorized but protected by try-catch or condition block in specific place of the program not breaking the processing. |
|
Invalid |
INV |
No |
Issue with provided data: input file, configuration, connection string not breaking the processing. |
|
License |
LIC |
No |
Issue with validating license not breaking the processing. |
|
MissingData |
MIS |
No |
Expected data required for processing is missing in expected location. This issue does not break the processing. |
|
InputResponseError |
RES |
No |
No respond or unexpected answer for the query send by the program. |
|
FormatNotSupported |
SUP |
No |
Limited or no support of source data or configuration item. This issue does not break the processing. |
|
Transformer |
TRA |
No |
Issue about one of the transform mapping feature used on processed data. This issue does not break the processing. |
|
Reformat |
REF |
No |
Automatic adjusting data to expected format during conversion due to output format requirements. |
|
Redundancy |
RED |
No |
Multiple and not necessary items of any type. This issue does not break the processing. |
|
Debug |
DEB |
No |
Low level technical information describing processing details. Only for severity Debug. ETL Gateways - only in debug mode in VS. Legacy Gateways - when logging is set to Debug. |
Notes:
-
"Error" is a type of issue which causes problems during processing but does not break it.
-
"ErrorProcessingFailed" happens only when processing of selected file or data cannot be continued and output is not delivered.
-
"ErrorCritical" happens when the program cannot continue work and no more files or data will be processed.
JSON Report Limitations:
The report is generated during the processing of each input file. Therefore, it does not contain messages connected with issues which arise before the processing of the file has started, for example, use of incorrectly formatted configuration files. In such cases, the message is delivered as a pop-up when in GUI mode or command line messages in case of batch mode. This information is also written to the Summary.txt file in the log folder.