Kayleigh

(Job Accounting II)

MX-SW310/MX-SW311/MX-SW312/MX-SW313

Installation Guide

The External Accounting Application for

Sharp MFP

The External Accounting Application for

Sharp MFP
KAYLEIGH | USING OSA TECHONOLOGY

Installation Guide

Version 2.8.3

 Sharp Digital Document Systems

European Solutions Business Centre
4 Furzeground Way, Stockley Park
Uxbridge, Middlesex UB11 1EZ
United Kingdom
Warranty
While every effort has been made to make this guide as accurate and helpful as possible, Sharp
Corporation makes no warranty of any kind with regard to its content. All information included
herein is subject to change without notice. Sharp Corporation is not responsible for any loss or
damages, direct or indirect, arising from or related to the use of this guide.

Copyright
© 2018 Sharp Corporation.
All rights reserved. Reproduction and translation are permitted. Adaption without written
permission is prohibited, except as allowed under copyright laws.

Trademark Acknowledgments
 Microsoft® Windows® operating system is a trademark or copyright of Microsoft Corporation in
the United States and other countries.
 Windows® 2016, Windows® 2012, Windows® 10, Windows® 8, Windows® 7 and Windows®
2008 are trademarks or copyrights of Microsoft Corporation in the United States and other
countries.
 Active Directory® is a trademark or copyright of Microsoft Corporation in the United States and
other countries.
 Apache is a trademark of the Apache Software Foundation.
 Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 Sharp® is a registered trademark of Sharp Corporation.
 All other trademarks and copyrights are the property of their respective owners.
Table of Contents
1 SYSTEM REQUIREMENTS ..................................................................................... 1

2 INSTALLATION .................................................................................................. 2
2.1 Installing Kayleigh ...........................................................................................................2
2.2 Verifying Kayleigh Installation ....................................................................................... 10
2.3 Starting the Kayleigh Admin Application ....................................................................... 11
2.4 Installing Kayleigh Licence ............................................................................................. 12
2.4.1 Assigning Licenses ...........................................................................................................................13

3 CONFIGURATION ............................................................................................. 14
3.1 Configuring the MFP – Non SSL/TLS ............................................................................... 14
3.2 Configuring the MFP - SSL/TLS ....................................................................................... 15
3.3 Configuring SSL/TLS for the Kayleigh Admin Application ................................................ 16
3.3.1 Managing SSL/TLS Certificate Errors ................................................................................................16
3.3.2 Accessing the Kayleigh Admin Application Using the Server’s Fully Qualified Domain Name ..........17
3.3.3 Using Your Own SSL/TLS certificate in Kayleigh ...............................................................................17
3.3.4 Only Allowing SSL/TLS Access ..........................................................................................................18
3.3.5 Generating Your Own Self-Signed Certificate ..................................................................................18
3.4 Using IC Card for Authentication ................................................................................... 20
3.5 Configuring End User’s Printer Driver to Print Directly to a Kayleigh Controlled MFP ...... 22
3.6 Configuring Kayleigh Pull Printing Service ...................................................................... 23
3.6.1 Configuring a Printer Driver for the Kayleigh SimplifyPrint Spooler .................................................24
3.6.2 Configuring End User’s Printing Preferences for Kayleigh Pull Printing ............................................26

4 KAYLEIGH UN-INSTALLATION .............................................................................. 27

5 UPGRADING KAYLEIGH ..................................................................................... 28

5.1 Migrating and Upgrading from 1.6 to 2.2 or Higher ........................................................ 28
5.2 Upgrading from v2.x to v2.2 or Higher ........................................................................... 31
5.3 Upgrading from v2.5/2.5.1 ............................................................................................ 32

6 FREQUENTLY ASKED QUESTIONS ......................................................................... 33

 I still get the error “Cannot find license file” after installing the license files. ................. 33
1 System Requirements
 Sharp MFPs that have OSA enabled and the EAM (AMX3) key
 Supported Operating Systems. Kayleigh has been tested on the below Operating Systems
successfully. Other versions of Windows might still work, although we cannot guarantee it:
Operating System
Windows 10 Professional
Windows 10 Enterprise
Windows 2008 R2 Standard SP1
Windows 2008 R2 Enterprise SP1
Windows 2012 Standard
Windows 2012 Essentials
Windows 2012 R2 Standard
Windows 2012 R2 Essentials
Windows 2016 Standard
Windows 2016 Essentials

Kayleigh is only tested on fresh installations of the operating systems listed above, co-residence
with other services and/or applications cannot be guaranteed.
 Web browsers: IE 7.0 and above, Firefox 3.0 and above, Google Chrome 44.0 and above.
 The server machine where Kayleigh is installed must have a static IP address for an MFP to connect
to and a static MAC address to support the Kayleigh license validation.

1
2 Installation
2.1 Installing Kayleigh

NOTE:

You must login as a Windows user with administrator’s right to install Kayleigh.

Login to the Kayleigh server machine as an administrator and launch the Kayleigh installer.

In Windows 7 you may see a user account control warning as follows:

Screen Shot 1: Windows 7 User Account Control Warning

Please click [Yes] to continue.

2
This will launch the Kayleigh Setup Wizard.

1. The first screen is the Welcome screen. Simply click [Next] to continue.

2. You must read and agree all the license terms from SHARP and the third party vendors including Oracle,
Apache, and PHP to continue.

3
3. Choose install location. The user can specify in which directory to install Kayleigh. From now on, we
will refer to the directory chosen here as the <Kayleigh Installation Directory>.

The default Kayleigh installation directory is as follows:

32-bit Operating System: %ProgramFiles%\Kayleigh2\
64-bit Operating System: %ProgramFiles (x86)%\Kayleigh2\

Where %ProgramFiles% and %ProgramFiles (x86)% are Windows environment variables which
should be replaced by their actual values.

For example, in a 32-bit Spanish Windows operating system, the value of the Windows environment
variable %ProgramFiles% is C:\Archivos de programa\, therefore the default Kayleigh installation
directory will be:

C:\Archivos de programa\Kayleigh2\

NOTE

In some localized Windows operating systems, for example, in French Windows 7, the directory
Program Files will be called Programme. However, Programme is not a real directory, it is simply a hard
link or an alias pointing to the original Program Files directory.

In this case, we recommend that you use the [Browse …] button to select the directory where you
want to install Kayleigh, if a hard link or alias is selected in the [Browse For Folder] dialog, the Setup
program will resolve the link or alias to its original directory and install Kayleigh to the correct location.

However, if you manually type in a directory path containing a hard link or an alias, for example
C:\Programme\Kayleigh2, a new directory with the name of C:\Programme may be created with a
sub-directory Kayleigh, even though a hard link or alias with the same name already existed. As a
result, when you open the Windows Explorer, you will see two directories with the same name
C:\Programme.

4
4. Choose Start Menu Folder. This will create a shortcut in the Windows start menu for Kayleigh which
contains a link to uninstall Kayleigh.

5. Select operating system language. For example, if you are installing Kayleigh in French Windows
operating system, then choose French. This will set up the default language in Kayleigh to be French.

5
6. Check Ports. This dialog lists all the ports that will be used by Kayleigh. Please accept the suggested
free ports or enter your own port numbers. If any port number entered is being used by another
program, the setup program will ask the user to enter a different port number. Click [Install] to
continue.

NOTE

Port numbers and relevant URLs that are needed for the user to access the Kayleigh functionality will
be recorded in the file <Kayleigh Installation Directory>/KayleighConfig.txt after the installation.

7. Please be aware that if you see the warning shown below, then depending on your version of
Windows that you may have an application called DNS.exe running on your system.

If you see this warning screen then you need to stop the DNS.exe application, re-run the Kayleigh
installer and re start DNS.exe afterwards.

6
A progress bar will be displayed and Kayleigh Setup will start to install and configure Kayleigh on the
server machine.

During this process:

 A few DOS windows will open and close on their own, this is normal.

 You may see the following Windows Security Alert.

Apache HTTP server is the web server that serves the Kayleigh Admin web application. If you
only need to access the Kayleigh Admin application within the Kayleigh server, click [Cancel].
Clicking [Allow Access] will add an exception to your firewall settings to allow you access the
Apache HTTP server and the Kayleigh Admin application outside the firewall. You can change
this firewall configuration later via Windows [Control Panel][Security Center].

 Kayleigh uses an embedded version of the PostgreSQL server. The PostgreSQL server is no
longer installed as a separate software package. Kayleigh still installs the Microsoft Visual C++
2005 – 2008 redistributable package which is required by the PostgreSQL server. You may see
the following window on the screen. This will close automatically.

7
  Towards the end of the installation process, you may see the following DOS windows stay on
the screen for a few minutes, this is normal. It will close automatically once the Kayleigh
installation is completed.

8. After the installation is completed, the following finishing screen will be displayed. Click Finish to exit
the installer.

8
After the installation is completed, the KayleighConfig.txt located in the <Kayleigh Installation Directory>
will be displayed automatically in the Windows Notepad application. It contains useful URLs and port
settings for the Kayleigh application. An example of KayleighConfig.txt that uses all the default installation
settings is shown below:

KAYLEIGH CONFIGURATION SETTINGS

=================================

----------------------------------------------
MFP External Accounting Application Settings
----------------------------------------------

Non-SSL/TLS:
----------
Address for Application UI:
http://<kayleigh server ip address>:58080/Kayleigh/login.jsp
Address for Web Service:
http://<kayleigh server ip address>:58080/Kayleigh/KayleighWS

SSL/TLS:
--------
Address for Application UI:
https://<kayleigh server ip address>:58181/Kayleigh/login.jsp
Address for Web Service:
https://<kayleigh server ip address>:58181/Kayleigh/KayleighWS

-------------------------------------------
Kayleigh Admin Web Site URL
-------------------------------------------

Non-SSL/TLS:
----------
http://localhost:50080/Kayleigh
http://<Kayleigh server ip address>:50080/Kayleigh

SSL/TLS:
--------
https://localhost:50081/Kayleigh
https://<Kayleigh server ip address>:50081/Kayleigh

----------------------------------------------------
Kayleigh ScanToMe Extended OSA Application Settings
----------------------------------------------------

Non-SSL/TLS:
----------
Address for Application UI:
http://<Kayleigh server ip address>:50080/Kayleigh/netfront/scanapp.jsp
Extended Platform: checked

SSL/TLS:
--------
Address for Application UI:
https://<Kayleigh server ip address>:50081 /Kayleigh/netfront/scanapp.jsp
Extended Platform: checked

----------------
Port Settings
-----------------

Kayleigh pull printing Port: 57000

Java Application Server Port: 58080
Java Application Server SSL/TLS Port: 58181
Java Application Server Administration Port: 54848
PostgreSQL Server Port: 55432
Apache Web Server Port: 50080
Apache Web Server SSL/TLS Port: 50081

9
2.2 Verifying Kayleigh Installation
Start the Windows Services console, you should see the following Windows services have been installed
and started automatically:

 KayleighApacheServer

 KayleighJavaServer

 KayleighPostgresServer

 KayleighSPSpooler.

10
2.3 Starting the Kayleigh Admin Application
Kayleigh Admin application is a web based managing tool. You can use it to configure Kayleigh, manage
users, departments, and printers etc. You can also use the tool to assign licenses and generate reports. To
start the application, enter one of the following URLs in a browser:

URLs for non SSL/TLS (HTTP) access:

 http://<Kayleigh server IP address>:<Apache server port number>/Kayleigh

 If to access within the Kayleigh server:

http://localhost:<Apache server port number>/Kayleigh

URLs for SSL/TLS (HTTPS) access:

 https://<Kayleigh server IP address>:<Apache server SSL/TLS port

number>/Kayleigh

 If to access within the Kayleigh server:

https://localhost:<Apache server SSL/TLS port number>/Kayleigh

Please note that SSL/TLS access to the Kayleigh Admin application will trigger the browser to display a SSL
certificate error. Please refer to the section Managing SSL/TLS Certificate Errors on page 16 for more
information.

Please replace <Kayleigh server IP address> > with the server’s actual IP address. Also replace
<Apache server port number> and <Apache server SSL/TLS port number>with the actual port
numbers. The default port numbers are 50080 and 50081 for <Apache server port number> and
<Apache server SSL/TLS port number> respectively. You can obtain the actual port numbers in
KayleighConfig.txt in the <Kayleigh Installation Directory>.

NOTE

If you need to access the Kayleigh Admin application through a firewall, please make sure the Apache
server port number is allowed in the firewall configuration.

The default administrator account is:

Username: admin
Password: admin

We recommend you change the admin password after you first login to the Kayleigh Admin
application.

11
2.4 Installing Kayleigh Licence
The Kayleigh application requires a valid license in order to run. The Kayleigh installer comes with a trial
license that is normally valid for 3 months and for 5 MFPs.

A typical situation where multiple licenses are required is as follows. A customer has a Kayleigh installation
with 3 MFPs and 100 users. The customer has now purchased 2 additional MFPs and would also like to
add 50 additional users to the Kayleigh system. An additional license file needs to be installed that allows
2 MFPs and 50 users.

The license files you receive must stay zipped and may look similar to this:

From the Kayleigh Admin application select [License] [Add License]

[Browse] for the license, once selected click [Open]

Click [Add License]

The license will be verified

If everything is OK the license will be installed

NOTE

Please do not modify your license files, doing so will make your license invalid and you will not be able
to run Kayleigh consequently. The Kayleigh server machine must have a static MAC address for the
Kayleigh license validation to work1.

If you don’t have a Kayleigh license, please contact your Kayleigh distributor.

If you want to use the pull printing (or SimplifyPrint) feature in Kayleigh, you will need a Kayleigh
license that has pull printing module option, (MX-SW311).

1 By default Microsoft Hyper-V virtual machines use dynamic MAC addresses. If Kayleigh is installed in a Hyper-V machine, you will need
to change the Hyper-V machine’s default Network Adapter setting and make sure it is using a static MAC address.

12
2.4.1 Assigning Licenses

A Kayleigh license can contain the Base Installation, (MX-SW310) and the module licenses. The base
installation specifies the maximum number of MFPs allowed to connect to the Kayleigh server. The module
licenses include the Pull Printing Option (MX-SW311), the Client Billing Option (MX-SW312) and the
ScanToMe option (MX-SW313). That means that an end customer could order 5 MFPs for the base
installation and 2 MFPs for the pull printing option.

Kayleigh supports multiple licenses. The total number of MFPs allowed by a module license in multiple
licenses, e.g. the Pull Printing Option, must not exceed the total number of MFPs allowed by the base
installation.

Once a license has been installed to Kayleigh it needs to be assigned. To assign licenses [Click] License in
the left navigation menu and select the Assign Licenses tab, please refer to the following diagram for more
information.
The total number of licenses
allowed for base and modules.

Green indicates all registered MFPs

have been assigned a license.
Orange indicates that some MFPs
have not been assigned license,
while licenses are available.
Red indicates that more MFPs have
been assigned than there are
available licenses.

Auto assigns the available

licenses to the registered
MFPs.

13
3 Configuration
3.1 Configuring the MFP – Non SSL/TLS

NOTE

For a Sharp MFP to use Kayleigh as the external accounting application it must have OSA 3.5 or above
enabled.

Go to the MFP administration web page. Navigate to:

[Application Settings][External Application Settings][External Accounting Settings]

or for newer MFP models, navigate to:

[System Settings][Sharp OSA Settings][External Accounting Application Settings]

Enable and configure the external accounting as follows:

External Account Control: Enable

Set Authentication Server (Server 1): Checked
Application Name: Kayleigh
Address for Application UI:
http://<Kayleigh server IP address>:<Java server port number>/Kayleigh/login.jsp
Address for Web Service:
http://<Kayleigh server IP address>:<Java server port number>/Kayleigh/KayleighWS

Please replace <Kayleigh server IP address> with the actual IP address of the Kayleigh server, and
replace <Java server port number> with the actual port number. By default this is 58080. You can obtain
the port number in KayleighConfig.txt in the <Kayleigh Installation Directory>.
Browser:
HTML Browser 3.5 – This is the old MFP browser.
HTML Browser n2.0 – This is the new MFP browser with enhanced web support.

The Browser option is only available for newer MFPs. If your MFP doesn’t have this option, it uses the HTML
Browser 3.5 by default.

14
 Reboot the MFP and the Kayleigh login
screen should be displayed on the MFP
touch panel.

NOTE

If the MFPs need to connect to the Kayleigh server through a firewall, you need to make sure that the
Kayleigh Java server port is allowed in the firewall configuration.

3.2 Configuring the MFP - SSL/TLS

To configure an MFP to communicate with the Kayleigh server using TLS, following the instructions in the
section Configuring the MFP on page 14, but replace the settings in [Address for Application UI] and
[Address for Web Service] as shown below:

Address for Application UI:

https://<Kayleigh server IP address>:<Java server SSL/TLS port
number>/Kayleigh/login.jsp

Address for Web Service:

https://<Kayleigh server IP address>:<Java server SSL/TLS port
number>/Kayleigh/KayleighWS

Please replace <Kayleigh server IP address> with the actual IP address of the Kayleigh server. Also
replace <Java server SSL/TLS port number> with the actual port number. The default port number is
58181. You can obtain the actual port number in KayleighConfig.txt in the <Kayleigh Installation Directory>.

Browser
HTML Browser 3.5 – This is the original and default browser
HTML Browser n2.0 – This is the latest MFP browser, select this browser if you want to use TLS 1.2.

NOTE

To support TLSv1.2 communication between an MFP and Kayleigh, the MFP's firmware must support
both the n2.0 browser and TLSv1.2, and the n2.0 browser must be selected when register Kayleigh as
the external accounting application for the MFP.

15
3.3 Configuring SSL/TLS for the Kayleigh Admin Application
3.3.1 Managing SSL/TLS Certificate Errors

Kayleigh automatically generates a self-signed SSL/TLS certificate during the installation process. This
certificate is unique to each installation and is used to encrypt data for secure communication. It is issued
for the following domain names:
 The server’s host name.
 kayleighserver.local
 localhost

When a user makes a HTTPS (SSL/TLS) connection to the Kayleigh Admin application, depend on the web
browser and how it is configured, the browser may display a certificate error because the certificate is not
issued by a trusted Certificate Authority (CA). For example, Google Chrome will display the following error:

Here are some options to work around the above error:

1. If permitted by your company’s security policy, users can choose to ignore the error by clicking the
[Advanced] button and give explicit permission to proceed to the Kayleigh web page. Some
browsers, e.g. Firefox, allows the users to add the Kayleigh certificate as a security exception to the
browser to stop the certificate error.

2. If you use Active Directory and Group Policies to manage user accounts and computers, you may
be able to suppress the certificate error for users in most browsers (excluding Firefox) by
configuring the following:

a) Configure your local DNS so that users can access the Kayleigh server using the server’s host
name, or using Kayleigh’s fixed domain name kayleighserver.local.

If your users need to access the Kayleigh Admin application externally using Kayleigh server’s
fully qualified domain name (FQDN) over SSL/TLS, you will need to generate a new self-signed
certificate to match the server’s FQDN. For more information, please refer to the section
Accessing the Kayleigh Admin Application Using the Server’s Fully Qualified Domain Name
on page 17.

16
 b) Use Active Directory to distribute and import Kayleigh’s self-signed certificate to the Trusted
Root Certification Authorities in managed user computers.

For more information, please see: https://docs.microsoft.com/en-us/windows-

server/identity/ad-fs/deployment/distribute-certificates-to-client-computers-by-using-group-
policy

Kayleigh’s self-signed certificate file is: <Kayleigh installation directory>\apache\conf\ssl\

kayleighserver.local.crt.

c) Advise users to access the Kayleigh Admin application using the server’s host name, fully
qualified domain name, or kayleighserver.local depends on your DNS configuration.
For example https://kayleighserver.local:50081/kayleigh

3. Alternatively you can purchase a public SSL/TLS certificate from a trusted Certificate Authority
(CA) and configure Kayleigh to use the public certificate. For more information, please refer to
the section Using Your Own SSL/TLS certificate in Kayleigh on page 17.

3.3.2 Accessing the Kayleigh Admin Application Using the Server’s Fully Qualified Domain Name

If your users need to access the Kayleigh Admin application externally using Kayleigh server’s fully
qualified domain name (FQDN) over SSL/TLS, the browser will display a domain mismatch error. This is
because the self-signed certificate generated by the Kayleigh installer is not aware of the server’s FQDN.
To fix the error, you will need to generate your own self-signed certificate for the server’s FQDN. For
more information, please refer to the section Generating Your Own Self-Signed Certificate on page 18.

3.3.3 Using Your Own SSL/TLS certificate in Kayleigh

You can configure Kayleigh to use your own SSL/TLS certificate:

1. Copy your pair of certificate and key files to the following directory: <Kayleigh Installation
Directory>\apache\conf\ssl\

2. Edit <Kayleigh installation directory>\apache\conf\extra\httpd-ahssl.conf in a text editor, find

the following section

Replace kayleighserver.local.crt with the name of your certificate file and replace
kayleighserver.local.key with the name of your key file. Save your changes.

3. Restart the KayleighApacheServer Windows service.

17
3.3.4 Only Allowing SSL/TLS Access

To disable non SSL/TLS access and thus only allow secure SSL/TLS access to the Kayleigh Admin application:

1. Edit <Kayleigh installation directory>\apache\conf\httpd.conf in a text editor:

a. Uncomment the line #Define KAYLEIGH_HTTPS_ONLY by removing the # in front, i.e.
replace it with
Define KAYLEIGH_HTTPS_ONLY

b. Find line Define KAYLEIGH_HOST "localhost", and replace localhost with the actual
Kayleigh server domain name or IP address that the users will be using in their URL to
access the Kayleigh Admin application.

Save your changes to the httpd.conf file.

2. Restart the KayleighApacheServer Windows service.

3.3.5 Generating Your Own Self-Signed Certificate

Steps to generate your own self-signed certificate:

1. Decide the domain name (subject name) you will use to generate the certificate, normally this
should be the server’s fully qualified domain name (FQDN), e.g. myserver.mydomain.com

2. Choose your certificate and key file names. For example myserver.crt and myserver.key.
3. Create a temporary directory to output the generated certificate and key files, say C:\mytemp.
4. Edit <Kayleigh installation directory>\apache\conf\openssl_kayleighserver.cnf in a text editor,
add a new line
DNS.4 = <Kayleigh server domain name>
after line DNS.3 = localhost. Replace <Kayleigh server domain name> with the actual domain
name. For example if you server’s FQDN is myserver.mydomain.com, add line: DNS.4=
myserver.mydomain.com

5. Open a DOS windows with administrator’s right (Run as administrator) and type the following
commands:
set OPENSSL_CONF=<Kayleigh installation
directory>\apache\conf\openssl_kayleighserver.cnf

"<Kayleigh installation directory>\apache\bin\openssl.exe" req -x509 -nodes -

days 365000 -newkey rsa:2048 -subj "/CN=<Kayleigh server domain name>" -
keyout "C:\mytemp\<key file name>" -out "C:\mytemp\<certificate file name>"

18
 Replace <Kayleigh installation directory>, <Kayleigh server domain name>, <key file name>,
<certificate file name> with the actual values. You may also need to replace C:\mytemp if you are
using a different directory to output the certificate and key files in Step 3.

This will create the pair of certificate and key files in the directory C:\mytemp\ or the directory of
your choice in step 3.

For example, if your <Kayleigh installation directory> is: C:\Program Files (x86)\Kayleigh2 and your
<Kayleigh server domain name> is myserver.mydomain.com, the <certificate file name> is
myserver.crt and the <key file name> is myserver.key, you would run the following commands:
set OPENSSL_CONF=C:\Program Files
(x86)\Kayleigh2\apache\conf\openssl_kayleighserver.cnf

"C:\Program Files (x86)\Kayleigh2\apache\bin\openssl.exe" req -x509 -

nodes -days 365000 -newkey rsa:2048 -subj "/CN=myserver.mydomain.com" -
keyout "C:\mytemp\myserver.key" -out "C:\mytemp\myserver.crt"

6. Follow the instructions in the section Using Your Own SSL/TLS certificate in Kayleigh on page 17
to configure Kayleigh to use the newly generated certificate.

19
3.4 Using IC Card for Authentication
From OSA 3.5, most MFP models added the new feature of “Use IC Card for Authentication”. If this
feature is enabled, a card reader must be pre-registered with the MFP for the external accounting
application to work. The benefit of this feature is that it allows a user to walk up to any Kayleigh
controlled MFP, scan their card directly and authenticate without having to press any button first.
Without this feature enabled, the user must first press the “Card” button, wait for the OSA keyboard
input form is displayed, then swipe/scan the card.

If IC Card authentication is enabled for a MFP,

Kayleigh will automatically display a different
login screen to prompt the user for direct card
login.

The procedure to register a card for a user is

the same regardless IC Card authentication is
enabled or not. The user must first login to a
Kayleigh controlled MFP using their username
and password, then press the [Register Card]
button to register their card.

NOTE

The procedure to enable the “Use IC Card for Authentication” feature varies on different MFP models.
Please contact your Sharp dealer for details about how to configure your particular MFP model.

20
When IC Card authentication is enabled on MFP, all cards are read in English, regardless of whether the
MFP's keyboard is set to English or not. This means that to ensure all cards are registered and read correctly
on different MFPS, you must implement one of the following:

1. All the MFPs on the network that are accessing Kayeigh need to have IC Card authentication
enabled, each MFP can have a different language display or keyboard setting.

2. If not all of the Kayleigh controlled MFPs have IC card authentication enabled, the MFPs that
don't have IC card authentication enabled must set the keyboard to English. This option is
available on the MFP Administration page under [System Settings][Default Settings][Keyboard
Select].

3. If IC Card authentication is not enabled, the card must be registered in the same keyboard that it
will be authenticated with later. A card that is registered on a MFP with French keyboard selected
will not authenticate on a MFP with English Keyboard selected. This is a limitation of using
keyboard simulation card reader technology.

21
3.5 Configuring End User’s Printer Driver to Print Directly to a Kayleigh Controlled MFP
For any end user to print to a Kayleigh controlled MFP directly, you will need to do the following.

1. Set up an account for the end user in Kayleigh (see the Kayleigh User Manual for more information
on how to do this).

2. Configure the end user’s printer driver

a. Go to [Start] [Control Panel] [Hardware][Devices and Printers]

b. Right click on the printer you want to configure and select [Printer Properties]

c. Choose the [Preferences…] button and then choose the [Job Handling] tab and follow the
instructions on the diagram below.

Figure 1: Configuring the User's Printer Driver to Print Directly to a Kayleigh Controlled MFP

22
3.6 Configuring Kayleigh Pull Printing Service
Kayleigh pull printing service is an optional component that the users can purchase. It only requires the
EAM (AMX3) key. Kayleigh pull printing allows a user to print files to the Kayleigh SimplifyPrint spooler,
then walk up to any Kayleigh controlled MFP to print and delete the files printed to the spooler.

To use pull printing with Kayleigh, you need the following:

 A Kayleigh license with the pull printing module option, (MX-SW311). If this option is activated,
after a user logs in to a Kayleigh controlled MFP, the user will be able to access their printed files
and print or delete the files at the MFP.

 Configure a printer driver to print to the Kayleigh SimplifyPrint spooler. Please refer to the next
section Configuring a Printer Driver for the Kayleigh SimplifyPrint Spooler on page 24 for more
details.

 From Kayleigh v1.5, you no longer need to enter the user’s Kayleigh credentials as part of the
driver’s printing preferences for each end user. You only needs to modify the user’s printing
preferences if the user’s default Windows user name is different from their Kayleigh user name.
Please refer to the section Configuring End User’s Printing Preferences for Kayleigh Pull Printing
on page 26 for more details.

23
3.6.1 Configuring a Printer Driver for the Kayleigh SimplifyPrint Spooler

NOTE

The printer driver for the Kayleigh SimplifyPrint spooler is used to generate print files that can be sent
to any Kayleigh controlled MFP for printing. It doesn’t modify the print data generated, so please
ensure that the printer driver you are using is compatible with the MFPs.

For each PC on the network that requires access to the Kayleigh pull printing service, you need to configure
a printer driver so that when you print a file, it will be sent to the Kayleigh SimplifyPrint spooler instead of
an actual MFP.

Like any printer driver, you can install the printer driver as a local printer driver or shared network printer
driver.

 Local Printer Drivers

Each user has a copy of the printer driver installed on their system locally. An administrator will need
to repeat the steps below on each user machine.

 Local Area Network (LAN) Shared Printer Drivers

Users share an MFP and printer driver from a printer server or local machine. Login to your printer
server or the machine where the MFP is shared from and follow the steps below.

 Active Directory Printers and Printer Drivers

Printers are deployed to users by Windows Active Directory. Login to your printer server or Active
Directory, where the MFP is shared from and follow the steps below.

Depending on your Active Directory settings you may need to re-publish your printer after updating
the configuration settings.

Please follow the steps below to configure the printer driver:

1. In Windows, go to [Control Panel] [Hardware][Devices and Printers].

2. Select the chosen Sharp printer driver that is compatible for all Kayleigh controlled MFPs, right click
and select [Printer Properties].

3. Select the tab [Ports] and select [Add Port…].

4. Select [Standard TCP/IP Port] and [New Port…].

5. Enter the IP address of the Kayleigh server for [Printer Name or IP Address:] and press [Next].

24
6. Accept the default device type, (this can take up to 40 seconds to be applied), and press [Next] and
[Close]. Select [Configure Port…] and enter the Kayleigh pull printing spooler port number in [Port
Number:]. By default this is 57000. This port number is available in the file KayleighConfig.txt in the
<Kayleigh Installation Directory>.

7. Uncheck [SNMP Status Enabled] if it is selected.

8. Click [OK] and then [Close].

NOTE

If end users need to print to the SimplifyPrint spooler through a firewall, you need to make sure the
Kayleigh pull printing port number is allowed in the firewall configuration.

25
3.6.2 Configuring End User’s Printing Preferences for Kayleigh Pull Printing

For each end user, if the user’s Windows user name is the same as the Kayleigh username, you can skip
the steps below. Otherwise, you need to enter the Kayleigh user name in the printer driver that prints to
the SimplifyPrint spooler, please follow the instructions below:

1. Go to [Start] [Control Panel] [Hardware] [Devices and Printers]

2. Right click on the printer driver for SimplifyPrint spooler and select [Printer Properties]

3. Choose the [Preferences…] button and then choose the [Job Handling] tab and follow the
instructions on the diagram below.

Figure 2: Configuring the User's Printer Driver for Kayleigh Pull Printing

26
4 Kayleigh Un-installation
You can uninstall Kayleigh from

[Control Panel][Programs][Uninstall a program][Kayleigh2][Uninstall]

Or click

[Windows start menu][All Programs][Kayleigh2][Uninstall Kayleigh2]

This will launch the Kayleigh uninstaller to uninstall the application from your computer.
Please be aware that the uninstaller will remove the Kayleigh database data as well.

27
5 Upgrading Kayleigh
As new versions are released you may choose to upgrade to the latest release. You will only have to run
the latest installer on the machine where Kayleigh is already installed.

However, for versions prior to 2.0, the upgrade process will require doing a manual migration of
data. A data migration tool is included in the 2.2+ installers to process data migration for 1.6 - 1.6.1
installations.

5.1 Migrating and Upgrading from 1.6 to 2.2 or Higher

NOTE

Kayleigh v1.x licenses are not valid for Kayleigh v2.x installations so after upgrading you will initially be
restricted to an installed trial license. Once the upgrade is complete you can use a server unique
request code to order new licences. Please refer to the section Ordering Licenses in the Kayleigh User
Manual for further information on how to collect your license request code.

To migrate from v1.6 to v2.x follow these steps:

1. Run the latest installer (Kayleigh v2.2+) and select the option to create a backup of the data. Follow
the instructions as provided in the setup:

NOTE

Please make a safe copy of this backup will be needed for data migration to Kayleigh v2.x later.

28
2. Once the backup has been created, uninstall old Kayleigh version using the provided Kayleigh
Uninstaller.

3. Run the latest Kayleigh v2.x installer to install the newest version of Kayleigh and the most recent
data migration tool on your server.

4. Run the Data Migration Tool to migrate the old data to the new Kayleigh v2.x server installation.

29
NOTE

If you have made changes to the Kayleigh configuration files, these changes are not not automatically
promoted to the new Kayleigh installation by the Data Migration Tool and need to be manually
updated. The old configuration files will be migrated and can be found in the same directories as their
new counterparts, in the following format:

<old config file name>.config.from_migration

Old license files, kayleigh.config and log4j.properties from v1.6 or higher are kept in:
<Kayleigh v2.x Installation directory>\kroot\kayleigh\config\config_from_migration

Old anonymous print settings are backed up in:

<Kayleigh v2.x Installation directory>\pullp\AnonymousPrintFromIP.config.from_migration
<Kayleigh v2.x Installation directory>\pullp\AnonymousPrintPortToMFPMap.config.from_migration

Old pull printing configuration file SimplifyPrint.config is located in:

<Kayleigh v2.x Installation directory>\pullp\config\config_from_migration

Old database configuration files can be found in:

<Kayleigh v2.x Installation directory>\postgres\db\data\pg_hba.conf_from_migration
<Kayleigh v2.x Installation directory>\postgres\db\data\postgresql.conf_from_migration

30
5.2 Upgrading from v2.x to v2.2 or Higher
To upgrade simply run the latest Kayleigh Installer and follow the instructions. The setup will detect that
an automatic migration is possible and ask you to proceed with that installation, as displayed below:

NOTE

If you have made changes to the Kayleigh configuration files, these changes are not not automatically
promoted to the new Kayleigh installation by the Auto Upgrade Tool and need to be manually
updated. The old configuration files will be migrated and can be found in the same directories as
follows:

Old license files, kayleigh.config and log4j.properties are kept in:

<Kayleigh v2.x Installation directory>\kroot\kayleigh\config\config_from_migration

Old anonymous print settings are backed up in:

<Kayleigh v2.x Installation directory>\pullp\AnonymousPrintFromIP.config.from_migration
<Kayleigh v2.x Installation directory>\pullp\AnonymousPrintPortToMFPMap.config.from_migration

Old pull printing configuration file SimplifyPrint.config is located in:

<Kayleigh v2.x Installation directory>\pullp\config\config_from_migration

Old database configuration files can be found in:

<Kayleigh v2.x Installation directory>\postgres\db\data\pg_hba.conf_from_migration
<Kayleigh v2.x Installation directory>\postgres\db\data\postgresql.conf_from_migration

31
5.3 Upgrading from v2.5/2.5.1
When upgrading from v2.5/2.5.1, existing print rules may need to be split into multiple new rules if they
used one or both of the following rule criteria:

 “block if above page count”

 “reroute if above page count”

This is because prior v2.6, it is possible to define a page count threshold value for the above two criteria
within a rule, but from v2.6 the threshold value can only be defined at the rule level and apply to all
criteria within the rule.

From v2.6, you can only define an Apply at (Pages) threshold value at the rule level and the value will apply
to all criteria within the rule.

If your pre-v2.6 installation did not have any print rules set up, or no rules that contained either the “block
if above” or “reroute if above” rule criteria then no changes will be made to the existing rules and you can
ignore this section.

Otherwise existing print rules will be split as follows:

 Each active “block if above” and “reroute if above” criteria within a rule will be taken out of the
exiting rule and created as a new rule with the original page count threshold applied.

 The new priority order after rule splitting is as follows:

o The new “block if above” rule

o The new “reroute if above” rule

o The existing rule that contains the remaining criteria and have page count threshold set to
1.

 The overall priority order will be retained. Any new rules will be inserted at their original rule’s
position and all other rules with a lower priority will be adjusted downwards automatically

 Any new rules created during this process will keep the original rule’s name but have “__1” or
“__2” appended to the name depending on how many new rules are created

32
6 Frequently Asked Questions
 I still get the error “Cannot find license file” after installing the license files.
If you still get the error “Cannot find license file” when accessing the Kayleigh Admin application after
you have installed the license files, please reboot a Kayleigh controlled MFP, this will force the Kayleigh
application to re-validate the license.

33