toolset logo  

The Kerridge ToolSet Division

Installation Information for Windows KCML users

Please make sure that you have read the following information before proceeding with an installation or upgrade of the Windows KCML product.

Contents

  1. Introduction to Windows KCML
  2. Obtaining the software
  3. About licence files and dongles
  4. About the WKCML licence server (LICSERV.EXE)
  5. Installing single user and LAN versions of WKCML
  6. Installing the DK2 dongle drivers
  7. Starting the licence server (LICSERV.EXE) on a Windows 9x machine
  8. Starting the licence server on a Windows NT server
  9. Installing WKCML LAN Clients
  10. Executing WKCML for the first time
  11. New users to KCML forms

1 Introduction to Windows KCML

All KCML 5 versions use the same componant, known as KClient, to manage the user interface.  However, Windows KCML (WKCML) differs from the standard client server product that is used with UNIX and NT servers in that both the KCML and KClient are executed on the same PC.  In a standalone single user environment KCML is installed onto a PC and is executed directly from the PC's hard drive.  When executing in a Windows LAN environment KCML is installed onto a PC which is designated to be the KCML licence server.   Client PC's on the network then execute KCML from the KCML licence servers hard disk.

The name WKCML is only used to distinguish the product from UNIX and Windows NT client server versions.  Previous versions of Windows KCML actually had a componant called "WKCML.EXE".  With Windows KCML 5 the program KCLIENT.EXE is executed to start Windows KCML session.  The same KClient executable is also used to connect in client server mode to either a UNIX or NT server. 

2 Obtaining the software

The WKCML software is available from the Kerridge Download Area.

Both the single user and LAN versions of WKCML are installed from the same SETUP.EXE program it is the KCML licence file (see below) that determines what the product is capable of.

As well as the WKCML software, a separate installation file for the DK2 dongle drivers is also required. This file is shipped on the WKCML CD or on a separate diskette.

If the PC being installed is going to be used for the development of GUI forms software then you will also need to install the KCML Forms designer.  This is installed from a separate SETUP.EXE file, it is not included as part of the standard distribution..

3 About licence files and dongles

WKCML uses a combination of a dongle and a licence file for protection.  It is the contents of the licence file that actually contains information about the licence itself.  Information contained in the licence file includes the number of licenced users, the software licence number, the customers name and address etc.  When KCML is executed it matches up information contained in the licence file with information in the dongle to make sure that the two go together.

The licence file (lic.txt) is an ASCII file and can therefore be viewed using any Windows text editor, e.g. NOTEPAD.  However, it is important that you do not attempt to change the encrypted part of the message as this will likely prevent KCML from starting up.  The licence file also contains regular text detailing the licence itself.  Changing this information will not effect KCML, it is there for general information purposes only. 

The licence file must reside in the directory from which KCML is executed.  Normally when KCML is installed the licence file will also get installed into the correct directory.  Once KCML has successfully been installed we suggest that you make a backup of the licence file.

User licence upgrades only require a new licence file to be installed, the dongle will not need to be re-programmed.  Upon receiving a new licence file we recommend that you make a copy of the old file before installing the new one.

4 About the WKCML licence server (LICSERV.EXE)

The WKCML licence server is used by LAN versions of WKCML only,   it is not required for single user versions.  The licence server is used to restrict the number of KCML connections according to the KCML software licence.  The licence server can be installed on either an NT Server/Workstation or any Windows 9x PC.  Ideally the machine that is to host the licence server should be a machine that will always be switched on to allow other users to get access to KCML.  The licence server does not need a user to log in to function as it is automatically executed as part of the machines boot up process. The dongle associated with the licence must also be permanantly connected to the PC running the licence server.

IMPORTANT : The licence server works by creating and removing files as each user logs in and out of WKCML.  This file structure can only exist on the PC hosting the KCML licence server and the dongle itself.  In other words WKCML must physically reside on the PC running the licence server, it cannot be installed onto a remote servers network drive, i.e. a Novell servers drive.  

IMPORTANT: The licence server is network independent therefore it only requires other PC's to have read and write access to the directory where WKCML was installed, i.e. the directory in which the LICSERV.EXE program was executed).   This means that the WKCML directory on the licence server PC must be shared (with Read and Write access) to allow users to execute KCML.  Other users can gain access to the directory either by adding the directory as a network drive or by executing KCML using its full UNC filename.

Once KCML has been installed the licence server will not automatically start-up.  On a Windows 9x PC you must manually execute LICSERV.EXE from within the WKCML directory.  This will then add a dongle icon into the System Tray.  To make the licence server start-up automatically when the machine boots, right click on the icon and select "Run Automatically".  On a Windows NT machine the licence server program is started using the Kerridge Server Administrator program.

5 Installing single user and LAN versions of WKCML

Both single user and LAN versions of WKCML consit of a SETUP.EXE file for the KCML itself, and a setup file for the dongle drivers.  If you already have a licence file (lic.txt) for the product then this file must exist in the same directory or on the same disk as the WKCML SETUP.EXE program.  If the setup program cannot find the licence file then it will prompt for it during the installation.  If you do not have a licence file then you will be given the opportunity to fill out a user registration form.  This form should be printed and sent to your KCML dealer with your order instructions.  Remember that the SETUP.EXE files for both single user and LAN versions are identical.

Running the setup program

The dialog prompts presented during execution will depend on the contents of the licence file, i.e. if you are installing a single user or a LAN version.   Most of these prompts should be self explanatory.  The following details each dialog that can appear during the installation.

Welcome

This dialog is always displayed first.  The background of the installation program shows the product being installed along with its exact version number.  For WKCML products this version number should obviously start with "WKCML", if it doesn't then you have the wrong SETUP program.

Licence

This dialog is only displayed if a licence file is not found.   Selecting the browse button allows you to browse and select a licence file.   You should only select the register button if you do not have a licence file.   Once the information in the register dialog has been completed, click on the copy to clipboard button and send this information with your order to you KCML dealer.

DK2 Licence Server

This dialog is only displayed if the setup program detects that you are installing WKCML on the licence server machine.  This is the machine that will run the licence server program (LICSERV.EXE) and have the dongle attached.  If you are not on the PC which you wish to install the licence server on then cancel the setup and move the the correct PC.  Note that the setup program knows that this is the licence server PC from information obtained in the licence file.

DK2 Licence Server Client

This dialog is only displayed when running the setup file from the client. (See below)

Select destination directory

This dialog allows you to specify the directory into which KCML will be installed.  The LAN version must be installed into a directory on the machines hard disk, it cannot be installed onto a Network drive.  Single user versions can be installed anywhere, although the dongle must be connected to the PC that will run WKCML.

Backup replaced files

This dialog is always displayed.  If you want to take a backup of KCML files before the installation takes place, select the "Yes" option.   This will make a copy of KCML files in the "backup" sub-directory.

Select Program Manager Group

This dialog is always displayed.  Select the program manager group that you want KCML to be installed into.

Ready to Install

Click "Next" to start the installation.   Alternatively click on "Back" to review your installation settings.

Note: Once the installation has completed you may be requested to reboot the system.  It is imperative that you do this otherwise WKCML may not function as expected or may not function at all.  This is normally only necessary when re-installing or upgrading WKCML. 

6 Installing the DK2 dongle drivers

The DK2 dongle drivers are distributed on a separate disk or within a separate directory on the CD.  To install the drivers run the supplied installation program.  Even if you already have the DK2 dongle drivers installed we recommend that you re-install them using the latest versions supplied.

7 Starting the licence server (LICSERV.EXE) on a Windows 9x machine

Once WKCML and the dongle drivers have succesfully been installed you can now start the licence server.  To start the licence server simply run the program LICSERV.EXE either via the Windows explorer or from the start up group that the installation program created earlier.

Once executed a dongle icon shouuld appear in the system tray.   To make the dongle server start automatically when the machine is booted up, right click on the icon and select the "Run Automatically" option.

8 Starting the licence server on a Windows NT server

Once WKCML and the dongle drivers have succesfully been installed you can now start the licence server.  To start the licence server you need to run the Kerridge Service Administrator (KServadm) program, and install the "LicServer" service.  See the separate document detailing the Kerridge Service Administrator for more information on starting Windows NT services.  Once the service has been installed it will automatically start each time the system is booted up.

9 Installing WKCML LAN Clients

Once the WKCML server has been installed you can now install the WKCML clients.  To do this you need to execute the SETUP.EXE program from the WKCML directory on the server.  This will then create a Start Menu group using the same group name that the server used and will subsequently create shortcuts to the KCML executables in the group.

Note that the directory containing the SETUP.EXE file must be shared with both read and write access otherwise the setup program will fail.

10 Executing WKCML for the first time

To start a standalone WKCML session execute the KClient program from within the startup group created by the installation program.  To execute WKCML directly from within the Windows explorer you need to run the KClient.EXE program.

Note that if you intend to develop forms based applications then you also need to install the Kerridge Forms Designer.

11 New users to KCML forms

If you have never used the KCML forms environment then the following easy steps should get you started:

  1. In the KCML editor press Ctrl+F.  This will display the KCML Object Browser.
  2. Select the Forms Tab.
  3. Click on Add forms object and accept the default form name.
  4. Click on the edit button.  This will display the KCML forms designer (assuming that you have installed it)
  5. New controls are added from the pallete at the base of the screen.
  6. Click on the "Close Door" icon to return to the program

For more information on the forms designer and forms programming refer to the KCML Forms help file.  Also see the KCML 5 FAQ.