Using Sessions Controller to Access a Robot Session for Scenario Creation and Maintenance

This article covers the why and the how related to using Sessions Controller with AppVerify.

Automai Sessions Controller is a service used to manage robot and ScenarioBuilder sessions. It is installed as part of the AppVerify rTester install, but can be installed stand alone, if needed. It works behind the scenes to maintain active sessions so the scenario images can be buffered and to prevent any connection errors during scenario playback. It can start automatically and run in the background while executing processes (scenarios/scripts) without human supervision.

It should also be used to access ScenarioBuilder for creating and maintaining scenarios. This is the best way to ensure the scenarios execute the same in ScenarioBuilder and the robots because the creation and execution environments are the same.

However, this also means you can’t use the robot to create/maintain scenarios while you are also executing scenarios in AppVerify.

The setup differs depending on the operating system where the robot (rTester) is installed. Follow the steps that match your install.

Robot is Installed on a Server

Follow these steps to set up Sessions Controller to access ScenarioBuilder on the server where the robot (rTester) is installed.

  1. Log onto the server where the robot (rTester) is installed.
  2. Double-click the Sessions Controller icon on the desktop. If Sessions Controller wasn’t running, the Sessions Controller window appears. Click Close. If it was already running nothing will appear.
  3. In the sys tray, right-click on the Sessions Controller icon . A pop-up menu appears.
  4. Click Manage Sessions. The Sessions Controller window opens. There should be a session for each rTester.
  5. For the rTester you want to use to create and or maintain scripts, click the Edit Session icon . The window changes to show the session for the selected robot.
  6. The screen resolution, color quality, font smoothing, and send enter key selections should already be set as needed. However, if you did not configure them when you first installed AppVerify, now is the time to edit these settings, if needed. IMPORTANT - Any changes made here to the screen resolution, color quality, font smoothing, and send enter key will need to be made to ALL robot sessions.
  7. Select the ScenarioBuilder checkbox.
  8. Enter the password for the selected robot in the Enter user password field.
  9. Click Submit. The "Connection created successfully" message will be displayed and the window closes.

Robot is Installed on a Workstation

If your robot is installed on a workstation (i.e. Windows 10), you will need to have Sessions Controller installed on a different workstation or server and use that to access a ScenarioBuilder session on the workstation. This is due to the limitations of a workstation operating system where the user, the robot and Sessions Controller cannot all be in use at the same time.

Follow these steps to set up Sessions Controller on a machine OTHER than the one where the robot is installed. It can be a workstation or server operating system.

  1. Log onto the machine where the robot (rTester) is installed.
  2. Double-click the Sessions Controller icon on the desktop. If Sessions Controller wasn’t running, the Sessions Controller window appears. Click Close. If it was already running nothing will appear.
  3. In the sys tray, right-click on the Sessions Controller icon . A pop-up menu appears.
  4. Click Manage Sessions. The Sessions Controller window opens. There should be a session for the rTester.
  5. For the rTester you want to use to create and/or maintain scripts, click the Edit Session icon . The window changes to show the session for the selected robot.
  6. The screen resolution, color quality, font smoothing, and send enter key selections should already be set as needed. However, if you did not configure them when you first installed AppVerify, now is the time to edit these settings, if needed. IMPORTANT - Any changes made here to the screen resolution, color quality, font smoothing, and send enter key will need to be made to ALL robot sessions.
  7. Make a note of the settings, including the username and the password for the selected robot. You’ll also need to have the IP address or machine name for the machine.
  8. Close the window.
  9. Go to the machine where you want to use Sessions Controller and download the exe.
  10. Double-click on the downloaded file to launch the installation wizard. If needed, click here for directions on performing the install.
  11. Once the install is complete, double-click the Sessions Controller icon on the desktop. The Sessions Controller window appears.
  12. Enter the robot’s username and password. If the robot account is a domain account, enter the domain name in the field provided.
  13. Using the information obtained from step 7, set the screen resolution, color quality, font smoothing and send enter key to match.
  14. If the Robot checkbox is selected, clear it.
  15. If not already selected, select the ScenarioBuilder checkbox.
  16. In the Enter host name field, enter machine name or IP address of the machine where the robot is installed.
  17. Click Submit. The "Connection created successfully" message will be displayed and the window closes.

If you want to add sessions for connecting to other robots, right-click on the Sessions Controller icon in the sys tray, click Add new session, and then follow steps 12-17 above.

Connecting to a ScenarioBuilder Session

Once you have Sessions Controller installed and a ScenarioBuilder session configured you can use it to access ScenarioBuilder and create and maintain scenarios. To connect to the session, right-click the Sessions Controller icon in the sys tray and then click the session you want to use.

The selected session opens. Through this connection, you can create and edit your scripts.

Troubleshooting Tips

Connection Error

Refer to the solutions below if you receive the "ERRCONNECT_PASSWORD_CERTAINLY_EXPIRED" connection error.

Solution 1

  1. Go to the machine where Sessions Controller is installed.
  2. Go to the "...\Automai\Sessions Controller\resources\app\php" folder and open the "SSrdpManager.conf" file.
  3. Change "securityoption=3" to "securityoption=1".
  4. Save the change and close the file.
  5. Try to connect to the user session again.

Solution 2

NOTE – this only applies if the user is a domain user.

  1. Go to the machine where Sessions Controller is installed.
  2. Go to the "...\Automai\Sessions Controller\resources\app\php\sessions" folder and open the user connection file.
  3. Look for the hostname and replace it with "localhost".
  4. Save the change and close the file.
  5. Try to connect to the user session again.

    Keyboard Stops Working

    While rare, it is possible that the keyboard might stop working while the ScenarioBuilder user session is open. If this happens, try to minimize and then maximize the ScenarioBuilder session window or close and reopen it.