Getting Started
Information related to the Keyfax Client installation & configuration.
These Keyfax Client files are normally held in one of other of these hidden shared folders:
\\IISSERVER\KFinstall$\\IISSERVER\KFinstallation$
You will find two files in this folder:
KF40client_n-n-n-n.exeKeyfax Client Installation Program (note: currently there is no .MSI equivalent).
KF40install.INIConfiguration Settings. This file contains settings that control the installation process. These settings will be tailored to your environment and normally will not need to be changed. However, you may need to change the settings if you plan to relocate the Keyfax websites. In any event, please consult Omfax Systems before making any changes.
Uninstall Previous Versions
Before installing a new version, it is important to uninstall any previous versions of the Keyfax Client, which may be present on the target machine.
To uninstall any previous version, from the start menu, select 'Settings - Control Panel - Add/Remove Programs' and select 'Keyfax', then click 'Change/Remove'. When the uninstall dialog displays, choose 'Automatic' for the first screen, 'No' for the second, then while the files are being removed you may be asked if you want to remove a shared component; answer 'Yes to All' to continue.
Where large numbers of client machines are involved, it may be more practical to script the uninstall process. The following command will perform a SILENT uninstall of Keyfax software (including Admin Tools if present):
C:\Progra~1\Keyfax\UnWise.exe /SC:\Progra~1\Keyfax\INSTALL.LOG
Implementing the Keyfax/Host interface requires a Keyfax Client installation to be run on each client PC, Terminal Services Server or Citrix® Server.
Installing the Keyfax Client
Installation should only be carried out by an operator with local administrator rights. This is because Keyfax configuration settings need to be written to an area of the system Registry accessible only to users with administrator security rights.
Installing for Citrix® Server or Microsoft® Terminal Services
IMPORTANT For Citrix/Terminal Server/RDS® installations, this must be performed using an Administrator account (not a user that has merely been assigned Admin privileges) from the machine's desktop (i.e. not from a terminal session).
When diagnosing problems with the Keyfax integration, if it is found that the Keyfax components (typically Keyfax.OCX or KeyfaxMIS.OCX) have been installed in the folder (e.g.) C:\Documents and Settings\CXBOX01\WINDOWS or beneath C:\Users\username this indicates that the software has been incorrectly installed (probably without installing via Add/Remove Programs or setting the server to Install Mode - see below). The Client will need to be uninstalled and re-installed correctly.
When installing applications on multi-user environment such as a Citrix/Terminal Server®, you must do this via Add/Remove programs wizard or put the server into INSTALL mode via the command prompt.
Start a COMMAND PROMPT session (right click on any Command Prompt icon and then 'Run as Administrator'):
When you want to add or remove programs, put the server in INSTALL mode:
At the command prompt, type change user /install and then press ENTER. The following message appears: User session is ready to install applications
Add or remove the programs that you want.
At the command prompt, type change user /execute and then press ENTER.
To Switch Windows® server to EXECUTE Mode:
When you are finished adding or removing programs, return the Windows® server to Execute mode. To do this:
At the command prompt, type change user /execute, and then press ENTER. The following message appears: User session is ready to execute applications.
Type EXIT, and then press ENTER.
If required, it is possible to install the Keyfax Client in 'silent' mode, i.e. there is no user interaction, by supplying a command line argument of '/S'. If this is not supplied, you will see the following dialogs:
The installation program will display the 'factory' settings for your environment, i.e. details of the web-service, shared folder and other site-specifics. If it is necessary to prove the settings are correct, you can chose to display the 'Keyfax Test Page'.
Log File Locations
Installation Logs
The installation logs for the Keyfax Client is named Install.log and is located in the folder C:\Program Files (x86)\Keyfax.
Application Logs
When the Keyfax Client is installed and debugging is enabled, this will write to the Temporary folder beneath the user's profile %TEMP%\KEYFAXDEBUG.LOG.
Enabling Debug Mode
To enable debug mode the following registry key must be set to 1...
HKEY_CURRENT_USER\Software\Omfax\Keyfax\Startup\Debug
This is shown below...
Debug Files
Debug files are created in the user's temporary folder. These files are called startup.xml, export.xml and keyfaxdebug.log. They can be found by entering the following paths on the command line after a Keyfax script has been completed:
Start-up XML = %temp%\startup.xml
Export XML = %temp%\export.xml
Code flow = %temp%\keyfaxdebug.log
The XML files will open in the default application for XML files. The LOG file can be opened in MS Notepad (but .log files may require associating to Notepad first).
As the keyfaxdebug.log will always be appended to when it exists, it can become very large after a time, therefore it is recommended that once debugging is complete, the temporary files are deleted.
MIS ActiveH Tracing It is possible to trace the Client activity in an MIS ActiveH environment by ensuring the following setting is configured in the appropriate instance configuration file. The @user attribute is a CSV list of users that you wish to trace. The folder is typically a network shared folder. <Debug html="0" user="operator, FredBloggs,KeyfaxUser" folder="\\KeyfaxWebServer\DebugFiles" xml="0" file="2" email="0" logmemory="0" logsql="0"/>
The trace file will be named according to the username, e.g. KeyfaxDebug_FredBloggs.Log and will be located in the shared folder specified, e.g. \\KEYFAX-SRV01\DebugFiles (this shared folder must be set up by Omfax technicians).
Last updated