Equitrac Professional 5.7 Installation Guide Professional Installation Guide 5 Introduction Equitrac Professional measures, monitors, and manages document output on your network for

Equitrac Professional5.7

Installation Guide

2 Equitrac Professional Installation Guide

Equitrac Professional Installation GuideDocument History

© 2015 Nuance Communications, Inc. All rights reserved.

All rights to this document, domestic and international, are reserved by Nuance Communications, Inc. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise) without prior written permission of Nuance.

Trademarks

Equitrac®, Equitrac Professional®, PageCounter®, PageCounter Professional®, SmartPrompt®, Follow-You Printing®, and TouchPoint Console® are trademarks of Nuance Communications, Inc.

All other brands and their products are trademarks or registered trademarks of their respective holders, and should be noted as such.

Symbols Used In This Guide

The following symbols are used in this guide:

Revision Date Revision List

February 26, 2015 Updated upgrade information for various software versions

February 6, 2015 Updated for software version 5.7

March 2014 Updated for software version 5.6

May 2012 Updated for software version 5.5

July 2011 Updated for software version 5.4

April 2010 Updated for software version 5.3.1

February 2010 Updated for software version 5.3

April 2009 Version 5.2.4

• Windows Server 2008 support.• Updated information about Web Interfaces Prerequisites.

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

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

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

Equitrac Professional Installation Guide 3

Contents

1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Equitrac Professional Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Core Server Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Administrative Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

System Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Device Monitoring Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Features and Optional Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Server System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Web Interfaces and .NET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Web Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Print Client System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Citrix Terminal Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Additional Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

2 Preparing for an Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Determining Component Install Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Single-server Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Distributed Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Preparing the Database Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Confirming Web Interface Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Configuring a Service Login User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Creating a User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Component Network Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Windows Server 2008 R2 Special Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

3 Deploying Server Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Single Server Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Single Server Installation Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Distributed Server Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Distributed Server Installation Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Installing the Server Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Configuring the Equitrac Professional Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

SQL Server Express Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28SQL Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Applying Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

If Licensing Fails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31If the Serial Number is Denied . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Contents


Configuring Virus Scanning Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Server Folders to Exclude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32File Extensions to Exclude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Confirming Single Sign-On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

IIS Version 7.0 and above . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Configuring SPE Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

4 Updating Control Device Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Upgrading TouchPoint Console Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Before you start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Updating the firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Upgrading PageCounter Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Configuring PageCounter CDR - DCE Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

5 Installing Print Client Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Installing the Print Client on Windows Workstations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Installing on a Single Workstation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Installing Silently on Multiple Workstations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Installing the Print Client on Macintosh Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Installing Equitrac Printer Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Installing the Macintosh Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Configuring Printers with the Equitrac Printer Utility X . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Remote Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

6 Upgrading Equitrac Professional . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Planning an Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Performing an Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Registry Keys for Remote Desktop Services Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Upgrading Macintosh Client Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

7 Uninstalling Equitrac Professional . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Uninstalling Server Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Restoring Printers to Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Uninstalling Client Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Windows - Local Uninstall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Macintosh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57


Introduction

Equitrac Professional measures, monitors, and manages document output on your network for the purpose of client bill-back. By regulating devices on the network and local desktop printers, Equitrac Professional tracks and controls photocopies, print jobs, scan jobs, faxes, disbursements and telephone charges with minimal administration.

TopicsCore Server Components

Administrative Applications

Features and Optional Components

Server System Requirements

Print Client System Requirements

Additional Documentation

1

Chapter 1: Introduction


Equitrac Professional ComponentsEquitrac Professional is comprised of both core and optional components. Core components are essential services and must be installed on a Windows server system. You can purchase optional components to customize the functionality to suit your needs. See Features and Optional Components on page 10 for a complete list.

CPS

DME

DCE

SPE

DRE

CAS

Data Source

Server Clustering

Interface Module

Release Station

Client Applications

Rules & Routing

3rd Party Transaction Integration

Time & Billing Integration

Rate Table Extensions

Core Server Components

Optional Components



Core Server ComponentsCore components can reside on a single server or you can deploy these components across multiple servers as outlined in Distributed Server Installation on page 25.

Core Component Description

Core Accounting Server (CAS + the Scheduler)

• verifies users, calculates copy, fax, scan and disbursement transaction charges, and assigns charges to an appropriate account

• calculates charges using page count and job attribute information• communicates with a database where Equitrac Professional stores account, device,

transaction and configuration details

Document Routing Engine (DRE) + the Equitrac Port Monitor

• routes network print jobs to the appropriate device• communicates with attached printers to determine size and attributes of each print

job; passes the information to the Core Accounting Server (CAS)• fully integrated with the Windows printing subsystem• enables the Port Monitor to receive and route print jobs to parallel or network-

connected printers

Note: If the Print Client is installed on a Terminal Services server, the DRE/Print server must be installed on a separate server.

Device Control Engine (DCE) • controls user workflow and data flow to devices such as Equitrac Embedded applications, TouchPoint Consoles and PageCounter terminals.

• communicates details about copies, faxes, disbursements and phone calls, collected at devices, to the Core Accounting Server (CAS)

Scan Processing Engine (SPE) • responsible for orchestrating all scan features once authentication has taken place.

CAS

DREDCE

System Manager& DME

Console

Windows Server

CPS

DME

SPE



Device Monitoring Engine (DME) • tracks Multi-function printer (MFP) device status to proactively identify maintenance or replacement needs

• provide status information to the reporting engine• notifies an Administrator of problems or faults based on configured alert sets• can redirect jobs based on device status

Note: DME is an optional licensed service only. You must purchase one license per installed DME instance. The current base license includes one DME license per DRE license.

Call Processing Service (CPS) • service installed with the CAS when you select Call Accounting in the Installation Wizard

• enables Equitrac Professional’s optional Call Accounting features, when you register a Rate Table license and extension licenses

• enables phone transaction processing through specified devices

Note: Call Processing (CPS) is an optional licensed service required for call accounting.

Core Component Description



Administrative Applications

System ManagerSystem Manager is the main Administrative Application that provides tools to configure, track, and manage a variety of network user activities: printing, copying, scanning, faxing, handling disbursements and phone records.

When installing the Core Accounting Server, the installation wizard also selects System Manager. To manage the server remotely, install System Manager on another machine within the deployment. From the remote machine, if you correctly identify the CAS server and have Administrative access permissions as the user starting System Manager, you can configure Equitrac Professional from other machines. For information on setting Access Permissions and other configuration options within System Manager, see the Equitrac Professional Administration Guide.

Device Monitoring ConsoleIf licensing and installing the Device Monitoring Engine (DME), you must also install at least one instance of the Device Monitoring Console. This console tracks the status of devices to identify faults before they become problems.

NOTE: The Device Monitoring Engine requires one license per installed instance of the DME service. This license must be applied in the Core Accounting Server.

You need to grant specific access permissions to user who will have access to the DME Console. For details, see the Device Monitoring with DME chapter in the Equitrac Professional Administration Guide.



Features and Optional ComponentsA base Equitrac Professional system can be extended to provide additional functionality. The following are examples of features and options that can be enabled through either additional components or option licenses. They are not required to successfully run Equitrac Professional. For detailed descriptions of these features and options, refer to the Equitrac Professional Administration Guide.

Component Description

Rate Table Extension • enables the Call Accounting features that process phone transactions from specified devices

Time & Billing Integration • enables you to import user and validation data from a third party application and export transactions to it from Equitrac Professional

3rd Party Transaction Integration

• enables you to import transaction data into Equitrac Professional from a third party application

Rules & Routing • create rules to determine the handling of print jobs that meet specific criteria • rules can accept, hold, deny or re-route print jobs based on rule criteria

Print Client • optional Windows or Macintosh software installed per workstation to enable per-print account code allocation

Release Station • acts as single point of release to control all print jobs from a secure print queue (also called Secure Printing)

• installation also loads a configuration utility to manage secure printing

Server Clustering • enables printing and tracking in Windows cluster environments • for more information, see Equitrac Professional Cluster Deployment Guide

Additional Print Server licenses

• enables tracking and/or monitoring for an additional 100 printers

Extension License Packs • Depending upon which edition of Equitrac Professional you purchase, you may require additional licensing to use some features.



Server System RequirementsThe table below lists minimum operating requirements only. To maximize performance in high-volume print environments, you require additional disk space and memory and a faster processor.

Component Software Hardware

Core Accounting Server (CAS): Standard Edition

• Windows Small Business Server 2011• Windows Server 2012 R2 (64 bit with, IIS 8.0 and .NET 4.5)• Windows Server 2012 (64 bit with, IIS 8.0 and .NET 4.5)• Windows Server 2008 R2 (64 bit with IIS 7.5 and .NET 3.5 SP1)• Windows Server 2008 (64 or 32 bit, with IIS 7.0 and .NET 3.5 SP1)• Microsoft SQL Server 2014 / SQL Server 2014 Express• Microsoft SQL Server 2012 / SQL Server 2012 Express• Microsoft SQL Server 2008 / SQL Server 2008 Express • Microsoft SQL Server 2005 / SQL Server 2005 Express

• Processor: 2 GHz or greater• Memory: 2 GB or greater• Display: 1024x768

resolution• Hard disk: 8 GB; additional

space as needed if database will be hosted on the same server

Core Accounting Server (CAS):

Enterprise Edition

• Windows Server 2012 R2 (64 bit with, IIS 8.0 and .NET 4.5)• Windows Server 2012 (64 bit, with IIS 8.0 and .NET 4.5)• Windows Server 2008 R2 (64 bit, with IIS 7.5 and .NET 3.5 SP1)• Windows Server 2008 (64 or 32 bit, with IIS 7.0 and .NET 3.5 SP1) • Microsoft SQL Server 2014 / SQL Server 2014 Express• Microsoft SQL Server 2012 / SQL Server 2012 Express• Microsoft SQL Server 2008 / SQL Server 2008 Express• Microsoft SQL Server 2005 / SQL Server 2005 Express

• Processor: 2.5 GHz or greater, multi-core

• Memory: 3 GB or greater• Display: 1024x768

resolution• Hard disk: 8 GB; additional

space as needed if database will be hosted on the same server; high performance with fault tolerance

Core Accounting Server (CAS):

Small Firm Edition

• Windows 7 Professional• Windows 7 Ultimate• Windows Small Business Server 2011• Windows Server 2012 R2 (64 bit with, IIS 8.0 and .NET 4.5)• Windows Server 2012 (64 bit with, IIS 8.0 and .NET 4.5)• Windows Server 2008 R2 (64 bit, with IIS 7.5 and .NET 3.5 SP1)• Windows Server 2008 (64 or 32 bit, with IIS 7.0 and .NET 3.5 SP1) • Microsoft SQL Server 2014 / SQL Server 2014 Express• Microsoft SQL Server 2012 / SQL Server 2012 Express• Microsoft SQL Server 2008 / SQL Server 2008 Express • Microsoft SQL Server 2005 / SQL Server 2005 Express

• Processor: 1.8 GHz or greater

• Memory: 1 GB or greater• Display: 1024x768

resolution• Hard disk: 10 GB, includes

operating system and SQL Server Express with 4GB maximum storage

Document

Routing Engine (DRE):

Print Server

• Windows Server 2012 R2 (64 bit)• Windows Server 2012 (64 bit)• Windows Server 2008 R2 (64 bit)• Windows Server 2008 (64 or 32 bit)

• Processor: 2 GHz or greater• Memory: 2 GB or greater• Hard disk: Additional space

as needed for spool files



Web Interfaces and .NETThe Equitrac Professional web interfaces (EQClient and EQStatus) must use Microsoft.NET 2.0 Service Pack 2.

Install and enable Microsoft .NET 2.0 SP2 for use with Equitrac Professional web interfaces.

Web BrowserInternet Explorer 7 or higher is required for tools such as the Web Client and Web Status.

Device Control Engine (DCE)


• Hard disk: 1 GB additional per TPC for certain scan solutions

Scan Processing Engine (SPE)


• Hard disk: 1 GB additional per TPC for certain scan solutions

• 4 GB of RAM and minimum 2 core processor required for OCR capabilities.

Device Monitoring Engine (DME)

• Windows Server 2012 R2 (64 bit)• Windows Server 2012 (64 bit)• Windows Server 2008 R2 (64 bit)• Windows Server 2008 (64 or 32 bit) or

• Processor: 2 GHz or greater• Memory: 2 GB or greater• Hard Disk: 1 GB or greater

Component Software Hardware



Print Client System RequirementsIf you are installing the Equitrac Professional Print Client on one or more Windows or Macintosh client workstations, ensure the machine(s) meet the following requirements:

NOTE: Macintosh Print Client includes the Document Routing Client (DRC) which, when properly configured, allows tracking of both DRE and non-DRE printers.

CAUTION: If the Print Client is installed on a Terminal Services server, the DRE/Print server must be installed on a separate server.

Citrix Terminal Services

Software Hardware

• Windows 8 and 8.1 (64 and 32 bit)• Windows 7 (64 and 32 bit)• Macintosh OS X 10.7 to 10.10

• Intel® Pentium® or AMD Athlon CPU• 512 MB of system memory• 10 MB available disk space for applications, and 2 GB for spool files

as needed with the Document Routing Client option• 1024x768 display resolution

Software Hardware

• Citrix ICA client v7.0 • Intel® Pentium® or AMD Athlon CPU • 256 MB of system memory • 50 MB available disk space for applications • 1024x768 display resolution



Additional DocumentationTo learn more about the advanced features and functionality of the Equitrac Professional, refer to the table below for an outline of the product guides.

The following guides are available on the Equitrac Professional CD in the Documentation folder.

Our Equitrac Customer Technical Support Center can be reached by:

• Phone: 1.877.EQUITRAC (1.877.378.4872) or +1.519.885.2417 for calls outside of North America

• Email: [email protected].

Guide When to refer to this guide

Administration Guide Instructions on how to configure and administer Equitrac Professional.

Scan Solutions Guide Instructions on how to configure Equitrac Professional for scan tracking.

Usage Guide Instructions on the user workflow including the Web Client and Print Client.

Cluster Deployment Guide Instructions on how to deploy Equitrac Professional in an existing Windows cluster environment, use this guide to plan and execute the installation.


Preparing for an Installation

Preparing and configuring your network environment is critical in order for your firm to successfully integrate with Equitrac Professional. This chapter outlines the following pre-requisites to prepare for an Equitrac Professional deployment:

• Determining component install locations

• Preparing a database server

• Confirming web interfaces prerequisites

• Configuring a Service Login User Account

• Allowing component network communication

TopicsDetermining Component Install Locations

Preparing the Database Server

Confirming Web Interface Prerequisites

Configuring a Service Login User Account

Component Network Communication

Windows Server 2008 R2 Special Considerations

2

Chapter 2: Preparing for an Installation


Determining Component Install LocationsBefore installing Equitrac Professional, you must determine whether to install all Equitrac Professional server components on a single machine or across multiple servers. This is dependent on the following factors:

• the size of your firm

• how your firm will use Equitrac Professional

• your firm’s network requirements

Single-server DeploymentA single-server deployment is ideal if your firm is supporting fewer than 100 users in a single location and fewer than 100 controlled devices. In a single-server deployment, your firm will install all Equitrac services on a single server.

Distributed DeploymentYou can install Equitrac Professional server components across multiple machines to balance the print and transaction load. This distribution of components is called a distributed install and involves two or more networked machines that host specific Equitrac Professional server components. You must determine which components to install on each machine prior to performing the installation tasks.

A distributed deployment is ideal if your firm:

• has remote offices connected by a WAN to your central office

• is physically located in a single office, but your user base is large

• has a physically segmented network that separates devices you plan to control

• will support more than 100 controlled devices

• will support fewer than 100 controlled devices with very high activity levels, such as Search, Equitrac Document Capture or copy center use

In a distributed install, you will have one Core Accounting Server (CAS) and can have multiple servers hosting Document Control Engine (DCE), Scan Processing Engine (SPE), Document Routing Engine (DRE), and Device Monitoring Engine (DME) components.

CAUTION: The DCE server should always be placed in network proximity to the output devices it controls. Each time a user authenticates or job details are uploaded from a TouchPoint Console, terminal or embedded application, the request is handled by the DCE. The DCE then communicates with the CAS across the network on a private port. Robust connectivity from the DCE to the controlled devices will therefore maximize performance.

CAUTION: If the Print Client is installed on a Terminal Services server, the DRE/Print server must be installed on a separate server.

You can set up multiple DCEs to distribute the load of managing a large number of devices. For instance, you could segregate devices for DCEs by department or location.

2 DRE and 2 DME licenses are included for each Enterprise Server license. More licenses can be purchased if needed. The number of licenses you purchased affects the number of DRE and DME servers you can deploy.



NOTE: It is ideal to keep the DRE, DCE, SPE, and DME within the same network segment. This will optimize intra-server communication. Often, the DME is deployed on the same server as the DRE. If you do not plan to install a DRE, we recommend you deploy the DME on the CAS server. If you do install the DRE, note if the Print Client is installed on a Terminal Services server, the DRE/Print server must be installed on a separate server.

Once you have decided whether your deployment will be single-server or distributed, identify target systems for server components and prepare the systems as needed.

Preparing the Database ServerEquitrac Professional stores collected data, account codes and system configuration settings in a database hosted by a Microsoft SQL Server database management system (DBMS).

Microsoft SQL Server 2008 on Windows Server 2008 (64-bit) IA64 and Microsoft SQL Server 2008 Express require Microsoft .NET Framework 2.0 SP2. All other editions of SQL Server 2008 require Microsoft .NET Framework 3.5 SP1.

Prior to installing Equitrac Professional, you must select a database server that will host its database. If you do not use an existing database server in your network, you must install Microsoft SQL Server before installing Equitrac Professional.

If you plan to set up a new database server:

• you can install Microsoft SQL Server on the same system where you plan to install the CAS, provided the system has sufficient resources.

• a free edition of Microsoft SQL Server 2008 Express is available from the Microsoft web site at: http://www.microsoft.com/Sqlserver/2008/en/us/express.aspx

• if you decide to use Microsoft SQL Server 2008 Express or SQL Server 2005 Express, you must install this on the CAS system.

• record the password you configured when you installed the DBMS.

The following must be taken into consideration whether installing a new DBMS or using an existing one at your site:

• In general, if your DBMS resides on a system separate from the CAS, the DBMS must have been installed for mixed mode authentication.

• Identify a specific named instance within Microsoft SQL Server that will host your Equitrac Professional database. Equitrac Professional performs optimally when its database is in a named instance.

• Obtain Client Access Licenses (CALs) from Microsoft as needed for the DBMS.

• Determine how you will back up your database. If possible, use industry standard backup software application that includes specific database backup options or connectors for backing up Microsoft SQL Server or Microsoft SQL Server Express databases. If such a solution is not available, you will need to stop Equitrac services and IIS on the CAS system before backing up the database.

When running the Equitrac Professional 5 server installer you will be prompted for the DBMS type you chose. The installer will either set up a database in the Microsoft SQL Server Express DBMS installed on the CAS or copy database script files that you will use to create the database in your Microsoft SQL Server DBMS.

http://www.microsoft.com/Sqlserver/2008/en/us/express.aspx

http://www.microsoft.com/Sqlserver/2008/en/us/express.aspx



Confirming Web Interface PrerequisitesThe Equitrac Professional Web Client and Web Status interfaces are installed automatically with the CAS component. These web interfaces use Microsoft .NET Framework 2.0 SP2 and Internet Information Services (IIS). Install these on the CAS system before running the Equitrac Professional installer. For more information on Microsoft .NET Framework, see: http://msdn.microsoft.com/en-us/netframework/default.aspx.

To host a Microsoft SQL Server database application and the Equitrac Professional CAS on the same system requires Microsoft SQL Server 2005 and Microsoft .NET Framework 2.0 Service Pack 2 to be installed on the system.

For more information about setting up IIS for your operating system, see the Microsoft web site.

NOTE: When installing IIS on Windows Server 2008, ensure you select the ASP.NET and IIS 7.0 Metabase Compatibility options.

NOTE: When installing IIS on Windows Server 2012, ensure you select the ASP.NET 3.5 and ASP.NET 4.5 options.

Configuring a Service Login User AccountMost Equitrac Professional server components are installed as Windows services. Rather than running under the Local System context, they require a user context. You must create a Windows user account for the services prior to installing Equitrac Professional. You will be prompted for credentials for this account during the installation.

• Single-server Installation

If you have planned a single-server installation where required Equitrac Professional server components are installed on one server, you may create a local Windows user account on the server. If the server belongs to a domain, create a domain user account.

• Distributed Server Installation

If you will have a distributed server installation with Equitrac Professional server components on multiple servers, create a network domain user account that can be used for all Equitrac services on all servers.

CAUTION: The services must start with the same network user credentials. This is required for inter-service communication.

Creating a User AccountWhen creating a Windows user account for Equitrac services:

1 ensure that the password does not need to be changed on first login and will not expire. The Equitrac Professional services will not start if service login authentication fails.

2 add the user account to the local Administrators group on each system where Equitrac server components will be installed. For proper security, do not use a Domain Administrator account.

3 ensure that the account has Print Operator privileges on DRE systems to process print requests.

4 test the account by logging into Windows interactively with the account credentials prior to running the Equitrac Professional install.

5 record the user account information you created.

http://msdn.microsoft.com/en-us/netframework/default.aspx



Component Network CommunicationEquitrac Professional components communicate with one another over the network.

If your organization restricts network traffic with hardware or software firewalls, you must open the ports listed in the table below for both inbound and outbound traffic.

On the machine running this component Port to open Enables communication from

CAS TCP 2910 DRE, DCE, DME, Workstations

Scheduler TCP 2941 CAS

DRE TCP 2938 DCE, CAS, Workstations

SPE TCP 2064 DCE, CAS, Workstations

DCE TCP 2939, 2062 TouchPoint Consoles, PageCounters, Windows Print Client, NET Buffer

DME TCP 2942 DRE, CAS

DME Console TCP 2613 CAS, DME

Print Client UDP 4940 DRE for Equitrac messaging service calls

Equitrac Embedded for eCopy, IKON, EFI

TCP 2613, 1234

UDP 68

PageCounter Mini

Canon MFPs TCP 9007, 47545 DCE, if configured for enhanced TCP/IP communication for color copy detection

Xerox EIP TCP 1824 DCE, if configured for enhanced TCP/IP communication for color copy detection

Fuji Xerox TCP 2939, 1824 DCE, if configured for enhanced TCP/IP communication for color copy detection



Windows Server 2008 R2 Special ConsiderationsEquitrac Professional may require additional configuration when installed on any system running Windows Server 2008 R2. Certain components of the Equitrac Web Client, such as reporting, may not be configured to run properly due to the Internet Information Server (IIS) configuration. If your installation exhibits problems under these circumstances, you can edit the applicationHost.config IIS configuration file to solve the problems. The steps below apply to the following configurations:

• Follow steps 1 through 4 and step 6 if Microsoft Exchange is installed on the same server.

• Follow steps 5-6 if Windows Server Update Services (WSUS) is installed.

• Follow all steps if your installation is Windows Small Business Server 2011 Standard-based.

1 Open Windows Explorer and navigate to %windir%\system32\inetsrv\config\

NOTE: A dialog box informing you of restrictions to the folder may appear. In this case, click Continue.

2 Open the applicationHost.config into any text editor.

3 Add the attribute preCondition="bitness64" to the following XML tags:• <add name="kerbauth" image="C:\Program Files\Microsoft\Exchange

Server\V14\Bin\kerbauth.dll" />

• <add name="exppw" image="C:\Program Files\Microsoft\Exchange Server\V14\ClientAccess\Owa\auth\exppw.dll" />

• <filter name="Exchange OWA Cookie Authentication ISAPI Filter" path="C:\Program Files\Microsoft\Exchange Server\V14\ClientAccess\owa\auth\owaauth.dll" enabled="true" />

• <filter name="Exchange ActiveSync ISAPI Filter" path="C:\Program Files\Microsoft\Exchange Server\V14\ClientAccess\sync\bin\AirFilter.dll" enabled="true" />

For example, <add name="kerbauth" image="C:\Program Files\Microsoft\Exchange Server\V14\Bin\kerbauth.dll" /> becomes <add name="kerbauth" image="C:\Program Files\Microsoft\Exchange Server\V14\Bin\kerbauth.dll" preCondition="bitness64" />

4 Save the changes.

5 Open a Command prompt, and run the following command as an Administrator:• %windir%\system32\inetsrv\appcmd.exe set config -section:system.webServer/

httpCompression /-[name='xpress']

6 Restart the Equitrac Professional application pool:

a Launch the IIS application from the Start menu.

b Click on Application Pools in the left pane.

c Right-click the Equitrac Professional Application Pool.



d From the context menu, select Recycle.

e If the Application Pool’s status is Stopped, click on Start.




Deploying Server Components

Now that you have successfully prepared for an Equitrac Professional deployment, you are ready to install the server components.

Use this chapter for a new Equitrac Professional installation.

• If you have not prepared for an Equitrac Professional deployment, see Preparing for an Installation on page 15.

• If you are installing Equitrac Professional components in an existing Windows server cluster environment, see the Equitrac Professional Cluster Deployment Guide.

If you are upgrading your existing version of Equitrac Professional, see Upgrading Equitrac Professional on page 51. Equitrac Professional server components can be installed on Windows servers in one of two ways:

• Single Server Installation

• Distributed Server Installation

This chapter also outlines database configuration, applying Equitrac Professional licenses, as well as virus scanning software considerations.

TopicsSingle Server Installation

Distributed Server Installation

Installing the Server Components

Configuring the Equitrac Professional Database

Applying Licenses

Configuring Virus Scanning Software

Confirming Single Sign-On

Configuring SPE Deployment

3

Chapter 3: Deploying Server Components


Single Server InstallationA single server installation places all Equitrac Professional server components and Administrative Applications on a single Windows machine. This type of installation is appropriate for small deployments only. If you are deploying Equitrac Professional across a large organization, refer to Distributed Server Installation on page 25 instead.

Before you follow this workflow, ensure that the network and database are prepared for the Equitrac Professional installation. See Preparing for an Installation on page 15 for instructions.

Single Server Installation WorkflowFollow the steps below to deploy the Equitrac server components on a single machine.

1 Install Server Components – Run the installation wizard and select CAS and other services as needed. Ensure that the CPS service is also selected if you are installing the optional Call Accounting module. See Installing the Server Components on page 26.

2 Configure the Database – Configure an SQL database for Equitrac Professional. See Configuring the Equitrac Professional Database on page 28.

3 Apply Licenses – Activate and register licenses for all components. You will require product serial numbers and the name of the system hosting the CAS. See Applying Licenses on page 30.

4 Update Virus Configuration – Configure your virus scanning software to ensure optimal Equitrac Professional performance. See Configuring Virus Scanning Software on page 32.

After you complete this workflow, if you are using Equitrac control device software, follow the instructions in on page 35. If you will be deploying print tracking, see Installing Print Client Components on page 41.

CAS

DREDCE

System Manager& DME

Console

Windows Server

CPS

DME

SPE



Distributed Server InstallationA distributed server installation places Equitrac Professional server components and Administrative Applications on multiple systems.

If you have determined that you will install all Equitrac Professional server components on a single machine, refer to Single Server Installation on page 24.

If you are installing one or more Equitrac components in an existing Windows cluster environment, refer to the Equitrac Professional Cluster Deployment Guide for instructions.

Distributed Server Installation WorkflowFollow the steps below to deploy the Equitrac server components in a distributed architecture, in which server components reside on different machines.

1 Install Server Components – Run the installation wizard and select CAS and other services as needed. Ensure that the CPS service is also selected if you are installing the optional Call Accounting module. See Installing the Server Components on page 26.

2 Configure the Database – Configure an SQL database for Equitrac Professional. See Configuring the Equitrac Professional Database on page 28.

3 Apply Licenses – Activate and register licenses for all components. You will require product serial numbers and the name of the system hosting the CAS. See Applying Licenses on page 30.

4 Install Remote Servers – Run the installation wizard on each server you have identified for remote server components. Installing the Server Components on page 26.

5 Update Virus Configuration – Configure your virus scanning software to ensure optimal Equitrac Professional performance. See Configuring Virus Scanning Software on page 32.

After you complete this workflow, if you are using Equitrac control device software, follow the instructions in Updating Control Device Software on page 35. If you will be deploying print tracking, see Installing Print Client Components on page 41.



Installing the Server ComponentsDuring the Equitrac Professional installation, the installation wizard enables you to select the server components to install per machine. For a single server installation, install all components on the same machine. For a distributed server installation, select only the components you require on each server.

1 Close all other applications on the server prior to running the Equitrac Professional installation.

2 Launch the Equitrac Professional installation wizard.

• To install from a CD, insert the Equitrac Professional CD into the server drive. The CD should boot automatically and an install window will open. Select Install Server to begin the install.

—Or—

• If you are installing from an electronic distribution, download and run the server installation Equitrac Professional.msi file.

3 At the Welcome screen, click Next to begin the installation process.

4 Review and accept the software License Agreement, and then click Next.

5 On the Select Features screen, select the features you want to install on this machine, then click Next. By default, all Server Components and Administrative Applications are selected. The Auxiliary applications (Release Station) are not selected by default.

Deselect all components that you do not want to install on this machine.

Click on the Change button if you wish to change the path where the Equitrac Professional files are installed.

Click Next.

6 If installing the Core Accounting Server (CAS), select the database type in the Select Database screen and then click Next.

a If you selected SQL Express on the database instance screen and if the instance name you identified is different than SQLEXPRESS, type a new instance name. Click Next to continue.



b If you selected SQL Server, enter the name of the computer where Microsoft SQL Server is installed in the Database Server Name field. If you identified a specific instance in Microsoft SQL Server for the Equitrac Professional database, include the instance name as well. Click Next to continue.

NOTE: If you did not choose to install the Core Accounting Server, the installation wizard will not display these screens.

7 On the User Name for Services screen, specify the User ID and Password of the account that you identified for services. For a network domain account, qualify the user ID with the domain name (domain\userid). Click Next.

8 Enter the Accounting server name of the system hosting the CAS and click Next.

NOTE: Equitrac Professional stores the CAS name under the registry key HKLM\Software\Equitrac\CAS\Common CASName. When deploying Equitrac Professional on a 64-bit Windows platform, bear in mind that some components remain 32-bit. Windows automatically redirects registry accesses from 32 bit components to the equivalent Wow6432Node registry branch. You must review both versions of the registry key when troubleshooting issues related to CAS connectivity.

9 Click Install to start the installation process. The installation wizard copies files, sets up services and creates program file shortcuts.

10 At the end of the process, click Finish to exit the installation wizard.



Configuring the Equitrac Professional DatabaseAfter installing the Core Accounting Server, you may need to perform additional configuration. The steps required depend on the database type you installed.

If you use the import/export wizards to when configuring ODBC imports or exports, the ODBC Admin button may not function. Because the ODBC console is a 32 bit application, on installs where the platform is 64 bit the application will run automatically, but not display 32 bit resources. To avoid this issue, start the ODBC console manually from the Windows\SysWOW64 directory by running the odbcad32.exe file. On 64 bit platforms, the 32 bit ODBC registry entries reside in the following path: HKLM\Software\Wow6432Node\ODBC

SQL Server Express Configuration

NOTE: Perform these steps for SQL Server Express only. These steps are not required for SQL Server 2005, 2008, 2012 or 2014 databases.

If you plan to use an ODBC database as an input source when importing validation data into a SQL Server Express database, you must enable the TCP/IP protocol.

1 From the Start menu, select All Programs > Microsoft SQL Server 2008 > Configuration Tools > SQL Server Configuration Manager.

2 Expand the SQL Server Network Configuration node in the left pane.

3 Click on Protocols for <instancename>.

4 In the right pane, right-click on TCP/IP, then select Enable from the menu.

5 At the warning message regarding the service, click OK to clear the message.

6 Stop and restart the SQL Server <instancename> service, where <instancename> is the name of the SQL Server Express database instance.

SQL Server Configuration

NOTE: Perform these steps for SQL Server configurations only. These steps are not required for SQL Express databases.

For general instructions on implementing Microsoft SQL Server, please refer to your Microsoft SQL Server documentation.

1 Using an account that has sysadmin privileges, such as sa, log into your SQL Server management tool for the database server and instance name you specified when you installed the CAS files.

2 Create a database named eqcas.

3 Connect to the eqcas database.

4 Locate the database scripts in the <installpath>\Database folder on your CAS system. <installpath> is typically C:\Program Files\Equitrac\Professional\Database.

5 Execute the scripts listed in the table below, in order, that apply to your configuration.



NOTE: Prior to running the scripts, confirm how you are connected to your DBMS. If your database context is not eqcas, elements created by the scripts will be in an incorrect database. If you are not logged into your DBMS as a system administrative user, table owners will be incorrect and may result in errors in the Equitrac Professional Web Client.

6 If necessary, on your CAS system, update the database references created by the Equitrac Professional installer.

If DBMS is configured for Windows authentication only:

a Configure the eqcas ODBC System DSN. Change the login ID verification to use Windows NT authentication and select eqcas as the default database.

b Open the HKLM\Software\Equitrac\CAS\database registry key and modify the connectionString value to be:

Data Source=<Server_name>\<Instance_name>;Integrated Security=True;database=eqcas;

7 On the CAS system, use the eqcas ODBC System DSN to verify communication to your database server and the new eqcas database.

8 On the CAS system, start the Equitrac CAS Service.

Equitrac Professional now integrates with the Microsoft SQL Server database.

Script name Applies if DBMS is Description

EQCASSQLServerInstall.sql SQL Server 2005, 2008, 2012 or 2014

creates an eqcas user login, with a password of eqcas

Note: This only applies if using Mixed-mode authentication.

CAS_SQLServer.sql SQL Server 2005, 2008, 2012 or 2014

creates database schema

CAS_SysData_SQLServer.sql SQL Server 2005, 2008, 2012 or 2014

adds general system data

CAS_SysData_SQLServer_EP.sql SQL Server 2005, 2008, 2012 or 2014

adds default system data

CAS_SQLServer_Views_EP.sql SQL Server 2005, 2008, 2012 or 2014

creates views for the web UI and reports

EQCASSQLEXPR2005.sql SQL Server 2005, 2008, 2012 or 2014

streamlines database performance

Note: If the script takes longer than 30 seconds to run, stop and restart the SQL Server <instancename> service, where <instancename> is the name of the SQL Server database instance. Run the script again.

Note: This script must be run while connected to the master database rather than the eqcas. Shut down CAS and all connections to the eqcas database before running the script.



Applying LicensesLicensing requires a combination of a serial number and an activation code to enable each Equitrac Professional component. Although the serial numbers are supplied with the software, you must also enter an activation code. There are two ways to enter this code: automatically via an Internet connection, or manually by requesting the codes via telephone or email. Regardless of the method you prefer, follow the instructions below to apply licenses and activate components.

1 Start System Manager by selecting Start > Programs > Equitrac Professional > System Manager.

2 In the Select Accounting Server dialog, choose the Core Accounting Server (CAS) with which System Manager is associated, then click Connect.

3 Click the System Manager > Licensing link in the left pane.

4 Under Current tasks, click Add license.

5 When the Equitrac Professional activation window opens, click Next to begin the activation process.

6 Enter the serial numbers for the components you want to activate. These serial numbers were supplied with your software. After you enter each number, click Add to add it to the list, then enter additional numbers as required.

7 When all numbers are entered, click Next.

8 Choose Automatic online activation then click Next.

NOTE: If you do not have an Internet connection, or do not wish to activate licensing across an Internet connection, choose Manual Activation. Click Next, then follow the instructions on the Contact Information page to contact Equitrac with your serial number.

9 Follow the Activation wizard prompts to provide contact information.

If you have already registered one or more Equitrac Professional components, the Activation wizard fills the form with previously-collected data.

10 The Activation wizard displays a Collecting information... message while retrieving system data. If you want to omit technical details of your system, click the Technical Details button and select the information you do not want to transmit. You cannot omit the following:



• Accounting server serial number (required).

• Domain-qualified print server name (required).

• Organization name as registered in Windows (required).

• Fully-qualified server DNS name (required).

11 When the Activation wizard is ready to transmit the information, review the collected data. Choose whether to send optional data with your activation request.

NOTE: The Activation wizard transmits the data using an HTTP connection to the Equitrac activation server. If the connection fails, the Activation wizard prompts for verification that you have configured the default gateway correctly, and that the Internet is accessible from this machine. You can retry or cancel the activation request at this point. If you cancel, the Activation wizard prompts you to use manual activation instead.

12 Once the Activation wizard sends the activation data and Equitrac returns the activation code, the Wizard automatically records the license activation in System Manager, and displays a summary of the activation results:

• Product code

• Serial number

• Activation code

• Status (either OK; Invalid, meaning the serial number is invalid; or Denied, meaning the serial number was valid but not accepted).

If Licensing FailsIf licensing fails during Automatic Activation, ensure that the Core Accounting Server is available prior to activation. The CAS controls licensing for all components, and if unavailable during activation, the activation fails. Components remain in an unlicensed state until CAS confirms a valid license.

After initial licensing, components cache their assigned license codes locally and use the cached information if the accounting server is unavailable. However, these temporary cached licenses will expire.

Ensure that you entered all serial numbers precisely. Remember that each component requires a separate license, unless you purchased a Suite license.

If the Serial Number is DeniedIf you apply a license and the Licenses view shows the status as "Denied", the serial number may already be registered to a different system ID. Please call the Customer Support Center to resolve this problem.



Configuring Virus Scanning SoftwareTo ensure that successful communication occurs between Equitrac Professional services, there are certain folders and file extensions that you should exclude from virus scanning.

Server Folders to ExcludeEquitrac recommends that you exclude the following server folders from virus scanning:

• the folder and subfolders containing Equitrac Professional program files

• the SPOOL folder that the Windows print spooler service is configured to use. The default location for all printer spool files is %SystemRoot%\System32\Spool\Printers.

• For Windows Server 2008 and 2012:

• C:\Users\userid\AppData\Local\Temp where userid is the Equitrac service login user account.

• If DRE is installed within a cluster, also exclude the folders that were manually set up on the cluster disk for DRE use.

File Extensions to ExcludeExclude the following file extensions from virus scanning:

• database files (mdf, ldf)

• trace log files (log)



Confirming Single Sign-OnThe Equitrac Professional Web Client is configurable to allow sign in using windows credentials for the user’s current session. This precludes the need to sign in to the Web Client when a user session is already active.

IIS Version 7.0 and above1 Configure the IIS Authentication Methods

a Open the Internet Information Services (IIS) Manager:

b In the left pane, navigate to the EQClient web site.

c In the right pane, under IIS, double-click the Authentication icon. The Authentication dialog opens.



2 Enable and Disable the Status of the appropriate Authentication settings:

a Anonymous Authentication should be set to Disabled. If it is not, Right click on Anonymous Authentication, and select Disabled from the context menu.

b Forms Authentication should be set to Enabled. If it is not, Right click on Forms Authentication, and select Enabled from the context menu.

c Windows Authentication should be set to Enabled. If it is not, Right click on Windows Authentication, and select Enabled from the context menu.

Configuring SPE DeploymentThe Scan Processing Engine (SPE) processes all scan routing and processing through Equitrac Document Capture. For basic deployments where all components are on a single server, there is always an SPE running wherever a DCE is running. By default, no configuration is necessary for such deployments. No further configuration is necessary in deployments that do not use Equitrac Document Capture, or Omtool processing. Installation of an SPE to a separate server is only necessary for deployments where moderate to extensive OCR processing will be in use.

Regardless of if your deployment plans to use scanning or OCR capabilities, we recommend installing at least one SPE per DCE on the deployment. The OmniPage OCR Add-On used by Equitrac Professional is CPU and memory intensive, and requires a minimum hardware setup to run. If you are planning on using any OCR document conversion, the minimum hardware requirements must be met, and preferably surpassed. See the Equitrac Professional Technical Specifications for detailed information about hardware requirements.

In deployments where SPEs are configured as standalone components on their own hardware, further configuration is required. See the Equitrac Professional Scan Solutions Guide for detailed information.


Updating Control Device Software

Your Equitrac Professional environment may include TouchPoint Consoles, PageCounters, PageCounter CDR devices and Equitrac Embedded applications on select MFPs. These may need to be upgraded to the most recent software.

To obtain software and documentation files for your Equitrac Embedded applications for your MFPs, contact our Equitrac Customer Technical Support Center:

• Phone: 1.877.EQUITRAC (1.877.378.4872) or +1.519.885.2417 for calls outside of North America.

• Email: [email protected]

To update your TouchPoint Console firmware, see Upgrading TouchPoint Console Firmware on page 36.

To update your PageCounter or PageCounter Professional firmware, see Upgrading PageCounter Firmware on page 38.

To configure your PageCounter CDRs to communicate with Equitrac Professional 5, see Configuring PageCounter CDR - DCE Communication on page 40.

TopicsUpgrading TouchPoint Console Firmware

Upgrading PageCounter Firmware

Upgrading TouchPoint Console Firmware

4

Chapter 4: Updating Control Device Software


Upgrading TouchPoint Console FirmwareYour TouchPoint Console ships with a default platform firmware and application firmware version that you need to update prior to allowing user access. Update both firmware types using the terminal firmware update utility packaged with Equitrac Professional.

This tool maintains all settings made from the Installation Wizard on the TPC.

Before you start• Obtain the most recent platform and application firmware versions from Equitrac Partner portal or the Equitrac

Customer Technical Support Center and save the files on the DCE system. Platform firmware is a .bin format file and application firmware is a .zip format file.

• TPC must be connected to the network and it is helpful to know its IP Address. If you are updating more than one TPC, record the IP Addresses of all TPCs you want to update.

• You must have Administrative access on the DCE Server to run this tool.

Updating the firmware1 On the server hosting the Equitrac Professional Device Control Engine, navigate to Program Files > Equitrac >

Professional > Tools and open the EQTerminalUpdate.exe tool.

2 From the Filter by device type list, choose TouchPoint Console, then press Refresh.

3 Under Advanced options, ensure Automatically restart after device is updated is unchecked.

NOTE: If TPCs do not automatically appear in the list, click Add, then enter the IP address of the TPC. Repeat for as many TPCs as you need to update. You can also use the Discover function to locate all TPCs on a particular subnet. See Discovering TPCs on a Subnet below.



4 Click the Browse button to locate the TPC firmware update file (.bin) you saved on your DCE server.

5 In the Terminal device list, use the Shift and Control keys to select one or more TPCs, then click Update Firmware. The Terminal Updater checks the status of each TPC you want to update. If the status is Idle, and Automatically Restart on Update was checked, the firmware update is applied immediately. If the status is Busy, the Terminal Updater waits until the status changes to Idle before applying the update.

6 Press the Refresh button in the Terminal Updater to view the platform firmware version applied to each TPC. Check the Version column to ensure it matches the update you applied. You may need to wait several minutes before you press Refresh. The Status column in the Terminal device list reports the current status of each TPC, and will read "Rebooting" while the restart is in progress.

7 Select one or more TPCs in the Terminal device list, then click Update Application.

8 Click the Browse button to locate the application firmware update file (.zip) you saved on your DCE server.

9 Click Update. The Terminal Updater checks the status of each TPC you want to update. If the status is Idle, and Automatically Restart on Update was checked, the application update is applied immediately. If the status is Busy, the Terminal Updater waits until the status changes to Idle before applying the update.

10 Close the window to return to the main Terminal Updater screen.

11 Press the Refresh button in the Terminal Updater to view the application version applied to each TPC. Check the Application column to ensure it matches the update you applied. You may need to wait several minutes before you press Refresh. The Status column in the Terminal device list reports the current status of each TPC, and will read "Rebooting" while the restart is in progress.

Discovering TPCs on a Subnet

The Terminal Updater can search a specified subnet for valid terminal devices and publish all found devices, as well as their attributes and status, in the Terminal device list.

1 Click Discover.

2 Enter a valid sample device IP address.

3 Enter the subnet mask and click OK.

The time required to complete the device discovery depends on the subnet range you specify. To stop a discovery that is in-progress, click Abort.



Upgrading PageCounter FirmwareYour PageCounter and PageCounter Professional terminals ship with a default firmware version that you need to update prior to using the terminal with Equitrac Professional. Update the firmware using the terminal firmware update utility packaged with Equitrac Professional. The instructions in this section provide basic details on updating firmware; for detailed documentation on all of the available options, see the Equitrac Professional Administration Guide.

Before you start, obtain the most recent firmware files from the Equitrac Partner portal or the Equitrac Customer Technical Support Center and save the files on the DCE.

1 On the server hosting the DCE, navigate to Program Files > Equitrac > Professional > Tools and open the EQTerminalUpdate.exe tool.

2 To select device firmware, click Browse and locate and open the appropriate device firmware .bin file. Select one of the following:

• For PageCounter Professional V1 terminals, select a .bin file prefixed by OMG31xxxxxx, where xxxxxx is the firmware version.

• For PageCounter Professional V2 terminals, select a .bin file prefixed by OCR32xxxxxx, where xxxxxx is the firmware version.

• For PageCounter terminals, with or without a keyboard, select a .bin file prefixed by SAL33xxxxxx, where xxxxxx is the firmware version.

3 Select the terminal you want to update with new firmware:

a Click Add.

b Enter the terminal’s IP address and click OK. The Terminal Updater adds the device to the Terminal device list.

NOTE: If you want to update several terminals at once, you can import a device list file or automatically discover devices on a subnet. For information on these procedures, refer to the EQTerminalUpdate.exe Tool section in the Equitrac Professional Administration Guide.

4 Prepare the terminal for the firmware update:

a Ensure the terminal is reporting an Idle status in the Terminal device list.

b Delete any validation data on the terminal by selecting the device in the Terminal device list and clicking Delete Validation.

CAUTION: Do not reboot the terminals prior to sending the firmware update.

c Verify that the Automatically restart after firmware update option is selected. This option reboots the device when the Terminal Updater completes the firmware upload. If this option is not selected, you must reboot the terminal using the Restart button.

d Click Refresh to refresh the status information in the Terminal device list before proceeding with the firmware update. Refreshing the list ensures that you have the most up-to-date status for your terminal; you cannot update a terminal's firmware unless it reports an Idle status.

5 When you have prepared the terminal for the update, select it in the Terminal device list and click Update to upload the firmware file to the selected terminal. The time required to complete the upload varies depending on the terminal’s internal hard disk but generally takes several minutes.



When the firmware update completes, the terminal reboots and establishes communication with the DCE. Equitrac Professional recognizes the terminal, identifies its name, and sends it the appropriate configuration file. When the terminal receives the configuration file, it reboots and displays the Idle screen.

The configuration file determines the basic behavior of a terminal. If you want to change the terminal’s basic behavior, you can update its configuration file, or you can make changes on the terminal itself. Changing the configuration file requires you to update the terminal configuration set in Equitrac Professional. Because configuration sets typically apply to a group of terminals rather than a single terminal, updating the configuration set may not be a viable solution. In such cases, use the terminal’s Manager Mode feature to apply the desired customizations.

When applying customizations, be aware that some changes create a user configuration file that overrides the general configuration file. In such cases, if you subsequently update the general configuration set, the customized terminal retains its original behavior because the new configuration file cannot override the custom settings. To apply the general configuration updates to your customized terminal, make and save a change in either the Devices or Date & Time Manager Mode menu. Making such a change creates a new user configuration file based on the updated general configuration file.

NOTE: We recommend maintaining all terminal configuration sets in Equitrac Professional, not manually at each PageCounter.



Configuring PageCounter CDR - DCE CommunicationTo enable communication between the DCE component and PageCounter CDRs, you must configure PageCounter CDR communication to use port 2939, rather than the default port 80.

WARNING: Failure to complete this procedure will result in PageCounter CDR devices never communicating with DCE for Call Accounting.

To change the HTTP Port in the PageCounterCDR.txt file, use the following procedure:

1 Open a browser and connect to the PageCounter’s webadmin page at http://<yourPCCDRIPADDRESS>, replacing the information in the angle brackets with the IP Address of the PageCounter CDR.

2 Click the Download link, log on, and follow the links to Disk1 > PageCounterCDR.

3 Open the PageCounterCDR.txt file with Notepad and search for Internet Port.

4 Edit this field from "Internet Port"=dword:00000050 to "Internet Port"=dword:00000b7b.

5 Save the changes to a location on your computer.

6 In your browser window, click Back to return to the main terminal web page and select Upload.

7 Browse the location to which you saved the PageCounterCDR.txt file.

8 In the next drop-down list, select the PageCounterCDR folder.

9 Click Upload.

10 Click the Restart link, and confirm that you want to restart the terminal. The change takes effect when the terminal restarts.


Installing Print Client Components

Equitrac Professional includes Print Client installers for your Windows and Macintosh workstations to track printing activity for cost recovery purposes.

Once the Print Client is installed, a user printing is resented with a popup dialog, prompting them to enter billing information to associate with the print in the CAS database. See the Equitrac Professional Administration Guide for details on how to configure prompt fields.

NOTE: For prints to be tracked, the CAS requires a Print Client license for each workstation.

The Windows and Macintosh workstation installers can be run on one workstation at time or can be copied to a central shared folder and invoked from the automated install process used at your firm.

TopicsInstalling the Print Client on Windows Workstations

Installing the Print Client on Macintosh Systems

5

Chapter 5: Installing Print Client Components


Installing the Print Client on Windows Workstations

Installing on a Single Workstation1 Confirm that each Windows workstation is resolving communications to the CAS, DCE and DRE servers by

hostname. On a client workstation, open a command prompt and type ‘ping hostname’ where the hostname is the name of the machine hosting the main CAS or DRE.

2 From the Equitrac Professional installation CD, double-click the client installer Equitrac Professional Client.msi file. If you have downloaded the Equitrac Professional installation package to a shared folder on your network, browse to that folder from the workstation on which you want to run the Equitrac Professional Client installation.

3 From the Welcome screen, click Next.

4 Read and accept the License Agreement, then click Next to continue.

5 The Client installation displays a warning that it must stop the Print Spooler service during the file installation, which briefly disables printing on this workstation. You must click Yes to continue the installation.

6 Select the program features you want installed:

a For a typical installation, accept the default settings.

b To enable Workstation direct IP printing (DRC), select the drop-down list next to the feature, and select This feature will be installed on local hard drive.

NOTE: Workstation direct IP printing (DRC) is for use only on workstations that do not track printers via a print server with an Equitrac Professional Document Routing Engine (DRE).

7 On the Printer type tracking screen, deselect the Track only DRE and DRC printers checkbox if you want to track prints to all printers, and click Next.

8 Specify the name of the Accounting server configured at your site, and click Next.

9 Specify the name of the DCE server to which this workstation will connect, and click Next.

10 Click Install to begin the installation.



11 When setup is complete, click Finish to close the installation wizard.

Installing Silently on Multiple WorkstationsTo install the Print Client on several workstations in your network, you can use Microsoft’s Windows Installer program to run the install package silently, along with your organization’s software installation scripting environment or best practices as required.

1 Copy the Equitrac Professional Client.msi or Equitrac Professional Client x64.msi installation file from the Installation CD to a local folder on each workstation or to a folder on a network share accessible from each workstation.

2 From a command prompt window or login script, run the following:msiexec /i "[<MSIPath>]Equitrac Professional Client.msi" EQCASName=<CASName>

EQDCEName=<DCEName> [DisableTrackingDesktopPrinters=1] [InstallDir="<TargetFolder>"]

AddLocal=<FeatureList> /q [REGISTERPRINTERS=0]

NOTE: Optional parameters in the above script are contained in square brackets ( [] ).

• <MSIPath> is the location where you copied the Equitrac Professional Client.msi file.

• <CASName> is the name of the system hosting the your Core Accounting Server (CAS).

• <DCEName> is the name of the system hosting the Device Control Engine (DCE) local to the workstation.

• DisableTrackingDesktopPrinters=1 disables tracking for desktop printers. The Print Client tracks printing to Document Routing Engine (DRE) printers only. If this parameter is not included, prints to both DRE and desktop (non-DRE) printers are tracked. This option has no effect on the Document Routing Client (DRC).

• <TargetFolder> is the path to the installation folder on the workstation. The default install folder is C:\Program Files\Equitrac\Professional.

• <FeatureList> is a comma-separated list that includes information about the print client components to be installed on the workstation(s). You must include all components corresponding to the configuration of printers and print servers you access from the workstation. The supported printing type components are:

• WindowsPrinting: Include this type if the workstation(s) access printers shared out from a Microsoft Windows Print server. In this case, the installer replaces the standard Microsoft Print Provider used to send jobs to the Microsoft print server.

• NDPSPrinting: Include if the workstation(s) access printers shared out from a Novell Print server using NDPS. In this case, the installer replaces the standard Novell Print Provider used to send jobs to the NDPS print server.

• iPrintPrinting: Include if the workstation(s) access printers shared out from a Novell Print server using iPrint. In this case, the installer replaces the standard Novell Print Provider used to send jobs to the iPrint print server.

• DRC: Include if the workstation(s) access network printers directly using Microsoft's Standard TCP/IP Port Monitor. This component includes Rules and Routing capabilities and Follow-You Printing.

• EQToolTray: Include this to install the User Settings tool. The tool is not installed if omitted from this list.



• /q: A flag for the Microsoft msiexec command that prevents the user interface from being displayed, thereby allowing a ‘quiet’ installation. Additional msiexec flags are found by typing msiexec /? at a command line, or by consulting the appropriate Microsoft documentation.

NOTE: Network printing type and User settings names in the FeatureList variable are case-sensitive, and cannot include spaces.

For example, if the workstation you are installing to has many printers defined where some point to Microsoft Windows print servers, others to Novell iPrint print servers and yet others that are connected directly over the network using TCP/IP, the string for this parameter is: <Addlocal=WindowsPrinting,iPrintPrinting,DRC>.

• REGISTERPRINTERS=0 disables auto-registration of the printers. By default it is set to 1, auto-registration enabled.

In the following example, the Print Client will be installed from a public network share, configured for Windows network printing and will include the User Settings tool.

msiexec /i "\\OurCorpFileSrv\Software\EquitracProfessional5.5\Equitrac Professional Client.msi" EQCASName=HeadOffice-EqCASSrv EQDCEName=Houston-EQDCESrv AddLocal=WindowsPrinting,EQToolTray /q



Installing the Print Client on Macintosh SystemsThe Print Client for Mac OS X enables you to print to Equitrac Professional printers defined from Mac OS X workstations. Print Client for Mac OS X requires Mac OS 10.7 or higher.

Installing Equitrac Printer UtilityAny installed printers, or printers added through the OS X System Preferences are not automatically configured to use the Equitrac Professional Accounting services. In order to use the Accounting services, printers must be configured through the Equitrac Printer Utility.

NOTE: Equitrac Printer Utility is an administration tool. You must have administrative privileges to run the tool. You may elect to omit it from your typical workstation deployment, depending on your corporate policies. In such instances, you might choose to install the utility on a shared volume and access it from each Macintosh workstation.

To install the Equitrac Printer Utility:

1 Navigate to the folder where you saved the Equitrac Professional Macintosh Print Client zip file.

2 Extract the contents of the zip file to a folder.

3 Navigate to the folder where you unzipped the files, highlight the EquitracPrinterUtilityX.app file and move it to the Applications folder.

NOTE: The uninstaller script, Uninstall_EQ_Print_Client.sh, is also included in the zip file. You can move it to the applications folder as well, or omit it if you feel the uninstaller is not applicable to the workstation in question.

Installing the Macintosh ClientThe following procedure assumes you have already completed installation of Equitrac Professional server components and printers on your network. Install the client on a representative Macintosh workstation in your print environment.

CAUTION: Administrative privileges are required to install the Macintosh client. If you are not logged on as an administrator, the installation will fail until you provide an administrative user name and password.

1 Log in to the Macintosh Client with Administrator privileges.

2 Uninstall the previous version of Equitrac Macintosh client, if installed.

3 Navigate to the folder where you extracted the Equitrac Professional zip file.



4 Run the package installer. The installation wizard opens:

5 Click Continue to start the installation. The CAS Server Address dialog opens:



6 In the CAS Server field, enter the CAS server IP address or Host Name, then click Continue. The Standard Install dialog opens:

7 Click Change Install Location... to change the location on the workstation where files will be installed, then Click Install. You will be prompted with a login screen.

8 Enter your login credentials, using an administrative account.

9 Upon successful login, installation commences. A dialog displays notifying you when installation is complete. Click Close.

Configuring Printers with the Equitrac Printer Utility XUse the EquitracPrinterUtilityX.app tool to configure printers. This tool presents a graphical user interface to query the Equitrac Professional DRE server and provide a list of available printers to add to the workstation. It also allows the addition of IP printers for use with the Macintosh Device Routing Client (DRC).

NOTE: Ensure that your Macintosh workstation has network connectivity to the Equitrac Professional CAS and DRE servers. The Equitrac Printer utility must contact DRE to retrieve a list of available printers.



To open Equitrac Printer Utility X, do the following:

1 Click the EquitracPrinterUtilityX.app file to open it. The Preferences dialog box opens:

2 In the CAS Server field, enter the IP address of the CAS server, then click OK.

3 Select the type of printer to install. From the Menu Bar:

4 Install a DRE printer:

a Click File > New Printer... A New Printer dialog box opens:

b In the DRE Address field, specify the DNS or IP address of the DRE server.

NOTE: If the Print Client is installed on a Terminal Services server, the DRE/Print server must be installed on a separate server.

c Click Get Printers button. The Equitrac Add Printer Utility will query DRE for a list of accessible printers, and populate the Printer drop down list.

d From the Printer drop-down list, select the appropriate printer.

e In the PPD field, enter the Postscript Printer Description if needed, then click OK.

NOTE: You can test your deployment by printing a document, entering validation data in the popup, and checking that Equitrac Professional 5 has properly recorded the information by running a standard print report. For information on running reports, see the Equitrac Professional Administration Guide.



5 Install a DRC printer:

a Click File > New IP PRinter... a New IP Printer dialog box opens:

b In the IP Address field, enter the IP address of the printer you want to add.

c In the Name field, enter a name for the printer.

CAUTION: The name you give a printer has a direct effect on how it is handled when using Equitrac Professional DRC. If your enterprise has a set naming convention for printers, be sure to use it. For detailed information, see Workstation Network Printer Consolidation in the Equitrac Professional Administration Guide.

d Accept the default settings for all remaining fields, and click OK.

Remote InstallationRemote installation of printers on Macintosh workstations is possible using process for accessing the remote workstation. For example, you can use Macintosh Remote Desktop as a means to install and run the setup program. Regardless of how you choose to deploy the system, you must have administrator rights to the remote workstation.

NOTE: The following instructions make use of Macintosh Remote Desktop to transfer and install the Print Client. This software must be purchased separately from your computer vendor. Alternatively, you can accomplish the same tasks using any process for file transfer and execution you are familiar with.

Remotely install the Print Client:

1 Locate or create the eqdrecas.cfg file.

The eqdrecas.cfg file must be present on the remote workstation before installing the print client.

The file is typically created when the print client is installed locally. It is found on a sample previously installed machine at <root>/Library/Application Support/Equitrac/DRE.



NOTE: If the local workstation does not contain an installation of the print client, the eqdrecas.cfg file is easily created by placing the IP address of the CAS into a text file, and saving it as “eqdrecas.cfg”.

2 Transfer the eqdrecas.cfg file to the remote workstation.

a In Macintosh Remote Desktop, connect to the remote workstation, then click Copy:

b Add the eqdrecas.cfg file to the Items To Copy box.

c From the Place Items In drop-down list, select Same relative location.

d Click Copy.

3 Install the Print Client.

a In Macintosh Remote Desktop, click Install:

b Add the Equitrac_Professional_Mac_OS_10_xxxx.mpkg file to the Packages box.

c Click Install.


Upgrading Equitrac Professional

This section provides instructions to upgrade to the current Equitrac Professional version from a 5.x version only. To upgrade from Equitrac Professional 3.52 or earlier, please contact the Equitrac Technical Support Center for information and requirements.

NOTE: If you require assistance while upgrading, please contact the Technical Support Center: Phone: 1.877.EQUITRAC (1.877.378.4872) or +1.519.885.2417 for calls outside of North America.

The table below outlines the upgrade path from previous versions of Equitrac Professional.

TopicsPlanning an Upgrade

Performing an Upgrade

Upgrading Macintosh Client Licensing

Previous Version Upgrade Path

Equitrac Professional 3.52 (or earlier) Contact the Equitrac Technical Support Center

Equitrac Professional 5.4 (or earlier) Upgrade to version 5.5 first, and then upgrade to Equitrac Professional 5.7

Equitrac Professional 5.5 or 5.6 Upgrade directly to Equitrac Professional 5.7

6

Chapter 6: Upgrading Equitrac Professional


Planning an UpgradeWhen upgrading Equitrac Professional, you will take a phased approach. You must upgrade CAS first, then other servers you may have installed, and finally, print clients and control device software as necessary. Equitrac Professional is designed so that server software in the current version can communicate with client software from prior versions.

Determine your upgrade rollout plan to minimize downtime for your users. For instance, when upgrading DREs, network prints will not be processed until the upgrade is complete. If you have the Print Client installed on your workstations, consider how you will schedule upgrades across your user base.

You must be running at least Equitrac Professional 5.5 in order to upgrade to version 5.7. A direct upgrade from version 5.4 (or earlier) to version 5.7 is not supported. If upgrading from version 5.4 (or earlier), you must first fully upgrade all components and database to version 5.5 or 5.6, and then upgrade to version 5.7.

NOTE: Do not perform a partial upgrade to version 5.5 or 5.6, as all Equitrac Professional components must be running at least 5.5 in order to upgrade to version 5.7. The version 5.4 (or earlier) database must also be upgraded to 5.5 or 5.6 as it is not compatible with version 5.7. The old database can be preserved for archiving and lookup purposes, but cannot be used directly with version 5.7.

Performing an UpgradeYou will upgrade your Equitrac Professional software components by running the Installation wizards provided with the new version. For more information, see Installing the Server Components on page 26, Installing the Print Client on Windows Workstations on page 42 and Installing the Print Client on Macintosh Systems on page 45.

NOTE: If you applied any Equitrac Professional hotfixes to server components in your current installation, stop the Equitrac (EQ) services and, for the CAS system, IIS, before running the new installer on server systems to perform the upgrade. Some hotfixes inadvertently do not correctly stop services when they are removed and may cause error messages after the server installer completes its tasks. After upgrading, all or most of the hotfix references in Add/Remove Programs will be removed.

Registry Keys for Remote Desktop Services RolesIf you have installed the role "Remote Desktop Services" and the role service "Remote Desktop Session Host" to your server, a change to the Windows registry is necessary to allow the upgrade to complete. Typically, these roles are not installed and no further configuration is required. If the roles are installed, add this registry key before starting the installer:

[HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Windows NT\TerminalServices\TSAppSrv\TSMSI] "Enable"=dword:00000000

NOTE: A system reboot is not required in order for this change to take effect.

1 Upgrade the CAS server.

On the CAS server, stop Equitrac (EQ) services and IIS, and run the Installation wizard from the new Equitrac Professional version. Ensure that all components installed on this system are selected. At a minimum, this will be CAS and System Manager. If you are upgrading a previous installation that included the Call Accounting Module, ensure that the CPS service is also selected.



After the installation wizard is finished, when CAS starts, it will automatically apply database upgrade scripts to modify the Equitrac Professional database.

Existing distributed services (DRE, DCE, SPE, DME) and Print Client components at earlier versions will continue to communicate with the upgraded CAS.

2 Upgrade any remote servers.

If you have a distributed server Equitrac Professional configuration, run the Installation wizard on remote servers. Ensure that all components installed on each system are selected for update in the wizard.

3 Upgrade the Print Clients.

Run the Print Client Installer on all required workstations.

Upgrading Macintosh Client LicensingEquitrac Professional version 5.3.1 (or earlier) used the Macintosh workstation’s IP address as the license identifier when consuming license device assignments. As of version 5.4, the Macintosh Client assigns licenses using the workstation’s serial number as the identifier. When upgrading the CAS and Macintosh Client from Equitrac Professional 5.3.1 (or earlier), you must remove the current Macintosh Client license assignments in System Manager’s licensing panel before deploying new clients. With version 5.4, dynamic IP addresses no longer impact the license assignments in Equitrac Professional.

If the IP address license assignments are not removed before upgrading, you may run out of licenses as new Macintosh license assignments are automatically allocated.

Follow this procedure:

1 Open System Manager and select Licensing from the left pane, then select Assignment View from the tabs at the top of the right pane.

2 Under Print Server Document Routing Engine, remove all Macintosh entries with an IP address assignment. You can use multi-select to remove all entries at once.

3 Click Refresh to see the changes reflected in the licensing panel.

After upgrading the Macintosh print client to version 5.4, the workstations start to use licenses based upon serial number rather than IP.




Uninstalling Equitrac Professional

To uninstall Equitrac Professional, you must remove both server and client components from the appropriate machines. In the case of Macintosh clients, you must run the Client installation wizard, then select Remove from the options.

This section provides uninstall instructions for the server and client components and details how to restore printers to defaults.

TopicsUninstalling Server Components

Restoring Printers to Defaults

Uninstalling Client Components

7

Chapter 7: Uninstalling Equitrac Professional


Uninstalling Server ComponentsThis process automatically removes any Equitrac program files on machine, including the DRE, DME, DCE, SPE, CAS, CPS and Administrative Applications. After you remove the server files, verify that the files have been removed. You must perform the uninstall on each machine that Equitrac Professional is currently deployed on.

WARNING: If you are uninstalling Equitrac Professional version 5.1.0 and you have applied hotfixes since installing it, we recommend that you stop the following services before performing this uninstall: EQ CAS Service, EQ CPS Service, EQ DCE Service, EQ SPE Service, EQ DRE Service, EQ DME Service, EQ Scheduler Server and IIS Admin Service. Failure to stop these services prior to running the uninstaller results in error messages after the uninstaller completes its tasks.

1 From the server Start menu, open Settings > Control Panel > Add/Remove Programs.

2 In the Add/Remove Programs window, select Equitrac Professional.

3 Click Remove.

4 Follow the prompts as necessary.

CAUTION: If you are uninstalling CAS and have set up the Equitrac Professional database on Microsoft SQL Server 2005, 2008, 2012 or 2014 Express, you will be prompted with a dialog asking you if you want to remove the CAS database. You may keep the database for future reference.

CAUTION: Uninstalling DRE without first restoring printers on Equitrac Ports to their original Ports results in each of those printers being converted to use the FILE: port. See Restoring Printers to Defaults on page 56 before uninstalling the DRE.

Restoring Printers to DefaultsIf you used the Port Conversion wizard at any time after installing Equitrac Professional, you must run the wizard again prior to uninstalling Equitrac Professional to revert the printers back to their original ports.

If no printers are assigned to Equitrac ports, the uninstall process deletes all ports and removes the port monitor from Windows.

If there are no Equitrac ports, the uninstall process removes the port monitor from Windows.

If there are printers assigned to Equitrac ports, then the uninstall process prompts you with a series of questions to determine how to proceed:

• If you choose to remove the Equitrac ports, the uninstall will convert existing printers to use the FILE: port. If you created Equitrac ports using the Equitrac Port Conversion Utility, you can exit the uninstall and use the conversion utility to revert printers to their original ports. When finished, return to the uninstall to complete the process.

• If you choose to leave the Equitrac ports, any printers associated with those ports will not be functional unless you reinstall the port monitor. The uninstaller will restart the print spooler so the Equitrac ports do not appear in Explorer.



Uninstalling Client ComponentsEquitrac Client components must be uninstalled before the server components are uninstalled.

Windows - Local UninstallTo uninstall the Windows Print Client from a single workstation, perform the following procedure:

1 From the workstation Start menu, open Control Panel > Programs and Features.

2 In the Add/Remove Programs window, select the Equitrac Professional Client.

3 Click the Remove button.

4 Follow the prompts to confirm uninstall as necessary.

5 Restart the workstation.

Windows - Silent UninstallTo silently uninstall the Windows Print Client, perform the following procedure:

1 Locate the Equitrac Professional Client.msi file you used to install the Print Client on your Windows workstations.

2 From a command prompt window or login script, run the following:msiexec /uninstall "[<MSIPath>]Equitrac Professional Client.msi" /norestart /q

where

• <MSIPath> is the location of the Equitrac Professional Client.msi file.

NOTE: The /q: flag for the Microsoft msiexec command prevents the user interface from being displayed, thereby allowing a ‘quiet’ installation. The /norestart flag prevents a restart after the installation is complete. Additional msiexec flags are found by typing msiexec /? at a command line, or by consulting the appropriate Microsoft documentation.

After a silent uninstall, Print Client files are deleted and popup processing is no longer triggered on printing. There will be benign Print Client references still loaded in Windows memory until the workstation is restarted.

MacintoshUninstall the Macintosh Print Client by executing a shell script provided in the Macintosh Print Client distribution. For more information on locating the uninstall shell script, please see Installing the Print Client on Macintosh Systems on page 45.

To uninstall the Macintosh client, open an OS X terminal window (bash shell) and execute the Uninstall_EQ_Print_Client.sh shell script.



Documents

Equitrac Professional 5.7 Installation Guide Professional Installation Guide 5 Introduction Equitrac Professional measures, monitors, and manages document output on your network for