The PaperCut NG activity tracking and charging is implemented using 100% server-side technology. User ClientThe User Client tool is an add-on that resides on a user's desktop. It allows users to view their current account balance via a popup window, provides users with the opportunity to confirm what they are about to print, allows users to select shared accounts via a popup, if administrators have granted access to this feature, and displays system messages, such as, the "low credit" warning message or print policy popups. software is not required as part of the activity monitoring process.
Note: The use of client software for activity monitoring could open up security problems as client software is readily accessible to end-users. By design PaperCut Software developers endeavor to implement all monitoring at the server level eliminating client-side loopholes. The client software supplied with PaperCut NG is a presentation layer around server-side implementation.
Client software is provided to facilitate four tasks:
Allow users to view their current account balance via a popup window.
Provide users with a "last chance" before printing, confirming what they are about to print.
Allow users to select shared accounts via a popup, if administrators have granted access to this feature.
Display system messages such as the "low credit" warning message or print policyPrint policies allow you to remind users via popup to print duplex, route large jobs to dedicated high-volume printers, discourage users from printing emails, discourage printing web pages in color, and print policies can be implemented in PaperCut using advanced scripting. popups.
The client software is available for most major platforms including:
Mac OS X
Linux and Unix
The client software and deployment tools are installed automatically on the server under the [app-path]\client directory. On a Windows based server this directory is automatically shared in read-only form providing network users with access to the client executables.
The following sections contain further information about the User Client:
User Client Options—command line and config options.
Customizing the User Client Tool window—customization of the User Client .
You can customize the behavior of the User Client, such as, where on the screen it pops up or which option is selected by default. For more information, see User Client Options. To educate the users about the User Client, administrators might find the Example User Information Sheets helpful.
User Client Deployment
Deployment on Windows
You can deploy the PaperCut NG client software to workstations using a variety of deployment methods. The deployment options are covered in detail in the [app-path]\client\README.txt file.
If you're after a manual "setup wizard" style installer, run the program client-local-install.exe located in the network share PCClient. You can access this share by typing the following address into Windows Explorer. \\<MyServer>\PCClient\win, where MyServer is the name of the server where PaperCut NG is installed.
Administrators looking for an automated install/deployment option should consider the "zero install" strategy. This is the recommended strategy for most Windows network environments as it's 100% self-maintaining.
Administrators can also deploy via MSI package, allowing the Client software to be remotely installed via Group Policy. This option is available for advanced sites that already leverage MSI packages for staged software deployment and want to continue with this procedure.
The recommended approach with Windows networks is the "zero install" strategy. This involves configuring the workstations via group policy or otherwise, to run the client executable directly off the PCClient share - a share set up during installation. This avoids the need to for a separate installation process on each workstation and ensures the client software is automatically updated in conjunction with server updates.
You can run the client directly from the PCClient share setup on the server. Two executables provide this launch functionality:
pc-client.exe launches the client directly off the network share. The "local-cache" version (pc-client-local-cache.exe), is a smarter version that first copies itself and associated files to the local drive and launches itself from there. The local-cache version has the advantage that any future startups use the local copy, which minimizes network traffic. The cache is self-managing and kept up-to-date ensuring that any new versions of the client are automatically and transparently copied down to the client.
Using pc-client-local-cache.exe is recommended on large networks. It does, however, require a globally writable cache directory. By default the cache is created in a directory on the system drive (normally C:\Cache). You can specify an alternate cache with the --cache command-line switch. Administrators should ensure than standard users have write access to the system drive, or manually create the cache directory if required.
The zero-install deployment option is not appropriate for all situations. A local install is recommend on Windows Laptop systems that are not permanently connected to the network or centrally managed by network administrators. The client-local-install.exe program can assist end users with a standard "setup wizard" install process. You can also streamline/automate this installer by using command-line options. Fore more information, see Automating / Streamlining Installation on Windows.
The recommended way to launch the pc-client-local-cache.exe on startup is to add a line to your Domain login script:
cmd /c "start \\servername\PCClient\win\pc-client-local-cache.exe --silent"
See below for other automatic start options.
For more information on alternate deployment options see the [app-path]\client\README.txt file.
Deployment on Windows via Silent Installer MSI
The User Client software is available as a silent-install MSI (no clicks or wizards). This option is available for advanced sites that already leverage MSI packages for automated software deployment and upgrades using Active Directory Group Policy options. We recommend using the pc-client-local-cache.exe version of the User Client for most deployments, as all updates are automatically pushed to client machines. The MSI option discussed here must be manually updated.
The MSI package is a great option for organizations managing staged rollouts via Group Policy Filters. It is common in large organizations to progressively roll out new software as a series of small steps, for example, the IT department might get the software first, followed by a roll out across the organization.
Important: Ensure these steps are conducted by an administrator experienced with Active Directory MSI software deployment.
Step 1 - Copy User Client files to deployment location
Copy the all client files and subdirectories from
into a versioned folder on your domain, alongside your other MSI-deployed software, e.g.
Do not deploy the MSI directly from the PaperCut install directory because the contents of this directory change when PaperCut is upgraded. This results in problems in your MSI deployments.
Unlike some other MSI packages, this file is not a self-contained archive - it must be copied along with the rest of the PaperCut client files when preparing your deployment.
Step 2 - Configure the User Client
If you need to make adjustments to the client (such as modifying config.properties or adding a custom logo), now's the time to do so. Changes made are distributed to your domain as the MSI deploys.
Step 3 - Deploy the MSI
Deploy the pc-client-admin-deploy.msi to your domain, as a Software Installation component to a Group Policy Object. The procedure for MSI deployment via Group Policy is explained in Microsoft's Knowledge Base: http://support.microsoft.com/kb/816102.
Step 4 - Configure for auto launch
Configure pc-client.exe to launch automatically at startup, as you would for any other program. One option is to add the User Client application to your GPO's "Run these programs at user logon" setting, found under Computer/User Configuration > Policies > Administrative Templates > System > Logon
Tip: To deploy to a heterogeneous environment of 32 and 64-bit systems, the default install paths are different for each architecture. A simple solution to this path problem is to launch the client from both C:\Program Files and C:\Program Files (x86) paths, as in the screenshot above. The non-matching path silently fails.
An alternate option is to start the client from an existing user logon script. An example of the line to add to the logon script is:
cmd /c "start "C:\Program Files\PaperCut NG Client\pc-client.exe --silent"
Older machines might require an upgrade to the Windows Installer Service. If so, the following error message is displayed:
"This installation package cannot be installed by the Windows Installer Service. You must install a Windows service pack that contains a newer version of the Windows Installer Package"
To resolve this, download and install the Windows Installer 4.5 Redistributable, from: http://www.microsoft.com/en-us/download/details.aspx?id=8483
Upgrade an MSI Installation
The procedure for upgrading an already-deployed installation of the client (e.g. from 12.3 to 12.4) is slightly different to that of the initial deployment - add the updated MSI packages to your original GPO as an upgrade item. For step-by-step instructions on the procedure, see Microsoft's Upgrade Guide at: http://technet.microsoft.com/en-us/library/cc783421%28v=ws.10%29.aspx
Do not replace an old MSI with a newer version. If after following the instructions in the Microsoft article above you're still unsure how to proceed, please seek assistance, or contact technical support.
Windows 8 Metro Requirements
Windows 8 a introduced a new user interfaceThe User Web Tool is the web user interface. It provide a range of services for users, including a summary of usage and balance history, a list of the shared accounts that the user can use for printing, the current costs for printing usage, ability to add balance by using a TopUp/Pre-Paid Card or an external payment system (when using the payment gateway module), transfer funds to other users, view a history of balance transactions, view a list of the user's recent printing, and view print jobs pending release (when using a Release Station). called Metro. It has a tile based start screen or runs one application at a time. This user interface is also known as the "Windows 8-style UI".
When the Windows 8 user interface is in Metro mode, Windows Desktop applications are not visible. This includes notifications such as the PaperCut Client popup. Therefore the Client popup could be missed.
PaperCut uses a Toast notification to notify user in Metro mode that a notification requires their attention in Metro mode.
With the Toast notification, users working in metro mode are notified of all PaperCut activities that require their attention in Desktop mode.
Deployment on Mac OS X
This section covers the installation of the PaperCut client on Apple Mac systems. Before installing the client software, review Mac Printing in Detail and first ensure printing is working as expected.
The PaperCut Mac client is a supplied as a native Mac .app package. The client is delivered in two flavors:
The current client, which supports Mac OS X 10.7 (Mountain Lion) and above.
The legacy client, which supports Mac OS X versions from 10.4 to 10.6. It is a universal application that runs on both PowerPC and Intel hardware. The legacy client will not receive future feature enhancements.
Apple has switched to a yearly release cycle for Mac OS X, which means it is difficult to keep this documentation up to date. For the most recent and up-to-date information on current best practices, see the Knowledge Base.
For Mac OS X 10.7 and later
For Macs running 10.7, 10.8, 10.9, 10.10, 10.11, and later, the best way to establish set launch behavior patterns for the PCClient.app is to use LaunchAgents managed by LaunchD. For more information, see http://www.papercut.com/kb/Main/MacClientStartupWithLaunchd.
For legacy Mac OS X (10.6 and earlier) solutions:
For Macintosh computers running versions of Mac OS older than 10.7, the following three common installation methods cover most situations. The instructions for the "single user install" follow the standard Mac application installation process and can be conducted by any Mac end-user. The other installation methods are more technically focused and aimed at Mac network administrators.
Special Notes for Mac OS X 10.6 and earlier
Note: The current version of the PaperCut client does not work on Mac OS X 10.6 and earlier. For these systems the legacy client must be used. If the client fails to start, ensure you are using the correct client for your system.
The legacy client is found in [app-path]/client/legacy. Use this path to locate the client when referenced in the following sections.
The legacy client software works best if Java 5 (or higher) is installed. Java 5 is available for OS X 10.4 or above. If Java is not already installed, the installer is available from the Apple website. This simplest way to install Java is to run /Applications/Utilities/Java Preferences from OS X Finder, and you are prompted to complete the installation.
Single User Install
This method is suitable for a Mac computer used by a single user. For example, a personal Mac desktop or laptop. The installation process involves clicking the client-local-install program. This copies the PCClient application into the over to the system's Applications folder and starts the client in the "confirm network identity" mode. The simplest way to run the install process is to connect to a Windows server's pcclient share over the network, however, alternate methods such as copying the folder contents via a USB key or drive are also possible.
To install the Mac client from a server's share:
Start and Log in to the Mac computer. Ensure it's connected to the network.
Open the Finder.
From the Go menu, select Connect to Server.
Enter the pcclient share's connection details, such as: smb://server_name/pcclient.
Enter password information if requested.
Double-click the client-local-install file. This executes a small AppleScript program that starts the install/copy process. (If installing on a legacy system (OS X 10.6 or lower) you must install the legacy client located in the legacy folder.)
Test the application by double-clicking the PCClient application icon in the system's local Applications folder.
If the user needs the client for printing - for example, to use the shared accountA shared account is an account that is shared by multiple users. For example, in business, shared accounts can be used to track printing costs by business unit, project, or client. Organizations like legal firms, engineering firms, or accounting offices often have long lists of accounts, projects, clients, or matters. In a school or university, shared accounts can be used to track printing by departments, classes, or subjects. popup - it's advisable to configure the application to automatically open upon start-up:
Open System Preference from the Apple menu.
Select your login account.
Click the Login Items tab.
Click + and browse and locate the PCClient application.
Test by restarting the computer. The client should start automatically after the reboot and login procedure is complete.
On a multi-user Mac system, setting up a Login Item for each user would be a tedious task. To streamline this process, you can configure the PCClient application to start on login via the login hook. A login hook is an advanced Mac feature that works by running a script when a user logs in. The PCClient package includes a command script resource that installs the login hook.
To install the client on a multi-user system:
Start and Log in to the Mac computer. Ensure it's connected to the network.
Open the Finder.
From the Go menu, select Connect to Server
Enter the pcclient share's connection details like: smb://server_name/pcclient
Enter password information if requested.
Drag the PCClient (or legacy/PCClient on OS X 10.6 or lower) package over to the local hard disk's Applications folder. The copy process begins.
Control+click the newly copied PCClient application in the Applications directory. Select Open Package Contents.
Navigate to Contents/Resources/.
Double-click the install-login-hook.command script.
Restart the system and verify the client starts on login.
Important: If you're already using a login hook for other script tasks, the setup process is different. Instead in step 9, double-click the set-permissions.command file. Then insert the following line at the end of your current login script (all on one line):
The set-permissions.command script ensures the software is set up with the correct permissions, ensuring it's accessible to all users.
You can remove the login hook, once installed, with the terminal command:
sudo defaults delete com.apple.loginwindow LoginHook
This deployment method is for advanced Mac network administrators and is suitable for medium to large Mac networks. Knowledge of the Mac's Unix underpinning and scripting is required.
A more flexible option over locally installing the PCClient package on each Mac system, is to directly launch the client from the pcclient share. The advantage of this deployment method is that any updates applied on the server (and updates to the client directory) are automatically propagated to all workstations.
The process of setting up zero-install deployment varies form network to network depending on the directory environment in use and administrator preferences. The process can, however, be summarized as:
Configure the Macs to mount the pcclient share as a volume on login or start-up.
Configure a login hook to start the client off the share. The install-login-hook.command resource script explained in the multi-user install above might help.
The typical way to mount the share is to use mount_smbfs in a boot script. See the Apple documentation on mount_smbfs at: http://developer.apple.com/documentation/Darwin/Reference/ManPages/man8/mount_smbfs.8.html
Further information on Mac printing is available at Mac Printing in Detail.
Deployment on Linux and Unix
You can deploy the PaperCut NG User Client software on Linux and other Unix based operating systems using the following installation procedure.
Step 1 - Install Java 8.0+
Linux and Unix workstations are supported via Java. Java version 8.0 or higher is required. Your Linux distribution might have Java pre-installed or have the option to install. If no Java option exists, Oracle provides a self-install Java distribution for Linux and other major Unix platforms.
Ensure Java 8.0 is installed and the JAVAHOME environment variable is defined on the PATH.
Step 2 - Copy (or Mount) the PaperCut NG User Client files
Similar to the Windows version of the client software, the Linux/Unix Java version is installed in the ~/client directory on the server. Copy or make available to the Linux/Unix workstation, all files in this directory. Common methods include:
Copying the files from the server using file transfer programs such as FTP or scp.
If the server is Windows based, connecting using smbclient or the Gnome or KDE smb:// file browsing tools. The client files are shared via a read-only share called \\[server_name]\PCClient.
If the server is Linux based, consider exporting the ~papercut/client directory via NFS and mounting on the workstations. The client can then be ran directly from the mount.
If the workstation is used by multiple users, copy the client directory to a common location such as /usr/local/papercut/client.
Step 3 - File permissions
Open a command prompt and set execute permissions on the pc-client-linux.sh file as follows:
chmod 755 ./pc-client-linux.sh
Step 4 - Testing
Log on as a user (a user listed in the PaperCut NG system) in your preferred Linux desktop GUI environment. Locate and execute the file /usr/local/papercut/client/pc-client-linux.sh. The PaperCut NG client should open displaying the user's account balance.
It is usual to configure the client as a "Startup Program" or "AutoStart Program" launched during login. See your desktop documentation to see how to define a startup program.
A number of command-line options are available to change the client's behavior. For more information, see User Client Options.
Share your findings and experience with other PaperCut users. Feel free to add comments and suggestions about this Knowledge Base article. Please don't use this for support requests.