This section discusses Windows Server Failover Clustering and how to configure the PaperCut Application Server within a cluster. There are separate pages for Veritas Cluster Server and Novell Cluster Services.
This section assumes that you have an already installed a working HA printing environment (see note above for current supported approaches)
Clustering of some key application layers
The below steps cover failover clustering of some key PaperCut NG/MF’s Service Oriented Architecture software layers, including:
- Clustering at the Application Server layer
- Optional clustering at the database layer.
This approach introduces failover (Active/Passive) clustering in the Application Server layer. This involves having an instance of the Application Server on each of the cluster nodes. When one node fails, the other automatically takes over the operation.
Both instances use a shared data source in the form of an external database (see Deployment on an external database (RDBMS)). Large sites should consider using a clustered database such as Microsoft SQL Server.
Step 1 - Application Server installation
On one of the cluster’s nodes, install the PaperCut Application Server component by selecting the Standard Install option in the installer. Follow the set up wizard and complete the process of importing all users into the system.
Step 2 - Convert the system over to an external database
The system needs to be configured to use an external database as this database is shared between both instances of the Application Server. Convert the system over to the required external database by following the procedure detailed in Deployment on an external database (RDBMS). The database can be hosted on another system, or inside a cluster. As per the external database setup notes, reference the database server by IP address by entering the appropriate connection string in the server.properties file.
Step 3 - Setup of 2nd node
Repeat steps 1 and 2 on the second cluster node.
Step 4 - Distribute application subscription or license
If you’re using PaperCut NG/MF version 23.x or earlier:
- Install your license file on each node in your cluster. See Installing a license for more information.
If you’re using PaperCut NG/MF version 24.x or later:
- If you’re a subscription customer:
- Activate your subscription (Activating/renewing a subscription) on the currently active node.
- Copy the
server.uuidfile from[app server install]\server\server.uuidto the same location on the other passive node(s).
- If you’re a perpetual customer:
- Install your license (Installing a license) on the currently active node.
- Copy the
server.uuidfile from[app server install]\server\server.uuidto the same location on the other passive node(s).
Step 5 - Decouple service management from the nodes
By default the PaperCut Application Server component is installed under the management of the node. It needs to be managed inside the cluster, so set the service’s start-up type to manual. On each node navigate to Control Panel > Administrative Tools > Services locate the PaperCut Application Server. Stop the service and set its start-up type to Manual. Repeat this on each node.
Step 6 - Create a new cluster group
Designate the PaperCut Application Server to run inside its own cluster group. Create a new cluster group containing the each of the nodes. Add an IP Resource and a Network Name resource. Give the network name resource an appropriate title such as PCAppSrv.
The need for a new cluster group is not required. It is, however, recommended as it gives the most flexibility in terms of load balancing and minimizes the potential for conflicts.
Step 7 - Adding the PaperCut Application Service as a resource managed under the new cluster group.
- Open the Cluster Administrator.
- Right-click the cluster group hosting the spooler service; then select New > Resource.
- In the new resource wizard, enter a name of
PaperCut Application Server, select a resource type of Generic Service, then click Next. - Click Next at Possible Owners page.
- Click Next at Dependency page.
- On the Generic Service Parameters page, enter a service name of
PCAppServer, ensure the Use Network Name for computer name option is checked; then click Next. - Click Finish at the Registry Replication page.
Step 8 - Bring the cluster group online
Right-click the cluster group; then select Bring online. Wait until the Application Server has started, then verify that you can access the system by pointing a web browser to :
http://[Virtual Server Name]:9191/admin
Log in, and perform some tasks such as basic user management and User/Group Synchronization to verify the system works as expected.
Step 9 - Client configuration
The client and Release Station programs are located in the directories:
[app-path]/client/[app-path]/release/
These directories contain configuration files that instruct the client to the whereabouts of the server. Update the IP address and the server name in the following set of files to the Virtual Server’s details (Name and IP address):
[app-path]/client/win/config.properties[app-path]/client/linux/config.properties[app-path]/client/mac/PCClient.app/Contents/Resources/config.properties[app-path]/release/connection.properties
Edit the files using Notepad or equivalent and repeat this for each node. Also see PaperCut User Client configuration.
Step 10 - Test
This setup is about as complex as it gets! Take some time to verify all is working using your standard failover testing. It’s also good to ensure that PaperCut NG/MF is tracking printing from your print server environment.
Clustering tips
-
Take some time to simulate node failure. Monitoring can stop for a few seconds while the passive server takes over the role. Simulating node failure is the best way to ensure both sides of the Active/Passive setup is configured correctly.
-
It is important that the version of PaperCut running on each node is identical. Ensure that any version updates are applied to all nodes so versions are kept in sync.
-
The PaperCut installation sets up a read-only share exposing client software to network users. If your organization is using the zero-install deployment method, the files in this share are accessed each time a user logs onto the network. Your network might benefit from exposing the contents of this share via a clustered file share resource.
-
PaperCut regularly saves transient state information (such as print job account selections) to disk so that this state can be recovered on server restart. If failing over to a new cluster server, you should ensure this state information is saved to a location available to the new server.
By default the state information is located in
[app-path]/server/data/internal/state/systemstate. You can change this location if required by setting the propertyserver.internal-state-pathin your server.properties file.
Regarding Print Services and the Print Provider
In this implementation, the Print Services can not be clustered at a service level (per the note at the top), and neither can the Print Provider as it’s a dependency on the spooler.
With this in mind, customers using service clustering for the Application Server should should not host print queues on their App Servers. Instead, we recommend customers use a different approach for Print Server HA, such as:
- VM Clustering (where the Print Server VM and it’s associated Print Provider is moved between nodes)
- Hosting Multiple Print Servers behind a Network Load Balancer (Like an F5).
- Note: If setting up Multiple Print Servers behind an NLB, we recommend leveraging Mobility Print as well on those print servers.
Additional configuration to support Web Print
By default the Application Server looks in [app-path]\server\data\web-print-hot-folder for Web Print files. This location is generally only available on one node in the cluster. To support Web Print in a cluster, add a Shared Folder on the Shared Storage in your cluster.
To change this location, use the Config Editor and modify the web-print.hot-folder key.
-
Add a Shared Folder on the Shared Storage, an example would be
E:\web-print-hot-folderand share it as\\clustername\web-print-hot-folder\. -
Click the Options tab. The General age is displayed.
-
In the Actions menu, click Config editor (advanced).

The Config Editor page is displayed.
-
Modify
web-print.hot-foldertoE:\web-print-hot-folder -
Map your selected network drive on the Web Print Sandbox machine to
\\clustername\web-print-hot-folder\ -
Add all relevant printer queues from
\\clusternameto the Web Print Sandbox server.
Additional configuration to support Print Archiving
If you have enabled Print Archiving (viewing and content capture), the Applications Server stores archived print jobs in [app-path]\server\data\archive. This location is generally available only on one node in the cluster. To support Print Archiving in a cluster, add a Shared Folder on the Shared Storage in your cluster. This location must be accessible to all cluster nodes and also any print servers that are collecting print archives.
For instructions for moving the archive location see Phase 1: Moving the central archive:. This describes how to configure both the Application Server and your print servers to use the same shared storage location.
Comments
Comments are not available in this preview environment. On papercut.com, this space shows the live Disqus comment thread for this page.