Table of Contents

Managing Runtime configuration files

Robot Manager 8.3.1 provides the capability to manage your Runtime configuration files from a centralized location. You can easily customize your configuration options for both attended and unattended robots, and associate different configurations with different applications. You can also assign a specific configuration to a department, work group, user, or robot. These assigned files will be deployed to Runtime systems at startup.

To manage the Robot Runtime configuration from a centralized location, the following software is required:

  • Pega Robot Studio or Pega Robot Runtime or both, version 19.1.7 or later
  • RPA Service version 3.1.3 or later
  • Synchronization engine version 3.1.2 or later

For more information about Runtime configuration, see the following sections:

Runtime configuration files - Introduction

The RuntimeConfig.xml file contains the configuration settings primarily used by Pega Robot Runtime. Pega Robot Runtime is installed as a stand-alone application and also with a Pega Robotic Automation Studio installation.

The RuntimeConfig.xml file includes options which let you do the following tasks:

  • Turn on diagnostics
  • Configure Pega Robotic Automation features
  • Define what diagnostic information is recorded
  • Define logging categories
  • Define which events are recorded
  • Specify general application settings, for example, what project should be loaded automatically when Pega Robot Runtime starts

With Pega Robot Manager, you can manage Runtime configuration files and switch between various configurations as needed within the context of a department, work group, individual user, robot, or an application.

Runtime configuration effective association for automations

You can have multiple Runtime configuration files used within one application scope; the system decides which one to apply using the following criteria (in order of precedence; if a condition is true, all subsequent criteria are ignored):

For RDA users:

  1. Direct assignment to the user
  2. Direct assignment to the immediate parent department
  3. If there is no direct assignment to the user's parent department, then direct assignment to its immediate parent, and so on until the top level department in the hierarchy is reached.
  4. Default setting assigned to the user’s application
  5. The master runtime config file provided with Pega Robot Manager

For RPA users:

  1. Direct assignment to the robot
  2. Direct assignment to the work group
  3. Default setting assigned to the robot’s application
  4. The master runtime config file provided with Pega Robot Manager

Creating Runtime configuration files

You can create a Runtime configuration file by saving an existing file (such as the master file) with a new name.

  1. Log in to your application built on Pega Robot Manager with administrative privileges.
  2. From the Pega Robot Manager dashboard, click Settings.
  3. In the Settings screen, click the Runtime configs tab.
  4. Click the More icon in the row that corresponds to an existing file and select Save as.
  5. Enter the file name and a description of the configuration and click Create.
    You cannot create different files with the same name within one application nor use Master runtime config settings v8.3.1 as the file name.

Uploading Runtime configuration files

You can upload Runtime configuration files for easy reuse of the same settings in different contexts.

  1. Log in to your application built on Pega Robot Manager with administrative privileges.
  2. From the Pega Robot Manager dashboard, click Settings.
  3. In the Settings screen select the Runtime configs tab.
  4. Enter a file name and a description for the configuration file.
    You cannot create different files with the same name within one application nor use Master runtime config settings v8.3.1 as the file name.
  5. Click Upload new, then locate your local file and upload it.

Editing Runtime configuration files

You can edit Runtime configuration files in the xml-aware editor available in Pega Robot Manager. Pega Robot Manager also provides version control mechanisms and a smart lock feature.

When you start editing a Runtime configuration file, you acquire a lock on the file, which prevents other users from saving changes to the file you are currently editing. Pega Robot Manager has a smart locking feature that prolongs your lock if no other user makes changes to the same file.

If your lock expires and another user saves changes to the same file (while you are still in the editor), a notification appears. To keep your changes, you can then copy and paste the content that you entered in the editor to a file on your local computer.

  1. Log in to your application built on Pega Robot Manager with administrative privileges.
  2. From the Pega Robot Manager dashboard, click Settings.
  3. In the Settings page, select the Runtime configs tab.
  4. Click the name of the file that you want edit.
  5. Perform one or more of the following actions:
    • To replace the entire content of the current file with another file's content, click Actions > Replace XML content and upload a local file.
    • To edit the file within Pega Robot Manager, click Edit and introduce your changes.
    • To edit the file offline, select Download XML and save it to you local drive. Then, introduce the changes, and upload the updated file by selecting Actions > Replace XML content.
    • To check if your xml is well-formed, click Validate.
  6. Save your changes:
    • To save changes to the same file, click Save.
    • To create a new file with the current xml content, click Actions> Save As and enter the new file name.
      You cannot create different files with the same name within one application nor use Master runtime config settings v8.3.1 as the file name.

Restoring previous Runtime configuration file versions

Because Pega Robot Manager stores the history of your Runtime configuration files, you can easily restore past versions.

  1. Log in to your application built on Pega Robot Manager with administrative privileges.
  2. From the Pega Robot Manager dashboard, click Settings.
  3. In the Settings page select the Runtime configs tab.
  4. Click the name of the file that you want to review or restore.
  5. Go to the History tab.
  6. Click a row that corresponds to a file version to preview the file and display the available actions.
  7. To restore your file, Restore.

Editing application-default settings for Runtime configuration files

When you create a new application built on Pega Robot Manager, the Master runtime config settings v8.3.1 file is always set as the default Runtime configuration file. You can change this setting and use any other file available in the application context, including Runtime configuration files that are inherited from other built-on applications.

Result: The selected file is now the default Runtime configuration file used in the application (for users or robots that do not have any assignments – neither direct nor inherited from departments or work groups).

  1. Log in to your application built on Pega Robot Manager with administrative privileges.
  2. From the Pega Robot Manager dashboard, click Settings.
  3. In the Settings screen, select the Runtime configs tab.
  4. Click the More icon in the row that corresponds to an existing file and select Set as default.

Adding and removing entity assignments for Runtime configuration files

You can assign specific Runtime configuration files to an organizational entity (from departments and work groups to individual users or robots). These entity assignments take precedence over any application-default settings. For more information, see Runtime configuration effective association for automations.

  1. Log in to your application built on Pega Robot Manager with administrative privileges.
  2. From the Pega Robot Manager dashboard, click Settings.
  3. In the Settings page select the Runtime configs tab.
  4. Click the name of the file that you want to assign.
  5. Peform the following actions:
    You can create assignments only for the entities which belong to the same application (and not the application stack).
    • To add a new direct assignment, in the Runtime config drill-in screen, click Assign new. Select the entity to assign the file to and confirm the assignment.
    • To remove an existing direct assignment, in the Runtime config drill-in screen, click the Delete icon next to the entity.

Editing entity assignments for Runtime configuration files

  1. Log in to your application built on Pega Robot Manager with administrative privileges.
  2. From the Pega Robot Manager header, click Users.
  3. Navigate to the entity whose assignments you want to edit.
  4. To change an existing assignment to an entity, perform the following actions:
    • To change a default assignment (such as an application default or inherited default), in the Runtime config section, click Override. Select a Runtime configuration file to set as the entity assignment and click Submit.
    • To change a direct assignment , in the Runtime config section, click Replace. Select a Runtime configuration file to set as the entity assignment and click Submit.
Suggest Edit

Have a question? Get answers now.

Visit the Pega Support Community to ask questions, engage in discussions, and help others.