Enabling verbose-level Runtime logging

Enabling verbose-level Runtime logging

Description	How to implement verbose-level logging to diagnose issues in Runtime
Version as of	19.1, 8.0 SP1
Application	Robotic Process Automation
Capability/Industry Area	Robotic Automation

Overview

Capturing verbose-level Runtime logging files can help to diagnose and resolve errors, when requested by the Pega Robotic Automation support team. The default location of the RuntimeConfig.xml may differ depending on the version of the product.

• For Robot Runtime version v19.1: %appdata%\Pegasystems
• For Robot Runtime version 8.0 SP1 and earlier: %appdata%\Openspan

Use case example

If you are designing an automation with Pega Robot Studio, and it isn't working as expected, verbose logging can help you or Pega Support determine what the issue is.

Modifying the RuntimeConfig.xml file

To enable verbose logging, perform the following steps:

1. Before starting Pega Robot Runtime, navigate to the RuntimeConfig.xml file.
2. Open the xml file in your preferred text editor.
3. Find type=“OpenSpan.Diagnostics.Publishers.FilePublisher" near the top of the document. On the same line, set the publisher mode to on.
4. Towards the bottom of the file, find the <LogCategories> section. For each category, change the logLevel attribute from its current value to 4.

logLevel attribute for verbose logging

In Notepad, all logLevels can be set to 4 at once, using the Ctrl+H and Replace window.

1. Save the file.
2. Re-create the issue that you experienced. Take note of when you began the steps to re-create the issue and when you finished.
3. After you re-create the issue, turn off the logging by setting the publisher mode to off  for type=“OpenSpan.Diagnostics.Publishers.FilePublisher”.
4. Collect the log file, timestamps, and any additional notes about the issue and provide them to your Support Engineer for analysis.

Results

You can find the log files in the same folder as the RuntimeConfig.xml file. The file is assigned the name RuntimeLog.txt.

A business solution that automates workflows in your organization. Multiple, unrelated applications can be hosted in the same system. You create an application by running the New Application wizard.

An action that does not require human involvement but can instead be done programmatically.

1) In user portals, a "team" is equivalent to a "work group". 2) One or more associates who work semi-autonomously on recurring tasks or towards a common goal. In a Pega Workforce Intelligence hierarchy, departments are comprised of teams. (Defined by the WFI team)

Contains the configuration settings that are primarily used by Pega Robot Runtime. Pega Robot Runtime is installed as a stand-alone application and is also installed with a Pega Robot Studio installation.

An action that does not require human involvement but can instead be done programmatically.

(Deprecated) A configuration of panels (areas) in a harness that support a composite portal. Existing panel sets continue to function. As a best practice, upgrade panel sets to screen layouts.

The building blocks of your user interface, sections can use design templates for their structure and contain such interactive UI elements as fields, buttons, lists, and so on. A section creates a functional chunk of a user interface, and can be reused throughout your application for improved consistency and efficient development.

For example, your application may need to display user data as a list of ID cards. You can create a section for the contents of a card, and then reuse that section so that the design of every card is consistent.

A case in a concrete class that inherits from the Work-Folder- class. A folder object holds a collection of one or more cases, including covers and other folders, to provide access for analysis and reporting.