Study guide

4.2 Logging Levels, Robot Logs & Custom Log Fields in REFramework

UiPath Automation Developer Professional UiPath-ADPv1

Track your progress as you read

Finished sections get a check mark.

1 Chapter 1: Exam Overview & Blueprint Map

1.1 About the UiPath-ADPv1 Exam: Format, Fees & Policies 1.2 The Exam Topics Mapped to This Guide & a Study Plan

2 Chapter 2: REFramework Architecture & State Dynamics

2.1 State Machine Architecture & The Four Core States 2.2 Configuration Management: Settings, Constants, and Assets 2.3 Transaction Types & The Dispatcher vs. Performer Architecture 2.4 Adapting REFramework: Tabular Data, Collections & Linear Processes

3 Chapter 3: REFramework Exception Handling & Recovery

3.1 BusinessRuleException vs. System.Exception Handling Patterns 3.2 Retry Mechanisms: Queue Retries vs. REFramework MaxRetryNumber 3.3 Consecutive System Exceptions & Graceful Process Termination

4 Chapter 4: State Machines, Custom Log Fields & REFramework Testing

4.1 Building State Machine Projects in Studio 4.2 Logging Levels, Robot Logs & Custom Log Fields in REFramework 4.3 Testing a REFramework Project With and Without Orchestrator Queues

5 Chapter 5: LINQ Queries & DataTable Operations

5.1 LINQ Essentials for Collections & Filtering 5.2 Advanced DataTable Querying with LINQ 5.3 In-Memory DataTable Transformations & Column Operations

6 Chapter 6: Regex, DateTime, JSON & Invoke Activities

6.1 Regular Expressions & Text Parsing for Automation 6.2 DateTime Formatting, Timezone Conversions & TimeSpan Calculations 6.3 JSON Parsing, JSONPath & Serialization with Newtonsoft.Json 6.4 Invoke Method & Invoke Code Activities 6.5 Data Referencing in Invokes: DataTable, List & Dictionary Arguments

7 Chapter 7: Modern UI Automation & Unified Targeting

7.1 Modern Design Experience & The Unified Target Concept 7.2 Anchors, Relative Elements & UI Automation Activities 7.3 Dynamic Selectors, Variables & Wildcards in Selectors

8 Chapter 8: Object Repository, Computer Vision & Remote Runtime

8.1 Object Repository & UI Descriptor Libraries 8.2 AI Computer Vision for Unattended & Remote Interfaces 8.3 Automation in Virtual Environments & UiPath Remote Runtime

9 Chapter 9: Advanced UI Automation: Browser Modes, Agentic UI & macOS

9.1 Browser Automation with the WebDriver Protocol 9.2 Agentic UI Automation: ScreenPlay, Semantic Activities & Healing Agent 9.3 macOS Automation: Native Apps, Office Apps & AppleScript

10 Chapter 10: Advanced Control Flow & Exception Architecture

10.1 Flowcharts, Sequences & Parallel Control Flow Patterns 10.2 Global Exception Handler Architecture & ErrorAction Directives 10.3 TryCatch, Retry Scope & Custom Exception Architectures

11 Chapter 11: Orchestrator Queues & Transaction Management

11.1 Queue Architecture, SpecificContent & Transaction Lifecycles 11.2 Queue Items SLA, Postpone, Deadlines & Priority Scheduling 11.3 Bulk Operations, Transaction Status Updates & Queue Triggers

12 Chapter 12: Orchestrator Tenant & Folder Entities

12.1 Asset Types, Per-Robot Assets & External Credential Stores 12.2 Modern Folder Hierarchy, User/Robot Assignment & Permissions 12.3 Storage Buckets, Webhooks & Environment Promotion 12.4 Orchestrator Tags: Labels, Properties & Governance

13 Chapter 13: Unattended Execution, API Triggers & Cloud Robots

13.1 Unattended Job Execution: Folders, Priorities, Background vs. Foreground & Runtimes 13.2 API Triggers: Starting Jobs from External Systems over HTTP 13.3 Serverless and Cloud VM Robots: Cloud-Hosted Execution Options

14 Chapter 14: Monitoring, Recording & Solutions Management

14.1 Orchestrator Monitoring, Trigger Alerts & Job Health 14.2 Job and Transaction Recording: Troubleshooting Faulted Unattended Jobs 14.3 Solutions Management: Packaging and Deploying Automations with Their Resources

15 Chapter 15: Debugging, Remote Debugging & Profiling

15.1 Studio Debugging Tools: Breakpoints, Panels & Execution Control 15.2 Remote Debugging: Remote Machine and Unattended Robot Connections 15.3 Profile Execution: Finding Performance Bottlenecks in Studio

16 Chapter 16: RPA Testing & Test Suite

16.1 UiPath Test Suite Overview, Test Cases & Given-When-Then Structure 16.2 Data-Driven Testing, Test Verification Activities & Mock Activities 16.3 CI/CD Pipelines with uipcli & Test Manager Traceability

17 Chapter 17: Long-Running Workflows, Action Center & Apps

17.1 Long-Running Workflows: Persistence, Suspend and Resume 17.2 Action Center & Human-in-the-Loop Orchestration 17.3 UiPath Apps: Action Apps, Automations & Integration Service

18 Chapter 18: Trigger-Based Attended Automation & Callouts

18.1 Trigger-Based Attended Automation: Forms, Triggers & Global Variables 18.2 Running Local Triggers & the Event Inspection Tool 18.3 Callouts & Forms for Attended Guidance

19 Chapter 19: UiPath Assistant & Robot Sessions

19.1 UiPath Assistant: Automations, Reminders, Widgets & Configuration 19.2 Robot Session (Picture in Picture): Child Session vs. Virtual Desktop

20 Chapter 20: Autopilot for Developers & Autopilot for Everyone

20.1 Autopilot for Developers: AI Assistance in Studio and Studio Web 20.2 Autopilot for Everyone: Chat, Automations & Clipboard AI

21 Chapter 21: API Automation & Integration Service

21.1 Integration Service: Connectors, Connections & Connector Activities 21.2 API Workflows in Studio Web 21.3 HTTP Requests: Web APIs, the Orchestrator API & Connector Requests 21.4 Connector Builder: Custom Integration Service Connectors 21.5 Integration Service Event Triggers: Connected and Disconnected 21.6 GenAI Activities: Generative AI Inside Workflows

22 Chapter 22: Data Service, Context Grounding & Coded Workflows

22.1 Data Fabric (Data Service) Entities: Modeling Business Data 22.2 Data Fabric Activities and the Platform Connector 22.3 Context Grounding: Retrieval-Augmented Generation with Company Data 22.4 Coded Automations: Structure, Arguments & Invoking Workflows 22.5 Coded Automation Services: Orchestrator, UI Automation, Microsoft 365 & Custom Services

23 Chapter 23: Integrated Scenario Practice

23.1 Integrated Scenario Practice: Designing an End-to-End Solution

4.2 Logging Levels, Robot Logs & Custom Log Fields in REFramework

Key Takeaways Explain This Topic AI

Log Message offers Trace, Info, Warn, Error, and Fatal; the robot logging level filters with Verbose, Trace, Information, Warning, Error, Critical, and Off.

Default logs include Execution Start and End and Transaction Start and End at Information level; Verbose adds activity tracking with variable values.

Add Log Fields attaches key-value pairs to every later log in the job until Remove Log Fields removes them; fields such as jobId and processName cannot be overridden.

REFramework adds logF_BusinessProcessName in Initialization and adds then removes logF_TransactionStatus, Number, ID, Field1, and Field2 in SetTransactionStatus.xaml.

Set out_TransactionID and the two transaction fields in GetTransactionData.xaml so every log line identifies the business record.

Last updated: September 2026

4.2 Logging Levels, Robot Logs & Custom Log Fields in REFramework

Core Concept: Every UiPath robot writes structured logs through NLog. Some are default logs that the robot writes by itself, and some are user-defined logs from activities such as Log Message . Add Log Fields attaches extra key-value pairs to every later log line, and REFramework uses this to tag each transaction. The exam description lists "Use Custom Log Fields in REFramework projects" explicitly, so know both the mechanism and the fields the template adds.

Two Scales: Activity Levels and Robot Levels

The Log Message activity offers five levels: Trace, Info, Warn, Error, and Fatal . The robot logging level (set per process or per robot in Orchestrator, and in Assistant) acts as a filter with seven values, from most to least detailed:

Robot logging level What gets logged

Verbose Everything at Trace and above, plus workflow tracking: every activity's start and end, with variable and argument values

  • Trace Messages at Trace level and above
  • Information (default) Information and above
  • Warning Warning and above
  • Error Error and above
  • Critical Critical only (Fatal messages from Log Message map here)
  • Off Nothing

The order is Verbose < Trace < Information < Warning < Error < Critical < Off. If a process runs at Warning , a Log Message at Info is dropped, while Warn, Error, and Fatal messages are kept. Verbose logs can include variable values, which is why activities have a Private property that stops their values from being logged at Verbose level.

Default Logs and Their Fields

The robot writes these default logs without any activity in your workflow:

  • Default log Level Notable fields
  • Execution Start Information processName, processVersion, jobId
  • Execution End Information totalExecutionTime, totalExecutionTimeInSeconds
  • Transaction Start Information queueName, transactionID, transactionState
  • Transaction End Information transactionStatus, transactionExecutionTime
  • Error Log Error Written when execution hits an error and stops

Debugging Log Trace Written only when the level is Verbose; contains activityInfo with DisplayName, State, and Activity

Default logs carry logType = Default , and logs from Log Message or Write Line carry logType = User . Every log also has default fields such as message , level , timeStamp , fileName , jobId , processName , robotName , and machineName . Fields such as jobId , processName , processVersion , and robotName cannot be overridden with Add Log Fields.

Add Log Fields and Remove Log Fields

Add Log Fields adds user-defined key-value pairs to every subsequent log in the job, default and user-defined alike, until they are removed.

Remove Log Fields removes them by name.

This matters for traceability. After you add InvoiceNumber = "INV-1001" , a selector error thrown three workflows deeper still carries the invoice number in Orchestrator, Elasticsearch, or whatever sink the logs go to. Remove per-transaction fields at the end of each transaction, or the next item's logs will show stale values.

How REFramework Uses Custom Log Fields

The template uses both activities in two places:

Initialization (first run). Add Log Fields adds logF_BusinessProcessName , whose value comes from the Settings sheet of Config.xlsx . Several sub-processes of one business process, such as a Dispatcher and a Performer, can share the same value, so their logs can be grouped in dashboards.

SetTransactionStatus.xaml. For each outcome (success, business exception, system exception) the template adds a set of transaction fields, writes the result message, and removes them:

  • Field Filled from
  • logF_TransactionStatus "Success", "BusinessException", or "ApplicationException"
  • logF_TransactionNumber io_TransactionNumber
  • logF_TransactionID in_TransactionID , set in GetTransactionData.xaml
  • logF_TransactionField1 in_TransactionField1 , set in GetTransactionData.xaml
  • logF_TransactionField2 in_TransactionField2 , set in GetTransactionData.xaml

So the customization point is GetTransactionData.xaml : assign out_TransactionID and the two extra fields to business values (for example, invoice number, vendor, and amount). The template's default is to use the current timestamp as the ID and leave the other fields empty, which is not useful for searching. Adding your own fields, such as logF_CustomerSegment , follows the same pattern: add them where the value becomes known and remove them before the next transaction.

Where Logs Go

Locally: execution logs are written to %LocalAppData%\UiPath\Logs for user-mode robots. The NLog configuration file in the robot's installation folder controls local targets and rotation.

Orchestrator: logs at or above the process's level are sent to Orchestrator and appear on the Logs page and in job details.

External sinks: NLog targets can also send logs to systems such as Elasticsearch or a SQL database.

Good practice is to log business milestones at Info, recoverable anomalies at Warn, failures at Error, never log secrets, and keep Verbose for short diagnostic runs.

Common Exam Traps

"Debug" is not a Log Message level; the levels are Trace, Info, Warn, Error, and Fatal.

Raising the robot level to Verbose adds activity tracking. It does not change what Log Message activities write.

Custom fields added with Add Log Fields stay on every later log until you remove them, including logs written after an exception.

logF_BusinessProcessName comes from the Settings sheet, not from Constants or Assets.