Index
1. Introduction _____________________________________________________ Page3 2. Windows Cluster _________________________________________________ Page3 2.1 High availability Cluster ___________________________________________ Page3 2.2 Shared Storage Device ____________________________________________ Page4 2.3 Active Passive Mode ______________________________________________ Page4 3 Boundary conditions _______________________________________________ Page4 4. Installation of Kyocontrol Enterprise ___________________________________Page5 5 Settings of Kyocontrol Enterprise Admin _______________________________ Page6 5.1 Host Name _______________________________________________________ Page6 5.2 Communication ___________________________________________________ Page6 5.3 Log files _________________________________________________________ Page7 5.4 Jobs _____________________________________________________________Page8 5.5 Scan to File _______________________________________________________Page8 6 Mercury _________________________________________________________ Page9 7 Kind of start services _______________________________________________ Page9 8 Kyocontrol Enterprise Installation on second Cluster Node _________________ Page10 9 Services in Cluster Management as Resource ____________________________Page10 9.1 New Resource ____________________________________________________ Page10 9.2 Possible Owners ___________________________________________________Page11 9.3 Dependent relationship _____________________________________________ Page12 9.4 Global Service Parameters __________________________________________ Page12 9.5 Replication and Finish _____________________________________________ Page13 10 Bring the Resources Online _________________________________________ Page14 11 Adding Printer Queues _____________________________________________ Page15 11.1 New Resources ___________________________________________________ Page15 11.2 Possible Owner ___________________________________________________ Page16 11.3 Dependent relationship _____________________________________________ Page16 11.4 Print Spooler Parameters ___________________________________________ Page17
Index
12 Printer Driver Installation ____________________________________________ Page17 12.1 Create a Port ______________________________________________________ Page18 12.2 Driver Installation __________________________________________________ Page21 12.3 Share Driver and Finish installation ____________________________________ Page22 12.4 Separator Page _____________________________________________________ Page22 12.5 Printer Settings ____________________________________________________ Page22 13 Connect the Printer Driver ____________________________________________ Page23 14 Start second Cluster Node ____________________________________________ Page24 15 Kyocontrol Enterprise Clients _________________________________________ Page25 16 Scenarios _________________________________________________________ Page26 17 License Kyocontrol Enterpise Edition in a Cluster _________________________ Page29
1.
Introduction
This Document describe the Installation of Kyocntrol Enterprise on a Windows 2003 Cluster system with two Cluster nodes.
This document will not describe the Installation of a Microsoft Windows 2003 cluster, this Document is a How To for Installing Kyocontrol Enterprise in this kind of environment You should have knowledge about Cluster for Topics like Cluster Node, Cluster Resources, And Cluster Groups, this will also not describe in this How To Manual.
2.
Windows Cluster
A Microsoft Windows 2003 Cluster can be used for. - High availability
- High Performance - Load Balancing
This How To will describe the High availability Installation other kind of Cluster are not tested already or be QA.
2.1 High availability Cluster
A High availability Cluster is a Cluster System that will be used for high system stability. Multiple Hardware devices will be combined together to one Cluster group. If one of the Hardware devices will be down for example damage Hardware the next Hardware device will be used as Fall Over automatically.
Users will in normal way not recognize the Hardware failure.
This How To describe the Installation for Kyocontrol Enterprise on this type of Cluster. The example in this How To will use two Windows 2003Eenterprise Server Cluster will be switched as active / passive Cluster (asymmetric units).
That mean Cluster Node A is active and Cluster Node B is passive if Cluster Node A run into however a Problem automatically Cluster Node B will be actives.
For our Instructions we will use “clusternodea” and “clusternodeb” take care of the Resources of this two Cluster Nodes, you must define the Services and Programs in the Cluster
2.2
Shared Storage Device
Shared Storage Device is a physical Disk Array that is attached to the Cluster Nodes A and B a Shared Storage device is not dedicated physical to one of the Cluster Nodes.
So it is possible that the Cluster that is up get access to the Data and Files instead of the Cluster Node that will be down.
2.3
Active Passive Mode
In a Active / Passive Configuration only one Cluster Node is active the second Cluster Node run in Passive Mode.
In the cluster Management of the passive Cluster Node all Services are setup in manual and stopped. The passive Cluster Note has no Access to the Shared Storage device.
The Installation of Kyocontrol is only possible on the active Cluster Node that has access to the Storage Device.
3.
Boundary conditions
The following Boundary conditions must be provide for this How To .
- Installed Cluster System Windows 2003 Enterprise with two Cluster Nodes Named in this How To “clusternodea” and “clusternodeb” (only example) - Same Cluster Name in this How To “clustercompany” (only example) - Shared Storage Device (Disk Array) accessible for both Cluster Nodes
- Minimum one Active Directory at the Cluster and one User (without Administrator rights) in this How To User “sample” (only example)
4.
Installation of Kyocontrol Enterprise
The Installation of Kyocontrol Enterprise Editon must be done on both Cluster Nodes, for Installation on “clusternodea” switch off “clusternodeb”.
Start the Kyocontrol Setup, the Application Parts of Kyocontrol can be installed at the local Hard Disk on “clusternodea” only the Database must be installed at the Shared Storage device in our example “ Drive F:\” that “clusternodea” and “clusternodeb” can reach the Database at the Shared Storage Device “Drive F:\”.
When you Setup the Database you have to specify the global Cluster Network Name, and the Folder at the Shared Storage device where to place the Database example:
- Host name Clustercompany
- -Database Folder: F:\KYOcontrol\database - Other Parameters must not be set
Picture 4.1
Specify Hostname and
5.
Settings of Kyocontrol Enterprise Admin
Now you have to setup some Parameters in Kyocontrol Admin the Host name must be setup, Path for the Database must be changed, that Kyocontrol get access to the Database placed at the Shared Storage Device.
5.1 Host Name
- Hostname “clustercompany”
Picture 5.1
Enter the Hostname in Field: Host Name in the Properties of the Kyocontrol Server.
5.2 Communication
The Path for local Data must be setup to the Shared Storage device this will be done in the Communication Writer
Path for local Data: F:\KYOcontrol\DB_Files
Picture 5.2
Setting Path for Local Data Files At Properties of the Kyocontrol Server
5.3 Log files
Also the Path for the Log Files and Reporting must be setup to the Shared Storages device - Path for Log Files : F:\KYOcontrol\LogFiles
- Path for Reporting : F:\KYOcontrol\RepFiles
Picture 5.3
Setup for Log files Setup for Reporting
5.4 Jobs
The Path for Print Jobs will be setup in the Services of the Kyocontrol Server the Path must be setup to the Shared Storage device at tab “Jobs”
- Path : F:\KYOcontrol\PrnFiles
Picture 5.4
Setup Path for Print Jobs at Kyocontrol Server Services
5.5 Scan to File
If you using the Option Scan to File, the Path where the Scan Files will be stored must be also setup to the Shared Storage Device at Scanner Settings in tab Scan to Files
- Path: F:\KYOcontrol\ScanFiles\Private for Private Scans - Path : F:\KYOcontrol\ScanFiles\Public for Public Scans
Picture 5.5
Setup Path for Scan to File for Private And Public Scan at Kyocontrol Server
6 Mercury
Mercury can not be installed on the Shared Disk Storage Device; the SMTP Server for Kyocontrol must be installed on every Node in the Cluster environment in our example on Node A and Node B.
7.) Kind of start services
The installed Services for Kyocontrol must now be setup to Manual so the Cluster Management will take care of starting the services, which are needed for Kyocontrol Enterprise Edition. Witch services and peaces are depending from who Kyocontrol Enterprise is installed, here the possible services you have to control, and setup to Manual:
- Firebird Guardian - Firebird Server
- Kyocontrol Enterprise File Import - Kyocontrol Enterprise LDAP Import - Kyocontrol Enterprise Report
- Kyocontrol Enterprise Server - Mercury
Picture 7.1
It is also possible to leave the services in Standard after Installation, the Cluster Management can also handle stopping and starting the services, but for the Installation on clusternodeb we have to stop the Services and set it to Manual by using start/Programs/Administrative Tools/Services. After the Installation on clusternodeb the Cluster Management will start the services for Kyocontrol Enterprise and the Cluster Recourses and also take care of it for a failed over.
8 Kyocontrol Enterprise Installation on second Cluster Node
To install Kyocontrol on clusternodeb please switch off clusternodea , that clusternodeb can access the Shared Storage device for Installation.
Install now Kyocontrol Enterprise Edition simulate to Chapter 4 and Chapter 5 of this How TO, The settings of Chapter 5 will be done automatically the settings are stored in the Database. After the Installation setup the Services that ar described in chapter seven, to manual and stops the services.
9 Services in Cluster Management as Resource
In order that the Cluster Management can switch the service (Failover) from one System to the next one, for example from clusternodea to clusternodeb you have to create a Cluster Group in a Cluster Resource in our example Cluster Group 0.
9.1 New Resource
- Name of the Cluster Resource Kyocontrol Enterprise (Display Name) - Resource Type Generic Services
- Cluster Group 0
Picture 9.1
Ner Resource Type with Generic Services And Cluster Group
9.2 Possible Owners
Both Cluster Nodes clusternodea and clusternodeb must be owner of this Resource and Group, to get access to the Database and the Shared Storage device, infect of a failed over situation.
Picture 9.2
Possible Owner must be both Cluster Nodes.
9.3
Dependent relationship
The Service is coactive depending from the Resource of the Cluster Name. Other Services ar no coactive from the Resource Cluster Name, but we recommended it to set it up in the same way. - Cluster Name
Picture 9.3
Dependent Relationship of the Server Services from the Cluster Name.
9.4 Global Service Parameters
In the Service Parameter the Name of the Name of the Service must be Setup, not the Display Name of the Cluster Group please look Page 7 Picture 7.1.
- KyocontrolEnterpriseServer
- Use Network Name as Computer Name
Picture 9.4
Parameter of the Service Use Network Name as Comupter Name.
9.5 Replication and Finish
For the Registry key Replication no special key must be added click finish, and the Cluster Group will be create.
Picture 9.5
No special Registry key is needed for the Registry Replication
Important
This procedure must be done with every service you will control by the Cluster Management means for:
- Firebird Guardian - Firebird Server
- Kyocontrol Enterprise Server - Kyocontrol File Import - Kyocontrol LDAP Import - Kyocontrol Reports
10 Bring the Resources Online
After you have add all Services to the Cluster Resource the Cluster Group must be switch Online After switch the Cluster Group online, the Cluster Management will take care of the services, if the Group is switch offline, also all Services in this Group will be stopped.
Picture 10.1
Check the Active Resource, that the Kyocontrol Services are Online. Picture 10.2
11 Adding Printer Queues
The print Queues can not be added to one of the local Cluster Nodes, for a failed over procedure the Print Queues must be add as a Cluster Resource to switch the Queues in a failed over
Situation.
So the Print Queues must be added as Print Spooler.
11.1 New Resources
To add the Resource use the following Parameters - Name Kyocontrol – Printer
- Resource Type Print Spooler - Group Cluster 0
Picture 11.1
New Recourse Type Printer Spooler Cluster Group Name KyoControlPrinter.
11.2 Possible Owner
Both Cluster Nodes must be Owner of the Print Spooler Resource to connect to the
Printer Spooler.
Picture 11.2
Possible Owners must be both Cluster Nodes A and B
11.3 Dependent relationship
The Print Queue needs tow depending Resources one from Type Cluster Name and Shared Storage Device.
Picture 11.3 - Cluster Name
11.4 Print Spooler Parameters
The Print Queue must be Setup to the Shared Storage device where the Spool Files should be stored.
- Resource KyocontrolEnterpriseServer - Use Network Name
- as Computer Name
Picture 11.4
Parameter of the Print Spooler On the Shared Storage Device
12 Printer Driver Installations
To add a Printer driver to the crated Print Spooler Resource use start/run and use the Cluster name for the Installation
Picture 12.1
The following Explorer Windows will Pop Up:
Picture 12.2
Click on Add Printer and Faxes to start Printer Driver Installation
12.1 Create a Port
Crate a Printer Port use the Cluster Name for Printer Name or IP Adress and the Port Name should be KYOControl.
Picture 12.3
Add Print Wizard Create TCP/IP Port
Use Cluster Name for Printer Name or IP Address and Port Name KYOControl
Picture 12.4 Cluster Name as
Printer Name or IP address Port KYOControl
Click on Custom Settings and Setup Port 9500
Picture 12.5 TCP/IP Settings Port 9500
12.2 Driver Installation
Now the Printer driver can be installed we recommended to use Kyocera WHQ Classic PCL or KPDL drivers signed by Microsoft.
Specify a Printer Name, in a Cluster environment the Printer Name is not matched to a physical Printer, so we use in this example the Printer Name “KYOControl”.
Picture 12.6
12.3 Share Driver and Finish Installation
Share the driver, and click next, if you would like you can type in A Location of the Printer and a Command for example witch Kind of Printer Black or white or color.
Finish the Installation without printing a Windows Test pages, this makes no sense at this Moment, there are no devices setup in Kyocontrol Enterprise Editon..
12.4 Separator Page
Copy the Separator Page that can be find in \\Windows\System32\KYOControl.sep to the Shared Storage Device for example at F:\KYOControl\KYOControl.sep.
12.5 Printer Settings
Now setup the important setting in the Printer Driver for Kyocontrol Enterprise Edition this will be:
Picture 12.7
- Start Print after last Page is spooled - Enable Advanced Printer Features off - Setup Separator Page
Now install the Separator Page for Kyocontrol Enterprise KYOControl.sep this is important Kyocontrol Enterprise will read the User Information from this special Separator Page Picture 12.8
Separator Page Setup
After setup the Separator Page the installation of the Printer Driver for Kyocontrol Enterprise is finished.
13 Connect the Printer Driver
No the driver can be shared to the Client from the Server, to connect a shared Printer Driver no special Rights are needed the User must be only a Member of Domain User Group.
Picture 13.1 Shared driver
14 Start second Cluster Node
Km2007ADAfter the Install Process is finished the second Node clusternodeb can be started after clusternodeb is started and clusternodea run in to a Failed Over Situation, clusternodeb will automatically used as Switch over Node.
Picture 14.1
After clusternodea ist active again all Kyocontrol Enterpise device will be for a short time inactive, when somebody has print by a Switchover it can happen, that the Devces in Kyocontrol Enterprise Edition must be started manual by using the Kyocontrl Administrator Tool.
Print Jobs started before a Switchover happen, can be printed again, if a Print Job start directly when the Switchover happen, the User will get a Error Message from the Cluster Server.
15 Kyocontrol Enterprise Clients
It is possible to use the Kyocontrol Enterprise Client in a Cluster Environment similar to a Non Cluster environment. Important when the Installation start the Cluster Name has to be use for Installation in a Cluster Environment.
Picture 15.1
Installation of Kyocontrol Enterprise Client in a Cluster Environment
The Kyocontrol Enterprise Client Print Queue is a local Client Print Queue so in a Switch Over Situation there will be no response from the Cluster to the Client, only if the Client start printing when a Failed over happen, at the same time, you will get the following Error Dialog
Picture 15.2
Error Message when print with Kyocontrol
16 Scenarios
Here some situations what happen with the Kyocontrol Enterprise Server in the following issues: Switch Over without Printing
The User will not recognize the Switch Over of the Cluster and can use the Kyocontrol Enterprise System for Printing / Scanning and Fax in normal way.
Switch over when a Print Job start but not already Pick up at the Printer
The Print Job can be picking up by the User after the Switch Over is finished, the User will not recognize this.
Switch Over when starting Printing
User will get a Error Message when using the Kyocontrol Enterprise Client look Picture 15.2 If not User get a Error Message from the Spool System of the Operating System from Windows. Switch Over printing a big Print Job (Spool File)
The Print Job ( Spool File ) will be chancel by the Operating System, and not received into Kyocontrol Enterprise Edition, the Print Job must be resend after the Switch Over.
17 License Kyocontrol Enterpise Edition in a Cluster
First Step load the LIC File to the Kyocontrol System using the Kyocontrol Administrator Tool Klick on System, and License select New, a File Open Dialog will Pop Up
Picture 17.1 System License New LIC File Dialog
Picture 17.2 File Open Dialog to load the LIC File
Second Step is to Activate the License so this will be done in the Database for Activation click on Database Server
Picture 17.3 Database / Server
Next Step right click on Server / Properties and Activation for activate the License you must have a Kyocontrol Cluster License and it must be activate by Host Name.
Important
Use not the Host Name of one Node you have to use the Cluster Network Name in this How To our Cluster Network Name is “clustercompany” otherwise you will run in to Problems to activate the Kyocontrol Enterpise Cluster License.
Picture 17.4
- check Hostname in - in General Tab
Now you can activate the License in the Activation Tab type or copy in your Activation Number Click on Change and Apply / OK the Activation is done.
Picture 17.5 Activation Dialog
Important Check your License was successful
Picture 17.6
