Status Messages from the Gateway Processing
- Last UpdatedDec 20, 2024
- 4 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 3D 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:
-
"Success", if no warnings or errors are detected.
-
"Warnings", if at least one warning is detected but no errors.
-
"Errors", if at least one minor error is detected but none that have halted the processing, for example, one or more objects might have been skipped but the entire source was read and processed.
-
"Failure", if a major error has caused the processing to be terminated early.
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 3D" |
Source 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. |
Categories should be used to scan the report for types of messages that might require further action:
|
Message Category |
Message Description |
|---|---|
|
Access |
Issues connected with accessing provided location, file or database. |
|
Break |
Break of processing caused by a cancellation or a timeout. |
|
Debug |
Low level technical information describing processing details. Only for severity Debug. |
|
Environment |
Issue influenced by system environment such as not enough memory and read only file. |
|
Extract |
Problem with extracting some source data like wrong item or unrecognized API behavior. |
|
Information |
Typical informational message not connected with bug nor low level processing. Only for severity Information. |
|
Initialize |
Issues connected with initialization of the processing. |
|
Internal |
Issues connected with program's code which is not yet recognized and categorized but protected against program crash. |
|
Invalid |
Issues with provided data: input file, configuration, connection string. |
|
MissingData |
Expected data required for processing is missing in expected location. |
|
Overload |
Issue with the amount of data or crossing an allowed range. |
|
Redundancy |
Multiple and not necessary items of any type. |
|
Reformat |
Output data was automatically adjusted to conform with the output format requirement. |
|
Respond |
No response or an unexpected response for the query sent by the program. |
|
Support |
Limited or no support of the type of source data or configuration item. |
|
Transform |
Issue/information about one of the transform mapping features used on processed data. |
|
Unknown |
Can be used for unhandled exceptions like additional protection for native errors thrown by 3rd party libraries. |
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.