Debugging a scheduled script

Attach IBM RPA Studio to a remote computer to debug scheduled scripts after they start. Use this feature to track the step by step of the debugging process in IBM RPA Studio and watch the remote computer screen in the process. It's useful to remote debug scheduled scripts in the production computer, where the environment might affect the script's operation.

Important:IBM RPA 23.0.0 deprecated the feature to watch the remote computer screen while you debug scheduled scripts, so this screen is no longer displayed by IBM RPA Studio. Starting from IBM RPA 23.0.3, this feature is removed from the product. You still can attach to a remote computer to debug a scheduled script, but you need to use another tool to watch the remote computer screen.

Before you begin

Before you start the procedure, you must comply with the following requirements. These requirements are general requirements for all versions of the product:

  • The remote computer must have IBM RPA installed.
  • To attach to a scheduled script in a remote computer, a scheduled script must exist in the IBM RPA Control Center tenant for the remote computer. For more information, see Scheduling scripts.

Requirements for IBM RPA clients before 23.0.3

In addition to the general requirements, you must comply with the following requirements if your IBM RPA client is on version before 23.0.3. Apply these requirements and configurations to the remote computer that runs the script:

  • Install a Virtual Network Computing (VNC) client on the remote computer and set an administrator password when you install the client.
  • Open the default ports 5800 and 5900 for inbound Transmission Control Protocol (TCP) in the remote computer. You can change the default ports in the VNC client.
  • Edit the computer configuration for the remote computer in IBM RPA Control Center to enter the VNC password. For more information, see Managing computers.
  • Download the certificate and reinstall it after you edit the computer.
Important:In version 23.0.3, IBM RPA Control Center shows the Vnc Password field for creation or edition of computers as deprecated. If you're using clients before 23.0.3, you still can use this field to enter the VNC password to attach to a remote computer.

Procedure

  1. Log in to IBM RPA Studio.

  2. On the Home tab, click Attach to Schedule.

  3. In the Machine name field, enter the remote computer name. The remote computer name must be the IP address or FQDN.

  4. After the search finds the computer, click Attach.

    Tip:Use the following steps to obtain the IP address or FQDN:
    1. Open the Windows™ command prompt.
    2. Enter the following command:
      3. ipconfig/all
    3. In the IPv4 Address field, get the IP address.
    4. Enter the following command to obtain FQDN:
      5. echo %COMPUTERNAME%.%USERDNSDOMAIN%

Results

After you click Attach, IBM RPA Studio attaches to the scheduled job, and waits for it to start. You can follow the remaining time for the schedule to start in the Attach to Schedule window.

After the scheduled bot starts, the bot's operation begins paused so you can debug the script.

What to do next

Important:Starting from IBM RPA 23.0.3, the following procedure is no longer applied. It's due to the removal of the feature to watch the remote computer screen while you debug scheduled scripts. If you want to watch the remote computer screen while, you need to use another tool. For more information, see Removed.
You can see the remote computer screen and interact with the remote computer's session:
  1. On the debugger's Window tab, click Debug bar.
  2. Maximize the debug bar window.
  3. Clear the Ignore VNC input option.