Element

Description

tenant

The tenant name that is assigned to the company. This is typically the company name, but without any non-alphanumeric characters.

Servers

Contains a list of the servers used by Robotic Automation applications. The following types of servers are available:

• RobotManager — (Optional) Use the RobotManager server type to connect to Pega Robot Manager.

• Config —  (Obsolete, do not use) This server type was used to connect to the legacy Pega Robotic Automation Deployment Portal to authenticate Runtime and Studio users and to deliver configuration settings and packages.

• Intelligence —  (Optional) Use Intelligence servers to connect to Pega Workforce Intelligence. The Off Computer Time and Expected Work Hours dialog rely on this setting.

• Identity Provider (IdP) — (Optional) Use IdP servers to provide security tokens which are used for authentication by other enabled servers. If you do not enable an IdP server, users are prompted to enter their email address and password for authentication.

Note: If Robot Runtime is behind a proxy server, include the information about the proxy server in the IdP servers section.

• PegaDevServer — (Optional) Use PegaDevServer to identify the Pega Platform instance that has the Robotic Automation Importer component installed on it and to send the package metadata provided by public automations. This server is also used to turn package version metadata into components that can be shared between platform instances.

• CredentialManager — (Optional) Use CredentialManager if you use third-party credentials extensions, such as CyberArk, BeyondTrust, or a custom client credential provider. This is only applicable for unattended (RPA) automations. 

Note : Contact Pega Support before enabling the CredentialManager server type.

Servers/Server name="RobotManager"

This server type includes the following parameters:

Server name — Enter RobotManager.

baseURL — You can enter an IP address or a URL. If you are using Robot Manager as your package server, set the UseRobotManagerPackageServer key to True in the RuntimeConfig.xml file.

enabled — Set to True to use this server entry.

proxyAddress — (Optional) Use this setting to define a proxy server that can be used to communicate with the server. To disable system default proxy settings, enter None for the proxyAddress attribute.

RPA — (Optional) Enter true if this is a Robotic Process Automation (RPA) configuration. The default is false.

authenticationType — (Optional) Defines the authentication method. Choose from Basic or Kerberos.

• RPA — The default is Basic.

• RDA — The default is Basic. This setting is overridden by the IdP setting if it is enabled.

workgroup — Enter the name of the Robotic Process Automation (RPA) server work group. This is the group to which your RPA robots belong. An RPA robot connects to Pega Robot Manager and reports into the work group you specify. The robot then retrieves its package assignment and, if it does not already have that package, downloads it from the package server. The RPA robot then loads the package and begins accepting robot activities.

Note:  You can also specify the RPA work group using a command-line parameter, as shown in the following example

openspan.runtime.exe workgroup=”Customer service”

If you include a command line parameter, it overrides the CommonConfig.xml file setting.

robotName — Specifies the robot name a Robotic Process Automation (RPA) robot will use as an operator ID. This information is used by Robot Manager. Include the machine name in your entry. If you omit the machine name, the system appends it to your entry. You can include the following characters in your entry:

letters (a-z, A-Z)
numbers (0-9)
variables ({MachineName} {Domain} {WindowsIdentity})
backward slash (\)
period (.)
single quote (')
tilde (~)
underscore (_)
exclamation point (!)
ampersand (&)
hash sign (#)
ONE at sign (@)

The system replaces all other characters with underscores (_). The default robot name is machine name. The following is an example of how you would set the robot name to MachineName_WindowsIdentity:

robotName="{MachineName}_{WindowsIdentity}"  

Items enclosed in braces {} are variables.

For example, with the setting shown above, if your machine name was PegaOS1 and the user credentials you used to log in were Acme1, the system would assign this robot name:

PegaOS1_Acme1

RPAServiceOperator — Enter the operator used by the RPA Service to register with Robot Manager. This is required for robotic processing automations when you are using Robot Manager version 6 or later.

Include the machine name in your entry. If you omit the machine name, the system appends it to your entry. You can include the following characters in your entry:

letters (a-z, A-Z)
numbers (0-9)
variables ({MachineName} {Domain} {WindowsIdentity})
backward slash (\)
period (.)
single quote (')
tilde (~)
underscore (_)
exclamation point (!)
ampersand (&)
hash sign (#)
ONE at sign (@)

The system replaces all other characters with underscores (_). RPAServiceOperator, which is the machine name, is the default.

maximumRobots — Enter the maximum number of robots that you want to register with Robot Manager.

Servers/Server name="Config"

(Obsolete, do not use)

Prior to 2021, this server type included the following parameters:

Server name — Enter Config.

baseURL — Enter an IP address or a URL to connect to the legacy Deployment Portal using the Config server. Do not include the tenant name in the URL.

enabled — Set to True to use this server entry.

proxyAddress — (Optional) Use this setting to define a proxy server that can be used to communicate with the server. To disable system default proxy settings, enter None for the proxyAddress attribute.

Servers/Server name="Intelligence"

This server type includes the following parameters:

Server name — Enter Intelligence.

baseURL — Enter an IP address or a URL.

enabled — Set to True to use this server entry, or False to not use it.

proxyAddress — (Optional) Use this setting to define a proxy server that can be used to communicate with the server. To disable system default proxy settings, enter None for the proxyAddress attribute.

Servers/Server name="IdP"

Note: Prior to the release of build 8.0.1058, the IdP server type was called AD FS (Active Directory Federation Services). Any AD FS entries will still work in later builds. If both AD FS and IdP entries are found, the system uses the IdP settings. If more than one server with the same name is present, the system uses the last one in the list, even if it is not enabled.

This server type includes the following parameters:

Server name — Enter IdP.

baseURL — Enter an IP address or a URL.

enabled — Set to True to use this server entry, or False to not use it.

proxyAddress — (Optional) Use this setting to define a proxy server that can be used to communicate with the server. To disable system default proxy settings, enter None for the proxyAddress attribute.

Servers/Server name="PegaDevServer"

Enable the PegaDevServer server type to identify the Prgs Platform instance that has the Robotic Automation Importer component installed on it and to send the package metadata provided by public automations. This server is also used to turn package version metadata into components that can be shared between platform instances. Enabling this server type sends the package metadata to the PegaDevServer server instead of the RobotManager server.

This server type includes the following parameters:

Server name — Enter PegaDevServer.

baseURL — Enter an IP address or a URL.

enabled — Set to True to use this server entry, or False to not use it.

proxyAddress — (Optional) Use this setting to define a proxy server that can be used to communicate with the server. To disable system default proxy settings, enter None for the proxyAddress attribute.

Servers/Server name="CredentialManager"

Enable the CredentialManagerserver type if you use third-party credentials extensions, such as CyberArk, BeyondTrust, or a Client Credential Provider. This only applies to unattended (RPA) implementations.

This server type includes the following parameters:

Server name — Enter CredentialManager.

baseURL — Enter an IP address or a URL.

enabled — Set to True to use this server entry, or False to not use it.

mappingFileLocation — Defines the folder that contains the mapping file.

providerType — Choose from DPAPI, CyberArk, BeyondTrust, Client Credential Provider, or Custom. This setting only applies if you set the RPA key to True for the RobotManager server type.

For more information, see CredentialManagerConfig.xml file.

ConfigurationLocation

Specifies the location of the configuration information.

The first time you run Robot Studio or Robot Runtime, the system copies this configuration file from the installation directory to the location you define with this option.

The default is ApplicationData, but you can enter a number of options for this setting. Here are the most commonly used options:

• ApplicationData - C:\Users\{username}\AppData\Roaming

• CommonApplicationData - C:\ProgramData

• LocalApplicationData - C:\Users\{username}\AppData\Local

• HomeDrive or SystemDrive - C:\

• MyDocuments - C:\Users\<username>\Documents

• Public - C:\Users\Public

• Temp - C:\Users\{Username}\AppData\Local\Temp

Note: Robot Runtime and the RPA Service default to the %appdata% location if the path that you specify in the ConfigurationLocation key is invalid.

FlashAllowedDomains

(19.1.54 and later)

Note: Adobe ended support for Adobe Flash on December 31, 2020. For more information, see Adobe Flash Player EOL General Information Page.

Lists the domains that can automate Adobe Flash applications. Separate domains with a comma or enter an asterisk (*) to indicate all domains.

For each domain that you list, the system allows Adobe Flash applications to accept inbound requests from webpage documents across domains, which is known as cross-scripting. Cross-scripting can be necessary if you are automating Adobe Flash applications that are hosted on a different domain than the webpage.

For example, if an Adobe Flash application is hosted on https://www.example.flashapp.com/ and the webpage is hosted at https://www.example.webpage.com/, then you would add the following value:

<FlashAllowedDomains>example.webpage.com</FlashAllowedDomains>

If there are multiple domains, use a comma to separate the domain within the value.  

<FlashAllowedDomains>example.webpage01.com,example.webpage02.com,example.webpage03.com</FlashAllowedDomains> 

If you want to allow all domains, enter an asterisk: 

<FlashAllowedDomains>*</FlashAllowedDomains>

DisplayConnectionError

(Obsolete, do not use)

This option was set to False if you did not want Robot Runtime to display an error message if it failed to connect to the legacy Deployment Portal. Deployment Portal is no longer available and its functionality is now handled by Robot Manager.

DeploymentSecurity

To enhance deployment security you can copy the DeploymentSecurity section from the RuntimeConfig.xml file and add it to the CommonConfig.xml file. You then use the options in this section to specify the signature validation that is required for deployment packages. To further enhance security, make the CommonConfig.xml file read-only.

If you do not specify the DeploymentSecurity values in the CommonConfig.xml file, the system uses the DeploymentSecurity values stored in the RuntimeConfig.xml file. For more information, see Runtime configuration settings.