PaperCut Canon Embedded Manual Contents

PaperCut Canon Embedded Manual
Contents
1
2
3
Overview ........................................................................................................................... 4
1.1
Consistency ................................................................................................................ 4
1.2
Integration ................................................................................................................. 4
1.3
Rate of development ................................................................................................. 4
1.4
Vendor Neutral .......................................................................................................... 5
1.5
Security ...................................................................................................................... 5
Installation Requirements ................................................................................................ 5
2.1
Requirements ............................................................................................................ 5
2.2
Device Type Compatibility ......................................................................................... 6
2.2.1
Fax, Scan, Copy and Box-Printing job tracking: ................................................. 6
2.2.2
Scan, Copy and Box-Printing job tracking: ......................................................... 7
2.2.3
Scan and Copy job tracking: .............................................................................. 7
Installation and Setup ....................................................................................................... 8
3.1
Mandatory Device Configuration .............................................................................. 8
3.1.1
3.2
Enable Job logging ............................................................................................. 9
Optional Device Configuration .................................................................................. 9
3.2.1
Enable USB Input for Card Readers and Storage Devices.................................. 9
3.2.2
Automatic Log Out........................................................................................... 10
3.2.3
Status Monitor/Cancel Screen......................................................................... 10
3.2.4
Managing USB Storage Media ......................................................................... 11
3.2.5
Scan To Email SMTP Settings ........................................................................... 11
3.3
Embedded Application Installation ......................................................................... 12
3.4
Application Settings ................................................................................................. 14
3.5
Additional Network Security (optional)................................................................... 15
3.6
Card Reader support ............................................................................................... 16
4
Upgrading to a newer version ........................................................................................ 17
5
Post-install testing .......................................................................................................... 18
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
| Canon Embedded Manual
6
7
2015-10-2323
5.1
Test Preparation ...................................................................................................... 18
5.2
Scenario 1: Standard copying .................................................................................. 19
5.3
Scenario 2: Copying with account selection ............................................................ 20
5.4
Scenario 3: Print release .......................................................................................... 22
5.5
Scenario 4: Scanning and faxing .............................................................................. 23
Configuration .................................................................................................................. 25
6.1
Device Function ....................................................................................................... 25
6.2
Authentication Methods ......................................................................................... 25
Advanced Configuration ................................................................................................. 27
7.1
Config Editor ............................................................................................................ 27
7.2
Configuring Swipe Card Readers ............................................................................. 29
7.3
Customizing the Header Logo.................................................................................. 32
7.4
Customizing the Header Text Color ......................................................................... 32
8
Uninstalling ..................................................................................................................... 33
9
Known Limitations .......................................................................................................... 35
10
9.1
Controlling USB jobs ................................................................................................ 35
9.2
Zero-stop ................................................................................................................. 35
9.3
Fax Tracking with Scan Tracking .............................................................................. 35
9.4
Devices with limited/no Fax Logging and Tracking ................................................. 35
9.5
Devices with limited/no Box Printing Tracking........................................................ 36
9.6
Color Restrictions .................................................................................................... 36
9.7
Waking up the touchscreen..................................................................................... 36
FAQ & Troubleshooting .................................................................................................. 37
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
2 of 37
| Canon Embedded Manual
2015-10-2323
This manual covers the PaperCut MF Canon embedded setup. For general PaperCut MF
documentation, please see the PaperCut MF manual.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
3 of 37
| Canon Embedded Manual
2015-10-2323
1 Overview
This manual provides an overview of the installation, configuration and operation of
PaperCut’s embedded software MFD (Multi-Function Device) solutions. Today’s MFDs are
smarter – they have touch screens and offer the ability to run applications directly on the
device. The goal of PaperCut Software’s embedded MFD solution is to leverage these smart
devices and to provide walk-up copier users with the same set of rich application features
provided in the print control area. These include:












Secure access to device functions
End user authentication including integration with single sign-on environments
Monitoring and control of photocopying, scanning and faxing (quotas, charging,
allocation and logging)
Allocation of copying, scanning and faxing to accounts/departments/costcenters/projects
Release jobs from a hold/release queue (Secure & Find Me Printing)
Group based access control: Limit access to color copying, the device as a whole, or
to selected user groups
Self-associate swipe cards with domain user accounts directly at the device
Streamlined interface throughout
Self-association and print release are possible as part of the device login
Account invoice and comment options are supported
Customizability of print release and account selection screens
Logo, messages and colors are customizable
Highlights of the embedded solution include:
1.1 Consistency
The embedded solutions are developed in-house by the PaperCut Software development
team. This ensures that the copier interface is consistent with the workstation print
interface, meaning users only have to learn one system.
1.2 Integration
PaperCut is a single integrated solution where print, internet and copier control are all
managed in the one system. Users have a single account and administrators have the same
level of reporting and administration for all services. The embedded solution interacts with
the PaperCut server using a Service Oriented Architecture (SOA) and web services based
protocols.
1.3 Rate of development
PaperCut is developed under a release-often policy where new features are made available
to users as soon as they are complete. Unlike hardware based solutions, new versions can
be delivered to users as regularly as software updates.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
4 of 37
| Canon Embedded Manual
2015-10-2323
1.4 Vendor Neutral
PaperCut remains true to its vendor neutral stance. All embedded solutions are equal and
support all server OS’s including Windows, Linux and Mac.
1.5 Security
A large percentage of PaperCut’s user base is in educational environments where security is
important. All embedded solutions are developed with security in mind. Where security
objectives cannot be satisfied, the deficiencies are fully disclosed.
2 Installation Requirements
This section covers the installation of the PaperCut embedded application for compatible
Canon MFDs. The embedded application will enable MFD access control, secure printing
and “Find-Me” printing, and allow logging and control copying, scanning and faxing.(for
information on just tracking network printing see the PaperCut user manual).
2.1 Requirements
Before installing the PaperCut Embedded Application on to the Canon device, ensure that
basic monitoring of network printing has been setup up and tested for this device. The
device would show up in the printer list in the PaperCut web interface and have a few print
jobs in its print history.
After that, ensure that the following points are checked off before getting started:






PaperCut is installed and running on your network. Please see the ‘Introduction ->
Quick Start Guide’ section of the PaperCut user manual for assistance.
Ensure that your Canon device is supported.
Ensure that the Canon device is connected to the network.
Have available the network name or IP address of the Canon device.
It is recommended that the device be configured with a static IP address.
Verify that firewalls or other network restrictions do not prevent the device’s access
to the PaperCut server on ports 9191 and 9193.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
5 of 37
| Canon Embedded Manual
2015-10-2323
2.2 Device Type Compatibility
The PaperCut Embedded software for Canon Multi-Function Devices (MFDs) is supported on
the following device models and types of activity tracking:
2.2.1 Fax, Scan, Copy and Box-Printing job tracking:
imageRUNNER ADVANCE series:






























4025 / 4025A / 4025F / 4025i
4035 / 4035A / 4035F / 4035i
4045 / 4045A / 4045F / 4045i
4051 / 4051A / 4051F / 4051i
4225 / 4225A / 4225F / 4225i
4235 / 4235A / 4235F / 4235i
4245 / 4245A / 4245F / 4245i
4251 / 4251A / 4251i
6055 / 6055i
6065 / 6065i
6075 / 6075i
6255 / 6255i
6265 / 6265i
6275 / 6275i
8205 / 8205 PRO
8285 / 8285 PRO
8295 / 8295 PRO
C5030 / C5030F / C5030i
C5035 / C5035F / C5035i
C5045 / C5045F / C5045i
C5051 / C5051F / C5051i
C5235 / C5235F / C5235i
C5240 / C5240F / C5240i
C5250 / C5250F / C5250i
C5255 / C5255F / C5255i
C7260 / C7260i
C7270 / C7270i
C7280i
C9270 PRO
C9280 PRO
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
6 of 37
| Canon Embedded Manual
2015-10-2323
2.2.2 Scan, Copy and Box-Printing job tracking:
imagePRESS series:




C60
C600 / c600i
C700
C800
imageRUNNER ADVANCE series:



C3320, C3320F, C3320i
C3325, C3325i
C3330, C3330F, C3330i
2.2.3 Scan and Copy job tracking:
imageRUNNER ADVANCE series:









400 / 400i / 400iF
500 / 500i / 500iF
C250 / C250i / C250iF
C350 / C350F / C350i / C350iF
C351iF
C2218F-V
C2220 / C2220F / C2220i / C2220L
C2225 / C2225i
C2230 / C2230F / C2230i
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
7 of 37
| Canon Embedded Manual
2015-10-2323
3 Installation and Setup
The following installation steps are based on the Canon iR-ADV C5240 of the Canon
Grasmere Series of MFDs. The administration web interface and steps may differ for
your model.
3.1 Mandatory Device Configuration
Please access the remote UI at http://<device-ip-address>:8000 and
login as the administrator.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
8 of 37
| Canon Embedded Manual
2015-10-2323
3.1.1 Enable Job logging
For PaperCut to track activity on a Canon MFD requires access to the device’s job
logs. From the remote UI:

Select Settings/Registration

Select Device Management (under Management Settings )

Select Display Log

Check Obtain Job Log from Management Software and click OK
3.2 Optional Device Configuration
3.2.1 Enable USB Input for Card Readers and Storage Devices
If storage devices are to be connected to the MFD or you are connecting a USB card
reader:

Select Settings/Registration

Select External Interface (under Preferences )

Select USB Settings

Check Use as USB Device

Check Use MEAP driver for USB Input Device

Uncheck Use MEAP driver for External USB Device

Click OK
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
9 of 37
| Canon Embedded Manual
2015-10-2323
3.2.2 Automatic Log Out
Canon devices have an 'Auto Reset' feature, which by default logs a user out after
two minutes of inactivity. The time out length can be modified via the web interface:

Select Settings/Registration

Select Timer/Energy Settings (under Preferences )

Select Timer/Energy Settings

Configure the Auto Reset Time

Click OK
3.2.3 Status Monitor/Cancel Screen
By default, the 'Status Monitor/Cancel Screen' can be displayed at any time by
pressing the 'Status Monitor/Cancel' hard key. This screen can contain sensitive data
such as usernames, e-mail addresses, document names etc. This information can be
prevented from being displayed by disabling the following setting in the device's
web interface:

Select Settings/Registration

Select Device Management (under Management Settings )

Select Display Log

Turn off Display Job Log

Click OK
If you would like the 'Status Monitor/Cancel Screen' to be unavailable until a user
logs in:

Select Settings/Registration

Select Device Management (under Management Settings )

Select Display Job Status Before Authentication

Turn off Display Job Status Before Authentication

Click OK
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
10 of 37
| Canon Embedded Manual
2015-10-2323
3.2.4 Managing USB Storage Media
Canon devices enable printing from USB storage media and scanning to USB media.
This functionality can be configured via the web interface:

Select Settings/Registration

Select Store/Access Files (under Function Settings )

Configure Use Scan Function and Use Print Function

Click OK
Any changes will require a reboot of the device.
3.2.5 Scan To Email SMTP Settings
If you want to do scanning to email on the device you can optionally change the
following setting to prevent the device from asking for SMTP verification:

Select Settings/Registration

Select Common Settings (under Function Settings )

Select Set Authentication Method

Configure Information Used for SMTP Server Authentication and choose
Device Settings

Click OK
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
11 of 37
| Canon Embedded Manual
2015-10-2323
3.3 Embedded Application Installation
Canon use a variety of region specific delivery methods designed to streamline the
installation process. Look in the following sub-directory to find out how this is achieved for
your region:
[app-path]\providers\hardware\canon\<your-region>
The sub-directory will contain either a JAR file, or installation instructions specific to your
device’s region. The inclusion of a JAR file means you can manually install the application
onto the device when coupled with an application license from your Canon dealer.
Speak with your Authorized Solution Center (ASC) representative for further details.
Following are the steps required to manually install the JAR for your region:
1. Log on to the device’s administration page, known as the Service Management
Service (SMS), under https://<device-ip-address>:8443/sms/. Tip:
The default administrator’s password is usually “MeapSmsLogin”.
2. Once logged in, select the Enhanced System Application Management option on
the left-hand side.
3. Select the PaperCut embedded software for Canon devices, by pressing the
Enhanced System Application File Path Choose File button.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
12 of 37
| Canon Embedded Manual
2015-10-2323
4. Locate and select the PaperCut embedded software at [apppath]\providers\hardware\canon\<your-region>\pc-meap.jar.
5. Select the License File Path Choose File button, and provide the location of the
dealer supplied license file.
6. Press the Install button.
7. You will be asked to confirm the installation of the embedded application. Select
Yes .
8. When the PaperCut embedded application has been installed, you will be returned
to the Enhanced System Application Management page. Switch to the “PaperCut”
Login Service by selecting the associated SWITCH button.
9. The “PaperCut” Login Service status will change to “Start after Restart”. Restart the
device to activate the PaperCut embedded application.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
13 of 37
| Canon Embedded Manual
2015-10-2323
3.4 Application Settings
Once the device has restarted, you can configure the PaperCut embedded application for
Canon devices by typing the following URL into a web browser: http://<ip-addressof-device>:8000
1. Enter the System Manager ID and System PIN . Tip: By default, they are both
“7654321”.
2. Press the Configure PaperCut button.
3. Specify the PaperCut Device Name .
4. Specify the Server IP/Host of the PaperCut server.
5. Press the Save button.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
14 of 37
| Canon Embedded Manual
2015-10-2323
Once the PaperCut embedded application has connected to the PaperCut server, the
authentication screen will display on the device, and the MFD will appear in the
PaperCut server devices list.
3.5 Additional Network Security (optional)
The MFP communicates with the PaperCut server over the network (e.g. to authenticate
users or release print jobs). To provide an additional level of security, PaperCut may be
configured to only allow device connections from a restricted range of network addresses.
This ensures that only approved devices are connected to the PaperCut servers
By default PaperCut will allow device connections from any network address. To restrict this
to a subset of IP addresses or subnets:
1. Logon to the PaperCut administration web interface at http://<papercutserver>:9191/admin
2. Go to the OptionsAdvanced tab and find the “Security” section.
3. In the “Allowed device IP addresses” field enter a comma-separated list of device IP
addresses or subnets (in the format <ip-address>/<subnet-mask>).
4. Press the “Apply” button.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
15 of 37
| Canon Embedded Manual
2015-10-2323
3.6 Card Reader support
PaperCut supports using swipe card for authentication at the copier. This is often more
convenient than entering username/password or ID/PIN numbers to log in.
PaperCut supports commonly used keyboard emulating USB card readers including:





Elatec TWN3 and TWN4
RFIDeas PxProx Plus
RFIDeas MS3-00m1aku Mag reader
NTWare MiCard PLUS
MiFare and HID iClass Readers
Please ensure the Canon MEAP USB driver is enabled as per the setup instructions in section
3.2.1 above.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
16 of 37
| Canon Embedded Manual
2015-10-2323
4 Upgrading to a newer version
After disabling the embedded application, the procedure for upgrading is the same as the
standard installation process, keeping all of your configuration settings.
1. Log on to the device’s administration page at https://<device-ipaddress>:8443/sms/.
2. Select the Enhanced System Application Management option on the left-hand
side.
3. The “PaperCut” login service needs to be disabled before it can be upgraded. Switch
to the “Default Authentication” login service by selecting the associated SWITCH
button.
4. Restart the device and log back into the device administration page as per steps 1
and 2 above.
5. Upgrade the application as per the Embedded Application Installation instructions.
After upgrading, it's worth checking that the embedded application's version number is
correct.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
17 of 37
| Canon Embedded Manual
2015-10-2323
5 Post-install testing
After completing installation and basic configuration it is recommended to perform some
testing of the common usage scenarios. This important for two reasons:
1. To ensure that the embedded application is working as expected.
2. To familiarize yourself with the features and functionality of PaperCut and the
embedded application.
This section outlines four test scenarios that are applicable for most organizations. Please
complete all the test scenarios relevant for your site.
5.1 Test Preparation
To complete these tests it is recommended you use two test users so that each can be
configured differently. These users are:


‘testusersimple’ – used to perform basic copier monitoring and control and to
perform print release tests.
‘testuseradvanced’ – used to perform copier monitoring and control with the
account selection enabled (i.e. to charge copying to accounts/departments/costcenters/etc.).
If you have existing users that can be used for these tests, then they can be used instead.
To setup these users in PaperCut:
1. Create the ‘testusersimple’ and ‘testuseradvanced’ users in your Active Directory or
LDAP directory.
2. Log into the PaperCut’s admin web interface
3. Go to the “Options->User/Group sync” page and press “Synchronize Now”.
4. Once the sync is complete, the users will be added to PaperCut.
The next step is to configure the users. To configure ‘testusersimple’:
1. In PaperCut, select the “Users” tab
2. Select the ‘testusersimple’ user.
3. Set the user’s balance to $50.00 and verify the account is set to “Restricted”.
4. Verify that this user is set to “Automatically charge to personal account” in the
“Account selection” options.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
18 of 37
| Canon Embedded Manual
2015-10-2323
5. Press the “OK” button to save.
To configure ‘testuseradvanced’:
1. In PaperCut, select the “Users” tab
2. Select the ‘testuseradvanced’ user.
3. Change the “Account Selection” option to “Standard account selection popup” and
enable all the account selection options.
4. Press the “OK” button to save.
5.2 Scenario 1: Standard copying
Standard copying involves monitoring/charging printing to a user’s personal account. This is
most commonly used for student printing or basic staff monitoring. Users can also be
configured for unrestricted printing, which is commonly used for staff/employee use.
At the photocopier:
1. The photocopier should display a screen to prompt the user to login. Follow the
prompts to login.
2. When prompted, enter username (‘testusersimple’) and password in the login fields.
3. At this point the copier will be enabled for usage.
4. Follow the onscreen instructions and perform some test copying, i.e. press the
“Copy” key on the device and perform a copy as normal.
5. Once completed copying press the “Logout” button on the device’s keypad.
Back in the PaperCut application verify that the copier activity was recorded and the user’s
account deducted.
1. Log into PaperCut.
2. Select the device from the “Devices” tab.
3. Select the “Job Log” tab. This will list all recent copying activity on the copier. The
copying just performed as the test user should be listed. Verify the details of the
copy job that was just performed.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
19 of 37
| Canon Embedded Manual
2015-10-2323
4. Click on the user’s name in the user column to view the user’s account details
5. Select the “Job Log” tab to display all print/copy activity for the user.
6. Select the “Transaction History” tab and verify that the cost of the photocopying was
deducted from the user’s account.
5.3 Scenario 2: Copying with account selection
Firstly a test account should be created:
1.
2.
3.
4.
5.
Log into PaperCut, select the “Accounts” tab.
Select the “Create a new account…” action link on the left.
Enter an account name “Test Account 1”.
Enter PIN/Code “2233”.
Select the “Security” tab and allow all users to access that account by adding the
“[All Users]” group.
6. Press “OK”.
At the photocopier:
1. The photocopier should be displaying a screen to prompt the user to login. Follow
the prompts to login.
2. When prompted, enter the username, ‘testuseradvanced’, and the password in the
login fields.
3. You will now be presented with the Account Selection page:
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
20 of 37
| Canon Embedded Manual
2015-10-2323
You may select your account from a list, by search or by an account code/PIN. From
the list, select the “Test Account 1” created earlier.
4. At this point the copier will be enabled for usage. Follow the onscreen instructions
and perform some test copying. I.e. press the “Copy” key on the device and perform
a copy as normal.
5. Once completed copying press “Logout” button.
Note: The account selection workflow can vary according to the user options selected. For
example a user configured to see the Advanced Account Selection popup may see an
additional dialog asking for comment and invoice information. At the device level, you may
also configure whether you wish to see the Account Summary screen or not.
Back in the PaperCut application verify that the copier activity was recorded and the user’s
account deducted.
1. Log into PaperCut
2. Select the device from the “Devices” tab
3. Select the “Job Log” tab. This will list all recent copying activity on the copier. The
copying just performed as the test user should be listed.
4. Verify the details of the job (i.e. that the job was charged to the selected account).
5. In the log details, click on the “Charged To” account name to view the account’s
details.
6. Selecting the “Job Log” tab will display all print/copy activity for the account, and
will show the test photocopying that was performed.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
21 of 37
| Canon Embedded Manual
2015-10-2323
5.4 Scenario 3: Print release
The embedded application may also be used for print release. For a full description of
PaperCut hold/release queues and release stations, please read the PaperCut manual.
Skip this scenario if hold/release queues will not be used at your site.
To perform print release testing, a hold/release queue must be enabled:
1. In PaperCut, select the “Printers” tab.
2. Select the print queue (i.e. not the ‘device’) for the Canon MFD that will be used for
testing.
3. Enable the “Hold/release queue” option.
4. Press OK/Apply to save the changes. All printing to this queue will now be held until
released by a user.
The photocopier device must also be enabled as a “Print Release Station”:
1.
2.
3.
4.
In PaperCut, select the “Devices” tab.
Select the Canon MFD device.
Under “Device Function” tick “Enable release station”.
Select the print queue that was enabled for hold/release above. The Canon device
will allow jobs on the selected queues to be released.
5. Press “OK” to save.
6. Login to a computer workstation as ‘testusersimple’.
7. Print a few jobs to the print queue that was configured above. The jobs will be held
in the hold/release queue.
8. Confirm that the jobs are held, by checking that the jobs are listed in the “Printers ->
Jobs Pending Release” page of the PaperCut administration interface.
9. Confirm that the username is ‘testusersimple’.
At the device:
1. Log into the device as “testusersimple” as described above.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
22 of 37
| Canon Embedded Manual
2015-10-2323
2. Upon successful login you will be presented with the Held Print Jobs page:
3. Select “Print All” to release all jobs. The jobs will begin to print to the destination
printer. (The “Print All” button will not appear if there are no jobs to print)
4. Once completed press the “Logout” button on the device keypad.
5.5 Scenario 4: Scanning and faxing
Canon devices can also scan documents and send them by email. If a phone line is attached,
they can send faxes. You can enable tracking scanning and faxing. Users can be prevented
from scanning or faxing when they are out of credit.
To enable tracking of scans and faxes:
1. In PaperCut, select the “Devices” tab.
2. Select the MFD device.
3. Under “Device function” tick “Track & control scanning” and tick “Track & control
faxes”.
4. Select the charging type “advanced” in both cases and set some numbers for page
costs and thresholds. The cost after the threshold should be lower than the standard
cost as it represents a volume discount. As an example, the screen shot below shows
that the first page of a fax is charged at $0.20 and any subsequent page at $0.10.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
23 of 37
| Canon Embedded Manual
2015-10-2323
At the photocopier, log in and scan a few documents and send a few faxes. At the end, make
sure to press the “Logout” button on the device’s keypad.
In the PaperCut administration interface verify that the scan and fax activities were recorded
and the user’s account was deducted. This can be done as follows:
1. Log in to the PaperCut administration interface.
2. Select the device from the “Devices” tab.
3. Select the “Job Log” tab. This will list all recent activity on the copier, including
copying, scanning and faxing. The jobs just performed as the test user should be
listed. Verify the details of the jobs that were just performed.
4. Click on the user’s name in the user column to view the user’s account details.
5. Select the “Job log” tab to display all activity for the user.
6. Select the “Transaction History” tab and verify that the cost of the scans and faxes
was deducted from the user’s account.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
24 of 37
| Canon Embedded Manual
2015-10-2323
6 Configuration
After completing the Installation section and registering the device with PaperCut, it will have been
configured with reasonable default settings that are suitable for most environments. This section
covers how to change those default settings. All the following settings are available via the device’s
‘Summary’ tab in the PaperCut administration interface.
6.1 Device Function
The device function setting defines which functions will be available on the device and how it will be
used. Not all function settings are supported on all devices.
Each device function is discussed in the following table.
Device Function
Description
Track & control copying
The device will track walk-up off-the-glass copying.
Track & control scanning
The device will track scanning such as scan-to-email or scan-to-file.
Track & control faxing
The device will track the sending of faxes.
Enable release station
The device will act as a print release station.
6.2 Authentication Methods
PaperCut supports a number of different ways to authenticate users who walk-up to the devices to
perform copying. The default authentication method is username and password authentication.
The available authentication methods can be modified in the ‘External Device Settings ->
Authentication methods’ section.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
25 of 37
| Canon Embedded Manual
2015-10-2323
Authentication methods available for a device
Not all authentication methods are supported on all devices. A grayed-out option indicates that the
option is not supported on this device.
Each authentication method is discussed in the following table.
Authentication
Method
Description
Username and password
The user may use their domain/network username and password to log
into the device.
Identity number
The user may log in with their identity number. Identity numbers are
convenient when usernames are long or cumbersome to enter. For
example, rather than entering a username like ‘john.smith.001’, it may
be more convenient to enter an employee ID of ‘1234’. See the
PaperCut user manual for information about user identity numbers,
including importing identity numbers from an external source.
Identity number ->
Require PIN
When a user logs in with their identity number, they must also provide
their associated PIN. This provides additional security for identity
number logins.
Anonymous (No login
required)
Specifies that this device should always automatically log in as the
specified user. This option overrides all other authentication methods
Description of authentication methods
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
26 of 37
| Canon Embedded Manual
2015-10-2323
7 Advanced Configuration
7.1 Config Editor
The common configuration options for a device in PaperCut are available on the device’s “Summary”
tab, and are discussed in more detail in the Configuration section. This section covers the more
advanced or less common configuration options which are available via the “Advanced Config” tab
in the device details screen.
Config name
Description
ext-devicemsg.welcome
Optionally customize the message displayed on the welcome page
e.g. PaperCut Software\nPlease swipe your card to login.
Specifying “\n” starts text on a new line. Be aware of the limited
screen space available on MFDs.
Default: DEFAULT
extdevice.canon.account
s.initial-tab
Set to “LIST”, “SEARCH” or “CODE” to make the account selection
screen start on the “from List”, “Search” or “by Code” tab
respectively.
If you have many shared accounts you may wish to set this to
“SEARCH”. An example of this is legal firms who use shared
accounts for matter codes.
Default: “LIST”
extdevice.canon.email.pe
rsonalized-sender
When enabled, pre-populate the email address in the device’s
Scan-to-Me function, as stored in the PaperCut user’s details.
extddevice.canon.header
.textcolor
See chapter Customizing the Header Text Color.
Default: Y (Yes)
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
27 of 37
| Canon Embedded Manual
extdevice.canon.limitreference.duplex
extdevice.canon.limitreference.grayscale
extdevice.canon.limitreference.paper-size
2015-10-2323
PaperCut will deny device access to restricted users who do not
have enough balance to copy. To determine if a user has enough
balance to copy a reference copy is required. By default PaperCut
checks if the user has enough balance to copy one grayscale single
sided Letter (North America) or A4 (worldwide) page. In some
situations it may be desirable to change the reference copy, such as
when the device allows smaller page sizes like A5.
Default for ext-device.canon.limit-reference.duplex: N (No)
Default for ext-device.canon.limit-reference.grayscale: Y (Yes)
Default for ext-device.canon.limit-reference.paper-size in North
America: Letter
Default for ext-device.canon.limit-reference.paper-size worldwide:
A4
extdevice.canon.release.
show-cost
Specify whether to show the job cost for each print job in the job
release screen.
extdevice.canon.restricte
d.allow-multiple-login
Enabling this allows users to log in and charge copy jobs to a
restricted account (user account or shared account) if another copy
job charged to the same account is still in progress. This may cause
cost overruns with users going into negative balance.
Default: Y (Yes)
Default: N (No)
extdevice.canon.swipeto-logout
Select whether swiping a card reader when logged in to the device,
logs the user out.
extdevice.canon.timeout.
session.mins
Specify the number of minutes before user session details are
discarded. Session details are kept on the device for jobs
completing after a user has logged out.
Default: Y (Yes)
Default: DEFAULT (1440 minutes, 24 hours)
Examples: 60, 1440
ext-device.card-noconverter
See Configuring Swipe Card Readers.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
28 of 37
| Canon Embedded Manual
2015-10-2323
ext-device.card-noregex
See Configuring Swipe Card Readers.
ext-device.card-selfassociation.usesecondary-cardnumber
Select whether user self-association should occupy the primary or
secondary card number. This overrides the global setting unless the
keyword "GLOBAL" is specified. This is useful when there is a mix of
different non-configurable card readers that read different
numbers from an ID card.
Set to "Y" to use the secondary card number, "N" to use the
primary card number. Default: "GLOBAL" to defer to the global
configuration setting.
ext-device.selfassociation-allowedcard-regex
Specify a regular expression that limits which card numbers are
accepted for associating swipe cards with user accounts. See
Authentication Methods for details. Defaults to “.*” (dot-star)
which includes all card numbers.
7.2 Configuring Swipe Card Readers
Swipe cards contain numbers used to identify users according to the card number configured in the
User Details screen under “Card/Identity” number. Some readers report information in addition to
the number encoded on the card, such as checksums. PaperCut can treat these cases in three ways:
Card Number Needs No Conversion

A typical case is the checksum being reported after the card number, separated by an equals
sign, such as 5235092385=8. PaperCut can handle this case by default; it will extract the
number before the equal sign as the card number: 5235092385.
Regular Expression Filters

For some cases, a “regular expression” may be required that will filter the card number from
the complete string of characters reported by the card reader. Documentation on regular
expressions can be found on the Internet, e.g. at www.regular-expressions.info.
o The regular expression must be fashioned so the card number is returned as the first
match group.
o Usually one regular expression will be used for all the devices managed by PaperCut.
This must be entered in “Config editor (advanced)” which is located on the
“Options” tab under “Actions”. The key is called “ext-device.card-no-regex”.
o Additionally, the global setting can be overridden on a per-device basis: The key
“ext-device.card-no-regex” can also be found on the “Advanced Config” tab in the
device details screen. This setting will override the global setting unless the keyword
“GLOBAL” is specified.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
29 of 37
| Canon Embedded Manual
o
o
2015-10-2323
PaperCut developers will gladly assist in producing a regular expression when
supplied with a few sample outputs from your card reader. Please contact PaperCut
support.
If you would like to write your own regular expressions, here are some examples:
 Use the first 10 characters (any character): (.{10})
 Use the first 19 digits: (\d{19})
 Extract the digits from between the two “=” characters in
“123453=292929=1221”: \d*=(\d*)=\d*
Card Number Format Converters
In addition to extracting parts of the card numbers using regular expressions, converting numbers
from one format to another is a common requirement. For example a card reader may report in
hexadecimal format, while the number stored in the source (e.g. Active Directory) is in a decimal
format. PaperCut includes a number of inbuilt converters to assist here.
Note: Many card readers are configurable - the number format can be changed at the hardware
level via utility or configuration tools. PaperCut’s software-level converters are there to support
card readers that don’t offer this level of configuration, or where a global software-level
conversion is a better choice. For example it may be quicker to do the conversion in PaperCut
rather than manually reprogram 100+ readers!
Like regex’s, the convertors may be defined on either a global (all devices) or a per-device basis.
To set globally:



Options -> Actions -> Config Editor
Search for “ext-device.card-no-converter”
Enter the name of the required converter (see table below) and click Update
To set at the device level:



Devices -> [select device] -> Advanced Config Editor
Search for “ext-device.card-no-converter”
Enter the name of the required converter (see table below) and click Update
Standard Converters
Convertor
Description
hex2dec
Convert a hexadecimal (base 16) encoded card number to decimal
format. Hexadecimal numbers usually contain 0-9 and A-F. This will
convert “946EBD28” to “2490285352”.
dec2hex
Convert a decimal encoded card number to hexadecimal format. This
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
30 of 37
| Canon Embedded Manual
2015-10-2323
will convert “2490285352” to “946EBD28”.
ascii-enc
Unpack an ASCII encoded card number string. E.g. given the number
“3934364542443238”, the ASCII code “39” is converted to 9, “34” > 4, “45” -> E, with the entire number resulting in “946EBD28”.
javascript:<path> Advanced: Define a custom conversion function in JavaScript (see
below)
It is possible to chain or pipeline converters by delimiting with a pipe (|). For example, asciienc|hex2dec will first unpack the encoded ASCII number then convert it to a decimal.
Tip: Not sure which converter to use? Often trial and error is a good approach. After presenting a
card, the number will appear in an application logger message with conversions applied (assuming
the card is unknown to the system). Try different converters and inspect the resulting numbers in
the application log.
Using custom JavaScript
If the inbuilt converter functions are unable to meet requirements, it is possible to define your own
function using JavaScript. This is an advanced exercise and it is expected that any implementer be
familiar with programming and JavaScript. To implement your own converter:
1. Create a file text file [app-path]/server/custom/card.js
2. Define a single JavaScript function in this file called “convert” It should accept and return a
single string. Here is a trivial example:
function convert(cardNumber) {
return cardNumber.substring(3,10).toLowerCase();
}
3. Enter a converter in the form: javascript:custom/card.js
Tip: Check the file [install-path]/server/log/server.log when testing. Any scripting
errors will be displayed as warning messages in the log.
Tip: A Javascript script may also be included in the pipeline. For example
ascii-enc|hex2dec|javascript:custom/card.js
Other advanced notes


If both a regular expression and a converter are defined, the regular expression is applied
first. This means a regular expression can be used to clean up the input (e.g. remove
checksum or delimiters) before passing to a converter.
In some special situations, a custom JavaScript implementation may not be enough. For
example, there may be a requirement to use a 3rd party system to decrypt the
number. PaperCut includes an advanced plugin architecture that the PaperCut Software
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
31 of 37
| Canon Embedded Manual
2015-10-2323
development team uses to implement these advanced converters. Please contact support
to discuss development options and costs.
7.3 Customizing the Header Logo
The embedded application displays a header logo at the top of the device screen. This header can be
replaced with your own organization’s logo image.
The PNG image should be 80 pixels high with the name “header.png”, and placed at the following
location:
[app-path]\server\custom\web\device\canon\
You may need to create the subdirectories if they do not already exist.
Make sure to verify the custom header logo appears correctly on the device.
Note: Some devices do not support PNG images with an alpha channel (transparency). This is a
common cause of the custom image not displaying in the header. Use an image editing program to
remove the alpha channel.
7.4 Customizing the Header Text Color
The header text color can be customized via the “Advanced Config” tab in the device details screen,
see Config Editor:

ext-device.canon.header.textcolor – the text color (specify DEFAULT for the default setting
of white)
The colors are specified using the hexadecimal web/HTML notation (#RRGGBB) where “RR” is the
red component, “GG” is the green component and “BB” is the blue component.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
32 of 37
| Canon Embedded Manual
2015-10-2323
8 Uninstalling
To uninstall the “PaperCut” Login Service:
6. Log on to the device’s administration page at https://<device-ipaddress>:8443/sms/.
7. Select the Enhanced System Application Management option on the left-hand side.
8. The “PaperCut” login service needs to be disabled before it can be removed from the device.
Switch to the “Default Authentication” login service by selecting the associated SWITCH
button.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
33 of 37
| Canon Embedded Manual
2015-10-2323
9. Restart the device and log back into the device administration page as per steps 1 and 2
above.
10. Press the “PaperCut” login service’s associated Uninstall button.
11. You will be asked to confirm. Press the Yes button.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
34 of 37
| Canon Embedded Manual
2015-10-2323
9 Known Limitations
This section lists known limitations with the Canon MEAP implementation.
9.1 Controlling USB jobs
Note: This section refers to the supported devices listed in section 2.2.1 (Fax, Scan, Copy and BoxPrinting job tracking:) and 2.2.2 (Scan, Copy and Box-Printing job tracking:)
Printing from USB media and scanning to USB media are correctly tracked within PaperCut.
However, these jobs cannot be controlled; meaning the jobs cannot be stopped from occurring.
Printing and scanning via USB media can be disabled on the device if required. See Managing USB
Storage Media.
9.2 Zero-stop
Ideally, PaperCut can control exactly how many pages a user can copy, and always prevent the user
from overdrawing their account. Canon devices offer the ability to limit page counts, but copying
does not necessarily stop immediately when those limits are reached. This delay means that users
may overrun their account below zero, by one or more pages.
9.3 Fax Tracking with Scan Tracking
Note: This section refers to the supported devices listed in section 2.2.1 (Fax, Scan, Copy and BoxPrinting job tracking:)
When Fax Tracking and Scan Tracking are enabled at the same time for a device, a fax job is logged
with an associated scan job of the pages scanned.
9.4 Devices with limited/no Fax Logging and Tracking
Note: This section refers to the supported devices listed in sections 2.2.2 (Scan, Copy and BoxPrinting job tracking:) and 2.2.3 (Scan and Copy job tracking:)
These models do not carry the mechanisms needed by PaperCut to both log and control Faxing.
On these devices, PaperCut may not be able to log faxing activity, and will not be able to prevent
users with insufficient funds from faxing. In addition, faxing on these devices might be logged as a
scan job (if the administrator has enabled Scan Tracking on that device in PaperCut).
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
35 of 37
| Canon Embedded Manual
2015-10-2323
9.5 Devices with limited/no Box Printing Tracking
Note: This section refers to the supported devices listed in section 2.2.22.2.3 (Scan and Copy job
tracking:)
Box Printing refers to print jobs that are initiated from the device itself.
Eg. Documents stored on a local mailbox inside the MFD, network share or USB media etc.
On some devices, these actions are accessible through the ‘Access Stored Files’ menu option.
These models do not carry the mechanisms needed by PaperCut to both log and control such print
jobs.
On these devices, PaperCut will not be able to log such print jobs, and will not be able to prevent
attempts by users with insufficient funds to print such documents.
9.6 Color Restrictions
Restricting color printing is not yet available on the device. This feature may be implemented via the
optional Canon Access Management System (AMS) in a future release.
9.7 Waking up the touchscreen
A device's touchscreen is turned off when in energy saving mode. Card swiping an attached card
reader logs in to the device, but not all devices are capable of 'waking up' the touchscreen without
the user pressing the 'Energy Saver' hard key.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
36 of 37
| Canon Embedded Manual
2015-10-2323
10 FAQ & Troubleshooting
What is the IP address of my PaperCut Server?
Use operating system command-line tools such as ipconfig or ifconfig to determine this.
The embedded application shows “Device Setup: failed to connect to …”?
This indicates that the embedded application is unable to connect to the PaperCut server over the
network. The embedded application will continually try to connect to the server, so if there is a
temporary network outage it will start working once the connection is available again.
Common causes of this problem are:




The PaperCut application server is not running.
There are firewalls or network routing configuration that is stopping the network connection
from being established. Check firewalls on the PaperCut server or with your network
administrator.
There is a network outage that is stopping the connection being established. Try accessing
the web interface of the Canon device to check that a network connection can be
established.
The PaperCut server name or IP was not set correctly.
Jobs performed on the MFD are not tracked in PaperCut?
Have you enabled job logging? See Enable Job logging.
Why would a card reader not work?
Not all card readers are supported. See Enable USB Input for Card Readers and Card Reader support.
I have thousands of accounts representing my clients. Will the system handle this?
Yes. We have designed the system to handle thousands of Shared Accounts. Users with many
accounts will also be presented with some “power options” to help them find accounts including
keywords based search.
Copyright © 2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
37 of 37