wsw-results

Diagnostics

Introduction

The application is capable of providing diagnostics whilst processing results; info/warning/error messages.

This document provides insight into what the application can handle and the significance of various messages.

There are 3 classes of message written to the console:

Info Messages

Info messages are purely for informational purposes and by default they are suppressed for previous years.

The current list of info messages is relatively short:

Note: Info messages are purely for informational purposes and do not require any follow up activity.

Warning Messages

Since there are so many different warning messages they have been split into “Entrant Details” and “Session Results”.

When a warning is issued it may be important for the details to be corrected in the entrants list, followed by a re-run of the reports.

Entrant Details

There are a number of messages that can be generated when the event contains invalid entrant details.

The event config contains a list of possible values for each attribute, enabling automatic validation and an appropriate fix:

Note: It may be important for the appropriate details to be corrected in the entrants list, followed by a re-run of the reports.

Gold Fleet and Pro Fleet competitors cannot be entered as a “first timer”, formerly known as a “novice”:

Note: It may be desirable for the appropriate details to be corrected in the entrants list, thus eliminating these warnings.

Checks for duplicate entrants or possible errors in the name; similar but not identical to previous years:

Note: It may be required for the appropriate details to be corrected in the entrants list, followed by a re-run of the reports.

An unrecognised nationality will result in the following warning:

Note: It may be desirable for the appropriate details to be corrected in the entrants list, followed by a re-run of the reports.

Session Results

When processing session results the following warnings may be generated:

If the reporting engine encounters results for an unknown craft type it may generate the following warnings:

When processing GPS results the following warnings may be generated:

Note: These warning messages listed above will not prevent results from being generated / published but they should be carefully considered. It may be important for the appropriate details to be corrected in the entrants list, followed by a re-run of the reports.

A number of warnings may be generated for years prior to 2010 but will not occur unless somebody changes the data:

Note: It is not anticipated that warnings relating to sail numbers will occur in the future since all such issues have been fixed.

Error Messages

Editing the application, event or session configuration files may result in a damaged JSON file.

Editing the GPSDATA or RUNDATA files may result in a damaged CSV file.

If an error message is generated then the application will also output the full stack trace to assist in diagnosis of the problem.

The processing will stop if an error occurs but once the issue has been resolved, reporting can re-attempted.