Equitrac - Installation Guide
Equitrac - Installation Guide
Installation Guide
Version 5.7
© 2017 EQ-IG-5.7-20170616
Nuance® Equitrac® Office and Express 5.7 Installation Guide
Document Revision Date Revision List
Trademarks
Equitrac®, Equitrac Express®, Equitrac Office®, Follow-You Printing®, and PageCounter® are registered 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.
Note The accompanying text provides cross-reference links, tips, or general information that can add to
your understanding of the topic.
Caution The accompanying text provides key information about a step or action that might produce
unexpected results if not followed precisely.
Warning Read the accompanying text carefully. This text can help you avoid making errors that might negatively
affect program behavior.
2 Server Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Local Installation Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Installing Couchbase Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Installing Server Components on a Single Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Remote Installation Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Installing Server Components Across Multiple Machines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Installing the Master CAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Configuring the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Microsoft SQL Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Oracle Database Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Applying Equitrac Office and Express Licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
4 Silent Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Server Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Running Windows Installer in Silent Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Core Accounting Server (CAS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Nuance® Equitrac® Office and Nuance® Equitrac ® Express are server-based print management and cost recovery
solutions which measure, monitor, and manage document output on the network. By regulating devices on the
network, and local desktop printers, Equitrac (Office/Express) tracks and controls photocopies, print jobs, scan jobs,
and faxes with minimal administration.
There are several different installation methods available to get Equitrac (Office/Express) up and running. Read this
chapter before beginning the installation to confirm the best option for your organization, the system requirements,
and the tasks to complete before installing the software.
Installation Overview
Equitrac Office and Equitrac Express provide installation wizards to guide you through the server, client, and optional
component installs.
There are several different types of deployment. Depending on the size of the Equitrac (Office/Express) deployment
and your network requirements, you can choose to install all server components on a single machine or you can
deploy across multiple servers. Follow the instructions indicated to install the components in the correct order.
Deployment Description
Local • All Equitrac (Office/Express) server components are installed on a single machine.
See Local Installation Workflow on page 23.
Remote • Equitrac (Office/Express) server components are deployed across multiple networked machines.
See Remote Installation Workflow on page 31.
Cluster • Equitrac (Office/Express) components are distributed in a Windows Server 2008/2008 R2 cluster
environment. See the Cluster Deployment Guide.
High Availability • Equitrac (Office/Express) print servers are distributed in a Windows High Availability cluster
Printing environment. See the Print Submission High Availability for DRE Setup Guide.
NOTE: Refer to the ReleaseNotes.pdf on the Equitrac Product Download site for potential important installation or
upgrade information not contained in this document.
• Install and configure TCP/IP protocol on the intended print server machine and on network printers.
• Install and configure the SQL Server or Oracle databases, otherwise the required database setup will not be
performed and the installation will quit without installing any components.
The database can be configured to use Windows Authentication Mode or mixed mode authentication (Windows
Authentication and SQL Server Authentication). Use Windows Authentication Mode where possible, as it provides
secure validation and encryption of passwords.
• If installing Web Client, ensure the appropriate Internet Information Services (IIS) version is installed. See
Installing the Web Client on page 48.
• If installing DCE in a high availability cluster setup, install the Couchbase server included in the Equitrac Installer
download zip file. Couchbase is a NoSQL document database used to distribute the DCE cache. When installing
Couchbase on Server 2008 or 2008 R2, Microsoft, ensure that .NET Framework 4.5 is installed as it is required for
DCE. Refer to the Print Release High Availability Setup Guide for complete Couchbase installation and
configuration for DCE High Availability (HA) deployment.
• When setting up a high availability (HA) environment with Couchbase for distributed caching, a Network Load
Balancer (NLB) should be set up in front of DCE to distribute the workload across all available DCE servers in
your environment. The NLB is not needed when using Windows failover clustering or Hyper-V clustering HA
solution.
Core Accounting • verifies users, calculates print charges, and assigns charges to an appropriate user or group account
Server (CAS) • calculates charges using page count and job attribute information
• contains an accounting database where all printer, user, department, billing code, transaction, and
balance information is stored
• provides primary and secondary pricing structures to track different costs/billing scenarios
• provides dual pricing capabilities
Device Control • enables document flow from client workstations to output devices such as printers, digital copiers,
Engine (DCE) scanners, and plotters
• provides transaction tracking at the device level
• communicates via different interfaces to control and management copy, fax, and hardware devices
such as PageCounter
• provides the ability to optionally configure caching of login credentials, enabling users to log in on
embedded clients and PageCounters even when network connection to CAS is lost
Scan Processing • optional core component required to use the Equitrac (Office/Express) scanning features
Engine (SPE) • coordinates all scan features once authentication has taken place
Device Web Server • manages and controls embedded applications on web-based MFPs
(DWS) • device login information is sent to DWS, which communicates with DCE, and then DCE contacts CAS
to verify the user account
Device Monitoring • tracks device status to proactively identify maintenance or replacement needs
Engine (DME) • provides status information to the reporting engine
• can redirect jobs based on device status
Optional Components
Optional components extend the functionality of Equitrac Office or Equitrac Express, and may require additional
licensing. Some optional components must be installed on a Windows Server; others are client-based and require a
separate workstation. For details of these components, refer to the Equitrac Office and Express Administration Guide.
Optional
Description
Component
Workstation • set of features that provide job information and billing prompts to the user submitting a print request
Client • Client Billing
• Desktop Printing
• Follow-You Printing
• Cost Preview
• Prompt for Login
• the Workstation Client includes an optional module to enable accurate tracking of ports configured
with the standard TCP/IP port monitor (See Workstation Client Installation on page 59)
• the workstation client includes Print Assistant functionality for Equitrac Express
Web Client • allows users and system administrators to perform Equitrac-related tasks using a web browser
• Web Client consists of Web System Manager for managing Equitrac accounts with a base set of System
Manager functions, the Scan Client for managing and monitoring scan jobs for an Equitrac user, User
Dashboard for Equitrac users to view and manage their personal account, Web Reports to display
reports in table, pie, and graph formats, and Web Deposit (an Equitrac Express feature) for accepting
funds into an Equitrac system through a web-based user interface.
Release Station • acts as single point of release to control print jobs from a secure print queue (also called Secure
Printing)
• installation also loads a configuration utility to manage secure printing
Deposit Station • allows users to transfer funds from a payment card to an existing Equitrac Express printing account
(Express feature)
Campus Card • enables users to pay for printing and copying with a third-party account
(Express feature)
Print Assistant • configure a pop-up window on user PCs to preview print job attributes, including cost, number of
(Express feature) pages and more
• information is collected from devices automatically over the network
Interface Module • supports control terminal devices (such as PageCounter, PageControl Touch) used to release
documents and control copier and scanner access
• supports controller interfaces to enable communication with multi-function devices
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
Mobile Printing • allows mobile devices, such as smart phones, tablets, and laptops, to print to a physical device without
being connected to the local network
Optional
Description
Component
Smart Card • enables users to authenticate through a smart card reader connected directly to control terminals
Note: The Smart Card solution is only for 64-bit systems.
Data Source • enables a third-party print tracking system to upload transaction data to the Equitrac Office or Express
Core Accounting Server
Uplink • enables central coordination of print transaction and accounting data from multiple sites (i.e. remote
campus locations)
• uploads transaction and account data from remote instances of CAS to the main accounting server
Optional
Description
Component
UNIX Print Server • controls and tracks printers connected though a UNIX printer server
• requires a connection to the CAS service running on a Windows Server
Note: Does not support the Equitrac (Office/Express) Workstation Client Billing Popup features.
Additional Print • enables tracking and/or monitoring for an additional 100 printers
Server licenses
Mobile Printer • allows mobile devices to print to a physical device without being connected to the local network
• one license is required for each physical printer used for mobile printing
Device Management Console • track device status to identify faults before they become problems
Refer to the Equitrac Office and Express Administration Guide for detailed information on these tools.
Connector Description
RightFax • a command line import utility to receive RightFax print transaction data to send to CAS
KIP • a command line import utility to import KIP plotter print transaction data to send to CAS
SAP • a command line import utility to import SAP records into CAS
eCopy version 4.3.5 • Equitrac passes users’ login ID and email address to eCopy. Scan transactions are recorded by
and version 5 Equitrac
NOTE: For information on system requirements for these connectors, consult your connector manufacturer’s
applicable manuals.
B.E.A.R DCS-2000
Equitrac DebitLog
Intercard AS 3880
Schlumberg-DANYL D/AUX
Xafax AS 6200
XCP 5870 (Unit or Value cards), 5871/5571/5812, 5512 (Unit or Value cards)
System Requirements
Before installing Equitrac Office or Express, ensure that the client and server machines you plan to use meet the
minimum operating requirements outlined below. To maximize performance in high-volume print environments,
additional disk space, memory, and a faster processor is required.
32-bit server components are not supported in Equitrac (Office/Express) version 5.7. CAS, DRE, DCE, DME, SPE and
Web Client are only available in 64-bit. Administrative applications, Auxiliary applications and Workstation Client are
available in both 32-bit and 64-bit installers.
A direct upgrade from an earlier version of Equitrac running 32-bit server components to version 5.7 running 64-bit
cannot be done. If you currently have any 32-bit server components installed on a 64-bit system, you must remove
them and then re-install the 64-bit components. See Planning an Upgrade on page 88.
If installing the Web Client, review the Prerequisites on page 48 for details on configuring IIS with ASP.NET for the
various Windows Servers.
Core Accounting Server (CAS) • Microsoft SQL Server 2008/2008 Express SP3 (or higher) • Processor: 2 GHz or greater
– Database • Memory: 2 GB or greater
• Microsoft SQL Server 2008 R2/2008 R2 Express SP1
• Hard disk: 1 GB or greater
• Microsoft SQL Server 2012/2012 Express (SQL Server 2008/2008 R2
• Microsoft SQL Server 2014/2014 Express and Oracle)
• Microsoft SQL Server 2016/2016 Express • Hard disk: 2.2 GB or greater
• Oracle®3 11g R2, 12c (SQL Server 2012 or higher)
Core Accounting Server (CAS) • Windows Server 2008, 2008 R2, 2012, 2012 R2, 2016 (x64) • Processor: 2 GHz or greater
Device Monitoring Engine (DME) • SharePoint Server 2007 SP3 (or higher), 2010 and 2013 • Memory: 2 GB or greater
Scan Processing Engine (SPE) • RightFax Server 9.4 and higher • Hard disk: 1 GB or greater
Device Control Engine (DCE) • Windows Server 2008, 2008 R2, 2012, 2012 R2, 2016 (x64) • Processor: 4 x 2 GHz or
– Non HA Setup • SharePoint Server 2007 SP3 (or higher), 2010 and 2013 greater
• RightFax Server 9.4 and higher • Memory: 6 GB or greater
• Hard disk: 2 GB or greater
Device Control Engine (DCE) • Windows Server 2008, 2008 R2, 2012, 2012 R2 failover • Processor: 4 x 2 GHz or
– HA Setup with Couchbase on cluster greater
DCE Node • Windows Server 2012, 2012 R2, 2016 Hyper-V cluster • Memory: 6 GB or greater
• Hard disk: 2 GB or greater
Device Control Engine (DCE) • Windows Server 2008, 2008 R2, 2012, 2012 R2 failover • Processor: 2 GHz or greater
– HA Setup with Couchbase on cluster • Memory: 2 GB or greater
Separate Node • Hard disk: 1 GB or greater
• Windows Server 2012, 2012 R2, 2016 Hyper-V cluster
Document Routing Engine (DRE) • Windows Server 2008, 2008 R2, 2012, 2012 R2, 2016 (x64) • Processor: 2 GHz or greater
Print Server • SUSE Linux SLES 11 SP3 for Novell OES 2015 (x64) • Memory: 2 GB or greater
– with Rules and Routing or • SUSE Linux SLES 11 SP4 for Novell OES 2015 SP1 (x64) • Hard disk: 1 GB or greater
Secure Document Release • Red Hat Enterprise 6.5, 7.0 and 7.2 (x64) + allocation for print jobs
Device Web Server (DWS) • Windows Server 2008, 2008 R2, 2012, 2012 R2, 2016 (x64) • Processor: 2 GHz or greater
Device Control Server (DCS) • Microsoft ASP.NET 4.5 for DCS • Memory: 2 GB or greater
+ 2 GB dedicated to DWS
• Hard disk: 1 GB or greater
Core Accounting Server (CAS) • Windows Server 2008, 2008 R2, 2012, 2012 R2 failover • Processor: 2 GHz or greater
Device Monitoring Engine (DME) cluster • Memory: 2 GB or greater
– Cluster Server • Windows Server 2012, 2012 R2, 2016 Hyper-V cluster • Hard disk: 1 GB or greater
Device Control Engine (DCE) • Windows Server 2008, 2008 R2, 2012, 2012 R2 failover • Processor: 4 x 2 GHz or
– Cluster Server (Couchbase on cluster greater
DCE Node) • Memory: 6 GB or greater
• Windows Server 2012, 2012 R2, 2016 Hyper-V cluster
• Hard disk: 2 GB or greater
Document Routing Engine (DRE) • Windows Server 2008, 2008 R2 failover cluster • Processor: 2 GHz or greater
Print Server • Memory: 2 GB or greater
• Windows Server 2012, 2012 R2, 2016 Hyper-V cluster
– Cluster Server • Hard disk: 1 GB or greater
+ allocation for print jobs
System Manager • Windows Server 2008 (x86, x64) • Processor: 2 GHz or greater
Accounts Manager • Windows Server 2008 R2, 2012, 2012 R2, 2016(x64) • Memory: 2 GB or greater
Department Manager • Windows 7 Professional/Enterprise/Ultimate (x86, x64) • Hard disk: 50 MB or greater
Reports Manager • Windows 8 Professional/Enterprise (x86, x64)
Release Station • Windows 8.1 Professional/Enterprise (x86, x64)
• Windows 10 (x86, x64)
Device Monitoring Console
NOTE: Microsoft .NET Framework 4.5 must be installed on Windows 8, 8.1 and 10 prior to installing the Windows
Client.
Server Requirements • Windows Server 2008 (x64 with IIS 7.0 and .NET 4.5) • Processor: 2 GHz or greater
• Windows Server 2008 R2 (x64 with IIS 7.5 and .NET 4.5) • Memory: 2 GB or greater
• Windows Server 2012/2012 R2 (x64 with IIS 8.0 and .NET 4.5) • Hard disk: 1 GB or greater
• Windows Server 2016 (x64 with IIS 10.0 and .NET 4.6)
• Import an SSL certificate and use the HTTPS protocol
(recommended)
Additional Requirements for • Microsoft SQL Server 2008/2008 Express SP3 (or higher)
Web Deposit • Microsoft SQL Server 2008 R2/2008 R2 Express SP1
(Equitrac Express feature) • Microsoft SQL Server 2012/2012 Express
• Microsoft SQL Server 2014/2014 Express
• Microsoft SQL Server 2016/2016 Express
• Equitrac External Data Connector license for each server
offering Web Deposit services
Additional Documentation
To learn more about the advanced features and functionality of Equitrac Office or Express, refer to the table below for
an outline of the product guides.
Planning Guide Use this guide to evaluate and plan an Equitrac Office or Express deployment on your
network.
Administration Guide After installing Equitrac Office or Express, use this guide to configure the product for
use in your organization.
Cluster Deployment If you are deploying Equitrac Office or Express in a Server 2008/2008 R2 cluster
environment, use this guide to plan the installation.
Print Submission High Availability Use this guide if you are deploying Equitrac Office or Express in a high availability
for DRE print server setup using Network Load Balancing or Hyper-V clustering.
Print Release High Availability Use this guide if you are deploying Equitrac Office or Express in a high availability
print release setup using Network Load Balancing and Couchbase NoSQL database.
Embedded Guides Available for Use these manufacturer specific guides for Equitrac embedded clients.
Various Manufacturers
Print Server Module Guides: If your deployment utilizes a UNIX print server, use these guides to configure the print
• Linux iPrint server after the installation is completed.
• Red Hat Enterprise
• Web Deposit Guide Use this guide to plan and configure the Web Deposit application in the Equitrac Web
(Equitrac Express Feature) Client.
Help Contents
Web Client Help Online help found within the Web Client application used to plan and configure
Equitrac Office or Express.
Release Station Help Instructions and reference information about using Release Station to release jobs for
pint.
This chapter provides the steps required to install all Equitrac Office or Express components on either a single
machine, or across multiple machines. A “Local” installation places all Equitrac Office or Express server components
and Administrative Applications on a single machine. This type of installation is appropriate for small site
deployment. If installing all components on a single machine, refer to Local Installation Workflow on page 23.
Equitrac (Office/Express) server and client components can be installed across multiple machines to balance the print
and transaction load. This distribution of components is called a “Remote” installation, and involves two or more
networked machines that will house specific Equitrac Office or Express components. You must determine the
appropriate network deployment for your enterprise before installing a single Equitrac Office or Express component.
If deploying Equitrac (Office/Express) across a large site, refer to Remote Installation Workflow on page 31.
Equitrac (Office/Express) offers a “Simple Install” to quickly install a default set of core components, features and
Administrative applications, or a “Standard Install” to customize the installed core and optional components,
Administrative and auxiliary applications, along with the database platform and its location within the environment.
If upgrading to Equitrac Office or Express version 5.7 from an earlier version, refer to Chapter 5: Upgrade Equitrac
Office/Express on page 88.
Refer to the ReleaseNotes.pdf on the Equitrac Product Download site for potential important installation or upgrade
information not contained in this document.
8 On the Select language screen, choose the interface language and the installation method, and then click Next.
• Standard Install – (default selection) Allows Administrators to install a customizable set of core server and
optional components, Administrative and auxiliary applications, along with the database platform and its
location within the environment. Go to Standard Install on page 26 to complete a customized installation.
• Simple Install – Installs a default set of core components and features including CAS, DRE (with iQueue),
DCE, DCS, DWS, WebClient, Administrative applications and user Documentation. If desired, the default
components and applications can be modified after installation. Go to Simple Install on page 25 to complete
the Simple installation.
CAUTION: You cannot change the display language after installation. To change the language, you must uninstall
and reinstall Equitrac Office or Express, and set the language. The display language is independent of the regional
language on the machine. For example, Equitrac can display Italian even if the regional setting is French.
Simple Install
When the Simple install is selected on the Select language screen, the Service Log On Credentials screen opens.
1 On the Service Log On Credentials screen, enter the Account and Password of the user who will run the
Windows services. Alternatively, click the Browse button to search for valid user from a specific location. Click the
Test Credentials button to verify the user, and click Next to continue.
2 On the Ready to install Equitrac Express (or Office) screen, click Install to start the installation process.
3 Once installed, click Finish to exit the installation wizard and begin initial configuration in System Manager.
Standard Install
When the Standard install is selected on the Select language screen, the Select Features screen opens.
1 On the Select Features screen, choose the features you want to install, and click Next.
By default, all main Server Components (except the Scan Processing Engine) and all Administrative Applications
are selected for installation. Deselect all options not required for the machine you are installing to. Any feature not
selected by default can be installed during initial installation, or they can be installed afterwards.
Optional Components
The Scan Processing Engine (SPE) is an optional server component required to run the Equitrac (Office/Express)
scan feature.
The I-Queue is an optional feature of DRE. The I-Queue is a single Follow-You Printing queue where all printers
are combined into a single pull group. The I-Queue only supports secure printing, and holds print jobs until the
user releases them at a networked printer via Follow-You Printing. When the I-Queue feature is installed, an I-
Queue Printer is auto-created on the DRE print server.
The Smart Card Service and Driver is an optional feature of DCE (available on 64-bit operating systems only). It is
required in order to support authentication from a device via a Smart Card.
Web Client is a package of web applications allowing both system administrators and users to perform Equitrac
related tasks using a web browser. Web Client includes Web System Manager (installed by default), Web Reports
(installed by default), User Dashboard (installed by default), Scan Client (optional) and Web Deposit (optional
Equitrac Express feature). For more information see Installing the Web Client on page 48.
NOTE: To change the default installation folder for any of the program features, select the feature icon and then click
the Browse button to open the Change destination folder dialog box. The top-level Server Components icon must be
selected to change the location of the individual Server components.
2 On the Service Log On Credentials screen, enter the Account and Password of the user who will run the
Windows services. Alternatively, click the Browse button to search for valid user from a specific location. Click the
Test Credentials button to verify the user, and click Next to continue.
NOTE: The Account field contains the account name in domain\username format. If you are using a SQL Express
database that is not on a domain and you are using local accounts, you must enter computername\username. If
neither domain or computer name prefix is specified, the user is handled as local user.
3 On the Windows Firewall Exceptions screen, select either a manual or automatic setup method for the firewall
exceptions, and then click Next to continue.
4 On the Database platform screen, select either the SQL Server or Oracle database, and click Next.
• If SQL Server is selected (default selection), additional database location and authentication information is
required.
• If Oracle is selected, the Oracle client is automatically located by the installer and the wizard advances without
requiring any additional database information.
5 If SQL Server is specified, select any available database server from the Database Instance drop-down list, and
then click Next. Alternatively, the database server address, and optionally the instance name, can be typed in the
Database Instance field.
6 On the Database Credentials screen, select the authentication type of the selected SQL Server:
• Windows Authentication (default selection): select this option when the user running the Windows Service
account connects to the database server. This user was specified on the Service Log On Credentials screen.
• SQL Authentication: enter the user credentials in the Login and Password fields, (this can be another
Windows user or a SQL Server user). Click the Test Connection button to check the connection to the
database with the selected user, then click Next.
7 If the specified SQL Express database (“eqcas”) already exists (e.g., in the case of an upgrade), the Database
Already Exists screen appears. Select whether to Replace or Keep the existing database, and click Next.
8 If any of the Web Client features are selected for installation, the Web Client - Application Pool screens appears.
For more detailed setup information and prerequisites, see Installing the Web Client on page 48.
9 On the DCE High Availability Setup screen, decide if DCE will be part of a High Availability setup or not.
NOTE: The Administrator Account and Password are required if there is the need to address the distributed cache in
your environment. Any changes to the distributed cache are directed by support. An Equitrac service account or
domain cannot be used as the distribute cache system is not synchronized with Active Directory (AD). The account
name cannot contain spaces, control or any ()<>@,;:\"/[]?={} characters, and must use valid UTF8 encoding.
NOTE: If installing Equitrac on a server with distributed cache already installed, provide the Administrator
credentials used with the pre-existing installation.
3 On the Ready to install Equitrac Express (or Office) screen, click Install to start the installation process. The
installation wizard copies files, sets up services, and creates shortcuts to the Administrative Applications.
4 At the end of the process, click Finish to exit the installation wizard and begin initial configuration.
5 The Processing Distributed Cache System progress screen appears and closes when complete.
DCE HA Setup
If DCE will be part of a High Availability cluster setup, do the following:
NOTE: Couchbase must be installed before installing DCE for HA. See Installing Couchbase Server on page 23.
1 Select the DCE will be part of a High Availability Setup checkbox, and enter the Virtual Server name: The IP
address or hostname of the virtual server configured in the network load balancer (NLB), and click Next. This
must be the same for all DCEs within the cluster.
a Enter the Connection string to the Couchbase database. The string is in the couchbase://hostname/
bucketname format.
b Enter the Administration account and password of the Couchbase server node. These are the Administrator
credentials used when initially installing and configuring Couchbase server.
c Click the Test Connection button to verify the connection to the Couchbase database, then click Next.
3 On the Ready to install Equitrac Express (or Office) screen, click Install to start the installation process. The
installation wizard copies files, sets up services, and creates shortcuts to the Administrative Applications.
4 At the end of the process, click Finish to exit the installation wizard and begin initial configuration.
5 After installing the Equitrac Office or Express components, continue to Configuring the Database on page 36.
Note: The DME component is not bundled with the Equitrac Express Small Campus Edition.
NOTE: The Simple install option cannot be used when installing individual features and applications across multiple
machines. The Simple install contains a default set of core components, features and Administrative applications that
cannot be modified during installation.
1 Close all other applications on the server prior to running the Equitrac Office or Express installation.
2 Obtain the Equitrac Office or Express software zip file from the Equitrac Product Download site. The product
software is available as individual component installers (e.g. server or print client) or as a complete package with
all installers, product documentation and the Microsoft SQL Server 2008 Express application file.
Alternatively, use the physical distribution DVD to run the appropriate installer, if available.
3 Obtain the required product serial number and activation code to enable the software functionality after
installation.
4 Ensure that Windows 10 Universal CRT for Visual Studio 2015 is installed prior to installing Equitrac Office or
Express on a non-Windows 10 OS (such as Windows 7, 8.0, 8.1, Server 2008, 2008 R2, 2012, 2012 R2 and 2016).
5 Select and run the Installer file (Equitrac.Office.exe or Equitrac.Express.exe) to launch the Equitrac Office or
Express 64-bit Installation wizard.
6 Read and accept the terms of the Nuance End User License Agreement, and click Install to continue.
7 At the Welcome screen, click Next to begin the installation process.
NOTE: Although some of the following screenshots may display Equitrac Express, they apply to both Equitrac Office
and Express. The differences between the products are noted when applicable.
8 On the Select Language screen, select the language you want to display in the user interface, and click Next.
NOTE: You cannot change the display language after installation. To change the language, you must uninstall and
reinstall Equitrac Office or Express, setting the language during installation.
NOTE: The Simple install option cannot be used when installing individual features and applications across multiple
machines. The Simple install contains a default set of core components, features and Administrative applications
that cannot be modified during installation.
9 On the Select Features dialog, only select the Core Accounting Server (CAS) from the Server Components and all
Administrative Applications (System Manager, Accounts Manager, Reports Manager, Department Manager and
Device Monitoring Console), and click the Next to continue. If desired, you can change the default installation
folder with the Browse button.
10 On the Service Log On Credentials screen, enter the Account and Password of the user who will run the
Windows services. Alternatively, click the Browse button to search for valid user from a specific location. Click the
Test Credentials button to verify the user., and click Next to continue.
NOTE: The Account field contains the account name in domain\username format. If you are using a SQL Express
database that is not on a domain and you are using local accounts, you must enter computername\username. If
neither domain or computer name prefix is specified, the user is handled as local user.
11 On the Windows Firewall Exceptions screen, select either a manual or automatic setup method for the firewall
exceptions, and then click Next to continue.
12 On the Database platform screen, select either a SQL Server or Oracle database, and click Next.
• If SQL Server is selected (default selection), additional database location and authentication information is
required.
• If Oracle is selected, the Oracle client is automatically located by the wizard and the wizard advances directly to
the Install screen without requiring any additional database information.
13 If SQL Server is specified, select any available database server from the Database Instance drop-down list, and
then click Next. Alternatively, the database server address, and optionally the instance name, can be typed in the
Database Instance field.
14 On the Database Credentials screen, select the authentication type of the selected SQL Server:
• Windows Authentication (default selection): select this option when the user running the Windows Service
account connects to the database server. This user was specified on the Service Log On Credentials screen.
• SQL Authentication: enter the user credentials in the Login and Password fields, (this can be another
Windows user or a SQL Server user). Click the Test Connection button to check the connection to the
database with the selected user, then click Next.
15 If the specified SQL Express database (“eqcas”) already exists (e.g., in the case of an upgrade), the Database
Already Exists screen appears. Select whether to Replace or Keep the existing database, and click Next.
16 Click Install to start the installation process. The installation wizard copies files, sets up services, and creates
shortcuts to the Administrative Applications.
17 At the end of the process, click Finish to exit the installation wizard and begin initial configuration.
After installing the Equitrac Office or Express components, continue to Configuring the Database on page 36.
When using Mixed Mode authentication on a SQL Server, the Equitrac SQL scripts creates the eqcas user account in
the eqcas database and grants this ID Database Owner rights (DBO). The Equitrac service will use this eqcas account
for the ODBC connection.
When using Windows authentication on a SQL Server, the domain user starting the Equitrac services must be granted
DBO privileges to the eqcas database. Please consult Microsoft on the best methods to accomplish this. The Equitrac
service will use this Windows account for the ODBC connection.
5 Start the EQ Scheduler service and then the Equitrac Core Accounting Server service (EQ CAS).
Equitrac Office or Express is now configured to use the Microsoft SQL Server database.
c Set its DSN child value to eqcas with the same name as in step 3.
d Specify the user credentials in the User and Password child values. These values specify the user account
which is used for the eqcas ODBC data source. The DSN name is to be the same.
5 To ensure your Oracle database properly executes the long statements in the final SQL script, open a command
prompt, navigate to C:\Program Files\Equitrac\Office or Express\Tools and execute the following command.
eqdbloader -f <full path to OracleServerLoader.sql> -d <your Oracle ODBC system DSN>
-u <your Oracle Admin user> -p <your Oracle Admin password>
For example:
eqdbloader -f "c:\Program Files\Equitrac\Express\Database\OracleServerLoader.sql" -d
Oracle_DSN -u eqcas -p eqcas
6 Start the EQ Scheduler service and then the Equitrac Core Accounting Server service (EQ CAS).
Equitrac Office or Express is now configured to use the Oracle database.
d The Activation wizard transmits the data and Equitrac returns the status of the activation code(s). The Wizard
automatically records the license activation in System Manager, and displays the following activation results:
• Serial number
• Activation code
• Status (either Success, Invalid; the serial number and activation code is an invalid combination, or Denied;
the serial number was valid but not accepted).
4 Press the Synchronize enterprise license button to initially license the subsidiary CAS from the master CAS.
Thereafter, at each uplink, the master CAS re-licenses the subsidiary CAS as long as the total number of licenses is
not exceeded.
5 The Transaction set options allow you to configure how the subsidiary and master CAS handle data transactions.
• Do not post transactions – the subsidiary servers do not send transactions to the master CAS.
• Post individual transactions – the subsidiary servers send individual transactions to the master CAS. This
option allows the master CAS to view transaction and account data from all CAS servers.
• Collate transactions – the subsidiary servers bundle transactions in one of two ways: Daily or Hourly.
Equitrac (Office/Express) collates daily transactions at the time you selected in Uplink time of day.
You can also select the By Network user option to send or to separate the transactions per network user.
6 Click OK to save the changes.
where <accounting server> represents the system name of your accounting server.
For example: eqrptload.exe -a PRINTSV1 -f reports\uplinkreportlist.csv -u
2 When the command prompt displays the message EQRptLoad success, all of the uplinked reports loaded
successfully. You can select any uplinked report in the Select report to open dialog box.
See the “Creating & Running Reports” chapter in the Equitrac Office and Express Administration Guide for details.
CAUTION: When installing the Equitrac components, you must enter the same user credentials for each machine.
These credentials are used to start and run all services. If you fail to enter the same credentials on all components, CAS
will not respond to requests by DCE, DRE, DME or SPE.
Install DRE
You can install a single Print Server (DRE) or multiple print servers to distribute the load across servers.
To install a DRE, select only the Document Routing Engine server component and the System Manager
Administrative Tool from the Select Features screen. Perform these steps for each DRE you install. See Install the
Server Components on page 42.
I-Queue is an optional feature of DRE. The I-Queue is a single Follow-You Printing queue where all printers are
combined into a single pull group. The I-Queue allows end users to send their print requests to the I-Queue printer,
and then release their jobs at any available network configured MFP through secure document release. When the I-
Queue feature is installed, an I-Queue Printer is auto-created on the DRE print server.
Install DCE
You can install a single Device Control Engine (DCE) or multiple engines to manage the communication load from
control terminal devices.
To install a DCE, select only the Device Control Engine server component from the Select Features screen. See Install
the Server Components on page 42. Perform these steps for each DCE you install. The DCE sub-features Device Web
Server (DWS) and Device Control Server (DCS) are installed by default, but the Smart Card Service and Driver is an
optional feature and is not installed by default. If DWS and Smart Card Service are installed, they must reside on the
DCE machine.
DWS is required in order to manage and control embedded applications on web-based MFPs. When a user logs in at a
web based device, the login data is sent to DWS, which communicates with DCE, and then DCE contacts CAS to
verify the user account.
The Smart Card Service and Driver is required in order to support authentication from a device via a Smart Card.
DCS is required to manage and control Nuance Ethernet card readers. DCS is also required to communicate with
DWS in order to work with some web-based MFPs.
When DCE is selected during Standard installation, there is the option to include DCE in a high availability (HA)
setup or not. If DCE is not selected as part of an HA setup, then a Distributed Cache service for DCE is automatically
installed on the local DCE as part of the Equitrac installation process.
If DCE will be part of the HA setup, then the Couchbase server must be installed and configured on your system
before installing DCE. See Installing Couchbase Server on page 23, and DCE HA Setup on page 30 for more details.
Install DME
You can install one or more Device Monitoring Engines (DME), but you only need one Device Management Console.
To install a DME, select only the Device Monitoring Engine server component from the Select Features screen. See
Install the Server Components on page 42. You can install the Device Management Console on any server within the
deployment, but it’s best to install the console on the CAS Server system. Refer to the "Device Monitoring with DME"
chapter in the Equitrac Office and Express Administration Guide for more information.
Install SPE
The Scan Processing Engine (SPE) is an optional server component required to run the Equitrac (Office/Express) scan
feature. You can install a single SPE or multiple engines to manage the scan load balancing. To install an SPE, select
only the Scan Processing Engine component from the Select Features screen. See Install the Server Components on
page 42.
CAUTION: You cannot change the display language after installation. To change the language, you must uninstall
and reinstall Equitrac Office or Express, setting the language during installation. The display language is
independent of the regional language set on the machine. For example, Equitrac (Office/Express) can display Italian
even if the regional setting is French.
NOTE: The Simple install option cannot be used when installing individual features and applications across multiple
machines. The Simple install contains a default set of core components, features and Administrative applications
that cannot be modified during installation.
9 On the Select Features screen, choose the features you want to install. Click the Next button to continue.
By default, all Server Components (except the Scan Processing Engine) and all Administrative Applications are
selected for installation. Deselect all options not required for the machine you are installing to. Any feature not
selected by default can be installed during initial installation, or they can be installed afterwards.
NOTE: To change the default installation folder for any of the program features, select the feature icon and then click
the Browse button to open the Change destination folder dialog box. The top-level Server Components icon must be
selected to change the location of the individual Server components.
10 If CAS is in cluster environment or is not selected for installation, the Core Accounting Server Location screen
appears. Enter the fully qualified domain name or fixed IP address of the CAS server. Click Test Connection to
validate a connection across the network, and click Next to continue. Optionally, click Next without testing the
CAS server.
11 On the Service Log On Credentials screen, enter the Account and Password of the user who will run the
Windows services. Alternatively, click the Browse button to search for valid user from a specific location. Click the
Test Credentials button to verify the user, and click Next to continue.
NOTE: The Account field contains the account name in domain\username format. If you are using a SQL Express
database that is not on a domain and you are using local accounts, you must enter computername\username. If
neither domain or computer name prefix is specified, the user is handled as local user.
CAUTION: When installing the Equitrac components across multiple machines, you MUST enter the same user
credentials for each machine. These credentials are used to start and run all services. If you fail to enter the same
credentials on all components, CAS will not respond to requests by DCE, DRE, DME or SPE.
12 On the Windows Firewall Exceptions screen, select either a manual or automatic setup method for the firewall
exceptions, and then click Next to continue.
13 Click Install to start the installation process. The installation wizard copies files, sets up services, and creates
shortcuts to the Administrative Applications.
14 At the end of the process, click Finish to exit the installation wizard and begin initial configuration.
6 Specify the version of the print driver to use, and click Next.
7 Enter the Printer name, and click Next. This is the name of the device that is displayed in System Manager.
8 Select to share or not to share the printer with others, and click Next. If sharing the printer, enter a Share name, and
optionally provide a printer location and any comments.
9 Click the Print a test page button, and click Finish to close the Add Printer wizard.
10 Confirm that the test page printed successfully.
4 Verify that the right pane displays a physical device with the name you specified within the Add Printer wizard. If
the device is not listed, disregard the remaining steps in this procedure, and refer to Installation Troubleshooting
on page 57.
5 In the right pane, select and expand the device to view the print queue for the newly added device.
6 Select the print queue to review default information such as pricing and device behavior. Equitrac (Office/Express)
is installed with default pricing of 0.01 per page.
4 In the Select Group dialog box, select the Domain that contains the group who will also have Administrative
privileges on the DRE Print Server machine. All members of the group will be granted the same privileges. If you
want to assign access to only one user, you must create a group on the Domain containing that user only.
5 Select the Group that contains the user, then click OK.
NOTE: The account that is running CAS, DCE, or DRE services has full permission to all Equitrac (Office/Express)
components and Administrative Applications.
NOTE: The default communication between the client web browser and the IIS server is unencrypted. It is
recommended to implement Secure Socket Layer (SSL) security on the IIS server to ensure that all communication
between client web browser and the IIS server is encrypted and secure. For more information, refer to your certificate
provider’s documentation.
Prerequisites
Web Client requires Internet Information Services (IIS) web server with the following features enabled on the target
machine:
• Common HTTP Features (HTTP Errors, Static Content)
• ISAPI Extensions, ISAPI Filters
• On Windows Server 2008 and 2008 R2: .NET Extensibility 4.5, ASP.NET 4.5
• On Windows Server 2012 and 2012 R2: .NET Extensibility 4.5, ASP.NET 4.5
• On Windows Server 2016: .NET Extensibility 4.6, ASP.NET 4.6
• On Windows 8 and 8.1: .NET Framework v4.5
• On Windows 10: .NET Framework v4.5
NOTE: If any listed prerequisite is missing, the installation stops with an error message describing the issue.
Installation
The Web Client applications communicate with CAS and can be installed either on the same machine CAS is deployed
to, or independently from the CAS server. This section describes the installation of the Web Client using the server
installer. After installing the Web Client, some additional configuration steps may be required for the Scan Client and
Web Deposit applications. See the Web Deposit Setup Guide for more details.
To silently install the Web Client from a command line, see Silent Installation on page 69.
The installation can be started as described in Installing Server Components on a Single Machine on page 24.
NOTE: Scan Client connects to the Equitrac database directly. If the database is configured to use Windows
authentication, the application pool user should have rights to connect to the database. Scan Client displays a critical
error message when opened if this account is not properly configured.
NOTE: Web Deposit has its own database which can be configured to use Windows authentication (see the Web
Deposit Setup Guide for more details). In this case, the application pool user should be a user that has rights to connect
to the Web Deposit database. When entering the Account, domain accounts must use the domain name (e.g.
domain\username). If you are using a local account, you must enter the computer name, followed by the account
name (e.g. computername\userid).
2 On the Web Client - Single Sign-On screen, select the Single Sign-On feature, then click Next to enable users to
access the Web Client automatically with their Windows user accounts,.
NOTE: Use the Single Sign-On feature if Equitrac is running in a domain environment and potential Web Client users
are domain members.
3 If the Scan Client is selected for installation and CAS is not being installed, or is not already installed on the same
computer, additional Scan Client database related screens appear.
On the Scan Client - Database platform screen, select the type of database used by the Equitrac server, and then
click Next.
• If SQL Server is selected (default selection), additional Scan Client database information is required.
• If Oracle is selected, the Oracle client is automatically located by the installer and the wizard advances without
requiring any additional Scan Client database information.
4 When using a SQL Server database, the database address and authentication settings must be specified on the Scan
Client – Database Settings screen.
a Select any available database server from the Database drop-down list. Alternatively, the database server
address, and optionally the instance name, can be typed in the Database field.
b Connect using Windows Authentication (default selection): select this option when the user running the Web
Client application pool connects to the database server. This user was specified on the Web Client -
Application Pool screen.
NOTE: If a user was not defined in the Web Client – Application Pool dialog (the default ApplicationPoolIdentity”
user) then the Windows authentication option is disabled.
—Or—
Connect using SQL Authentication: enter the user credentials in the Login and Password fields. This can be
another Windows user or a SQL Server user.
c Click the Test Connection button to check the connection to the database with the selected user, then click
Next.
NOTE: When SQL Express database is used by Equitrac Office or Express, remote access should be enabled in the
SQL Express (disabled by default). To do this, enable the TCP/IP connection with the SQL Express configuration
console and make sure that the SQL Server Browser service is running.
5 If Web Deposit is selected for installation, the location and authentication mode of the Web Deposit database
should be provided on the Web Deposit - Database screen. For detailed setup and configuration information, see
the Web Deposit Setup Guide.
a In the SQL Server that you are installing to field, specify the address and optionally the instance name of the
SQL Server.
b Select Windows authentication credentials of the application pool user if Windows authentication is used on
the specified SQL Server. In this case, Web Deposit will connect the user that was specified at the Web Client -
Application Pool Identity dialog.
NOTE: If a user was not defined in the Web Client – Application Pool dialog (the default ApplicationPoolIdentity”
user) then the Windows authentication option is disabled.
—Or—
Select the SQL Server authentication using the Login and Password below option if the specified SQL Server
uses its own authentication. In this case, enter the Login and the Password of the SQL Server user that are later
used by Web Deposit.
c Click Next to continue.
6 Click Install to start the installation process.
7 At the end of the process, click Finish to exit the installation wizard and begin initial configuration.
NOTE: During installation a new Equitrac application pool and a new EQWebClient web application using port 80 are
created in IIS.
After the installation, it is recommended to set SSL certification in IIS for using the HTTPS protocol. For more
information refer to the Microsoft Knowledge Base article "How To Set Up an HTTPS Service in IIS".
When you use the Web Client for the first time after restarting its application pool (e.g. installation or a computer
reboot), the Web Client behaves very slow (you may wait for more than 30 seconds). It is recommended to open Web
Client in a web browser before end-users start working with it.
NOTE: If the Web Client is used for the first time after initial installation or a computer reboot, it may take more than
30 minutes to load.
2 Web Client opens. Depending on the installation settings, different pages may display:
• If Single Sign-On was not selected, the Login page displays.
• If Single Sign-On was selected, the Web Client tries to log in the user who is running the web browser. The web
browser may ask for Windows user credentials. If the login is not successful, the Login page displays with error
message. Otherwise, another page displays depending on the rights of the logged-in user and the installed web
applications.
3 Web Client can communicate with CAS if login is successful or failed, but not with a communication error.
4 If Scan Client was installed, login with an Equitrac user or a Windows user with Equitrac administrative rights and
start Scan Client. If the scan jobs list screen appears, then Scan Client can connect to the server database. If the
logged-in user only has access to the Scan Client, then Scan Client starts automatically.
5 If Web Deposit was installed, login with an Equitrac user and start Web Deposit. See the Web Deposit Setup Guide.
If the logged-in user only has access to Web Deposit, then Web Deposit starts automatically.
6 For further verification, repeat these steps from another computer.
Configuration
After installing the Web Client some additional reconfigurations may be required (for example, there is a change in
CAS settings or a change to the Web Client authentication is required). Most of the modifications can be done with the
interactive installation wizard, but some can only be done manually.
Refer to the “Release Station” chapter in the Equitrac Office and Express Administration Guide for configuration
information.
Installing MobileDCE
MobileDCE is an Equitrac Express feature that allows for tracking prints and copies without depending on a network
connection to CAS. MobileDCE can be installed on a portable server (e.g. a laptop).
To install MobileDCE, do the following:
1 Locate the MobileDCE.msi on the Equitrac Express Product Download site, or download it from the software
download website.
2 Run MobileDCE.msi on the laptop which will update user PIN data and collect transactions from the PageCounter
terminals.
3 Click Next on the MobileDCE Install Wizard to start the installation.
4 Read and accept the License Agreement, and then click Next.
5 Select a language, and click Next.
6 Select a destination folder to install MobileDCE, and click Next.
7 Enter an Accounting server name, and click Next.
8 Click Install, and then Finish to complete the installation.
Refer to the "Using MobileDCE Server" section in the Equitrac Office and Express Administration Guide for
configuration information.
Installation Troubleshooting
If Licensing Failed
If licensing fails during Automatic Activation, ensure that the Accounting Server is available prior to activation. 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 Installing Web Client with the Default Application Pool Identity Fails
Installing Web Client with the default application pool identity requires Windows Server 2008 (64-bit) Service Pack 2
or later.
WARNING: Do not install any Equitrac Client services on any computer running any Equitrac Server services. If these
services are installed on the same computer, the Equitrac Server may crash and will need to be reinstalled. You cannot
run the Repair option on the server if it crashes, a complete reinstall is required.
4 Obtain the required product serial number and activation code to enable the software functionality after
installation.
5 Ensure that Windows 10 Universal CRT for Visual Studio 2015 is installed prior to installing Workstation Client
on a non-Windows 10 OS (such as Windows 7, 8.0, 8.1, Server 2008, 2008 R2, 2012, 2012 R2 and 2016).
6 Select and run the 64-bit Installer file (Equitrac.Office.x64.Client.msi or Equitrac.Express.x64.Client.msi), or
select and run the 32-bit Installer file (Equitrac.Office.x86.Client.msi or Equitrac.Express.x86.Client.msi) to
launch the Equitrac Office or Express Installation wizard.
7 From the Welcome screen, click Next.
8 Read and accept the End-User License Agreement, and then click Next to continue.
9 Select the language version of the clients you want to install.
10 On the Custom Setup screen, select the client applications to install on the workstation, and click Next.
NOTE: You can check the disk space requirements on the workstation to ensure that enough space is available for
the selected components. Click Disc Usage to view the disk space analysis.
11 On the Core Accounting Server Location screen, enter the fully qualified domain name or fixed IP address of the
CAS server, and click Test Connection to validate a connection across the network, and then click Next to
continue. Otherwise just click Next without testing the CAS server.
12 On the Windows Firewall Exceptions screen, select either a manual or automatic setup method for the firewall
exceptions, and then click Next to continue.
13 Click Install to start the installation process. The installation wizard copies files, sets up services, and creates
shortcuts to the Administrative Applications.
CAUTION: If the cache directory specified for the Temporary File Location during the client installation is on the
network, the shared engine (SE) will not start. The SE runs under the system account and you cannot give Equitrac
\SYSTEM access to the share on the network. You must ensure that the Local System account has write access into
this directory. The cache directory also must reside on the local client machine, not on the network.
NOTE: You must install Desktop Printing feature in order for several client features (Prompt for Login, Cost Preview,
Interactive Print Rules, Print Assistant, Client Billing popup and DRC) to work.
1 Confirm that each Citrix or Terminal server is resolving communications to the CAS and DRE servers by
hostname. On a Client machine, open a command prompt and type ’ping hostname’ where the hostname is
the name of the machine hosting the master CAS or DRE.
2 Close all other applications on the server prior to installing the Workstation Client.
3 Obtain the Equitrac Office or Express Client software file from the Equitrac Product Download site. The Client
Installer is available as an individual installation file or as part of a complete package with all installers, product
documentation and the Microsoft SQL Server 2008 Express application file.
Alternatively, use the physical distribution DVD to run the appropriate installer, if available.
4 Obtain the required product serial number and activation code to enable the software functionality after
installation.
5 Select and run the 64-bit Installer file (Equitrac.Office.x64.Client.msi or Equitrac.Express.x64.Client.msi), or
select and run the 32-bit Installer file (Equitrac.Office.x86.Client.msi or Equitrac.Express.x86.Client.msi) to
launch the Equitrac Office or Express Installation wizard.
6 From the Welcome screen, click Next.
7 Read and accept the End-User License Agreement, and then click Next to continue.
8 Select the language version of the clients you want to install.
9 On the Custom Setup screen, select the client applications to install on the workstation, and click Next.
To select or deselect an item, click on the hard drive icon beside the feature and select one of the following options:
• Will be installed on local hard drive.
• Entire feature will be installed on local hard drive.
• Entire feature will be unavailable.
10 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. Click Yes to continue or No to abort the installation.
11 On the Printing Support screen select Windows printing, and click Next.
12 Enter the CAS server name in the Accounting server field. Click Next to continue.
CAUTION: If the cache directory specified for the Temporary File Location during the client installation is on the
network, the shared engine (SE) will not start. This happens since the SE runs under the system account and there is
no way to give the Equitrac \SYSTEM access to the share on the network. You must therefore ensure that the Local
System account has write access into this directory. The cache directory also must reside on the local client machine,
not on the network.
• Cost Preview – provides a summary of the cost for a print transaction before the user sends the document to
the printer.
• ReleaseKey – requires the user to provide a numeric release key to print documents. (Equitrac Express feature)
• Allow rename document – allows the user to rename their documents at print time, if desired. (Equitrac
Express feature)
4 Enter the CAS Server name or IP address.
NOTE: By default this field is blank. If a value is not entered in this field, the Mac DRC will set the IP address to
127.0.0.1, and the DRC will not function properly.
5 In the DRC system name section, select what identifier to use for the Mac DRC.
• IP address – the Mac computer IP address.
• Bonjour name – the Mac computer’s local network name.
• DNS hostname – the user-specified string.
NOTE: The identifier must be stable and unique across the CAS database, and must be resolvable from Windows,
since it will be used by other system components (e.g. System Manager) to open the network connection and to
communicate with the Mac DRC.
If using Bonjour name, then your computer’s name is appended with ".local", and any spaces are replaced with
hyphens. For example, if your computer’s name is My Computer, the its Bonjour name would be My-
Computer.local. The Bonjour name is generated by Mac OS X.
If using DNS hostname, do the following:
• Enter the hostname identifier or click Generate to populate the field. It is recommended to qualify the DNS
hostname with the network domain name. For example, computer_1.nuance.com
• Select Register with DNS server to enable the Mac client to register the specified hostname with DNS server
every 24 hours.
c On the login popup, enter your Name (user ID) and Password, and click OK.
9 Click Close to complete the client installation.
10 Logout of the Mac system and login again to enable printer functionality. Users logged in to the system during
installation, must log out and then log back in before printing functions become available to them.
Setting Languages
The Mac OS allows users to set the Preferred languages list in the System Preferences. The EQLoginController
application goes through the Preferred languages list until it finds the first supported language in the list. If no
localized language is supported (or selected), it defaults to English. If the Preferred languages list is changed in the
System Preferences, then the EQLoginController must be restarted.
3 In the DRE Address field, enter the DRE server IP address, and click Get Printers.
The Equitrac Printer Utility queries DRE for a list of accessible printers.
4 Select the appropriate printer from the list, and click OK.
3 Enter the IP Address and Name of the printer, and click OK.
The new printer displays in the available printers list.
/Library/LaunchAgents/
/Library/LaunchDaemons/
/usr/libexec/cups/backend/eqtrans
/usr/libexec/cups/backend/eqpmon
Ownership:
eqpmon - root
eqtrans - root
Troubleshooting
If there is an MAC Client installation problem, verify the following:
• The Name/IP displayed in the CAS Server field in the EQPrintUtilityX.app > Preferences dialog is set to a valid
CAS machine name IP, and not 127.0.0.1.
• The Name/IP displayed in the CAS Server field in the EQPrintUtilityX.app > Preferences dialog can be pinged
from a MAC workstation.
• The workstation license is available on the CAS server.
If you plan to deploy the same Equitrac Office or Express features across several servers, silent installation can be used
to simplify the installation process. Silent installation is handled by the Microsoft Windows Installer by specifying
options and features to install from the Equitrac Office or Express install package to the Windows installer. This
document outlines each feature that can be installed, but these features can be combined into one command to install
multiple components on a single server.
If you are upgrading to Equitrac Office or Express version 5.7 from an earlier version, refer to Upgrade Equitrac
Office/Express on page 88.
NOTE: For Windows Servers 2008, 2008 R2, 2012, 2012 R2 and 2016, make sure the server is up to date with the latest
service packs, or manually download and install the latest version of Windows Installer from www.microsoft.com.
Windows Installer 4.5 is required to install Equitrac (Office/Express) 5.7. If you do not have Windows Installer 4.5 the
following error displays: “This installation package cannot be installed by the Windows Installer service. You must install a
Windows service pack that contains a newer version of the Windows Installer Service.”
Server Installation
Equitrac server components (CAS, DRE, DCE, DME, SPE) and Web Client are only available in 64-bit. Administrative
applications, Auxiliary applications and Workstation Client are available in both 32-bit and 64-bit installers.
NOTE: If the ADDLOCAL parameter is specified, it must contain the Common value to install and configure the
required common files. If you want to install a specific component (for example, Documentation), specify it as one of
the feature names in the ADDLOCAL parameter.
Example:
ADDLOCAL="Common,CAS,AdministrativeApplications,SystemManager,Documentation,IQueue"
Options
To install the Core Accounting Server, the following options must be specified to the installer:
CASNAME – This is the name of the Equitrac Core Accounting Server. Based on your network configuration, use a
name or IP address that other components can use to connect to the server. If this option is not specified, its default
value is the local computer name.
LANGUAGE – This specifies the installation language. If this option is not specified, the default installation language
is English. The following values can be specified:
"en" – English
"es" – Spanish
"fr" – French
"it" – Italian
"de" – German
"pt" – Portuguese
"zh" – Chinese
SRVCUID – This option specifies the name of the account under which the services will run. Domain accounts
should be qualified with the domain name (e.g. DomainName\UserID). If this option is not specified, the installation
fails.
SRVCPWD – This option specifies the password of the account under which the services will run. If this option is not
specified, the installation fails.
CAS_DBTYPE – This option specifies the type of database to which CAS will connect. Its default value is
“SQLSERVER”. The following values can be specified:
"SQLSERVER" – Microsoft SQL Server or Microsoft SQL Express
"ORACLE" – Oracle
CAS_DBSERVER – This option is only specified when installing CAS with a Microsoft SQL Server or SQL Express
database type. This parameter specifies the SQL Server database to which CAS will connect. If a port number also has
to be specified, use the comma (",") character as a port separator (e.g. "hostname,port"). If this option is not specified,
its default value is “.\SQLEXPRESS".
CAS_DBLOGONTYPE – This option select the authentication mode used to connect to the specified SQL Server or
SQL Express. Its default value is “WinAuth”. The following values can be specified:
“WinAuth” – Windows authentication
“SqlAuth” – SQL authentication
CAS_DBUID – This option specifies the account name of the user who will connect to the Equitrac Express or Office
repository. This option has effect only if the selected database platform is SQL Server or SQL Server Express (the
CAS_DBTYPE option is “SQLSERVER”).
CAS_DBPWD – This option specifies the password of the user who will connect to the Equitrac Express or Office
repository. This option has effect only if the selected database platform is SQL Server or SQL Server Express (the
CAS_DBTYPE option is “SQLSERVER”).
CAS_DBOVERWRITE - This option indicates that existing database should be deleted and the new one created
when the user installs CAS and database type is SQL Server or SQL Express. In this case, installer detects if database is
Express and if database with name “eqcas” already exists.
Options
To install the Document Routing Engine, the following options must be specified to the installer:
CASNAME – This is the name of the Equitrac Core Accounting Server. Based on your network configuration, use a
name or IP address that other components can use to connect to the server. If this option is not specified, its default
value is the local computer name.
LANGUAGE – This specifies the installation language. If this option is not specified, the default installation language
is English. The following values can be specified:
"en" – English
"es" – Spanish
"fr" – French
"it" – Italian
"de" – German
"pt" – Portuguese
"zh" – Chinese
SRVCUID – This option specifies the name of the account under which the services will run. Domain accounts
should be qualified with the domain name (e.g. DomainName\UserID). If this option is not specified, the installation
fails.
SRVCPWD – This option specifies the password of the account under which the services will run. If this option is not
specified, the installation fails.
EQDRENAME – This option only needs to be specified if installing DRE on a cluster. Based on your network
configuration, use a name or IP address that other components can use to connect to the DRE server. On a cluster, this
will be the name or IP address associated with the resource group in which DRE will run.
Options
To install the Device Control Engine, the following options must be specified to the installer:
CASNAME – This is the name of the Equitrac Core Accounting Server. Based on your network configuration, use a
name or IP address that other components can use to connect to the server. If this option is not specified, its default
value is the local computer name.
LANGUAGE – This specifies the installation language. If this option is not specified, the default installation language
is English. The following values can be specified:
"en" – English
"es" – Spanish
"fr" – French
"it" – Italian
"de" – German
"pt" – Portuguese
"zh" – Chinese
SRVCUID – This option specifies the name of the account under which the services will run. Domain accounts
should be qualified with the domain name (e.g. DomainName\UserID). If this option is not specified, the installation
fails.
SRVCPWD – This option specifies the password of the account under which the services will run. If this option is not
specified, the installation fails.
DCE_CACHE_DISTRIBUTED – This option specifies if DCE is part of a High Availability setup or not.
DCE_VSN – This option specifies the IP/hostname of the virtual server configured in the Network Load Balancer.
DCE_COUCHBASE – This option specifies the connection string to the Couchbase database. The string is in the
couchbase://hostname/bucketname format.
COUCHBASE_USERNAME – This option specifies the Administrator’s username on the Couchbase server node.
COUCHBASE_PASSWORD – This option specifies the Administrator’s password on the Couchbase server node.
Options
To install the Device Monitoring Engine, the following options must be specified to the installer:
CASNAME – This is the name of the Equitrac Core Accounting Server. Based on your network configuration, use a
name or IP address that other components can use to connect to the server. If this option is not specified, its default
value is the local computer name.
LANGUAGE – This specifies the installation language. If this option is not specified, the default installation language
is English. The following values can be specified:
"en" – English
"es" – Spanish
"fr" – French
"it" – Italian
"de" – German
"pt" – Portuguese
"zh" – Chinese
SRVCUID – This option specifies the name of the account under which the services will run. Domain accounts
should be qualified with the domain name (e.g. DomainName\UserID). If this option is not specified, the installation
fails.
SRVCPWD – This option specifies the password of the account under which the services will run. If this option is not
specified, the installation fails.
Options
To install the Scan Processing Engine, the following options must be specified to the installer:
CASNAME – This is the name of the Equitrac Core Accounting Server. Based on your network configuration, use a
name or IP address that other components can use to connect to the server. If this option is not specified, its default
value is the local computer name.
LANGUAGE – This specifies the installation language. If this option is not specified, the default installation language
is English. The following values can be specified:
"en" – English
"es" – Spanish
"fr" – French
"it" – Italian
"de" – German
"pt" – Portuguese
"zh" – Chinese
SRVCUID – This option specifies the name of the account under which the services will run. Domain accounts
should be qualified with the domain name (e.g. DomainName\UserID). If this option is not specified, the installation
fails.
SRVCPWD – This option specifies the password of the account under which the services will run. If this option is not
specified, the installation fails.
Administrative Applications
Features
To install the various administrative applications, the following features are specified in ADDLOCAL:
Common – These are common components essential for every installation of the product, regardless of features being
installed. This feature has to be installed.
AdministrativeApplications – These are all the common tools and libraries used by the various administrative
applications and must be installed regardless of which applications are going to be installed.
SystemManager – Include this feature to install the System Manager administrative application. It enables
administrators to maintain system settings and configuration.
AccountManager – Include this feature to install the Accounts Manager administrative application. It enables
administrators to set up accounts and maintain account details.
ReportManager – Include this feature to install the Reports Manager. It enables administrators to view and maintain
standard and customized reports.
DeviceMonitoringConsole – Include this feature to install Device Monitoring Console which enables administrators
to monitor device status and faults.
DepartmentManager – Include this feature to install Department manager which enables department administrators
to maintain account settings.
Options
To install the Administrative Applications, the following options must be specified to the installer:
LANGUAGE – This specifies the installation language. If this option is not specified, the default installation language
is English. The following values can be specified:
"en" – English
"es" – Spanish
"fr" – French
"it" – Italian
"de" – German
"pt" – Portuguese
"zh" – Chinese
Auxiliary Applications
Features
To install the various optional public workstation applications, the following features are specified in ADDLOCAL:
Common – These are common components essential for every installation of the product, regardless of features being
installed. This feature has to be installed.
AuxApplications – These are all the common libraries used by the various auxiliary applications and must be
installed regardless of which auxiliary applications are going to be installed.
F.ReleaseStation – Include this feature to install Release Station. Your users can release print jobs held at the print
server when secure printing is configured.
F.Cashier – Include this Equitrac Express feature to install the Cashier for staff to record transactions against user
accounts; a subset of Accounts Manager functionality.
F.DepositStation – Include this Equitrac Express feature to install Deposit Station. Your users can transfer funds from
value cards to their Equitrac accounts.
F.EQXLPD – Include this option to make EQXLPD available for configuration. EQXLPD is a Windows service that
provides extended LPD functionality to enable administrators to map or modify user IDs for incoming LPR print jobs.
Options
To install the Auxiliary Applications, the following options must be specified to the installer:
LANGUAGE – This specifies the installation language. If this option is not specified, the default installation language
is English. The following values can be specified:
"en" – English
"es" – Spanish
"fr" – French
"it" – Italian
"de" – German
"pt" – Portuguese
"zh" – Chinese
Web Client
Features
To install the Web Client, the following features can be specified in ADDLOCAL:
Common – These are common components essential for every installation of the product, regardless of features being
installed. This feature has to be installed.
ScanClient – This feature installs Scan Client.
WebSystemManager – This feature installs Web System Manager.
UserDashboard – This feature installs User Dashboard.
WebReports – This feature installs Web Reports.
WebDeposit – This feature installs Web Deposit.
Options
The following options effect all Web Client features:
CASNAME – This is the name of the Core Accounting Server. Based on your network configuration use a fully
qualified domain name or fixed IP address. If this option is not specified, its default value is the local computer name.
WC_APPPOOL_UID – Specify the account name of the user who will run the Web Client Application Pool in IIS. If
this option is not specified, the default “ApplicationPoolIdentity” user will be set.
WC_APPPOOL_PWD – Specify the password of the user who will run the Web Client Application Pool in IIS. This
option is only has effect if the WC_APPPOOL_UID option is also specified.
WC_SSO – Enable or disable the Single Sign-On authentication mode of Web Client. If it is set to “0” or not specified,
Single Sign-On will be disabled, which is the default setting.
The following options have effect only for Scan Client and if CAS is not installed on the same machine:
WC_SCANCLIENT_DBTYPE – Selects the database platform used by the Equitrac Express or Office repository. If it
is “2”, Scan Client will be configured to use Oracle. Otherwise Scan Client will connect to a SQL Server or SQL Server
Express database, which is the default setting.
WC_SCANCLIENT_SQLADDRESS – Specify the location (server name and optionally the database instance) of the
Equitrac Express or Office repository. This option has effect only if the selected database platform is SQL Server or
SQL Server Express (the WC_SCANCLIENT_DBTYPE option is not “2”). If a port number also has to be specified,
use the comma (",") character as a port separator (e.g. "hostname,port"). If this option is not specified, its default value
is “.\SQLEXPRESS”.
WC_SCANCLIENT_SQLUID – Specify the account name of the user who will connect to the Equitrac Express or
Office repository. This option has effect only if the selected database platform is SQL Server or SQL Server Express
(the WC_SCANCLIENT_DBTYPE option is not “2”). If this option is not specified, Windows authentication will be
used meaning the Web Client application pool user connecting to the database.
WC_SCANCLIENT_SQLPWD – Specify the password of the user who will connect to the Equitrac Express or Office
repository. This option has effect only if the selected database platform is SQL Server or SQL Server Express (the
WC_SCANCLIENT_DBTYPE option is not “2”) and the WC_SCANCLIENT_SQLUID option is also specified.
7 Replace the "options" variable with the components you have licensed or plan to use. Separate the options with
a comma, and do not use spaces between the commas.
Options
To silently install the Equitrac Workstation Client, the following options must be specified.
Common – Required option for all commands. Installs the common files required for any type of install.
DesktopPrinting – Installs the Desktop Print Tracking feature.
ClientBilling – Installs the Client Billing feature.
PromptForLogin – Installs the Prompt for Login feature.
DocumentRename – If using Release Stations, use this option to install the Document Rename feature that allows
users to rename documents.
ReleaseKey – Use this Equitrac Express option to install the release key feature. This is not compatible with Login or
Billing Code prompts.
CostPreview – Installs the Cost Preview feature.
NetworkPrinting – This option tracks Windows DRE printing to Windows print servers.
DRC – Installs the Document Routing Client for Direct IP printing.
NOTE: For the DRC option, you must also select DesktopPrinting if you require a popup from one of the other options
(Client Billing, Prompt for Login, Cost Preview, ReleaseKey, DocumentRename, Interactive Rules). Do not install on a
server where DRE is installed, as they are not compatible.
IQueue – This feature enables I-Queue printing.
ManagedQueue – This feature enables Managed Queue printing.
InteractiveRules – This function allows a server-based print rule to interact with the end user when running on a
Windows print server. This change does not apply to workstation rules or copy rules.
EQMsg – This option displays messages in the Windows system tray via the Equitrac Message Client.
Example for installing Equitrac Office or Express interactively with the I-Queue defaulted to monochrome:
msiexec /i Equitrac.[Office].[Express].Client.x64.msi IQUEUE_DEFAULT_COLOR=1
Installation Examples
The following are some installation examples using management tools on a server. All parameters are case-sensitive
and must be typed as shown.
NOTE: The Nuance certificate must be pre-trusted before running a silent install. If the Nuance certificate is not
already added, then a Windows security popup appears requesting that you Always trust software from "Nuance
Communications, Inc" to add the certificate, and the silent install stops.
Installing CAS
Microsoft SQL Server
Equitrac.[Office].[Express].exe
ADDLOCAL="Common,CAS,AdministrativeApplications,SystemManager,AccountManager,ReportMa
nager,DeviceMonitoringConsole,DepartmentManager" CASNAME="EQCASSERVER" LANGUAGE="en"
CAS_DBSERVER="DBSERVERNAME\EQINSTANCE" SRVCUID="DomainName\equitrac"
SRVCPWD="password" /q
Oracle
Equitrac.[Office].[Express].exe
ADDLOCAL="Common,CAS,AdministrativeApplications,SystemManager,AccountManager,ReportMa
nager,DeviceMonitoringConsole,Department_Manager" CASNAME="EQCASSERVER" LANGUAGE="en"
DBTYPE="ORACLE" SRVCUID="DomainName\equitrac" SRVCPWD="password" /q
Installing DRE
Standalone Print Server
Equitrac.[Office].[Express].exe ADDLOCAL="Common,DRE" CASNAME="EQCASSERVER"
LANGUAGE="en" SRVCUID="DomainName\equitrac" SRVCPWD="password" /q
Installing DCE
Standalone DCE Server
Equitrac.[Office].[Express].exe ADDLOCAL="Common,DCE" CASNAME="EQCASSERVER"
LANGUAGE="en" SRVCUID="DomainName\equitrac" SRVCPWD="password"
COUCHBASE_USERNAME="Administrator" COUCHBASE_PASSWORD="Password" /q
Installing DME
Standalone DME Server
Equitrac.[Office].[Express].exe ADDLOCAL="Common,DME" CASNAME="EQCASSERVER"
LANGUAGE="en" SRVCUID="DomainName\equitrac" SRVCPWD="password" /q
Installing SPE
Standalone SPE Server
Equitrac.[Office].[Express].exe ADDLOCAL="Common,SPE" CASNAME="EQCASSERVER"
LANGUAGE="en" SRVCUID="DomainName\equitrac" SRVCPWD="password" /q
Reports Manager
Equitrac.[Office].[Express].exe
ADDLOCAL="Common,AdministrativeApplications,ReportManager" LANGUAGE="en" /q
Department Manager
Equitrac.[Office].[Express].exe
ADDLOCAL="Common,AdministrativeApplications,DepartmentManager" LANGUAGE="en" /q
Release Station
Equitrac.[Office].[Express].exe ADDLOCAL="Common,AuxApplications,F.ReleaseStation"
LANGUAGE="en" /q
Cashier
Equitrac.Express.exe ADDLOCAL="Common,AuxApplications,F.Cashier" LANGUAGE="en" /q
Deposit Station
Equitrac.Express.exe ADDLOCAL="Common,AuxApplications,F.DepositStation" LANGUAGE="en"
/q
EQXLPD
Equitrac.[Office].[Express].exe ADDLOCAL="Common,AuxApplications,F.EQXLPD"
LANGUAGE="en" /q
Documentation
Equitrac.[Office].[Express].exe ADDLOCAL="Common,AuxApplications,Documentation"
LANGUAGE="en" /q
This example sets an application pool user, enables Single Sign-On, CAS uses SQL Server Express database and sets the
default local SQL Server Express database for Web Deposit with Windows authentication:
Equitrac.[Office].[Express].exe
ADDLOCAL="Common,CAS,ScanClient,UserDashboard,WebDeposit,WebReports,WebSystemManager"
CASNAME="EQCASSERVER" LANGUAGE="en" SRVCUID="DomainName\equitrac" SRVCPWD="password"
WC_APPPOOL_UID=”DomainName\equitrac” WC_APPPOOL_PWD=”password” WC_SSO=”1” /q
This example installs only Scan Client on a computer where CAS is not installed. It sets an application pool user,
enables Single Sign-On and sets the Equitrac Office or Express repository settings, which means Oracle database:
Equitrac.[Office].[Express].exe ADDLOCAL="Common,ScanClient" CASNAME="EQCASSERVER"
WC_APPPOOL_UID=”DomainName\equitrac” WC_APPPOOL_PWD=”password” WC_SSO=”1”
WC_SCANCLIENT_DBTYPE="2" /q
This example installs only Web Deposit with a specified application pool user, enables Single Sign-On sets a SQL
Server database for Web Deposit with Windows authentication:
Equitrac.Express.exe ADDLOCAL="Common,WebDeposit" CASNAME="EQCASSERVER"
WC_APPPOOL_UID=”DomainName\equitrac” WC_APPPOOL_PWD=”password” WC_SSO=”1”
WCÜDEPOSITÜSQLADDRESS="DBSERVERNAME" /q
Transforms Example
The following procedure describes a scenario using Orca to generate a transform to hardcode using the Equitrac
services username and password.
1 Open the msi using Orca.
2 In the Transform menu, select New Transform.
3 Alter the Property table for the following properties:
a Add the property SRVCUID and set it to the name of the account under which the services will run.
b Add the property SRVCPWD and set it to the password of the account under which the services will run.
4 In the Transform menu, generate the transform and save the MST file.
To apply the transform, specify the MST file in the TRANSFORMS property during installation. For example, for a
transform that is used to hardcode the SRVCUID and SRVCPWD properties named serviceaccount.mst, specify
TRANSFORMS=serviceaccount.mst instead of the SRVCUID and SRVCPWD properties.
Example for installing DRE with this transform:
Equitrac.[Office].[Express].exe ADDLOCAL="Common,DRE" CASNAME="EQCASSERVER"
LANGUAGE="en" TRANSFORMS="serviceaccount.mst"
CAS_DBSERVER – This option is only specified when installing CAS with a database type of Microsoft SQL Server.
This parameter specifies the SQL Server database to which CAS will connect.
SRVCUID – This option specifies the name of the account under which the services will run. Domain accounts
should be qualified with the domain name (e.g. DomainName\UserID).
SRVCPWD – This option specifies the password of the account under which the services will run.
EQDRENAME – This option only needs to be specified if installing DRE on a cluster. Based on your network
configuration, use a name or IP address that other components can use to connect to the DRE server. On a cluster, this
will be the name or IP address associated with the resource group in which DRE will run.
Example for installing Equitrac Office or Express interactively with the I-Queue defaulted to monochrome:
Equitrac.[Office].[Express].exe IQUEUE_DEFAULT_COLOR=1
This chapter provides detailed instructions to upgrade to Equitrac Office or Express version 5.7 from a previous
version.
Refer to the ReleaseNotes.pdf on the Equitrac Product Download site for potential important installation or upgrade
information not contained in this document.
NOTE: If you require assistance while upgrading, contact the Technical Support Centre:
Phone: 1.877.EQUITRAC (1.877.378.4872) or +1.519.885.2417 for calls outside of North America.
Planning an Upgrade
When planning an upgrade to Equitrac Office or Express version 5.7 consider the following:
• If upgrading from Equitrac (Office/Express) 4.x, you must have a valid 4.x maintenance license applied in System
Manager > Licensing prior to upgrading. The upgrade only proceeds if the license is found/validated by the
Installer. Equitrac 5.7 requires new licenses and cannot function with the existing 4.x licenses after the upgrade is
complete. After upgrading to version 5.7 System Manager removes the old 4.x licenses and applies the 5.7 licenses.
It is recommended that you write down your existing 4.x licenses, and obtain the new 5.7 licenses before
proceeding with the upgrade. The 4.x licenses are removed immediately after installing 5.7, and Equitrac cannot
function until the 5.7 licenses are applied.
• 32-bit server components are not supported in Equitrac (Office/Express) version 5.7. A direct upgrade from an
earlier version of Equitrac running 32-bit server components to version 5.7 running 64-bit cannot be done. If you
currently have any 32-bit server components installed on a 64-bit system, you must remove them and then re-
install the 64-bit components. 32-bit Administrative applications (e.g System Manager, Reports Manager) and
Workstation Client components can be upgraded on 64-bit systems.
• You must be running at least Equitrac (Office/Express) 4.2.6 in order to upgrade to version 5.7. A direct upgrade
from version 4.2.5 or lower to version 5.7 is not supported.
• If upgrading from versions 4.2.1 through 4.2.5 to version 5.7, you first need to fully upgrade all components to
4.2.6, and then upgrade to 5.7. You do not need to uninstall the earlier version of Equitrac when upgrading from
4.2.6 to 5.7, and the database will upgrade accordingly.
• If upgrading from version 4.2.0 (or lower), you must uninstall the current version of Equitrac (Office/Express) and
any applicable hotfixes, and then fully install all components to version 4.2.6. After installing 4.2.6, you can then
perform a direct upgrade to 5.7. Do not perform a partial upgrade to version 4.2.6, as all Equitrac Office or Express
components need to be running at least 4.2.6 in order to upgrade to version 5.7.
• If upgrading from version 5.1 (or lower) to version 5.7, and have existing Equitrac printer ports configured, you
will be prompted to keep or remove the Equitrac ports. Keep these ports as they will be converted to standard
TPC/IP ports while maintaining the printer port definitions after upgrading DRE.
NOTE: When upgrading from Equitrac (Office/Express) 5.1 (or lower) to 5.7, you must open a command window as
Administrator, and run the Installer from the command line.
• If upgrading from 5.5 (or lower) to 5.7, and you currently have physical devices on TCP/IP ports that are not
registered in System Manager, CAS attempts to pull licenses to those devices after upgrade. After the upgrade, all
devices on TCP/IP ports appear in System Manager, and are tracked in the Equitrac database. To prevent licenses
being pulled to these devices, set the Tracking Behavior in the physical device summary to "Do not track or record
print transactions on this device" after the upgrade.
• Existing e-Queue Ports will be converted to standard TCP\IP ports and will continue to function as before when
upgrading to version 5.7. However, new e-Queue ports cannot be created.
• Existing Port type devices will be removed from System Manager once the DRE they are associated with is
upgraded to version 5.7.
• After upgrading CAS, DRE configurations from version 5.5 or lower will continue to be supported until the DRE is
upgraded. The Output Options will be migrated to 5.7 once CAS is upgraded.
NOTE: When upgrading DRE, stored/cached print jobs will be lost due to database schema changes in version 5.7.
• If an earlier version is installed on a Small Business Server 2011 system, a direct upgrade cannot be performed as
Small Business 2011 is not supported in version 5.7. A new install on another supported server is required.
• If upgrading a small deployment, you can schedule a period of downtime and perform the upgrade quickly. You
must upgrade CAS first, then upgrade the remaining components in any order.
• If performing this upgrade for a large deployment, you should consider a phased upgrade. Phasing the upgrade
allows you to upgrade different components at different times, which will minimize the print/scan/copy/fax
interruption within your site. See Phased Upgrade Workflow on page 90.
• If you made any changes to the User Dashboard pages, you must back them up before performing an upgrade.
These pages are not translated, and any changes will be lost when installing Equitrac Office or Express.
Performing an Upgrade
A direct upgrade from Equitrac (Office/Express) version 4.2.0 or lower to version 5.7 is not supported. If you are
upgrading from version 4.2.0 (or lower), you must uninstall the current version of Equitrac Office or Express and any
applicable hotfixes, and then install version 4.2.6 and then upgrade to 5.7. Refer to Uninstall Equitrac Office/Express
on page 95 and Server Installation on page 22 for either Local or Remote installation details.
Whether performing a phased upgrade, or upgrading all components during a period of scheduled downtime, the
following instructions guide you through the Equitrac installation wizard.
Backing up your CAS database prior to performing an upgrade is recommended. Before upgrading, ensure that all
machines within the current Equitrac Office or Express deployment meet the operating requirements. See Additional
Documentation on page 20.
If upgrading from Equitrac Office or Express 5.2 to 5.7, and DWS is currently installed, you must uninstall version 5.2,
and manually remove the DWS service prior to the upgrade. To remove the DWS service, open a command window as
Administrator, and run the sc delete EQDWSSrv script from the command line.
If you installed remote server components (server components hosted on a different machine other than the master
CAS), perform these steps to upgrade each machine within the Equitrac Office or Express deployment.
If you deployed the Equitrac Express Small Campus Edition and all server components are installed on a single
system, perform these steps only once to upgrade the server, then run the client installation wizard to upgrade clients.
During the upgrade, all CAS information is maintained—not overwritten.
Upgrade the Equitrac (Office/Express) components in the following order:
1 Master CAS
2 Licenses
3 Subsidiary CAS (if applicable)
4 DRE/DME (Typically, DME is installed on the DRE server)
5 DCE
6 SPE
7 Release Stations (if applicable)
8 Web Client
9 Client workstations
2 Start the installer and steps through the installation wizard as described in Installing Server Components on a
Single Machine on page 24.
During the installation, on the Select Features dialog choose the features you want to install. Ensure that you
select only the appropriate components to upgrade for this machine. In most cases, these will be the same
components that were installed with the previous version of the product.
3 Finish the installation. The selected components will be upgraded on this machine.
4 After you upgrade the master CAS, apply all Equitrac Office/Express 5.7 licenses immediately (including DRE,
DCE, Workstation Client licenses, etc). Refer to Applying Equitrac Office and Express Licenses on page 37 for
instructions.
Upload Reports
Follow the instructions below for your database type. These instructions update the CAS database to accept new
report definitions. If you are using a SQL Express database, you do not need to perform this task.
SQL Database Configuration:
To set up Equitrac (Office/Express) reports within SQL Server, open a command prompt, navigate to C:\Program
Files\Equitrac\Office or Express\Accounting Service and execute the following command:
eqrptload.exe -a <accounting server> -f reports\reportlist.csv -u -v
reports\variables.csv -h reports\globalstyle.txt
where <accounting server> represents the system name of your accounting server.
For example:
eqrptload.exe -a PRINTSV1 -f reports\reportlist.csv -u -v reports\variables.csv -h
reports\globalstyle.txt
where <accounting server> represents the system name of your accounting server.
For example:
eqrptload.exe -a ACCTSRV-1 -file reports\reportlist.csv -upload -v
reports\variables.csv -h reports\globalstyle.txt
Known Issues
DWS
When upgrading from Equitrac Office or Express version 5.2 to 5.7 with DWS currently installed, you must uninstall
version 5.2, and manually remove the DWS service prior to the upgrade. To remove the DWS service, open a
command window as Administrator, and run the sc delete EQDWSSrv script from the command line.
To uninstall Equitrac Office or Express, you must remove both server and client components from the appropriate
machines. In the case of Mac clients, you must run the Client installation wizard, then select Remove from the options.
This chapter provides uninstall instructions for the server and client components, and details how to restore printers
to defaults.
where <path> is the full path to the location where you copied the client.msi file.
The workstation will reboot automatically after the uninstall is complete. If you need to suppress the reboot, enter the
following command instead:
msiexec /x "<path>\Equitrac.[Office].[Express].Client.x64.msi" /q /norestart
Mac
To uninstall the Mac Client, do the following:
1 Login to the Mac Client with Administrator privileges.
2 Unpack the Equitrac_Office/Express_MacOSX_xxxx.zip file.
3 To remove the Mac Client from a single workstation, do the following:
a Select Uninstall > EquitracUninstall from the Finder.
b Click Run.
c Enter your Name and Password, and click OK.
4 To remove the Mac Client from multiple workstations at one time, do the following:
a Copy the EquitracUninstall.sh script onto each workstation via Apple Remote Desktop (ARD).
Run the uninstall script via ARD on each workstation.