PaperCut MF - Toshiba eSF Embedded Manual - 2021-07-29
PaperCut MF - Toshiba eSF Embedded Manual - 2021-07-29
PaperCut MF - Toshiba eSF Embedded Manual - 2021-07-29
M Manual
Contents
1 Document revision history................................................................................................ 3
2 Installation ........................................................................................................................ 4
2.1 Requirements ............................................................................................................ 4
2.1.1 Supported models ............................................................................................. 4
2.2 Setup Procedure ........................................................................................................ 4
2.2.1 PaperCut Settings .............................................................................................. 4
2.2.2 Locating the Embedded Application File ........................................................... 4
2.2.3 Installing the Embedded Application ................................................................ 5
2.2.4 Setting Login Timeout........................................................................................ 6
2.2.5 Setting Logout Timeout ..................................................................................... 7
2.2.6 Disabling “Held Jobs” ......................................................................................... 8
2.2.7 Security Lock-Down ........................................................................................... 8
2.2.8 Additional Network Security (optional)........................................................... 10
2.3 Upgrading to a newer version ................................................................................. 10
3 Post-install testing .......................................................................................................... 12
3.1 Test Preparation ...................................................................................................... 12
3.2 Scenario 1: Standard copying .................................................................................. 13
3.3 Scenario 2: Copying with account selection ............................................................ 14
3.4 Scenario 3: Print release .......................................................................................... 15
3.5 Scenario 4: Scanning ................................................................................................ 17
4 Configuration .................................................................................................................. 19
4.1 Device Function ....................................................................................................... 19
4.2 Authentication Methods ......................................................................................... 19
4.3 Shared Account Selection ........................................................................................ 20
4.4 Customizing Text and Messages.............................................................................. 21
4.5 Tracking Jobs from Non-Standard Applications ...................................................... 21
4.6 Automatic Sign-On to Applications ......................................................................... 22
4.7 Configuring Application Access Controls with PaperCut Security Templates (eSF 4.4
and earlier devices) ............................................................................................................. 23
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
4.8 Configuring Application Access through the PaperCut MF Application Server (eSF
5.0+ devices) ....................................................................................................................... 24
4.9 SNMP ....................................................................................................................... 24
5 Advanced Configuration ................................................................................................. 24
5.1 Config Editor ............................................................................................................ 24
5.2 Configuring Swipe Card Readers Customizing the Header Logos and Colors ......... 30
5.2.1 Customized Logos ............................................................................................ 30
5.2.2 Custom Header Color ...................................................................................... 31
5.3 Configuring Swipe Card Readers ............................................................................. 31
5.3.1 Card Number Needs No Conversion................................................................ 31
5.3.2 Regular Expression Filters................................................................................ 31
5.3.3 Card Number Format Converters .................................................................... 32
5.3.4 Standard Converters ........................................................................................ 32
5.3.5 Using custom JavaScript .................................................................................. 33
5.3.6 Other advanced notes ..................................................................................... 33
5.4 Block the release of jobs to a device in error .......................................................... 34
6 Known Limitations and Security ..................................................................................... 35
6.1 Known Limitations ................................................................................................... 35
6.2 Security concerns .................................................................................................... 36
7 FAQ & Troubleshooting .................................................................................................. 37
A. Appendix: Supported Authentication Card Readers ...................................................... 38
B. Appendix: Screenshots for User Information Sheets ..................................................... 39
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 2 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 3 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
2 Installation
Note: Toshiba is a Trademark of Toshiba, USA and LeSF is a trademark of Lexmark USA. PaperCut is
solely responsible for the contents of this publication and the performance of PaperCut's products.
This section covers installation of the PaperCut embedded application for compatible Toshiba
devices. The embedded application will allow control, logging and monitoring of walk-up off-the-
glass copier usage and may serve as a release station for network prints (for information on just
tracking network printing see the PaperCut user manual).
2.1 Requirements
Ensure that the following requirements are satisfied before getting started:
• The PaperCut server software is installed and running on your network. Please see the
‘Installation’ section of the PaperCut user manual for assistance.
• Ensure that your Toshiba device is supports eSF version 1.2 or later. Check the device lists in
section 2.1.1 below.
• All devices are certified with latest available firmware and hard disk sizes.
• Have available the network name and IP address of the system running PaperCut (e.g. the
print server).
• Make sure the network (firewalls, routers etc.) allows TCP connections on ports 9191, 9192
and 9193 from the device to the PaperCut server.
• Ensure that the Toshiba MFD is connected to the network.
Integration is supported for compatible Toshiba LeSF devices. For a list of supported models, see
http://www.papercut.com/tour/embedded/toshiba/#supported.
3. Click ‘Apply’.
PaperCut offers two versions of the Lexmark Embedded application, targeted at different versions of
the Toshiba embedded services framework (eSF). You must install the version of the application
suited to your Lexmark device. The following applications are available:
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 4 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
The files are located under your PaperCut installation directory on the server, in the subdirectory
[app-path]/providers/hardware/Toshiba.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 5 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
15. The device will attempt to connect to the PaperCut server. Once successful, you may need to
accept the server's SSL certificate.
16. Check that the SHA-1 fingerprint matches the server's certificate. You can also see the
certificate details by hovering over the ‘Fingerprint’ question mark (?) icon. See the
‘Troubleshooting SSL’ section of the PaperCut MF manual for details on viewing server
certificates.
17. Press the 'Accept' button to permanently accept the server certificate. The device will
attempt to connect to the server with the accepted certificate.
18. Once connected, the PaperCut login screen will display on the device.
19. The Toshiba device is displayed in the PaperCut Admin web interface under the “Devices”
tab with the name you provided in the steps above. It will be created using the cost settings
of the “[Template Printer]” on the “Printers” tab.
20. The embedded application is now successfully installed. To use the photocopier, the users
must login to the application, and any copying they perform will be logged in PaperCut.
When configured, the native device’s Screen Timeout supersedes PaperCut inactivity timeout (See
the config key ext-device.inactivity-timeout-secs in Config Editor).
The location of the native device’s Screen Timeout setting is different for every platform.
• On Gen 5 devices (Android), it can be found in: Settings > Device > Preferences > Screen
Timeout.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 6 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
• On Gen4 devices (Non-android), it can be found in: Settings > General Settings > Timeouts >
Screen Timeout.
While on Android devices, the user is logged out of the device entirely, on non-android devices, the
user is only exited from the current screen and returned to the home screen (like the PaperCut
inactivity timeout).
After logging into the device, the device shows the “Home screen”, which presents the available
functions, such as, copying, scanning, and faxing. This screen is also displayed after the completion
of each function.
Note: Android-based devices do not return to the Home screen. Instead, the user is logged out after
the timeout period.
By default, non-android Lexmark devices return to the login screen after a timeout of typically 5
seconds, requiring the user to go through the login procedure again.
• On one hand, the timeout should be long enough to provide the user with time to
contemplate whether to continue using the device and which function to select.
• On the other hand, the timeout should be short enough to prevent “tailgating”, i.e. after a
user walks away from the device another user should not be able to walk up to it and
continue using it with the previous user’s login credentials.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 7 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
Toshiba devices provide a functionality called “Held Jobs” that overlaps with PaperCut’s hold/release
queues. You should deactivate “Held Jobs” in order to avoid confusion with PaperCut MF’s print
release functions.
In order to prevent unauthorized users from modifying essential device settings such as disabling
copy accounting, a simple security configuration is recommended.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 8 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
This will deny users access to any functions other than copying and print release.
You can revisit this setup later and re-enable other functions, such as e-mail or fax. If
you are uncertain of how to set a particular feature you should deny access by
setting it to “No Authentication Required”, "Require user ID", or "Requires User ID
and Password".
d. Click “Submit”.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 9 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
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 server.
By default, PaperCut will allow device connections from any network address. To restrict this to a
subset of IP addresses or subnets:
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 10 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
After upgrading, it's worth verifying that the Embedded Application's version number matches the
expected value.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 11 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
3 Post-install testing
After completing installation and basic configuration you should test the common usage. This is
important for two reasons:
This section outlines three test scenarios that are applicable for most organizations. Please complete
all the test scenarios relevant for your site.
• ‘testusersimple’ – is used to perform basic copier monitoring and control and to perform
print release tests
• ‘testuseradvanced’ – is used to perform copier monitoring and control with account
selection enabled (i.e. to charge copying to accounts, departments, cost-centers etc.)
1. Create the ‘testusersimple’ and ‘testuseradvanced’ users in your Active Directory or LDAP
directory.
2. Login to PaperCut’s admin web interface
3. Go to the “Options->User/Group sync” page and click “Synchronize Now”.
4. Once the synchronization is complete, the users will be added to PaperCut.
To configure ‘testusersimple’:
4. Verify that this user is set to “Automatically charge to personal account” in the “Account
selection” options.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 12 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
To configure ‘testuseradvanced’:
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 13 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
5. Once copying is completed the device will return to the home screen.
6. Press the “Logout” button.
In the PaperCut application verify that the copier activity was recorded and that the user’s account
was deducted.
1. Log in to 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.
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.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 14 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
5. Select the “Security” tab and allow all users to access that account by adding the “[All
Users]” group.
6. Press “OK”.
7. Repeat this process to create some more accounts.
5. Perform copying as normal. Once completed copying the device will return to the home
screen.
6. Press the “Logout” button.
Back in the PaperCut Admin web interface, verify that the copier activity was recorded and the
user’s account was deducted.
1. Log in to 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 job details (i.e. that the job was charged to the account that was selected).
5. In the log details, click on the “Charged To” account name to view the account 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.
Skip this scenario if hold/release queues will not be used at your site.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 15 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
4. Click OK or 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”:
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 16 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
6. Select the job to release by pressing the arrow next to the job.
7. Confirm the release of the print job by pressing the “Print Job” button.
8. The job will then print.
9. Try cancelling a job by selecting it and then pressing the “Cancel Job” button.
10. The job will be cancelled and will not print.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 17 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
At the device, log in as ‘testusersimple’ and proceed to do faxing and scanning as usual. Both Scan-
to-Email and Scan-to-FTP are supported. Please consult your device manual for details of these
operations.
Back in the PaperCut administrator web interface, the job log for the device will show the scan and
fax jobs with their respective destinations:
• When scanning to multiple destinations such as multiple email addresses or multiple FTP
folders, the whole scan job is only charged once.
• When sending a fax to multiple phone numbers, each fax sent will be charged separately as
a separate fax job.
Note on point-of-charging for faxes: Fax jobs are scanned and then stored by the device for later
(asynchronous) faxing. While fax jobs are pending, the red “Cancel Jobs” button will display on the
device’s home screen and can be pressed to inspect the pending jobs and cancel them individually.
• On eSF 2.1+ devices, charging of faxes is delayed until sending over the telephone line has
succeeded.
o This has the benefit that cancelled fax jobs will not be charged.
o While restricted users’ account balance is checked for sufficient credit during the
scan process of a fax job, users may in some cases be able to deplete their credit
before the fax has completed sending and as such the delayed charging of faxes may
result in users overrunning their account balance.
• On eSF 1.2 devices, users are charged at completion of the scan process of a fax job and will
not be reimbursed should the fax job subsequently fail to transmit because of a manual
cancellation, a busy/faulty telephone number or any other reason.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 18 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
4 Configuration
After completing the Installation section and registering the device with PaperCut, it will be
configured with default settings that are suitable for most environments. This section covers
changes to the default settings. All of the following settings are available via the device’s ‘Summary’
tab in the PaperCut administration interface.
Track & control copying The device will track walk-up off-the-glass copying.
Enable release station The device will act as a print release station.
Available authentication methods can be modified in the ‘External Device Settings -> Authentication
methods’ section.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 19 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
Authentication Description
Method
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 -> When a user logs in with their identity number, they must also provide
Require PIN their associated PIN. This provides additional security for identity
number logins.
Swipe card The user may log in by swiping a card (e.g. magnetic strip, smart card,
RFID). See the PaperCut user manual for information about user card
numbers, including importing card numbers from an external source.
Please see Appendix 0 below for a list of supported card readers.
Swipe card -> Require When a user logs in by swiping a card, they must also provide their
PIN associated PIN. This provides additional security for swipe card logins.
Swipe card -> Enable Available Q1 2010: Users can swipe cards previously not used or
self-association with registered at the device with PaperCut and will be prompted for their
existing user accounts username and password. The swipe card can then be used at
subsequent logins. See chapter 5.1 for advanced configuration of this
function.
Automatically login as Specifies that this device should always automatically log in as the
user given user. This option overrides all other authentication methods
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 20 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
The options available to each user, as well as account security access, will mirror the same options
available when the user prints. “Select from list” and/or “Select using PIN/Code” are controlled at
the user level via the User Details page. The “Security” tab on each account controls account security
and access.
Note: The search option will only appear if the account list is long. Short lists of only a few accounts
will not list a search option.
The text can be customized by editing the device configuration from the PaperCut administration
interface. For more details, see the following Advanced Configuration section.
• come preinstalled with some devices, such as “Forms and Favorites” or “Scan to Network”,
• can be installed as eSF applications such as “Eco Copy”, or
• can be accessed via the “Profiles” button on the home screen or through the “Held Jobs”
menu.
If “automatically charge to personal account” or “automatically charge to single shared account” are
configured for a PaperCut user, non-standard application usage will be automatically charged to the
user’s personal account or pre-defined shared account respectively. For any other account selection
option, the default behavior is to charge jobs from non-standard applications to the user’s personal
account.
Jobs from non-standard applications are not subject to credit limits of restricted personal or shared
accounts, i.e. users can overrun credit limits by producing jobs through non-standard applications. In
environments where enforcing credit limits is desired, it is recommended to disable non-standard
applications by removing them from the home screen via the device’s web configuration.
Charging can be configured to display an account selection dialog and charge non-standard
application jobs to the selected account instead. Two options are available for non-standard
application account selection, each with different limitations:
• Account Selection from Home Screen can be shown when the user selects presses the non-
standard application at the home screen. This is similar to account selection when pressing
the buttons for the standard applications, but with the following limitations:
o The non-standard application needs an “Access Control” in the “Security” menu of
the device’s web configuration.
o Account selection will only be shown once during the session for the selected
application and all other non-standard applications. This means that subsequent re-
selection of the application from the home screen will not result in the account
selection being shown again, nor would selecting another non-standard application.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 21 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
Other 3rd party applications (e.g. document workflow applications) require just the username of the
authenticated user to direct scanned documents to the correct destination.
You can configure PaperCut MF to automatically pass the user’s PaperCut MF credentials to the
application requiring sign-on, subject to the following limitations:
• PaperCut MF can only pass credentials to one application. E.g. if both “Scan to Network” and
“Forms and Favorites” are present on the copier, one of them has to be selected for
automatic sign-on. All other applications require manual sign-on as before.
• In case the application needs both username and password for its functionality, the user has
to log in with username and password. If the application needs only the username, any login
method will work.
• Application sign-on is incompatible with Account Selection from Home Screen for non-
standard applications (see section 4.5). If account selection for non-standard applications is
required with application sign-on, you must enable Account Selection at Login.
To enable automatic sign-on to an application, configure the application’s access control with a
PaperCut MF security template (see section 4.7). Next, change the advanced configuration property
“ext-device.toshiba.app-sign-on” from “OFF” to the appropriate access control identifier:
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 22 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
• For access control identifiers of other applications, contact your reseller or Authorized
Solution Center. You can find their contact information in your PaperCut Admin interface on
the About page.
• Some applications can be configured to use the all-purpose numeric access controls
“Solution 1” to “Solution 10”. In this case the access control identifier is the number 54 plus
the solution number added, e.g. for “Solution 5” the identifier is “59”.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 23 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
Repeat this process for every device application that you would like to configure an access control
for as per instructions from the previous sections, increasing the number for the security template
every time. E.g. for the second application, create a security template named “PaperCut 2” with
“PaperCut Authentication Module 2”, then “PaperCut 3” with “PaperCut Authentication Module 3”
etc. A maximum of 5 security templates can be created this way and assigned to a maximum of 5
access controls.
4.9 SNMP
PaperCut MF uses SNMP to:
5 Advanced Configuration
5.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 devices details screen.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 24 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
ext-device.block-release-on- Defines the error types that will block the release of
error.snmp-error-list jobs from the MFD Print Release. Valid values:
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 25 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
outputTrayMissing, markerSupplyMissing,
outputNearFull, outputFull,
inputTrayEmpty, overduePreventMaint
ext- If set to “Y” and the email field of the user logged
device.toshiba.email.personalized- onto the Toshiba device has been populated in
sender PaperCut, will set this email address as the “From”
field in the scan-to-email function. Depending on
device model and firmware, “Track and Control
Scanning” may have to be enabled.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 26 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
ext-device.toshiba.show-start-prompt Default: “Y”. If set to “N” the initial prompt that asks
the user to press a button to start logging in will be
skipped and the device immediately displays the
username or ID number entry prompt. “N” only
works when username or ID number login is
enabled as a single choice (not in combination).
ext-device.toshiba.login.app-only Default: “N”. If set to “Y” the device will show the
home screen with the function icons without
requiring login. Login will only be required for
functions that are being tracked and print release.
ext-device.toshiba.login.account- eSF 1.2 devices only. Default: “N”. If set to “Y”, will
selection display account selection and/or print release
during the login process. See section 4.5 for details.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 27 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 28 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
8 – Supplies menu
10 – Paper Menu
12 – Reports menu
14 – Settings menu
18 – Manage shortcuts
27 – Copy
30 – Email function
32 – Fax Print
33 – FTP function
34 – Held Jobs
35 – Profiles
36 – Shortcuts function
37 – Bookmarks
76 – Cancel jobs
83 – Device menu
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 29 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
The embedded application header has a header logo (as shown below). You can replace this logo
with your organization’s logo.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 30 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
This shows the logo outlined in red. The image must be saved as a GIF file with the following
filename and size:
These images should be saved on the PaperCut application server in the PaperCut application
directory under the subdirectory server\custom\web\device\Toshiba. Create the
subdirectory if necessary. The embedded application will fetch the images from the server to display
them on the device screen.
Minor deviations from the recommended horizontal pixel size are possible for the text logo (wider or
narrower). Verify the correct layout on the device screen after producing the image.
The header colors are defined in the “Advanced Config” in the devices details screen, see chapter
5.1. The options to change are:
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.
• A typical case is the checksum being reported after the card number, separated by an equals
sign, such as in 5235092385=8. PaperCut can handle this case by default; it will extract
the number before the equal sign as the card number: 5235092385.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 31 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
details screen. This setting will override the global setting unless the keyword
“GLOBAL” is specified.
o PaperCut developers will gladly assist in producing a regular expression when
supplied with a few sample outputs from your card reader. Contact your reseller or
Authorized Solution Center for help with regular expressions. You can find their
contact information in your PaperCut Admin interface on the About page.
o 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*
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 regexes, the convertors can be defined on either a global (all devices) or on a per-device basis.
To set globally:
Convertor Description
dec2hex Convert a decimal encoded card number to hexadecimal format. This will
convert “2490285352” to “946EBD28”.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 32 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
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”.
It is possible to chain or pipeline converters by delimiting with a pipe (|). For example, ascii-
enc|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.
If the inbuilt converter functions are unable to meet the 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:
Tip: A JavaScript script may also be included in the pipeline. For example
ascii-enc|hex2dec|javascript:custom/card.js
• 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 might be a requirement to use a 3rd party system to decrypt the number.
PaperCut includes an advanced plugin architecture that the PaperCut Software development
team uses to implement these advanced converters. Contact your reseller or Authorized
Solution Center to discuss development options and costs. You can find their contact
information in your PaperCut Admin interface on the About page.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 33 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
Note: This config key is available for devices supporting eSF v2.1 only.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 34 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
• When using the “Auto Match” paper size setting, “Customer Job” mode, separator sheets or
booklet printing, the cost of a job cannot be estimated accurately prior to printing. For
restricted users, this may result in the job starting to print and getting stopped before it is
complete. It may also result in an account overdraft of a few pages.
• Some Toshiba devices ship with an optional application called “Scan Center”. This
application allows a document to be scanned once and then automatically routes the image
to one or more selectable destinations such as email, copier, fax etc.
Some scan jobs generated through Toshiba’s Scan Center cannot be tracked by PaperCut
MF, nor can PaperCut MF prevent a user with insufficient balance from performing such
jobs. These include scan jobs that target the printer (essentially making them plain copy
jobs) and scan jobs that target multiple destinations.
If this poses a concern, you can disable some Scan Center connectors (for example, disable
'Scan Center - Printer' to prevent standard copy jobs through Scan Center), or remove the
Scan Center app altogether
• Depending on firmware, copy jobs with an output paper size selection of “Auto Size Match”
may not perform zero-stop correctly when the output paper size is not Letter (US/Canada)
or A4 (other countries).
Inquire with Toshiba or your reseller or Authorized Solution Center about whether your
devices’ firmware supports “Auto Size Match” correctly. You can find their contact
information in your PaperCut Admin interface on the About page. If not supported, this
means that
o For copy jobs with output paper sizes with a cost lower than the cost of A4/Letter
the copy job may be denied with a reason of insufficient credit even when sufficient
credit is available.
o For copy jobs with output paper sizes with a cost higher than the cost of A4/Letter
the copy job may result in an account overrun.
• Duplex copies may at times not be charged correctly in mixed duplex/simplex copy jobs such
as copy jobs involving multiple copies of a range of pages where ranges of duplex pages are
interspersed with the occasional simplex page.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 35 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
• Copy jobs with an output paper size selection of “Auto Size Match” are not recorded
correctly with respect to the output paper size used. The paper size recorded will be the
configuration value “ext-device.toshiba.paper-size.default” (see section 5.1) irrespective of
the actual paper size used.
• The copier’s admin password (see chapter 0) should always be kept secure.
• The power and network cable should be securely connected. The system is designed to be
robust and record copier usage if the power is lost during copying, but it is possible to start
copying before the embedded application starts after restarting the copier.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 36 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
Use operating system command-line tools such as ipconfig or ifconfig to determine this.
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 (trying both the
server name and IP), so if there is a temporary network outage then it will start working once the
connection is available again.
This may indicate a configuration issue, or maybe a software bug. Re-check your settings and restart
the MFD (i.e. power-off and power-on the copier). If problems continue, contact your reseller or
Authorized Solution Center. You can find their contact information in your PaperCut Admin interface
on the About page.
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 © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 37 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
• MagTek (USB)
• RFIdeas (USB), tested on RDR-67081AKU but may support others
• Elatec, ACID and Weltrend
• OmniKey CardMan 5321, 5121 and 5125 USB
o OmniKey readers need a driver that needs to be installed as a separate embedded
application alongside PaperCut
o It is being provided as an *.fls file with a file name such as “omnikeydriver-2.1.2.fls”
o Please contact your Toshiba supplier for the OmniKey driver
o PaperCut has been tested with the OmniKey driver version 2.1.2
Other keyboard emulating USB card readers may work, but should be tested prior to deployment.
1. Connecting a supported card reader to the device via the USB port (Note: On some devices
this is hidden under a sticker on the side panel).
2. Enabling Swipe card as an Authentication method under the device’s configuration in
PaperCut’s web interface.
3. Ensure the card number, as read by the reader, is loaded into the Card Number field in the
PaperCut database (or consider using user self-association).
NOTE: Some Toshiba devices do not support any form of connected card reader. Models known to
support card readers are e-STUDIO525P and e-STUDIO305CP. It is recommended you check with
Toshiba to confirm support for card readers on your device.
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 38 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 39 of 40
| PaperCut MF - Toshiba eSF Embedded Manual 2021-07-29
Copyright © 2010-2021 PaperCut Software International Pty. Ltd., All Rights Reserved. 40 of 40