This KB Article does not apply to PaperCut NG or PaperCut ChargeBack. For these editions, consult the README.txt file located in the [app-dir]/client directory.

The PaperCut User Client Tool is a simple program that provides network users with access to their account balance. It is usually set to display when a user logs onto a workstation. Note: The User Client Tool is optional. PaperCut is implemented using 100% server-side technology and no client software is required.

PaperCut will automatically setup a special shared folder on the server called 'PCSetup' containing the installation program and pre-configured configuration files and scripts. As of PaperCut version 5.2, the User Client Tool can be deployed using a zero-install strategy. (i.e. the 'PCSetup.exe' process can be run directly from the 'PCSetup' share). For more inforation about deploying the User Client Tool see below or read the README.txt file in the 'PCSetup' share.

The User Client Tool can be configured to alert the user when their balance drops below a predefined limit (see screenshot below).

Deployment Options

OPTION 1 - ZERO-INSTALL DEPLOYMENT

The zero-install option is suitable for networks running modern operating systems such as Windows 2000 and Windows XP. The UIT (PCClient.exe) can simply be run directly from the PCSetup share on the primary PaperCut Server. Typical methods for starting the program include:

Logon or startup script

Add a line in the users' logon script to run the program. For example:

    cmd /c "start \\servername\PCSetup\PCClient.exe /silent"

(Note: this may not work on all setups. The "/k" option may be required in some scripts)

Group Policy

Use the group policy template to define the PCClient.exe as a program to be run on Logon. This is done via to policy located under:

    Computer Config->Administrative Templates->System->Logon->Run these programs at user logon

Alternatively a line can be added to the user's logon script under:

    User Configuration->Windows Settings->Scripts (Logon/Logoff)->Logon

to run the program as part of the logon process.

   Batch File:
     cmd /c "start \\servername\PCSetup\PCClient.exe /silent"

   VBScript:
     Set WshShell = WScript.CreateObject("WScript.Shell")
     WshShell.Run "\\server_name\PCSetup\pcclient.exe /silent"

All Users StartUp Folder

On each workstation create a shortcut to \\servername\PCSetup\PCClient.exe in the "All Users" Startup folder. This folder is usually located at C:\Documents and Settings\All Users\Start Menu\Programs\Startup. The program will then run whenever a user logs into the workstation.

Starting via the Windows Registry (Advanced)

Use a logon script or otherwise to add a registry key to each workstation. Create a key called "PaperCut" with a value of

      "\\servername\PCSetup\PCClient.exe /silent"

in the root

      HKLM/Software/Microsoft/Windows/CurrentVersion/Run

Special Note for Windows XP SP2: Windows XP may prevent the running of remote executables hosted on a server's share. If users receive a security warning, add the server to the workstation's list of "Trusted sites" via Internet Options in the control panel and reboot.

OPTION 2 - FULL INSTALLATION

The PCSetup share also includes a copy of the full PaperCut installer. In some cases, the zero-install deployment option may not work - for example, very old versions of Windows may not have the required components. The full installation will install all required dependencies. Administrators, running at Administrator level privileges may install the client my running the "pcsetup.exe" program from this directory and selecting the "Workstation Client Install" option, or more conveniently, by running the "client-silent-install.bat" script which automates the process somewhat.

Option 1 should be used in preference to the full installation on each workstation.

CONFIGURATION

The "setup.txt" file can be used to change the behavior and appearance of the UIT. Please see the PaperCut User Guide for an explanation of the options available.

DEPENDENCIES (Information for technical administrators)

The "PCClient.exe" process requires the following Microsoft components:

    Windows Scripting Host
       installed by default in Windows 2000, XP and higher

    Microsoft DAO or MDAC
       installed by default with Windows 2000, XP and higher

Categories: User Client Tool

Keywords: client install, client software, uit, installation, deployment, client tool