Notifications and Logs

Both logs and notifications inform users of various actions that are taking place in the system and errors that may have occurred. VoiceCheck and VoiceConsole maintain system logs and provide notifications in the user interface.

  • Notifications are messages that the application sends to alert users to various events. These messages can be viewed on the Notifications page, and critical notifications also appear in a colored banner at the top of the interface when they occur. The system can be configured to email critical notifications to specific users.

  • To take responsibility for the resolution of a notification. acknowledge that notification. Other users can see who acknowledged the notification and when it was acknowledged.
  • Logs track user activities in the application and are useful for analyzing unexpected situations or issues. View a list of logs that have been generated by the application on the Logs page, and save a log as a zip (compressed) file.

Server Logs

Two types of logs are generated by Apache Tomcat and displayed in the Logs page. In most cases, you will not need to reference these logs.

The Honeywell-specific logs are preceded by "Vocollect" or "VoiceCheck" or "VoiceConsole." These are the logs typically referenced for troubleshooting. These logs are created using log4j. Learn more about log4j at the following sites:

  • http://logging.apache.org/log4j/2.x/
  • http://www.developer.com/open/article.php/3097221

See the Honeywell VoiceConsole Implementation Guide for details on VoiceConsole log files.

VoiceCheck log

This log is named according to the following naming convention:

VoiceCheck.log.n

where n is the number of the log. The most recent log has no value for n, the next-most recent log has a value of 1 for n, and so on.

The VoiceCheck log contains all information logged according to the logging level set in the log4j configuration file. This level is set to INFO by default, which means it logs all information at a level of INFO or more critical.

VoiceCheck Error Log

This log is a subset of the Honeywell log. It contains all information logged at a level of ERROR or more critical. This log is named according to the following naming convention:

VoiceCheck.err.n

where n is the number of the log.

Logging Levels

Logs can be configured to record activities at one of the following levels, with TRACE being the least critical and FATAL the most critical:

  • TRACE
  • DEBUG
  • INFO
  • WARN
  • ERROR
  • FATAL

Logging configuration files set the logging level and the maximum size for logs. There are two logging configuration files, one for the Honeywell log and error log, and another for the Proxy log.

  • The logging configuration file for the Honeywell log and the Honeywell error log is found here: <installation path>\Honeywell\apache-tomcat-<version>\webapps\VoiceCheck\WEB-INF\classes\log4j.properties

Changing the Logging Level for a Log File

To change the logging level for one of these files, modify the threshold property and the root category. Examples of the affected parameters for each logging configuration file are shown below:

Honeywell Log and Error Log

  • log4j.rootCategory=WARN,voc

This parameter specifies that these logs will report all information at a level of WARN or greater. If you want to view the log files at a lower level, you must change WARN to a lower logging level.

  • log4j.appender.voc.Threshold=INFO
    log4j.logger.com.Honeywell=INFO,voc_err

These parameters specify the logging level for the Vocollect log. It is set to INFO. To log information at a different level in this file, you must change both of these parameters.

  • log4j.appender.voc_err.Threshold=ERROR

This parameter specifies the logging level for the Vocollect error log. It will log information at a level of ERROR.

Changing the Maximum File Size for a Log File

To change the maximum file size for any of the logs, modify the maxFileSize property. An example is shown below:

  • log4j.appender.voc.MaxFileSize=4MB

Change the number of rollover files (files with a .n extension) by changing this parameter:

  • log4j.appender.voc.MaxBackupIndex=30

Device Logs

Enable device logging in the VoiceConsole user interface to help troubleshoot problems and capture logs for Technical Support.

  1. In VoiceConsole, select Device Management > Devices.
  2. Select one or more devices in the table.
  3. Click the Manage devices > Enable logging for selected devices action link.
  4. After the issues have been captured, click the device name to view the device properties.
  5. Export the log file from the View Device page.
  6. Save the file and send it to Technical Support with relevant environment information:
    • Device and headset models
    • Honeywell software versions in use for VoiceCatalyst MI, VoiceConsole, and VoiceCheck
    • Date/time the issue first occurred
    • Frequency of the issue occurring
    • Impacts of the issue
    • Recent changes in the Honeywell Voice Maintenance & Inspection Solution environment

Capture Device Logs

The fastest way to capture device logs for a specific issue is for the technician to speak the "Talkman report problem" command when the problem occurs. The system responds by sending a snapshot of the log file to VoiceConsole. The log can then be exported and sent to Technical Support.

To report a problem in Android, say "I need help" from any point in the application and select Report a Problem.

Reporting a problem sends logs from the device to the server. This includes:

M&I application logs: all files contained in the /sdcard/Vocollect/logs directory. Sub-directories are not included.

Android logs: all files contained in the /storage/IPSM/logger directory.

The /storage/IPSM/logger directory is only available when the device logging is enabled. Enable device logging from the Android device's Settings menu.

View Device Logs

Open the Administration tab and select Logs from the navigation bar.

From the Log Actions list in the navigation bar, View Server Logs, View Device Logs, or Save As Zip.

Clicking server or device logs enables the View Logs list. From here click the name of a log to view that log.