Real-Time Client Logs

The real-time client generates log files that can be used for analyzing and debugging automation solutions executed by the real-time client. The real-time client generates logs whether running on the designer's machine or the agent's desktop.

The logs provide details on every aspect of the solution being run. For example, a log is added when:

• The solution is initiated.

• Any error occurs.

• A variable's value changes.

• A workflow ends.

• An event handler is triggered.

• A callout is displayed.

The logs are highly configurable.

The logging mechanism is based on the Log4Net solution. For additional information beyond what is provided below, consult Log4Net documentation and other Internet resources.

Log File Location

The location of the RTClient log file depends on the version of Automation Studio in use:

Automation Studio Version	Location of RTClient Log File
Lower than 7.3	%APPDATA%\Nice_Systems\Real-Time\log\
7.3 and Higher	%APPDATA%\Nice_Systems\AutomationStudio\log\

The file is named RTClient.log.

The log folder and file are only created when a solution is run for the first time.

The file is rolled (cleared) automatically when it reaches a specified size. A backup is made of the file and is named with a backup counter, for example, RTClient.log.1. The file name and rolling policy can be configured.

Log Configuration

Real-Time Client logging is highly configurable.

The location of the RTClient configuration file depends on the version of Automation Studio in use:

Automation Studio Version	Location of RTClient Configuration File
Lower than 7.3	%APPDATA%\Nice_Systems\Real-Time\RTClient.exe.config
7.3 and Higher	%APPDATA%\Nice_Systems\AutomationStudio\RTClient.exe.config

Use any text editor to edit the configuration file.

Changes made to the configuration generally only take effect after restarting the Real-Time Client, for example, after clicking Start Project.

You can configure the following:

• The contents of each log

• The minimum severity level of logs to include

• Advanced configuration

Configure Log Contents

The following information is provided by default for each event logged:

• Date and time

• The name of the application thread that triggered the log

• The level of the log event

• The name of the logger that generated the log

• The event details

Some examples are displayed below:

log	Thread	Level	Logger	Description
2020-06-14 12:22:43,705 [ShellThread] SYSTEM System - Starting Session (RT Client version 7.2.0.712)...	ShellThread	System	System	The solution started running.

The contents and format of each log entry can be configured.

To configure the contents and format of each log entry:

1. Open the configuration file.

2. Locate the section title <!-- LAYOUT CONFIGURATION -->.

3. Modify the conversionPattern value. By default, it is set as below:

   <conversionPattern value="%date [%thread] %-5level %logger - %message%newline" />

Configure Minimum Severity of Logged Events

Each logged event is automatically assigned a severity level. The log levels are listed below in ascending order of severity:

• DEBUG

• INFO

• WARN

• ERROR

• FATAL

You can choose the minimum severity of logged events to include in the log. Also, instead of specifying one of the severity levels listed above, you can specify:

• ALL to include all logs

• OFF to exclude all logs

The minimum severity of logs to include is specified on two levels:

• Logger level: The level set per logger, for example, for the Workflows logger which logs workflow-related events.

• Overall level: The level set for the whole log file.

Where the logger level and overall level conflict, the most exclusive of the two levels will be applied. For example:

• If the overall threshold level is set to WARN and the Workflows logger level is set to INFO, the overall threshold will apply and only Workflows logs of severity WARN or higher will be included.

• If the overall threshold level is set to INFO and the Workflows logger level is set to WARN, the Workflows logger level will apply and only Workflows logs of severity WARN or higher will be included.

Configure Minimum Severity of Logged Events per Logger

Logs are generated by multiple loggers where each logger is responsible for a different aspect of an automation solution. For example, there is a logger for workflows and another for event handlers.

You can specify the minimum severity of logged events to include from each logger individually. For example, if you are testing a workflow in detail, you might want to include ALL logs generated by the Workflows logger and only include the FATAL logs generated by the EventHandlers logger.

The table below lists loggers that are most useful when debugging an automation solution.

logger	Description
BizEntities	Events related to variables For example: Business Entity property changed - name: 'Log.SaleDate, old value: '6/14/2020 12:22:00 PM', new value: '6/1/2020 12:00:00 AM' The value of the variable SaleDate changed from 6/14/2020 12:22:00 PM to 6/1/2020 12:00:00 AM.

To configure the minimum severity level per logger:

1. Open the configuration file.

2. Locate the section title <!-- ROOT LOGGER CONFIGURATION -->.

3. Locate the entry for the logger you want to configure and modify its level value. Either specify one of the log levels listed above, or specify ALL or OFF.

   For example, the level for the EventHandlers logger is set to Fatal below.

   <logger name="EventHandlers">
   	<level value="Fatal" />
   </logger>
   

Configure Overall Minimum Severity of Logged Events

You can set the minimum level of severity of all logs to include in the log file. This is called the threshold level.

Only events with a severity level equal to or higher than the threshold level are included in the log file.

To configure the overall threshold logging level:

1. Open the configuration file.

2. Locate the section title <!-- APPENDER CONFIGURATION -->.

3. Set the threshold value. Either specify one of the log levels listed above, or specify ALL or OFF.

   For example, the threshold level is set to WARN below. Logs with levels of INFO and DEBUG will be excluded as they are of lower severity than WARN.
   

   <threshold value="WARN" />

Advanced Log Configuration

In addition to setting the minimum severity of logged events, many other configurations are available.

The table below lists all configuration settings.

Setting	Description	Default Configuration
fileNameFormat	The full path of the log file.	For versions lower than 7.3: <fileNameFormat value="%env{APPDATA}\Nice_Systems\Real-Time\log\RTClient.log" /> For version 7.3 and higher: <fileNameFormat value="%env{APPDATA}\Nice_Systems\AutomationStudio\log\RTClient.log" />

To perform advanced configuration of Real-Time Client logging:

1. Open the configuration file.

2. Locate the section title <!-- APPENDER CONFIGURATION -->.

3. Locate the setting you want to configure and modify its value.