Skip to content

docs: add error handling guidance to uipath-coded-workflows skill#84

Open
1aifanatic wants to merge 1 commit intoUiPath:mainfrom
1aifanatic:feat/error-handling-guidance
Open

docs: add error handling guidance to uipath-coded-workflows skill#84
1aifanatic wants to merge 1 commit intoUiPath:mainfrom
1aifanatic:feat/error-handling-guidance

Conversation

@1aifanatic
Copy link
Copy Markdown

@1aifanatic 1aifanatic commented Mar 26, 2026

Summary

Adds skills/uipath-coded-workflows/GUIDANCE-error-handling.md — a comprehensive reference for building robust, self-recovering coded workflows.

Contents:

  • Exception hierarchy table — maps each exception type (HttpRequestException, TimeoutException, FileNotFoundException, etc.) to the correct action (retry, fail immediately, re-authenticate)
  • Retry with exponential backoff — reusable RetryHelper class + inline loop pattern with IsTransient() predicate
  • Three try/catch templates: queue item processing (ApplicationException vs BusinessException distinction), global exception handler with Slack alert, finally block for guaranteed resource cleanup
  • Recovery patterns: Checkpoint/Resume for long-running jobs (JSON-based progress file), dead-letter queue for unprocessable items, circuit breaker to stop hammering failing APIs
  • Logging best practices — correct log levels, including context in messages, tracking duration, what never to log (secrets, credentials)
  • Quick reference table — scenario → pattern mapping for fast lookup

Motivation

Coded workflows that fail on the first exception and lose progress are a common pain point. The existing skill teaches how to write workflows but doesn't cover how to make them resilient. This guidance file fills that gap without modifying the core SKILL.md, following the pattern established by other GUIDANCE-*.md files in the repo.

Test plan

  • Verify RetryHelper C# code compiles against .NET Standard 2.0 (UiPath project target)
  • Verify queue item status values (QueueItemStatus.Successful, QueueItemStatus.Failed, QueueItemErrorType) match UiPath.System.Activities API
  • Verify system.GetQueueItem, system.SetTransactionStatus, system.AddQueueItem match the system service API in uipath-coded-workflows SKILL.md
  • Verify the CircuitBreaker and CheckpointManager are plain C# (no UiPath-specific dependencies) so they can be used as Coded Source Files

Adds comprehensive error handling reference covering retry with exponential
backoff, exception hierarchy, try/catch templates (queue items, global handler,
finally cleanup), circuit breaker, checkpoint/resume for long-running jobs,
dead-letter queues, and logging best practices.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant