56
Kofax Equitrac Embedded for Canon MEAP Setup Guide Version: 2.0.17 Date: 2019-04-30

Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

  • Upload
    others

  • View
    5

  • Download
    2

Embed Size (px)

Citation preview

Page 1: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

Kofax EquitracEmbedded for Canon MEAP Setup GuideVersion: 2.0.17

Date: 2019-04-30

Page 2: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

2

Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide Document History

© 2019 Kofax. All rights reserved.

Kofax is a trademark of Kofax, Inc., registered in the U.S. and/or other countries. All other trademarks are the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in any form without the prior written permission of Kofax.

Symbols Used In This Guide

The following symbols are used in the margins of this guide:

Revision Date Revision List

April 30, 2019 Updated for Canon software version 2.0.17, Equitrac 6.0 and Kofax Branding

November 28, 2018 Updated for Canon software version 2.0.16

June 14, 2018 Updated for Canon software version 2.0.15

March 4, 2018 Updated for Canon software version 2.0.14

October 28, 2016 Updated for Canon software version 2.0.12

February 29, 2016 Updated for Canon software version 2.0.9

October 30, 2014 Updated for Canon software version 2.0.8

November, 2013 Updated for Canon software version 2.0.7

August, 2013 Updated for Canon software version 2.0.6

December 18, 2012 Updated for Canon software version 2.0.5

June 10, 2011 Updated for Canon software version 2.0.2

July 5, 2010 Updated for software version 2.0.1

April 20, 2010 Initial document release

Note The accompanying text provides cross-reference links, tips, or general information that can add to your understanding of the topic.

Caution The accompanying text provides key information about a step or action that might produce unexpected results if not followed precisely.

Warning Read the accompanying text carefully. This text can help you avoid making errors that might negatively affect program behavior.

Page 3: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

3

Contents

1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Supported MFPs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6USB Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Installation Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

2 Pre-Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Additional Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Pre-Installation Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Planning the Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Licensing the Embedded Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Downloading the Embedded Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

3 Embedded Application Install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Machine Status During Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Performing an Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Verifying the Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Uninstalling an existing installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

4 Server-Side Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Configuring the Embedded Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Configure Embedded Device Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Configuring Authentication Prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Configuring Card Self-Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Configuring Follow-You Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Enabling Release Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

5 User Workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Using the Card Reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Logging in with a Magnetic Stripe Card . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Logging in with a Proximity Card . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Logging with Campus Card . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Page 4: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

4

Registering Swipe Cards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Using the MFP Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Using Follow-You Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Setting Print Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Using Multi-Server Follow-You Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Accessing the Device Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

6 Administrator Reference Material . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Canon System Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Offline Mode and the Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Administrator Tracking and Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Normal Users and Departmental Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Transactions, Power Failure and Offline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Behavioral Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Configure the Equitrac Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

7 Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Obtaining Equitrac Embedded Installer Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Obtaining Device Application Logs from the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Obtaining Device Application Logs from the Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

8 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Appendix A: Third-Party Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Page 5: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

5

Introduction

Product OverviewThis product is an embedded application for select Canon MEAP iR-ADV devices. It provides a custom front panel user interface for authenticated user access to the device—for job control and tracking, and Follow-You Printing. The product works in conjunction with an Equitrac server.

Features for user access include:

• Authentication against the Equitrac Core Accounting Server (CAS)• Support for Primary, Secondary and Alternate PINs• Server-based licensing• Offline support• Separate user and administrator login privileges• USB card reader support for identification and authentication• Full USB keyboard support for workflows at the MFP

Features for job control and tracking include:

• Copy tracking, with account limit enforcement through Copy Stop• Scan tracking, with account limit enforcement at login• Fax tracking (incoming and outgoing) with account limit enforcement at login on outgoing faxes• Power failure protection for billing integrity

Features for Follow-You Printing

• Secure Document Release (SDR) with authenticated login• Full multi-server Follow-You print release from multiple Equitrac print servers• Release key • Force Monochrome• Print and Save• Set number of copies to print

Once Equitrac Embedded for Canon MEAP is installed on the device—and properly licensed and configured—the application fully secures the console login on the device. The web interface is secured with user ID and password logins. Authenticating the user allows the embedded application to report user job activity to the CAS server, and facilitate access to the Secure Document Release application.

Page 6: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

6

Supported MFPsFor a list of Equitrac Embedded for Canon MEAP supported MFP models, visit https://kofaximaging.custhelp.com/app/imaging/supported_devices/.

NOTE: This release of the Equitrac Embedded application only supports MEAP 4.x (iR-ADV) devices, and does not support MEAP 1.x, 2.x or 3.x (iR) devices. There is another version of the embedded application that supports 2.x and 3.x (iR) devices. 1.x devices are not supported by any version of Equitrac software.

USB AvailabilityFull USB keyboard support at the device allowing users to navigate through all of the workflows exclusively on a USB attached keyboard. This support is in addition to the existing touchscreen and hard key functionality.

Not all Canon MEAP devices support USB card readers. Please contact your local Canon Sales Representative for more information.

Installation OverviewThe embedded application is part of an integrated enterprise solution. A proper installation involves more than placing a binary on a file system. All the parts in the integrated solution must be properly addressed to provide a complete installation.

ScopeThe installation chapters focus on the steps required to add the embedded application into an existing enterprise solution. They do not outline how to setup and install the enterprise solution itself.

The installation chapters do not cover the following:

• Initial server setup, installation or configuration. However, server setup and configuration relevant to the embedded application is included or referenced.

• Initial MFP setup or installation.

• Any network setup or configuration.

NOTE: While installation and configuration of Equitrac is beyond the scope of this document, the software must be installed and configured before installing Equitrac.

Page 7: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

7

Pre-InstallationPre-installation involves steps that you can take in preparation before installing the Equitrac Embedded application. All the MFP device and the server pre-installation (except the printer ports) can be done before the devices are delivered to their destination. Planning is a key component of pre-installation.

Additional DocumentationIn addition to this guide, ensure that you have any documentation related to your Equitrac product and for your MFPs. These documents are located in https://docshield.kofax.com/Portal/Products/en_US/ControlSuite/1.0.0-mj6ng2jazq/ControlSuite.htm.

PrerequisitesBefore you begin the installation:

• Ensure you have met the system requirements for your multi-functional products (MFP) and Equitrac installation.

• Obtain the IP address or DNS name for the Equitrac Device Control Engine (DCE) server.

• Install or upgrade your Equitrac server applications or database.

• Ensure Java software version 1.4 or higher is installed on the system you are installing the Embedded application.

• Open the appropriate firewall settings. To enable communication between the MFP and the server, copier access to the server requires port 2939. To enable remote installation on copiers, open ports 8000 and 8443.

• If eCopy is installed on the device, uninstall the application. It can later be reinstalled after installing the Equitrac Embedded application. Equitrac recommends upgrading to the latest version of eCopy before reinstalling it.

• Confirm MFP administrator authentication credentials (Equitrac Web System Manager ID, system password, and SMS password)

NOTE: To install and configure the Equitrac embedded and server components, you must have administrative access (including valid Windows network credentials with assigned administrative rights) to the network machine hosting the web service, and to the machine hosting the Equitrac server components. Your Canon technician will provide the default administrative credentials for the device.

Guide When to refer to this guide

Kofax Equitrac Planning Guide Before installing Equitrac, use this guide to select the appropriate combination of product variables to support the needs of your institution or organization.

Kofax ControlSuite Installation Help file Use this guide to perform an initial installation or upgrade.

Kofax Equitrac Administration Help file After installing Equitrac, use this guide to configure advanced options for use on your campus or in your organization.

Page 8: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

8

Pre-Installation WorkflowThe installation process for the Equitrac Embedded for Canon MEAP follows this general workflow:

1 Verify or upgrade the MFP firmware. Contact your local Canon service technician.

2 Obtain and install the necessary Canon MEAP licenses on the Equitrac server.

3 Download the Equitrac Embedded installation file for Canon MEAP from Partner Portal..

Planning the DeploymentBefore you use the Equitrac Embedded Installer to deploy the Equitrac Embedded software, it is recommended that you develop a deployment plan.

1 Identify the IP address of each MFP device.

2 Identify the address of the host server on which each DCE service is running.

3 If there are multiple DCEs, identify which devices are assigned to each DCE.

Licensing the Embedded ApplicationTo license your Canon MEAP embedded application, do the following:

1 Open the LAN file that was included with the application JAR file and record the License Access Number (LAN).

2 Record and add the serial number for each Canon MFP you want to license in a comma separated (CSV) file.

3 Open a web browser and navigate to the Canon License Management System (http://www.canon.com/meap).

4 Enter the License Access Number and click Next.

Page 9: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

9

5 Verify the information and click Apply to Issue a License.

6 Select the method of registration:

• Enter Device Serial Number to manually enter the serial number for each device up to 10 devices.

—Or—

• Batch Register Several Device Serial Numbers Using a File to use the CSV file when registering more than 11 devices. Up to 1000 devices can be registered at once with the CSV file.

When using batch registration, click Choose File navigate to the CSV file on your local machine.

7 Click Next and follow the rest of the steps until a license (.lic) file is downloaded.

8 Open a web browser and enter http://<MFP IP>:8000/sms in the Address field.

Page 10: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

10

9 Login using the SMS password.

10 On the System Management Services page, navigate to System Management > Enhanced System Application Management.

11 In the Install Enhanced System Application/License section, click Browse to locate the path to the embedded application file.

12 Click Browse to locate the path to the matching license file.

13 Click Install.

Downloading the Embedded Application Before you run the Equitrac Installer, you must download the embedded software zip file.

WARNING: Do NOT extract the contents of the zip file.

Equitrac Partners

If you are an Equitrac Partner, you can access the software on the Partner Portal website.

1 Open a web browser, and enter http://partners.equitrac.com in the address field.

2 Login to the site with your user credentials (User Name and Password).

3 Navigate to TECH SUPPORT > Software Downloads > Equitrac, and follow the links to access the current release of the Equitrac software.

4 Select the Appropriate Canon MEAP solution for your MFP.

5 Save the software zip file into a folder on your network drive or local machine. Note where you have placed it so you can find it later. Do NOT unzip the file.

Customers

Contact the Customer Support Center to obtain the URL to the Equitrac download page. Once you have the URL, do the following:

1 Open a web browser, and enter the provided URL in the address field.

2 Click the Documentation and Software Download page link.

3 Scroll to the bottom of the page, and under Equitrac Embedded for Equitrac click the appropriate Canon MEAP solution for your MFP. The software downloads.

4 Save the software zip file into a folder on your network drive or local machine. Note where you have placed it so you can find it later. Do NOT unzip the file.

Page 11: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

11

Embedded Application InstallThis chapter discusses how to install the Equitrac Embedded for Canon MEAP application. This is a manual process that must be accomplished per individual MFP by a system administrator.

This guide assumes that you are installing the Equitrac products (servers and embedded solutions) in a Windows network environment.

You need to use a web browser to complete the installation. Equitrac recommends using Internet Explorer 7.0 (or higher) or Mozilla Firefox 3.1 (or higher) with the pop-up blocker disabled.

NOTE: Ensure that the Enable Department ID Management option is selected in your Department ID Management Settings. The Equitrac Embedded for Canon MEAP software then requires a System Manager ID and Department ID to be set, and the password to be configured for each.

Machine Status During InstallationThe Canon device needs to be considered “out of production” for the installation process. Failure to take the device out of production may result in failed installation and/or termination of user jobs. Due to device reboots during installation, user activity on the device will be negatively impacted. There is also the possibility that user interaction during installation may cause the device to appear to crash.

The network needs to remain intact since the install process is executed through the network. We recommend that installation be executed during off hours, or that users be notified that the device is out of production during the installation period.

Printing should be avoided during the installation process. Printing will not negatively impact the installation, but the print job may be prematurely terminated upon device reboot. It is recommended that you pause the printers on the print server during installation. Resume the printers before executing tests.

Performing an InstallationThe following procedure assumes a clean installation, wherein the application is being installed on the MFP for the first time. If you are reinstalling the application, see Uninstalling an existing installation on page 15 before proceeding. To install the Equitrac Embedded application, do the following:

1 Open a web browser, and enter the IP address of the MFP to which you will install the application. The device Remote UI Portal opens.

Page 12: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

12

NOTE: For these instructions, a Canon iR-ADV C255 device was used. Other models of MFP may display slightly different screens.

2 From the right menu options, under Management Tools, select Service Management Service. The Service Management Service screen displays.

3 From the left menu pane, under System Management, select Enhanced System Application Management. The Enhanced System Application Management screen displays in the right pane.

4 Add the Equitrac login Application to the list of installed applications, and license the application:

a Under Install Enhanced System Application/License subheading, locate the field for Enhanced System Application File Path, then click Browse...

Page 13: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

13

b Navigate to the file location where you have saved the application file. If you have not acquired the file, see Downloading the Embedded Application on page 10.

c Select the application .jar file, and click Open. the file path and name populate into the Enhanced System Application File Path field.

d Again under Install Enhanced System Application/License subheading, locate the field for License File Path, then click Browse...

e Navigate to the location where you saved the Canon license file.

f Select the license .lic file, and click Open. the file path and name populate into the License File Path field.

g Under Operation to Perform, ensure the Install and Start or Enable radio button is selected.

h Click the Install button. A dialog displays listing information about the install process about to be performed. Ensure the information is correct, then click Yes.

The display returns to the Enhanced System Application Management screen, where there should now be an Equitrac Login Application entry in the list of application names, with a status of Start after Restart:

NOTE: If the status of the Equitrac Login Application is not Start after Restart, click the Switch button until Start after Restart displays.

5 Click the To Portal link at the top of the screen to return to the device Remote UI Portal.

6 From the right menu options, select Settings/Registration. the Settings/Registration dialog displays.

7 From the left menu options, select Restart Device. The Restart Main Unit dialog displays.

8 Select Perform Restart. A dialog box displays, warning you that the main unit will be restarted, and all processes canceled. Click OK. Wait for the system to restart.

9 Open a web browser and enter http://xxx.xxx.xxx.xxx:8000/Equitrac/Config, where the x’s indicate the IP address of the MFP to which you have installed the software. An Equitrac Login screen displays, with the message that initial server contact has not been made.

10 In the Password field, enter equitrac then click Login. A Login Configuration screen displays.

11 In the Password field, enter equitrac then click Login. The configuration options display.

12 Set Login Configuration options:

a Under Server Configuration, in the IP/Domain field, enter the IP address of the server.

Page 14: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

14

b Under Change System IDs and Passwords, enter appropriate values for the System Manger ID and System Manager Password fields, clicking each field’s respective Update button to confirm the change. Note these values to be able to login later.

c Click the section Update button.

Verifying the InstallationAfter installing the embedded application, make a copy at the device and verify that a transaction was successfully recorded in the server database.

1 Log in to the device either by manually entering your user credentials on the front panel, or by swiping your card on the attached card reader. See User Workflows on page 22 for details on login options.

2 Press the Login & Access Functions button to open the Canon device functions Main Menu.

3 Press the Copy icon on the Main Menu screen to access the copy function.

4 Make a copy. A basic letter-sized, single page copy is sufficient to verify a transaction.

5 Press the Log Out button to end the user session.

6 On the server, select Start > All Programs > Equitrac > Reports Manager.

7 Select the Detailed activity by device report.

8 Click OK to maintain the Select report criteria default values and generate the report. The report displays the details of the transaction, such as device IP address, user, and number of pages.

9 Verify the details of the report against the copy executed in step 3.

The successful generation of this report indicates that the Equitrac Embedded for Canon MEAP application is correctly installed on the device.

Page 15: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

15

Uninstalling an existing installationBefore installing a new version of the application, the old version must first be removed. Follow these steps:

1 Open a web browser, and enter the IP address of the MFP to which you will reinstall the application. The device Remote UI Portal opens.

NOTE: For these instructions, a Canon iR-ADV C255 device was used. Other models of MFP may display slightly different screens.

2 From the right menu options, under Management Tools, select Service Management Service. The Service Management Service screen displays.

3 From the left menu pane, under System Management, select Enhanced System Application Management. The Enhanced System Application Management screen displays in the right pane.

4 From the list of applications, in the User Authentication row, click the Switch button to change the authentication method back to the native device.

5 Click the To Portal link at the top of the screen to return to the device Remote UI Portal.

6 From the right menu options, select Settings/Registration. the Settings/Registration dialog displays.

Page 16: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

16

7 From the left menu options, select Restart Device. The Restart Main Unit dialog displays.

8 Select Perform Restart. A dialog box displays, warning you that the main unit will be restarted, and all processes canceled. Click OK. Wait for the system to restart.

9 Open a web browser, and enter the IP address of the MFP you are working with. The Canon Log In screen displays:

10 Enter Administrator and 7654321 respectively in the User Name and Password fields, then click the Log In button. The Change Password screen displays:

11 Click the Cancel button, then click the To Portal link at the top of the screen to return to the device Remote UI Portal.

12 From the right menu options, under Management Tools, select Service Management Service. The Service Management Service screen displays.

13 From the left menu pane, under System Management, select Enhanced System Application Management. The Enhanced System Application Management screen displays in the right pane:

14 In the row for Equitrac Login Application, click the Uninstall button.

The Application is removed from the list of installed applications. You can now proceed with installing a new version of the application using the process outlined in Performing an Installation on page 11.

Page 17: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

17

Server-Side ConfigurationThere are two levels of configuration required to enable the Equitrac Embedded application features on your Canon MFP; configuration at the MFP itself and on the Equitrac server.

Server-side configuration involves specifying whether you want print release only, copy control only, or both print release and copy control.

This chapter includes instructions for configuring the Equitrac server for the embedded application. This workflow assumes you have already registered the physical device in Web System Manager and, if necessary, enabled secure printing at the print queue level, as detailed in the Kofax Equitrac Administration Help file.

Configuring the Embedded DeviceWeb System Manager automatically creates Equitrac Embedded devices once the embedded application installed on the MFP communicates with DCE—assuming you have already configured the MFP with the location of DCE and have available licenses. If Web System Manager was open during the embedded installation, click Refresh to update the list of devices.

The DCE provides license confirmation to the device, as well as passes the device information to Web System Manager. After a successful connection and licensing approval, the embedded device appears in the Web System Manager > Devices listing.

CAUTION: There is no method for manually adding the embedded device. It is auto-created as long as an embedded license was available during the setup of the MFP in the previous chapters. If a license was not available, you must press the Reset key on the MFP and it will then appear in Web System Manager.

Configure Embedded Device SettingsThe embedded device configuration includes enabling secure document release (SDR) and release behavior, as well as copy, scan, and fax tracking on a per-device basis.

To configure how each Canon MEAP device is controlled by Equitrac, do the following:

1 In Devices, select Physical Devices and select a physical device from the list. Select Add Embedded Device from Select Action drop-down list.

2 In the Definition section, select Canon MEAP from the Type drop-down list.

3 Enter a Name for the embedded device. This is a required field, and an error message appears prompting to specify a device name if you click OK without naming the device.

4 Enter a Description for the embedded device.

5 The DCE server defaults to the current DCE host. Change the server, if necessary, by selecting another server from the list

6 Select the Server hosting the DCE associated with this physical and embedded device from the drop-down list.

7 Enter the Serial number for the device. This must match the serial number as shown on the MFP itself.

Page 18: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

18

8 The Version field is populated automatically once communication is enabled.

9 In the Behavior section, choose how you want to track activities at the device. By default, the global settings are used, but you can Override default tracking options for print, copy, scan and fax.

10 From the Secure document release drop-down list, select how documents are released from the embedded device.

• Prompt allows users to release documents through the regular configured workflows. Deselecting this releases documents automatically when the user logs in to the device.

• Release all at login automatically releases all documents in the queue at login. This does not automatically log the user out.

11 If you have defined Rule sets in System Manager, select one from the drop-down list to apply to this embedded device. For more information on creating rule sets, see the Kofax Equitrac Administration Help file.

12 Select a Prompt for billing code option from the drop-down list. These options allow you to configure billing codes on a per device level. For more information on globally configuring billing code prompts, see the Kofax Equitrac Administration Help file.

• Default – This option uses the global billing code settings configured in Equitrac System Manager.

• Enabled – This option prompts the user for a billing code even if billing code prompts are not enabled globally.

• Disabled – This option disables the billing code prompts even if they are enabled globally.

13 Click Pricing to configure pricing at the controller interface level. You should apply a default price list or a price list for each applicable function on the MFP.

For details on configuring price lists, see the Kofax Equitrac Administration Help file.

To configure the Equitrac Embedded application to use the price list for the associated device, select the default price list. If you select an alternate price list for the Equitrac Embedded application, the alternate price list overrides the device setting.

14 Click Advanced to select the Card Reader HID decoding from the drop-down list.

For details on HID decoding, see the Kofax Equitrac Administration Help file.

15 Determine the type of Offline access users will have when the device cannot connect to the DCE.

• None: This option denies all normal user access to the device. System administrators can still access the System Administration functions.

• Cached only: With this option, only users who have previously logged into this device can access the device using their cached login credentials and any cached billing values.

• Allow all: This option permits any user credentials for login and many billing values for access to device features. If a user had previously logged in while the device was online, the user receives the standard billing prompts as configured in Equitrac.

16 Click Save to save your configuration changes.

NOTE: Whenever changes are made to server-side settings, press the Reset key on the MFP front panel to ensure that the embedded application re-initializes and retrieves the new settings from the server.

Page 19: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

19

Configuring Authentication PromptsThe user authentication prompts on the MFP login screen are determined by the Equitrac configuration.

1 Open Web System Manager, and navigate to System Configuration > Global Configuration Settings > Configuration > Security and Authentication > User authentication.

2 Select one or more Authentication mechanisms:

• Equitrac PINs – Select to connect an Equitrac print account with login information.

• External user ID and password – Select to verify all user information outside of Equitrac.

• Equitrac PIN with external password – Select if users swipe their cards for identification, and must also enter their domain user account password. Equitrac cross-checks the database for the corresponding Equitrac account name, then verifies the credentials against the selected external authority for network logon.

3 Select Store secondary PIN encrypted if you want the secondary PIN to be encrypted.

4 Select one of the following User Input options from the Input type drop-down list:

• Card swipe only – Users authenticate with a swipe card.

• Card swipe or keypad entry – Users authenticate with a swipe card or at the MFP front panel.

• Keypad only – Users authenticate at the MFP front panel

5 Select one of the following options from the Secondary prompt drop-down list:

• Always – If the user has a PIN2 configured, it must be entered via the keyboard after they swipe their card.

• If PIN2 available – This option does not apply to Canon MEAP devices. If selected, this behaves as the Always option.

• If PIN2 available or keyboard login – This option does not apply to Canon MEAP devices. If selected, this behaves as the Always option.

• Never – Secondary PIN is not required.

• Only with keyboard login – User must enter a secondary PIN if they entered their primary PIN via the keyboard (rather than with a swipe card). This option prevents users from typing in someone else’s primary PIN while still allowing valid users to login without a card.

NOTE: If a change is made to the Prompt for secondary PIN option, then you must re-initialize the device in order to enable the new selection.

6 Select the Auto-register primary PINs checkbox if you want users to self-register their swipe cards. Optionally, you can select Register as alternate PIN to record the PIN as the Alternate PIN instead of the Primary PIN. See Configuring Follow-You Printing on page 21 for details.

7 In the Card setup area, enter the data From position and To position in the Use Data as Primary PIN.

8 Click Save to save the changes.

For more details on configuring user authentication options refer to Accounts System Configuration in the Kofax Equitrac Administration Help file.

Page 20: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

20

Configuring Card Self-RegistrationIf you want users to self-register their swipe cards, you must enable this option in Web System Manager. When a user swipes an unregistered card for the first time at an MFP, they are required to login with valid User ID and Password. The User ID must already exist in CAS, or in the External authority defined to allow self-registration. The Password comes from one of the defined external authorities.

1 Open Web System Manager, and navigate to System Configuration > Global Configuration Settings > Configuration > Security and Authentication > User authentication.

2 Select one or more Authentication mechanisms:

• Equitrac PINs – Select to connect an Equitrac print account with login information.

• External user ID and password – Select to verify all user information outside of Equitrac.

• Equitrac PIN with external password – Select if users swipe their cards for identification, and must also enter their domain user account password. Equitrac cross-checks the database for the corresponding Equitrac account name, then verifies the credentials against the selected external authority for network logon.

3 Depending upon your setup, select Card swipe only or Card swipe or keypad entry from the Input type drop-down list.

4 Select Always or Only with keyboard login from the Secondary prompt drop-down list. The If PIN2 available and If PIN2 available or keyboard login options are not supported by Canon MEAP devices, and will function as Always if selected.

5 Select the Auto-register primary PINs checkbox.

6 Click Save to save the changes and return to the Global Configuration Settings page.

7 Navigate to Configuration > Security and Authentication > External Authentication and select an External authority – Windows or LDAP.

Refer to External User Authentication in the Kofax Equitrac Administration Help file for more details on setting up an external user authentication method.

The next time the user swipes the card, their account information is automatically associated with the card, and they can login without manually entering their user credentials. However, if Secondary prompt is set to Always in Web System Manager, and secondary PINs are set as required or the user has a secondary PIN stored in their profile, the user must enter the PIN or an external authority password after they swipe their card.

Page 21: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

21

Configuring Follow-You PrintingFollow-You Printing extends the basic functionality of secure printing by allowing a user to release a print job to other compatible devices in the organization. Even if you deployed multiple DRE print servers—each of which manages a separate set of devices—you can configure Equitrac to allow printing across multiple print servers.

For example, a user who works in two different buildings can submit a print job from their computer in Building A, and while on the way to a meeting in Building B, they can walk up to any predefined MFP (with the embedded application installed on it) and "pull" the job to the device which then prints the job.

If you want to deploy the Equitrac Embedded application in a single-server or a multi-server Follow-You Printing environment, do the following:

1 Enable secure printing on each MFP.

Secure printing enables the Equitrac print queue that holds jobs until they are released at the embedded device by a valid user.

2 Create and manage Pull groups.

To allow users to release print jobs to multiple compatible devices with the Equitrac Embedded application, you must create Pull groups, then add each physical device to a Pull group.

3 Configure the Follow-You print settings.

Determine the site where you want Follow-You Printing to be accessible from, and choose whether the print job is priced based on its properties before or after it is released.

NOTE: See the Advanced Printing Configuration chapter in the Kofax Equitrac Administration Help file for details on configuring secure printing, Follow-You Printing, and pull groups.

Enabling Release KeysRelease key is an Equitrac feature that lets users assign a key value to their documents when they submit print requests. Users can also assign a release key to a print job allowing other users to walk up to any embedded device, and print any jobs in the queue that were submitted using that release key. The job is tracked and charged to the user releasing the job, not the user who assigned the release key.

When prompted for a release key at an embedded device, users are required to enter the same alpha-numeric key value used at print time to release a job from the secure print queue.

To enable release key prompts on the embedded device, do the following:

1 Open Web System Manager, and navigate to System Configuration > Global Configuration Settings > Configuration > User Interaction > Session flow.

2 Select Prompt for release key in the Other prompts section if release keys are to be enabled.

3 Click Apply to save the setting.

Page 22: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

22

User WorkflowsThis chapter describes the workflow for users who want to access the available Equitrac Embedded features on the MFP device, including:

• Secure Document Release (SDR)

• Copying

• Scanning

• Sending or receiving faxes

• Other device functions

There are two ways to log in: using a USB card reader, and/or manually entering user credentials on the device. When completing login, the user has a choice between accessing Follow-You Printing and accessing the device functions. See Using the MFP Device on page 25 for login option details.

Using the Card Reader When the MFP device is configured for swipe card authentication, you can log on using a magnetic stripe card, proximity card, or Campus Card before you can access the device functions. Depending on how Web System Manager is configured, you log in with the swipe card only or with both swipe card and password (Secondary prompt).

Logging in with a Magnetic Stripe CardTo log in at a magnetic stripe card reader, do the following:

1 Swipe the card down through the guide track with the magnetic stripe facing the indicated direction. Ensure the card is pressed firmly against the guide.

NOTE: If the card reader cannot read the entry, run the card through the guide track again. Do not run the card through at an angle or the terminal will not accept the data.

2 If configured for Secondary prompt, enter your password on the login screen.

3 Press Login & Release Print Jobs or Login & Access Functions to start a user session. See Using the MFP Device on page 25 for login option details.

NOTE: If you are unable to log in, you may need to register your card using your Equitrac PINs or Windows username/password. See Registering Swipe Cards on page 24.

Page 23: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

23

Logging in with a Proximity CardTo log in at a proximity card reader, do the following:

1 Pass the card within 1 inch (2.5 cm) of the proximity symbol located on the top of the card reader device. If the swipe is detected, the LED flashes off temporarily.

2 If configured for Secondary prompt, enter your password on the login screen.

3 Press Login & Release Print Jobs or Login & Access Functions to start a user session. See Using the MFP Device on page 25 for login option details.

NOTE: If you are unable to log in, you may need to register your card using your Equitrac PINs or Windows username/password. See Registering Swipe Cards on page 24.

Logging with Campus CardEquitrac supports print and copy payments from a third-party account. Using card readers, users can authorize themselves as valid Campus Card account holders, make copies, release jobs, and pay for these services in real time, directly from their campus card account.

To log in at a card reader, do the following:

1 Swipe the card down through the guide track with the magnetic stripe facing the indicated direction. Ensure the card is pressed firmly against the guide.

NOTE: If the terminal cannot read the entry, run the card through the guide track again. Do not run the card through at an angle or the terminal will not accept the data.

2 Select the desired account if multiple Campus Card accounts with funds are available.

3 Press Login & Release Print Jobs or Login & Access Functions to start a user session. See Using the MFP Device on page 25 for login option details.

NOTE: If you cannot log in with the card swipe, you can manually enter your Primary PIN on the numeric keypad to access your Campus Card accounts.

Card Reader Status MessagesThe embedded application indicates swipes through an LED light on the card reader module.

The following signals may be displayed on the card reader:

LED Behavior Meaning

Solid LED Card reader is connected to the MFP and is receiving power

No LED Card reader is not connected to the MFP or is not receiving power

Flashes off Card swipe detected

Page 24: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

24

Registering Swipe CardsWhen a user swipes an unregistered card, they are required to login to the device with valid user credentials in order to register their card. The information the user must enter depends upon the authentication options that are set in Web System Manager.

To self-register a user swipe card, do the following:

1 Swipe the magnetic stripe card, proximity card, or Campus Card at the USB card reader attached to the device. The login screen indicates that the card is not recognized, and you need to log in to register the card.

2 Enter your User ID (and Password if Secondary prompt is configured in Web System Manager) using the on-screen soft keyboard, or the hard keys on the MFP front panel.

Touch the keyboard icon beside the entry field to bring up the soft keyboard. Alternatively, you can use a USB keyboard connected directly to the device.

3 Press Login & Release Print Jobs or Login & Access Functions.

The swipe card is registered once the login credentials have been authenticated by CAS. The user can now access Follow-You Printing or access the copy, scan, and fax device functions. See Using the MFP Device on page 25 for login option details.

The next time the user swipes their card they can log in without manually entering their User ID. Depending on how Web System Manager is configured, the user may be prompted for their password.

Page 25: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

25

Using the MFP DeviceA user session begins when the user logs in with valid credentials through the MFP device interface. Once their login credentials have been authenticated by CAS, the user can manage documents with SDR, or access any of the other device features, such as copying, scanning and faxing.

To start a user session, do the following:

1 On the Login screen, swipe your card or manually enter your user credentials using the soft keyboard, or the hard keys on the MFP front panel.

Touch the keyboard icon beside the entry field to bring up the soft keyboard. Alternatively, you can use a USB keyboard connected directly to the device.

2 Depending upon how User Authentication is configured in Equitrac Web System Manager, you may also need to enter your password. See the Kofax Equitrac Administration Help file to configure authentication options.

3 Select the set of functions you want to access:

• Press Login & Release Print Jobs to select and print documents from the secure print queue. Continue to Using Follow-You Printing on page 26.

• Press Login & Access Functions to enable the copy, scan and fax features on the device. Continue to Accessing the Device Functions on page 29.

The * and # hard keys on the MFP front panel can be used to Backspace and Tab (respectively) between editable fields on any of the Equitrac screens. For example, after entering a User ID in its field, press the # key to proceed to the Password field. The tab function does not wrap back to the first field, nor does it work as an “enter” mechanism in the last field on the screen.

The Tab and Backspace keys on a device-connected USB keyboard perform the same functions as the * and # hard keys on the MFP front panel.

Page 26: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

26

Using Follow-You PrintingUsers can use Follow-You Printing to release documents held in the print queue associated with the user’s account from any device within a predefined pull group, which is connected to the particular print server. Multi-Server Follow-You Printing allows users to select any remote print server accessible to the device within a predefined pull group, and pull documents for printing. This is useful if the user has printed documents to different print servers, and wants to print them at the same device.

To release a secure document, do the following;

1 On the Login screen, enter your user credentials or swipe your card.

2 From the Login screen, press Login & Release Print Jobs. The Follow-You Printing screen opens with a list of your documents held in the secure print queue.

3 If Equitrac is configured to prompt for a release key on the device, the Release Key screen opens. Enter the release key and click OK.

The Follow-You Printing screen opens, displaying a list of documents held in the secure print queue for the logged-in user.

Page 27: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

27

4 From the Follow-You Printing screen, you can use the on-screen buttons to perform the following functions.

Setting Print OptionsYou can modify the default print options on a per-job basis, or you can apply these options to enforce “temporary” settings for any print jobs for the duration of a user session. The applied print options are cleared when the user logs off.

To set the print options per selected job, do the following:

1 On the Follow-You Printing screen, select the document(s) from the list you want to print.

2 Press Options to open the Print Options dialog.

3 Select from the following options:

• Number of Copies – sets how many copies of the document to print.

• Force Monochrome – forces a color job to print in black & white.

• Save Print Jobs – keeps the job in the list after printing. By default, a job is deleted from the list after printing.

4 Press Print Now to use these settings for the selected job. The Print Now option releases the job immediately without having to press Print on the Follow-You screen. The settings are temporary for this print job only, and the default settings are restored after printing is complete.

Button Function

Print Select one or more documents in the list, then press the Print button to release the documents and delete them from the list.

Delete Select one or more documents in the list, then press the Delete button to remove the jobs from the queue without printing them, and not be charged.

Select all Selects all the jobs in the document list. When one or more documents are selected, the button changes to Clear all to uncheck the selected documents.

Refresh Checks the DCE server to determine if any new jobs are available, and updates the document list accordingly.

Details Displays the details for the selected document such as, document name, page count, cost, and User ID.

Options Select print options such as, Force Monochrome, Save Print Jobs, and Number of Copies. See Setting Print Options on page 27.

You can apply the selected options to use for any job within the current user session, or on a per-job basis. When the user session ends, the selected options are cleared.

Servers If your configuration supports multi-server Follow-You Printing, you can select documents on other servers and pull them to this device to print. Press the Servers button to display a list of print servers. Select the new server and press the Done button to see a new list of documents. See Using Multi-Server Follow-You Printing on page 28.

End Session

Ends the user session and returns to the login screen.

You can also use the ID key on the device keypad to end the session.

Page 28: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

28

To modify the print options and apply them as the default settings for the duration of a user session, do the following:

1 On the Follow-You Printing screen, press Options to open the Print Options dialog.

2 Select the desired alternate print options.

3 Press Apply to use the selected print options as the default settings for the remainder of the user session. The print option dialog closes.

4 Select one or more documents from the list, and press Print. The modified print options are applied across all released documents. These print options remain the default print settings until the session is ended, or other print options are applied.

Using Multi-Server Follow-You PrintingYour printing environment may be configured with additional print servers that are accessible to users of Canon MEAP devices. With secure print release and multi-server Follow-You Printing, you can select a different remote print server in the predefined pull group other than the default local server, and pull documents from that remote server to the local device.

1 On the Login screen, enter your user credentials, and press Login & Release Print Jobs.

2 On the Follow-You Printing screen, press Servers.

3 In the Servers dialog, select your alternate print server from the list, and press Done.

The Default server is the DRE with which this device is configured. If you have a home server defined, documents associated with your login credentials for this home server will also be listed with documents from the default server.

When selected, the alternate server is queried for documents associated with your login credentials. The list is refreshed with documents from the alternate server. The list no longer shows documents from the default servers.

For details about configuring your printing environment for multi-server Follow-You Printing, see the Advanced Printing Configuration chapter in the Kofax Equitrac Administration Help file.

Page 29: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

29

Accessing the Device Functions To access the copy, scan, or fax device functions, press Login & Access Functions on the Login screen.

Depending on the configuration of your printing environment, one of the following occurs:

• The Canon MEAP device interface displays, and the Equitrac Embedded application unlocks the device keypad for access to copy, scan, and fax functions.

—Or—

• The Billing Details screen displays if billing codes are required.

If billing codes are required, do the following:

1 Enter the Billing Code in the field provided.

a If the billing code you entered is invalid, or you don’t know the code, touch Search (if configured).

NOTE: Search is a configurable option, and only appears on the screen when configured through Web System Manager. The Search button is active only when the Billing Code field is selected on the screen. The Search function is only available when embedded device is connected to the Equitrac server.

Page 30: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

30

b Enter the criteria in the Search for field, then touch Search.

The screen updates with up to the first 100 codes that match your search. Use the Up/Down arrows to browse through billing codes.

NOTE: The billing code search only looks for codes that start with the characters entered in the Search for field. For example, if you enter “acc” as the search criteria, only the billing codes that start with those letters display in the list.

c Select the correct billing code, then touch OK to apply the billing code to the current job and close the Billing Code search screen.

2 If configured, select whether the job is Billable or not.

This option determines if the transaction is billed to a user, group, or department, or if it is only entered into the system for reporting purposes.

3 Touch Next to continue to the Canon MEAP main menu.

The billing code is validated when you touch Next. If you searched for a code and selected it from the list, it is validated immediately, and the description is displayed beside the code field.

NOTE: If an account is configured with only one available billing code to charge against, and billing codes are required, then that code is automatically selected and the Billing Code screen does not appear.

Once the device validates the billing information, the Canon MEAP device interface appears and the Equitrac Embedded application unlocks the device keypad on the front panel for access to copy, scan, and fax functions. You can then conduct your session without needing to interact with the embedded application.

4 Press Log Out to end the user session.

Page 31: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

31

Administrator Reference MaterialThis chapter is for Device Administrators only. It outlines who and what the Administrator is, what they can do, and what distinguishes the administrator from other users.

The Canon MEAP device requires administrative management. For the embedded application to provide the required security, the administrative management can only be done by a person acting with administrative privileges. To acquire these privileges you must authenticate as the Administrator.

If you are unfamiliar with any of the terms in this chapter, please refer to your Canon device documentation.

Canon System ManagerThe Canon framework provides native administrative control of the device. Canon defines this role as System Manager. Before the Equitrac embedded application is installed, the device may be configured so that all users can administer the machine, or it may be configured so that only the System Manager can administer the machine.

For the Equitrac embedded application to provide proper security, System Manager must be enabled before the embedded application is installed. The System Manager is enabled in the Canon framework by assigning a numeric ID and password. Once the System Manager is enabled, normal users will no longer be able to administer the device.

Creation and configuration of the System Manager is handled transparently by the automated installer.

Once the Equitrac embedded application is installed, the System Manager becomes hidden by the login application, but remains fully active in the background. Once the Equitrac application has taken control of the login, the System Manager ID and password no longer work.

The Equitrac embedded application provides its own Administrator. This Administrator always has the Primary PIN or login ID of “Admin” (with an upper case “A”). If a Secondary PIN or password is required, this value is determined in the application configuration page, and defaults to “equitrac” (with a lower case “e”). This administrator is exclusive to the device, and does not have any administrator role outside the MFP, including on the Equitrac servers. The “Admin” login ID is not related to any users on the CAS system. If there is an “Admin” user on CAS, this user will not be able to login to the Canon device.

A person logging in as the Equitrac Embedded Administrator gains all the privileges and functions of the Canon System Manager while maintaining the special role that the Equitrac Administrator has. When the application logs the administrator into the Canon framework, it uses the System Manager credentials from the application configuration. As a result, the Equitrac Administrator is mapped to the Canon System Manager.

Offline Mode and the AdministratorOffline mode occurs when the Equitrac embedded application is not successfully talking to the DCE server. This can happen for a number of reasons, including network failure and lack of server availability. The application is designed to continue to operate in offline mode. The server configuration will dictate if users are allowed to log in when the device is offline. This configuration does not affect the Equitrac Embedded Administrator. The Equitrac Administrator is always allowed to login and access the device.

Page 32: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

32

Administrator Tracking and ValidationWhen the Administrator logs in, there is no corresponding account on the Equitrac CAS server. As such, the data used for billing information is not validated, but is recorded. Any jobs executed by the Administrator will be reported to the server, as the default user with billing information. Executing jobs as Administrator should only be done when no other options are available.

Normal Users and Departmental ManagementAdministrators typically manage normal user accounts. With Equitrac embedded, the normal user accounts reside on the CAS server, and are managed by the server’s administrators.

The only role played by the embedded Administrator with normal user accounts is how they are treated on the Canon device. The user is mapped to a Department ID in the same way as the embedded Administrator is mapped to System Manager. In a typical configuration, all normal Equitrac users are mapped to the same Department ID. This configuration is necessary because Equitrac can have more users defined than the Canon device can have Department IDs. Each time a user is logged in the Department, information is reset to match the account limits of the user. The System Manager should not modify the department configuration.

For users to be properly mapped to the single Department ID, the System Manager must enable Department Management—create a department, and record the ID and password. This must be done before the embedded application in installed. Following installation, the Department ID and password must be assigned in the configuration of the embedded application.

Creation and configuration of the Department is handled by the automated installer.

Failure to properly configure Department Management may result in the login application not allowing logins. On some models, the user can login but the account enforcements will not function. Equitrac cannot support the application if Department Management is not enabled.

For institutions that currently use Department IDs for identification—and cannot quickly migrate from this configuration—there is an alternate ID mapping solution available. However, due to the complexity, custom application, and management required to keep a multi Department ID solution working, support for this configuration is not available. Support will only be available once you have completed migration to a single department model.

If the customer is using PINs on CAS that match Department IDs on the device, the embedded application can be configured to log the user in with the corresponding Department ID. With this configuration, consider the following:

• Ensure there is an exact string match between the PIN and Department ID.

• Ensure to add the departments across each machine where it will be used.

• Avoid adding too many departments to the device.

• Take care when removing accounts.

This configuration should only be used if it is necessary to migrate to the one Department ID model. Mapping of PINs to Department IDs can be enabled by turning on Department Support. Turning off Department Support will provide a complete transition to the single Department ID model.

Page 33: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

33

Transactions, Power Failure and OfflineThe Equitrac server tracks user activity on the device using information sent from the embedded application. At a high level, each time the user logs out, the embedded application polls the MFP for activity completed by the user. For any tracked activity, the application converts the information into a transaction and sends it to the server. At a low level, the process is more complicated. The application must mitigate power loss, network disconnection, and other factors that might impact proper billing.

To maintain proper billing, it is a requirement that the embedded application not loose information about tracked user activity. To mitigate power failure, the embedded application works closely with the Canon MFP device mechanism that tracks job output. The mechanism is protected against loss of information from power failure. The embedded application interacts with the MFP device mechanism at three events:

• Power up. If the power is lost before a job is finished, a complete accounting of the job is recorded in the user’s billing statement once power to the device is restored.

• Logout. All user activity is reported as soon as the user logs out, or the device times out the current login session.

• Regular console timeout events. While the login application is idle, a timeout counter is running. When a timeout occurs, the console is refreshed. In the background the application polls the device for any new activity. This helps deliver transactions for delayed activity, such as retries on outbound faxes, in a timely fashion.

There is a concept known as Transaction Integrity which allows two tasks (on separate systems) to be treated as an atomic function. Basically, either both tasks succeed, or both fail, but not only one. The embedded application maintains transaction integrity between the MFP engine, and the server using a hard drive queue. All transactions are queued to the hard drive first, then queued from the hard drive to the server. This protects against power failure and network disconnection.

To guarantee transaction integrity, the application favors accidental duplicate transactions versus accidental lost transactions. Duplicate billing is avoided by the server, which weeds out duplicate transactions before the billing process starts. The embedded application only considers information from the MFP engine to be consumed after it is known that the transaction is queued on the hard drive. If power is lost after queuing, but before the information is marked consumed, the information will again be converted to a transaction when the MFP reboots. Also, the embedded application only considers a transaction queued from the hard drive after the server has acknowledged the reception of the transaction. If power or network is lost before the server acknowledges the transaction, the transaction will remain queued on the disk. The application will make continued attempts to deliver the transaction until the server acknowledges receipt.

If the MFP remains disconnected from the server for a prolonged period, unbilled transactions may accumulate. To mitigate this risk, the embedded application presents warnings on the front console which advise the administrator that unsent transactions have accumulated. The warnings are presented to all users during the login cycle. The warning is presented in the following cases:

• When the number of accumulated transactions has reached or exceeds 50.

• When the number of days since last successful transaction deliver reaches or exceeds 30 days.

Transactions should not be allowed to accumulate indefinitely. It defeats the purpose of billing, and in extreme cases may eventually fill the hard drive of the MFP.

Page 34: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

34

Behavioral ChangesThe Equitrac embedded application is a Canon login application. Canon login applications are a similar to normal MEAP applications but play very different roles, and are handled by Canon in a very different way. Once any login application is enabled in a Canon device, certain default behaviors and configurations cease to apply. This can cause the appearance that the login application has broken certain device functions which are completely unrelated to the application. This appearance is faulty, and can be relieved by assigning a complete configuration to the Canon MFP for the broken device functions.

A complete accounting for all affected device functions and configurations is beyond the scope of this document. However, Internet related deliveries like scan to email and Fax are the most notably affected device functions. The automated installer adjusts the device configurations to maintain operation of these features after the login application is installed.

Page 35: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

35

Configure the Equitrac ApplicationAfter installation, you can configure the embedded application settings.

1 Enter http://<MFP IP>:8000/Equitrac/Config in the Address field and login when prompted to open the device’s configuration page.

2 In the IP/Domain field, enter the IP address or DNS name of the Equitrac DCE server.

Page 36: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

36

3 In the Add Property File section, click Browse to select any relevant Property Files, such as as a hotfix. Click Upload to import the selected files from their network location to the device. The interface lists any Current Property Files installed on this device.

4 Console Output enables or disables debug logging on the device. If you change this setting, click Update.

5 In the Change System IDs and Passwords section, you can edit the Canon System Manager access and print control settings. Click Update beside any field to apply any new values.

6 In the Change Password fields, you can modify the Admin password. Click Change Password to update the new password.

7 Under Third-Party Application Login ID, enter a User Name to identify an account that third-party applications can use for remote scans, and click Update. Transactions logged under this third-party User ID will be reassigned to the Equitrac User Account that is signed in at the time of the scan.

8 Under Scan to email originator, enter a valid email address to use as the From address for email messages that include scanned documents.

9 To Reset Log Indexes, click Reset.

NOTE: The Reset Log Indexes button is not available on the console configuration page. It is only available via the web browser.

Field Description

System Manager ID

The ID required to access administrative functions on the device.

Note: The ID you enter here must match the ID configured on the device. If this ID does not match the System Manager ID, you cannot access the device’s administrative functions.

System Manager Password

The password required to access administrative functions on the device.

Note: The password you enter here must match the password configured on the device. If this password does not match the System Manager password, you cannot access the device’s administrative functions.

Department ID

The default Canon Department ID that controls and tracks printing during device sessions with normal users.

Department Password

The default Canon Department Password that will control and track printing during device sessions with normal users.

Department Support Enabled

Select this option if you want the Equitrac Embedded application to support multiple Canon departments.

Note: The department personal identification numbers (PINs) that are stored on the Equitrac server must match the Canon Department IDs. If they do not match, users can only log in using the default Canon Department ID. Use at own risk.

Page 37: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

37

Log FilesDuring installation or operation of the software, problems may be encountered. Diagnosis of the problem by Equitrac Support Services often requires use of logs generated during the problem situation. This chapter covers the steps necessary to initiate logging and how to acquire the logs after they are created. This chapter covers Device Application Logs and Installer Logs. Server Logs (logs of server activity) are not covered in this section.

If the problem occurs during installation and the Installer reports a failed install, you need to obtain Installer Logs. See Obtaining Equitrac Embedded Installer Log Files on page 37.

If the problem occurs after the Installer has reported a successful install, you need to obtain Device Application Logs. You have two options for obtaining Device Application Logs—from the device, or the server. See Obtaining Device Application Logs from the Server on page 38.

Obtaining Equitrac Embedded Installer Log FilesWhen using the Equitrac Embedded Installer, sometimes the install fails. To acquire support for the failed install, you need to gather the Embedded Installer logs and then contact Equitrac Support.

The Installer continually logs all activity, and keeps a copy of the activity locally on the machine that is running the Installer. You do not need to turn on logging for the installer.

To obtain Equitrac Embedded Installer logs, do the following:

1 Open the C:\EquitracInstallerLogs directory.

2 Locate the directory for the failed install. The directories are named Run.<ip address>.<date>, where date refers to the time of initial installation.

3 In the Installer window, place the cursor on the text that shows the installation steps.

4 Select and copy all the text, and then paste it into a new blank text file.

NOTE: Ensure that all the text in the installation steps is selected. Do not take a screen capture of the Installer log, as all the text will not be shown.

5 Save the new text file into the same Run.<ip address>.<date> directory. Name the file install.log.

6 Create a zip file of the Run.<ip address>.<date> directory.

7 Add a password to the zip file, and then email the zip file to Equitrac support. The password allows the zip file to be sent through the email servers.

Page 38: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

38

Obtaining Device Application Logs from the ServerThis process cannot be used if the embedded application has not been licensed to the server. If this is the case, refer to Obtaining Device Application Logs from the Device on page 38 instead.

The Equitrac server provides an interface for extracting the logs generated by the embedded application on the device. The advantage of this interface is that it is easy to use and is provided in a central location to all devices. The disadvantage is that it cannot be used with specific types of problems, such as network disconnect between the application and the server, bad server address configuration, critical failure on the device, licensing issues. If you cannot successfully gather a log using this method, see Obtaining Device Application Logs from the Device on page 38.

To obtain log files from a Canon MEAP device, do the following:

1 Start Web System Manager, and navigate to Diagnostics > Trace > Settings in the left pane.

If Diagnostics does not appear in the left pane, modify the Web System Manager startup parameters by adding /-d at the end of the Target field name in Web System Manager Properties. (e.g. "C:\Program Files\Nuance\Equitrac\WebClient\EQSrvMgr.exe" /-d).

2 In the right pane, expand the Equitrac server.

3 Click the embedded device link. The Trace file settings dialog opens.

4 Select the EQ MEAP Device checkbox, and then click OK to enable tracing.

5 Select Files in the Diagnostics section in the left pane.

6 In the right pane, expand the Equitrac server and the Canon embedded device.

7 Right-click the log file, select Send to zip file from the menu, and then save the file.

8 Repeat steps 1 - 4, and uncheck the EQ MEAP Device to disable tracing.

Obtaining Device Application Logs from the DeviceDevice Application Logs can be gathered from the device directly using a java console application. This approach to gathering Device Application Logs is the most robust, and the most difficult to setup. This approach will fail if the application is not installed, or there is no network connection to the device. You must be able to ping the device before using this approach.

To use these instructions you have to acquire a copy of Console.jar from Equitrac Support Services.

In order to enable console logging, there are some prerequisites. You need access to a workstation (PC) with privileges to install software, and physical network access. You need to configure the MFP, and the login application.

PC Setup and Installation

On the PC, install Sun Java version j2re-1_4_2_15-windows-i586-p.exe.

MFP Configuration

1 Logout of any running login applications.

2 Press Reset.

3 Press and hold Counter Check for 4 seconds, and then release.

Page 39: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

39

4 Enter 3210, and press ID. The button “beeps”. If the button does not beep, repeat steps 2 - 4.

5 Press Counter Check. The button beeps and a login window opens.

6 Enter 9876 and press OK.

7 Turn on Console Debugging.

Login Application Configuration

1 Open a web browser, and enter http://<MFP IP>:8000/Equitrac/Config in the address field and login when prompted to open the device’s configuration page. (If SSL is enabled, enter https://<MFP IP>:8443/Equitrac/Config).

2 In the Console Output section, select the Enabled checkbox to enable debug logging on the device, and click Update.

3 Verify the update from the message at the top of the window.

4 Logout.

Running the Console

On the system with the Java Virtual Machine, do the following:

1 Create a new directory on the system, and place the console jar file in that directory.

2 Start a command prompt from that directory, and enter the following command line:java -jar Console.jar -host <MFP ip address or hostname>

A command window and a Console window open with the message “Connected” displayed in the Console window.

Page 40: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

40

Troubleshooting

This section discusses troubleshooting issues you may encounter, and provides solutions for common issues.

Turning Off MFP Debug ModeOn Canon MEAP MFPs with the Equitrac embedded application installed, if the Debug mode is set to ON, the MFPs may not start up again after a shut down. Therefore, set the MFP Debug mode to OFF to enable all MFP and embedded application functions. For help in changing the Debug mode settings, contact your Canon MEAP technician or representative.

Disabling the Equitrac Login ApplicationIf you have issues with the device during configuration or after initialization and a period of use, you can temporarily disable the Equitrac login application to access Canon administrative functions without uninstalling the application.

1 Open a web browser and enter http://<MFP IP>:8000/sms in the URL Address Field.

2 Login using the SMS password.

3 On the System Management Services page, navigate to System Management > Enhanced System Application Management.

4 In the Login Service section, select Default Authentication in the list, then click Switch.

5 Reboot the device. When the device reboots, it starts up with the default Canon Login application instead of the Canon MEAP application.

To restore the Canon MEAP application, repeat steps 1-4 and reselect Equitrac Login Application from the Login Service list before rebooting the device.

Access to System Management ModeTo access the Canon device System Management functions, log in to the device with the user ID Admin. This user ID is case-sensitive. If there is a password assigned to the Web System Manager ID and one configured for Equitrac Embedded, the device prompts you for the password before allowing access to the System Settings.

Slow Device Response or Local Mode SwitchingIf the Canon MEAP device is slow or unable to respond to login requests, Follow-You printing requests or other server-based functions, or if the device repeatedly switches into local mode, check the DNS (Domain Name Server) or WINS (Windows Internet Naming Service) configuration settings in the MFP Web System Manager.

NOTE: If invalid settings are configured, the device will experience communication time-outs, which can slow down performance or cause the device to fail over into local mode.

Page 41: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

41

Scan to email FailureIf the Canon Universal Send feature is installed and the Scan to email feature fails to send email messages, use the following procedures:

1 Check that there is a valid setting for the Scan to email originator in the device configuration page.

2 If Scan to email still fails, you may need to reconfigure the device Web System Manager settings. Before reconfiguring the Web System Manager settings, disable the Equitrac Login application.

3 In the MFP Web System Manager, check that there is:

• A valid Device Name under Management Settings > Device Management > Device Information Settings

• A valid E-Mail Address under Function Settings > Send > Network Settings - E-Mail/I-Fax Settings

• A valid Host Name and Domain Name under Preferences > Network Settings > TCP/IP Settings > DNS Settings (IPv4)

4 Conduct a test to ensure you can successfully send email messages.

5 After successfully sending an email message, re-enable the Equitrac Login application and test the Scan to email feature.

Device Constraints

Fax-with-Scan Transmissions Generate Two Transaction Records

For outgoing fax transmissions that originate with a scanned document, two or more separate transactions are recorded on the Equitrac server: one for the scan and one for each phone number of the fax transmission. Canon MEAP creates the scan transaction first, and when the fax transmission(s) is/are complete, it creates any fax transactions. Since any of these fax transmissions can occur much later in time after the scan, any fax transactions are also recorded later, and there may be no obvious link between the fax records and corresponding scan records.

If your billing system charges for each scan transaction, Equitrac recommends that you set up your fax transaction billing to account for the cost of a scan, and to avoid sending faxes through multiple phone numbers.

Page 42: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

42

eCopy Failure After Installing the Embedded ApplicationIf the eCopy embedded application stops working after the Equitrac embedded application is installed on the same device, do the following:

1 Uninstall both the embedded and eCopy applications.

2 Install the embedded application.

3 Install the eCopy application.

4 Log in to the embedded application, and remain logged in until step 5 is complete.

5 Configure the device on the eCopy ShareScan server. See the Managing Devices chapter in Kofax Equitrac Administration Help file.

CAUTION: If not logged in to the embedded device while configuring ShareScan, the device will not be successfully added to the eCopy server.

After installing the Equitrac embedded application, upgrading to the latest version of eCopy is recommended to ensure accurate user authentication and successful eCopy scans.

Embedded Device Not Associated with Physical Device in Web System ManagerIf two physical device entries appear in Web System Manager after installing the Equitrac embedded application on the MFP, the embedded software will not function properly. This behavior may occur if the embedded device was configured before adding your printer. When this occurs, two physical device entries may appear in Web System Manager; one containing the print queue, and one containing the embedded device.

To correct this behavior, do the following:

1 Delete the physical device entry containing the embedded device from Web System Manager.

2 Reboot the device.

3 Refresh Web System Manager.

4 Verify that a single physical device entry containing the port, print queue, and embedded device appears in Web System Manager.

If the embedded device does not appear within the physical device entry containing the print queue, ensure that the DNS name of the MFP resolves to the appropriate IP address from the DCE server. Once resolved, repeat the preceding steps to associate the embedded device with the physical device in Web System Manager.

If this problem persists, contact Equitrac Technical support.

Page 43: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

43

GlossaryThe following unique Equitrac terms are used within this guide.

Term Description

Account Limits A feature to ensure that sufficient funds are available in an account to pay for print jobs before they are released from the queue. Rules defined on the server for print and copy may present on the device as an account limit.

Account limits also impact copy jobs.

Alternate Primary PIN An ID— a sequence of letters or numbers—that uniquely identifies a user. The Alternate Primary PIN can be data encoded on a magnetic swipe card or entered on the device keypad. The Alternate Primary PIN can be used as an alternate to the Primary PIN.

Authentication The process of entering a Secondary PIN to gain access to a controlled MFP. In a 1 PIN model, users are identified and authenticated with a single PIN. In a 2 PIN model, users are identified with the Primary PIN, and authenticated with the Secondary PIN.

Authentication verifies that the identified user is really that user.

Copy/Scan/Fax Tracking The ability to track the attributes of a Copy/Scan/Fax job. For example, number of pages, page size, and color. With Canon MEAP all Copy/Scan/Fax tracking is done by the embedded application and reported to DCE.

Copy Stop A feature to limit the number of copies a user can make. Copy Stop will terminate copy jobs in real time, as soon as maximum copies are reached. The maximum number of copies is based upon the account limits.

Core Accounting Server (CAS)

CAS is a core component of Equitrac. This service controls the accounting database that stores all printer, user, department, transaction and balance information. CAS also verifies users, calculates printing charges and assigns charges to an appropriate user or department.

Device Control Engine (DCE)

A core component of Equitrac, DCE handles communication with the embedded applications and terminals.

Device Routing Engine(DRE)

A core component of Equitrac, DRE enables document flow from workstations to output devices. When a job is released, DRE captures the job characteristics and communicates the characteristics to CAS.

Follow-You Printing A secure printing feature that holds print jobs in a virtual print queue until the user “pulls” the print job to a selected device. A user can select a particular printer when they submit a print request, then walk to an entirely different compatible device in a predefined pull group, and pull the job to that device.

Force Monochrome A feature that allows the user to force a color job to print in black & white.

Identification The process of entering a Primary PIN to gain access to a controlled MFP. Users may use the card reader, or the MFP control panel. Identification tells us who is attempting login without guaranteeing it is that user.

Page 44: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

44

Multi-serverFollow-You

A secure printing feature that extends the Equitrac Follow-You functionality to allow users to view and release secure print jobs from different print servers.

Offline A situation where DCE is not available to the device. Hardware failures, or communication failures on the network can create an offline situation. When CAS is offline, DCE will provide offline support with cached data. When DCE is offline, the Canon device goes into offline mode and supports the appropriate login feature based upon server settings.

Print Tracking The ability to track the attributes of a released network print job. For example, number of pages, page size, and color. With Canon MEAP all print tracking is done by DRE.

Primary PIN An ID— a sequence of letters or numbers—that uniquely identifies a user. The Primary PIN can be data encoded on a magnetic swipe card or entered on the MFP device keypad.

Print & Save A feature that allows a user to print a job without deleting it from the Equitrac print queue.

Release Key An Equitrac feature that lets users assign an alpha-numeric key value to their document when they submit a print request. When any user wishes to print the document they can find it by supplying the correct Release key.

Secondary PIN Typically is a password used to authenticate the user when used in conjunction with a Primary PIN or Alternate PIN. Secondary PINs may be optional.

Secure Document Release (SDR)

A feature that holds network print jobs in a secure virtual print queue. Users must authenticate at an MFP to release jobs from the secure queue. The goal of secure printing is to ensure that confidential information does not sit at an output device for public consumption.

Term Description

Page 45: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

45

Appendix A: Third-Party Software

This software contains the following third-party software.

SAX XML Parsing Project

SAX XML Parsing Project (http://www.saxproject.org) covering packages org.sax.*

Copyright Status: SAX is free.

It is not possible to own a license to SAX, as it is public domain.

No Warranty

Because SAX is released to the public domain, there is no warranty for the design or for the software implementation, to the extent permitted by applicable law. Except when otherwise stated in writing the copyright holders and/or other parties provide SAX "as is" without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The entire risk as to the quality and performance of SAX is with you. Should SAX prove defective, you assume the cost of all necessary servicing, repair or correction.

In no event unless required by applicable law or agreed to in writing will any copyright holder, or any other party who may modify and/or redistribute SAX, be liable to you for damages, including any general, special, incidental or consequential damages arising out of the use or inability to use SAX (including but not limited to loss of data or data being rendered inaccurate or losses sustained by you or third parties or a failure of the SAX to operate with any other programs), even if such holder or other party has been advised of the possibility of such damages.

Copyright Disclaimers

This page includes statements to that effect by David Megginson, who would have been able to claim copyright for the original work.

SAX 1.0

Version 1.0 of the Simple API for XML (SAX), created collectively by the membership of the XML-DEV mailing list, is hereby released into the public domain.

No one owns SAX: you may use it freely in both commercial and non-commercial applications, bundle it with your software distribution, include it on a CD-ROM, list the source code in a book, mirror the documentation at your own web site, or use it in any other way you see fit.

David Megginson, Megginson Technologies Ltd.5/11/1998

Page 46: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

46

SAX 2.0

I hereby abandon any property rights to SAX 2.0 (the Simple API for XML), and release all of the SAX 2.0 source code, compiled code, and documentation contained in this distribution into the Public Domain. SAX comes with NO WARRANTY or guarantee of fitness for any purpose.

David Megginson, Megginson Technologies Ltd.5/5/2000

Piccolo 1.04 XML ParserPiccolo 1.04 XML Parser (com.bluecast.*) which contains the following copyright notice and license terms:

Copyright© 2002-2004 by Yuval Oren. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and limitations under the License.

The following software packages are licensed under GNU GPLv2 with Classpath Exception to support XML parsing through Piccolo:

• java.rmi.*

• javax.xml.parsers.*

• javax.xml.rpc.*

• eq.java.lang.*

• eq.java.util.*

These packages contain the following copyright notice and license terms:

Copyright© 1998, 1999, 2001, 2002, 2005 Free Software Foundation, Inc.

GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version.

GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination.

As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked

Page 47: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

47

independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Base64 Encodingcldc_crypto.jar and com.sun.midp.io.Base64.java supports encryption and Base64 encoding of data is based upon work carrying the following copyright legend and license terms:

Copyright© 2000 The Legion Of The Bouncy Castle (http://www.bouncycastle.org)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Apache ModulesThe following Apache modules are used:

• commons_fileupload_1.1.1.jar

• commons_io_1.2.jar

• com.apache.log4j

Apache's Log4j ProjectApache's Log4j Project (com.apache.log4j) carries the following copyright and license notice:

Copyright© 2003-2006 The Apache Software Foundation.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and limitations under the License.

Page 48: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

48

Java Collections v1.1

The standard Java Collections v1.1 (com.sun.java.util.collections.*) is Copyright© Sun Microsystems Inc. and is released under the following license:

SUN MICROSYSTEMS, INC., THROUGH ITS JAVASOFT BUSINESS ("SUN") IS WILLING TO LICENSE THE ACCOMPANYING com.sun.java.util.collections.x PACKAGES AND DOCUMENTATION ("SOFTWARE") INCLUDING AUTHORIZED COPIES OF EACH (THE "SOFTWARE") TO LICENSEE ONLY ON THE CONDITION THAT LICENSEE ACCEPTS ALL OF THE TERMS IN THIS AGREEMENT.

PLEASE READ THE TERMS CAREFULLY BEFORE CLICKING ON THE "ACCEPT" BUTTON. BY CLICKING ON THE "ACCEPT" BUTTON, LICENSEE ACKNOWLEDGES THAT LICENSEE HAS READ AND UNDERSTANDS THIS AGREEMENT AND AGREES TO BE BOUND BY ITS TERMS AND CONDITIONS. IF LICENSEE DOES NOT ACCEPT THESE LICENSE TERMS, SUN DOES NOT GRANT ANY LICENSE TO THE SOFTWARE, AND LICENSEE SHOULD CLICK ON THE "REJECT" BUTTON TO EXIT THIS PAGE.

1 Limited License Grant. Licensee is granted a non-exclusive, non-transferable limited license to use the Software to assist in the development Java compatible software programs running on JDK 1.1 ("Developed Programs") provided that Licensee: (i) may not create or authorize your licensees to create additional classes, interfaces, or sub-packages that are contained in "java" or "sun" packages or similar as specified by Sun in any class file naming conventions; and (ii) agree to indemnify, hold harmless, and defend Sun and its licensors from and against any claims or lawsuits, including attorney's fees, that arise or result from the use of the Software or development performed by Licensee.

2 License to Distribute. Licensee is granted a royalty-fee right to reproduce and distribute the Software provided that Licensee: (i) distributes the Software complete and unmodified, only as part of, and for the sole purpose of running Licensee's Developed Program into which the Software is incorporated; (ii) do not distribute additional software intended to replace any component(s) of the Software; (iii) do not remove or alter any proprietary legends or notices contained in the Software; (iv) only distribute the Developed Program(s) subject to a license agreement that protects Sun's interest consistent with the terms contained herein; and (v) agree to indemnify, hold harmless, and defend Sun and its licensors from and against any claims or lawsuits, including attorney's fees, that arise or result from the distribution of the Developed Program(s).

3 Restrictions. Software is copyrighted and title to all copies is retained by Sun and/or its licensors. Licensee shall reproduce and apply all proprietary rights notices which appear on or in the Software on or in any copies of the Software made by Licensee. Unless enforcement of this provision is prohibited by applicable law, and only to that extent, Licensee shall not modify, decompile, disassemble, decrypt, extract, or otherwise reverse engineer Software. Software is not designed or licensed for use in on-line control equipment in hazardous environments such as operation of nuclear facilities, aircraft navigation or control, or direct life support machines.

4 Confidentiality. Software is confidential and proprietary information of Sun and/or its licensors. Licensee agrees to take adequate steps to protect Software from unauthorized disclosure or use.

5 Disclaimer of Warranty. The Software is provided "AS IS". All express or implied conditions, representations and warranties, including any implied warranty of merchantability, fitness for a particular purpose or non-infringement, are hereby excluded to the extent allowed by applicable law.

6 Limitation of Liability. In no event will Sun or its licensors be liable for any lost revenue, profit, or data, or for special, indirect, consequential, incidental, or punitive damages however caused and regardless of the theory of liability arising out of the use of or inability to use software, even if Sun has been advised of the possibility of such damages.

Page 49: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

49

7 Termination. This License is effective until terminated. Licensee may terminate this License at any time by destroying all copies of Software including any documentation. This License will terminate immediately without notice from Sun if Licensee fails to comply with any provision of this License. Upon termination, Licensee must destroy all copies of Software.

8 Export Regulations. Software, including technical data, is subject to U.S. export control laws, including the U.S. Export Administration Act and its associated regulations, and may be subject to export or import regulations in other countries. Licensee agrees to comply strictly with all such regulations and acknowledges that it has the responsibility to obtain licenses to export, re-export, or import Software.

9 U.S. Government Restricted Rights. Use, duplication or disclosure of the Software by the U.S. Government is subject to restrictions of FAR 52.227-14(g)(2)(6/87) and FAR 52.227-19(6/87), or DFAR 252.227-7015(b)(6/95) and DFAR 227.7202-3(a).

10 Governing Law. Any action related to this Agreement will be governed by California law and controlling U.S. federal law. No choice of law rules of any jurisdiction will apply.

11 Severability. If any of the above provisions are held to be in violation of applicable law, void, or unenforceable in any jurisdiction, then such provisions are herewith waived to the extent necessary for the License to be otherwise enforceable in such jurisdiction. However, if in Sun's opinion deletion of any provisions of the License by operation of this paragraph unreasonably compromises the rights or liabilities of Sun or its licensors, Sun reserves the right to terminate the License and refund the fee paid by Licensee as Licensee's sole and exclusive remedy.

12 Integration. This Agreement is the entire agreement between Licensee and Sun relating to Software and:

(i) supersedes all prior or contemporaneous oral or written communications,

(ii) prevails over any conflicting or additional terms of any quote, order, acknowledgment, or similar communication between the parties during the term of this Agreement. No modification to this Agreement will be binding, unless in writing and signed by a duly authorized representative of each party.

AES Encryption

AES Encryption is based upon aes.js provided through the BrowserSync project (http://code.google.com/p/browsersync/) under the following copyright and license terms:

Copyright© 2005, Google Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1 Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2 Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3 Neither the name of Google Inc. nor the names of its contributors may be used to endorse or promote products DERIVED FROM THIS SOFTWARE WITHOUT SPECIFIC PRIOR WRITTEN PERMISSION.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

Page 50: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

50

LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Fast GUID Generation

Copyright© Fast GUID generation is provided under the following copyright and license terms:

Copyright© 2001-2004 The Apache Software Foundation.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

The Complete Apache License v2.0 is below:

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1 Definitions.

"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on

Page 51: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

51

behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

2 Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3 Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4 Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

a You must give any other recipients of the Work or Derivative Works a copy of this License; and

b You must cause any modified files to carry prominent notices stating that You changed the files; and

c You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and

d If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

5 Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

Page 52: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

52

6 Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

7 Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

8 Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

9 Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

GNU General Public License v2.0The Complete GNU General Public License v2.0 is reproduced below. Please note that this software contains third-party components released under the GNU Classpath license, which includes the GNU GPL v2 by reference.

GNU GENERAL PUBLIC LICENSE Version 2, June 1991

Copyright© 1989, 1991 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too.

When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.

To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.

Page 53: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

53

For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.

We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.

Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.

Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.

The precise terms and conditions for copying, distribution and modification follow.

TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

1 This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".

Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.

2 You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.

You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.

3 You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:

a You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.

b You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.

c If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of

Page 54: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

54

this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)

These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.

Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.

In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.

4 You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:

a Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

b Accompany it with a written offer, valid for at least three years, to give any third-party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

c Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)

The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.

If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.

5 You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

6 You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.

Page 55: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

55

7 Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.

8 If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.

If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.

It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.

This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.

9 If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.

10 The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.

11 If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.

NO WARRANTY

12 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH

Page 56: Embedded Canon MEAP 2.0 · February 29, 2016 Updated for Canon software version 2.0.9 October 30, 2014 Updated for Canon software version 2.0.8 November, 2013 Updated for Canon software

CAN-2.0.17-20190430Kofax Equitrac Embedded for Canon MEAP 2.0.17 Setup Guide

56

YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

13 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.