Equitrac Embedded for Lexmark - Kofax

Kofax EquitracEmbedded for Lexmark Setup GuideVersion: 1.0.5

Date: 2019-04-11

LEX-1.0.5-20190411Kofax Equitrac Embedded for Lexmark Setup Guide

2

Kofax Equitrac Embedded for Lexmark 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 11, 2019 Updated for Equitrac 6.0 and Kofax branding

October 3, 2018 Updates and revisions for 1.0.5 for SSO support

October 3, 2017 Updates and revisions for 1.0.4

March 1, 2016 Updated for Equitrac Office/Express Version 5.6

August, 2014 Updates and revisions for 1.0.2

April 16, 2013 Updated for Equitrac Office/Express Version 5.0

November 2, 2012 Updated for Equitrac Office/Express Version 4.2.5

May 2, 2012 Updates and enhancements for Equitrac Office/Express Version 4.2.4

December 8, 2011 Document created for Equitrac Office/Express Version 4.2.3.

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.


3

Contents1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Supported MFPs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Single sign-on with AutoStore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Installation Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Device Deployment Utility tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

2 Pre-Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Pre-Installation Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Planning the Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Downloading the Embedded Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Equitrac Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Customers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

3 Server-Side Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Configuring the Embedded Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Configure Embedded Device Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Configuring Follow-You Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Enabling Release Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Configuring Authentication Prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Configuring Card Self-Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

4 Embedded Application Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Export security templates (eSF 2.x-eSF 4.x devices) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Installation overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Installation with Equitrac only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Create an administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Enable permissions for public users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Manually install the Equitrac embedded client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Configure the EQLogin app . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Configure Scan Center permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Export settings configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Installation with Equitrac and AutoStore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Create an administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Enable permissions for public users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Manually install the Equitrac embedded client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Configure the EQLogin app . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Manually install the AutoStore client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Configure the AutoStore app . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Configure Scan Center permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Export settings configuration files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31


4

Update configured MFP devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Machine status during installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Verifying the installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

5 User Workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Using the Card Reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Logging in with a Magnetic Stripe Card . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Logging in with a Proximity Card . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Logging with Campus Card . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Registering Swipe Cards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Using the MFP Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Using Follow-You Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Printing from the USB Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Change the MFP Logout Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

6 Administrator Reference Material . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Offline Mode and the Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Administrator Tracking and Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Transactions, Power Failure and Offline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Transaction Blockage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

USB Card Reader Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Configure the Equitrac Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Additional Group Permissions (eSF 6.x devices) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Administration Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

7 Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Obtaining Equitrac Embedded Installer Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Obtaining Lexmark Embedded Solution Diagnostic Logs from the Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Enabling and Disabling Lexmark Embedded Solution Diagnostic Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Capturing Lexmark Embedded Solution Diagnostic Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Obtaining Device Application Logs from the Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

PC Setup and Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Device Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Login Configuration Web Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Running the Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

8 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Appendix A: Uninstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Appendix B: Third-Party Software Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87


7

Introduction

Product OverviewThis product is an embedded application for select Lexmark models. 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

Features for job control and tracking include:

• Copy tracking, with account limit enforcement through Copy Stop

• Scan tracking, with account limit enforcement at device function selection

• 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 (available with server configuration)

• Print and Save

• Set number of copies to print

• Force Duplex (available with server configuration)

Once Equitrac Embedded for Lexmark is installed, properly licensed, and configured on the device, the application fully secures the console login on the device. Authenticating the user allows the embedded application to report user job activity to the CAS server, and facilitate access to the Secure Document Release (Follow-You) application.

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

NOTE: Lexmark 1.x Framework devices are not supported by Equitrac software.

https://kofaximaging.custhelp.com/app/imaging/supported_devices/


8

Single sign-on with AutoStoreIf AutoStore is installed on the same Lexmark MFP device, the Equitrac embedded application supports single sign-on with AutoStore. When you log onto the device using the Equitrac login method, the login information is sent to AutoStore. Depending on your access level, you can view public workflows and any workflows that are assigned to you.

• If you want to log in as an administrator, swipe the front panel screen right to left and press the user icon. Press Admin ID/Password option and enter your credentials. You can view applications that you have permission to use.

• If Login Bypass is enabled and you are logged in as a guest, you can only view the applications that have been allowed by an administrator.

• When you log out of Equitrac, you are also logged out of the AutoStore application.

Single sign on with AutoStore is only supported on eSF 3.x, eSF 4.x, and 6.x devices.

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

• Certain administrative setup tasks, such as other device security.

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

Device Deployment Utility toolTo deploy the embedded software on a single MFP device or multiple MFP devices, Lexmark provides a Device Deployment Utility (DDU) tool that is compatible with the Kofax solution. After manually installing the embedded software, you can export the configuration files and use the DDU for single or bulk deployment, updating configuration settings and certain group permissions, and uninstalling the embedded application.

To request the DDU tool and receive more information, please contact your Lexmark support provider.


9

StrategyIntegrated solutions require an install strategy, and pre-planning is key to a successful installation. You cannot simply download the application and install it on the MFP. Installation without a strategy can take days or longer as you work through the problems for failing to pre-plan. Understanding, knowing and executing a proper install strategy can result in an installation of less than an hour for a single machine and minutes per MFP for bulk installations.

There are areas of the enterprise solution that must be addressed for proper installation of the embedded application. Some are manual only tasks, and others have automated support. The preferred task execution order is as follows:

Task Method Description

Downloads Manual Acquire the installation materials and licenses. The application must be downloaded from Equitrac. The installer must be accessible through the Internet or downloaded from Equitrac.

Firmware Manual The MFP must have the latest firmware or be upgraded to the latest firmware.

License Manual Must be completed on the Equitrac server. The server may require licenses for certain product features and MFPs, and will require proper licenses for each instance of the embedded application.

Printer Port Manual The print server must be setup with knowledge of the MFP. The server manages a configuration of the MFP for printing, with or without the embedded application installed.

Installer Setup Automated The MFP must be configured appropriately to receive the embedded application using the automated installer. We recommend pre-creating your install sets and configuration sets.

Install Application

Automated The embedded application must be installed on the MFP.

Configure Application

Automated The embedded application must be configured.

Configure Server

Manual The server must be configured for the embedded application.

Verify Manual The installation must be verified with an execution of a user workflow.


10

Pre-InstallationPre-installation involves steps that you can take in preparation before installing the Equitrac Embedded application. All MFP device and 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.

PrerequisitesBefore you begin the installation:

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

• If you are using an eSF 5.0 device, you need to update to eSF 6.0 before installing the latest embedded client for Lexmark.

• Some Lexmark devices cannot run embedded applications, or require memory upgrades before they can run third-party applications. Consult your Lexmark vendor to ensure your MFP devices can run third party additions.

• 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.6 or higher is installed on the system from which you are installing the Equitrac 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 via ftp on copiers, open ports 20 and 21.

• Ensure your MFP devices have enough physical memory to run the embedded application. We recommend a minimum of 512MB of RAM.

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. Do not install USB Readers before loading the software. Installing USB drivers at this time results in undesired behaviors during the installation process (i.e. The installation will “hang”).

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

1 Plan the deployment. Decide whether a single installation or bulk deployment is required, and obtain the DDU tool. See Device Deployment Utility tool on page 8.

2 Verify or upgrade the MFP firmware. Contact your local Lexmark service technician for information.

3 Obtain and install the necessary licenses from Equitrac. This includes proper licenses for the embedded application. This may also include licenses for certain product features and for all MFPs. Refer to the Kofax Equitrac Administration Help file.

4 Download the Equitrac Embedded installation file for Lexmark from Partner Portal. See Downloading the Embedded Application on page 11.


11

Planning the DeploymentBefore you deploy the Equitrac Embedded software, we recommend that you develop a deployment plan. The DDU tool allows you to install the software on a single MFP device or perform a bulk deployment on multiple devices at once.

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.

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

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

Equitrac PartnersIf 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 Lexmark 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.

CustomersContact 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 Lexmark 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.


12

Server-Side ConfigurationThere are two levels of configuration required to enable the Equitrac Embedded application features on your Lexmark 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.

When performing a bulk install, the steps outlined in this chapter need to be completed once per each MFP device.

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 in Web System Manager 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, correct the problem, then press the X (Cancel) key on the MFP and the device is then listed in Web System Manager.

Before proceeding to configure the embedded device settings, verify that the physical device entry in Web System Manager contains its corresponding print queue and embedded device.

Configure Embedded Device SettingsUse the Web System Manager > Physical Devices link to manually configure an embedded device that is associated with a single physical device. This configuration also includes enabling secure document release (SDR) and release behaviors, as well as copy, scan and fax access, on a per-MFP basis.

NOTE: You need only perform these steps if you want to alter the values generated when the device was auto-created. Any default values work, and can be left as is.

The following procedure assumes you have already registered the physical device hosting the Equitrac Embedded application within Web System Manager. For details on performing this procedure, see the Kofax Equitrac Administration Help file.


13

1 Use the Web System Manager > Devices link to manually add an embedded device that is associated with a single physical device in Equitrac.

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

3 In the Definition section, select Lexmark from the Type drop-down list.

4 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.

5 Enter a Description for the embedded device.

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

7 Enter the device Serial number.

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.

NOTE: 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 group from the drop-down list. For details on HID decoding, see the Kofax Equitrac Administration Help file.

15 Click Save to save the configuration changes.

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


14

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 hosting the embedded application 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.


15

Configuring Authentication PromptsThe user authentication prompts on the MFP login screen are determined by your 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 one of the following Authentication 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

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

• Always – User must enter a secondary PIN via the keyboard after they swipe their card.

• If PIN2 available – This option does not apply to Lexmark devices.

• If PIN2 available or keyboard login – This option does not apply to Lexmark devices.

• 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 Secondary prompt option, then you must re-initialize the device in order to enable the new selection.

5 In the Card setup section, enter the data start and stop position in the Use data from position fields. For details on entering HID decoding parameters, refer to the Kofax Equitrac Administration Help file.

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 Card Self-Registration on page 16 for details.

7 Click OK to save the changes.

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


16

Configuring Card Self-Registration If 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. Two-level authentication is required to register new cards, and the user must manually enter both primary and secondary login credentials.

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 In the Authentication options section, do the following:

• Select Card swipe only from the Input type drop-down list.

• 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 Lexmark devices.

• Select the Auto-register primary PINs check box. Optionally, you can select Register as alternate PIN to record the PIN as the Alternate PIN instead of the Primary PIN.

4 Click Save to save the changes and close the User authentication dialog box.

5 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, the user must enter a secondary PIN, or an external authority password after they swipe their card.


17

Embedded Application InstallationThis chapter discusses how to install the Equitrac Embedded for Lexmark application following one of the supported installation configurations and using the DDU tool to deploy the software. 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. Nuance recommends using Internet Explorer 7.0 (or higher) or Mozilla Firefox 3.1 (or higher) with the pop-up blocker disabled, or Google Chrome.

Export security templates (eSF 2.x-eSF 4.x devices)If you are updating or redeploying the Equitrac embedded software, you need to export the security templates for any eSF 2.x-eSF 4.x devices. You can use the exported security templates in the DDU tool during installation.

1 From a web browser, open the Lexmark MFP device web page: http://device_ip

2 From the left menu, click Settings.

3 Under Other Settings, click Import/Export.

4 Under Import/Export Security Setups, click Export Security Setups File. The security template is saved automatically to your Downloads folder.

Installation overviewChoose one of the following configurations to begin installing or upgrading the Equitrac embedded application for Lexmark MFP devices.

• Installation with Equitrac only.

• Installation with Equitrac and AutoStore.

• Installation with AutoStore only. If you are installing on an AutoStore only environment, refer to the Lexmark MFP component in the AutoStore Help.

Before you begin, verify that the MFP device firmware is up to date. For more information, contact your Lexmark support provider.

Installation with Equitrac only

Create an administratorYou need to create a new local user with administrator permissions. Complete the following:

1 From a web browser, open the Lexmark MFP device web page: http://device_ip.

2 Go to Settings > Security.

3 Under Local Accounts, click Add User.


18

4 Select User Name/Password as the authentication method.

5 On the Edit User Name/Password Account screen, enter the following information for the new user:

• Name. The full name of the user.

• User Name. This is the display name and can be different from the name.

• Email. The email address associated with the user.

• Password. Enter a password that conforms to your company’s security standards and confirm it.

The new login credentials will be used in Manually install the Equitrac embedded client on page 20.

6 Under Permissions Group, click Add New Group.

7 In the Group Name field, enter the Device Administrators group name for the new user. Associate the new administrator with this group.

8 Under Access Controls, select the Administrative Menus and Device Management check boxes. Every option must be selected under these two check boxes.

9 Click Create.


19

Enable permissions for public usersYou need to enable permissions for the public user. Complete the following:


2 Under Public, click Manage Permissions.

3 In the Function Access section, select the B/W Print and Color Print check boxes only.

4 If you want to allow printing from Equitrac servers only, do the following:

a Return to the Settings page and click Network/Ports > TCP/IP.

b In the Restricted Server List field, add the IP addresses for any servers running Equitrac services to allow printing.

NOTE: After this change, you must now access the device web page from a server on the restricted list.

5 5. Click Save.24


20

Manually install the Equitrac embedded client Complete the following:

1 From a web browser, open the Lexmark MFP device web page again (http://device_ip) and log in as the newly created administrator.

2 Click Apps.

3 Click Install an app and browse to the eqlesbaselib.fls file.

• This eqlesbaselib.fls file must be installed first.

• If you have an eSF 4.x device or lower, install eqlesbaselib.fls by ftp or the DDU tool.

4 Click Install. Repeat step 3 for each remaining .fls file: eqallocate, eqfollowyou, and eqlogin. All four apps are displayed on the Apps screen with the State: Running.

Configure the EQLogin app Complete the following:

1 On the Apps page, click EQLogin. Ensure the State: Running.

2 Click Configure.

3 In the Equitrac Server URL field, enter the Equitrac server IP or hostname.


21

4 Update other fields as required.

5 Click Apply.

Configure Scan Center permissions Complete the following:

1 From the left menu, click Security, and then click Manage Permissions (for EQAuthControl1) > All EQ Users.

2 Expand Apps and select Scan Center. Click Save.

3 Click Installed Apps and click Scan Center - Printer. Click Stop.


22

4 Click Installed Apps and click Scan Center. Click Configure.

5 Clear the Allow user to create destination in printer control panel check box and click Save.

6 Click Summary Page.

7 Select the Show Scan Summary, Print Confirmation, and Print a page confirming that the document was successfully sent check boxes and click Save.

8 Click Fax.

9 Select the Allow user to create destination in printer control panel check box and click Save.

10 Click Email.


23


Export settings configuration filesAfter manually installing the Lexmark embedded client, you can export the settings configuration files and use them to deploy the software to one or more MFP devices. Complete the following:

1 Click Settings, then click Export Configuration > All Settings. Files are saved automatically in your Downloads folder.

2 Do one of the following:

• Deploy the software on additional MFP devices using the device web page and the exported configuration files.

• Run the DDU tool to deploy the software and the configuration files.

When using the DDU tool:

• Follow the same order from Manually install the Equitrac embedded client when you are deploying the Equitrac .fls files.

• If you are upgrading an MFP device that has already been configured, in the DDU tool interface, ensure that the Secure Devices check box is selected.

Installation with Equitrac and AutoStore

Create an administratorYou need to create a new local user with administrator permissions. Complete the following:




24

3 Under Local Accounts, click Add User.

4 Select User Name/Password as the authentication method.

5 On the Edit User Name/Password Account screen, enter the following information for the new user:

• Name. The full name of the user.

• User Name. This is the display name and can be different from the name.

• Email. The email address associated with the user.

• Password. Enter a password that conforms to your company’s security standards and confirm it.

The new login credentials will be used in Manually install the Equitrac embedded client on page 20

6 Under Permissions Group, click Add New Group.

7 In the Group Name field, enter the Device Administrators group name for the new user. Associate the new administrator with this group.


25

8 Under Access Controls, select the Administrative Menus and Device Management check boxes. Every option must be selected under these two check boxes.

9 Click Create.

Enable permissions for public usersYou need to enable permissions for the public user. Complete the following:


2 Under Public, click Manage Permissions.


26

3 In the Function Access section, select the B/W Print and Color Print check boxes only.

4 If you want to allow printing from Equitrac servers only, do the following:

a Return to the Settings page and click Network/Ports > TCP/IP.

b In the Restricted Server List field, add the IP addresses for any servers running Equitrac services to allow printing.

NOTE: After this change, you must now access the device web page from a server on the restricted list.

5 Click Save.

Manually install the Equitrac embedded client Complete the following:

1 From a web browser, open the Lexmark MFP device web page again (http://device_ip) and log in as the newly created administrator.

2 Click Apps.

32


27

3 Click Install an app and browse to the eqlesbaselib.fls file.

• This eqlesbaselib.fls file must be installed first.

• If you have an eSF 4.x device or lower, install eqlesbaselib.fls by ftp or the DDU tool.

4 Click Install. Repeat step 3 for each remaining .fls file: eqallocate, eqfollowyou, and eqlogin. All four apps are displayed on the Apps screen with the State: Running.

Configure the EQLogin app Complete the following:

1 On the Apps page, click EQLogin. Ensure the State: Running.

2 Click Configure.

3 In the Equitrac Server URL field, enter the Equitrac server IP or hostname.


5 Click Apply.


28

Manually install the AutoStore client Complete the following:

1 While you are still logged in as the newly created user, click Apps.

2 Click Install an app and browse to the autostoreclient.fls file.

3 Click Install.

The AutoStore Client app is displayed on the Apps screen with the State: Running.

Configure the AutoStore appComplete the following:

1 On the Apps page, click AutoStore Client. Ensure the State: Running.

2 Click Configure.

3 In the AutoStore Server URL field, enter the AutoStore server IP address.

NOTE: To get the server IP address, you must right-click on the Lexmark MFP component in the AutoStore Workflow Process Designer, and select Properties > Preferences. For detailed instructions, refer to the “How to determine the host name or IP address of the AutoStore server” topic from the Lexmark MFP component in the AutoStore Help.


5 Click Apply.


29

Configure Scan Center permissions Complete the following:

1 From the left menu, click Security, and then click Manage Permissions (for EQAuthControl1) > All EQ Users.

2 Expand Apps and select Scan Center. Click Save.

3 Click Installed Apps and click Scan Center - Printer. Click Stop.


30

4 Click Installed Apps and click Scan Center. Click Configure.

5 Clear the Allow user to create destination in printer control panel check box and click Save.

6 Click Summary Page.

7 Select the Show Scan Summary, Print Confirmation, and Print a page confirming that the document was successfully sent check boxes and click Save.

8 Click Fax.


10 Click Email.


31


Export settings configuration filesAfter manually installing the Lexmark embedded client and AutoStore client, you can export the settings configuration files and use them to deploy the software to one or more MFP devices. Complete the following:

1 Click Settings, then click Export Configuration > All Settings. Files are saved automatically in your Downloads folder.

2 Do one of the following:

• Deploy the software on additional MFP devices using the device web page and the exported configuration files.

• Run the DDU tool to deploy the software and the configuration files.

When using the DDU tool:

• Follow the same order from Manually install the Equitrac embedded client on page 20 when you are deploying the Equitrac .fls files.

• If you are upgrading an MFP device that has already been configured, in the DDU tool interface, ensure that the Secure Devices check box is selected.

Update configured MFP devicesAfter deploying the Equitrac embedded software and AutoStore client to your MFP devices, if you need to change any configuration settings, such as a server IP address, you can update the information in an exported .ucf file.


2 Click EQLogin and click Configure.

3 Update the configuration settings as needed and click Export. The eqlogin.ucf file is saved automatically in your Downloads folder.

4 In the DDU tool, open your previous deployment to import the eqlogin.ucf file and redeploy the configuration updates.


32

Machine status during installationThe Lexmark 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. 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 will be executed through the network. It is recommended 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. It is recommended that you pause the printer on the print server during installation. Un-pause the printer before executing tests.

If there are any system errors, such as a “Toner Out” message, before the installation is started, the automated installation will halt and fail. Please ensure that the device is in a healthy state before beginning the installation.

Verifying the installationAfter installing the embedded application, whether single or bulk install, 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 33on page 40 for details on login options.

2 Press the Login button to open the Lexmark 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 Home button to end the user session.

6 On the server, select Start > Programs > Equitrac Office/Express > 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.

10 The successful generation of this report indicates that the Equitrac Embedded for Lexmark application is

11 correctly installed on the device.


33

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.

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 PIN).

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 device will not accept the data.

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

3 Press Login to start a user session. See Using the MFP Device on page 36 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 35.

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 PIN, enter your password on the login screen.


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 35.


34

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.


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 Reader is connected to the MFP and is receiving power

No LED Reader is not connected to the MFP or is not receiving power

Flashes off Card swipe detected


35

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 configured to prompt for Secondary PIN) 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.

3 Press Login.

The swipe card is registered once the login credentials have been authenticated by CAS. The user can now access Follow-You Printing, scan, and fax device functions. See Using the MFP Device on page 36 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.


36

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. If bypass is enabled, users can access designated MFP functions that are not protected by security templates.

To start a user session, do the following:

1 At 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.

—Or—

If enabled, select the Bypass button to access any MFP functions not protected by a security template. Note these functions are tracked through Equitrac Embedded under an “unidentified user”. Any functions protected with a security template are not available.

NOTE: Touch the keyboard icon beside the entry field to bring up the soft keyboard.

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 Press Login.

4 Select the device function from the menu.

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

• The selected device function displays its profile.

—Or—


37

• 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.

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.


38

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 OK to continue to the selected function.

The billing code is validated when you touch OK. 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.

4 Press the Home key to end the user session.

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.

3 Select Follow-You from the device main menu.

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


39

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

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

6 Select from the following options:

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

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

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.

Print & Save Select one or more documents in the list, then press the Print button to release the documents but retain them in 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.

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 37.

Exit Exits the Follow-You printing screen, and returns to the main menu.


40

Printing from the USB PortYou can print files from a USB flash drive using the USB port on a Lexmark MFP device. These print jobs are reported as copies in Equitrac.

Printing from USB supports the following file types:

• BMP

• DOC, DOCX

• GIF

• JPEG

• PNG

• PPT, PPTX

• TIFF

• XLS, XLSX

• XPS

You cannot print the following file types from the USB port:

• RTF

• TXT

• XML

Change the MFP Logout TimerDuring a session, if the front panel screen is idle for 30 seconds, you are returned to the home screen. After another 30 seconds, you are logged out of the session. You can change the length of time before you are logged out due to user inactivity.


2 Go to Settings > Device.

3 Under Screen Timeout, enter the new value, in seconds, for the timer. The default is 30 seconds.

4 Click Save.


41

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 Lexmark 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 Lexmark device documentation.

SecurityEquitrac Embedded for Lexmark provides the components to successfully implement cost recovery on the Lexmark LES platform. Lexmark security implementation is achieved on two levels:

1 Global user authentication

2 The collection of job tracking information on a per device function basis.

Global User AuthenticationGlobal user authentication is handled through the Lexmark idle screen. The user is presented with User ID and password prompts before being permitted to advance to the Lexmark main menu.

Job Tracking InformationThe collection of job tracking information is handled on the device functions that are configured to be guarded by a security template. Typically a security template is used to authenticate the user, however, since the user is already authenticated on the idle screen, Equitrac uses the security template to gather job tracking details. To initiate a device function, the user selects the function on the main menu. If the selected function is guarded by a security template, the template displays prompts. Once the user has satisfied the prompts presented by the template, the user advances to the selected device function.

NOTE: Using a security template to collect job tracking information can sometimes confuse the role of the logout button. The logout button is presented by the MFP upon successful completion of a security template, and is outside the Equitrac solution. Regardless of the presence of the logout button, users of Equitrac software can always logout using the home button. As with all login applications, the user is properly logged out once a prompt for a user ID is presented.

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.


42

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.

WorkflowsDepending upon which functions use a security template, Lexmark workflows can be either tracked, or not tracked. In the case of a workflow that is not tracked, no security template is involved with the device function selected, and therefore no billing information is collected. Tracked workflows contain an extra step wherein billing information is collected once a device function with a security temple assigned is selected. A typical Lexmark workflow without tracking consists of:

• Authentication

• Selection of an MFP function

• Execution of the selected function

• Logout.

A typical Lexmark tracked workflow consists of:

• Authentication

• Selection of an MFP function

• Designation of a billing code

• Execution of the selected function

• Logout.

Authentication

Security on the device is managed through authentication at the MFP idle screen. In order to gain access to the device, users must key in their user name and passcode before they are presented with the functions available to them. Authenticating in this way also allows the software to track the user’s selections on the MFP during the session, regardless of whether the functions chosen are being tracked by the Equitrac solution. Tracking for the various functions of the MFP is achieved through entering a billing code for the desired function.

NOTE: A user only needs to input the billing information once per login session. Selection of subsequent device functions during the session use the billing information provided at the outset.

Function Select

Users are presented with a screen containing the functions available to them at the device. If a user selects a function that has a security template attached, the user is prompted for billing information. The software does not restrict the native functions of the MFP and additional security measures can be employed. However, note that security on any given function must either be controlled through the Equitrac solution or any other third party security feature. Both cannot coexist on any given function.


43

NOTE: Although functions that do not have the Equitrac allocation agent are not tracked through billing code, the system none the less maintains information about which user has authenticated and completed the job. This information is passed to the database, and may be adequate for the needs of a given installation by way of security.

Billing code (tracked workflows only)

The Equitrac Embedded installer creates a template for each billable function of the MFP during the installation process. Both the Equitrac solution for authentication as well as authorization are present in each template. Providing a template for each function allows the workflow at the device to proceed without the need for users logging in after completing a task. For instance, users can copy a document, and then move on to fax a different document without exiting the workflow and logging in again. The software remembers the user’s login credentials and billing code.

NOTE: The number of security templates required depends upon the number of MFP functions Equitrac Embedded will track. This number is set during the installation process, and can be subsequently updated in the configuration settings. The security templates normally created by the installer must be created and named by the device administrator. Instructions for doing these actions are provided in a separate document. Contact Equitrac Support for further information.

Function execute

The selected function carries out, and the user is returned to the Main Menu.

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 completes a task, the embedded application uses information about the user’s activity. 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, the embedded application must maintain information about tracked user activity. To mitigate power failure, the embedded application works closely with the Lexmark device mechanism that tracks job output. The embedded application attempts to send transaction information to the server at 4 events:

1 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.

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

3 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 looks for updated information about job activity. This helps deliver transactions for delayed activity, such as retries on outbound faxes, in a timely fashion.

4 Job completion events.

Transaction Integrity is a process which allows two tasks (on separate systems) to be treated as an atomic function, that is, either both tasks succeed, or both fail. The embedded application maintains transaction integrity between the device, 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. The server avoids duplicate billing, which weeds out duplicate transactions before the billing process starts. The embedded application only considers information from the device to be consumed after it is known that


44

the transaction is queued on the hard drive. 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 remains queued on the disk. The application then makes continued attempts to deliver the transaction until the server acknowledges receipt.

If the device 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 appears 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 device.

Transaction BlockageTransactions that fail to deliver stay at the top of the delivery queue, preventing the following transactions from being delivered. In some cases, a transaction can have a data problem, and the server will never accept it. This blocks the delivery queue until the application is reinstalled. Application reinstall removes all transactions in the queue. To avoid this problem, users are now able to post all transactions, regardless of whether the server accepts them.

Use the Post transactions function from the Configure screen in the web application to correct the issue. This function effectively flushes the queue, sending information about queued jobs either to the server, or recorded to the log.

To use this feature, check the number of undeliverable transactions and/or the date of the last delivery. If there appears to be a bottleneck:

1 Turn on logging.

2 Start capturing logging. If you do not, the logs will scroll past top of the log page and be lost.

3 Click the Post transactions button in the configuration screen.

4 Retrieve the logs, and manually enter the errored transactions into the server. This step should be done in consultation with Equitrac Support.

Do not manually enter the entries where the transaction is being successfully pushed onto the network. Enter only the rejected transactions.

NOTE: The device must be online to correct the issue. This solution does not work with the device offline. All waiting transactions are pushed out. Upon completion, the queue should be zero, or at 1 or two for active FAX jobs.


45

USB Card Reader SupportAn issue exists between Equitrac software and the device that intermittently causes the device to lose connectivity with its attached USB card reader. Typically, this occurs when the device wakes up from power saving modes and does not re-establish its connection to the device. In this situation, there are three options to re-establish a connection. All of these options are available during or after installation is complete from the configuration dialog. All have other specific impacts on the operation of the device. The options are:

1 Prohibit low power mode.

This option prevents the device from entering into any sort of low power or deep sleep state. When the device remains fully powered, there is less likelihood of the USB card reader losing connectivity. Use of this option prevents the device from using modes designed to conserve power and toner, as well as lessen the effects of normal wear and tear.

2 Enable USB reset on Cancel/Stop Job button.

This option allows the user standing at the device to press the hard Cancel/Stop Job button to reset the connection to the server, and between the device and the card reader, should the card reader stop functioning. Frequent use of this option can cause the USB card reader to lose connection with the device permanently. In this case, the device must be rebooted.

3 USB reset with device wake up

This option attempts to reset the USB card reader each time the device wakes from sleep mode. Use of this option alone leaves no alternative should the card reader become disconnected for reasons not associated with power saving, or if the card reader does not reconnect on the first attempt. If the card reader loses its connection, it must be physically disconnected from the device and reconnected, or the device must be rebooted.

These options can be used in tandem with one another. Note that option 1 negates option 3, therefore it is best to select 1 or 3 when selecting more than one option to deal with this issue. Other external, third-party solutions may be available, such as an automated reboot function that may reboot the device at a given time each day when it is likely to have been asleep and will soon be used again (i.e. early morning).

Configure the Equitrac Application

After installation, you can configure the embedded application settings.

CAUTION: The application is fully configured by the installer during installation. These instructions should only be carried out if reconfiguration becomes necessary at a later time.

1 From a web browser, open the Lexmark MFP device web page: http://device_ip.

2 Click Settings. Depending upon your device series, go to the Equitrac configuration settings:

• For eSF 6.x devices, go to Settings > Apps > Installed Apps > EQLogin

• For eSF 4.x devices, go to Settings > Device Solutions > Solutions (eSF) > EQLogin

• For eSF 3.x devices, go to Settings > Embedded Solutions > EQLogin

• For eSF 2.x devices, go to Settings > Apps > Apps Management > EQLogin


46

3 Click Configure. The EQLogin configuration screen displays.

4 In the Equitrac Server URL field, enter the IP address or DNS name of the Equitrac DCE server.

5 Select the Enable debug logging check box to enable debug logging on the device. If you change this setting, click Apply.

6 The Seconds before forced logout timeout field contains the length of time before you are logged out due to user inactivity. User inactivity measures the length of time a user does not interact with the MFP during a session, or if the MFP runs out of paper or a paper jam occurs. The default value is 320 seconds. It is recommended that you keep this setting at a higher number.

7 Select the Enable Login Bypass check box if you want to permit users to access functions not protected by a security template without prompting for billing code.

8 Select the Prohibit low power mode check box to prevent the device from entering low power or deep sleep modes, then click Apply. Selecting this option prevents the device from using modes designed to conserve power and lessen the effects of normal wear and aging.

9 Enter a Minimum page number to be held in user account value, then click Apply. This value is used to synchronize the Equitrac Copy Stop feature with the timing of the device. This value represents the number of pages released from the device after the Equitrac software forces copying to stop.

10 10.Select the Post Transactions check box if the transaction queue is refused by the server. For detailed information about this step, see Transaction Blockage on page 44.

11 Under Options for SDK 2.x, 3.x and 4.x devices:

a Select the Enable USB reset with Stop button check box to allow Equitrac software to reinitialize the card reader USB port when the user presses Stop (the cancel/job stop button), then click Apply.


47

b Select the Enable USB reset on device wake up check box to allow Equitrac software to reinitialize the card reader USB port when the device wakes from sleep mode, then click Apply.

c Enter the number of device functions tracked by Equitrac Embedded through a security template in the Number of tracked functions field.

NOTE: If you increase the number of billable functions you must manually configure additional security templates, and manually assign these new templates to device functions.

Additional Group Permissions (eSF 6.x devices)The Administrator can manage group, or application-level, permissions using the MFP web interface or the DDU tool.

The following table contains the default group permissions that are set automatically during installation.

NOTE: For more information about application-level permissions in Equitrac, see the Equitrac Office and Express Administration Guide.

Manually Adding Security TemplatesYou must manually add additional security templates to device functions to guard them. These instructions do not apply to eSF 6.x MFP devices.

1. From a web browser, open the Lexmark MFP device web page: http://device_ip2. From the left menu, select Settings. The Settings page opens.3. Click Security. The Security screen opens.4. Click Security Setup. The Security Setup screen opens.5. In the Advanced Security Setup area, Step 2, click Security Template. The Manage Security Templates screen opens.6. Click Add Security Template. The Security Templates screen opens.12 In the Security Template Name field, provide a name for the template. We recommend intuitively naming the

template based upon the current setup. For example, if the Authentication Setup for the first billable device function is EQAuthControl1, a possible good name is EQAC1. The use of such a naming convention allows the installation program to uninstall the application cleanly, negating the need for a manual uninstall process.

Group Name Permissions

BW Copy Users Flash Drive Print, Copy Function, B/W Print

Color Copy Users Flash Drive Color Printing, Copy Color Printing, Color Print

Scan Users Flash Drive Scan, E-mail Function, FTP Function

Fax Users Fax Function

All EQ Users Access Address Book in Apps, Color Dropout, Use Profiles, Cancel Jobs at the Device


48

13 From the Authentication Setup list, select the device function that will be associated with the security template.

14 Click Add Authorization. The screen refreshes.

15 From the Authorization Setup list, select the same device function you selected in step 8.

NOTE: Each template must have a distinct authentication setup and authorization. Sharing authentication across templates results in selective function access lockout. Do not assign a group.

16 Click Save Template. You are returned to the Manage Security Templates screen.

17 Repeat steps 6 through 11 for each template associated with a billable or tracked device function.

The following billable or tracked functions usually require coverage with a security template:

18 When all templates have been created, on the Manage Security Templates screen, click the Return to Security Setup link at the bottom of the screen. The Security Setup screen displays.

19 In the Advanced Security Setup area, Step 3, click the Access Controls link. The Edit Access Controls page opens.

20 If present, click Expand All to view the controls if the tree structure for the access controls in collapsed.

21 In the Function Access branch, locate the function you want to install a security template to. For example, the first template you created, EQAC1, may be installed to the Copy Function of the device. The Function Access is only available in Lexmark 3.1 devices and above.

22 From the list of the function you want to install to a security template, select the name of the security template to install.

23 Repeat steps 16 through 17 for all the security templates you created, assigning one per device function.

NOTE: Do not assign the same security template to multiple device functions. Doing so locks the user out of one of the functions.

24 Scroll to the bottom of the screen and click Submit.


49

Administration SecurityEquitrac software is not responsible for device security administration. At a minimum, we recommend device administrators secure the following functions:

• Security Menu at the Device

• Security Menu Remotely

• Service Engineer Menus at the Device

• Service Engineer Menus Remotely

• Configuration Menu

• Paper Menu Remotely

• Reports Menu at the Device

• Reports Menu Remotely

• Settings Menu at the Device

• Settings Menu Remotely

• Network/Ports Menu at the Device

• Network/Ports Menu Remotely

• Flash Drive Firmware Updates

• Web Import/Export Settings

• Remote Management

• Firmware Updates

• Option Card Configuration at the Device

• Option Card Configuration Remotely

• Create Profiles

• Create Bookmarks at the Device

• Create Bookmarks Remotely

• PJL Device Setting Changes

• NPA Network Adapter Setting Changes


50

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 50.

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: Lexmark Embedded Solution diagnostic logs, or application logs. See Obtaining Lexmark Embedded Solution Diagnostic Logs from the Device on page 51 or Obtaining Device Application Logs from the Device on page 51.

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.


51

Obtaining Lexmark Embedded Solution Diagnostic Logs from the DeviceThe Lexmark Embedded Solutions Diagnostic Log contains all logs available in the Device Application logs captured using EquitracEsfConsole.jar. It also contains Lexmark runtime logging not captured by the EquitracEsfConsole.jar. Be mindful that these logs have a small buffer size, which often leads to log information being lost due to scrolling beyond the end of the buffer; they are difficult to capture. To retrieve ES logs, the administrator must enable them first.

Capturing the Lexmark Embedded Solutions Diagnostic Logs is an important practice when investigating firmware issues where the Equitrac application is interacting with system components.

Enabling and Disabling Lexmark Embedded Solution Diagnostic Logging1 Open a web browser, and enter http://<Device IP Address>/se

2 Click Embedded Solutions

3 Click Set Logging Level

4 In Allow debugging entries in the log? choose Yes to enable and No to disable.

5 Click Submit

Capturing Lexmark Embedded Solution Diagnostic Logs1 Open a web browser, and enter http://<Device IP Address>/se

2 Click Embedded Solutions

3 Click Log File

4 The log content is displayed in the browser window. Copy/Paste the entire window contents into a notepad file and save it as <description>_se.log.

5 Refreshing the window obtains the latest snapshot of the end of the log. The rest of the log rolls off at the top of the displayed portion and can no longer be retrieved.

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 preferred approach as it collects the logs for the duration of a specific period. This approach fails 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 must acquire a copy of the EquitracEsfConsole.jar for Lexmark from Equitrac Support Services.

Prerequisites to enable console logging:

• Access to a workstation (PC) with privileges to install software, and physical network access.

• Enable debug in the configuration from the MFP.


52

There are 3 ways to enable logging debug logging:

• Through PC setup and installation.

• Through the device configuration.

• Through the login configuration web page.

PC Setup and InstallationOn the PC, install Sun Java version 1.6.0_24-b07. This enables logging.

Device Configuration1 Logout of any currently active user sessions.

2 Power down and restart the device.

3 After the device boots, a screen displays containing Configure and Start buttons. Press Configure.

4 Enter “equitrac” as password.

5 Press Login.

6 Select the Enable Debugging Logging check box.

7 Press OK

Login Configuration Web Page1 Open a web browser, and enter http://< Device IP Address >

2 Navigate to Settings -> Embedded Solutions -> EQLesBaseLib and click the Configure tab

3 Use “equitrac” for the admin password when prompted, then click Login.

NOTE: The default admin password is equitrac - all lower case.

4 Select the Enable debug logging check box. Click the adjacent Update button.

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

6 Logout.

Running the ConsoleOn the system with the Java Virtual Machine, do the following:

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

2 Start a command prompt from that directory, and enter the following command line:

java -jar EquitracEsfConsole.jar <device address> [outfile]

Where <device address> is the address of the copier to retrieve logs from, and <outfile> is the path to a file to which logs are written. Any existing contents in the outfile will be overwritten.


53

NOTE: When an <outfile> is specified, the log tool also captures the SE log when it connects to the device. The contents of the SE logs contents are written to files named DeviceLog_<timestamp>.log. These log files share the same folder as the <outfile>. To capture additional SE logs after the tool has started, from a command prompt, type seLog on the command line and press Enter. The SE writes to a new file named DeviceLog_<timestamp>.log.

3 Type exit or quit at the command line, then press Enter to Exit. After exiting, the log file can be attached to the defect.


54

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

Device ConfigurationTo access the Lexmark device configuration, log in to the device with the user ID Admin. This user ID is case-sensitive. If secondary PINs are enabled on the server, the device prompts you for the password before allowing access to the System Settings.

Slow Device Response or Local Mode SwitchingIf the Lexmark 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) settings in the MFP Configuration.

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.

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.

Incorrect IP address displayedIn some instances, when an MFP is moved from one location to another on a network, the IP address for the first location remains displayed on the MFP front panel. This is caused by the host name of the MFP being registered twice in the DNS, once for each location, however only the first registry entry is resolved. To correct this issue, consult your network administrator about removing the unwanted DNS entry.


55

Eco-Mode defeats print settings for duplexingIf Eco-Mode is set on the device, it can override requests made from Equitrac Embedded regarding finishing options, such as simplex printing. In order for print jobs to be costed correctly, we recommend disabling Eco-Mode on the device at install time:

1 Open a browser window, and enter the IP address of the device, for example, http://192.168.10.10

2 From the left menu, select Settings, then General Settings. The General Settings page opens.

3 Select Eco-Mode.

4 From the Eco-Mode drop-down list of options, select either Off or Energy. Any other option causes incorrect costing due to forced duplexing of print jobs.

Pictbridge PrintingPrints directly from digital cameras using the PictBridge function are not correctly costed in Equitrac Embedded. We recommend disabling this function on the device to prevent costing errors:

1 Open a browser window, and enter the IP address of the device, for example, http://192.168.10.10

2 From the left menu, select Settings. The Settings page opens.

3 Click Security, then Security Setup, then from Step 3, Access Controls. The Edit Access Controls screen displays.

4 Click Expand All to display the list of all functions, if not already displayed.

5 Scroll down to the PictBridge Printing drop-down list, and from the list, select Disabled.

6 Click Submit.

TransactionsWhen a copy job is interrupted due to paper jams, the system may track usage from before and after the paper jam as two separate transactions.

USB Card readers do not operate when the device wakesWhen devices wake from deep sleep mode, the USB card readers may not operate. Either press the Reset button on the front of the machine to reinitialize the reader, or unplug the reader from the USB port and re-insert it, or power cycle the device.

This condition can be circumvented by preventing the device from entering low power mode. For more information, see “Configure the Equitrac Application” on page 45., step 11.


56

Appendix A: Uninstallation

Automated UninstallTo uninstall the Equitrac Embedded application using the Embedded Installer, do the following:

1 Open a web browser and enter http://download.equitrac.com/38834/installGUI.html in the Address field.

The Equitrac Embedded installer loads:

2 Click Uninstall. The Uninstall Setup dialog box opens:

3 In the Copier Address field, enter IP address of the MFP from which you will remove the embedded application.

4 Click Browse to select the configuration set originally used to install the embedded application.

5 Navigate to the location of the configuration set, select it, and click OK.

NOTE: If the original configuration set does not exist, you must create a new set and then use that one to uninstall the embedded application. See Creating Configuration Sets on page 11.

6 Click OK to begin the uninstall process. The Uninstall [IP] dialog box displays. As the uninstallation proceeds, progress lines appear in the dialog box.

NOTE: Uninstallation takes a few minutes to complete. During this time, only the Cancel button is available. When the uninstallation completes, a message appears in the dialog box indicating the success or failure of the installation, the Retry and Report buttons become available, and the Cancel button changes to Done.

7 Click Done when uninstallation is complete.


57

Appendix B: Third-Party Software LicensesThe following software may be included in this product: apache commons codec; Fast GUID Generation; apache commons http; apache commons logging; and Jakarta Regular Expressions. Use of any of this software is governed by the terms of the following license:

Apache LicenseVersion 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 behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic,


58

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.


59

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.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

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.

This product includes software developed by The Apache Software Foundation (http://www.apache.org/).

NOTICE file corresponding to the section 4 d of

the Apache License, Version 2.0,

in this case for the Apache Ant distribution.


60

This product includes also software developed by :

• the W3C consortium (http://www.w3c.org) ,

• the SAX project (http://www.saxproject.org)

Please read the different LICENSE files present in the root directory of this distribution.

The names "Ant" and "Apache Software Foundation" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact [email protected].

The following software may be included in this product: Dundas Ultimate Grid and Dundas Ultimate TCP/IP. Use of this software is governed by the terms of the following “CPC - Code Project Code Software License”:

Preamble

This License governs Your use of the Work. This License is intended to allow developers to use the Source Code and Executable Files provided as part of the Work in any application in any form.

The main points subject to the terms of the License are:

• Source Code and Executable Files can be used in commercial applications;

• Source Code and Executable Files can be redistributed; and

• Source Code can be modified to create derivative works.

This License is entered between You, the individual or other entity reading or otherwise making use of the Work licensed pursuant to this License and the individual or other entity which offers the Work under the terms of this License ("Author").

License

THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CODE PROJECT CODE USAGE LICENSE ("LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HEREIN, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE AUTHOR GRANTS YOU THE RIGHTS CONTAINED HEREIN IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS. IF YOU DO NOT AGREE TO THE ACCEPT AND BE BOUND BY THE TERMS OF THIS LICENSE, YOU CANNOT MAKE ANY USE OF THE WORK.

1 Definitions.

a "Articles" means, collectively, all articles written by Author which describes how the Source Code and Executable Files for the Work may be used by a user.

b "Author" means the individual or entity that offers the Work under the terms of this License.

c "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works.

d "Executable Files" refer to the executables, binary files, configuration and any required data files included in the Work.


61

e "Publisher" means the provider of the website, magazine, CD-ROM, DVD or other medium from or by which the Work is obtained by You.

f "Source Code" refers to the collection of source code and configuration files used to create the Executable Files.

g "Standard Version" refers to such a Work if it has not been modified, or has been modified in accordance with the consent of the Author, such consent being in the full discretion of the Author.

h "Work" refers to the collection of files distributed by the Publisher, including the Source Code, Executable Files, binaries, data files, documentation, whitepapers and the Articles.

i "You" is you, an individual or entity wishing to use the Work and exercise your rights under this License.

2 Fair Use/Fair Use Rights. Nothing in this License is intended to reduce, limit, or restrict any rights arising from fair use, fair dealing, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.

3 License Grant. Subject to the terms and conditions of this License, the Author hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:

a You may use the standard version of the Source Code or Executable Files in Your own applications.

b You may apply bug fixes, portability fixes and other modifications obtained from the Public Domain or from the Author. A Work modified in such a way shall still be considered the standard version and will be subject to this License.

c You may otherwise modify Your copy of this Work (excluding the Articles) in any way to create a Derivative Work, provided that You insert a prominent notice in each changed file stating how, when and where You changed that file.

d You may distribute the standard version of the Executable Files and Source Code or Derivative Work in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution.

e The Articles discussing the Work published in any form by the author may not be distributed or republished without the Author's consent. The author retains copyright to any such Articles. You may use the Executable Files and Source Code pursuant to this License but you may not repost or republish or otherwise distribute or make available the Articles, without the prior written consent of the Author.

Any subroutines or modules supplied by You and linked into the Source Code or Executable Files this Work shall not be considered part of this Work and will not be subject to the terms of this License.

4 Restrictions. The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:

a You agree not remove any of the original copyright notices and associated disclaimers that may appear in the Source Code or Executable Files.

b You agree not to advertise or in any way imply that this Work is a product of Your own.

c The name of the Author may not be used to endorse or promote products derived from the Work without the prior written consent of the Author.

d You may distribute the Executable Files and Source Code only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy of the Executable Files or Source Code You distribute and ensure that anyone receiving such Executable Files and Source Code agrees


62

that the terms of this License apply to such Executable Files and/or Source Code. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute the Executable Files or Source Code with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License.

e You agree not to use the Work for illegal, immoral or improper purposes, or on pages containing illegal, immoral or improper material. The Work is subject to applicable export laws. You agree to comply with all such laws and regulations that may apply to the Work after Your receipt of the Work.

5 Representations, Warranties and Disclaimer. THIS WORK IS PROVIDED "AS IS", "WHERE IS" AND "AS AVAILABLE", WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES OR CONDITIONS OR GUARANTEES. YOU, THE USER, ASSUME ALL RISK IN ITS USE, INCLUDING COPYRIGHT INFRINGEMENT, PATENT INFRINGEMENT, SUITABILITY, ETC. AUTHOR EXPRESSLY DISCLAIMS ALL EXPRESS, IMPLIED OR STATUTORY WARRANTIES OR CONDITIONS, INCLUDING WITHOUT LIMITATION, WARRANTIES OR CONDITIONS OF MERCHANTABILITY, MERCHANTABLE QUALITY OR FITNESS FOR A PARTICULAR PURPOSE, OR ANY WARRANTY OF TITLE OR NON-INFRINGEMENT, OR THAT THE WORK (OR ANY PORTION THEREOF) IS CORRECT, USEFUL, BUG-FREE OR FREE OF VIRUSES. YOU MUST PASS THIS DISCLAIMER ON WHENEVER YOU DISTRIBUTE THE WORK OR DERIVATIVE WORKS.

6 Indemnity. You agree to defend, indemnify and hold harmless the Author and the Publisher from and against any claims, suits, losses, damages, liabilities, costs, and expenses (including reasonable legal or attorneys’ fees) resulting from or relating to any use of the Work by You.

7 Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL THE AUTHOR OR THE PUBLISHER BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK OR OTHERWISE, EVEN IF THE AUTHOR OR THE PUBLISHER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

8 Termination.

a This License and the rights granted hereunder will terminate automatically upon any breach by You of any term of this License. Individuals or entities who have received Derivative Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, 8, 9 and 10 will survive any termination of this License.

b Subject to the above terms and conditions, this License is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, the Author reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.

9 Publisher. The parties hereby confirm that the Publisher shall not, under any circumstances, be responsible for and shall not have any liability in respect of the subject matter of this License. The Publisher makes no warranty whatsoever in connection with the Work and shall not be liable to You or any party on any legal theory for any damages whatsoever, including without limitation any general, special, incidental or consequential damages arising in connection to this license. The Publisher reserves the right to cease making the Work available to You at any time without notice

10 Miscellaneous


63

a This License shall be governed by the laws of the location of the head office of the Author or if the Author is an individual, the laws of location of the principal place of residence of the Author.

b If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this License, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

c No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.

d This License constitutes the entire agreement between the parties with respect to the Work licensed herein. There are no understandings, agreements or representations with respect to the Work not specified herein. The Author shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Author and You.

The following software may be included in this product: SQLite. Use of any of this software is governed by the terms of the following license(s):

SQLite Copyright

SQLite is in the Public Domain

All of the deliverable code in SQLite has been dedicated to the public domain by the authors. All code authors, and representatives of the companies they work for, have signed affidavits dedicating their contributions to the public domain and originals of those signed affidavits are stored in a firesafe at the main offices of Hwaci. Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original SQLite code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

The previous paragraph applies to the deliverable code in SQLite - those parts of the SQLite library that you actually bundle and ship with a larger application. Portions of the documentation and some code used as part of the build process might fall under other licenses. The details here are unclear. We do not worry about the licensing of the documentation and build code so much because none of these things are part of the core deliverable SQLite library.

All of the deliverable code in SQLite has been written from scratch. No code has been taken from other projects or from the open internet. Every line of code can be traced back to its original author, and all of those authors have public domain dedications on file. So the SQLite code base is clean and is uncontaminated with licensed code from other projects.

The following software may be included in this product: JPEG6. Use of any of this software is governed by the terms of the following license(s):

The Independent JPEG Group's JPEG software

README for release 6b of 27-Mar-1998

This distribution contains the sixth public release of the Independent JPEG Group's free JPEG software. You are welcome to redistribute this software and to use it for any purpose, subject to the conditions under LEGAL ISSUES, below.

Serious users of this software (particularly those incorporating it into larger programs) should contact IJG at [email protected] to be added to our electronic mailing list. Mailing list members are notified of updates and have a chance to participate in technical discussions, etc.

This software is the work of Tom Lane, Philip Gladstone, Jim Boucher, Lee Crocker, Julian Minguillon, Luis Ortiz, George Phillips, Davide Rossi, Guido Vollbeding, Ge' Weijers, and other members of the Independent JPEG Group.


64

IJG is not affiliated with the official ISO JPEG standards committee.

DOCUMENTATION ROADMAPThis file contains the following sections:

Other documentation files in the distribution are:

User documentation:

Programmer and internal documentation

Please read at least the files install.doc and usage.doc. Useful information can also be found in the JPEG FAQ (Frequently Asked Questions) article. See ARCHIVE LOCATIONS below to find out where to obtain the FAQ article.

If you want to understand how the JPEG code works, we suggest reading one or more of the REFERENCES, then looking at the documentation files (in roughly the order listed) before diving into the code.

OVERVIEW General description of JPEG and the IJG software.

LEGAL ISSUES Copyright, lack of warranty, terms of distribution.

REFERENCES Where to learn more about JPEG.

ARCHIVE LOCATIONS Where to find newer versions of this software.

RELATED SOFTWARE Other stuff you should get.

FILE FORMAT WARS Software *not* to get.

TO DO Plans for future IJG releases.

install.doc How to configure and install the IJG software.

usage.doc Usage instructions for cjpeg, djpeg, jpegtran, rdjpgcom, and wrjpgcom.

*.1 Unix-style man pages for programs (same info as usage.doc).

wizard.doc Advanced usage instructions for JPEG wizards only.

change.log Version-to-version change highlights.

libjpeg.doc How to use the JPEG library in your own programs.

example.c Sample code for calling the JPEG library.

structure.doc Overview of the JPEG library's internal structure.

filelist.doc Road map of IJG files.

coderules.doc Coding style rules --- please read if you contribute code.


65

Overview

This package contains C software to implement JPEG image compression and decompression. JPEG (pronounced "jay-peg") is a standardized compression method for full-color and gray-scale images. JPEG is intended for compressing "real-world" scenes; line drawings, cartoons and other non-realistic images are not its strong suit. JPEG is lossy, meaning that the output image is not exactly identical to the input image. Hence you must not use JPEG if you have to have identical output bits. However, on typical photographic images, very good compression levels can be obtained with no visible change, and remarkably high compression levels are possible if you can tolerate a low-quality image. For more details, see the references, or just experiment with various compression settings.

This software implements JPEG baseline, extended-sequential, and progressive compression processes. Provision is made for supporting all variants of these processes, although some uncommon parameter settings aren't implemented yet. For legal reasons, we are not distributing code for the arithmetic-coding variants of JPEG; see LEGAL ISSUES. We have made no provision for supporting the hierarchical or lossless processes defined in the standard.

We provide a set of library routines for reading and writing JPEG image files, plus two sample applications "cjpeg" and "djpeg", which use the library to perform conversion between JPEG and some other popular image file formats. The library is intended to be reused in other applications.

In order to support file conversion and viewing software, we have included considerable functionality beyond the bare JPEG coding/decoding capability; for example, the color quantization modules are not strictly part of JPEG decoding, but they are essential for output to colormapped file formats or colormapped displays. These extra functions can be compiled out of the library if not required for a particular application. We have also included "jpegtran", a utility for lossless transcoding between different JPEG processes, and "rdjpgcom" and "wrjpgcom", two simple applications for inserting and extracting textual comments in JFIF files.

The emphasis in designing this software has been on achieving portability and flexibility, while also making it fast enough to be useful. In particular, the software is not intended to be read as a tutorial on JPEG. (See the REFERENCES section for introductory material.) Rather, it is intended to be reliable, portable, industrial-strength code. We do not claim to have achieved that goal in every aspect of the software, but we strive for it.

We welcome the use of this software as a component of commercial products. No royalty is required, but we do ask for an acknowledgement in product documentation, as described under LEGAL ISSUES.

LEGAL ISSUES

In plain English:

11 We don't promise that this software works. (But if you find any bugs, please let us know!)

12 You can use this software for whatever you want. You don't have to pay us.

13 You may not pretend that you wrote this software. If you use it in a program, you must acknowledge somewhere in your documentation that you've used the IJG code.

In legalese:

The authors make NO WARRANTY or representation, either express or implied, with respect to this software, its quality, accuracy, merchantability, or fitness for a particular purpose. This software is provided "AS IS", and you, its user, assume the entire risk as to its quality and accuracy.

This software is copyright (C) 1991-1998, Thomas G. Lane.

All Rights Reserved except as specified below.


66

Permission is hereby granted to use, copy, modify, and distribute this software (or portions thereof) for any purpose, without fee, subject to these conditions:

1 If any part of the source code for this software is distributed, then this README file must be included, with this copyright and no-warranty notice unaltered; and any additions, deletions, or changes to the original files must be clearly indicated in accompanying documentation.

2 If only executable code is distributed, then the accompanying documentation must state that "this software is based in part on the work of the Independent JPEG Group".

3 Permission for use of this software is granted only if the user accepts full responsibility for any undesirable consequences; the authors accept NO LIABILITY for damages of any kind.

These conditions apply to any software derived from or based on the IJG code, not just to the unmodified library. If you use our work, you ought to acknowledge us.

Permission is NOT granted for the use of any IJG author's name or company name in advertising or publicity relating to this software or products derived from it. This software may be referred to only as "the Independent JPEG Group's software".

We specifically permit and encourage the use of this software as the basis of commercial products, provided that all warranty or liability claims are assumed by the product vendor.

ansi2knr.c is included in this distribution by permission of L. Peter Deutsch, sole proprietor of its copyright holder, Aladdin Enterprises of Menlo Park, CA. ansi2knr.c is NOT covered by the above copyright and conditions, but instead by the usual distribution terms of the Free Software Foundation; principally, that you must include source code if you redistribute it. (See the file ansi2knr.c for full details.) However, since ansi2knr.c is not needed as part of any program generated from the IJG code, this does not limit you more than the foregoing paragraphs do.

The Unix configuration script "configure" was produced with GNU Autoconf. It is copyright by the Free Software Foundation but is freely distributable. The same holds for its supporting scripts (config.guess, config.sub, ltconfig, ltmain.sh). Another support script, install-sh, is copyright by M.I.T. but is also freely distributable.

It appears that the arithmetic coding option of the JPEG spec is covered by patents owned by IBM, AT&T, and Mitsubishi. Hence arithmetic coding cannot legally be used without obtaining one or more licenses. For this reason, support for arithmetic coding has been removed from the free JPEG software. (Since arithmetic coding provides only a marginal gain over the unpatented Huffman mode, it is unlikely that very many implementations will support it.) So far as we are aware, there are no patent restrictions on the remaining code.

The IJG distribution formerly included code to read and write GIF files. To avoid entanglement with the Unisys LZW patent, GIF reading support has been removed altogether, and the GIF writer has been simplified to produce "uncompressed GIFs". This technique does not use the LZW algorithm; the resulting GIF files are larger than usual, but are readable by all standard GIF decoders.

We are required to state that

"The Graphics Interchange Format(c) is the Copyright property of CompuServe Incorporated. GIF(sm) is a Service Mark property of CompuServe Incorporated."

REFERENCES

We highly recommend reading one or more of these references before trying to understand the innards of the JPEG software.

The best short technical introduction to the JPEG compression algorithm is:


67

Wallace, Gregory K. "The JPEG Still Picture Compression Standard",

Communications of the ACM, April 1991 (vol. 34 no. 4), pp. 30-44.

(Adjacent articles in that issue discuss MPEG motion picture compression, applications of JPEG, and related topics.) If you don't have the CACM issue handy, a PostScript file containing a revised version of Wallace's article is available at ftp://ftp.uu.net/graphics/jpeg/wallace.ps.gz. The file (actually a preprint for an article that appeared in IEEE Trans. Consumer Electronics) omits the sample images that appeared in CACM, but it includes corrections and some added material. Note: the Wallace article is copyright ACM and IEEE, and it may not be used for commercial purposes.

A somewhat less technical, more leisurely introduction to JPEG can be found in "The Data Compression Book" by Mark Nelson and Jean-loup Gailly, published by M&T Books (New York), 2nd ed. 1996, ISBN 1-55851-434-1. This book provides good explanations and example C code for a multitude of compression methods including JPEG. It is an excellent source if you are comfortable reading C code but don't know much about data compression in general. The book's JPEG sample code is far from industrial-strength, but when you are ready to look at a full implementation, you've got one here...

The best full description of JPEG is the textbook "JPEG Still Image Data Compression Standard" by William B. Pennebaker and Joan L. Mitchell, published by Van Nostrand Reinhold, 1993, ISBN 0-442-01272-1. Price US$59.95, 638 pp. The book includes the complete text of the ISO JPEG standards (DIS 10918-1 and draft DIS 10918-2). This is by far the most complete exposition of JPEG in existence, and we highly recommend it.

The JPEG standard itself is not available electronically; you must order a paper copy through ISO or ITU. (Unless you feel a need to own a certified official copy, we recommend buying the Pennebaker and Mitchell book instead; it's much cheaper and includes a great deal of useful explanatory material.) In the USA, copies of the standard may be ordered from ANSI Sales at (212) 642-4900, or from Global Engineering Documents at (800) 854-7179. (ANSI doesn't take credit card orders, but Global does.) It's not cheap: as of 1992, ANSI was charging $95 for Part 1 and $47 for Part 2, plus 7% shipping/handling. The standard is divided into two parts, Part 1 being the actual specification, while Part 2 covers compliance testing methods. Part 1 is titled "Digital Compression and Coding of Continuous-tone Still Images, Part 1: Requirements and guidelines" and has document numbers ISO/IEC IS 10918-1, ITU-T T.81. Part 2 is titled "Digital Compression and Coding of Continuous-tone Still Images, Part 2: Compliance testing" and has document numbers ISO/IEC IS 10918-2, ITU-T T.83.

Some extensions to the original JPEG standard are defined in JPEG Part 3, a newer ISO standard numbered ISO/IEC IS 10918-3 and ITU-T T.84. IJG currently does not support any Part 3 extensions.

The JPEG standard does not specify all details of an interchangeable file format. For the omitted details we follow the "JFIF" conventions, revision 1.02. A copy of the JFIF spec is available from:

Literature Department

C-Cube Microsystems, Inc.

1778 McCarthy Blvd.

Milpitas, CA 95035

phone (408) 944-6300, fax (408) 944-6314

A PostScript version of this document is available by FTP at ftp://ftp.uu.net/graphics/jpeg/jfif.ps.gz. There is also a plain text version at ftp://ftp.uu.net/graphics/jpeg/jfif.txt.gz, but it is missing the figures.

The TIFF 6.0 file format specification can be obtained by FTP from ftp://ftp.sgi.com/graphics/tiff/TIFF6.ps.gz. The JPEG incorporation scheme found in the TIFF 6.0 spec of 3-June-92 has a number of serious problems. IJG does not recommend use of the TIFF 6.0 design (TIFF Compression tag 6). Instead, we recommend the JPEG design proposed by TIFF Technical Note #2 (Compression tag 7). Copies of this Note can be obtained from ftp.sgi.com or from ftp://


68

ftp.uu.net/graphics/jpeg/. It is expected that the next revision of the TIFF spec will replace the 6.0 JPEG design with the Note's design. Although IJG's own code does not support TIFF/JPEG, the free libtiff library uses our library to implement TIFF/JPEG per the Note. libtiff is available from ftp://ftp.sgi.com/graphics/tiff/.

ARCHIVE LOCATIONS

The "official" archive site for this software is ftp.uu.net (Internet address 192.48.96.9). The most recent released version can always be found there in directory graphics/jpeg. This particular version will be archived as ftp://ftp.uu.net/graphics/jpeg/jpegsrc.v6b.tar.gz. If you don't have direct Internet access, UUNET's archives are also available via UUCP; contact [email protected] for information on retrieving files that way.

Numerous Internet sites maintain copies of the UUNET files. However, only ftp.uu.net is guaranteed to have the latest official version.

You can also obtain this software in DOS-compatible "zip" archive format from the SimTel archives (ftp://ftp.simtel.net/pub/simtelnet/msdos/graphics/), or on CompuServe in the Graphics Support forum (GO CIS:GRAPHSUP), library 12 "JPEG Tools". Again, these versions may sometimes lag behind the ftp.uu.net release.

The JPEG FAQ (Frequently Asked Questions) article is a useful source of general information about JPEG. It is updated constantly and therefore is not included in this distribution. The FAQ is posted every two weeks to Usenet newsgroups comp.graphics.misc, news.answers, and other groups. It is available on the World Wide Web at http://www.faqs.org/faqs/jpeg-faq/ and other news.answers archive sites, including the official news.answers archive at rtfm.mit.edu: ftp://rtfm.mit.edu/pub/usenet/news.answers/jpeg-faq/. If you don't have Web or FTP access, send e-mail to [email protected] with body

send usenet/news.answers/jpeg-faq/part1

send usenet/news.answers/jpeg-faq/part2

RELATED SOFTWARE

Numerous viewing and image manipulation programs now support JPEG. (Quite a few of them use this library to do so.) The JPEG FAQ described above lists some of the more popular free and shareware viewers, and tells where to obtain them on Internet.

If you are on a Unix machine, we highly recommend Jef Poskanzer's free PBMPLUS software, which provides many useful operations on PPM-format image files. In particular, it can convert PPM images to and from a wide range of other formats, thus making cjpeg/djpeg considerably more useful. The latest version is distributed by the NetPBM group, and is available from numerous sites, notably ftp://wuarchive.wustl.edu/graphics/graphics/packages/NetPBM/. Unfortunately PBMPLUS/NETPBM is not nearly as portable as the IJG software is; you are likely to have difficulty making it work on any non-Unix machine.

A different free JPEG implementation, written by the PVRG group at Stanford, is available from ftp://havefun.stanford.edu/pub/jpeg/. This program is designed for research and experimentation rather than production use; it is slower, harder to use, and less portable than the IJG code, but it is easier to read and modify. Also, the PVRG code supports lossless JPEG, which we do not. (On the other hand, it doesn't do progressive JPEG.)

FILE FORMAT WARS

Some JPEG programs produce files that are not compatible with our library. The root of the problem is that the ISO JPEG committee failed to specify a concrete file format. Some vendors "filled in the blanks" on their own, creating proprietary formats that no one else could read. (For example, none of the early commercial JPEG implementations for the Macintosh were able to exchange compressed files.)


69

The file format we have adopted is called JFIF (see REFERENCES). This format has been agreed to by a number of major commercial JPEG vendors, and it has become the de facto standard. JFIF is a minimal or "low end" representation. We recommend the use of TIFF/JPEG (TIFF revision 6.0 as modified by TIFF Technical Note #2) for "high end" applications that need to record a lot of additional data about an image. TIFF/JPEG is fairly new and not yet widely supported, unfortunately.

The upcoming JPEG Part 3 standard defines a file format called SPIFF. SPIFF is interoperable with JFIF, in the sense that most JFIF decoders should be able to read the most common variant of SPIFF. SPIFF has some technical advantages over JFIF, but its major claim to fame is simply that it is an official standard rather than an informal one. At this point it is unclear whether SPIFF will supersede JFIF or whether JFIF will remain the de-facto standard. IJG intends to support SPIFF once the standard is frozen, but we have not decided whether it should become our default output format or not. (In any case, our decoder will remain capable of reading JFIF indefinitely.)

Various proprietary file formats incorporating JPEG compression also exist. We have little or no sympathy for the existence of these formats. Indeed, one of the original reasons for developing this free software was to help force convergence on common, open format standards for JPEG files. Don't use a proprietary file format!

TO DO

The major thrust for v7 will probably be improvement of visual quality. The current method for scaling the quantization tables is known not to be very good at low Q values. We also intend to investigate block boundary smoothing, "poor man's variable quantization", and other means of improving quality-vs-file-size performance without sacrificing compatibility.

In future versions, we are considering supporting some of the upcoming JPEG Part 3 extensions --- principally, variable quantization and the SPIFF file format.

As always, speeding things up is of great interest.

Please send bug reports, offers of help, etc. to [email protected].

The following software may be included in this product: ZIP Libraries. Use of any of this software is governed by the terms of the following license(s):

Original authors' comments

This is version 2002-Feb-16 of the Info-ZIP copyright and license. The definitive version of this document should be available at ftp:ftp.info-zip.org/pub/infozip/license.html indefinitely.

Copyright (c) 1990-2002 Info-ZIP. All rights reserved.

For the purposes of this copyright and license, "Info-ZIP" is defined as the following set of individuals:

Mark Adler, John Bush, Karl Davis, Harald Denker, Jean-Michel Dubois, Jean-loup Gailly, Hunter Goatley, Ian Gorman, Chris Herborth, Dirk Haase, Greg Hartwig, Robert Heath, Jonathan Hudson, Paul Kienitz, David Kirschbaum, Johnny Lee, Onno van der Linden, Igor Mandrichenko, Steve P. Miller, Sergio Monesi, Keith Owens, George Petrov, Greg Roelofs, Kai Uwe Rommel, Steve Salisbury, Dave Smith, Christian Spieler, Antoine Verheijen, Paul von Behren, Rich Wales, Mike White

This software is provided "as is", without warranty of any kind, express or implied. In no event shall Info-ZIP or its contributors be held liable for any direct, indirect, incidental, special or consequential damages arising out of the use of or inability to use this software.


70

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

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

2 Redistributions in binary form (compiled executables) must reproduce the above copyright notice, definition, disclaimer, and this list of conditions in documentation and/or other materials provided with the distribution. The sole exception to this condition is redistribution of a standard UnZipSFX binary as part of a self-extracting archive; that is permitted without inclusion of this license, as long as the normal UnZipSFX banner has not been removed from the binary or disabled.

3 Altered versions--including, but not limited to, ports to new operating systems, existing ports with new graphical interfaces, and dynamic, shared, or static library versions--must be plainly marked as such and must not be misrepresented as being the original source. Such altered versions also must not be misrepresented as being Info-ZIP releases--including, but not limited to, labeling of the altered versions with the names "Info-ZIP" (or any variation thereof, including, but not limited to, different capitalizations), "Pocket UnZip", "WiZ" or "MacZip" without the explicit permission of Info-ZIP. Such altered versions are further prohibited from misrepresentative use of the Zip-Bugs or Info-ZIP e-mail addresses or of the Info-ZIP URL(s).

4 Info-ZIP retains the right to use the names "Info-ZIP", "Zip", "UnZip", "UnZipSFX", "WiZ", "Pocket UnZip", "Pocket Zip", and "MacZip" for its own source and binary releases.

The following software may be included in this product: AES Encryption. Use of any of this software is governed by the terms of the following license(s):

Copyright (c) 2003, Dr Brian Gladman <[email protected]>, Worcester, UK.

All rights reserved.

LICENSE TERMS

The free distribution and use of this software in both source and binary form is allowed (with or without changes) provided that:

1 distributions of this source code include the above copyright notice, this list of conditions and the following disclaimer;

2 distributions in binary form include the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other associated materials;

3 the copyright holder's name is not used to endorse products built using this software without specific written permission.

ALTERNATIVELY, provided that this notice is retained in full, this product may be distributed under the terms of the GNU General Public License (GPL), in which case the provisions of the GPL apply INSTEAD OF those given above.

DISCLAIMER

This software is provided 'as is' with no explicit or implied warranties in respect of its properties, including, but not limited to, correctness and/or fitness for purpose.

Issue Date: 26/08/2003

This file contains the definitions required to use AES in C. See aesopt.h for optimisation details.*/


71

The following software may be included in this product: openSSL. Use of any of this software is governed by the terms of the following license(s):

LICENSE ISSUESThe OpenSSL toolkit stays under a dual license, i.e. both the conditions of the OpenSSL License and the original SSLeay license apply to the toolkit. See below for the actual license texts. Actually both licenses are BSD-style Open Source licenses. In case of any license issues related to OpenSSL please contact [email protected].

OpenSSL License

Copyright (c) 1998-2011 The OpenSSL Project. All rights reserved.

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 All advertising materials mentioning features or use of this software must display the following acknowledgment: "This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org/)"

4 The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact [email protected].

5 Products derived from this software may not be called "OpenSSL" nor may "OpenSSL" appear in their names without prior written permission of the OpenSSL Project.

6 Redistributions of any form whatsoever must retain the following acknowledgment: "This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/)"

THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY EXPRESSED 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 OpenSSL PROJECT OR ITS CONTRIBUTORS 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 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.

This product includes cryptographic software written by Eric Young ([email protected]). This product includes software written by Tim Hudson ([email protected]).

Original SSLeay License

Copyright (C) 1995-1998 Eric Young ([email protected]) All rights reserved.


72

This package is an SSL implementation written by Eric Young ([email protected]). The implementation was written so as to conform with Netscapes SSL.

This library is free for commercial and non-commercial use as long as the following conditions are aheared to. The following conditions apply to all code found in this distribution, be it the RC4, RSA, lhash, DES, etc., code; not just the SSL code. The SSL documentation included with this distribution is covered by the same copyright terms except that the holder is Tim Hudson ([email protected]).

Copyright remains Eric Young's, and as such any Copyright notices in the code are not to be removed. If this package is used in a product, Eric Young should be given attribution as the author of the parts of the library used. This can be in the form of a textual message at program startup or in documentation (online or textual) provided with the package.


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


3 All advertising materials mentioning features or use of this software must display the following acknowledgement:

"This product includes cryptographic software written by Eric Young ([email protected])" The word 'cryptographic' can be left out if the rouines from the library being used are not cryptographic related :-).

4 If you include any Windows specific code (or a derivative thereof) from the apps directory (application code) you must include an acknowledgement:

"This product includes software written by Tim Hudson ([email protected])"

THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``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 OR CONTRIBUTORS 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 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.

The licence and distribution terms for any publically available version or derivative of this code cannot be changed. i.e. this code cannot simply be copied and put under another distribution licence [including the GNU Public Licence.]

The following software may be included in this product: Zlib 1.1.3. Use of any of this software is governed by the terms of the following license(s):

zlib 1.1.3 is a general purpose data compression library. All the code is thread safe. The data format used by the zlib library is described by RFCs (Request for Comments) 1950 to 1952 in the files ftp://ds.internic.net/rfc/rfc1950.txt (zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format). These documents are also available in other formats from ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html

All functions of the compression library are documented in the file zlib.h (volunteer to write man pages welcome, contact [email protected]). A usage example of the library is given in the file example.c which also tests that the library is working correctly. Another example is given in the file minigzip.c. The compression library itself is composed of all source files except example.c and minigzip.c.


73

To compile all files and run the test program, follow the instructions given at the top of Makefile. In short "make test; make install" should work for most machines. For Unix: "configure; make test; make install" For MSDOS, use one of the special makefiles such as Makefile.msc. For VMS, use Make_vms.com or descrip.mms.

Questions about zlib should be sent to <[email protected]>, or to Gilles Vollant <[email protected]> for the Windows DLL version. The zlib home page is http://www.cdrom.com/pub/infozip/zlib/ The official zlib ftp site is ftp://ftp.cdrom.com/pub/infozip/zlib/ Before reporting a problem, please check those sites to verify that you have the latest version of zlib; otherwise get the latest version and check whether the problem still exists or not.

Mark Nelson <[email protected]> wrote an article about zlib for the Jan. 1997 issue of Dr. Dobb's Journal; a copy of the article is available in http://web2.airmail.net/markn/articles/zlibtool/zlibtool.htm

The changes made in version 1.1.3 are documented in the file ChangeLog. The main changes since 1.1.2 are:

• fix "an inflate input buffer bug that shows up on rare but persistent occasions" (Mark)

• fix gzread and gztell for concatenated .gz files (Didier Le Botlan)

• fix gzseek(..., SEEK_SET) in write mode

• fix crc check after a gzeek (Frank Faubert)

• fix miniunzip when the last entry in a zip file is itself a zip file (J Lillge)

• add contrib/asm586 and contrib/asm686 (Brian Raiter) See http://www.muppetlabs.com/~breadbox/software/assembly.html

• add support for Delphi 3 in contrib/delphi (Bob Dellaca)

• add support for C++Builder 3 and Delphi 3 in contrib/delphi2 (Davide Moretti)

• do not exit prematurely in untgz if 0 at start of block (Magnus Holmgren)

• use macro EXTERN instead of extern to support DLL for BeOS (Sander Stoks)

• added a FAQ file

plus many changes for portability.

Unsupported third party contributions are provided in directory "contrib".

A Java implementation of zlib is available in the Java Development Kit 1.1 http://www.javasoft.com/products/JDK/1.1/docs/api/Package-java.util.zip.html See the zlib home page http://www.cdrom.com/pub/infozip/zlib/ for details.

A Perl interface to zlib written by Paul Marquess <[email protected]> is in the CPAN (Comprehensive Perl Archive Network) sites, such as: ftp://ftp.cis.ufl.edu/pub/perl/CPAN/modules/by-module/Compress/Compress-Zlib*

A Python interface to zlib written by A.M. Kuchling <[email protected]> is available in Python 1.5 and later versions, see http://www.python.org/doc/lib/module-zlib.html

A zlib binding for TCL written by Andreas Kupries <[email protected]> is availlable at http://www.westend.com/~kupries/doc/trf/man/man.html

An experimental package to read and write files in .zip format, written on top of zlib by Gilles Vollant <[email protected]>, is available at http://www.winimage.com/zLibDll/unzip.html and also in the contrib/minizip directory of zlib.

Notes for some targets:

• To build a Windows DLL version, include in a DLL project zlib.def, zlib.rc and all .c files except example.c and minigzip.c; compile with -DZLIB_DLL The zlib DLL support was initially done by Alessandro Iacopetti and is


74

now maintained by Gilles Vollant <[email protected]>. Check the zlib DLL home page at http://www.winimage.com/zLibDll

From Visual Basic, you can call the DLL functions which do not take a structure as argument: compress, uncompress and all gz* functions. See contrib/visual-basic.txt for more information, or get http://www.tcfb.com/dowseware/cmp-z-it.zip

• For 64-bit Irix, deflate.c must be compiled without any optimization. With -O, one libpng test fails. The test works in 32 bit mode (with the -n32 compiler flag). The compiler bug has been reported to SGI.

• zlib doesn't work with gcc 2.6.3 on a DEC 3000/300LX under OSF/1 2.1 it works when compiled with cc.

• on Digital Unix 4.0D (formely OSF/1) on AlphaServer, the cc option -std1 is necessary to get gzprintf working correctly. This is done by configure.

• zlib doesn't work on HP-UX 9.05 with some versions of /bin/cc. It works with other compilers. Use "make test" to check your compiler.

• gzdopen is not supported on RISCOS, BEOS and by some Mac compilers.

• For Turbo C the small model is supported only with reduced performance to avoid any far allocation; it was tested with -DMAX_WBITS=11 -DMAX_MEM_LEVEL=3

• For PalmOs, see http://www.cs.uit.no/~perm/PASTA/pilot/software.html Per Harald Myrvang <[email protected]>

Acknowledgments:

The deflate format used by zlib was defined by Phil Katz. The deflate and zlib specifications were written by L. Peter Deutsch. Thanks to all the people who reported problems and suggested various improvements in zlib; they are too numerous to cite here.

Copyright notice:

(C) 1995-1998 Jean-loup Gailly and Mark Adler

This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

1 The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.

2 Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.

3 This notice may not be removed or altered from any source distribution.

Jean-loup Gailly Mark Adler

[email protected] [email protected]

If you use the zlib library in a product, we would appreciate *not* receiving lengthy legal documents to sign. The sources are provided for free but without warranty of any kind. The library has been entirely written by Jean-loup Gailly and Mark Adler; it does not include third-party code.


75

If you redistribute modified sources, we would appreciate that you include in the file ChangeLog history information documenting your changes.

The following software may be included in this product: EEBase64. Use of any of this software is governed by the terms of the following license(s):

C_Base64 - a simple base64 encoder and decoder.

Copyright (c) 1999, Bob Withers - [email protected]

This code may be freely used for any purpose, either personal or commercial, provided the authors copyright notice remains intact.

The following software may be included in this product: Bouncy. Use of any of this software is governed by the terms of the following license(s):

Copyright (c) 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.

The following software may be included in this product: LibTiff. Use of any of this software is governed by the terms of the following license(s):

Copyright (c) 1988-1997 Sam Leffler

Copyright (c) 1991-1997 Silicon Graphics, Inc.

Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that (i) the above copyright notices and this permission notice appear in all copies of the software and related documentation, and (ii) the names of Sam Leffler and Silicon Graphics may not be used in any advertising or publicity relating to the software without the specific, prior written permission of Sam Leffler and Silicon Graphics.

THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.


76

IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

The following software may be included in this product: PCRE. Use of any of this software is governed by the terms of the following license(s):

PCRE LICENCEPCRE is a library of functions to support regular expressions whose syntax and semantics are as close as possible to those of the Perl 5 language.

Written by: Philip Hazel <[email protected]>

University of Cambridge Computing Service,

Cambridge, England. Phone: +44 1223 334714.

Copyright (c) 1997-2000 University of Cambridge

Permission is granted to anyone to use this software for any purpose on any computer system, and to redistribute it freely, subject to the following restrictions:

1 This software 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.

2 The origin of this software must not be misrepresented, either by explicit claim or by omission. In practice, this means that if you use PCRE in software which you distribute to others, commercially or otherwise, you must put a sentence like this

Regular expression support is provided by the PCRE library package, which is open source software, written by Philip Hazel, and copyright by the University of Cambridge, England.

somewhere reasonably visible in your documentation and in any relevant files or online help data or similar. A reference to the ftp site for the source, that is, to

ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/

should also be given in the documentation.

3 Altered versions must be plainly marked as such, and must not be misrepresented as being the original software.

4 If PCRE is embedded in any software that is released under the GNU General Purpose Licence (GPL), then the terms of that licence shall supersede any condition above with which it is incompatible.

End

The following software may be included in this product: AES Encryption-Google. Use of any of this software is governed by the terms of the following license(s):

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.


77


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 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.

The following software may be included in this product: SAX XML Parsing. Use of any of this software is governed by the terms of the following license(s):

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

Copyright Status

SAX is free!

In fact, it's not possible to own a license to SAX, since it's been placed in the 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


78

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

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

The following software may be included in this product: GNU Classpath. Use of any of this software is governed by the terms of the following license(s):

These packages contain the following copyright notice and license terms

Copyright (C) 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 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.

GNU General Public License Version 2General information:

http://www.gnu.org/copyleft/gpl.html

Copyright 1989, 1991 Free Software Foundation, Inc.

The GNU General Public License (GPL) Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA


79

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

For information about the GPL, click here.

Preamble

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 Library 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.

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

0. 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 theProgram does.

1 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


80

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.

2 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 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.

3 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


81

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.

4 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.

5 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.

6 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.

7 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.

8 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.

9 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.


82

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.

10 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

11 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 YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

12 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.

END OF TERMS AND CONDITIONS

How to Apply These Terms to Your New ProgramsIf you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the 'copyright' line and a pointer to where the full notice is found.

one line to give the program's name and a brief idea of what it does. Copyright (C)

This program 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 of the License, or (at your option) any later version.

This program 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.


83

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

Also add information on how to contact you by electronic and paper mail.

If the program is interactive, make it output a short notice like this when it starts in an interactive mode:

Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program.

You should also get your employer (if you work as a programmer) or your school, if any, to sign a 'copyright disclaimer' for the program, if necessary. Here is a sample; alter the names:

Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker.

signature of Ty Coon, 1 April 1989 Ty Coon, President of Vice

This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License.

The following software may be included in this product: Sun Java Collections v1.1. Use of any of this software is governed by the terms of the following license(s):

The standard Java Collections v1.1 (com.sun.java.util.collections.*) is copyright (c) 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 subpackages 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


84

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.

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.


85

The following software may be included in this product: kxml2. Use of any of this software is governed by the terms of the following license(s):

kXML 2 license can be found at: <https://github.com/karlmdavis/kxml2/blob/master/license.txt>

Copyright (c) 2002,2003, Stefan Haustein, Oberhausen, Rhld., Germany

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.

The following software may be included in this product: OpenLDAP. Use of any of this software is governed by the terms of the following license(s):

The OpenLDAP Public License

Version 2.0.1, 21 December 1999

Copyright 1999, The OpenLDAP Foundation, Redwood City, California, USA.

All Rights Reserved.

Redistribution and use of this software and associated documentation ("Software"), with or without modification, are permitted provided that the following conditions are met:

1 Redistributions of source code must retain copyright statements and notices. Redistributions must also contain a copy of this document.


3 The name "OpenLDAP" must not be used to endorse or promote products derived from this Software without prior written permission of the OpenLDAP Foundation. For written permission, please contact [email protected].

4 Products derived from this Software may not be called "OpenLDAP" nor may "OpenLDAP" appear in their names without prior written permission of the OpenLDAP Foundation. OpenLDAP is a trademark of the OpenLDAP Foundation.

5 Due credit should be given to the OpenLDAP Project (http://www.openldap.org/).

THIS SOFTWARE IS PROVIDED BY THE OPENLDAP FOUNDATION AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED 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 OPENLDAP FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,


86

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 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.


87

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 Lexmark 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.

Authorization The process by which an authenticated user is permitted or denied access to a device function.

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.


88

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.

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 Lexmark 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 Lexmark 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

Equitrac Embedded for Lexmark - Kofax

Documents

Transcript of Equitrac Embedded for Lexmark - Kofax