XA Client Logging

XA Client Logging

PROBLEM/NEED

Depending on the kind of problem you are troubleshooting, logging will need to be enabled for specific XA Client components.

SUMMARY

This document explains how to enable logging for different XA Client troubleshooting situations.

TYPE of TROUBLESHOOTING

1. General XA Troubleshooting
2. Badge Troubleshooting
3. XA Lock and Logoff Troubleshooting
4. Login / Credential Provider Troubleshooting
5. Kiosk-Mode Troubleshooting
6. Connector Troubleshooting
7. SnapAPP Troubleshooting
8. Auditing Troubleshooting
9. Other XA Client Service Troubleshooting

General eXactACCESS File Logging

Most XA Client and Server executable (.exe files) will generate logs based on the settings contained in corresponding .ini files. For instance, to enable logging for xaucm.exe:

1. Open Notepad (or another text editor) as an administrator.
2. Using Notepad, browse to the C:\Program Files (x86)\HealthCast\eXactACCESS folder and open the xaucm.exe.ini file:
3. Set "information=1" in the "debug" section
   1. information=1
4. Save the changes to xaucm.exe.ini.
   NOTE: Some XA executables will recognize the change to their ini file and immediately start logging, while others will need to be restarted before they recognize the change
5. Log files are written to this location and file:
   1. C:\ProgramData\HealthCast\logs
   2. xaucm.txt.debuglog

General XA Troubleshooting

One of the core XA Client components is xaucm.exe (XA User Context Manager). This component manages the communication between the XA Client and XA Server. When its logging is enabled, along with other information it will show:

• When a user logs in and out of XA
• The XA client startup steps
• The list of applications a user has access to

Enable xaucm.exe Logging

1. Open Notepad (or another text editor) as an administrator.
2. Using Notepad, browse to the C:\Program Files (x86)\HealthCast\eXactACCESS folder and open the xaucm.exe.ini file:
3. Set "information=1" in the "debug" section
   1. information=1
4. Save the changes to xaucm.exe.ini
5. Log files are written to this location and file
   NOTE: Some XA executables will recognize the change to their ini file and immediately start logging, while others will need to be restarted before they recognize the change.
   1. C:\ProgramData\HealthCast\logs
   2. xaucm.txt.debuglog

Badge Troubleshooting

Enable hchidscan.exe Logging

The primary executable that connects to badge reader hardware and processes badge events on the end-user workstation is hchidscan.exe. This executable is ran as a service (HCI ProxCard Client Service) so should start automatically when a user logs into Windows. To enable logging for hchidscan.exe:

1. Open Notepad (or another text editor) as an administrator
2. Using Notepad, browse to the C:\Program Files (x86)\HealthCast\eXactACCESS folder and open the hchidscan.exe.ini file:
3. Modify these two settings under the "debug" section
   1. LogFileSizeInMeg=50
      MaxMemoryCacheLogLines=100000

critical=1
information=1
methodEntryExit=0
warning=1

• 
  
  1. NOTE: While changing LogFileSizeInMeg isn't strictly necessary, the hchidscan.exe executable writes to the log file several times per second, and so the log file grows large quickly. Increasing the LogFileSizeInMeg setting to 50 gives you a better chance of capturing a badge tap event.

1. Save the changes to the hchidscan.exe.ini file.
2. Restart the HCI ProxCard Client Service service.
3. Log files are written to  C:\ProgramData\HealthCast\logs\hcidscan.txt.debuglog 

XA Lock and Logoff Troubleshooting

Enable xalock.exe Logging

xaLock.exe is the executable that runs when XA locks (either in Kiosk or Standard User Mode), usually due to a lock timeout. To enable logging for xalock.exe:

1. Open Notepad (or another text editor) as an administrator
2. Using Notepad, browse to the C:\Program Files (x86)\HealthCast\eXactACCESS folder and open the xaLock.exe.ini file:
3. Set "information=1" in the "debug" section
   1. information=1
4. Save the changes to the ini file
5. Log files are written to this location and file (NOTE: Some XA executables will recognize the change to their ini file and immediately start logging, while others will need to be restarted before they recognize the change).
   1. C:\ProgramData\HealthCast\logs
   2. xalock.txt.debuglog

Enable xaloggoff.exe Logging

xaLoggoff.exe is the executable that runs when a user logs out of XA (either in Kiosk or Standard User Mode). To enable logging for xaLogoff.exe:

1. Open Notepad (or another text editor) as an administrator
2. Using Notepad, browse to the C:\Program Files (x86)\HealthCast\eXactACCESS folder and open the xaLoggoff.exe.ini file:
3. Set "information=1" in the "debug" section
   1. information=1
4. Save the changes to the ini file
5. Log files are written to this location and file (NOTE: Some XA executables will recognize the change to their ini file and immediately start logging, while others will need to be restarted before they recognize the change).
   1. C:\ProgramData\HealthCast\logs
   2. xaloggoff.txt.debuglog

Credential Provider Troubleshooting (SUM only)

Credential manager logging can be useful on systems running in Standard User Mode to troubleshoot issues with the login process. XA users a credential provider on SUM systems to capture the user's password to passthrough to applications that need the user's AD password. 

There are two ways to enable Credential Provider logging. Both should be enabled when troubleshooting the Credential Provider:

1. Registry update

[HKLM\SOFTWARE\HealthCast\eXactACCESS\QAW\Settings]
DebugEnabled= 1 (reg_sz)

This will generate a file called "QAW.ProxCardCredProv.log" in the C:\ProgramData\HealthCast directory.

2. Edit the QAW.ProxCardCredProv.ini file (or QAW.ini file, depending on the version of XA) located in the C:\ProgramData\HealthCast directory. When editing the file, you will want to set information=1 in the [debug] section:

information=1 (The default value is "0")

The logs will generate in the following directories:
C:\programdata\healthcast\logs
C:\programdata\healthcast

Kiosk-Mode Troubleshooting

Enable xahid_kiosk.exe Logging

Enable xahid_kiosk.exe logging when troubleshooting issues with XA running in Kiosk Mode. xahid_kiosk.exe logging provides details about the login process, including badge information. To enable logging for xahid_kiosk.exe:

1. Open Notepad (or another text editor) as an administrator
2. Using Notepad, browse to the C:\Program Files (x86)\HealthCast\eXactACCESS folder and open the xahid_kiosk.exe.ini file:
3. Set "information=1" in the "debug" section
   1. information=1
4. Save the changes to the ini file
5. Log files are written to this location and file (NOTE: Some XA executables will recognize the change to their ini file and immediately start logging, while others will need to be restarted before they recognize the change).
   1. C:\ProgramData\HealthCast\logs
   2. XAHID_kiosk.txt.debuglog

Connector Troubleshooting

Enable Individual Connector Logging

Most Connectors enable logging via a setting in their .xml file. To enable logging for a Connector:

1. Open Notepad (or another text editor) as an administrator
2. Browse to the directory where the Connector  executable is located (.e.g xaMyConnector.exe)
3. Open up the associated .xml file (e.g. xaMyConnector.xml) and set the "TraceToFile" setting to True
4. Log files will be saved to the user's individual %appdata%\HealthCast\Connector folder
   1. e.g. xaMyConnector.trace

SnapAPP Troubleshooting

Enable WebSSO Logging

Enable WebSSO logging when troubleshooting issues with web-based SnapAPP applications. To enable logging for WebSSSO:

1. Open Regedit as an administrator
2. Open the [HKEY_LOCAL_MACHINE\SOFTWARE\HealthCast\eXactACCESS\WebSSO] key
3. If it does not already exist, add a new string value EnableLogging and set it to True
   1. EnableLogging = True 
4. Log files will be saved to the user's individual %appdata%\HealthCast\webConnect folder
   1. webConnect.log

Enable WinConnector Logging

Enable WinConnector logging when troubleshooting issues with Windows-based SnapAPP applications. To enable logging for WinConnector:

1. Open Notepad (or another text editor) as an administrator
2. Using Notepad, browse to the C:\Program Files (x86)\HealthCast\eXactACCESS\wrappers\WinConnector folder and open the WinConnector.xml file:
3. Set the "TraceToFile" setting to True
4. Save the changes to the .xml file
5. Log files will be saved to the user's individual %appdata%\HealthCast\WinConnector folder
   1. WinConnector.trace

Auditing Troubleshooting

Enable HCLFOAuditing.exe Logging

Enable HCLFOAuditing.exe logging when troubleshooting issues with auditing from the XA Client, and can help troubleshoot why the Auditing service on the XA server (HCI auditServer Service) may not be receiving expected audit messages. To enable logging for HCLFOAuditing.exe:

1. Open Notepad (or another text editor) as an administrator
2. Using Notepad, browse to the C:\Program Files (x86)\Common Files\HealthCast\bin folder and open the HCLFOAuditing.exe.ini file:
3. Set "information=1" in the "debug" section
   1. information=1
4. Save the changes to the ini file
5. Log files are written to this location and file (NOTE: Some XA executables will recognize the change to their ini file and immediately start logging, while others will need to be restarted before they recognize the change).
   1. C:\ProgramData\HealthCast\logs
   2. HCLFOAuditing.txt.debuglog

Other XA Client Service Troubleshooting

Logging can be enabled for the following XA Client Services for troubleshooting particularly difficult-to-resolve XA client issues. Generally, logging for these components is not necessary, but may be requested by Engineering.

Enable HCLFOMessaging.exe Logging

To enable logging for HCLFOMessaging.exe:

1. Open Notepad (or another text editor) as an administrator
2. Using Notepad, browse to the C:\Program Files (x86)\Common Files\HealthCast\bin folder and open the HCLFOMessaging.exe.ini file:
3. Set "information=1" in the "debug" section
   1. information=1
4. Save the changes to the ini file
5. Log files are written to this location and file (NOTE: Some XA executables will recognize the change to their ini file and immediately start logging, while others will need to be restarted before they recognize the change).
   1. C:\ProgramData\HealthCast\logs
   2. HCLFOMessaging.txt.debuglog

Enable HCLFOSysServices.exe Logging

To enable logging for HCLFOSysServices.exe:

1. Open Notepad (or another text editor) as an administrator
2. Using Notepad, browse to the C:\Program Files (x86)\Common Files\HealthCast\bin folder and open the HCLFOSysServices.exe.ini file:
3. Set "information=1" in the "debug" section
   1. information=1
4. Save the changes to the ini file
5. Log files are written to this location and file (NOTE: Some XA executables will recognize the change to their ini file and immediately start logging, while others will need to be restarted before they recognize the change).
   1. C:\ProgramData\HealthCast\logs
   2. HCLFOMessaging.txt.debuglog

Enable HealthCastWLLSvc.exe Logging

To enable logging for HealthCastWLLSvc.exe:

1. Open Notepad (or another text editor) as an administrator
2. Using Notepad, browse to the C:\Program Files (x86)\Common Files\HealthCast\bin folder and open the HealthCastWLLSvc.exe.ini file:
3. Set "information=1" in the "debug" section
   1. information=1
4. Save the changes to the ini file
5. Log files are written to this location and file (NOTE: Some XA executables will recognize the change to their ini file and immediately start logging, while others will need to be restarted before they recognize the change).
   1. C:\ProgramData\HealthCast\logs
   2. HealthCastWLLSvc.txt.debuglog