Managing Runtime configuration files in Pega Robot Manager 8.4.2
Robot Manager 8.4.2 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 Robotic Automation version 19.1.23 or later
- Pega RPA Service version 3.1.6.0 or later
- Pega Synchronization Engine version 3.1.5.0 or later
For more information about Runtime configuration, see the following sections:
- Runtime configuration file - Introduction
- Runtime configuration effective association for automations
- Creating Runtime configuration files
- Uploading Runtime configuration files
- Editing runtime configuration files
- Restoring previous Runtime configuration file versions
- Editing application-default settings for Runtime configuration files
- Adding and removing entity assignments for Runtime configuration files
- Editing entity assignments for Runtime configuration files
- Enabling reporting data collection on Pega Robot Runtime
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 Robot 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:
- Direct assignment to the user
- Direct assignment to the immediate parent department
- 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.
- Default setting assigned to the user’s application
- The master runtime config file provided with Pega Robot Manager
For RPA users:
- Direct assignment to the robot
- Direct assignment to the work group
- Default setting assigned to the robot’s application
- 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.
- Log in to your application built on Pega Robot Manager with administrative privileges.
- From the Pega Robot Manager dashboard, click Settings.
- In the Settings screen, click the Runtime configs tab.
- Click the More icon in the row that corresponds to an existing file and select Save as.
- Enter the file name and a description of the configuration and click Create.
Uploading Runtime configuration files
You can upload Runtime configuration files for easy reuse of the same settings in different contexts.
- Log in to your application built on Pega Robot Manager with administrative privileges.
- From the Pega Robot Manager dashboard, click Settings.
- In the Settings screen select the Runtime configs tab.
- Enter a file name and a description for the configuration file.
- 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.
- Log in to your application built on Pega Robot Manager with administrative privileges.
- From the Pega Robot Manager dashboard, click Settings.
- In the Settings page, select the Runtime configs tab.
- Click the name of the file that you want edit.
- 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.
- 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.
Restoring previous Runtime configuration file versions
Because Pega Robot Manager stores the history of your Runtime configuration files, you can easily restore past versions.
- Log in to your application built on Pega Robot Manager with administrative privileges.
- From the Pega Robot Manager dashboard, click Settings.
- In the Settings page select the Runtime configs tab.
- Click the name of the file that you want to review or restore.
- Go to the History tab.
- Click a row that corresponds to a file version to preview the file and display the available actions.
- 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.4.2 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).
- Log in to your application built on Pega Robot Manager with administrative privileges.
- From the Pega Robot Manager dashboard, click Settings.
- In the Settings screen, select the Runtime configs tab.
- 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.
- Log in to your application built on Pega Robot Manager with administrative privileges.
- From the Pega Robot Manager dashboard, click Settings.
- In the Settings page select the Runtime configs tab.
- Click the name of the file that you want to assign.
- Peform the following actions:
- 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
- Log in to your application built on Pega Robot Manager with administrative privileges.
- From the Pega Robot Manager header, click Users.
- Navigate to the entity whose assignments you want to edit.
- 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.
Enabling reporting data collection on Pega Robot Runtime
You can enable the data collection on Pega Robot Runtime for the reporting feature on Pega Robot Manager by configuring the RuntimeConfig.xml file. The reporting feature in Pega Robot Manager extends the capabilities offered by Pega Platform, so that you can create, edit, and view reports from applications that include Pega Robot Manager in their application stack.
- Log in to your application built on Pega Robot Manager with Developer, Runtime User, Robot Admin, or Admin privileges.
- From the Pega Robot Manager dashboard, click Settings.
- In the Settings page, select the Runtime configs tab.
- If only the Master settings file exists, create a new Runtime configuration file. For more information, see Creating Runtime configuration files.
- Click the file that you want to edit.
- Click Edit.
- In the XML editor, go to the line that contains the
<PublishToRobotManager
enabled="value">
command, and set the value to"true".
Correct command reads:<PublishToRobotManager enabled="true">
Customize data collection according to your business needs by configuring any of the following attributes:
HealthStatistics enabled
– Indicate whether to collect health statistics, including login information, the Pega Robot Runtime version, the package name and version, and any fatal exceptions.UsageStatistics enabled
– Indicate whether to collect the automation and activity usage statistics.publishInterval
– Indicate how often (in minutes) Pega Robot Runtime publishes the health and usage statistics data to Pega Robot Manager.ssoUserIdRule
– Required for SSO authentication only. Specify how Pega Robot Runtime forms the UPN for the Pega Security Token Service (STS) server. You can set this attribute to the following values:FullUPN
– Format the user ID as [email protected]. This is the default value.PartialUPN
– Format the user ID as username@supportUsername
– Format the user ID as username.
- Click Save.
- In the Save changes modal dialog box, describe the change, and click Submit.
- To assign the file to a specific entity:
Assign new.
b) In the Assign new modal dialog box, select the entity to which you want to assign the file.
c) Click Submit.
a) Click
Previous topic Creating, editing, and viewing reports in Pega Robot Manager 8.4.2 Next topic Using Pega Robot Manager 8.4.2