PaperCut NG 8.5 User Manual


Table of Contents

Preface
About This Guide
Expectations & Prerequisites
Terminology used in this document
Notice
1. Introduction
What is PaperCut NG?
Benefits
Key Features
System Requirements
How does PaperCut NG work?
Key Concepts
Understanding the print process flow
Architecture Overview
The Top-Ten Hidden Features!
One: Remote Administration
Two: Secondary Servers and Local Printers
Three: Shared Accounts
Four: Customizable Web Interface
Five: XML Web Services and Command-line Control
Six: Hold/Release Queues and Release Stations
Seven: Text Print Logs
Eight: 3rd Party Database Support
Nine: Zero-install Client Deployment
Ten: The Development Team
2. Installation
Installation on Windows
Step 1 - System Requirements & Network Setup
Step 2 - Print queue configuration
Step 3 - Download and install
Step 4 - Configuration Wizard
Step 5 - Printer Configuration
Step 6 - Sharing Client Software
Step 7 - Testing
What next?
Installation on Apple Mac
Step 1 - System Requirements
Step 2 - Print Queue Setup
Step 3 - Download and install
Step 4 - Configuration Wizard
Step 5 - Printer Configuration
Step 6 - Sharing Client Software
Step 7 - Testing
What next?
Installation on Novell OES Linux (iPrint)
Step 1 - System Requirements
Step 2 - Create the host user account and firewall settings
Step 3 - Download and installing
Step 4 - Configuration Wizard
Step 5 - Printer/iPrint Configuration
Step 6 - Sharing Client Software
Step 7 - Testing
What next?
Installation on Linux (CUPS and/or Samba)
Step 1 - System Requirements
Step 2 - Create the host user account and firewall settings
Step 3 - Download and installing
Step 4 - Configuration Wizard
Step 5 - Printer Configuration
Step 6 - Sharing Client Software
Step 7 - Testing
What next?
3. Implementation by Example
Scenario: The Small School
Requirements
Implementation
Scenario: The Large School
Requirements
Implementation
Scenario: The University
Requirements
Implementation
Scenario: The Small Business
Requirements
Implementation
Scenario: The Medium to Large Business
Requirements
Implementation
Scenario: The Public Library or Internet Cafe/Kiosk
Requirements
Implementation
4. Quick Tour
Navigation
Tabs
Actions
Buttons
Crumb Trail
Status Messages
Fields
Sections
Users
Groups
Accounts
Printers
Internet
Reports
Cards
Options
Application Log
About
Basic User Operations
Basic Printer Operations
Client Software
Demonstrating the client software and account selection process
Interface Levels
Admin Access
User Access
Assigning Administrator Level Access
Charting, Statistics, Reports and Logs
Charts
Reports
Logging
5. Services for Users
Introduction
User Client
User Client Deployment
User Web Pages
Summary
Environmental Impact
Shared Accounts
Rates
Use Card
Add Credit
Transfers
Transaction History
Recent Print Jobs
Recent Internet Use
Jobs Pending Release
Mobile User Web Pages
Gadgets/Widgets and more...
Windows Vista Gadgets
Web Widgets
6. Advanced User Management
Groups in PaperCut NG
Setting up quota allocations
Custom Quota Scheduling Periods
Advanced User Quota Management
Automated Quota Allocation Example
New User Creation Rules
Bulk User Operations
Using Overdrafts
Batch User Import and Update
Batch User Import File Format
Batch User Card/Identity Update
Batch User Card/Identity Update File Format
Disabling user printing with time latches
User Management Quick Reference
7. Advanced Printer Management
Adding and Removing/Deleting/Ignoring Printers
On Windows
On Mac
On Linux
The Template Printer
Copying Printer Settings
Disabling printers with time latches
Managing printing using differential charging
Charging modes available
How duplex discounts are calculated
Using filters and restrictions
Reduce printer jams
Controlling documents on slow Inkjets
Automatically deleting duplicate jobs
Force sensible use
Automatically deny documents based on file extension or name
Control who can print in color (Advanced)
Advanced Setups
Charge Rates
Popup Authentication
Where Popup authentication is used
How does popup authentication work?
Configuration
Color Detection
Limitations of Page-Level Color Detection
Printer Quick Reference
8. Shared Accounts
Creating a Shared Account
The Template Account
Account Naming Guidelines
Client / Matter Naming Model
Project / Phase Naming Model
Customer / Job Naming Model
Client Security
The Account Selection Popup
Standard Account Selection Popup
Advanced Account Selection Popup
Automatically charge to a shared account
Account Selection in Non-Domain Environments (Workgroups)
Batch Shared Account Import and Update
Batch Account Import File Format
Shared Account Synchronization
Synchronization Options
Bulk Shared Account Operations
Advanced Shared Account Options
9. Reports
Report types
User Reports
Printer Reports
Print Log Reports
Internet Use Reports
Group Reports
Shared Accounts Reports
Transaction Reports
Environmental Impact Reports
Ratio Reports
Report Formats
Combining Filters and Reports
Scheduling and Emailing Reports
Usage
Details
Advanced Reporting Options
10. Hold/Release Queues & Print Release Stations
Release Station Interfaces
Standard Release Station
Web-based release station (Manager mode)
Web-based release station within the admin pages
End-user web-based interface
Hold/Release Usage Scenarios
Saving paper and toner
Secure Printing
Pay per print (e.g. Library or Internet Cafe)
Expensive Printers (Approved Printing)
Unauthenticated printing
Release Station Configuration
Enabling hold/release support on a printer
Hold/Release Queue Managers
Standard Release Station Configuration
End-User Web Based Release Interface Configuration
11. System Management
Overview
User and Group Synchronization
Synchronization Options
Importing Card/Identity numbers from Active Directory or LDAP
On Demand User Creation
Using Active Directory for user synchronization
Using LDAP for user synchronization
Assigning Administrator Level Access
Assigning Administrator Access to a Group
Assigning Administrator Access to a User
System Backups
Performing an Online Backup
Restoring a Backup
Performing Offline Backups
System Notifications
Configuring Notifications
Error Notifications (for Administrators)
Testing Notification Methods
System Security Options
Application Server Connections
Provider Connection Security
Environmental Impact
Using the Config Editor
12. TopUp/Pre-Paid Cards
Cards by Example
The User's Perspective
The Administrator's Perspective
The Card System
Creating New Cards
Overview and Definitions
Using the Card Wizard
TopUp/Pre-Paid Card Tips
Using a Card
13. Configuring Secondary Print Servers and Locally Attached Printers
Configuring a Windows Secondary Print Server
Step 1 - Ensure primary server is set up correctly
Step 2 - Ensure firewall software is set to allow access to port 9191
Step 3 - Install the print provider
Step 4 - Configuration
Step 5 - Test
Automated Install
Configuring a Macintosh Secondary Print Server
Step 1 - Ensure primary server is set up correctly
Step 2 - Ensure firewall software is set to allow access to port 9191
Step 3 - Create the host user account
Step 4 - Install the print provider
Step 5 - Configuration
Step 6 - Test
Configuring a Linux Secondary Print Server
Step 1 - Ensure primary server is set up correctly
Step 2 - Ensure firewall software is set to allow access to port 9191
Step 3 - Account setup
Step 4 - Install the Print Provider
Step 5 - Configuration
Step 6 - Test
Print Monitoring Architecture
Multiple Print Servers
Automating Secondary Server Deployment on Windows
14. Net Control in Detail
How Internet Control works
Data-based control
Time-based control
Proxy server configuration
Proxy authentication
Denying access to users without credit
Internet Control service setup
Single/primary server installation
Secondary server installation
Verifying the Net Control service setup
Internet Control Settings
Internet usage costs
Ignored Domains and users
15. Advanced Customization
Customizing the User Client Tool window
Limiting the list of interface languages/translations
Customizing the User web pages
Customizing the administration web interface
Customizing Report Headers
Data Access and Custom Reports
Plain Text Print Log
Automation and Scripting
Custom User Directory Information Providers
16. Licensing and Support
Installing a License
Technical Support & Further Information
17. Deployment on an External Database (RDBMS)
Overview
Why use an external RDBMS?
Supported Databases
Upsizing to an External RDBMS
Step 1 - Stop the PaperCut NG application
Step 2 - Perform a backup of the existing data
Step 3 - Create a new database in the external RDBMS
Step 4 - Change the PaperCut NG connection details
Step 5 - Initialize the new database
Step 6 - Load the data into the new database
Step 7 - Restart the PaperCut NG application server
Database specific configuration
Configuring Microsoft SQL Express
Configuring Oracle (and Oracle Express Edition)
18. Microsoft Cluster Environments
About Clustering
Microsoft Cluster Server
Mode 1 - Clustering at the Print Provider layer
Mode 2 - Clustering at all application layers
Clustering Tips
Veritas Cluster Server
Mode 1 - Clustering at the Print Provider layer
Client/Workstation Configuration
19. PaperCut NG on Linux
The Installation Process
Manual extraction
The install process
Linux Print Queue Integration
Advanced Configuration & Logs
Backups & System Management
User Directory and Authentication
Standard Unix
Samba/Windows Domain
Custom
Unix Command-Line Release Station Client
Installing the Command-Line Release Station Client
Removing PaperCut NG from a Linux server
Linux FAQ
20. Print Authentication
About Authentication and Printing
What is authentication?
Why does authentication pose a problem?
How does PaperCut NG address authentication?
Handling Unauthenticated Laptops
Option 1: Popup Authentication for Unauthenticated Laptops
Option 2: Release Station Authentication for Unauthenticated Laptops
The Authentication Cookbook - Recipes by example
Windows systems with generic logins
Windows laptops that do not authenticate against a domain
Windows print server using LDAP or eDirectory authentication
Mac OS X systems with generic user accounts
Mac OS X systems using domain authentication via Open Directory
Mac OS X systems using domain authentication via Windows Active Directory
Mac OS X laptops (or single user systems) printing to Windows print queues
Linux Workstations in a lab environment with printers hosted on a Windows server
Linux Workstations in a lab environment with printers hosted on Linux CUPS server
Linux laptops (or single user systems)
Multiuser Unix terminal servers
Further Recommendations
21. Mac Printing in Detail
Mac hosted print queues
Step 1: Installing the printers on the server
Step 2: Enable Printer Sharing
Step 3: Set up the printers (shared queues) on the workstations
Publishing the printer via Workgroup Manager
Unauthenticated systems (e.g. Laptops)
Windows hosted print queues
Scenario One: My Own Mac (Single User)
Scenario Two: The Multi-User Mac with Popup Authentication
Scenario Three: Multi-user Macs using LDAP or Active Directory authentication
Scenario Four: Mac OS X Server
Additional information and tips
22. Running in a Workgroup Environment
Option 1: Common username and passwords on all systems
Option 2: Authenticating via popup
23. Managing Guests and Internal Users
Internal Users (users managed by PaperCut NG)
Implementation by Example
Internal Users Options
Batch Internal User Import and Update
A. Tools (Advanced)
Server Commands (server-command)
Available Commands
Database Tool (db-tools)
export-db Command
import-db Command
init-db Command
delete-old-logs Command
The XML Web Services API
Web Services Example Code
Security
SSL/HTTPS Key Generation
Re-create the self-signed certificate
Using a custom/or signed SSL Key
User Client Options
Stopping and Starting the Application Server
Stopping/Starting the server on Windows
Stopping/Starting the server on Mac
Stopping/Starting the server on Linux
Automating / Streamlining Installation on Windows
B. Troubleshooting & Technical FAQ's
C. Advanced LDAP Configuration
LDAP Server Default Configuration
Standard (Unix / Open Directory)
Novell eDirectory Defaults
Microsoft Active Directory Defaults
D. Proxy server configuration
Configuring Microsoft ISA Server 2004/2006
Configuring Squid Proxy
Squid authentication with LDAP / Active Directory
Restricting Internet Access for users without credit
E. Capacity Planning
Database Sizing and Growth
Internal database growth
SQL Server database growth
Sample database growth calculation
Network Bandwidth Planning
Bandwidth Estimates
Managing Large Client Account Lists on Distributed Sites
Known limitations
F. Upgrading From a Previous Version
The recommended upgrade procedure
G. Upgrading from PaperCut Quota
Upgrade process
Step 1 - Stop and disable PaperCut Quota
Step 2 - Install PaperCut NG
Step 3 - Configure and test printers
Step 4 - Import the existing User Balances
Step 5 - Upgrade client software
Step 6 - Optionally uninstall PaperCut Quota
H. Example User Information Sheets
Example 1: Printing with the popup confirmation window
Popup Confirmation Dialog
The Printing Balance Window
Resolving Problems
Printing Denied Message
Example 2: Printing with shared accounts (for staff)
Shared Account Selection Popup Window
Resolving Problems
Printing Denied Message
Example 3: Printing using a release station
Example 4: Refunding a print job (for staff)
Full Refund
Partial Refund
Example 5: Adding credit using a TopUp/Pre-Paid Card
I. Software License Agreement

List of Figures

1.1. The user client tool
1.2. The User Client account selection popup
1.3. The Windows print queue
1.4. PaperCut NG Architecture - an advanced configuration
2.1. Network printer configuration
2.2. Configuring Windows print queue permissions
2.3. Setup wizard
2.4. PaperCut NG Configuration wizard
2.5. User sync configuration wizard page
2.6. The Mac installer
2.7. PaperCut NG Configuration wizard
2.8. User sync configuration wizard page
2.9. Creating the host user account - part 1
2.10. Creating the host user account - part 2
2.11. The Novell OES Linux install process
2.12. PaperCut NG Configuration wizard
2.13. eDirectory/LDAP configuration wizard page
2.14. The Linux install process
2.15. PaperCut NG Configuration wizard
2.16. User sync configuration wizard page
4.1. Application navigation tabs
4.2. The Actions area. Click to perform the action.
4.3. Buttons to validate and save settings
4.4. The crumb trail highlighting the location
4.5. A red status message indicating a validation error
4.6. A field highlighted indicating a validation error
4.7. Application navigation tabs
4.8. Adjusting a user's credit up $10.00
4.9. A 40% discount applied to double-sided printing
4.10. Printer Filters and Restrictions
4.11. A printer disabled for 1 hour
4.12. The user client displaying the "Advanced Account Selection Popup"
4.13. The user client tool
4.14. User 30-day account balance history
4.15. Printer utilization chart
4.16. Print page history for a single printer
4.17. Printer report in PDF
4.18. Printer usage log
4.19. User account transaction log
5.1. PaperCut user client on Mac OS X
5.2. PaperCut user web pages
5.3. Example of customized user web pages
5.4. The User Client Balance Window
5.5. User Client account selection popup (Standard Popup)
5.6. User Client (Advanced Popup)
5.7. PaperCut Client on Mac OS X
5.8. PaperCut NG requires Mac OS X v 10.3.9 or later
5.9. Connecting to a Windows server
5.10. The PCClient share's connection string
5.11. Add PCClient as a Login Item
5.12. Control-click and open the package contents
5.13. Double-click to install the login hook
5.14. A user's summary information
5.15. Draw a user's attention to their environmental impact
5.16. A list of available shared accounts
5.17. Printing costs as seen by the user
5.18. Internet usage costs as seen by the user
5.19. Using a TopUp/Pre-Paid Card
5.20. Transferring funds to another user
5.21. A user's recent balance transactions
5.22. A user's recent printing
5.23. A user's recent internet usage
5.24. The user's view of jobs pending release
5.25. Mobile user web tools - summary page
5.26. View in Desktop mode link
5.27. Mobile user web tools - balance
5.28. Mobile user web tools - environmental impact statistics
5.29. Mobile user web tools - redeem TopUp/Pre-Paid Card
5.30. Mobile user web tools - entering a TopUp/Pre-Paid Card number
5.31. The Environmental Impact Gadget
5.32. The Print Balance Gadget
6.1. Adding/removing groups
6.2. The Group Details screen
6.3. Initial settings applied to new users
6.4. Setting a user's overdraft to $20.00
6.5. User printing disabled using a time-latch
7.1. The Template Printer
7.2. Copy settings from one printer to others
7.3. Printer disabled using a time-latch
7.4. Advanced differential charging example
7.5. Some of the available printer filters and restrictions
7.6. Three charge rates defined at the printer level
7.7. Charge rates displayed in the Advanced Client Popup
7.8. Turning on popup authentication at the user level
7.9. PaperCut NG client requesting for authentication
7.10. The color detection setting for a printer
8.1. Selecting a shared account with the User Client popup
8.2. Creating a shared account
8.3. The template account
8.4. Template account settings
8.5. Client / Matter Naming Model example
8.6. Searching accounts by client name in the client/matter code naming model
8.7. Searching accounts by client code in the client/matter code naming model
8.8. Searching accounts by matter name in the client/matter code naming model
8.9. Searching accounts by matter code in the client/matter code naming model
8.10. Project / Phase Naming Model example
8.11. Searching accounts by project name or number in the project/phase code naming model
8.12. Searching accounts by phase in the project/phase code naming model
8.13. Selecting a shared account from the popup
8.14. The user's popup settings under User -> User Details
8.15. Setting up shared account security
8.16. The standard account selection popup
8.17. Client popup options defined on a per-user basis
8.18. The print job confirmation dialog (no account selection options)
8.19. The advanced account selection popup
8.20. Account selection option to automatically charge to a shared account
8.21. Configuration allowing only selection of other user accounts
8.22. Popup requesting the user to enter their username and password
9.1. Selecting ad-hoc date ranges for reports
9.2. Printer log PDF report
9.3. Report icons of available report formats (PDF, HTML, CSV (Excel)).
9.4. Filters applied to the shared account print log
9.5. The Scheduled Reports page
10.1. The Standard Release Station
10.2. Web-based release station (Manager mode)
10.3. Web-based release station within the admin pages
10.4. End-user web-based interface listing held jobs
10.5. All documents easily identifiable by document and machine name
10.6. End-user web based release interface options
11.1. User/group synchronization options
11.2. Progress of a user/group synchronization process
11.3. On demand user creation options
11.4. The list of users and groups granted admin access
11.5. The list of users and groups granted admin access
11.6. Options for a single system notification
11.7. Printer error notification settings
11.8. Error level event notification settings
11.9. Draw a user's attention to their environmental impact
12.1. Entering a batch ID
12.2. Defining a valid till date
12.3. Options to edit the card design
12.4. Enable Macros in MS Word 2007
12.5. Cards ready for printing
12.6. Imported card numbers
12.7. Inserting a new logo into a card
12.8. Propagate labels button in previous versions of MS Word
12.9. Update labels button in MS Word 2007
12.10. Using a card
13.1. Secondary server reporting back to primary server (application server)
13.2. PaperCut NG Architecture - an advanced configuration
14.1. Example of how Internet Control calculates time used on the Internet
14.2. Application Server, Internet Control module and proxy server all on one system
14.3. Application Server installed with Internet Control module, accessing proxy logs remotely
14.4. Internet Control service installed on proxy server, Application Server on separate system
14.5. Selecting the proxy server type and log file location
14.6. Example output from a test parse of proxy server log files
14.7. Selecting a security group to allow internet access
14.8. Selecting a service account
14.9. Example of Internet Control service status when service is running.
14.10. Internet usage cost settings
14.11. Internet usage cost settings
15.1. Customized user client link
15.2. A customized end-user web designed for St Mary's Anglican Girls School
15.3. A customized end-user web designed for Williamstown High School
15.4. Login Page with an instruction
15.5. Custom logo in the administration interface
15.6. Example custom report header usage
18.1. Stopping the service and setting to Manual startup
18.2. Creating a new cluster resource
18.3. Cluster service parameters configuration
18.4. Stopping the service and setting to Manual startup
20.1. PaperCut NG client requesting authentication
21.1. Setting up a printer (direct) on Leopard server using Jetdirect
21.2. Enable IPP on each queue via Server Admin
21.3. Setting up a workstation printer on Leopard
21.4. Printing settings via the Workgroup manager
21.5. Add printer appropriate to the container (users, group, or computer)
21.6. PaperCut Client on Mac OS X
21.7. Add a printer
21.8. Option-click for advanced printer addition types
21.9. Windows printer via SAMBA
21.10. Connecting to a Windows server
21.11. The PCClient share's connection string
21.12. Add PCClient as a Login Item
21.13. Mac popup authentication dialog requesting username and password
21.14. Add a printer
21.15. Option-click for advanced printer addition types
21.16. Windows printer via SAMBA
21.17. Connecting to a Windows server
21.18. The PCClient share's connection string
21.19. Command-click and open the package
21.20. Double-click to install the login hook
21.21. Turning on popup authentication at the user level
21.22. PaperCut NG client requesting for authentication (Sorry: Windows screen-shot!)
21.23. Windows Component: Other Network File and Print Service
21.24. Add a printer
21.25. Adding an LPR/LPD printer
21.26. Connecting to a Windows server
21.27. The PCClient share's connection string
21.28. Double-click to install the login hook
22.1. Turn off simple file sharing
22.2. Turn off simple file sharing
22.3. Enable perform printing as other user
23.1. Internal users options
23.2. Web based internal user registration interface
23.3. Creating an internal user from the administration interface
23.4. Login screen showing the registration link
B.1. Disable simple file sharing
D.1. ISA Server 2004/2006 - Logging tab
D.2. ISA Server 2004/2006 - Configure Proxy Logging option
D.3. ISA Server 2004/2006 - Using the W3C log file format
D.4. ISA Server 2004/2006 - Applying changed log settings
D.5. ISA Server 2004/2006 - Properties for the internal network
D.6. ISA Server 2004/2006 - Enabling the HTTP proxy
D.7. ISA Server 2004/2006 - Creating a new user set
D.8. ISA Server 2004/2006 - Adding Windows users to a user set
D.9. ISA Server 2004/2006 - Creating a new access rule
D.10. ISA Server 2004/2006 - Allowing the HTTP protocol
D.11. ISA Server 2004/2006 - Setting the internal network as the rule source
D.12. ISA Server 2004/2006 - Applying changed access rule settings
E.1. Database growth using the internal database
E.2. Database growth using a Microsoft SQL Server database
H.1. Client Popup Confirmation Window
H.2. Printing balance window showing $10.00 of printing balance
H.3. Printing balance icon in the system tray
H.4. Printing denied message
H.5. Shared Account Selection Popup
H.6. Printing balance icon in the system tray
H.7. Printing denied message
H.8. Login screen
H.9. Print jobs waiting in a release station
H.10. Print History
H.11. Issuing a partial refund using Adjustments & Charges
H.12. Balance window showing the Details link
H.13. Redeem Card page

List of Tables

6.1. Quota schedule times
6.2. User Import File Format
6.3. User Card/Identity Update File Format
7.1. User Client Popup Config Keys
8.1. Shared Account Import File Format
9.1. Report Formats
9.2. Scheduled reports delivery times
9.3. Advanced Reporting Config Keys
10.1. Standard Release Station config settings
10.2. Standard Release Station modes
11.1. Fields available in printing notifications
11.2. Fields available in low balance notifications
11.3. Fields available in printer error notifications
11.4. Fields available in error level event notifications
11.5. Environmental Impact Reporting
12.1. Card Terminology
13.1. PaperCut NG services/components
14.1. Internet Control Cost Options
15.1. User Client Customization Config Keys
15.2. Files used to customize the user web pages
15.3. Login instruction Config key
15.4. Text print log file format
19.1. Secured Application Areas
19.2. Standard print commands
19.3. Advanced Configuration
23.1. Internal User Import File Format
A.1. XML Web Services Methods
A.2. User Client command-line options
A.3. Windows installer command-line options
C.1. LDAP Config entries
C.2. Unix / Open Directory LDAP default settings
C.3. Novell eDirectory LDAP default settings
C.4. Active Directory LDAP default settings