Prerequisites to install the client

This section covers the requirements for hardware and system, network, product, and any other requirements that you must meet prior to installing IBM RPA SaaS client.

In this topic

Detailed system requirements

To ensure a successful installation of IBM RPA, it is important to review and comply with the detailed system requirements report. This report provides information on the necessary operational systems, hardware, software, and any other requirements that are needed to install IBM RPA.

Complete the following steps to review the detailed system requirements:

  1. Go to Detailed system requirements for a specific product 🡥.
  2. On the Full or partial product name field, enter IBM Robotic Process Automation and click the magnifying glass.
  3. From the Search results list, choose the offering:
    1. If IBM RPA on premises, select IBM Robotic Process Automation.
    2. If IBM RPA on Red Hat® OpenShift® Container Platform, select IBM Robotic Process Automation.
    3. If IBM RPA SaaS, select IBM Robotic Process Automation as a Service.
  4. From the Version list, select a version.
  5. Optional: You can customize the report by expanding the accordion items and selecting the items you want to see. By default, all options are selected.
  6. Click Submit.

Note about software prerequisites

Install software prerequisites manually if you want to install IBM RPA through the command line interface.

When you run the installer on a computer without meeting software prerequisites, the installer prompts you to install it, and restart the computer before you resume the IBM RPA installation.

User requirements

You must run the installer with administrator privileges.

Antivirus notice

Some antivirus software might block certain parts of the installation process, causing error messages to appear. In some cases, the installer ends successfully, but IBM RPA Studio or other components don't get the necessary permissions to operate.

In this scenario, add the following paths to the antivirus ignore list:

  • IBM executable files at C:\Program Files\IBM Robotic Process Automation\IBM Robotic Process Automation.
  • IBM executables files at C:\Program Files\IBM Robotic Process Automation\IBM Robotic Process Automation\Toolkit.
  • Executable files that are not part of the IBM RPA Studio, but are used to help automations.
  • These executable files are extracted at runtime in the %LOCALAPPDATA%\IBM Robotic Process Automation\packages folder in the current user session. For example,C:\Users\USER_NAME\AppData\Local\IBM Robotic Process Automation\packages.

Optional: System restore point

You can configure your Windows™ environment to create restore points at regular intervals, or create it manually at any time. It can help you undo changes to a previous state by using the data from a restore point. For more information, see Use System Restore 🡥.

Network prerequisites

See the network prerequisites for the IBM RPA SaaS client installation:

Internet connection

The IBM Robotic Process Automation as a Service client installer doesn't work offline. A stable internet connection is needed to proceed with the installation. It ensures stable communication between the client installer and the server.

Web browser policy

Setting policies to the supported web browsers 🡥 can block web automation capabilities. The following policies can block:

  • The DisableDevTools preference in Mozilla Firefox.
  • The "Set User Data Directory" policy in Google Chrome.

Also, don't change the default directory to the user profile data. For more information, see Web browser policies.

API requests to IBM RPA domains and HTTPS communication

IBM RPA domains
If you want to enable the specific IBM RPA domains, you need to allow communication to the following URLs:

Domain Protocol Port Description
HTTPS 443 IBM RPA server API endpoint
HTTPS 443 Main IBM RPA server API endpoint
HTTPS 443 Chatbot API endpoint
HTTPS 443 IBM RPA downloads repository API endpoint
HTTPS 443 IBM RPA installer download repository
HTTPS 443 IBM RPA server API endpoint HTTPS 443 Main IBM RPA server API endpoint HTTPS 443 Chatbot API endpoint
licensing.wdgautomation.com¹ HTTPS 443 IBM RPA licensing system API endpoint
<REGIONCODE> HTTPS 443 Platform's default workload queue endpoint

¹ Starting from version 23.0.2, the domain isn't required.

Grant access to * and * and their respective domains and subdomains in the client's operating system.

Note:The * domains are only available for the EU1 and AP1 regions at the moment.

For more information about region codes, see Understanding tenants and regions.

HTTPS communication
You need to enable HTTPS communication. If you want to enable the certificate authorities-specific domains, the following list shows the domains that you need to allow communication to enable SSL/TLS encryption:


Ports to trigger bots

The following table shows optional ports that you can open in the host computer to trigger bots through the API:

Service Protocol Port Traffic
HTTPS handler TCP 8099 Inbound
HTTPS handler by using IBM RPA brokering TCP 8096 Inbound
IVR Telephony (SSH) ¹ TCP 22 Outbound

¹ Starting from IBM RPA 23.0.3, the IBM RPA Studio Test Telephony Service isn't available due to the IVR removal. For more information, see Removed.

Make sure that there is no firewall policy blocking IPC. The range affected is 49152-75535. For more information, refer to Web browser policies.

Remember:The bot uses only one port per runtime.

Product prerequisites

See the following product prerequisites before you install IBM RPA:

IBM RPA license: License ID and License password

For versions before 23.0.2, a License ID, License password, and Tenant Code are needed for the IBM RPA SaaS Client to activate the product. The tenant owner gets these data after purchase. For information about purchasing, see Robotic Process Automation.

If you are not the tenant owner, you should ask your tenant owner for your license details.

To download the installer, see the Downloading the installer topic.

License activations

Each License ID and License password can be activated only a limited amount of time, and you must not exceed the maximum amount of activations, otherwise you run into invalid license issues. See Out of licenses after installation for more information.

To prevent licensing issues, you can deactivate your license to restore one license activation. You can activate your license later even on different computers. If you are unable to deactivate your license, contact IBM Support.

Getting your tenant code

Complete the following steps to get the tenant code for installations before IBM RPA 23.0.2:

  1. Log in to IBM RPA Control Center.
  2. Click the Profile icon The avatar icon that represents the profile.
  3. Copy the number that follows the Code label.

The tenant code is shown closely to the sign out option.

IBM RPA license: Installation key

Starting from version 23.0.2, you must have an installation key to install IBM Robotic Process Automation Client. The installer registers and certifies the computer to the tenant that generated the installation key.

The following list describes how you can get your tenant's installation key on IBM RPA Control Center:

  • You can copy the installation key in the download modal that appears after you click the Download icon. The modal has the button to download the client installer and the installation key for the tenant.
  • If you have the appropriate user permissions, you can copy the installation key in the tenant's client settings.

To download the installer, see the Downloading the installer topic.

IBM Robotic Process Automation supports a new licensing system that provides flexibility and security. With this update, you can install the IBM Robotic Process Automation Client on any computer, considering that you have an installation key from a tenant. Installation keys mitigate common installation issues such as "License not loaded", "Out of license", or "No remaining activations" that required support intervention.

On IBM RPA Control Center, tenant administrators can regenerate the tenant's installation key, rendering previous keys unusable on newer client installations. This protects your tenant if the installation key gets exposed.

About the installer

The following table displays the tools that IBM RPA SaaS Client installs and that you need to run and develop your bots:

Tool Function
Bot Runtime Run IBM RPA bots. This tool is used by the other IBM RPA tools to run the bot.
IBM RPA Studio Develop IBM RPA bots. For more information, see IBM RPA Studio.
IBM RPA Launcher Start IBM RPA bots on demand. For more information, see Launching scripts.
IBM RPA Vault Store secrets and credentials. For more information, see IBM RPA Vault.

Understanding certificates

IBM RPA uses a certificate system to authenticate computers on the IBM RPA server. After you install IBM RPA Client, your computer is registered to an environment that your organization is entitled to. The certificate ensures that your computer maintains a secure communication with the server.

Important:Installing the same certificate into multiple machines might cause issues when you try to run your Bots and scripts. Ensure that the certificate is installed in only one machine.

Understanding tenants and regions

  • Tenant
    A tenant is an independent logical section on the IBM Robotic Process Automation server. Tenants are also called environments. They store data and resources for specific use in that environment, such as users, computers, scripts, credentials, dashboards, among others. You can access these resources on the IBM RPA Control Center.

  • Regions
    Regions refer to the locations of available IBM Robotic Process Automation servers. The servers are spread across different continents. Access your tenant through the IBM RPA Control Center by referencing the region code in the URL:



{regioncode} Country (Region)
ap1 Singapore (Asia)
br1 Brazil (Latin America)
br2- Brazil (Latin America)
eu1 Germany (Europe)
uk1 United Kingdom (Europe)
us1 United States (North America)


Starting at version 23.0.15, these regions now support the following URL:

{regioncode} Country (Region)
ap1 Singapore (Asia)
eu1 Germany (Europe)

The * URLs redirect to the new supported URL in the supported regions.

For more information, see Details about tenants.