4.x How to configure Logoff Cleanup
  • 02 Jun 2022
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

4.x How to configure Logoff Cleanup

  • Dark
    Light
  • PDF

Article summary

Logoff Cleanup is used to close any opened programs when the user logs out of eXactACCESS. Any programs that are closed are not closed gracefully and no work will be saved.

Configure eXactACCESS to run Logoff Cleanup

To configure Logoff Cleanup to run when eXactACCESS closes add a value named logoffCleanup.clsEventNotify to the notification registry key:
HKEY_LOCAL_MACHINE - SOFTWARE - HealthCast - eXactACCESS - notification
logoffCleanup.clsEventNotify=

Windows Application

To add an application to be closed by the Logoff Cleanup, you need to add the exe to the WatchList. This is done by adding a key to HKEY_LOCAL_MACHINE - SOFTWARE - HealthCast - eXactACCESS - LogoffCleanup Settings - WatchList named for the exe to be closed, for example: To close MS Word name the key WINWORD.EXE.

If you need an application to close, and all prompts be suppressed, you can add a string value to the key created above named Force that will force the process to close. This is an ungraceful termination that could lead to data corruption, and should only be used when necessary.

Internet Explorer Browser

To close all opened Internet Explorer windows you only need to add the following string value to the registry the following registry key (This is the default setting upon installation of the XA client):

HKEY_LOCAL_MACHINE - SOFTWARE - HealthCast - eXactACCESS - LogoffCleanup Settings - InternetExplorer
CloseIEBrowser=True

If you wish to exclude certain URLs, such as a Tracking Board, you can do so by adding string values named for the URLs you wish to exclude to the registry key HKEY_LOCAL_MACHINE - SOFTWARE - HealthCast - eXactACCESS - LogoffCleanup Settings - InternetExplorer - ExcludedURLs

Logoff Script
Logoff Cleanup supports launching command shell associated scripts (i.e. .bat, .vbs, .ps1) or an executable for added flexibility. To launch a script on log off add a key to HKEY_LOCAL_MACHINE - SOFTWARE - HealthCast - eXactACCESS - LogoffCleanup Settings - LogoffScript named for the script you wish to run.

Add a string value to the key named Path that contains the absolute path to the script. If there are command line arguments to pass to the script add a string value named Param to the key that contains the parameters to pass to the script.

Requirements:
Logoff Cleanup uses the TaskKill command to terminate applications during logoff. If this command is not available, not all of the configured applications will close.
#### Enable Logging for xalogoffcleanup
To add instructions to enable logging:

  1. In the registry key, enter Computer\HKEY_LOCAL_MACHINE\SOFTWARE\HealthCast\eXactACCESS\LogoffCleanup Settings.
  2. Add a string value named LoggingEnabled and set it to true.
  3. The log file will appear in the %AppData!\HealthCast\xalogoffCleanup folder as LogoffCleanup.trace.

Was this article helpful?