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 —  (Optional) Use Config servers to authenticate Runtime and Studio users and to deliver configuration settings and packages. This server type is used to connect to the Pega Robotic Automation Deployment Portal.

• 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.

• PegaDevServer — (Optional) Use PegaDevServer to identify the 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 the CredentialManager to set up authentication with RPA Service.

 Note: Contact Robotic Automation Support before enabling the CredentialManager server type.

Servers/Server name="RobotManager"

This server type includes the following parameters:

Server name — Enter RobotManager.

baseURL — Enter an IP address or a 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.

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 workgroup. This is the group to which your RPA robots belong. When an RPA robot connects to the Robot Manager and reports into the workgroup 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: The RPA workgroup was originally defined on the Project Properties page for a package. In builds 8.0.1058 and later, it is defined in the CommonConfig.xml file. You can also specify it 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. You must have version 8.0.1067 or later to include this key. 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 Aceme1, the system would assign this robot name:

PegaOS1_Aceme1

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

Note: To use Robot Manager version 6 or later you must have 8.0 SP1 2019 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 (_). The default RPAServiceOperator is the machine name.

Servers/Server name="Config"

This server type includes the following parameters:

Server name — Enter Config.

baseURL — Enter an IP address or a URL. If you are connecting to Deployment Portal using the Config server, do not include the tenant name in the URL. To Deployment Portal, a tenant is the name of the organization using the Deployment Portal.

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"

Note: This server type was added in build 8.0 SP1 2029.

Enable the PegaDevServer server type to identify the 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.

ConfigurationLocation

Specifies the location of the configuration information.

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

You can enter absolute paths, environment variables, and SpecialFolders enumerated values, such as CommonApplicationData, LocalApplicationData, Documents, Personal, or Temporary. The default is Application Data.

Here are some examples of actual paths that are represented by commonly-used variables:

For Windows 7, 8, 10, and Server 2008, 2012, 2016:

ApplicationData: \Users\<userName>\AppData\Roaming
CommonApplicationData: \ProgramData
LocalApplicationData: \Users\<userName>\AppData\Local

For Windows XP and Server 2003:

ApplicationData: \Documents and Settings\<userName>\Application Data
CommonApplicationData: \Documents and Settings\All Users\Application Data
LocalApplicationData: \Documents and Settings\<userName>\Local Settings\Application Data

DisplayConnectionError

Add this option to the CommonConfig.xml file and set it to False if you do not want Runtime to display the following message if it fails to connect to the Deployment Portal:

Cannot connect to OpenSpan Server.

Here is an example:

<DisplayConnectionError>False</DisplayConnectionError>

The default is True, which instructs Runtime to display the message.

Note: This option is only used if you have enabled the Deployment Portal server configuration. If the Deployment Portal is disabled, no message is displayed, regardless of how this option is set.

DeploymentSecurity

In build 8.0.1058 and later, 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.