Build notes: Pega RPA Service 3.1

Build 3.1.20.0 — September 16, 2021 — bundled with Pega Robotic Automation 19.1.91.0

US-434072
US-434090

To enhance security, this build updates the following files:

• log4net.dll to version 2.0.12
• Newtonsoft Json.NET framework to version 13.0

log4net.dll
newtonsoft.json.dll
Pega.RpaService.Common.dll

Build 3.1.19.0 — August 20, 2021 — bundled with Pega Robotic Automation 19.1.89.0

EPIC-66956

This build provides a security update to safeguard against the Veracode CWE 117 error — Improper Output Neutralization — which allows for the storage of sensitive information in memory.

Pega.RpaService.Common.dll
Pega.RpaService.CredentialManager.dll
CredMgr.exe
SessionMgr.exe
Pega.RpaService.Tools.exe

Build 3.1.18.0

The changes in this build were released in 3.1.19.0.

Build 3.1.17.0 — June 9, 2021 — bundled with Pega Robotic Automation 19.1.85.0

Build 3.1.16.0 — January 25, 2021 — bundled with Pega Robotic Automation 19.1.73.0

Build 3.1.15.0 — September 14, 2020 — bundled with Pega Robotic Automation 19.1.61.0

EPIC-63220

This build updates the endpoints for all calls that the Pega RPA Service makes to provide support for Pega Robot Manager 8.5.

Pega.RPAService.Common.dll
Pega.RPAService.Service.exe

Build 3.1.14.0 — July 17, 2020 — bundled with Pega Robotic Automation 19.1.50.0

EPIC-63194

This build modifies the CredMgr.exe program to ensure that it includes the same functionality available from the CredMgr UI. The following changes were made:

• The Robot index is no longer added if no robot index is passed.
• Adds validation when you remove credential entries using the CredMgr.exe program.
• Simplifies the requirements for removing entries.

OpenSpan.Security.dll
CredMgr.exe

BUG-575637
US-370979

This build adds the *.exe.config files to the version manifest/bundle and includes these files in the cache version folder with their corresponding .exe files.

N/A

Build 3.1.13.0 — June 01, 2020 — bundled with Pega Robotic Automation 19.1.44.0

EPIC-62795

This build changes the Credential Manager UI for the Pega RPA Service to ensure that the application displays correctly when you have the screen resolution of 1280 x 720.

CredMgrUI.exe

EPIC-62787

This build includes the following changes:

• Ensures that the Pega RPA Service accurately reports the status of Robot Runtime and can log out of the computer as requested when a single Robot Runtime is enabled for a computer and Remote Desktop Protocol (RDP) is used to connect to the computer.
• Changes the CyberArk and BeyondTrust credential providers to support all the parameters that are passed by the GetCredentials overload method to call the AsoManager and credential store, with the exception of the Name and WorkGroup parameters.
• Adds the defaultProvider attribute, which you can use to define a custom credential provider to override DPAPI as the default credential provider.

Pega.RpaService.Common.dll
Pega.RpaService.Loader.dll
Pega.RpaService.Scheduler.dll
Pega.RpaService.Service.dll

Build 3.1.12.0 — April 24, 2020 — bundled with Pega Robotic Automation 19.1.39.0

EPIC-62070

• The RPA Service no longer writes to the RuntimeLaunchState.dat file in on-demand mode.
• The SchedulerDefinitions.xml file includes support for Windows Server 2019. 
• The RPA Service log now includes all AppSetting values from the RPAService.config.xml file. 

US-355454

This build modifies the installer to adjust permissions on the RPAService folder in the ProgramData folder to permit the Scheduler program to write log information.

PegaRPAServiceSetup.exe

US-358012

This build enhances credential provider support for Robot Runtime and the Robotic Process Automation (RPA) Service in several ways:

• Ensures that all credential providers process requests with WorkGroups and replaceable system values in the same way. 
• Provides additional logging and a new domain attribute for CyberArk in the CredentialManagerConfig.xml file.
• Updates the client credential provider to include all system parameters with each credential call.

For more information, see Integrating a Client Credential Provider.

OpenSpan.Security.dll
Pega.ClientCredentialProvider.dll

Build 3.1.11.0 — April 13, 2020 — bundled with Pega Robotic Automation 19.1.38.0

BUG-551870

This build ensures that the Pega RPA Service uses the value defined for the ScheduledTaskStartBoundary key in the RPAService.config.xml file to schedule the runtime task.

Pega.RpaService.Common.dll
Pega.RpaService.Scheduler.exe
Pega.RpaService.Service.exe
CredMgrUI.exe

BUG-552492

This hotfix ensures that the Pega RPA Service uses the BaseURL key from the AppSettings section in the RPAService.config.xml file. The RPA Service uses the value that you specify for this key, if present, instead of the BaseURL key value in the RobotManager section of the CommonConfig.xml file.

Pega.RpaService.Common.dll
Pega.RpaService.Scheduler.exe
Pega.RpaService.Service.exe
CredMgrUI.exe

Build 3.1.10.0 — March 07, 2020 — bundled with Pega Robotic Automation 19.1.32.0

US-317631

This build adds support for running multiple Runtime sessions on a single Windows machine if the machine supports RDP connections.

To specify the maximum number of robots that you want to register with Robot Manager, use the new maximumRobots option in the RobotManager section of the CommonConfig.xml file.

This build also updates the CredMgrUI.exe and CredMgr.exe programs to support multiple Runtime sessions. When you set the maximum number of robots to two or more, a new RobotIndex field appears  in the CredMgrUI.exe and CredMgr.exe programs when you specify the WindowsUser and RuntimeUser keys in the CredentialManagerConfig.xml file. Ensure that each robot has unique WindowsUser and RobotIndex entries.

This build also adds the following options to the AppSettings section in the RPAService.config.xml file:

• To select the screen resolution to use for new RDP connections, use the RemoteDesktopSessionScreenResolution option.
• To specify the maximum number of concurrent Runtime robots that can start at the same time, use the RemoteDesktopSessionStartupConcurrency option. The Synchronization Engine Product Loader also uses this value.
• To set the wait time, in seconds, between the creation of each RDP session when starting multiple robots at the same time, use the RemoteDesktopSessionCreationWaitTimeSec option.
• To fill in ASO.db file passwords for multiple Runtime robots and prevent ASO dialogs from appearing when running projects for the first time, use the new Pega.RpaService.Tools.exe utility.

CommonConfig.xml
CredentialManagerConfig.xml
RpaService.config
Pega.RpaService.Common.dll
Pega.RpaService.Loader.exe
Pega.RpaService.Scheduler.exe
Pega.RpaService.Service.exe
Pega.RpaService.Tools.exe
SessionMgr.exe
CredMgr.exe
CredMgrUI.exe

US-319231

This build adds the ConsecutiveInvalidLoginLimit option to the AppSettings section of the RPAService.config.xml file. Use this option to limit the number of failures allowed before the RPA Service stops trying to register with Pega Robot Manager.

For example, if you enter 10, the RPA Service attempts to register with Pega Robot Manager up to10 times. If it fails to register 10 times, you must then restart the RPA Service.

CommonConfig.xml
CredentialManagerConfig.xml
RpaService.config
Pega.RpaService.Common.dll
Pega.RpaService.Loader.exe
Pega.RpaService.Scheduler.exe
Pega.RpaService.Service.exe
Pega.RpaService.Tools.exe
SessionMgr.exe
CredMgr.exe
CredMgrUI.exe

US-349008

This build resolves a security vulnerability in the Pega RPA Service by changing the default behavior for handling locked screens during unattended robotic sessions when running in Scheduled mode.

CommonConfig.xml
CredentialManagerConfig.xml
RpaService.config
Pega.RpaService.Common.dll
Pega.RpaService.Loader.exe
Pega.RpaService.Scheduler.exe
Pega.RpaService.Service.exe
Pega.RpaService.Tools.exe
SessionMgr.exe
CredMgr.exe
CredMgrUI.exe

Build 3.1.9.0 — February 7, 2020 — bundled with Pega Robotic Automation 19.1.27.0

BUG-538964
BUG-538133

This build adds security enhancements to resolve potential vulnerabilities.

Installer changes

EPIC-59173

This build adds security enhancements to resolve potential vulnerabilities.

OpenSpan.Branding.dll
OpenSpan.dll
OpenSpan.Runtime.Core.dll
OpenSpan.Security.dll
Pega.ClientCredentialProvider.dll
Pega.Interop.dll
Pega.RpaService.Common.dll
Pega.RpaService.CredentialManagerUI.exe
Pega.RpaService.Loader.exe
Pega.RpaService.Scheduler.exe
Pega.RpaService.Service.exe
Pega.RpaService.SessionManager.exe

ISSUE-72086

This build adds a missing registration payload password field so that the RPA Service can register with Robot Manager.

Not applicable

Build 3.1.7.0 — February 7, 2020 — bundled with Pega Robotic Automation 19.1.26.0

EPIC-60451

This build implements full support of the BeyondTrust credential provider for Robot Runtime. You can use your existing BeyondTrust portal to provide credentials for the registration operator, Windows user, Runtime user, ASO manager, and Credential Store.

CommonConfig.xml
CredentialManagerConfig.xml
RpaService.config
OpenSpan.Branding.dll
OpenSpan.dll
OpenSpan.Runtime.Core.dll
OpenSpan.Security.dll
Pega.ClientCredentialProvider.dll
Pega.Interop.dll
Pega.RpaService.Common.dll
CredMgr.exe
CredMgrUI.exe
Pega.RpaService.Loader.exe
Pega.RpaService.Scheduler.exe
Pega.RpaService.Service.exe
SessionMgr.exe
System.ValueTuple.dll

Build 3.1.6.0 — December 4, 2019 — bundled with Pega Robotic Automation 19.1.20.0

ISSUE-68867

This build removes the requirement of an internet connection during the installation process.

Installer MSI files

US-328600

This build adds support to RPA Service for a new robot profile endpoint in Robot Manager. It reverts to an existing endpoint when a new endpoint does not exist.

Pega.RpaService.Service.exe

Build 3.1.5.0 — October 11, 2019 — bundled with Pega Robotic Automation 19.1.14.0.

BUG-512701

This build resolves an issue that could occur in the CommonConfig.xml file if you enabled the CredentialManager server and set the providerType to DPAPI.

OpenSpan.Security.dll

Build 3.1.4.0 — September 27, 2019 — bundled with Pega Robotic Automation 19.1.13.0.

BUG-508009

This build adds the ScheduledTaskStartBoundary configuration setting to the RPAService.config.xml file. Use this setting to ensure that the start boundary does not occur before the scheduled task.

OpenSpan.WinLogon.Scheduler.dll

US-323726

This build adds the BaseURL key to the AppSettings section in the RPAService.config.xml file. The system uses the value that you specify in this key instead of the BaseURL key value in the RobotManager section of the CommonConfig.xml file.

CredentialManagerConfig.xml

US-323723

This build enables you to get and set custom credentials by using the IClientCredentialProvider interface.

To set up custom credentials, use the CredentialManager server options in the CommonConfig.xml file, and make corresponding entries in the CredentialManagerConfig.xml file.

For the credential provider, set the providerType attribute in the CredentialManagerConfig.xml file to Client and include values for the assemblyName and className attributes.

CredentialManagerConfig.xml
OpenSpan.ApplicationFramework.dll
OpenSpan.Controls.dll
OpenSpan.Security.dll
Pega.ClientCredentialProvider.dll

Build 3.1.3.0 — August 19, 2019 — bundled with Pega Robotic Automation 19.1.7.0.

US-318438

This build modifies the Pega RPA Service to use the correct argument format when passing the workgroup option to the Pega.Loader.exe program.

In addition, this hotfix also updates the Pega RPA Service to use a signed version of the Framework binaries and modifies the CredMgrUI.exe program to ignore empty credentials.

FrameworkBinaries/OpenSpan.Branding.dll
FrameworkBinaries/OpenSpan.Runtime.Core.dll
FrameworkBinaries/OpenSpan.Security.dll
FrameworkBinaries/OpenSpan.dll
Pega.RpaService.Common.dll
Pega.RpaService.CredentialManagerUI.exe
Pega.RpaService.Loader.exe

ISSUE-25935

This build adds updated copyright information for all versioned files.

All versioned files.

Build 3.1.2.0 — June 28, 2019 — bundled with Pega Robotic Automation 19.1.2.0.

US-267153

This build modifies the Credentials Manager (CredMgr.exe/CredMgrUI.exe) (DPAPI) tools to accept the workgroup field when you save credentials. This information can be retrieved by the Pega RPA Service or Pega Robot Runtime.

This build also adds workgroup support to the CyberArk and DPL credential providers.

These changes allow you to retrieve different Registration Operator, Windows User, and Runtime User credentials based on your current workgroup.

Pega.RpaService.Common.dll
OpenSpan.Security.dll
CredMgr.exe
CredMgrUI.exe
Pega.RpaService.Loader.exe
Pega.RpaService.Scheduler.exe
Pega.RpaService.Service.exe

ISSUE-62354

This build adds a default heartbeat interval of 30 seconds. This default is used if the heartbeat interval is not set on Pega Platform.

This build also modifies the log message if an exception is thrown.

Pega.RpaService.Service.exe

BUG-486961

Pega.RpaService.Common.dll

Build 3.1.1.0 — May 31, 2019 — bundled with Pega Robotic Automation 19.1.1.0

Not applicable

This is the initial released build of the Pega RPA Service for Pega Robotic Automation 19.1.

Not applicable