› Install and Configure ControlSuite › Upgrading ControlSuite › Planning an upgrade

Planning an upgrade

When planning an upgrade it important to be aware that some components are able to run with newer and older versions of ControlSuite at the same time. This can be used to stage the upgrade over multiple days and reduce any downtime related to the upgrade process. A solution with mixed versions is difficult to support and troubleshoot, therefore running in this mixed state is not supported for longer than one week.

When upgrading to a newer version of ControlSuite, the components should be upgraded in the following general order.

These ControlSuite components can run with mixed versions during the upgrade process.

  • Security Framework Service (SFS) - Security Framework should be upgraded one node at a time, but will work if the versions are mixed.
  • License Server - There is typically only one license server. Older versions of ControlSuite should be able to communicate with a newer license server.
  • Equitrac (these components need to be updated is the following order)
    • Master Core Account Server (CAS)
    • Secondary CAS(es)
    • Document Routing Engine (DRE) / Device Monitoring Engine (DME) - (typically, DME is installed on the DRE server)
    • Device Control Engine (DCE)
    • Scan Processing Engine (SPE)
    • Client Workstations

These ControlSuite components should be taken offline indivually and fully upgraded before bringing them back online.

  • AutoStore
  • Output Manager
  • Business Connect
  • Device Registration Service (DRS)

Impacts during upgrade

It is important to understand what process in ControlSuite will be impacted during an upgrade, so downtime can be planned appropriately. Below is a list of expected impacts:

  • Security Framework Service - If multiple SFS are deployed (as recommended) and they are upgraded one at a time, then no impact should be expected during an upgrade related to the SFS upgrade.
  • License Server - No impact to the solution should occur if the license server is upgraded. All ControlSuite components cache their licensing for 7 days if a license server is down.
  • AutoStore - All AutoStore components should be upgraded at the same time. While an upgrade is in progress, expect your capture workflows to not function or not be accessible at the MFP. Even when configured in a highly available setup, all instances of AutoStore should be upgraded before bringing them online.
  • Output Manager - All Output Manager components should be upgraded at the same time. While upgrading, expect production print and complex print flows to not function. Even when configured in a highly available configuration, all Output Manager components should be upgraded before bringing them online.
  • Business Connect - All Business Connect servers should be upgraded at the same time. While upgrading, expect to not be able to access Authentication, Workflows and Printing from the Business Connect mobile app.
  • Equitrac - Equitrac is built in a way that allows distributed and backward compatible components. Equitrac can be upgraded in stages and one component at a time while the rest of the solution remains up and running.
  • Equitrac Core Account Server (CAS) - Day to day operations can continue while CAS is being upgraded with some exceptions. The Escrow function requires CAS to be active, but this function is disabled by default and not typically enabled. CAS to CAS print release will also not function. This would prevent a user from printing a job in one region controlled by one CAS and releasing it in another region supported by another CAS. Administrative operations like adding users and devices would also be unavailable while CAS is offline.
  • DRE - Upgrading this component will impact the ability for users to print to a print server while the upgrade takes place. Print servers are usually distributed and the upgrade process will only impact a small portion of the organization.
  • DCE/SPE - Upgrading this component will impact functionality on the MFP, preventing access to the device, authentication and print release.
  • DWS - Upgrading this component will prevent authentication and workflow at MFPs.
  • DRS - DRS is typically not needed for day to day operation and while this component is upgraded, it would prevent adding new devices to your environament.