Kyocera Embedded Manual
PaperCut Kyocera Embedded Manual
Contents
1
2
Overview ........................................................................................................................... 3
1.1
Consistency ................................................................................................................ 3
1.2
Integration ................................................................................................................. 3
1.3
Rate of development ................................................................................................. 3
1.4
Vendor neutrality ...................................................................................................... 4
1.5
Security ...................................................................................................................... 4
Installation ........................................................................................................................ 5
2.1
Supported models ..................................................................................................... 5
2.1.1
Integrated scanning ........................................................................................... 5
2.2
Requirements ............................................................................................................ 5
2.3
Setup procedure ........................................................................................................ 6
2.3.1
Enable external hardware integration .............................................................. 6
2.3.2
Install the PaperCut embedded application ...................................................... 6
2.3.3
Configure PaperCut embedded settings ........................................................... 6
2.3.4
Additional network security (optional) ............................................................. 7
2.4
Verify installation and configuration ......................................................................... 7
2.5
Bypassing the system ................................................................................................ 8
3
Upgrading to a newer version .......................................................................................... 9
4
Post-install testing .......................................................................................................... 10
5
4.1
Test preparation ...................................................................................................... 10
4.2
Scenario 1: Standard copying .................................................................................. 11
4.3
Scenario 2: Copying with account selection ............................................................ 12
4.4
Scenario 3: Print release .......................................................................................... 13
4.5
Scenario 4: Scanning and faxing .............................................................................. 15
Configuration .................................................................................................................. 17
5.1
Device details........................................................................................................... 17
5.1.1
Authentication methods.................................................................................. 17
5.1.2
Offline mode .................................................................................................... 17
5.1.3
Tracking ........................................................................................................... 17
5.1.4
Print release..................................................................................................... 17
5.1.5
Integrated scanning ......................................................................................... 17
6
5.2
Usage of panel keys for ID number and PIN or card PIN ......................................... 17
5.3
Shared account selection ........................................................................................ 18
5.4
Customizing text and messages .............................................................................. 18
Advanced configuration .................................................................................................. 19
6.1
Config Editor ............................................................................................................ 19
6.2
Customizing the header........................................................................................... 22
6.2.1
Logo ................................................................................................................. 22
6.2.2
Colors ............................................................................................................... 23
6.3
6.3.1
No conversion required ................................................................................... 23
6.3.2
Regular expression filter .................................................................................. 23
6.3.3
Format conversion........................................................................................... 24
6.4
Release-only expedited workflow ........................................................................... 26
6.5
Strict zero-stop copying ........................................................................................... 26
6.5.1
“Balanced” configuration ................................................................................ 27
6.5.2
“Aggressive” configuration .............................................................................. 27
6.6
7
Swipe card readers .................................................................................................. 23
Scanning to searchable PDF .................................................................................... 27
Known limitations and security ...................................................................................... 28
7.1
Zero-stop when copying .......................................................................................... 28
7.2
Job restrictions on restricted accounts ................................................................... 28
8
Troubleshooting and frequently asked questions .......................................................... 29
9
Appendix: Supported authentication card readers ........................................................ 30
| Kyocera Embedded Manual
2015-11-27
1 Overview
This manual provides an overview of the installation, configuration and operation of
PaperCut’s embedded software Multi-Function Device (MFD) solution for Kyocera. For
general documentation on PaperCut MF, please see the PaperCut MF manual (also available
as online help in the PaperCut administration web interface).
Today’s MFDs are smarter – they have touch screens and offer the ability to run applications
directly on the device. The goal of PaperCut’s embedded MFD solution is to leverage these
smart devices and provide walk-up MFD users with the same rich application features
provided in the print control area. These include:
•
•
•
•
•
•
•
Secure access to MFD functions
End-user authentication including integration with single sign-on environments
Monitoring and control of photocopying, scanning, faxing and on-device printing
from device storage and USB drives to support quotas, charging, allocation and
logging
Allocation of all job types to accounts/departments/cost-centers/projects
Account invoice and comment options are supported
Release print jobs from a hold/release queue, also known as Secure & Find Me
Printing
Group based access control: Limit access to color copying or to the device as a whole
to selected user groups.
Highlights of the embedded solution include consistency, integration, rate of development,
vendor neutrality and security.
1.1 Consistency
The embedded solution is developed by the PaperCut Software development team and the
MFD interface is consistent with the workstation print interface, so users only have to learn
one system.
1.2 Integration
PaperCut is a single integrated solution where print 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 features can
be delivered to users regularly as software updates.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
3 of 30
| Kyocera Embedded Manual
2015-11-27
1.4 Vendor neutrality
PaperCut remains true to its vendor-neutral stance. All embedded solutions are equal and
support all server operating systems including Windows, Linux and Mac.
1.5 Security
A large percentage of PaperCut’s user base is in education environments where security is
important. All solutions are developed with a strong security focus. Where security
objectives can’t be satisfied, any known deficiencies are fully disclosed.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
4 of 30
| Kyocera Embedded Manual
2015-11-27
2 Installation
This section covers the installation of the PaperCut embedded application for compatible
Kyocera MFDs. The embedded application will allow the control, logging and monitoring of
walk-up off-the-glass copy, scan and fax usage and may serve as a print release station for
network prints (for information on tracking network printing see the PaperCut user manual).
2.1 Supported models
PaperCut supports selected multi-function Kyocera devices supporting the HyPAS
framework. For the latest list of supported models, see
http://www.papercut.com/tour/embedded/kyocera#supported.
NOTE: ECOSYS/FS devices must have a Compact Flash (CF) card (older models) or SD card
(newer models) installed.
NOTE: For the purposes of this document, a large-panel MFD has a panel that is 7 inches
(17.8 cm) or larger.
2.1.1 Integrated scanning
The PaperCut embedded application includes integrated scanning, which you can optionally
enable per MFD. Integrated scanning has the following additional prerequisites:
•
•
Large panel
API 2.1.1-subset or later
NOTE: Once the MFD is successfully installed and configured, the API version is
reported as part of its “Device Status” in the PaperCut administration web interface.
2.2 Requirements
Before installing the PaperCut embedded application on to the Kyocera MFD, ensure that
basic monitoring of network printing has been setup up and tested for this MFD. The MFD
should show up in the printer list in the PaperCut administration 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 the MFD is connected to the network.
ECOSYS/FS series devices only: Ensure that the Compact Flash/SD card is installed.
Consult the device manual or your service technician for details.
Have available the network name or IP address of the MFD.
Have available the username and password for administrator access to the MFD’s
internal web interface.
It is recommended that the MFD be configured with a static IP address.
Verify that firewalls or other network restrictions don't prevent the MFD’s access to
the PaperCut server on ports 9191 and 9193.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
5 of 30
| Kyocera Embedded Manual
2015-11-27
2.3 Setup procedure
2.3.1 Enable external hardware integration
Ensure PaperCut is set up on your server and monitoring print activity before proceeding to
install the embedded application.
Log in to the PaperCut administration web interface using a web browser (e.g.
http://papercut-server:9191/admin).
2. Go to the “Advanced” tab of the “Options” page and ensure the option “Enable
external hardware integration” is enabled.
3. Click “Apply”.
1.
2.3.2 Install the PaperCut embedded application
The PaperCut embedded application for Kyocera is provided in a file named pckyocera.pkg, located under your PaperCut installation directory on the server, in the
subdirectory [app-path]/providers/hardware/kyocera/
1.
2.
3.
4.
5.
6.
7.
8.
9.
Copy this file to a FAT32 formatted USB drive.
At the MFD, press the “System Menu” button on the panel, page down until you see
the “Application” item and press it. At this point you may have to log in with the
MFD’s built-in device administrator account.
Press the “Add” button.
Insert the USB drive and wait for “PaperCut” to appear in the list.
Press the checkbox next to the PaperCut list item and press “Install” and confirm
with “Yes”.
Press “Remove USB drive” and confirm with “OK”.
Press “Close”.
Select the new PaperCut list item and press “Activate”.
Now wait up to a minute until the PaperCut setup screen shows.
2.3.3 Configure PaperCut embedded settings
At the setup screen, enter a descriptive device name and the IP address or hostname
of the PaperCut server.
NOTE: The device name should be chosen to uniquely identify this Kyocera MFD
among all devices controlled by PaperCut, including devices from other
manufacturers. E.g. “Kyocera 1” or “Library Copier”.
2. Optionally specify an override for the MFD’s locale (language setting) in the form xx
or xx_XX, e.g. fr for French or zh_HK for Chinese (Hong Kong).
3. Press “Apply”.
1.
Alternatively, the embedded application can also be configured via a web browser from your
desktop workstation. Go to http://<device-ip>:8080/papercut/admin and log in as the
“Admin” user. This is the MFD’s “Admin” user, not PaperCut’s “admin” user. Then proceed
as above.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
6 of 30
| Kyocera Embedded Manual
2015-11-27
2.3.4 Additional network security (optional)
The MFD 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:
Log in to the PaperCut administration web interface at http://<papercutserver>:9191/admin
2. Go to the “Advanced” tab of the “Options” page 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. Click “Apply”.
1.
Test the devices to ensure they can continue to contact the PaperCut server.
2.4 Verify installation and configuration
On the MFD screen you should see a login prompt.
Log in to the PaperCut administration web interface at
http://<papercut-server>:9191/admin. On the “Devices” page, you should see the MFD
listed with the name chosen in section 2.3.3.
You should now proceed to configure page costs, the authentication methods you will allow
and other settings relating to the MFD.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
7 of 30
| Kyocera Embedded Manual
2.5
2015-11-27
Bypassing PaperCut
It is important that administrators take care to prevent users from bypassing PaperCut and
directly accessing the MFD. Likewise, it’s also important that administrators know how to
bypass/disable the system if direct MFD access is required, i.e. to change advanced system
settings. Administrators should take the following precautions:
•
•
Change the MFD’s built-in administrator password and always keep it secure.
Securely connect the power and network cable. PaperCut is designed to be robust
and record MFD usage if power is lost during copying, but it is possible to start
copying before the embedded application starts after restarting the MFD.
To allow for uncontrolled access to the MFD, deactivate the embedded application or
remove it completely:
At the MFD, press the “System Menu” button on the panel, page down until you see
the “Application” item and press it. At this point you might have to log in with the
MFD’s built-in device administrator account.
2. Select the PaperCut application and press the “Deactivate” button to deactivate it
(which will retain the stored configuration) or “Remove” to remove the application
completely.
1.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
8 of 30
| Kyocera Embedded Manual
2015-11-27
3 Upgrading to a newer version
The procedure for upgrading an existing embedded application to a newer version is similar
to the initial installation. Please note that only the device-level installation needs to be
performed, and you shouldn't have to perform any additional configuration within the
PaperCut administration web interface.
After upgrading, it's worth quickly checking the embedded application's version number now
matches the expected value.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
9 of 30
| Kyocera Embedded Manual
2015-11-27
4 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.
4.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 account selection
enabled (i.e. to charge copying to accounts/departments/cost centers)
To set up these users in PaperCut:
1. Create the “testusersimple” and “testuseradvanced” users in your Active Directory or LDAP
directory.
2. Log in to the PaperCut administration web interface.
3. Go to the “User/Group sync” tab of the “Options” page and click “Synchronize Now”.
4. Once synchronization is complete, the users will be added to PaperCut.
The next step is to configure the users. To configure “testusersimple”:
1. Select the “Users” page.
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.
5. Click “OK” to save.
To configure “testuseradvanced”:
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
10 of 30
| Kyocera Embedded Manual
2015-11-27
1. Select the “Users” page.
2. Select the “testuseradvanced” user.
3. Change the “Account Selection” option to “Standard account selection popup” and enable
all the account selection options.
4. Click “OK” to save.
4.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 MFD:
1. On the “Log In” screen, enter the “testusersimple” username and password and press “Log
in”.
2. If you see an account confirmation screen with a “Next” button, press “Next”.
3. You will now see either the home screen or the copy screen (below):
4. At this point, the MFD functions will be enabled for usage.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
11 of 30
| Kyocera Embedded Manual
2015-11-27
5. Perform some test copying, i.e. press the green button on the MFD button panel and
perform a copy as normal.
6. Once completed copying press the “Logout” button on the MFD button panel.
Back in the PaperCut administration web interface verify that the MFD activity was recorded and the
user’s account deducted.
1. Select the MFD from the “Devices” page.
2. Select the “Job Log” tab. This will list all recent activity on the MFD. The copying just
performed as the test user should be listed. Verify the details of the copy job that was just
performed.
4.3 Scenario 2: Copying with account selection
Firstly a test account should be created:
1. In the PaperCut administration web interface, select the “Accounts” page.
2. Select the “Create a new account…” action on the left.
3. Enter the account name “Test Account 1”.
4. Enter PIN/Code “2233”.
5. Click “Apply”.
6. Select the “Security” tab and allow all users to access that account by adding the “[All
Users]” group.
At the MFD:
1. Log in as “testuseradvanced”.
2. You will see something like the following:
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
12 of 30
| Kyocera Embedded Manual
2015-11-27
3. Press “Test Account 1”.
4. The confirmation screen will show that “Test Account 1” has been selected. Acknowledge by
pressing “Next”.
5. Now perform copying as normal and finally log out using the “Logout” button as before.
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 MFD level, you may also configure whether you wish
to see the Account Summary screen or not.
Back in the PaperCut administration web interface verify that the MFD activity was recorded and the
user’s account deducted.
1. Select the MFD from the “Devices” page.
2. 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.
3. Verify the details of the job (i.e. that the job was charged to the selected account).
4. In the log details, click on the “Charged To” account name to view the account’s details.
5. Selecting the “Job log” tab will display all print/copy activity for the account, and will show
the test photocopying that was performed.
4.4 Scenario 3: Print release
The embedded application may also be used for print release. For full description of PaperCut
hold/release queues and release stations, please see the Hold/Release Queues & Print Release
Stations chapter of the PaperCut MF manual.
Skip this scenario if hold/release queues will not be used at your site.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
13 of 30
| Kyocera Embedded Manual
2015-11-27
To perform print release testing a hold/release queue must be enabled:
1. In the PaperCut administration web interface, select the “Printers” page.
2. Select the print queue for the MFD that will be used for testing.
3. Enable the “Hold/release queue” option.
4. Click “OK” to save the changes. All printing to this queue will now be held until released by a
user.
Make sure the MFD is enabled for print release:
1. Select the MFD from the “Devices” page.
2. In “External Device Settings”, tick “Enable print release”.
3. Select the print queue that was enabled for hold/release above. The MFD will allow jobs on
the selected queues to be released.
4. Click “OK” to save.
5. Log in to a computer workstation as “testusersimple”.
6. Print a few jobs to the print queue that was configured above. The jobs will be held in the
hold/release queue.
7. Confirm that the jobs are held, by checking in the PaperCut administration web interface
that the jobs are listed on the “Jobs Pending Release” tab of the “Printers” page.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
14 of 30
| Kyocera Embedded Manual
2015-11-27
8. Confirm that the username is “testusersimple”.
At the MFD:
1. Log in as “testusersimple”.
2. A list of print jobs will show. Select a print job to see its details.
3. Press the “Print” button to add the print job to the queue for printing and a confirmation
screen will show briefly.
4. To cancel a print job, select the print job and press the “Cancel job” button.
5. Remember to log out using the “Log out” button.
4.5 Scenario 4: Scanning and faxing
Kyocera MFDs can also scan documents and send them by email or to a network folder. If a phone
line is attached, they can send faxes. You can enable the tracking of scans and faxes. Users can be
prevented from scanning or faxing when they are out of credit.
To enable tracking of scans and/or faxes:
1.
2.
3.
4.
In the PaperCut administration web interface, select the “Devices” page.
Select the MFD.
Under “Tracking” tick “Track & control scanning” (or “Track & control faxing”).
Select the charging type “advanced” to 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 scan is
charged at $0.10 and any subsequent page at $0.05.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
15 of 30
| Kyocera Embedded Manual
2015-11-27
At the MFD:
1. Log in as “testusersimple”.
2. Press the “Send” or “Send/FAX” button on the panel.
3. Press “Enter E-mail Addr”, enter an email address, place some sheets in the document
feeder and press the green button.
4. The MFD will proceed to scan and send an email with an attached PDF file to the email
address.
5. Press the “Logout” button to log out as before.
In the PaperCut administration web interface verify that the scan was recorded and the user’s
account was deducted. This can be done as follows:
1. Select the MFD from the “Devices” page.
2. Select the “Job Log” tab. This will list all copying, scanning and faxing activity on the copier.
The job just performed as the test user should be listed. Verify the details of the job that
was just performed.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
16 of 30
| Kyocera Embedded Manual
2015-11-27
5 Configuration
After completing installation and registering the MFD with PaperCut, it will have been configured
with reasonable default settings that are suitable for most environments. This section covers how to
change the default settings. All the following settings are available in the PaperCut administration
web interface.
5.1 Device details
The settings in this section are on the MFD’s “Device Details” page which can be accessed by clicking
on the MFD on the “External Device List” tab of the “Devices” page. For more information about
settings in the “Advanced Config” tab, see section 6.1.
5.1.1 Authentication methods
PaperCut supports a number of different ways to authenticate users who walk up to the MFD to use
it. These authentication methods are configured in the “Summary” tab and are documented in the
“Copier Integration” chapter of the PaperCut MF manual.
5.1.2 Offline mode
Offline mode enables the MFD to continue being used when the PaperCut server is unavailable. See
the “Copier Integration” chapter of the PaperCut MF manual for details.
5.1.3 Tracking
The tracking settings in the “Summary” tab for the MFD define which functions will be tracked and
controlled at the MFD. Not all settings are supported on all MFDs.
5.1.4 Print release
The MFD can act as a print release station. Print release configuration is documented in the “Copier
Integration” chapter of the PaperCut MF manual.
5.1.5 Integrated scanning
The PaperCut embedded application can provide a simple scanning interface. See section 2.1.1 for
MFD requirements and refer to the “Integrated Scanning” chapter of the PaperCut MF manual for
more information.
5.2 Usage of panel keys for ID number and PIN or card PIN
When logging in with an ID number, and optionally a PIN, the keys 0 – 9 on the MFD panel may be
used in place of the on-screen keyboard provided the ID number and PIN are numeric. Panel keys
may be used for PIN entry after a card swipe, too. The corresponding fields are highlighted with a
blue frame on the screen.
In addition, the panel keys ‘C’ and “Enter” may be used:
•
•
‘C’ clears the field in case of a mistyped number.
“Enter” advances the highlight to the next field – in case of screens with more than one field
on them such as the ID number + PIN login screen, or performs the log in equivalent to
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
17 of 30
| Kyocera Embedded Manual
2015-11-27
pressing the “Log in” button on the screen after the last field on the screen has been
entered or the screen only has one field.
5.3 Shared account selection
Shared account selection options at the MFD mirror the options presented in the PaperCut client
print popup. The options available include:
•
•
•
Select from a list of shared accounts
Search for shared accounts by keyword
Select account using PIN/Code
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 of the “Account Details” page for each
account controls account security/access.
5.4 Customizing text and messages
PaperCut allows some text that appears on the MFD to be customized. The custom text might
include instructions or terminology that is more appropriate for the site. An example of text that is
customizable is the “welcome text” that displays before the user logs in to the MFD.
The text can be customized by editing the MFD’s configuration in the PaperCut administration web
interface. For more details see section 6.1.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
18 of 30
| Kyocera Embedded Manual
2015-11-27
6 Advanced configuration
6.1 Config Editor
The common configuration options for an MFD in PaperCut are available on its “Summary” tab, and
are discussed in more detail in section 5. This section covers the more advanced or less common
configuration options which are available via the “Advanced Config” tab of the “Device Details”
page.
Config name
Description
ext-device-msg.busy-onrelease
Message to display when “ext-device.kyocera-mita.release.showbusy.job-timeout” is enabled. Specify “DEFAULT” for the default text.
ext-device-msg.cardassociation
Message to display when users are requested to associate their swipe
card with an existing user account. See section 5.1.1 for details.
Specify “DEFAULT” for the default text.
ext-device-msg.welcome
Specify two lines of text to be displayed on top of the login screen in
place of the default message. These can include instructions on which
username and password are valid for the MFD. Specify “DEFAULT” for
the default text.
ext-device-msg.welcomeoffline
Specify two lines of text to be displayed on top of the offline login
screen in place of the default message. Specify “DEFAULT” for the
default text.
ext-device.card-noconverter
See section 6.3.3.
ext-device.card-no-regex
See section 6.3.2.
Default: GLOBAL (defer to the global configuration)
Default: GLOBAL (defer to the global configuration)
ext-device.card-selfassociation.use-secondarycard-number
Select whether user self-association should occupy the primary or
secondary card number. It 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, or ‘N’ to use the primary
card number. Default: "GLOBAL" (defer to the global configuration).
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
19 of 30
| Kyocera Embedded Manual
ext-device.inactivitytimeout-secs
2015-11-27
Defines how long to allow a user to interact on a PaperCut screen
between before they are automatically logged out. Default: 60.
NOTE: Interactions on the MFD’s native screens are governed by the
MFD’s native timeout mechanism.
ext-device.kyoceramita.email.personalizedsender
Set to ‘Y’ to take the user’s email address as stored in the user’s
PaperCut profile and use it as the “From”/”Sender” address when
scanning to email.
NOTE: ECOSYS/FS series MFDs may need a firmware upgrade for this
to work.
ext-device.kyoceramita.extra-app-button.label
If set to a value other than “NONE” will display a second button with
this label underneath “Device functions” on the print release screen.
Pressing this button will enable access to the MFD functions and show
a specific MFD function, defined by “ext-device.kyocera-mita.extraapp-button.target” (see below). Example: “Scanner”
NOTE: This applies to large-panel MFDs only.
ext-device.kyoceramita.extra-appbutton.target
The MFD function to show when pressing the button labeled using
“ext-device.kyocera-mita.extra-app-button.label” (see above).
Options are: APPLICATION, COPY, CUSTOM_BOX, FAX_BOX, JOB_BOX,
PROGRAM, REMOVABLE_MEMORY_BOX, SEND, STATUS, UD_COPY
and UD_SEND.
NOTE: This applies to large-panel MFDs only.
ext-device.kyoceramita.header.color
See section 6.2.2.
ext-device.kyoceramita.header.textcolor
See section 6.2.2.
ext-device.kyoceramita.limit-reference.duplex
See section 6.5.
ext-device.kyoceramita.limitreference.grayscale
See section 6.5.
ext-device.kyoceramita.limit-reference.papersize
See section 6.5.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
20 of 30
| Kyocera Embedded Manual
2015-11-27
ext-device.kyoceramita.limit.strict
See section 6.5.
ext-device.kyoceramita.log.max-size
The maximum size (in bytes) of the debug log file. Default: 20480.
ext-device-kyoceramita.login.device-adminusers
Specify which users are given device admin rights when logged in.
Device admin rights allow editing the address book and other
advanced functions available in the System Menu. As device admin
rights offer full MFD access, including the ability to deactivate the
PaperCut embedded application, only trusted users should be given
device admin rights.
Specify “NONE” for no users to receive device admin rights (default).
Specify a comma-separated list of usernames identifying the users to
receive device admin rights. This list is case-sensitive.
Specify ‘*’ to give device admin rights to all users.
ext-device.kyoceramita.login.show-release
Set to ‘N’ to skip the print release screen during the login process even
with print release enabled. The print release screen will then only be
accessible by choosing PaperCut from the MFD’s Application menu.
See section 6.4 for recommended settings for this workflow.
NOTE: This has no effect when integrated scanning is available.
ext-device.kyoceramita.release.list-format
Change this to change the displayed list of print jobs pending release
to include details in addition to or in place of the document name. Use
the following place holders for document details:
•
•
•
•
•
•
%document% - document name
%user% - username
%pages% - number of pages
%time% - time of printing
%cost% - print job cost
%client% - the machine from which the print job was sent
Example: “%user% - %document%” would show jobs in the form
“jsmith – Tax Form.pdf”.
ext-device.kyoceramita.release.show-busy
Set to ‘Y’ to show a warning message when users are releasing
documents while the MFD is still busy printing or copying.
ext-device.kyoceramita.release.show-busy.jobtimeout
When “ext-device.kyocera-mita.release.show-busy” is enabled, jobs
that have been paused (paper jam, out of paper) for this time are
considered not to be keeping the printer busy.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
21 of 30
| Kyocera Embedded Manual
2015-11-27
ext-device.kyoceramita.release.show-cost
Set to ‘N’ to remove the cost display from the print release details
screen. Suitable for “release only” or “silent tracking” environments.
ext-device.kyoceramita.restricted.allow-busylogin
Set to ‘Y’ to allow users to log in and charge jobs to a restricted
account (user account or shared account) if any other job – charged to
the same or another account – is still in progress. This may cause cost
overruns with users going into negative balance.
ext-device.kyoceramita.restricted.allowmultiple-txn
Set to ‘Y’ to allow users to charge jobs to a restricted account (user
account or shared account) if another job charged to the same
account is still in progress. This may cause cost overruns with users
going into negative balance.
ext-device.kyoceramita.swipe-to-logout
Set to ‘Y’ to allow users to log out using a card swipe (when swipe card
authentication is enabled).
ext-device.kyoceramita.timeout.scan-promptsend.secs
When using integrated scanning and the user is prompted to scan
more or send (or cancel), if no choice is made in this time, the scan
will be sent and the user will be logged out. Default: 30.
ext-device.kyoceramita.timezone.use-server
Set to ‘Y’ to use the time zone of the server when displaying job
creation times in the PaperCut print release job list. This overcomes
some shortcomings with respect to daylight savings that have been
observed with Kyocera MFDs.
ext-device.self-associationallowed-card-regex
Only card numbers matching this regex are allowed to be associated
with existing accounts. See section 6.3.2 for more information about
regexes. Default: “.*” (dot-star; include all card numbers).
6.2 Customizing the header
6.2.1 Logo
The embedded application header includes a logo. This logo can be replaced with your
organization’s logo.
The image must be saved as PNG files with the filename “logo.png” and should be no more than
55 pixels high and 300 pixels wide, and less than 50 kB in file size.
This image should be saved on the PaperCut application server in the PaperCut application directory
under the subdirectory server\custom\web\device\kyocera-mita. Create the
subdirectory if necessary. The embedded application will fetch the image from the server to display
it on the MFD screen.
Verify the correct layout on the MFD screen after producing the image.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
22 of 30
| Kyocera Embedded Manual
2015-11-27
6.2.2 Colors
The header colors are defined in the MFD’s Advanced Config, see section 6.1. The options to change
are:
•
•
ext-device.kyocera-mita.header.color – the background color (type DEFAULT for the default)
ext-device.kyocera-mita.header.textcolor – the text color (type DEFAULT for the default)
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.
6.3 Swipe card readers
Supporting card reader authentication is as easy as:
1. Connecting a supported card reader to the MFD via the USB port. For a list of supported
card readers, see section 9.
NOTE: On some MFDs the USB port is hidden under a sticker on the side panel.
2. Enabling Swipe card as an Authentication method in the MFD’s configuration in the PaperCut
administration web interface.
3. Ensuring 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).
Swipe cards contain numbers used to identify users according to the card number configured under
“Card/Identity Numbers” on each user’s “User Details” page of the PaperCut administration web
interface. Some readers report information in addition to the number encoded on the card, such as
checksums. PaperCut can treat these cases in three ways:
•
•
•
no conversion required
regular expression filter
format conversion
6.3.1 No conversion required
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.
6.3.2 Regular expression filter
For some cases, a regular expression (regex) that will filter the card number from the complete
string of characters reported by the card reader might be required. You can find more information
about regexes on the Internet, for example, www.regular-expressions.info.
The regex must be fashioned so that the card number is returned as the first match group.
Usually one regex is used for all the devices managed by PaperCut. To enter this, select “Options”,
then “Config editor (advanced)” under “Actions”. The key is called “ext-device.card-no-regex”.
You can, however, override the global setting on a per-device basis using the “ext-device.card-noregex” key on the “Advanced Config” tab of the “Device Details” page. This setting overrides the
global setting unless the keyword “GLOBAL” is specified.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
23 of 30
| Kyocera Embedded Manual
2015-11-27
PaperCut 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 regexes, 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 equal signs in “123453=292929=1221”:
\d*=(\d*)=\d*
6.3.3 Format conversion
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 – you can change the number format 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, you can define the convertors in the PaperCut administration web interface either
globally (for all devices) or on a per-device basis.
To set globally:
1.
2.
3.
On the “Options” page, click “Config Editor (advanced)”.
Search for “ext-device.card-no-converter”.
Enter the name of the required converter (see the table below) then click “Update”.
To set at the device level:
1.
2.
3.
Go to the “Advanced Config” tab of the “Device Details” page for the device.
Search for “ext-device.card-no-converter”.
Enter the name of the required converter (see the table below) then click “Update”.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
24 of 30
| Kyocera Embedded Manual
2015-11-27
6.3.3.1 Standard Converters
The following table lists the converters available.
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 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>
Define a custom conversion function in JavaScript (see section 6.3.3.2).
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.
6.3.3.2 Using custom JavaScript
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:
1. Create a file text file [install-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
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
25 of 30
| Kyocera Embedded Manual
2015-11-27
6.3.3.3 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 third-party system to decrypt the number. PaperCut includes
an advanced plugin architecture that the PaperCut Software development team uses to implement
these advanced converters. Please contact support to discuss development options and costs.
6.4 Release-only expedited workflow
NOTE: This workflow is not available when using integrated scanning.
In environments where all or most users do not use account selection (for instance in larger
corporate environments where PaperCut is used purely for monitoring purposes), the following
settings result in an expedited workflow that requires fewer key presses to access all essential
functions:
•
•
•
In the PaperCut administration web interface, on the MFD’s “Device Details” page, untick
“Show account confirmation”.
In the PaperCut administration web interface, on the MFD’s “Advanced Config” tab, set “extdevice.kyocera-mita.login.show-release” to ‘N’.
On the MFD itself, in the System Menu, select Common, select “Default Application” and
choose PaperCut as the default application.
This will result in the following workflow:
•
•
•
•
The user logs in at the MFD.
The user can directly switch to Copy/Send/Fax/Document Box functions by pressing the
corresponding button on the left of the panel.
The user can display print release by pressing the Application button on the panel.
The user logs out using the Logout button.
Users that do have account selection enabled for them will see an additional account selection step
on login that will display even when they only log in to release prints. For this reason the above
configuration is only recommended in “release only” or “silent tracking” scenarios where users’
activity is automatically logged to their personal or a shared accounts.
6.5 Strict zero-stop copying
When the MFD has been configured for standard zero-stop copying, it is possible for a restricted
user’s copy job to not be halted immediately upon their balance reaching a value that is less than the
cost of the next page. Due to the pipelined processing of pages, a job can continue for a number of
pages that is dependent on the speed of the copier, resulting in a negative balance for the user.
To provide further control in this scenario, additional limit checking functionality can be enabled via
the MFD’s “Config Editor” in the PaperCut administration web interface. The configuration option
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
26 of 30
| Kyocera Embedded Manual
2015-11-27
labeled “ext-device.kyocera-mita.limit.strict” will need to be set to ‘Y’ to activate this option. Please
see section 5.1 for more details regarding how to change a configuration option in the Config Editor.
This option will set PaperCut to estimate the cost of a print job, and decide ahead of time whether
the user should be allowed to copy the job based on their current balance. This estimation is based
on configurable assumptions regarding paper size, color/grayscale status and simplex/duplex status,
irrespective of these actual attributes for the copy job. The following configuration options control
these assumptions:
•
•
•
ext-device.kyocera-mita.limit-reference.paper-size
ext-device.kyocera-mita.limit-reference.grayscale
ext-device.kyocera-mita.limit-reference.duplex
The precise values that these are configured to is dependent on the priorities of the organization,
however included below are two example configurations that may be useful to work from.
6.5.1 “Balanced” configuration
•
•
•
ext-device.kyocera-mita.limit-reference.paper-size = A3
ext-device.kyocera-mita.limit-reference.grayscale = N
ext-device.kyocera-mita.limit-reference.duplex = N
When configured as above for a copier’s most costly values, PaperCut will generate a generous cost
estimate. The result is the chance of a cost over-run and negative balance for the user becomes nil,
however you may also encounter circumstances where copy jobs with cheaper attributes, such as a
grayscale, duplex copy on A5, are stopped a number of pages before the user’s balance would have
been depleted.
6.5.2 “Aggressive” configuration
•
•
•
ext-device.kyocera-mita.limit-reference.paper-size = A4
ext-device.kyocera-mita.limit-reference.grayscale = Y
ext-device.kyocera-mita.limit-reference.duplex = Y
Under this configuration, copy jobs with more costly options may not halt before the user’s balance
becomes negative. Even so, the standard zero-stop limit will apply once the job hits those bounds as
this functionality is in addition to, rather than replacing, the standard zero-stop checks.
6.6 Scanning to searchable PDF
Scanning to searchable PDF requires the optional Scan Extension Kit to be installed on the MFD.
Once installed, any PDF created when using integrated scanning will be searchable as long as the
scanned text is in the correct orientation.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
27 of 30
| Kyocera Embedded Manual
2015-11-27
7 Known limitations and security
Kyocera MFDs have some limitations that have an impact on functionality and security.
7.1 Zero-stop when copying
See section 6.5 about shortcomings of zero-stop when copying and configuration options to alleviate
these shortcomings.
7.2 Job restrictions on restricted accounts
Users are prevented from logging in with a restricted account (user account or shared account) if
another job charged to the same account is still in progress. Jobs in progress can be viewed using the
“Status/Job cancel” button on the MFD panel. Once the previous job has finished, users can log in
again and charge to the restricted account. This behavior can be overridden using the “extdevice.kyocera-mita.restricted.allow-multiple-txn” configuration key (see section 6.1).
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
28 of 30
| Kyocera Embedded Manual
2015-11-27
8 Troubleshooting and frequently asked
questions
What is the IP address of my PaperCut Server?
Use operating system command-line tools such as ipconfig or ifconfig to determine this.
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.
I’ve just moved from “Job Accounting” inbuilt to the copier and I’m having issues.
Leaving “Job Accounting” active on the copier can cause print jobs to go missing, prevent logins and
conflict with tracking of jobs. Double-check that that the functionality has been turned off on the
copier.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
29 of 30
| Kyocera Embedded Manual
2015-11-27
9 Appendix: Supported authentication card
readers
The PaperCut embedded solution for Kyocera MFDs currently supports the following card reader
manufacturers:
•
•
•
RF IDeas (USB), tested using RDR-6081AKU and MS3-00M1AKU but may support others
Elatec (USB), tested using TWN3 Mifare USB but may support others
SCM (USB), tested using SCL010 and SCL011
NOTE: The Kyocera Card Authentication Kit is required – this is an optional component that will have
to be purchased separately.
Other keyboard emulating USB card readers may work, but should be tested prior to deployment.
Please contact your Kyocera dealer for assistance.
Copyright © 2010-2015 PaperCut Software International Pty. Ltd., All Rights Reserved.
30 of 30
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement