Pay Tray Application Logging

If you are experiencing issues, turning on logging or opening the debug window will allow the tray app to capture technical information. This information can be used for debugging and troubleshooting purposes.

Important Notes

To use this feature:

• You must be using version 2.1 or higher
• You can only log new transactions (logging is not retroactive)
• You can create one log file that will be created per day. Each logged event will be concatenated to the file.
• You can view these files in Notepad or any text editor.
• You can always get to the log folder by right-clicking the icon in the Windows tray and selecting "View Logs" 

Tray App Version 2.1 to 2.4

• If using this version of the tray app:
  • You must have administrator privileges. This is because the logs are written to the root of the installation directory which is defaulted to C:\Program Files (x86)\CivicPlus.
  • You can find logs in the root of your installation directory. For example: C:\Program Files (x86)\CivicPlus\CpPay Tray App\logs

Tray App Version 2.5 and Higher 

• Log files are written to your local app data directory and you no longer need administrator privileges.  
  • The directory may be similar to C:\Users\{username of logged in user}\AppData\Local\CivicPlus\Pay Tray App\logs
• Each user's logs will go to their own log folder. Logs are not shared across users.
• If you turn off logging, you will be asked if you want to destroy (delete) the files. If you select this option, the logs will not be recoverable. We recommend always deleting log files that are no longer needed. We will delete all files that follow our naming convention. Log files that were renamed will not be deleted.

Turn on Logging

1. Right-click on the Pay Tray App icon in your Windows Tray
   
2. Select Settings
   
3. Open the General section and change AllowLogging from False to True
   
   
   Note: If you get this message, you will need to run with administrator privileges. See the note at the top of this article.