Install Equitrac in a production environment

The following is a basic overview of the installation process for Equitrac as a standalone product in a production environment. There are many installation options available to suit your deployment needs. Although this procedure is for installing a standalone Equitrac solution, the option to install other ControlSuite products are available within the Install Assistant questionnaire pages.

To install Equitrac, do the following:

  1. Download the installer package (Web Installer or Offline Installer) and run the InstallAssistant application.
  2. Click Get Started on the Welcome page.
  3. A Questionnaire page opens asking Do you want to check for updated Install Assistant files? Select Yes or No and then click Next to continue.
    If "Yes" is selected, any updated Install Assistant configuration files will be downloaded from the software download server. The files that require updating are not overwritten, and the system creates a backup file with a .bak extension for the older files. Once any updated files are downloaded, click OK on the popup message to continue with the installation.
    Select "No" to continue with the installation without checking for updates.
  4. When asked Do you want to create an offline installer package? select Yes or No and then click Next to continue.
    If "Yes" is selected, a Summary page opens with Offline installer package location field and the package name. Click Next to continue. The Install Assistant will download all ControlSuite component installers and create an offline installer package, but will not install ControlSuite. The Results page opens displaying that the offline installer package was successfully created. Click Finish to continue. See Create an offline installation package for details.
    If "No" is selected, the installation process continues.
  5. Depending on whether ControlSuite is already installed on your system, or if you are performing a fresh installation, one of the following questionnaire screens opens.
    • ControlSuite is already installed on this system. What would you like to do?
    • Do you want to use the Install Assistant Wizard or manually configure the server?
  6. When asked ControlSuite is already installed on this system. What would you like to do? Select one of the following options and then click Next to continue.
    • Upgrade to a newer ControlSuite version or modify current installation. If you select to upgrade to a newer version or to modify a current installation, a Summary page opens listing the currently installed components. Click the Advanced link to modify the components to be installed.
    • Uninstall ControlSuite. All ControlSuite components are uninstalled and removed from the server. Click Yes on the popup message to uninstall ControlSuite and to continue with the installation.
      The Uninstall option only removes the ControlSuite components. Go to Uninstall ControlSuite to uninstall the components and remove configuration data from a previous installation.
  7. When asked Do you want to use the Install Assistant Wizard or manually configure the server? select one of the following option and click Next.
    • Use the Install Assistant Wizard (recommended) - Select this to use the wizard to walk you through the installation process.
    • Manually Configure - This option is intended for advanced users who are familiar with the components. This options skips the questionnaire and goes directly to the Advanced installation page.
  8. When asked What software do you want to install on this server? select Equitrac print management, and click Next.
    Your license determines the functionality that is available. Some of the features selected to install may not be enabled if you do not have the correct licensing package.
  9. When asked Are you installing Equitrac in a production environment or do you want to build a demo or Proof of Concept (POC) server? select I am building an Equitrac production environment and click Next.
  10. When asked Will this be your primary Equitrac Core Accounting Server (CAS)? select one of the following options and click Next.
    • Yes, this will be my primary Equitrac Core Accounting Server (CAS) - This installs the Equitrac core configuration, authentication and accounting features. The Security Framework will also be installed on this server. You can un-select the security framework from the Advanced Selection page if you have already created a Security Framework datacenter and don’t require any additional nodes. See Understanding Security Framework Datacenters for more details.
    • No, this server will host a secondary CAS or support print management capabilities - Select this option if you already have a primary Equitrac server, but want to add other print capabilities to this server.
  11. When asked What additional Equitrac print management capabilities will this server support? select any or all of the following options and click Next.
    • Print Server (DRE)
    • MFP Device Support
    • Web-based System Manager - This installs Equitrac Web System Manager.
    • Device Monitoring (DME)
    • Device Control (DCS) - This is required to support Ethernet card readers or Konica Minolta Combined Client (iOption)
    • Host-based printing powered by Output Manager - This is only for Equitrac Enterprise installations.
    • Equitrac Configuration and Reporting Utilities - This enables the configuration of the Equitrac Windows System Manager, which includes Print Driver Repository, Campus Card and Reports Manager. Refer to the Kofax Equitrac Windows System Manager Guide to install and configure the Windows System Manager components.
    • Reporting/Secondary CAS Server - This is only available when selecting the secondary CAS option.
  12. When asked Which Capture functionality do you want to install? select one of the following options and click Next.
    • Equitrac Capture & Send - Equitrac scanning only supports Xerox, Fuji-Xerox, Ricoh and Toshiba devices.
    • Enhanced Capture powered by AutoStore - This installs the core AutoStore capture and processing components.
    • I do not want to install Capture functionality on this server
  13. When asked Will this server be used to support mobile devices? select Yes or No and click Next.
  14. When asked Which of the following ControlSuite shared services or tools would you like to install on this server? select any or all of the following, and click Next.
    • License Server - This is required on at least one ControlSuite server to enable and enforce licensed entitlements.
    • Device Registration - This is required to register and configure MFP devices and to initialize and configure Mobile on MFPs.
    • Device Web Service (DWS) - This is required to support web-based MFP devices.
    • Microsoft Universal Print Integration Service - This enables Microsoft Universal Print. Install this on each server running session control. This works with Equitrac Session Control and Output Manager Input and Output Services.
    • Audit Log Viewer Service - This provides a web service interface to view the events recorded by different ControlSuite components in the Audit Log Collection Service.
  15. A Summary page opens displaying the components to be installed and deployed in an Equitrac production environment. The components are grouped into their respective functionality. For example, ControlSuite contains Security Framework and Licensing, and Equitrac contains the required print management components. Click Next to continue.

    Click the Advanced link if you want to modify the components to be installed. At this point you can select additional components, but the previously selected components cannot be updated or modified. In order to modify pre-selected components, you need to go back and change your selection through the questionnaire. After any changes have been made click Save and Next to continue.

  16. A second Summary page opens with ControlSuite installer download options and the Installation location. The default location is C:\Program Files, or you can click Browse to select a different location. Click Next to continue.

    Select one or more of the following options, and then click Next to continue.

    • Force download of latest installers - Install Assistant verifies that the latest installers are currently on your system, and if they are not the latest, it downloads updated installers overriding the older files in the Installs folder. This is not required, and will increase the installation time.
    • Automatically continue with install once all required installers are available - Install Assistant verifies that the required installers are currently on your system and then continues with the installation. Any missing installers are automatically downloaded, but this option does not check if you have the latest versions of the installers on your system. Select this option and the "Force download of latest installers" option to ensure you have a complete up-to-date set of installers before proceeding.
    • Download only - will not check local system for prerequisites or install - Install Assistant downloads the selected components but does not check for prerequisites or install the selected components. Using this option allows customers to download the necessary MSIs and generate an offline installer package that can then be distributed and installed within an offline deployment. When this option is selected, Install Assistant proceeds directly to the Results page displaying a "Successfully downloaded selected components" message. Click Finish when done.

    When no options are selected, Install Assistant downloads any missing selected components, and then displays a message stating "All selected components are downloaded. Continue with install?" If you select Yes, the installation continues. If you select No, Install Assistant proceeds directly to the Results page displaying a "Successfully downloaded selected components" message. Click Finish when done.
    When the "Download only" option is selected, the "Automatically continue with install" option and the Installation location field are disabled (grayed-out), and the installation process is not available.

    If installing the Web Installer package, which only contains the Install assistant, the installers for the services selected in the Questionnaire will be downloaded and will populate the Install folder of the Web Installer package.

    If installing the Offline Installer package that contains all installers, it can be run locally on the server without an Internet connection. The Offline version contains every installer required for any possible installation setup, and not all installers may be needed for your deployment. As the files are being installed, the C:\Program Files\Kofax\<Product> folders are populated with the selected services.

  17. A Prerequisites page opens displaying the status of the system requirements needed to install and run the selected components.
    • A green checkmark beside the feature indicates that the requirements have been met.
    • A red ’X’ means that a particular feature does not meet the minimum requirement and must be installed or updated before the installation can continue.
    • A yellow warning means that the minimum requirements are met, but does not meet the preferred requirements to run with optimum results.
    If a component needs to be installed or updated, click the top level feature to show the list of required features to be fixed.
    If any software needs to be updated, click the Install Prerequisites button to automatically install the software from the Prerequisites folder which is included in the installer package. This button is only available for software prerequisites. Alternatively, click the link beside the software component to open a website to download and manually install the required software
    If you continue to install with any prerequisites with a warning, a pop-up opens asking if you are sure you want to continue with the installation. Click Yes if you want to proceed with the knowledge that you may encounter some performance issues, or click No if you want to fix any requirements before installing.

    After addressing any hardware or ports prerequisites issues, click Retry, and then click Next to continue once the requirements are met.

  18. A Download page opens showing the progress of the downloaded components.
  19. An Install page opens, and the install starts automatically.

    During the install process, you can Cancel or Rollback the installation.

    • Cancel stops or pauses the install but does not remove already installed components. The previous selections are saved and administrators can re-run the install at a later date and continue where they left off.
    • Rollback stops the install and uninstalls any components that have been installed to that point.

  20. The Results page opens displaying that the installation was successful. Click Finish to continue. By default, the ControlSuite Configuration Assistant will start automatically after the installation finishes.