Shutting down Runtime in a Citrix implementation

Use the ShutdownRuntime utility in Citrix deployments to shut down any running Pega Robotic Automation Runtime process before relaunching Pega Robotic Automation Runtime. Typically, you would only need to use this utility if Robotic Automation Runtime hangs during a normal shutdown or if you want to shut down a specific user and then launch an admin session.

This utility is installed in the main installation folder, along with the configuration files, when you install Pega Robotic Automation Runtime, Pega Robotic Automation Studio, or the Pega Robotic Automation Studio plug-in.

Note: To see a complete list of the parameters you can include with this utility, enter the following command:

ShutdownRuntime.exe /Help

The parameters are case-sensitive.

Shutting down all users

When you enter this command, the utility immediately shuts down all Robotic Automation Runtime users. Runtime users will have no opportunity to save their work.

Open a command prompt on the machine where Robotic Automation Runtime is running.
Enter the following command:

ShutdownRuntime.exe allUsers

Here is an example that includes the pauseBeforeExit parameter, which will pause the shutdown process until the user presses Enter to continue. This gives users a chance to respond to any messages before Runtime is shut down:

ShutdownRuntime.exe pauseBeforeExit allUsers

Shutting down a specific user

When you enter this command, the utility immediately shuts down the Robotic Automation Runtime user that you specify. The Runtime user will have no opportunity to save work.

Open a command prompt on the machine where Robotic Automation Runtime is running.
Enter the following command:

ShutdownRuntime.exe user=JohnDoe

Here is an example that includes the pauseBeforeExit parameter, which will pause the shutdown process until the user presses Enter to continue. This gives the user a chance to respond to any messages before Runtime is shut down:

ShutdownRuntime.exe pauseBeforeExit user=JohnDoe

Simulating the shutdown process

If you want to test the shutdown process include the noKill parameter. For example, if you want to make sure that your entry in the pauseBeforeExit parameter provides a sufficient pause, you could include this parameter.

Open a command prompt on the machine where Robotic Automation Runtime is running.
Enter the following command:

ShutdownRuntime.exe noKill

Here is an example that includes the pauseBeforeExit parameter, which will pause the shutdown process until the user presses Enter to continue:

ShutdownRuntime.exe pauseBeforeExit noKill