System diagnostics
MapTron 1207 contains built-in diagnostics to aid in the setup and configuration of the locator system. Diagnostics provides access to the brains of the system. The diagnostics log is updated whenever XML data is processed by the locator application. System actions, performance benchmarks, parse errors, warnings, and system information are all recorded in the diagnostics log.
 
Using the diagnostics

Diagnostics is on by default. Diagnostics will remain on unless turned off in the startup XML file. Do not turn off diagnostics until system is fully configured.

The file diagnostics.htm contained in the product package is used to view the system's diagnostics log. Make sure this file is installed. The diagnostics web page contains other features to help search for problems, send XML to the application, and manage the system's diagnostics.

Once the diagnostics.htm page loads in the browser window, the contents of the diagnostics log is acquired and displayed in the text area. It may be necessary to refresh the contents after the locator application loads additional XML data.

The diagnostics log is sequential and each line identified by a timestamp. The log describes procedures executed by the locator application after XML is loaded and parsed. Any errors or warnings are logged and can be isolated for inspection.

The diagnostics page also allows sending XML instructions to the locator application. This feature may be used to dump system information, view loaded locations, and testing of the locator application. The page contains a text area to enter XML and a button to send the data to the application. The diagnostics log is automatically refreshed every time the send button is pressed.

 
Recording data into the diagnostics log

Sometimes its helpful to be able to insert information (text or comments) into XML data and view it in the diagnostics log when the XML is parsed and processed by the locator. This feature can be used to determine when XML is processed, what order, and to help isolate problems.

Recording text into the log is accomplished with the <log> tag as shown in figure 5.1a. The <log> tag may be inserted into any XML file or used in the diagnostics.htm page to send XML to the application. Table 5.1b details the use of the option attribute within the <log> tag. Log options are described in the notes.

<log>This comment will be recorded</log>

<log option="SYS_INFO" />

<log option="DUMP_LOCATIONS" />
Fig 5.1a Using the <log> tag
 
MT1207 Application <log>
AttributeValues / Range Default 1 Notes
option SYS_INFO
CLEAR
DUMP_LOCATIONS		   2, 3, 4
Notes
  1. Default value persists if attribute is omitted from tag.
  2. SYS_INFO dumps the system information regarding the loading of locations.
  3. CLEAR will remove all the contents of the diagnostics log. An empty
    <log /> tag will also clear the diagnostics.
  4. DUMP_LOCATIONS displays all locations loaded into the system. This is useful when optimizing locations.
Table 5.1b Tag Reference
 
Turning off the diagnostics
Diagnostics should be turned off once the system is completely configured and operational. Disabling the diagnostics will improve system performance. See section 3.3 for instructions to turn off diagnostics with the <prefs> tag.