Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Understanding the SchedulerDefinitions.xml file for managing login pathways

Updated on October 19, 2022

With the Pega RPA Service, you can log into a virtual machine as a Windows user and start or stop Pega Robot Runtime. You can also specify the daily schedules for an unattended robot to better manage production systems that have applications that are not always available.

The RPA Service uses the SchedulerDefinitions.xml file to complete its tasks. This file includes the information that the service requires to handle Windows 7 and Windows Server 2012 login pathways. For other operating systems, use this file to define the sequence of login screens and the actions that the system must take to start the virtual machine.

Before working with the SchedulerDefinitions.xml file, understand the following basic information:

File Location

When you install the RPA Service, the setup wizard copies the SchedulerDefinitions.xml file to the \Programdata\Pegasystems\RPAService folder. The RPA Service uses the SchedulerDefinitions.xml file that is located in this folder.

Updates to Robot Studio or Robot Runtime

When you update Robot Studio or Robot Runtime with a newer build, the system checks for a SchedulerDefinitions.xml file in the \Programdata\Pegasystem\RPAService folder.

If the SchedulerDefinitions.xml file exists in the folder, the installer does not replace this file. Your changes to this file remain available. However, an update always overwrites the template version of the SchedulerDefinitions.xml file.

Local account logins

The SchedulerDefinitions.xml file contains entries for both domain and local account logins.


The SchedulerDefinitions.xml file includes entries, or matchsets, for Windows 7, Windows 8.1, Windows 10, Windows Server 2008 R2, Windows Server 2012 R2, and Windows Server 2016 login sessions. The Pega RPA Service determines which matchset to use based on the operating system of the computer or the virtual machine on which the robot runs.

If a machine is not logged in and the robot is scheduled to run, the Pega RPA Service reads the appropriate matchset from the SchedulerDefinitions.xml file. The Pega RPA Service searches for the screens and controls that are displayed based on the order in which the matchsets are listed in the SchedulerDefinitions.xml file.

For example, if the robot runs on a Windows 7 computer, the Pega RPA Service executes the instructions in the following order:

  • The Pega RPA Service checks for the disclaimer screen.
    • If no OK button is displayed, the RPA Service stops the login attempt because the matchFailurekey is set to Stop.
    • If an OK button is displayed, the RPA Service clicks the button and continues to the next section.
  • The RPA Service checks to see whether the Username and Password fields exist.
    • If the Username and Password fields are available, the RPA Service retrieves and enters the user name and password from the Pega Credentials Manager utility (CredMgr.exe file), clicks the OK button, and then stops.
    • If the user name and password do not match, the RPA Service moves to the next matchset.

Interpreting log entries

To add a matchset and define the actions that the system performed during the login sequence, review the RPAService.log file. Use the Accessibility log entries in this file to determine which controls are displayed on the various screens.

The following figure is an example of the RPAService.log file, which is located in the \Programdata\Pegasystems\RPAService folder by default:

RPA Service log file
RPA Service log file with different sections tagged.

In this example, the highlighted sections show which screens are displayed during a login sequence and how to modify the SchedulerDefinitions.xml file:

A. The disclaimer screen is displayed.

B. The login engine finds and clicks the OK button on the disclaimer screen.

C. The login engine collects all controls for the login screen.

D. The login engine pushes the static user name to the Username field. The login engine then enters the password supplied from Pega Credentials Manager in the Password field before clicking the Submit button.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us