Clusters

This section enables you to manage clusters and RoboServers known to the Management Console. All servers in the list can be monitored using the portlets on the Dashboard. By default, the list contains one cluster containing one RoboServer, namely the one that also runs the Management Console functionality. In larger setups with multiple RoboServers and clusters, it is recommended that the Management Console is deployed on a standalone web container (if license permits), or on a RoboServer which is not used for running robots.

The following information is displayed for each server. Note that for RoboServers version earlier than 9.4 some of the information is not available.

Column

Description

Cluster/Server

For Clusters

The name of the cluster. Will be suffixed by - SSL if the cluster uses SSL. If the cluster has unapplied settings this will also be shown here, and the name will be displayed in blue. If the cluster has invalid settings, the name will be displayed in red.

For RoboServers

The name and port of the RoboServer. If the RoboServer is incorrectly configured the name will be displayed in red. If you hover over the red name, a tooltip will inform you of the error.

Version

Shows the version of the software on the running RoboServer.

KCU

The number of KCUs assigned to this cluster. KCUs in a cluster are distributed evenly between online RoboServers in the cluster. To adjust the KCUs on a cluster click the Assign KCUs button.

Running Robots

Shows the number of robots currently running on the RoboServer.

Queued Robots

The number of queued robots on the RoboServer

Max Robots

The maximum number of concurrent robots on the RoboServer. Can be configured in the Clusters settings

Uptime

The uptime of the RoboServer. Allows you to see when the server was started or restarted.

Command line (hidden)

The command line the RoboServer was started with

CPU count (hidden)

Number of CPUs assigned to the RoboServer process, for example if CPU affinity has been assigned.

Memory Limit

The maximum amount of memory assigned to the JVM the RoboServer runs in.

Above Limit

Shows whether the server is operating above its memory threshold (80% default). If this limit is reached, the RoboServer will queue the robot instead of starting it.

Duration (Accum.)

Shows the total time the RoboServer has been in the above limit state.

Max Queue (hidden)

The maximum number of robots that can be queued on the RoboServer. Can be set in the Clusters settings

License Type

The license type of the RoboServer, this is either Production or Non-Production.

Cluster Mode/Server Status

For clusters, shows the Cluster Mode. For RoboServers, shows if the server is Online or Offline.

Temp Profiling

Indicates whether profiling has been temporarily enabled for a given server. The setting will be cleared upon server restart.

Last Updated

Click this button to delete the cluster/server from the Management Console. This will remove any associated information from the Dashboard portlets.

Settings

Click to modify cluster settings in the Cluster Settings dialog box.

Delete

Click to delete the cluster/server from the Management Console. This will remove any associated information from the Dashboard portlets.

Server Information


The Robot Runtime view is located below Server Information and contains detailed information about running Robots. The top bar of the Robot Runtime view contains the following:

You can sort by any column in an ascending or descending order by clicking the column header. The default sorting is by Start Time Client.

Double click a row in the table to open the Robot's information in a window. The window shows the same information available in the Robot Runtime view only that it is a snapshot of the information at the time you open the window and it is not updated even if the robot stops executing.

Click to refresh the information in the table.

The following information is displayed for each running or recently completed robot. The table shows Robots either from one RoboServer or from all RoboServers if a Cluster is selected.

Column

Description

Robot

Name of the robot

Server

Name of the server that runs the robot

Project

Name of the project that the Robot belongs to. The list of projects can be viewed on the Repository>Robots tab.

Robot URL

A URL that the Robot is identified by. When you build the execute request for a RoboServer, you can either specify a file://URL or a Library:/, which specifies whether the robot should be loaded from the file system or the library.

  • File system URL - file://C:/Kapow/Robots/Library/Input.robot

  • The Library URL - Library:/Input.robot

The execute request for a Robot may look like this: Request request = new Request("Library:/Input.robot")

Robot Library

A type of Robot library. The following types exist:

  • Design Studio Robot Library

  • Embedded File-based Robot Library

  • Repository Robot Library

  • URL File-based Robot Library

  • URL Folder-based Robot Library

See the following topics for more information: Programming With Robots>Robot Libraries and Reference>Deployment Wizards>Robot Libraries.

Start Time Client

The time when the Robot was started. The time is displayed in time zone of the browser running the Management Console.

Execution ID

Robot execution ID.

Current Step

The step the Robot is currently executing.

Execution Path

The sequence of steps the Robot has performed.

Location Code

A code assigned to a step that you can view in Design Studio.

Step Execution Time

Current step execution time in seconds.

Executed Steps Limit

Shows the maximum number of steps the robot is allowed to execute. If the limit is reached, the robot is stopped.

Status

Robot's current status.

  • Running - Currently running

  • Queued - Queued for running when possible

  • Completed - Finished executing on RoboServer. This status is assigned to Robots that:

    • Completed successfully

    • Completed with errors

    • Crashed

    • Were force stopped

    Robots with Completed status are removed from the table after one minute from completion.

KCU Point Cost

KCU points spent for running the Robot. KCU Point Cost is equal to KCU-Point Usage from Design Studio.

KCU Wait

Amount of time the Robot has been unable to execute because the KCU Points (for this second) had already been spent.

Loaded Bytes

Bytes loaded during a Robot execution.

Extracted Values Limit

Displays an upper limit on the number of object extractions. If the robot extracts more objects than indicated by this property, then an error message is generated or the robot is stopped.

Execution Time Limit

Displays an upper limit on the total robot execution time. If the robot does not complete within this time limit, then an error message is generated and the robot is stopped. The property value is specified in seconds.

Last Output Time

Shows the time when the last extraction was performed.

Emails Sent

Shows the number of emails sent by the robot.

Stopping

Shows whether the robot is in the process of shutting down.

Output Count

Shows the number of objects that the robot has generated.

Executed Steps

Displays the number of steps the robot has executed.

Stop If Connection Lost

When this flag is set the robot will stop if it looses the connection to the Management Console.

Stop On API Exception

When this flag is set the robot will stop if it generates an API exception.

Log

Click in this column to open the Log tab.

Stop

Click in this column to stop robot execution.

Schedule

Click in this column to open the Edit Schedule dialog box.

Robot Runtime View


Create a Cluster

When you create a cluster you specify the name of the cluster, and the cluster type. If you create a non-production cluster you can assign KCU from the non-production license, and similarly if you create a Production cluster you can assign KCU from the production license. If you select the SSL option, all RoboServers in the cluster must use the SSL RQL service.

After you have created a cluster, you can add RoboServers to the cluster.

Context Menu

The grid contains a context menu, which has some rarely used functionality which are not available from the bottom menu, these are

Cluster Settings

Brings up the Cluster Setting dialog,

Stop RoboServer

Brings up a dialog which allows you to stop/reboot the selected RoboServer.

Dump Threads

Sends a request to the selected RoboServer to perform a full thread dump, the thread dump opens in a separate window. It is also possible to get a thread dump of the Management Console, for details see.

Load Distribution and fail over

When a cluster needs to execute a robot, it finds the RoboServer with the highest number of available slots. Available slots are calculated based on how many robots are already running on the RoboServer and how many robots it can run concurrently (the max concurrent robots in the Clusters settings.)

If a RoboServer in a cluster goes offline, the KCU is automatically distributed evenly among the remaining RoboServers.