Welcome to Kofax Kapow > Management Console > Management Console Configuration and User Interface > Admin > RoboServers > Change the Cluster Mode

Change the Cluster Mode

You can set three different modes to a cluster: Normal, Maintenance or Pending Maintenance. The Maintenance mode is used to set clusters into a mode where nothing is run on them. The point is to be able to update cluster settings in a way that ensures that all robots in a given schedule use the same settings, and that settings are not changed in the middle of schedule runs. The table below explains the different modes.

Cluster Mode

Description

Normal

Cluster operates normally with schedules and individual robots executed as expected. Cluster settings are not "applied" to the RoboServers so that settings are not changed in the middle of schedule runs.

Maintenance

No robots are allowed to run on the cluster (unless initiated from the API, as described after the table). For cluster settings to be applied to the RoboServers, a cluster MUST be in Maintenance mode.

Pending Maintenance

When you select one of the following ways to set a cluster to Maintenance mode, Pending Maintenance mode goes into effect until all robots stop running on the cluster.

Stop All Robots and Schedules Now

Attempts to stop all currently running robots. Any queued robots are de-queued and not run. This is the fastest way of setting a cluster to Maintenance mode.

Finish Currently Running Tasks and Stop

Ensures that all robots that have been started and are currently running will finish before the cluster goes into Maintenance mode. A schedule running several robots where some are queued and some running, will only have its currently running robots run; any queued robots are de-queued.

Finish Currently Running Schedules and Stop

Ensures that all running and queued robots are finished. This means that any started schedules will finish before the cluster is set into Maintenance mode.

  1. Click Change Cluster Mode above the cluster list.

    The Change Cluster Mode window appears.

    Note You can also right-click a cluster in the list and select the appropriate submenu item.
  2. In the Cluster field, select the cluster to change.
  3. In the Cluster Mode field, select a Maintenance option to transition into Maintenance mode.

    The cluster modes are, as the name implies, only relevant on a cluster level. As such, they are a way for the Management Console to control when tasks can be executed on clusters. They do not, however, control the individual RoboServers. This means that robots started from the API are not stopped when going into Maintenance mode. Therefore, the settings of a RoboServer can be updated while API robots are running. It is guaranteed, though, that a robot will not have its settings updated during its execution. For instance, if databases are updated while one or more API robots are running, the robots will use the databases that were configured when they started. Next time they are run, they will use the new settings.