EveryonePrint Integration

with PaperCut Print

Accounting Solution
Configuration Guide

EveryonePrint Integration with PaperCut 2014.02.20

Page 1 of 10

1. Overview .................................................................................................................................................................................3
1.1

Added features with PaperCut integration .....................................................................................................................3

1.2

Prerequisites and Requirements ....................................................................................................................................3

2. How to enable PaperCut integration in EveryonePrint ..............................................................................................................4

3. How to enable EveryonePrint integration in PaperCut ..............................................................................................................5
4. Configuring PaperCut features in EveryonePrint ......................................................................................................................7
4.1

PaperCut Authentication ...............................................................................................................................................7

4.1.1

Automatically create accounts for email print ........................................................................................................8

4.1.2

PaperCut Guest User self-sign up via the Web .......................................................................................................9

4.2

Display PaperCut user balances in user portal .............................................................................................................10

5. Troubleshooting tips .............................................................................................................................................................10

5.1

Create a test accounts using Web form .......................................................................................................................10

EveryonePrint Integration with PaperCut 2014.02.20

Page 2 of 10

1. Overview
EveryonePrint supports advanced integration with the PaperCut print accounting and print
management solution.

1.1 Added features with PaperCut integration

When PaperCut integration is enabled in EveryonePrint, the following additional features are
available:
1.

Authenticate internal users in PaperCut

a.

In addition to authenticating users against LDAP servers, authenticate

internal users in PaperCut

2.

Create guest users from within the EveryonePrint Web interface

a.

EveryonePrint creates a unique numeric username and password for the

guest

3.

b.

User accounts are created as internal PaperCut users

c.

Users email address set in PaperCut

d.

Login credentials optionally emailed to user

Automatically create guest user when user sends email print job or Google Cloud
Print job
a.

EveryonePrint creates a unique numeric username and password for the

guest

4.

b.

User accounts are created as internal PaperCut users

c.

Users email address set in PaperCut

d.

Login credentials emailed to user

Show users PaperCut balance in the EveryonePrint Web interface

1.2 Prerequisites and Requirements

EveryonePrint must be minimum version 3.5.0.
The PaperCut integration requires minimum PaperCut version 14.
EveryonePrint can be installed either on the PaperCut server or on its own server. Most often
EveryonePrint is installed on its own server, separate from the PaperCut solution.

EveryonePrint Integration with PaperCut 2014.02.20

Page 3 of 10

2. How to enable PaperCut integration in EveryonePrint

To enable the PaperCut specific features in EveryonePrint, follow the steps below.
1.

From Windows services, stop the EveryonePrint Web Service

2.

In the root directory of the EveryonePrint installation, open the file eop.xml in a text editor
such as Notepad

3.

Find the entry <edition> and change this to

<edition>waccount</edition>

4.

Find entry <editionacct> and change this to

<editionacct>papercut</editionacct>
It should look like below:

5.

Save the eop.xml file

6.

Start the EveryonePrint Web Service

Now the EveryonePrint Admin interface, will show PaperCut specific configuration features.

EveryonePrint Integration with PaperCut 2014.02.20

Page 4 of 10

3. How to enable EveryonePrint integration in PaperCut

EveryonePrint uses the PaperCut Web services API interface as described here:
http://www.papercut.com/products/ng/manual/apdx-tools-web-services.html
In order for EveryonePrint to communicate with the Web services API, the following must be
established:
1.

IP address level security

The IP address level security in PaperCut is used to control which systems, denoted by IP
address, are allowed to connect to the PaperCut server and call the API's. By default this is
restricted to localhost (127.0.0.1) only.
If EveryonePrint making use of the API's resides on another server, then the EveryonePrint
servers IP address will need to be added to the list of approved addresses in PaperCut under
Options Advanced Allowed XML Web Services callers.
2.

Authentication tokens
When EveryonePrint makes calls to the PaperCut API, a PaperCut authentication token must
be supplied.
In the default setup the authentication token is the built-in admin user's password (This is
password defined for the admin during the initial configuration wizard).
Optionally an alternative web service authentication token may be defined via configuration
- see below.

To specify an alternative web service authentication token, to avoid the need to use/share
the built-in admin user's password:
1.

Login to the system.

2.

Navigate to the Options section.

3.

Click on the Config editor link in the list of actions.

4.

Find the auth.webservices.auth-token config setting.

5.

Enter a new value that will be the new web services authentication token.

EveryonePrint Integration with PaperCut 2014.02.20

Page 5 of 10

6.

Press the Update button to the right to apply the change.

This authentication token can now be used in addition to the built-in admin user's
password.

3.

Enable internal PaperCut users

For EveryonePrint to be able to create and authenticate users internally in PaperCut, Internal
Users must be enabled in PaperCut. This is done via Options User/Group Sync Internal
User Options.

EveryonePrint Integration with PaperCut 2014.02.20

Page 6 of 10

4. Configuring PaperCut features in EveryonePrint

The following section covers the configuration screens in EveryonePrint Admin.

4.1 PaperCut Authentication

EveryonePrint supports authenticating internal PaperCut users.

Enter the Web URL to the PaperCut server and the PaperCut Web services authorization token or
the PaperCut admin accounts password, as described above in section 3.
Verify the authentication to PaperCut using a username or password of a test user created in
PaperCut.
If test authentication fails, an error message will be shown, and error details written to the
EveryonePrint log files.
Enable both PaperCut authentication and LDAP authentication, to authenticate users both
internally in PaperCut (guests) and users in Active Directory/LDAP (eg.
staff/employees/students).

EveryonePrint Integration with PaperCut 2014.02.20

Page 7 of 10

4.1.1

Automatically create accounts for email print

Under Email Authentication, choose how email from unknown senders should be handled,
whether unknown senders are guests, and accounts should be created in PaperCut automatically
for guests.

In this configuration an account is created in PaperCut for unknown users.

EveryonePrint Integration with PaperCut 2014.02.20

Page 8 of 10

4.1.2

PaperCut Guest User self-sign up via the Web

If EveryonePrint is installed in an environment where guests should be able to create guest
accounts using a Web interface, enable the PaperCut Guest Users Self-Signup feature.

Users created via the Web portal are created in the internal PaperCut users database. If an Active
Directory exists, both LDAP and PaperCut users can authenticate.

EveryonePrint Integration with PaperCut 2014.02.20

Page 9 of 10

4.2 Display PaperCut user balances in user portal

For customers using PaperCut quotas or balances, it is possible to show the users PaperCut
balance in the My Print Jobs page.

Control the display of balances from the Web Portal settings page.

5. Troubleshooting tips
5.1 Create a test accounts using Web form
Even if the feature is not needed, its recommended to test the account creation in PaperCut,
using the Web based self-sign-up feature, outlined in section 4.1.2, as errors will appear and be
written to log immediately.
Once accounts can be created successfully using the Web form, they can also be created from
email.

EveryonePrint Integration with PaperCut 2014.02.20

Page 10 of 10