papercut mf manual

8/15/2019 PaperCut MF Manual

1/564

PaperCut MF TM

PaperCut MF User Manual

w w w. p a p e r c u t. c

o m

© Copyright. PaperCut Sofware International Pty Ltd. All rights reser


2/564

PaperCut MF 12.5 User Manual


3/564



4/564


5/564

Table of ContentsPreface .................................................... ........................................................ .................... xxiv

1. About This Guide ........................................................ ................................................ xxiv2. Expectations & Prerequisites .................................................. ....................................... xxiv3. Terminology used in this document ................................................... .............................. xxiv4. Notice ........................................................................................................................xxv

1. Introduction ........................................................................................................................... 11.1. What is PaperCut MF? ................................................................................................. 1

1.1.1. Benefits .......................................................................................................... 11.1.2. Key Features ................................................................................................... 21.1.3. System Requirements ........................................................................................ 2

1.2. How does PaperCut MF work? ....................................................................................... 31.2.1. Key Concepts ................................................................................................... 31.2.2. Understanding the print process flow ..................................................................... 41.2.3. Architecture Overview ........................................................................................ 6

1.3. The Top-Ten Hidden Features! ....................................................................................... 71.3.1. One: Zero-install Client Deployment ...................................................................... 71.3.2. Two: Remote Administration ................................................................................ 71.3.3. Three: Web Print ............................................................................................... 81.3.4. Four: Shared Accounts ....................................................................................... 81.3.5. Five: Secondary Servers and Local Printers ........................................................... 81.3.6. Six: Scripting .................................................................................................... 81.3.7. Seven: Customizable Web Interface ..................................................................... 91.3.8. Eight: XML Web Services and Command-line Control ............................................... 91.3.9. Nine: 3rd Party Database Support ........................................................................ 91.3.10. Ten: The Development Team ............................................................................. 9

2. Installation ...........................................................................................................................102.1. Installation on Windows ...............................................................................................10

2.1.1. Step 1 - System Requirements & Network Setup ....................................................102.1.2. Step 2 - Print Queue Configuration ......................................................................112.1.3. Step 3 - Download and Install .............................................................................122.1.4. Step 4 - Configuration Wizard .............................................................................132.1.5. Step 5 - Printer Configuration .............................................................................162.1.6. Step 6 - Sharing Client Software .........................................................................162.1.7. Step 7 - Client Software Deployment (Optional) ......................................................162.1.8. Step 8 - Testing ...............................................................................................172.1.9. What Next? .....................................................................................................17

2.2. Installation on Apple Mac .............................................................................................172.2.1. Step 1 - System Requirements ...........................................................................172.2.2. Step 2 - Print Queue Setup ................................................................................172.2.3. Step 3 - Download and install .............................................................................172.2.4. Step 4 - Configuration Wizard .............................................................................182.2.5. Step 5 - Printer Configuration .............................................................................212.2.6. Step 6 - Sharing Client Software .........................................................................212.2.7. Step 7 - Testing ...............................................................................................212.2.8. Step 8 - Deployment for a Professional (Client Billing) Installation ..............................212.2.9. What next? .....................................................................................................22

2.3. Installation on Novell OES Linux (iPrint) ..........................................................................222.3.1. Step 1 - System Requirements & Printer Setup ......................................................222.3.2. Step 2 - Create the host user account and firewall settings .......................................232.3.3. Step 3 - Download and installing .........................................................................252.3.4. Step 4 - Configuration Wizard .............................................................................252.3.5. Step 5 - Printer/iPrint Configuration ......................................................................282.3.6. Step 6 - Sharing Client Software .........................................................................292.3.7. Step 7 - Testing ...............................................................................................302.3.8. Step 8 - Deployment for a Professional (Client Billing) Installation ..............................302.3.9. What next? .....................................................................................................30

iv


6/564

2.4. Installation on Linux (CUPS and/or Samba) .....................................................................302.4.1. Step 1 - System Requirements ...........................................................................312.4.2. Step 2 - Create the host user account and firewall settings .......................................312.4.3. Step 3 - Download and installing .........................................................................322.4.4. Step 4 - Configuration Wizard .............................................................................322.4.5. Step 5 - Printer Configuration .............................................................................352.4.6. Step 6 - Sharing Client Software .........................................................................352.4.7. Step 7 - Testing ...............................................................................................362.4.8. Step 8 - Deployment for a Professional (Client Billing) Installation ..............................362.4.9. What next? .....................................................................................................37

2.5. Testing the Installation .................................................................................................372.5.1. Testing for an Education or Small/Medium Enterprise Installation: ..............................372.5.2. Testing for a Professional (Client Billing) Installation: ...............................................37

3. Implementation by Example ....................................................................................................403.1. Scenario: The Small School ..........................................................................................40

3.1.1. Requirements ..................................................................................................403.1.2. Implementation ................................................................................................40

3.2. Scenario: The Large School ..........................................................................................413.2.1. Requirements ..................................................................................................413.2.2. Implementation ................................................................................................42

3.3. Scenario: The University ..............................................................................................423.3.1. Requirements ..................................................................................................433.3.2. Implementation ................................................................................................43

3.4. Scenario: The Small Business .......................................................................................443.4.1. Requirements ..................................................................................................443.4.2. Implementation ................................................................................................44

3.5. Scenario: The Medium to Large Business ........................................................................453.5.1. Requirements ..................................................................................................453.5.2. Implementation ................................................................................................45

3.6. Scenario: The Public Library or Internet Cafe/Kiosk ...........................................................463.6.1. Requirements ..................................................................................................463.6.2. Implementation ................................................................................................46

4. Quick Tour ...........................................................................................................................484.1. Navigation .................................................................................................................48

4.1.1. Tabs ..............................................................................................................484.1.2. Actions ..........................................................................................................484.1.3. Buttons ..........................................................................................................48

4.1.4. Crumb Trail .....................................................................................................494.1.5. Status Messages .............................................................................................494.1.6. Fields ............................................................................................................49

4.2. Sections ...................................................................................................................504.2.1. Dashboard ...............................................................................................50

4.2.2. Users ......................................................................................................50

4.2.3. Groups ....................................................................................................51

4.2.4. Accounts ..................................................................................................51

4.2.5. Printers ....................................................................................................51

4.2.6. Internet ....................................................................................................51

4.2.7. Reports ....................................................................................................52

4.2.8. Cards ......................................................................................................52

4.2.9. Options ....................................................................................................52

4.2.10. Application Log ........................................................................................52

4.2.11. About .....................................................................................................52

4.3. Basic User Operations .................................................................................................534.4. Basic Printer Operations ..............................................................................................54


v


7/564

4.5. Client Software ..........................................................................................................564.5.1. Demonstrating the client software and account selection process ...............................57

4.6. Interface Levels ..........................................................................................................584.6.1. Admin Access .................................................................................................584.6.2. User Access ...................................................................................................58

4.7. Assigning Administrator Level Access .............................................................................594.8. Charting, Statistics, Reports and Logs ............................................................................59

4.8.1. Charts ...........................................................................................................594.8.2. Reports ..........................................................................................................614.8.3. Logging ..........................................................................................................62

5. Services for Users .................................................................................................................645.1. Introduction ...............................................................................................................645.2. User Client ................................................................................................................66

5.2.1. User Client Deployment .....................................................................................685.3. User Web Pages ........................................................................................................77

5.3.1. Summary .......................................................................................................785.3.2. Environmental Impact .......................................................................................785.3.3. Shared Accounts .............................................................................................795.3.4. Rates ............................................................................................................795.3.5. Use Card ........................................................................................................805.3.6. Add Credit ......................................................................................................805.3.7. Transfers ........................................................................................................805.3.8. Transaction History ..........................................................................................815.3.9. Recent Print Jobs .............................................................................................815.3.10. Recent Internet Use ........................................................................................825.3.11. Jobs Pending Release .....................................................................................825.3.12. Web Print .....................................................................................................83

5.4. Mobile User Web Pages ..............................................................................................835.5. Gadgets/Widgets and more... ........................................................................................85

5.5.1. Paper-Less Alliance Widget ...............................................................................855.5.2. Windows Vista Gadgets ....................................................................................865.5.3. Web Widgets ..................................................................................................87

6. Advanced User Management ..................................................................................................896.1. Groups in PaperCut MF ...............................................................................................896.2. Setting up quota allocations ..........................................................................................90

6.2.1. Custom Quota Scheduling Periods ......................................................................916.2.2. Advanced User Quota Management ....................................................................92

6.2.3. Automated Quota Allocation Example ..................................................................926.3. New User Creation Rules .............................................................................................926.4. Bulk User Operations ..................................................................................................94

6.4.1. Example 1: Bulk operation on a user group ...........................................................946.4.2. Example 2: Bulk operation on an ad-hoc list of users ...............................................946.4.3. Additional information .......................................................................................94

6.5. Using Overdrafts ........................................................................................................956.6. Batch User Data Import and Update ...............................................................................96

6.6.1. Batch User Import File Format ............................................................................976.7. Batch User Card/Identity Update ....................................................................................98

6.7.1. Batch User Card/Identity Update File Format .........................................................986.8. Looking up card numbers in an external database .............................................................99

6.8.1. Database lookup configuration ............................................................................996.8.2. Testing ........................................................................................................ 100

6.9. Disabling user printing with time latches .................................................... .................... 100

6.10. Office/Department History ................................ ....................................................... .. 1016.10.1. Scenario 1: Correcting a late change to a user's office or department ...................... 1016.10.2. Scenario - Correcting an unintended office or department change .......................... 102

6.11. User Management Quick Reference ....................................................... .................... 1037. Advanced Printer Management .................. ........................................................ .................... 105

7.1. Adding and Removing/Deleting/Ignoring Printers ...................... ....................................... 1057.1.1. On Windows ................................................................................................. 1057.1.2. On Mac ............................ ........................................................ .................... 1067.1.3. On Linux ...................................................................................................... 106

7.2. The Template Printer ........................................ ....................................................... .. 107


vi


8/564

7.3. Copying Printer Settings ............................................................................................ 1087.4. Renaming a printer ................................................................................................... 1097.5. Disabling printers with time latches ............................... ................................................ 1107.6. Managing printing using differential charging ......... ....................................................... .. 110

7.6.1. Charging modes available ................................ ................................................ 1117.6.2. How duplex discounts are calculated .................. ................................................ 112

7.7. Print filters: conversions and restrictions ............... ....................................................... .. 1127.7.1. Examples ..................................................................................................... 1147.7.2. Print Conversion Filters in Detail ................................................... .................... 1167.7.3. Print Restriction Filters in Detail .................................................... .................... 117

7.8. Managing printer groups ............................................................................................ 1197.8.1. Suggested best practises for naming printer groups .............................................. 121

7.9. Cost Adjustments ..................................................................................................... 1217.10. Popup Authentication ...................................... ....................................................... .. 123

7.10.1. How does popup authentication work? .............. ................................................ 1237.10.2. Where and when should Popup authentication be used? ...................................... 1247.10.3. What technical considerations do I need to review before implementing PopupAuthentication? ...................................................................................................... 1247.10.4. Configuration ............................ ........................................................ ........... 125

7.11. Color Detection ...................................................................................................... 1277.11.1. Limitations of Page-Level Color Detection ....................................................... .. 128

7.12. Validating page counts using hardware checks .................................................. ........... 1297.12.1. Causes for differences in page counts ................................................... ........... 1297.12.2. Requirements .................. ........................................................ .................... 1297.12.3. How hardware checks work ......... ........................................................ ........... 1307.12.4. Configuring hardware checks ................. ....................................................... .. 1307.12.5. Reviewing hardware check results ........................................................ ........... 1347.12.6. Known Limitations ........................................................................................ 1357.12.7. Troubleshooting ...... ....................................................... .............................. 136

7.13. Watermarking/Job Annotation ........................... ....................................................... .. 1367.13.1. Typical Uses ............................................................................................... 1377.13.2. Requirements .................. ........................................................ .................... 1387.13.3. Enabling Watermarking ................................................................................. 1387.13.4. Digital Signatures in Detail (Advanced) .................................................. ........... 1407.13.5. Troubleshooting ...... ....................................................... .............................. 141

7.14. Behavior on Server Connection Failures ... ........................................................ ........... 1427.14.1. Failure Mode Settings ................................................................................... 143

7.15. Toner Levels (for supported printers) ...................................................... .................... 1447.15.1. How toner level information is retrieved? ................................................ ........... 145

7.16. Printer Quick Reference ...... ....................................................... .............................. 1457.17. Refunding Print Jobs ............................................................................................... 146

7.17.1. Enabling End-User Refunds ....................................................... .................... 1467.17.2. Managing Refunds ....................................................................................... 1477.17.3. Admin Notifications ........... ........................................................ .................... 1497.17.4. User Notifications .... ....................................................... .............................. 149

7.18. Custom Printer Fields .............................................................................................. 1517.18.1. Defining Custom Printer Fields ..... ........................................................ ........... 151

7.19. Extracting Usernames in Enterprise Print Environments (e.g. SAP, Unix) ........................... 1527.19.1. Configuring PaperCut to Extract Usernames from Spool Files ... ............................. 152

8. Shared Accounts ................................................................................................................ 1548.1. Creating a Shared Account ...................... ........................................................ ........... 155

8.1.1. The Template Account ........ ........................................................ .................... 156

8.2. Account Naming Guidelines ..................... ........................................................ ........... 1578.2.1. Client / Matter Naming Model ....................................................... .................... 1578.2.2. Project / Phase Naming Model ................. ....................................................... .. 1628.2.3. Customer / Job Naming Model ................. ....................................................... .. 164

8.3. Client Security ......................................................................................................... 1648.3.1. Using account security with PIN/codes .................................................... ........... 167

8.4. The Account Selection Popup ..................................................................................... 1678.4.1. Standard Account Selection Popup ........... ....................................................... .. 1688.4.2. Advanced Account Selection Popup ................... ................................................ 1708.4.3. Manager Mode Popup ............................ ....................................................... .. 172


vii


9/564

8.4.4. Automatically charge to a shared account ................................................ ........... 1738.5. Account Selection in Non-Domain Environments (Workgroups) ... ....................................... 1748.6. Batch Shared Account Import and Update ................................................. .................... 174

8.6.1. Batch Account Import File Format ...................... ................................................ 1758.7. Shared Account Synchronization ................................................................................. 178

8.7.1. Synchronization Options ......................... ....................................................... .. 1788.8. Bulk Shared Account Operations ................................................................................. 1798.9. Shared Account Quota Allocation ................................. ................................................ 1798.10. Shared Account Cost Multiplier ............... ........................................................ ........... 1808.11. Advanced Shared Account Options ........................................................ .................... 180

9. Reports ............................................................................................................................. 1829.1. Report types ................................ ........................................................ .................... 182

9.1.1. User Reports ........................................ ....................................................... .. 1839.1.2. Printer Reports ......... ....................................................... .............................. 1839.1.3. Print Log Reports ............... ........................................................ .................... 1839.1.4. Internet Use Reports .............................. ....................................................... .. 1839.1.5. Group Reports ...................................... ....................................................... .. 1839.1.6. Shared Accounts Reports .... ........................................................ .................... 1839.1.7. Transaction Reports ....................................................................................... 1839.1.8. Environmental Impact Reports ....... ........................................................ ........... 1839.1.9. Ratio Reports ................................................................................................ 1839.1.10. Period Comparison Reports ............................ ................................................ 183

9.2. Report Formats ................... ....................................................... .............................. 1839.3. Combining Filters and Reports .................................................................................... 1849.4. Scheduling and Emailing Reports .................................................. .............................. 185

9.4.1. Usage ....................................... ........................................................ ........... 1859.4.2. Details ......................................................................................................... 188

9.5. Advanced Reporting Options ...................................................................................... 18810. Hold/Release Queues & Print Release Stations .... ........................................................ ........... 190

10.1. Release Station Interfaces ............ ........................................................ .................... 19010.1.1. Standard Release Station ................................................ .............................. 19010.1.2. Manager-mode web-based release station ...................................................... .. 19110.1.3. Web-based release station within the admin pages ............................................. 19210.1.4. End-user web-based release station ................. ................................................ 19210.1.5. Mobile Print Release ......... ........................................................ .................... 193

10.2. Hold/Release Usage Scenarios ................................................................................. 19410.2.1. Saving paper and toner ................................................................................. 194

10.2.2. Secure Printing ....... ....................................................... .............................. 19410.2.3. Pay per print (e.g. Library or Internet Cafe) ...................................................... .. 19410.2.4. Expensive Printers (Approved Printing) .... ....................................................... .. 19510.2.5. Unauthenticated printing .... ........................................................ .................... 195

10.3. Release Station Configuration ................................................................................... 19710.3.1. Enabling hold/release support on a printer ....................................................... .. 19710.3.2. Hold/Release Queue Managers ....................... ................................................ 19710.3.3. Standard Release Station Configuration ............ ................................................ 19810.3.4. End-User Web Based Release Interface Configuration ........... .............................. 201

10.4. Mobile Print Release Configuration .................... ....................................................... .. 20211. Find Me Printing and Printer Load Balancing .................. ....................................................... .. 203

11.1. Find Me Printing ..................................................................................................... 20311.1.1. Implementation by Example ............................ ................................................ 20411.1.2. Find Me Printing and Web-Based Release .................. ....................................... 211

11.2. Requirements For Job Redirection (Load Balancing or Find Me Printing) ............................ 211

11.2.1. Compatibility Testing .................. ........................................................ ........... 21111.2.2. Find Me Printing Implementation Checklist ...................................................... .. 21211.3. Advanced Configuration ...... ....................................................... .............................. 213

11.3.1. Overriding cost and filter settings .. ........................................................ ........... 21311.3.2. Mixed Color and Grayscale Printers ...................................................... ........... 21311.3.3. Cross-Server Job Redirection ..................................................... .................... 213

11.4. Printer Load Balancing .......................... ........................................................ ........... 21411.4.1. Example 1: Simple Load Balancing ....................................................... ........... 215

11.5. Find Me Printing and Printer Load Balancing FAQ ....................................................... .. 21612. Copier Integration .................................. ........................................................ .................... 217


viii


10/564

12.1. Overview ............................................ ........................................................ ........... 21712.2. Setup ................................................................................................................... 21712.3. Device List and Statuses ..... ....................................................... .............................. 21712.4. Managing Copiers ................................ ........................................................ ........... 21812.5. Using filters and restrictions ...................................................................................... 21812.6. Release Stations and Find Me Printing ..... ........................................................ ........... 21812.7. Advanced Configuration ...... ....................................................... .............................. 219

13. System Management ......................................................................................................... 22113.1. Overview ............................................ ........................................................ ........... 22113.2. The Dashboard ...................................................................................................... 22113.3. User and Group Synchronization ................................ ................................................ 223

13.3.1. Sync Source ....................................... ....................................................... .. 22413.3.2. Sync Source Options .................................................................................... 22413.3.3. Sync Options ............................ ........................................................ ........... 22513.3.4. Secondary Sync Source (Advanced) ..................................................... ........... 22513.3.5. Manual Synchronization ................................. ................................................ 22513.3.6. Importing Card/Identity numbers from Active Directory or LDAP ............................. 22613.3.7. On Demand User Creation . ........................................................ .................... 22813.3.8. Using Active Directory for user synchronization ................................................ .. 22813.3.9. Using LDAP for user synchronization ................ ................................................ 229

13.4. Assigning Administrator Level Access ..................................................... .................... 23013.4.1. Assigning Administrator Access to a Group ................. ....................................... 23013.4.2. Assigning Administrator Access to a User ................... ....................................... 232

13.5. System Backups .................................. ........................................................ ........... 23313.5.1. Performing an Online Backup ..................................................... .................... 23313.5.2. Restoring a Backup ...................................................................................... 23313.5.3. Performing Offline Backups ........................................................ .................... 23413.5.4. Backup File Retention ................................................................................... 235

13.6. System Notifications and Emailing ..................... ....................................................... .. 23513.6.1. Configuring Notifications .... ........................................................ .................... 23513.6.2. System Notifications (for Administrators) ................................................ ........... 23913.6.3. Testing Notification Methods .................. ....................................................... .. 242

13.7. System Security Options .......................................................................................... 24213.7.1. Application Server Connections .............. ....................................................... .. 24213.7.2. Provider Connection Security ................. ....................................................... .. 24313.7.3. Web Session Inactivity Timeout .............. ....................................................... .. 243

13.8. Environmental Impact ......... ....................................................... .............................. 244

13.9. Using the Config Editor ............................................................................................ 24514. TopUp/Pre-Paid Cards ....................................................................................................... 246

14.1. Cards by Example .......................................... ....................................................... .. 24614.1.1. The User's Perspective ......................... ....................................................... .. 24614.1.2. The Administrator's Perspective .................................................. .................... 246

14.2. The Card System ................................. ........................................................ ........... 24614.3. Creating New Cards ................................................................................................ 247

14.3.1. Overview and Definitions ................................................. .............................. 24714.3.2. Using the Card Wizard .................................................................................. 24714.3.3. TopUp/Pre-Paid Card Tips ............................................... .............................. 253

14.4. Using a Card ....................................... ........................................................ ........... 25515. Configuring Secondary Print Servers and Locally Attached Printers ............................................. 257

15.1. Configuring a Windows Secondary Print Server ................................................. ........... 25715.1.1. Step 1 - Ensure primary server is set up correctly ......... ....................................... 25715.1.2. Step 2 - Ensure firewall software is set to allow access to port 9191 .... .................... 257

15.1.3. Step 3 - Install the print provider .................................................. .................... 25715.1.4. Step 4 - Configuration ................................................................................... 25715.1.5. Step 5 - Test ............................................................................................... 25815.1.6. Automated Install ......................................................................................... 258

15.2. Configuring a Macintosh Secondary Print Server .. ....................................................... .. 25815.2.1. Step 1 - Ensure primary server is set up correctly ......... ....................................... 25815.2.2. Step 2 - Ensure firewall software is set to allow access to port 9191 .... .................... 25815.2.3. Step 3 - Create the host user account ............... ................................................ 25815.2.4. Step 4 - Install the print provider .................................................. .................... 25815.2.5. Step 5 - Configuration ................................................................................... 258


ix


11/564

15.2.6. Step 6 - Test ............................................................................................... 25915.3. Configuring a Linux or Novell iPrint Secondary Print Server ............................................. 259

15.3.1. Step 1 - Ensure primary server is set up correctly ......... ....................................... 25915.3.2. Step 2 - Ensure firewall software is set to allow access to port 9191 .... .................... 25915.3.3. Step 3 - Account setup .................................................................................. 25915.3.4. Step 4 - Install the Print Provider ................................................. .................... 25915.3.5. Step 5 - Configuration ................................................................................... 26015.3.6. Step 6 - Test ............................................................................................... 260

15.4. Print Monitoring Architecture ..................................................................................... 26015.5. Multiple Print Servers ...................................... ....................................................... .. 26115.6. Automating Secondary Server Deployment on Windows ............................................... .. 263

16. Net Control in Detail ............................... ........................................................ .................... 26516.1. How Internet Control works ........... ........................................................ .................... 265

16.1.1. Data-based control ....................................................................................... 26516.1.2. Time-based control ........... ........................................................ .................... 265

16.2. Proxy server configuration ........................................................................................ 26616.2.1. Proxy authentication ..................................................................................... 26616.2.2. Denying access to users without credit .................................................. ........... 266

16.3. Internet Control service setup ................. ........................................................ ........... 26716.3.1. Single/primary server installation ................................................. .................... 26916.3.2. Secondary server installation ...................................................... .................... 27316.3.3. Verifying the Net Control service setup .................................................. ........... 276

16.4. Internet Control Settings ........................ ........................................................ ........... 27616.4.1. Internet usage costs ............................. ....................................................... .. 27616.4.2. Ignored Domains and users ................... ....................................................... .. 277

17. Advanced Customization .................................................................................................... 27917.1. Customizing the User Client Tool window ................................................ .................... 27917.2. Limiting the list of interface languages/translations ......... ................................................ 28017.3. Customizing the User web pages ... ........................................................ .................... 280

17.3.1. Look & Feel ........................................ ....................................................... .. 28017.3.2. Login Instructions .... ....................................................... .............................. 28317.3.3. Additional Links in the Navigation Menu ................................................. ........... 28417.3.4. Custom Printer Maps for Web Print ....................................................... ........... 285

17.4. Customizing the Administration Web Interface ................................................... ........... 28517.5. Customizing Report Headers ............................ ....................................................... .. 28717.6. Data Access and Custom Reports ........... ........................................................ ........... 288

17.6.1. Plain Text Print Log ...................................................................................... 288

17.7. Automation and Scripting ................................. ....................................................... .. 28917.8. Custom User Directory Information Providers .................................................... ........... 28917.9. Enabling ports 80 (HTTP) and 443 (HTTPS) ................. ................................................ 289

17.9.1. Windows .................................................................................................... 29017.9.2. Linux ......................................................................................................... 29017.9.3. Mac ........................................................................................................... 290

18. Advanced Scripting (Print Scripting) ...................................................................................... 29118.1. Introduction ........................................................................................................... 291

18.1.1. Prerequisites ............................................................................................... 29218.1.2. How to Use Print Scripts .... ........................................................ .................... 29318.1.3. Tips for Print Scripts ............................. ....................................................... .. 296

18.2. Print Script API Reference ... ....................................................... .............................. 29618.2.1. Script Hooks (Entry Points) ............................. ................................................ 29718.2.2. Script Inputs ................................................................................................ 29718.2.3. Script Actions .............................................................................................. 302

18.2.4. User Defined Persistent Properties (Storage) ................................................... .. 31218.2.5. Print Script Requirements (Advanced) ................................................... ........... 31319. Licensing and Support ............................ ........................................................ .................... 314

19.1. Installing a License ......................................... ....................................................... .. 31419.2. Technical Support & Further Information ............. ....................................................... .. 314

20. Deployment on an External Database (RDBMS) .................................................. .................... 31520.1. Overview ............................................ ........................................................ ........... 315

20.1.1. Why use an external RDBMS? ..... ........................................................ ........... 31520.1.2. Supported Databases ........................... ....................................................... .. 315

20.2. Upsizing to an External RDBMS ................................. ................................................ 315


x


12/564

20.2.1. Step 1 - Stop PaperCut MF ........................................................ .................... 31620.2.2. Step 2 - Perform a backup of the existing data ............. ....................................... 31620.2.3. Step 3 - Create a new database in the external RDBMS ....................................... 31620.2.4. Step 4 - Change the PaperCut MF connection details .......................................... 31720.2.5. Step 5 - Initialize the new database ......... ....................................................... .. 31920.2.6. Step 6 - Load the data into the new database ..... ................................................ 31920.2.7. Step 7 - Restart PaperCut MF ...... ........................................................ ........... 320

20.3. Database specific configuration ................................................................................. 32020.3.1. Configuring Microsoft SQL Express ......... ....................................................... .. 32020.3.2. Configuring MySQL ...................................................................................... 32120.3.3. Configuring Oracle (and Oracle Express Edition) ................................................ 322

21. Web Print (Driver-less printing via a web browser) .................... ................................................ 32321.1. Key Features ......................................................................................................... 32321.2. Introduction to Web Print ..... ....................................................... .............................. 324

21.2.1. Supported Applications and File Formats ............................................... ........... 32421.2.2. Security Considerations .............. ........................................................ ........... 324

21.3. Setting Up Web Print .......... ....................................................... .............................. 32421.3.1. Simple Mode Setup ...................................................................................... 32521.3.2. Sandbox Mode Setup ........................... ....................................................... .. 327

21.4. Web Print Testing and Feature Tour ....................................................... .................... 33121.5. Web Print Configuration ........................................................................................... 335

21.5.1. Print Options for Web Print Jobs ............. ....................................................... .. 33621.5.2. Designing Printer Maps / Custom Printer Selection Lists ....................................... 33721.5.3. Advanced Web Print Configuration ................... ................................................ 342

21.6. Troubleshooting Web Print Problems ...................................................... .................... 34321.7. XPS Viewer Installation Instructions ................... ....................................................... .. 344

22. PaperCut & iPad / iPhone Printing (iOS) ................................. ................................................ 34622.1. Requirements ........................................................................................................ 34622.2. Sharing Printers to iOS Devices .............. ........................................................ ........... 34622.3. The PaperCut iPad / iPhone App (iOS app) ......... ....................................................... .. 348

22.3.1. Deployment ........................................ ....................................................... .. 34822.3.2. Usage ................... ....................................................... .............................. 350

22.4. Troubleshooting & FAQ ......................... ........................................................ ........... 36122.5. Advanced iPad / iPhone Printing Setup ................................................... .................... 362

22.5.1. iPad / iPhone Printing Technical Description .................................................... .. 36222.5.2. Limiting Printer Deployment ................... ....................................................... .. 36322.5.3. Advanced App Deployment ........................................................ .................... 363

23. Mobile Print Release - Releasing print jobs on your mobile ...................................................... .. 36423.1. Usage and features ................................................................................................. 36423.2. Deployment ........................................................................................................... 36723.3. Management tips for large networks ....................................................... .................... 367

23.3.1. User education ............................................................................................ 36723.3.2. Power features ............................................................................................ 36823.3.3. Quick printer location .................................................................................... 36823.3.4. Using QR Codes ..... ....................................................... .............................. 368

24. Web Cashier .................................................................................................................... 36924.1. Setting Up Web Cashier ............... ........................................................ .................... 36924.2. Purchasing Items .................................................................................................... 37024.3. Depositing Funds ................................. ........................................................ ........... 37224.4. Web Cashier Order History .. ....................................................... .............................. 37424.5. Advanced Web Cashier Configuration ...... ........................................................ ........... 37424.6. Assigning Web Cashier User .................. ........................................................ ........... 375

24.7. Web Cashier Reports .............................................................................................. 37625. Clustering and High Availability ............................................................................................ 37825.1. About Clustering ..................................................................................................... 37825.2. Microsoft Cluster Server (MSCS) on Windows ................................................... ........... 378

25.2.1. Mode 1 - Clustering at the Print Provider layer .... ................................................ 37825.2.2. Mode 2 - Clustering at all application layers ..................................................... .. 38125.2.3. Clustering Tips .................................... ....................................................... .. 38425.2.4. Additional configuration steps to support Web Print ............................................. 384

25.3. Microsoft Failover Cluster Manager (MSFCM) ............... ................................................ 38425.3.1. Mode 1 - Clustering at the Print Provider layer .... ................................................ 385


xi


13/564

25.3.2. Mode 2 - Clustering at all application layers ..................................................... .. 38825.3.3. Clustering Tips .................................... ....................................................... .. 39125.3.4. Additional configuration steps to support Web Print ............................................. 392

25.4. Veritas Cluster Server (VCS) on Windows .................... ................................................ 39225.4.1. Mode 1 - Clustering at the Print Provider layer .... ................................................ 392

25.5. Novell Cluster Services (NCS) on Novell OES Linux .................................................... .. 39525.5.1. Mode 1 - Clustering at the print provider layer .................................................. .. 39525.5.2. Mode 2 - Clustering at all application layers ..................................................... .. 398

25.6. Client/Workstation Configuration .... ........................................................ .................... 40126. PaperCut MF on Linux ..................................... ........................................................ ........... 403

26.1. The Installation Process ...... ....................................................... .............................. 40326.1.1. Manual extraction ............. ........................................................ .................... 40326.1.2. The install process ............................... ....................................................... .. 40326.1.3. Linux Print Queue Integration .......................... ................................................ 404

26.2. Advanced Configuration & Logs .............. ........................................................ ........... 40726.3. Backups & System Management ................................ ................................................ 40726.4. User Directory and Authentication ................................................ .............................. 407

26.4.1. Standard Unix ..................................... ....................................................... .. 40826.4.2. Samba/Windows Domain ............ ........................................................ ........... 40826.4.3. Custom ...................................................................................................... 408

26.5. Unix Command-Line Release Station Client ...................................................... ........... 40826.5.1. Installing the Command-Line Release Station Client ............................................ 409

26.6. Removing PaperCut MF from a Linux server ..................................................... ........... 41026.7. Linux FAQ ............................................................................................................. 410

27. Print Authentication ......................................... ........................................................ ........... 41227.1. About Authentication and Printing ............................... ................................................ 412

27.1.1. What is authentication? ................................................................................. 41227.1.2. Why does authentication pose a problem? .................. ....................................... 41227.1.3. How does PaperCut MF address authentication? ................................................ 413

27.2. Handling Unauthenticated (non-domain) Laptops ............................................... ........... 41527.2.1. Option 1: Popup Authentication for Unauthenticated Laptops .... ............................. 41527.2.2. Option 2: Release Station Authentication for Unauthenticated Laptops .................... 416

27.3. The Authentication Cookbook - Recipes by example .................................................... .. 41827.3.1. Windows systems with generic logins .................................................... ........... 41827.3.2. Windows laptops that do not authenticate against a domain .................................. 41827.3.3. Windows print server using LDAP or eDirectory authentication .............................. 41927.3.4. Mac OS X systems with generic user accounts ... ................................................ 419

27.3.5. Mac OS X systems using domain authentication via Open Directory ....................... 42027.3.6. Mac OS X systems using domain authentication via Windows Active Directory ......... 42027.3.7. Mac OS X laptops (or single user systems) printing to Windows print queues ........... 42127.3.8. Linux Workstations in a lab environment with printers hosted on a Windows server .. .. 42127.3.9. Linux Workstations in a lab environment with printers hosted on Linux CUPS server .. 42227.3.10. Linux laptops (or single user systems) ...................... ....................................... 42227.3.11. Multiuser Unix terminal servers ............. ....................................................... .. 42227.3.12. Further Recommendations ....................................................... .................... 423

28. Mac Printing in Detail ......................................................................................................... 42428.1. Mac hosted print queues .......................................................................................... 424

28.1.1. Step 1: Installing the printers on the server ...................................................... .. 42528.1.2. Step 2: Enable Printer Sharing .................................................... .................... 42728.1.3. Step 3: Set up the printers on the workstations (pointing to the shared server queues) 42728.1.4. Publishing the printer via Workgroup Manager ............. ....................................... 42928.1.5. Unauthenticated systems (e.g. Laptops) ..................... ....................................... 431

28.2. Windows hosted print queues ................. ........................................................ ........... 43228.2.1. Scenario One: My Own Mac (Single User) ......... ................................................ 43228.2.2. Scenario Two: The Multi-User Mac with Popup Authentication ............................... 43628.2.3. Scenario Three: Multi-user Macs using LDAP or Active Directory authentication ........ 44228.2.4. Scenario Four: Mac OS X Server ............ ....................................................... .. 44628.2.5. Additional information and tips .................................................... .................... 446

28.3. Eliminating PopUp Authentication via Mac Login Hook ................................................. .. 44729. Running in a Workgroup Environment ........................... ....................................................... .. 449

29.1. Option 1: Common username and passwords on all systems ........................................... 44929.2. Option 2: Authenticating via popup ............................................... .............................. 450


xii


14/564

30. Managing Guests and Internal Users .................. ........................................................ ........... 45230.1. Internal Users (users managed by PaperCut MF) ............................................... ........... 452

30.1.1. Implementation by Example ............................ ................................................ 45230.1.2. Internal Users Options .......................... ....................................................... .. 45430.1.3. Changing Internal User Passwords ....................................................... ........... 45730.1.4. Batch Internal User Import and Update .................................................. ........... 458

31. Multiple Personal Accounts ................................................................................................. 46131.1. Why use multiple personal accounts? ..................................................... .................... 461

31.1.1. Separating Quota and Cash ....................................................... .................... 46131.1.2. Independently Managed Work Areas ....... ....................................................... .. 462

31.2. Configuration ......................................................................................................... 46231.2.1. Enabling Multiple Personal Accounts ....... ....................................................... .. 46231.2.2. How Account Priorities Work ........................... ................................................ 46231.2.3. Configuring the Payment Accounts ....................................................... ........... 46331.2.4. Why can't I delete accounts? ...................................................... .................... 46331.2.5. Other Options .................. ........................................................ .................... 464

31.3. Configuration Examples ........................................................................................... 46431.3.1. Example 1: Separate Cash/Quota Accounts ................ ....................................... 46431.3.2. Example 2: Department/Faculty Quotas (Advanced) ............................................ 465

32. Advanced Server Management ............................................................................................ 46732.1. Changing the network interface that PaperCut listens on . ................................................ 46732.2. Overriding the "Host" header for redirects ................................................ .................... 467

A. Tools - database, server-command scripting, and APIs (Advanced) .............................................. 468A.1. Server Commands (server-command) ...................................................... .................... 468

A.1.1. Accessing Server Commands remotely ................................................... ........... 468A.1.2. Available Commands ............................. ....................................................... .. 469

A.2. Database Tool (db-tools) ........................................................................................... 479A.2.1. export-db Command .............................. ....................................................... .. 479A.2.2. import-db Command .............................. ....................................................... .. 480A.2.3. init-db Command ...... ....................................................... .............................. 480A.2.4. delete-old-logs Command ................................ ................................................ 481

A.3. The XML Web Services API ....................................................................................... 481A.3.1. Web Services Example Code ........ ........................................................ ........... 486A.3.2. Security ....................................................................................................... 486

A.4. SSL/HTTPS Key Generation ...................................................................................... 487A.4.1. Re-create the self-signed certificate .......... ....................................................... .. 487A.4.2. Using a custom signed SSL key ........................ ................................................ 488

A.4.3. Importing an existing SSL key ...................................................... .................... 490A.4.4. Installing the Keystore .................................................................................... 491

A.5. User Client Options .................................................................................................. 492A.6. Stopping and Starting the Application Server ...................................................... ........... 495

A.6.1. Stopping and Starting the Application Server on Windows ...................................... 495A.6.2. Stopping and Starting the Application Server on Mac ............................................ 496A.6.3. Stopping and Starting the Application Server on Linux .... ....................................... 496

A.7. Automating / Streamlining Installation on Windows .......... ................................................ 496A.8. Importing Print Job Details ......................................................................................... 497

B. Troubleshooting & Technical FAQ's ..................... ........................................................ ........... 500C. Advanced LDAP Configuration ......... ....................................................... .............................. 505

C.1. LDAP Server Default Configuration ..................... ....................................................... .. 505C.1.1. Standard (Unix / Open Directory) .................................................. .................... 505C.1.2. Novell eDirectory Defaults ... ........................................................ .................... 506C.1.3. Microsoft Active Directory Defaults . ........................................................ ........... 506

D. Proxy server configuration .................................................................................................... 508D.1. Configuring Microsoft ISA Server 2004/2006 .................. ................................................ 508D.2. Configuring Squid Proxy ................ ........................................................ .................... 512

D.2.1. Squid authentication with LDAP / Active Directory ................................................ 512D.2.2. Restricting Internet Access for users without credit ............................................... 513

E. Capacity Planning ............................................................................................................... 516E.1. Database Sizing and Growth ...................................................................................... 516

E.1.1. Internal database growth .............. ........................................................ ........... 516E.1.2. SQL Server database growth ....................................................... .................... 517E.1.3. Sample database growth calculation ......... ....................................................... .. 518


xiii


15/564

E.2. Network Bandwidth Planning .......... ........................................................ .................... 518E.2.1. Bandwidth Estimates .......... ........................................................ .................... 519

E.3. Managing Large Client Account Lists on Distributed Sites . ................................................ 519E.3.1. Known limitations .................................. ....................................................... .. 520

F. Upgrading From a Previous Version ....................................................................................... 521F.1. The recommended upgrade procedure ..................................................... .................... 521

G. Upgrading from PaperCut Quota ........................................................................................... 522G.1. Upgrade process ..................................................................................................... 522

G.1.1. Step 1 - Stop and disable PaperCut Quota ....................................................... .. 522G.1.2. Step 2 - Install PaperCut MF ................... ....................................................... .. 522G.1.3. Step 3 - Configure and test printers .......... ....................................................... .. 522G.1.4. Step 4 - Import the existing User Balances ....................................................... .. 523G.1.5. Step 4b - Import the existing Accounts ...... ....................................................... .. 524G.1.6. Step 5 - Upgrade client software .............. ....................................................... .. 525G.1.7. Step 6 - Optionally uninstall PaperCut Quota ................ ....................................... 525

H. Example User Information Sheets .............. ........................................................ .................... 526H.1. Example 1: Printing with the popup confirmation window ................................................ .. 526

H.1.1. Popup Confirmation Dialog ........... ........................................................ ........... 526H.1.2. The Printing Balance Window ...................................................... .................... 526H.1.3. Resolving Problems .. ....................................................... .............................. 527H.1.4. Printing Denied Message ................................................................................ 527

H.2. Example 2: Printing with shared accounts (for staff) ...................................................... .. 527H.2.1. Shared Account Selection Popup Window ............................................... ........... 527H.2.2. Resolving Problems .. ....................................................... .............................. 528H.2.3. Printing Denied Message ................................................................................ 529

H.3. Example 3: Printing using a release station ........................................................ ........... 529H.4. Example 4: Refunding a print job (for staff) . ........................................................ ........... 530

H.4.1. Refund ........................................................................................................ 530H.4.2. Action Refund Requests ................................................................................. 531

H.5. Example 5: Adding credit using a TopUp/Pre-Paid Card ... ................................................ 532H.6. Example 6: Printing from a wireless network or laptop (Web Print) ..................................... 533

I. Software License Agreement (EULA) ........... ........................................................ .................... 538


xiv


16/564

List of Figures1.1. The user client tool .............................................................................................................. 41.2. The User Client account selection popup .................................................................................. 51.3. The Windows print queue ...................................................................................................... 61.4. PaperCut MF Architecture - an advanced configuration ............................................................... 72.1. Network printer configuration ................................................................................................112.2. Configuring Windows print queue permissions ..........................................................................122.3. Setup wizard .....................................................................................................................132.4. PaperCut MF Configuration wizard .........................................................................................142.5. User sync configuration wizard page ......................................................................................152.6. The Mac installer ................................................................................................................182.7. PaperCut MF Configuration wizard .........................................................................................192.8. User sync configuration wizard page ......................................................................................202.9. Creating the host user account - part 1 ....................................................................................232.10. Creating the host user account - part 2 ..................................................................................242.11. The Novell OES Linux install process ....................................................................................252.12. PaperCut MF Configuration wizard .......................................................................................262.13. eDirectory/LDAP configuration wizard page ............................................................................272.14. The Linux install process ....................................................................................................322.15. PaperCut MF Configuration wizard .......................................................................................332.16. User sync configuration wizard page .....................................................................................342.17. Ensure the advanced popup is enabled .................................................................................372.18. The account selection popup (displaying extra accounts) ..........................................................384.1. Application navigation tabs ...................................................................................................484.2. The Actions area. Click to perform the action. ...........................................................................484.3. Buttons to validate and save settings ......................................................................................484.4. The crumb trail highlighting the location ...................................................................................494.5. A red status message indicating a validation error .....................................................................494.6. A field highlighted indicating a validation error ..........................................................................504.7. Application navigation tabs ...................................................................................................504.8. Adjusting a user's credit up $10.00 .........................................................................................544.9. A 40% discount applied to double-sided printing .......................................................................554.10. Printer Filters and Restrictions .............................................................................................564.11. A printer disabled for 1 hour ................................................................................................564.12. The user client displaying the "Advanced Account Selection Popup" ............................................574.13. The user client tool ............................................................................................................594.14. User 30-day account balance history ....................................................................................604.15. Printer utilization chart .......................................................................................................604.16. Print page history for a single printer .....................................................................................614.17. Printer report in PDF ..........................................................................................................624.18. Printer usage log ..............................................................................................................624.19. User account transaction log ...............................................................................................635.1. PaperCut user client on Mac OS X .........................................................................................645.2. PaperCut user web pages ....................................................................................................655.3. Example of customized user web pages ..................................................................................655.4. The user client balance window .............................................................................................665.5. The user client's confirmation popup .......................................................................................665.6. The user client's standard account selection popup ...................................................................675.7. The user client's advanced account selection popup ..................................................................675.8. PaperCut Client on Mac OS X ...............................................................................................685.9. Deploying an MSI package as part of a Group Policy .................................................................705.10. Configuring a startup application in Group Policy Manager ........................................................715.11. Upgrading an MSI package as part of a GPO .........................................................................725.12. Toast Notification (panel at top right) in Metro Mode .................................................................725.13. PaperCut MF requires Mac OS X v 10.4 or later ......................................................................735.14. Connecting to a Windows server ..........................................................................................735.15. The PCClient share's connection string .................................................................................745.16. Add PCClient as a Login Item ..............................................................................................74

xv


17/564

5.17. Control-click and open the package contents ..........................................................................755.18. Double-click to install the login hook .....................................................................................765.19. A user's summary information ..............................................................................................785.20. Draw a user's attention to their environmental impact ...............................................................795.21. A list of available shared accounts ........................................................................................795.22. Printing costs as seen by the user ........................................................................................805.23. Internet usage costs as seen by the user ...............................................................................805.24. Using a TopUp/Pre-Paid Card .............................................................................................805.25. Transferring funds to another user ........................................................................................815.26. A user's recent balance transactions .....................................................................................815.27. A user's recent printing .......................................................................................................825.28. A user's recent internet usage .............................................................................................825.29. The user's view of jobs pending release .................................................................................835.30. Web Print jobs in progress ..................................................................................................835.31. Mobile user web tools - summary page ..................................................................................845.32. View in Desktop mode link ................................................................................................845.33. Mobile user web tools - balance ...........................................................................................845.34. Mobile user web tools - environmental impact statistics .............................................................845.35. Mobile user web tools - redeem TopUp/Pre-Paid Card ..............................................................855.36. Mobile user web tools - entering a TopUp/Pre-Paid Card number ...............................................855.37. The Paper-Less Alliance Desktop Widget ...........................................

papercut mf manual

Documents