--- schema_version: "1" id: 657c1739b96c42affd258a0a39fa432afc6dbf112072c23832deafcf9f7cc085 title: Configuring RPA Bot collection: mulesoft version: current locale: en-us portal_url: https://docs.salesforce.com/mulesoft/current/en-us/rpa-bot/latest/configuration.md canonical_url: https://docs.mulesoft.com/rpa-bot/latest/configuration source_site: docs.mulesoft.com content_type: documentation content_hash: b977e2730ce4050aa63d3fcf43b9789ecb62ed1821cb88a5fdfd12ff3966e4ee description: MuleSoft Documentation Site release: "1.7" latest: true --- --- product: RPA Bot version: 1.7 is-latest-version: true --- # Configuring RPA Bot > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use the RPA Bot Configurator application to change the default settings of a bot. To find the application navigate to **MuleSoft** > **RPA Bot Configurator**. The RPA Bot Configuration tool has the following configuration panels: - [Common](#common-settings) - [Proxy](#proxy-settings) - [Session Settings](#session-settings) - [Secure Session Settings](#secure-session) - [System Settings](#system-settings) - [Session Monitoring](#session-monitoring) - [Diagnostic Infos](#diagnostic-infos) > [!TIP] After saving your changes, restart the RPA Bot Service for the changes to take effect. ## Common Settings ![The RPA Bot Configurator application showing the Common settings panel](/mulesoft/current/en-us/rpa-bot/latest/_images/bot-configurator-common.png) - **RPA Bot ID** ID generated during the installation process of RPA Bot, which identifies the bot in RPA Manager (even if the IP or MAC-Address changes). If you need a new ID, uninstall and then reinstall RPA Bot. - **RPA Manager to connect** The URL address of the RPA Manager instance the bot connects to. There is no default setting. - **API Key** The API key entered during the installation of the robot. You can change this setting. - **TEST CONNECTION** Click **TEST CONNECTION** to verify that the bot can establish a connection to RPA Manager. - **Alive interval** Time interval in milliseconds after which the bot connects to the RPA Manager to show that it is still alive. - **Check interval** Time interval in milliseconds after which the bot connects to RPA Manager and checks for provided packages to collect (such as scheduling tasks or activities). - **Cleanup activities on start** Select this option to delete the activities that are no longer assigned to a configuration but are still stored locally in the bot. - **Cleanup runtime packages on next start** Select this option to delete all runtime packages that are stored locally in the bot. The process activities retrieve the required runtime packages from the RPA Manager on the next run. After the runtime packages are deleted, the Bot Configurator deselects this setting. - **Maximum number of sessions** Set the maximum number of Secure Sessions that the bot can use. Enabling this setting limits the number of Secure Sessions, but doesn’t overwrite the same setting in RPA Manager Bot Management. ## Proxy Settings ![The RPA Bot Configurator application showing the Proxy settings panel](/mulesoft/current/en-us/rpa-bot/latest/_images/bot-configurator-proxy.png) - **Proxy** The bot and RPA Manager communicate through the HTTP protocol at Port 80. If you connect to the internet through a proxy server, enter the proxy address in this field Format: `http://:`, for example: `http://myproxy.de:881`. ## Session Settings To specify a default user account that the RPA Bot uses to log in to the session and run processes on the computer, enter the credentials here. When users create a process run configuration in RPA Manager, they can choose this user or specify another there. ![The RPA Bot Configurator application showing the Secure Session settings panel](/mulesoft/current/en-us/rpa-bot/latest/_images/bot-configurator-session-settings.png) - **Default Session User** To specify a default user account that the RPA Bot uses to log in to the session and run processes on the computer, enter the credentials here. If the environment of the computer the bot is installed on is embedded in a domain and you want to use a local user, write the user name as follows: `.\username`. For domain users, use the following form: `mydomain\username`. - **Send images for process streaming** Select this checkbox to transfer screenshots used for process streaming to RPA Manager. Deselect the checkbox if not everyone on the process team is allowed to view the processed data. For the Process Streaming to work, the usage of the Windows Taskbar must be enabled in the process-run configuration, too. ## Secure Session Settings ![The RPA Bot Configurator application showing the Secure Session Settings panel](/mulesoft/current/en-us/rpa-bot/latest/_images/bot-configurator-secure-session.png) - **Activate certificate based login on SSL enabled terminal servers** Enable this option if you are installing the bot on a terminal server that only allows SSL protected RDP connections. - **Handle “Always prompt client for password” option** Enable this option if the `fPromptForPassword` Group Policy is enabled. The `fPromptForPassword` policy requests the password to be entered a second time when the RDP session is established. Some machines request the second password entry via a popup dialog. Other machines embed the prompt into the same screen, like the regular Windows login. - **Handle a “Custom LogonMessage”** Enable this option if you are prompted with a custom logon message when connecting to your system via RDP. Some systems show a custom logon message screen after logging into an RDP session, and this message has to be acknowledged by pressing a button. - **Allow usage of SmartCards inside Secure Sessions** Enables authentication via SmartCard within the Secure Session. - **Use the Credential Security Support Provider (CredSSP) for authentication** Select this option to use the CredSSP for authentication. - **Use alternative RDP handling for Secure Session login (recommended for Windows 10 and Windows Server 2016)** If the group policy _Always prompt for password upon connection_ is enabled, the password must be entered twice when logging into the RDP session. This might prevent the Secure Session from running smoothly, especially on Windows 2010 and Windows Server 2016. If this is the case, activate this option so that the credentials can be entered correctly in the second query. In this context, ensure that you have selected the option **Allow connections only from computers running Remote Desktop with Network Level Authentication (recommended)** in the Windows system properties. - **Session connection timeout** With an established connection, the session connection timeout defines the time that a call can remain unanswered before the bot cancels the call. - **Retries in timeout** Defines how often the bot tries to reach a started StSec via session connection. - **Seconds to wait between each try** The wait time specifies how long the bot waits between every individual attempt. ### Test Settings Optionally, click **TEST SETTINGS** to test your connection settings for the Secure Session. In the **TEST SETTINGS** dialog, enter test parameters for the Secure Session. ![The RPA Bot Configurator application showing the Test Settings window](/mulesoft/current/en-us/rpa-bot/latest/_images/bot-configurator-test-settings.png) If you click **TEST**, the application starts a non-operational Secure Session in which you can see a list of parameters for the Secure Session. Click **Logout** to end this non-operational Secure Session. > [!NOTE] On single session systems, such as Windows 10 and 11, a message shows that the test may > fail if no further sessions are available. ## Session Monitoring ![The RPA Bot Configurator application showing the Session Monitoring settings panel](/mulesoft/current/en-us/rpa-bot/latest/_images/bot-configurator-session-monitoring.png) - **Take Analysis Pictures** Specifies whether the bot takes screenshots while executing a process. - **Analyze Pictures Count** Specifies the number of screenshots to take. - **Analyze Picture Seconds** Defines the interval at which the bot takes screenshots. - **Analysis package on OK** Sends analysis packages if the Activity Workflow terminates with OK. - **Custom Analysis package folder of failed workflows** Define a folder location for the analysis packages of failed workflow runs. - **Custom Analysis package folder of succeeded workflows** Define a folder location for the analysis packages of successful workflow runs. ## System Settings ![The RPA Bot configurator application showing the System Settings panel](/mulesoft/current/en-us/rpa-bot/latest/_images/bot-configurator-system-settings.png) This panel indicates whether a terminal server software is installed and displays a list of all known registry keys with their current value. The panel also includes a `Bot Service State` entry, which shows the current RPA Bot Windows Service state and configuration. If a setting prevents RPA Bot from operating correctly, it is marked with a warning icon. You can fix the registry key settings directly from the panel by doing the following: 1. Right-click the warning icon. 2. Click **Fix it**. A confirmation pop-up displays to indicate the setting was fixed successfully. If the fix fails, access documentation from the panel for information about why the fix failed and how to resolve it. To fix the terminal server setting, which is needed for Secure Sessions, ensure the software is installed. Visit [Hardware and Software Requirements](https://docs.mulesoft.com/rpa-bot/latest/hardware-software-requirements) for more information about requirements for Secure Sessions. ## Diagnostic Infos The diagnostics panel shows important runtime information to help you identify current and potential problems with RPA Bot. The panel also shows which Windows session is currently being used by which secure session. Some values cannot be determined when RPA Bot is not running. ![The RPA Bot Configurator application showing the Diagnostic Infos panel](/mulesoft/current/en-us/rpa-bot/latest/_images/bot-configurator-diagnostic-infos.png) - **Bot Service state** Shows the current status of the Windows service. - **Bot start time (local time)** Shows the last bot start time and running time. The time is shown in the time zone of the current RPA Bot user. - **Process execution count** Shows the number of processes that executed successfully since the last bot start time. - **Workflow execution count** Shows the number of workflows executed successfully since the last bot start time. - **Average Secure session count** Shows the average number of secure sessions at the same time, the bot needs to run the processes since it was last started. - **Max. Secure session count** Shows the maximum number of secure sessions at the same time the bot needs to run the processes since it was last started. - **Last Time used to established a new secure session** Shows the time a secure session was last created. If a secure session has not been created since the last bot start time, then a value is not shown. - **Session creation errors occurred in the last hour** Shows the number of errors that occurred in the last hour when creating a secure session. - **Session creation errors occurred in the last day** Shows the number of errors that occurred in the last 24 hours when creating a secure session. - **Connection errors occurred in the last hour** Shows the number of errors that occurred in the last hour when establishing a connection to RPA Manager. - **Connection errors occurred in the last day** Shows the number of errors that occurred in the last 24 hours when establishing a connection to RPA Manager. - **Last average of download speed** Shows the average download speed when RPA Bot is downloading the last runtime package. This is an indicator of the connection quality between RPA Bot and RPA Manager. If no runtime packages have been downloaded since the last bot start time, then a value is not shown. - **Time used for RPA Manager connection test** When you refresh the Diagnostic Infos panel, RPA Bot runs a connection test to RPA Manager. This field shows the amount of time RPA Bot used to test the connection to RPA Manager. This is an indicator of the connection quality between RPA Bot and RPA Manager. - **Temp folder size** Shows the current size of the files in the Bot Temp folder (`C:\ProgramData\Mulesoft\RPABot\temp`) on disk. - **Warnings count** Shows the number of warnings that have occurred in the bot since the last bot start, the last hour, and the last 24 hours. - **Errors count** Shows the number of errors that have occurred in the bot since the last bot start, the last hour, and the last 24 hours. - **Fatal count** Shows the number of fatal errors that have occurred in the bot since the last bot start, the last hour, and the last 24 hours. ## Editing RPA Bot Configurator While Recording When a change is made to the RPA Bot Configurator while a recording is in progress, the configurator must be restarted for the changes to take effect. Clicking **OK** in the RPA Bot Configurator to save your changes opens the **Restart RPA Bot Service** dialog, which lets you decide if you want to defer or force the restart, restart manually, or continue configuring your changes. > [!NOTE] If a deployed process is running on the bot instance, the process may be canceled if RPA > Bot is restarted as a result of a change made to the RPA Bot Configurator. ![The RPA Bot Configurator application showing the Restart RPA Bot Service dialog](/mulesoft/current/en-us/rpa-bot/latest/_images/bot-configurator-restart-service.png) ## See Also - [RPA Manager - Bot Management](https://docs.mulesoft.com/rpa-manager/botmanagement-overview#getting-started) - [RPA Manager - Deploying Automations](https://docs.mulesoft.com/rpa-manager/processautomation-deploy) - [RPA Manager - Streaming Processes](https://docs.mulesoft.com/rpa-manager/processmonitoring-stream)