PaperCut NG 6.3 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: Customizable Web Interface
Four: XML Web Services and Command-line Control
Five: Release Station Support
Six: Text Print Logs
Seven: 3rd Party Database Support
Eight: Zero-install Client Deployment
Nine: Shared Accounts
Ten: The Development Team
Quick Start Guide (for Windows)
Step 1 - Checking system requirements
Step 2 - Downloading and installing PaperCut NG
Step 3 - Running the configuration wizard
Step 4 - Printing a test document and verifying charging has occurred
Step 5 - Accessing and printing from another workstation
Step 6 - Configure print queue permissions (Optional)
What next?
Quick Start Guide (for Linux)
Step 1 - Checking system requirements
Step 2 - Creating the host user account
Step 3 - Downloading and installing
Step 4 - Running the configuration wizard
Step 5 - Configuring Printers
Step 6 - Print a test document and verify charging has occurred
Step 7 - Sharing client software
Step 8 - Accessing and printing from another workstation
What next?
Quick Start Guide (for Mac Servers)
Step 1 - Checking system requirements
Step 2 - Creating the host user account (optional)
Step 3 - Downloading and installing
Step 4 - Running the configuration wizard
Step 5 - Configuring Printers
Step 6 - Print a test document and verify charging has occurred
Step 7 - Sharing client software
Step 8 - Accessing and printing from another workstation
What next?
2. 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
3. Quick Tour
Navigation
Tabs
Actions
Buttons
Crumb Trail
Status Messages
Fields
Sections
Users
Groups
Accounts
Printers
Reports
Cards
Options
Application Log
About
Basic User Operations
Basic Printer Operations
Interface Levels
Admin Access
User Access
Assigning Administrator Level Access
Charting, Statistics, Reports and Logs
Charts
Reports
Logging
4. Advanced User Management
Groups in PaperCut NG
Setting up quota allocations
Advanced User Quota Management
Automated Quota Allocation Example
New User Creation Rules
Bulk User Operations
Batch User Import and Update
Batch User Import File Format
Disabling user printing with time latches
User Management Quick Reference
5. Advanced Printer Management
The Template Printer
Copying Printer Settings
Disabling printers with time latches
Managing printing using differential charging
Charging modes available
Using filters and restrictions
Reduce printer jams
Controlling documents on slow Inkjets
Automatically deleting duplicate jobs
Force sensible use
Automatically delete documents based on file extension or name
Control who can print in color (Advanced)
Advanced Setups
Ignoring/Deleting a printer
Popup Authentication
Where Popup authentication is used
How does popup authentication work?
Configuration
Printer Quick Reference
6. User Client
User Client Deployment
Deployment on Windows
Deployment on Mac OS X
Deployment on Linux and Unix
7. Shared Accounts
Creating a Shared Account
Client Security
Advanced Popup Settings
Account Selection Non-Domain Environments (Workgroups)
Batch Shared Account Import and Update
Batch Account Import File Format
8. Reports
Report types
User Reports
Printer Reports
Group Reports
Shared Accounts Reports
Print Log Reports
Report Formats
Combining Filters and Reports
9. 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 release station
Release Station 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 release station support for a printer
Release Station Managers
Standard Release Station Configuration
10. System Management
Overview
User and Group Synchronization
Synchronization Options
Using LDAP for user synchronization
System Backups
Performing an Online Backup
Restoring a Backup
Performing Offline Backups
System Notifications
Configuring Notifications
Testing Notification Methods
System Security Options
Application Server Connections
Provider Connection Security
11. 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
12. 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
13. Advanced Customization
Customizing the User Client Tool window
Customizing the User web pages
Data Access and Custom Reports
Plain Text Print Log
Automation and Scripting
Custom User Directory Information Providers
14. Licensing and Support
Installing a License
Technical Support & Further Information
15. Deployment on an External 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
Configuring Microsoft SQL Express 2005
Enable TCP/IP connections
Enable SQL Server authentication
Create Database User
16. Microsoft Cluster Environments
About Clustering
Cluster Configuration Modes
Mode 1 - Clustering at the Print Provider layer
Mode 2 - Clustering at all application layers
Clustering Tips
Client/Workstation Configuration
17. PaperCut NG on Linux
The Installation Process
Manual extraction
The install process
CUPS Integration
Samba 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
18. Print Authentication & Cross-Platform Networks
About Authentication and Printing
What is authentication?
Why does authentication pose a problem?
How does PaperCut NG address authentication?
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
19. Mac Printing in Detail
Scenario One: My Own Mac (Single User)
Requirements
Installation
Scenario Two: The Multi-User Mac with Popup Authentication
Requirements
Installation
Scenario Three: Multi-user Macs using LDAP or Active Directory authentication
Requirements
Installation
Scenario Four: Mac OS X Server
Additional information and tips
20. Running in a Workgroup Environment
Option 1: Common username and passwords on all systems
Option 2: Authenticating via popup
A. Tools (Advanced)
Server Commands (server-command)
Available Commands
Database Tool (db-tools)
export-db Command
import-db Command
init-db Command
The XML Web Services API
Web Services Example Code
Security
SSL/HTTPS Key Generation
Using a custom SSL Key
User Client Options
Stopping and Starting the Application Server
Stopping/Starting the server on Windows
B. Troubleshooting & Technical FAQ's
C. Advanced LDAP Configuration
LDAP Server Default Configuration
Unix / NIS Defaults
Novell eDirectory Defaults
Microsoft Active Directory Defaults
D. Capacity Planning
Database Sizing and Growth
Internal database growth
SQL Server database growth
Sample database growth calculation
E. Upgrading From a Previous Version
The recommended upgrade procedure
F. 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 User Balances from PaperCut Quota
Step 5 - Optionally uninstall PaperCut Quota
G. 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
1.5. Network printer configuration
1.6. Setup wizard
1.7. PaperCut NG Configuration wizard
1.8. User sync configuration wizard page
1.9. User client
1.10. Configuring Windows print queue permissions
1.11. The Linux install process
1.12. PaperCut NG Configuration wizard
1.13. User sync configuration wizard page
1.14. User client
1.15. The Mac installer
1.16. PaperCut NG Configuration wizard
1.17. User sync configuration wizard page
1.18. User client
3.1. Application navigation tabs
3.2. The Actions area. Click to perform the action.
3.3. Buttons to validate and save settings
3.4. The crumb trail highlighting the location
3.5. A red status message indicating a validation error
3.6. A field highlighted indicating a validation error
3.7. Application navigation tabs
3.8. Adjusting a user's credit up $10.00
3.9. A 40% discount applied to double-sided printing
3.10. Printer Filters and Restrictions
3.11. A printer disabled for 1 hour
3.12. The user client tool
3.13. The list of users granted admin access
3.14. User 30-day account balance history
3.15. Printer utilization chart
3.16. Print page history for a single printer
3.17. Printer report in PDF
3.18. Printer usage log
3.19. User account transaction log
4.1. Adding/removing groups
4.2. The Group Details screen
4.3. Initial settings applied to new users
4.4. User printing disabled using a time-latch
5.1. The Template Printer
5.2. Copy settings from one printer to others
5.3. Printer disabled using a time-latch
5.4. Advanced differential charging example
5.5. Some of the available printer filters and restrictions
5.6. Turning on popup authentication at the user level
5.7. PaperCut NG client requesting for authentication
6.1. The User Client on Windows
6.2. User Client account selection popup
6.3. PaperCut Client on Mac OS X
6.4. PaperCut NG requires Mac OS X v 10.3 or later
6.5. Connecting to a Windows server
6.6. The PCClient share's connection string
6.7. Add PCClient as a Login Item
6.8. Control-click and open the package contents
6.9. Double-click to install the login hook
7.1. Selecting a shared account with the User Client popup
7.2. Creating a shared account
7.3. Selecting a shared account from the popup
7.4. The user's popup settings under User -> User Details
7.5. Setting up shared account security
7.6. Client popup options defined on a per-user basis
7.7. The print job confirmation dialog (no account selection options)
7.8. Configuration allowing only selection of other user accounts
7.9. Popup requesting the user to enter their username and password
8.1. Selecting ad-hoc date ranges for reports
8.2. Printer log PDF report
8.3. Report icons of alternate report formats (i.e. PDF, HTML, Excel).
8.4. Filters applied to the shared account print log
9.1. The Standard Release Station
9.2. Web-based release station (Manager mode)
9.3. Web-based release station within the admin pages
9.4. End-user web-based release station
9.5. All documents easily identifiable by document and machine name
10.1. User/group synchronization options
10.2. Progress of a user/group synchronization process
10.3. Options for a single system notification
11.1. Entering a batch ID
11.2. Defining a valid till date
11.3. Options to edit the card design
11.4. Cards ready for printing
11.5. Imported card numbers
11.6. Inserting a new logo into a card
11.7. Propagate labels button
11.8. Using a card
12.1. Secondary server reporting back to primary server (application server)
12.2. PaperCut NG Architecture - an advanced configuration
13.1. Customized user client link
13.2. A customized end-user web designed for Flora Hill Secondary College
13.3. A customized end-user web designed for Ross University
16.1. Stopping the service and setting to Manual startup
16.2. Creating a new cluster resource
16.3. Cluster service parameters configuration
18.1. PaperCut NG client requesting authentication
19.1. PaperCut Client on Mac OS X
19.2. Add a printer
19.3. Option-click for advanced printer addition types
19.4. Windows printer via SAMBA
19.5. Connecting to a Windows server
19.6. The PCClient share's connection string
19.7. Add PCClient as a Login Item
19.8. Mac popup authentication dialog requesting username and password
19.9. Add a printer
19.10. Option-click for advanced printer addition types
19.11. Windows printer via SAMBA
19.12. Connecting to a Windows server
19.13. The PCClient share's connection string
19.14. Command-click and open the package
19.15. Double-click to install the login hook
19.16. Turning on popup authentication at the user level
19.17. PaperCut NG client requesting for authentication (Sorry: Windows screen-shot!)
19.18. Windows Component: Other Network File and Print Service
19.19. Add a printer
19.20. Adding an LPR/LPD printer
19.21. Connecting to a Windows server
19.22. The PCClient share's connection string
19.23. Double-click to install the login hook
20.1. Turn off simple file sharing
20.2. Turn off simple file sharing
20.3. Enable perform printing as other user
D.1. Database growth using the internal database
D.2. Database growth using a Microsoft SQL Server database

List of Tables

1.1. Standard print commands
4.1. Quota schedule times
4.2. User Import File Format
5.1. User Client Popup Config Keys
7.1. Shared Account Import File Format
8.1. Report Formats
9.1. Standard Release Station config settings
9.2. Standard Release Station modes
10.1. Fields available in all notifications
10.2. Fields available in print notifications
11.1. Card Terminology
12.1. PaperCut NG services/components
13.1. User Client Customization Config Keys
13.2. Files used to customize the user web pages
13.3. Text print log file format
17.1. Secured Application Areas
17.2. Advanced Configuration
A.1. XML Web Services Methods
A.2. User Client command-line options
C.1. LDAP Config entries
C.2. Unix / NIS LDAP default settings
C.3. Novell eDirectory LDAP default settings
C.4. Active Directory LDAP default settings