@uipath/skills 1.198.0-preview.21 → 1.199.0-preview.106

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (395) hide show
  1. package/.claude-plugin/marketplace.json +1 -1
  2. package/.claude-plugin/plugin.json +1 -1
  3. package/CODEOWNERS +4 -2
  4. package/hooks/send-telemetry.ps1 +19 -13
  5. package/hooks/send-telemetry.sh +19 -13
  6. package/package.json +1 -1
  7. package/skills/uipath-admin/SKILL.md +10 -7
  8. package/skills/uipath-admin/references/audit-commands.md +21 -10
  9. package/skills/uipath-admin/references/audit-workflow-guide.md +15 -6
  10. package/skills/uipath-agents/references/coded/capabilities/guardrails/guardrails-recommend.md +6 -1
  11. package/skills/uipath-agents/references/coded/capabilities/guardrails/guardrails.md +7 -1
  12. package/skills/uipath-agents/references/coded/embedding-in-flows.md +5 -5
  13. package/skills/uipath-agents/references/coded/flow-integration.md +1 -1
  14. package/skills/uipath-agents/references/coded/quickstart.md +3 -3
  15. package/skills/uipath-agents/references/coded-vs-lowcode-guide.md +1 -1
  16. package/skills/uipath-agents/references/lowcode/capabilities/guardrails/guardrails-recommend.md +39 -2
  17. package/skills/uipath-agents/references/lowcode/capabilities/guardrails/guardrails.md +36 -2
  18. package/skills/uipath-agents/references/lowcode/capabilities/process/process.md +4 -4
  19. package/skills/uipath-agents/references/lowcode/capabilities/process/solution-files.md +1 -1
  20. package/skills/uipath-agents/references/lowcode/critical-rules/critical-rules.md +1 -1
  21. package/skills/uipath-agents/references/lowcode/project-lifecycle.md +19 -9
  22. package/skills/uipath-agents/references/lowcode/solution-resources.md +2 -2
  23. package/skills/uipath-api-workflow/SKILL.md +14 -7
  24. package/skills/uipath-api-workflow/references/cli-reference.md +2 -2
  25. package/skills/uipath-api-workflow/references/connector-activity-discovery.md +1 -1
  26. package/skills/uipath-api-workflow/references/expressions-and-context.md +2 -2
  27. package/skills/uipath-api-workflow/references/operating-published-workflows.md +74 -0
  28. package/skills/uipath-api-workflow/references/task-types.md +3 -3
  29. package/skills/uipath-api-workflow/references/troubleshooting.md +23 -10
  30. package/skills/uipath-coded-apps/SKILL.md +3 -3
  31. package/skills/uipath-coded-apps/assets/scripts/dashboards/build-dashboard.mjs +2 -2
  32. package/skills/uipath-coded-apps/references/create-action-app.md +11 -3
  33. package/skills/uipath-coded-apps/references/create-web-app.md +9 -7
  34. package/skills/uipath-coded-apps/references/dashboards/plugins/build/impl.md +3 -1
  35. package/skills/uipath-coded-apps/references/dashboards/plugins/deploy/impl.md +145 -87
  36. package/skills/uipath-coded-apps/references/dashboards/primitives/state-file.md +2 -2
  37. package/skills/uipath-coded-apps/references/debug.md +44 -37
  38. package/skills/uipath-coded-apps/references/oauth-client-setup.md +69 -616
  39. package/skills/uipath-coded-apps/references/sdk/conversational-agent.md +1 -1
  40. package/skills/uipath-coded-apps/references/sdk/data-fabric.md +3 -1
  41. package/skills/uipath-coded-apps/references/widgets/validation-station.md +169 -13
  42. package/skills/uipath-feedback/SKILL.md +12 -6
  43. package/skills/uipath-governance/references/auth-context.md +1 -1
  44. package/skills/uipath-governance/references/compliance-pack/coverage/impl.md +115 -31
  45. package/skills/uipath-governance/references/compliance-pack/full-apply/impl.md +2 -1
  46. package/skills/uipath-governance/references/compliance-pack/query/impl.md +2 -2
  47. package/skills/uipath-human-in-the-loop/SKILL.md +3 -3
  48. package/skills/uipath-human-in-the-loop/references/hitl-node-apptask.md +2 -2
  49. package/skills/uipath-human-in-the-loop/references/hitl-node-coded-action-app.md +1 -1
  50. package/skills/uipath-human-in-the-loop/references/hitl-node-quickform.md +2 -2
  51. package/skills/uipath-insights/SKILL.md +2 -2
  52. package/skills/uipath-ixp/SKILL.md +5 -5
  53. package/skills/uipath-ixp/references/cli-reference.md +1 -1
  54. package/skills/uipath-maestro-bpmn/SKILL.md +92 -8
  55. package/skills/uipath-maestro-bpmn/references/diagnose/CAPABILITY.md +5 -1
  56. package/skills/uipath-maestro-bpmn/references/diagnose/references/troubleshooting-guide.md +5 -0
  57. package/skills/uipath-maestro-bpmn/references/expression-authoring.md +16 -3
  58. package/skills/uipath-maestro-bpmn/references/operate/references/run.md +17 -3
  59. package/skills/uipath-maestro-bpmn/references/public-safety.md +15 -0
  60. package/skills/uipath-maestro-bpmn/references/registry-workflow.md +50 -22
  61. package/skills/uipath-maestro-bpmn/references/shared/local-metadata-regeneration-guide.md +17 -0
  62. package/skills/uipath-maestro-bpmn/references/shared/project-layout.md +30 -2
  63. package/skills/uipath-maestro-bpmn/references/structural-bpmn.md +54 -7
  64. package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/ScriptWritesVariableThenGatewayBranches.bpmn +8 -4
  65. package/skills/uipath-maestro-case/SKILL.md +72 -34
  66. package/skills/uipath-maestro-case/assets/templates/sdd-template-examples.md +1 -1
  67. package/skills/uipath-maestro-case/assets/templates/sdd-template.md +40 -20
  68. package/skills/uipath-maestro-case/assets/templates/sdd-viewer.html +2 -2
  69. package/skills/uipath-maestro-case/references/bindings-and-expressions.md +13 -8
  70. package/skills/uipath-maestro-case/references/bindings-v2-sync.md +1 -1
  71. package/skills/uipath-maestro-case/references/brownfield.md +13 -3
  72. package/skills/uipath-maestro-case/references/case-commands.md +6 -6
  73. package/skills/uipath-maestro-case/references/case-editing-operations.md +13 -13
  74. package/skills/uipath-maestro-case/references/case-schema.md +58 -47
  75. package/skills/uipath-maestro-case/references/connector-trigger-common.md +2 -2
  76. package/skills/uipath-maestro-case/references/evals/evals.json +124 -23
  77. package/skills/uipath-maestro-case/references/implementation.md +15 -15
  78. package/skills/uipath-maestro-case/references/phase-0-interview.md +119 -460
  79. package/skills/uipath-maestro-case/references/phased-execution.md +23 -17
  80. package/skills/uipath-maestro-case/references/placeholder-tasks.md +3 -3
  81. package/skills/uipath-maestro-case/references/planning.md +48 -28
  82. package/skills/uipath-maestro-case/references/plugins/case/impl-json.md +2 -1
  83. package/skills/uipath-maestro-case/references/plugins/case/planning.md +1 -1
  84. package/skills/uipath-maestro-case/references/plugins/conditions/case-exit-conditions/planning.md +2 -0
  85. package/skills/uipath-maestro-case/references/plugins/conditions/stage-entry-conditions/planning.md +3 -3
  86. package/skills/uipath-maestro-case/references/plugins/conditions/stage-exit-conditions/impl-json.md +2 -0
  87. package/skills/uipath-maestro-case/references/plugins/conditions/stage-exit-conditions/planning.md +2 -0
  88. package/skills/uipath-maestro-case/references/plugins/conditions/task-entry-conditions/impl-json.md +2 -2
  89. package/skills/uipath-maestro-case/references/plugins/conditions/task-entry-conditions/planning.md +18 -2
  90. package/skills/uipath-maestro-case/references/plugins/sla/impl-json.md +12 -7
  91. package/skills/uipath-maestro-case/references/plugins/sla/planning.md +23 -7
  92. package/skills/uipath-maestro-case/references/plugins/stages/impl-json.md +3 -0
  93. package/skills/uipath-maestro-case/references/plugins/stages/planning.md +7 -4
  94. package/skills/uipath-maestro-case/references/plugins/tasks/action/planning.md +15 -6
  95. package/skills/uipath-maestro-case/references/plugins/tasks/agent/planning.md +17 -34
  96. package/skills/uipath-maestro-case/references/plugins/tasks/api-workflow/planning.md +15 -13
  97. package/skills/uipath-maestro-case/references/plugins/tasks/case-management/planning.md +14 -10
  98. package/skills/uipath-maestro-case/references/plugins/tasks/connector-activity/impl-json.md +2 -2
  99. package/skills/uipath-maestro-case/references/plugins/tasks/connector-activity/planning.md +8 -2
  100. package/skills/uipath-maestro-case/references/plugins/tasks/connector-trigger/impl-json.md +1 -1
  101. package/skills/uipath-maestro-case/references/plugins/tasks/connector-trigger/planning.md +4 -0
  102. package/skills/uipath-maestro-case/references/plugins/tasks/create-inline-common.md +55 -0
  103. package/skills/uipath-maestro-case/references/plugins/tasks/process/planning.md +9 -6
  104. package/skills/uipath-maestro-case/references/plugins/tasks/rpa/planning.md +10 -5
  105. package/skills/uipath-maestro-case/references/plugins/tasks/wait-for-timer/planning.md +1 -1
  106. package/skills/uipath-maestro-case/references/plugins/triggers/event/impl-json.md +3 -3
  107. package/skills/uipath-maestro-case/references/plugins/triggers/event/planning.md +1 -1
  108. package/skills/uipath-maestro-case/references/plugins/triggers/manual/impl-json.md +1 -0
  109. package/skills/uipath-maestro-case/references/plugins/triggers/timer/impl-json.md +1 -0
  110. package/skills/uipath-maestro-case/references/plugins/variables/bindings/impl-json.md +2 -1
  111. package/skills/uipath-maestro-case/references/plugins/variables/global-vars/impl-json.md +10 -4
  112. package/skills/uipath-maestro-case/references/plugins/variables/io-binding/impl-json.md +74 -24
  113. package/skills/uipath-maestro-case/references/plugins/variables/io-binding/planning.md +51 -8
  114. package/skills/uipath-maestro-case/references/registry-discovery.md +83 -29
  115. package/skills/uipath-maestro-case/references/sdd-generation-rules.md +96 -64
  116. package/skills/uipath-maestro-flow/SKILL.md +2 -1
  117. package/skills/uipath-maestro-flow/references/author/CAPABILITY.md +1 -1
  118. package/skills/uipath-maestro-flow/references/author/references/editing-operations-json.md +1 -1
  119. package/skills/uipath-maestro-flow/references/author/references/greenfield.md +6 -6
  120. package/skills/uipath-maestro-flow/references/author/references/plugins/agent/impl.md +4 -4
  121. package/skills/uipath-maestro-flow/references/author/references/plugins/connector-trigger/impl.md +4 -1
  122. package/skills/uipath-maestro-flow/references/author/references/plugins/connector-trigger/planning.md +1 -1
  123. package/skills/uipath-maestro-flow/references/diagnose/references/failure-modes.md +5 -7
  124. package/skills/uipath-maestro-flow/references/shared/cli-commands.md +13 -12
  125. package/skills/uipath-maestro-flow/references/shared/file-format.md +1 -1
  126. package/skills/uipath-maestro-flow/references/shared/variables-and-expressions.md +2 -1
  127. package/skills/uipath-mcp-servers/SKILL.md +6 -6
  128. package/skills/uipath-mcp-servers/references/is-activity-workflow.md +17 -7
  129. package/skills/uipath-planner/SKILL.md +36 -24
  130. package/skills/uipath-planner/assets/templates/agent-sdd-template.md +111 -7
  131. package/skills/uipath-planner/assets/templates/api-workflow-sdd-template.md +75 -11
  132. package/skills/uipath-planner/assets/templates/bpmn-sdd-template.md +429 -0
  133. package/skills/uipath-planner/assets/templates/case-sdd-template.md +114 -19
  134. package/skills/uipath-planner/assets/templates/coded-app-sdd-template.md +68 -5
  135. package/skills/uipath-planner/assets/templates/flow-sdd-template.md +84 -5
  136. package/skills/uipath-planner/assets/templates/rpa-sdd-template.md +265 -26
  137. package/skills/uipath-planner/references/attended-reauth-pattern-guide.md +7 -1
  138. package/skills/uipath-planner/references/multi-skill-patterns-guide.md +11 -6
  139. package/skills/uipath-planner/references/non-pdd-lane-guide.md +90 -86
  140. package/skills/uipath-planner/references/package-selection-guide.md +4 -2
  141. package/skills/uipath-planner/references/pdd-analysis-guide.md +34 -7
  142. package/skills/uipath-planner/references/pdd-driven-lane-guide.md +25 -3
  143. package/skills/uipath-planner/references/plan-and-tasks-format.md +7 -6
  144. package/skills/uipath-planner/references/platform-availability-guide.md +5 -2
  145. package/skills/uipath-planner/references/product-selection-guide.md +239 -21
  146. package/skills/uipath-planner/references/rpa-product-guide.md +22 -2
  147. package/skills/uipath-planner/references/sdd-generation-guide.md +123 -31
  148. package/skills/uipath-planner/references/tenant-library-search-guide.md +6 -4
  149. package/skills/uipath-planner/scripts/docx-extract.ps1 +59 -0
  150. package/skills/uipath-planner/scripts/sdd-to-docx.ps1 +74 -0
  151. package/skills/uipath-platform/SKILL.md +12 -3
  152. package/skills/uipath-platform/references/data-fabric/data-fabric.md +7 -1
  153. package/skills/uipath-platform/references/data-fabric/entity-schema.md +21 -2
  154. package/skills/uipath-platform/references/data-fabric/filter-platform-contract.md +2 -0
  155. package/skills/uipath-platform/references/data-fabric/records-query.md +12 -0
  156. package/skills/uipath-platform/references/integration-service/triggers.md +2 -0
  157. package/skills/uipath-platform/references/orchestrator/tenant-admin.md +3 -1
  158. package/skills/uipath-rpa/CLAUDE.md +12 -10
  159. package/skills/uipath-rpa/SKILL.md +62 -34
  160. package/skills/uipath-rpa/references/cli-reference.md +3 -1
  161. package/skills/uipath-rpa/references/coded/codedworkflow-reference.md +1 -1
  162. package/skills/uipath-rpa/references/coded/coding-guidelines.md +18 -3
  163. package/skills/uipath-rpa/references/coded/operations-guide.md +8 -6
  164. package/skills/uipath-rpa/references/legacy/activity-docs/ActiveDirectory.md +2 -3
  165. package/skills/uipath-rpa/references/legacy/activity-docs/_INDEX.md +1 -1
  166. package/skills/uipath-rpa/references/library-authoring-guide.md +1 -1
  167. package/skills/uipath-rpa/references/powershell-interop-guide.md +1 -1
  168. package/skills/uipath-rpa/references/project-structure-guide.md +1 -1
  169. package/skills/uipath-rpa/references/testing-guide.md +1 -1
  170. package/skills/uipath-rpa/references/uia-starter-guide.md +216 -0
  171. package/skills/uipath-rpa/references/validation-guide.md +2 -0
  172. package/skills/uipath-rpa/references/xaml/workflow-guide.md +2 -2
  173. package/skills/uipath-solution/SKILL.md +8 -6
  174. package/skills/uipath-solution/references/develop-solution.md +14 -14
  175. package/skills/uipath-solution/references/pack-and-deploy.md +4 -0
  176. package/skills/uipath-solution/references/scenarios/intra-solution-references.md +1 -1
  177. package/skills/uipath-solution/references/scenarios/manual-edits.md +2 -2
  178. package/skills/uipath-solution/references/solution-overview.md +28 -1
  179. package/skills/uipath-tasks/SKILL.md +2 -2
  180. package/skills/uipath-tasks/references/action-center-urls.md +4 -5
  181. package/skills/uipath-troubleshoot/SKILL.md +15 -9
  182. package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/overview.md +19 -2
  183. package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/browser-open-or-attach-failed.md +4 -0
  184. package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/browser-scope-errors.md +119 -0
  185. package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/click-silent-no-op.md +76 -0
  186. package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/invoke-workflow-failed.md +38 -11
  187. package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/invoke-workflow-file-design-time-errors.md +89 -0
  188. package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/queue-operation-failed.md +91 -0
  189. package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/trigger-scope-and-local-triggers-failed.md +106 -0
  190. package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/type-into-wrong-or-incomplete-text.md +91 -0
  191. package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/summary.md +7 -2
  192. package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/overview.md +38 -0
  193. package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/csv-datatable-structure-mismatch.md +32 -0
  194. package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/csv-file-locked-or-invalid-path.md +33 -0
  195. package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/csv-helper-method-not-found.md +36 -0
  196. package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/read-csv-file-not-found.md +34 -0
  197. package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/read-csv-invalid-format.md +33 -0
  198. package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/read-csv-more-values-than-header.md +34 -0
  199. package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/write-csv-access-denied.md +35 -0
  200. package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/write-csv-cannot-set-unknown-member.md +30 -0
  201. package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/write-csv-invalid-delimiter.md +27 -0
  202. package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/write-csv-unsupported-encoding.md +27 -0
  203. package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/summary.md +16 -0
  204. package/skills/uipath-troubleshoot/references/activity-packages/database-activities/playbooks/execute-query-failures.md +27 -2
  205. package/skills/uipath-troubleshoot/references/activity-packages/database-activities/summary.md +1 -1
  206. package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/overview.md +1 -1
  207. package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/excel-application-card-failures.md +20 -31
  208. package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/excel-application-scope-failures.md +7 -6
  209. package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/excel-not-installed.md +72 -0
  210. package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/null-reference-from-activity.md +150 -0
  211. package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/read-range-sheet-not-found.md +1 -1
  212. package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/{read-range-file-locked.md → workbook-file-locked.md} +54 -40
  213. package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/write-cell-failures.md +3 -3
  214. package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/summary.md +5 -7
  215. package/skills/uipath-troubleshoot/references/activity-packages/file-operations/overview.md +31 -0
  216. package/skills/uipath-troubleshoot/references/activity-packages/file-operations/playbooks/download-file-403-401-auth.md +32 -0
  217. package/skills/uipath-troubleshoot/references/activity-packages/file-operations/playbooks/download-file-host-not-found.md +33 -0
  218. package/skills/uipath-troubleshoot/references/activity-packages/file-operations/playbooks/download-file-httpclient-reused-in-loop.md +34 -0
  219. package/skills/uipath-troubleshoot/references/activity-packages/file-operations/playbooks/download-file-stuck-tmp.md +29 -0
  220. package/skills/uipath-troubleshoot/references/activity-packages/file-operations/summary.md +10 -0
  221. package/skills/uipath-troubleshoot/references/activity-packages/intelligent-ocr-activities/investigation_guide.md +36 -0
  222. package/skills/uipath-troubleshoot/references/activity-packages/intelligent-ocr-activities/overview.md +33 -0
  223. package/skills/uipath-troubleshoot/references/activity-packages/intelligent-ocr-activities/playbooks/du-document-rejected.md +32 -0
  224. package/skills/uipath-troubleshoot/references/activity-packages/intelligent-ocr-activities/playbooks/du-license-or-endpoint-rejected.md +63 -0
  225. package/skills/uipath-troubleshoot/references/activity-packages/intelligent-ocr-activities/playbooks/du-not-enabled-or-tenant-key.md +38 -0
  226. package/skills/uipath-troubleshoot/references/activity-packages/intelligent-ocr-activities/playbooks/du-storage-or-taxonomy-missing.md +44 -0
  227. package/skills/uipath-troubleshoot/references/activity-packages/intelligent-ocr-activities/summary.md +10 -0
  228. package/skills/uipath-troubleshoot/references/activity-packages/ipc-activities/investigation_guide.md +34 -0
  229. package/skills/uipath-troubleshoot/references/activity-packages/ipc-activities/overview.md +35 -0
  230. package/skills/uipath-troubleshoot/references/activity-packages/ipc-activities/playbooks/broadcast-message-timeout.md +38 -0
  231. package/skills/uipath-troubleshoot/references/activity-packages/ipc-activities/playbooks/broadcast-message-unauthorized-access.md +38 -0
  232. package/skills/uipath-troubleshoot/references/activity-packages/ipc-activities/presentation.md +9 -0
  233. package/skills/uipath-troubleshoot/references/activity-packages/ipc-activities/summary.md +9 -0
  234. package/skills/uipath-troubleshoot/references/activity-packages/jira-activities/investigation_guide.md +31 -0
  235. package/skills/uipath-troubleshoot/references/activity-packages/jira-activities/overview.md +39 -0
  236. package/skills/uipath-troubleshoot/references/activity-packages/jira-activities/playbooks/jira-activity-missing-or-not-loaded.md +37 -0
  237. package/skills/uipath-troubleshoot/references/activity-packages/jira-activities/playbooks/jira-add-comment-failures.md +50 -0
  238. package/skills/uipath-troubleshoot/references/activity-packages/jira-activities/playbooks/jira-scope-authentication-failures.md +47 -0
  239. package/skills/uipath-troubleshoot/references/activity-packages/jira-activities/playbooks/jira-scope-response-not-json-or-500.md +42 -0
  240. package/skills/uipath-troubleshoot/references/activity-packages/jira-activities/playbooks/jira-transition-issue-failures.md +47 -0
  241. package/skills/uipath-troubleshoot/references/activity-packages/jira-activities/presentation.md +9 -0
  242. package/skills/uipath-troubleshoot/references/activity-packages/jira-activities/summary.md +11 -0
  243. package/skills/uipath-troubleshoot/references/activity-packages/mail-activities/overview.md +1 -0
  244. package/skills/uipath-troubleshoot/references/activity-packages/mail-activities/playbooks/send-smtp-mail-failures.md +161 -0
  245. package/skills/uipath-troubleshoot/references/activity-packages/mail-activities/summary.md +1 -0
  246. package/skills/uipath-troubleshoot/references/activity-packages/ocr-activities/investigation_guide.md +29 -0
  247. package/skills/uipath-troubleshoot/references/activity-packages/ocr-activities/overview.md +26 -0
  248. package/skills/uipath-troubleshoot/references/activity-packages/ocr-activities/playbooks/ocr-endpoint-and-authentication.md +52 -0
  249. package/skills/uipath-troubleshoot/references/activity-packages/ocr-activities/playbooks/ocr-engine-config-and-dependencies.md +55 -0
  250. package/skills/uipath-troubleshoot/references/activity-packages/ocr-activities/playbooks/ocr-input-and-runtime.md +51 -0
  251. package/skills/uipath-troubleshoot/references/activity-packages/ocr-activities/summary.md +10 -0
  252. package/skills/uipath-troubleshoot/references/activity-packages/pdf-activities/investigation_guide.md +33 -0
  253. package/skills/uipath-troubleshoot/references/activity-packages/pdf-activities/overview.md +34 -0
  254. package/skills/uipath-troubleshoot/references/activity-packages/pdf-activities/playbooks/pdf-corrupt-or-image-input.md +49 -0
  255. package/skills/uipath-troubleshoot/references/activity-packages/pdf-activities/playbooks/pdf-encrypted-or-wrong-password.md +51 -0
  256. package/skills/uipath-troubleshoot/references/activity-packages/pdf-activities/playbooks/pdf-file-not-found-or-not-pdf.md +45 -0
  257. package/skills/uipath-troubleshoot/references/activity-packages/pdf-activities/playbooks/pdf-invalid-page-range.md +42 -0
  258. package/skills/uipath-troubleshoot/references/activity-packages/pdf-activities/playbooks/pdf-read-ocr-no-engine.md +39 -0
  259. package/skills/uipath-troubleshoot/references/activity-packages/pdf-activities/summary.md +11 -0
  260. package/skills/uipath-troubleshoot/references/activity-packages/python-activities/overview.md +1 -0
  261. package/skills/uipath-troubleshoot/references/activity-packages/python-activities/playbooks/python-scope-architecture-version-mismatch.md +2 -0
  262. package/skills/uipath-troubleshoot/references/activity-packages/python-activities/playbooks/python-scope-hang-dotnet-runtime.md +36 -0
  263. package/skills/uipath-troubleshoot/references/activity-packages/python-activities/summary.md +1 -0
  264. package/skills/uipath-troubleshoot/references/activity-packages/sap-bapi-activities/investigation_guide.md +34 -0
  265. package/skills/uipath-troubleshoot/references/activity-packages/sap-bapi-activities/overview.md +34 -0
  266. package/skills/uipath-troubleshoot/references/activity-packages/sap-bapi-activities/playbooks/sap-bapi-not-found.md +39 -0
  267. package/skills/uipath-troubleshoot/references/activity-packages/sap-bapi-activities/playbooks/sap-connection-failed.md +46 -0
  268. package/skills/uipath-troubleshoot/references/activity-packages/sap-bapi-activities/playbooks/sap-unsupported-bapi.md +32 -0
  269. package/skills/uipath-troubleshoot/references/activity-packages/sap-bapi-activities/summary.md +9 -0
  270. package/skills/uipath-troubleshoot/references/activity-packages/slack-activities/investigation_guide.md +31 -0
  271. package/skills/uipath-troubleshoot/references/activity-packages/slack-activities/overview.md +29 -0
  272. package/skills/uipath-troubleshoot/references/activity-packages/slack-activities/playbooks/connection-resolution-failure.md +46 -0
  273. package/skills/uipath-troubleshoot/references/activity-packages/slack-activities/playbooks/slack-api-error.md +65 -0
  274. package/skills/uipath-troubleshoot/references/activity-packages/slack-activities/summary.md +8 -0
  275. package/skills/uipath-troubleshoot/references/activity-packages/system-activities/investigation_guide.md +13 -0
  276. package/skills/uipath-troubleshoot/references/activity-packages/system-activities/overview.md +21 -9
  277. package/skills/uipath-troubleshoot/references/activity-packages/system-activities/playbooks/compress-extract-files-failed.md +64 -0
  278. package/skills/uipath-troubleshoot/references/activity-packages/system-activities/playbooks/download-file-failed.md +46 -0
  279. package/skills/uipath-troubleshoot/references/activity-packages/system-activities/playbooks/file-folder-operation-failed.md +61 -0
  280. package/skills/uipath-troubleshoot/references/activity-packages/system-activities/playbooks/get-asset-wrong-activity-type.md +2 -0
  281. package/skills/uipath-troubleshoot/references/activity-packages/system-activities/playbooks/queue-transaction-activity-failed.md +47 -0
  282. package/skills/uipath-troubleshoot/references/activity-packages/system-activities/summary.md +6 -0
  283. package/skills/uipath-troubleshoot/references/activity-packages/terminal-activities/investigation_guide.md +28 -0
  284. package/skills/uipath-troubleshoot/references/activity-packages/terminal-activities/overview.md +30 -0
  285. package/skills/uipath-troubleshoot/references/activity-packages/terminal-activities/playbooks/terminal-session-connection-failed.md +58 -0
  286. package/skills/uipath-troubleshoot/references/activity-packages/terminal-activities/playbooks/terminal-session-null-reference.md +40 -0
  287. package/skills/uipath-troubleshoot/references/activity-packages/terminal-activities/summary.md +8 -0
  288. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/interpretations/healing-agent-data.md +10 -27
  289. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/investigation_guide.md +1 -1
  290. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/overview.md +9 -0
  291. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/ambiguous-selector.md +2 -0
  292. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/application-not-found.md +1 -10
  293. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/browser-communication-failed.md +85 -0
  294. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/click-coordinate-off-screen.md +2 -0
  295. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/click-silent-no-op.md +79 -0
  296. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/dependency-version-conflict.md +66 -0
  297. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/disabled-element.md +2 -0
  298. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/napplicationcard-view-generation-failed.md +78 -0
  299. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/scope-container-wrong-page.md +2 -2
  300. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/selector-failure-healing-disabled.md +2 -0
  301. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/selector-failure-healing-fix.md +4 -2
  302. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/selector-failure-manual.md +3 -1
  303. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/type-into-input-failed.md +148 -0
  304. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/verify-execution-failure.md +2 -0
  305. package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/summary.md +5 -0
  306. package/skills/uipath-troubleshoot/references/activity-packages/word-activities/playbooks/add-picture-failures.md +1 -0
  307. package/skills/uipath-troubleshoot/references/activity-packages/word-activities/playbooks/word-com-interop-failures.md +5 -0
  308. package/skills/uipath-troubleshoot/references/presenting.md +3 -3
  309. package/skills/uipath-troubleshoot/references/products/agents/playbooks/context-grounding-index-not-found.md +35 -24
  310. package/skills/uipath-troubleshoot/references/products/agents/playbooks/guardrail-violation.md +14 -12
  311. package/skills/uipath-troubleshoot/references/products/agents/playbooks/input-schema-validation-failure.md +23 -13
  312. package/skills/uipath-troubleshoot/references/products/agents/playbooks/is-connection-disabled.md +6 -4
  313. package/skills/uipath-troubleshoot/references/products/agents/playbooks/is-invalid-credentials.md +12 -9
  314. package/skills/uipath-troubleshoot/references/products/agents/playbooks/is-invalid-element-instance.md +12 -9
  315. package/skills/uipath-troubleshoot/references/products/agents/playbooks/llm-insufficient-information.md +20 -13
  316. package/skills/uipath-troubleshoot/references/products/agents/summary.md +1 -1
  317. package/skills/uipath-troubleshoot/references/products/api-workflows/investigation_guide.md +52 -0
  318. package/skills/uipath-troubleshoot/references/products/api-workflows/overview.md +33 -0
  319. package/skills/uipath-troubleshoot/references/products/api-workflows/playbooks/connection-auth-failure.md +49 -0
  320. package/skills/uipath-troubleshoot/references/products/api-workflows/playbooks/expression-reference-error.md +32 -0
  321. package/skills/uipath-troubleshoot/references/products/api-workflows/playbooks/output-undefined.md +39 -0
  322. package/skills/uipath-troubleshoot/references/products/api-workflows/playbooks/publish-deploy-failure.md +38 -0
  323. package/skills/uipath-troubleshoot/references/products/api-workflows/playbooks/run-not-successful.md +37 -0
  324. package/skills/uipath-troubleshoot/references/products/api-workflows/summary.md +14 -0
  325. package/skills/uipath-troubleshoot/references/products/assistant/investigation_guide.md +71 -0
  326. package/skills/uipath-troubleshoot/references/products/assistant/overview.md +44 -0
  327. package/skills/uipath-troubleshoot/references/products/assistant/playbooks/assistant-crash.md +38 -0
  328. package/skills/uipath-troubleshoot/references/products/assistant/playbooks/orchestrator-connection-failure.md +43 -0
  329. package/skills/uipath-troubleshoot/references/products/assistant/playbooks/process-missing-or-unstartable.md +41 -0
  330. package/skills/uipath-troubleshoot/references/products/assistant/playbooks/sign-in-failure.md +42 -0
  331. package/skills/uipath-troubleshoot/references/products/assistant/summary.md +18 -0
  332. package/skills/uipath-troubleshoot/references/products/coded-apps/overview.md +49 -0
  333. package/skills/uipath-troubleshoot/references/products/coded-apps/playbooks/action-app-form-data-not-loading.md +66 -0
  334. package/skills/uipath-troubleshoot/references/products/coded-apps/playbooks/api-401-after-login.md +51 -0
  335. package/skills/uipath-troubleshoot/references/products/coded-apps/playbooks/api-403-folder-permission.md +51 -0
  336. package/skills/uipath-troubleshoot/references/products/coded-apps/playbooks/cors-error-wrong-base-url.md +46 -0
  337. package/skills/uipath-troubleshoot/references/products/coded-apps/playbooks/deploy-404-app-not-found.md +59 -0
  338. package/skills/uipath-troubleshoot/references/products/coded-apps/playbooks/invalid-scope.md +70 -0
  339. package/skills/uipath-troubleshoot/references/products/coded-apps/playbooks/isauthenticated-false-after-callback.md +59 -0
  340. package/skills/uipath-troubleshoot/references/products/coded-apps/playbooks/redirect-uri-mismatch.md +59 -0
  341. package/skills/uipath-troubleshoot/references/products/coded-apps/summary.md +14 -0
  342. package/skills/uipath-troubleshoot/references/products/integration-service/playbooks/connection-invalid.md +11 -10
  343. package/skills/uipath-troubleshoot/references/products/integration-service/playbooks/connection-not-resolved.md +3 -3
  344. package/skills/uipath-troubleshoot/references/products/integration-service/playbooks/connector-general-exception.md +1 -1
  345. package/skills/uipath-troubleshoot/references/products/integration-service/playbooks/request-failed.md +2 -0
  346. package/skills/uipath-troubleshoot/references/products/maestro/error_codes.md +2 -2
  347. package/skills/uipath-troubleshoot/references/products/maestro/investigation_guide.md +6 -2
  348. package/skills/uipath-troubleshoot/references/products/maestro/playbooks/autopilot-429.md +8 -5
  349. package/skills/uipath-troubleshoot/references/products/maestro/playbooks/expression-evaluation-errors.md +6 -0
  350. package/skills/uipath-troubleshoot/references/products/maestro/playbooks/folder-not-accessible.md +1 -1
  351. package/skills/uipath-troubleshoot/references/products/maestro/playbooks/gateway-no-outgoing-flow.md +6 -4
  352. package/skills/uipath-troubleshoot/references/products/maestro/playbooks/integration-service-404.md +3 -2
  353. package/skills/uipath-troubleshoot/references/products/maestro/playbooks/js-runtime-discrepancy.md +7 -1
  354. package/skills/uipath-troubleshoot/references/products/maestro/playbooks/marker-input-null.md +4 -0
  355. package/skills/uipath-troubleshoot/references/products/maestro/playbooks/marker-invalid-cast.md +5 -1
  356. package/skills/uipath-troubleshoot/references/products/maestro/playbooks/multi-instance-parallel.md +7 -1
  357. package/skills/uipath-troubleshoot/references/products/maestro/playbooks/no-suitable-runtime-machine.md +2 -0
  358. package/skills/uipath-troubleshoot/references/products/maestro/playbooks/personal-automation-quota.md +1 -1
  359. package/skills/uipath-troubleshoot/references/products/maestro/playbooks/service-task-child-job-faulted.md +10 -2
  360. package/skills/uipath-troubleshoot/references/products/maestro/playbooks/variable-expression-errors.md +6 -0
  361. package/skills/uipath-troubleshoot/references/products/maestro/summary.md +5 -5
  362. package/skills/uipath-troubleshoot/references/products/orchestrator/investigation_guide.md +2 -2
  363. package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-faulted-logon-failure.md +2 -0
  364. package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-faulted-session-timeout.md +50 -0
  365. package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-pending-no-host.md +2 -0
  366. package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-stuck.md +2 -0
  367. package/skills/uipath-troubleshoot/references/products/orchestrator/summary.md +1 -0
  368. package/skills/uipath-troubleshoot/references/products/studio/overview.md +34 -0
  369. package/skills/uipath-troubleshoot/references/products/studio/playbooks/studio-autopilot-unavailable.md +47 -0
  370. package/skills/uipath-troubleshoot/references/products/studio/summary.md +7 -0
  371. package/skills/uipath-troubleshoot/references/runtime-exceptions/overview.md +12 -1
  372. package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/argument-exception.md +48 -0
  373. package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/argument-out-of-range-exception.md +50 -0
  374. package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/assign-linq-no-data-rows.md +78 -0
  375. package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/assign-type-mismatch.md +91 -0
  376. package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/directory-not-found-exception.md +47 -0
  377. package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/if-condition-compiler-error.md +81 -0
  378. package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/if-wrong-branch.md +85 -0
  379. package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/index-out-of-range-exception.md +48 -0
  380. package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/invalid-operation-exception.md +51 -0
  381. package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/key-not-found-exception.md +45 -0
  382. package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/null-reference-exception.md +2 -0
  383. package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/visualbasicvalue-requires-compilation.md +47 -0
  384. package/skills/uipath-troubleshoot/references/runtime-exceptions/summary.md +11 -0
  385. package/skills/uipath-troubleshoot/references/summary.md +138 -5
  386. package/version-manifest.json +2 -2
  387. package/skills/uipath-rpa/references/ui-automation-guide.md +0 -559
  388. package/skills/uipath-rpa/references/uia-configure-target-workflows.md +0 -188
  389. package/skills/uipath-rpa/references/uia-elements-interaction-guide.md +0 -102
  390. package/skills/uipath-rpa/references/uia-prerequisites.md +0 -42
  391. package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/add-queue-item-failed.md +0 -58
  392. package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/lookup-range-excel-not-installed.md +0 -36
  393. package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/lookup-range-file-locked.md +0 -40
  394. package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/lookup-range-null-reference.md +0 -37
  395. package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/read-range-null-reference.md +0 -119
@@ -0,0 +1,34 @@
1
+ ---
2
+ confidence: medium
3
+ ---
4
+
5
+ # Download File from URL — "This instance has already started one or more requests"
6
+
7
+ ## Context
8
+
9
+ What this looks like:
10
+ - `Download File from URL` faults with `This instance has already started one or more requests. Properties can only be modified before sending the first request.` (a `System.InvalidOperationException` from `System.Net.Http.HttpClient`).
11
+ - The failure appears on the **second (or a later) iteration** when the activity runs inside a `For Each` / loop downloading multiple files; the first download often succeeds.
12
+
13
+ What can cause it:
14
+ - **Reused / improperly-disposed HTTP client across loop iterations.** The underlying `HttpClient` from the first download is still occupied (or was disposed and is being reused), so the next iteration cannot start a fresh request — `HttpClient` forbids changing properties / starting requests on an instance that already sent one.
15
+
16
+ What to look for:
17
+ - Whether `Download File from URL` sits inside a `For Each` / `While` loop over multiple URLs.
18
+ - Whether the failure is iteration-dependent (first item works, later items fail) — the signature of client-lifecycle reuse, not a per-URL problem.
19
+
20
+ ## Investigation
21
+
22
+ 1. Read the error from job evidence; confirm it is `This instance has already started one or more requests` at `Download File from URL` (an `HttpClient`/`InvalidOperationException`), not an HTTP status, DNS, or file-finalize error.
23
+ 2. Read the `.xaml`: confirm the download activity is inside a loop, and how the HTTP client / download is structured per iteration.
24
+ 3. Confirm the timing — first iteration succeeds, a later one fails — pointing at client reuse rather than a bad URL.
25
+
26
+ ## Resolution
27
+
28
+ - **Instantiate a fresh HTTP client per iteration (preferred):** add an `Assign` immediately before the download inside the loop so each iteration uses a clean client — `httpClient = New System.Net.Http.HttpClient()` (variable type `System.Net.Http.HttpClient`).
29
+ - **Force release after each download (alternative):** drag an `Invoke Code` block right after the download step to release the prior client's resources:
30
+ ```vbnet
31
+ GC.Collect()
32
+ GC.WaitForPendingFinalizers()
33
+ ```
34
+ - **General:** ensure each loop iteration owns its own request lifecycle (new client per item, or a properly scoped/disposed client) so no instance is asked to start a second request.
@@ -0,0 +1,29 @@
1
+ ---
2
+ confidence: medium
3
+ ---
4
+
5
+ # Download File from URL — Downloaded File Stuck as .tmp
6
+
7
+ ## Context
8
+
9
+ What this looks like:
10
+ - `Download File from URL` reports success, but a **downstream step fails** because the saved file is a temporary file — e.g. `document.xlsx.tmp` instead of `document.xlsx` — so `Read Range` / `Read CSV` / a path check on the real name can't find it.
11
+
12
+ What can cause it:
13
+ - **The download/finalize raced.** The activity streams the body to a `*.tmp` file and then renames it to the final name; when downstream activities run before the network stream is fully flushed and the file is finalized, the path is still the `.tmp`. A slow/large transfer or an eager next step makes the workflow "move too fast" for the file system.
14
+
15
+ What to look for:
16
+ - Whether the immediate next step references the **final** file name/extension, and whether it intermittently finds a `*.tmp` instead.
17
+ - Whether the failure is intermittent (timing-dependent) rather than every run.
18
+
19
+ ## Investigation
20
+
21
+ 1. Read the error from job evidence; confirm the download "succeeded" but a later step fails resolving the target file, and that a `*.tmp` artifact is involved.
22
+ 2. Read the `.xaml`: what consumes the downloaded file immediately after, and does it expect the final extension?
23
+ 3. Confirm the failure is timing-dependent (intermittent), the signature of a finalize race rather than a wrong path.
24
+
25
+ ## Resolution
26
+
27
+ - **Wrap the download in a Retry Scope (preferred):** put `Download File from URL` (or the consuming step) in a **Retry Scope** whose condition is a `File Exists` / `Path Exists` check on the **final** target path — i.e. validate the real extension is present and there is **no** `.tmp` — with a retry interval of ~5 seconds. This waits for the stream to finalize before proceeding.
28
+ - **Gate downstream steps on the final file:** before reading the file, poll `File Exists` for the exact target name (not `*.tmp`); only continue once the finalized file is present.
29
+ - **General:** never assume the file is ready the instant the activity returns — validate the finalized path/extension before consuming it.
@@ -0,0 +1,10 @@
1
+ # File Operations Activities Playbooks
2
+
3
+ **Overview:** [overview.md](./overview.md) — `UiPath.Activities.System.FileOperations` (System > File) activities in `UiPath.System.Activities`; `Download File from URL` execution model and common failure patterns
4
+
5
+ | Issue | Confidence | Description | Playbook |
6
+ |-------|:---:|-------------|----------|
7
+ | Download File from URL — "This instance has already started one or more requests" (in a loop) | Medium | `DownloadFileFromUrl` inside a `For Each` reuses/disposes its internal HTTP client across iterations. Fix: instantiate a fresh `System.Net.Http.HttpClient` per iteration, or force release with `GC.Collect()` / `GC.WaitForPendingFinalizers()` after the download | [download-file-httpclient-reused-in-loop.md](./playbooks/download-file-httpclient-reused-in-loop.md) |
8
+ | Download File from URL — HTTP 403 (Forbidden) / 401 (Unauthorized) | Medium | The server rejects the native download because it needs authentication / cookies / a browser session the activity doesn't carry (or a blocked `User-Agent`). Fix: set `UserAgentHeader` / authenticate, or download through a UI browser session (Click + Wait for Download) for portal-gated files | [download-file-403-401-auth.md](./playbooks/download-file-403-401-auth.md) |
9
+ | Download File from URL — file stuck as .tmp | Medium | The activity finishes but downstream steps fail because the saved file is left as `*.tmp` (the download/finalize raced). Fix: wrap in a Retry Scope with a File Exists check validating the real target extension (not `.tmp`) | [download-file-stuck-tmp.md](./playbooks/download-file-stuck-tmp.md) |
10
+ | Download File from URL — "Don't know about such a host" (DNS / firewall) | Medium | DNS cannot resolve the host, or an enterprise firewall / SSL-inspection proxy blocks the automated outbound connection. Fix: have the network team whitelist the endpoint for the robot/user-agent; verify connectivity from the robot host | [download-file-host-not-found.md](./playbooks/download-file-host-not-found.md) |
@@ -0,0 +1,36 @@
1
+ # Intelligent OCR / Document Understanding Investigation Guide
2
+
3
+ ## Data Correlation
4
+
5
+ Before using any fetched data, verify it matches the user's reported problem:
6
+
7
+ - **Activity** — the faulted activity is a classic DU activity (`UiPath.IntelligentOCR.Activities.DigitizeDocument`, `...ClassifyDocumentScope`, `...DataExtractionScope`, `...PresentValidationStation`, `...ExportExtractionResults`). Modern DU / IXP is a different surface.
8
+ - **Tenant / DU endpoint** — the tenant and DU endpoint/API key in evidence are the ones the user is asking about. A different tenant = different DU entitlement and a different storage layout.
9
+ - **Storage bucket / folder** — the bucket, blob path, and Orchestrator folder named in the error are the ones the workflow targets.
10
+ - **Document** — the document being processed is the one the user reports (matters for size-limit and validation-rejection cases).
11
+ - **Workflow file** — the error originates from the workflow the user references.
12
+ - **Timestamp** — the failure occurred in the reported window (load-bearing for a transient DU-server outage vs. a config problem).
13
+
14
+ If the data doesn't match: discard it.
15
+
16
+ ## Domain-Specific Data Gathering
17
+
18
+ 1. **Classify by exception type and message.**
19
+ - `DUApiException` → the **DU server / endpoint** rejected the HTTP call. Read the HTTP status and message: 401 license/API key, 403 page-units, 413 request size, 400 wrong endpoint/API key, signature-invalid, or the generic `DocumentUnderstanding server returned <code> ...`.
20
+ - `Failed to fetch Document Understanding projects list...` / `Couldn't retrieve a tenant key.` / `Information about tenant <id> couldn't be retrieved.` → **tenant not enabled / setup**: DU isn't enabled/licensed on the tenant, or tenant context couldn't be resolved.
21
+ - `No such bucket ...` / `Couldn't find path ...` / `Could not load the ... from storage bucket ...` / `The local directory path ... could not be found.` / `Could not find Orchestrator Folder ...` → **storage / taxonomy / folder** missing.
22
+ - `DocumentRejectedByUserException` → a **human rejected** the document at Validation Station (a business outcome, not a system fault).
23
+ 2. **For a `DUApiException`, the HTTP status is the discriminator.** The message text is fixed per status — match it (e.g. 401 → `Your license could not be validated...`). Capture `CF-RAY` and `AppId` from the exception for escalation; the `HttpResponseContent` carries the server's detail.
24
+ 3. **Separate license from connectivity.** 401/403 are entitlement/units; a generic `DocumentUnderstanding server returned 5xx ...` is a server-side/transient failure — check the window.
25
+ 4. **For storage errors, confirm what's missing and where.** The message names the bucket / blob path / folder — confirm it exists in the tenant/folder the robot runs in and that the robot account can read it.
26
+
27
+ ## Testing Prerequisites
28
+
29
+ > The invalid-API-key failure occurs on the OCR call itself; tenant-not-enabled / storage / document-rejected failures depend on the DU project / endpoint / storage / HITL setup. Diagnosis is evidence-based from the faulted job.
30
+
31
+ 1. **Activity identity** — which DU activity and its display name.
32
+ 2. **Exception type + message** — `DUApiException` (with HTTP status / `CF-RAY` / `AppId`) vs. tenant resource string vs. storage resource string vs. `DocumentRejectedByUserException`, verbatim.
33
+ 3. **DU endpoint / API key** — which endpoint the activity targets and whether the API key/license parameter is configured (do not expose the key).
34
+ 4. **Tenant entitlement** — whether Document Understanding is enabled/licensed on the tenant and has page units available.
35
+ 5. **Storage** — the bucket, blob path, and Orchestrator folder the workflow reads/writes, and whether they exist and are accessible to the robot account.
36
+ 6. **Package version** — `UiPath.IntelligentOCR.Activities` version.
@@ -0,0 +1,33 @@
1
+ # Intelligent OCR / Document Understanding (Classic) Activities
2
+
3
+ Activities from the `UiPath.IntelligentOCR.Activities` package — the **classic Document Understanding** framework: **Digitize Document** (`DigitizeDocument`), **Classify Document Scope** (`ClassifyDocumentScope`), **Data Extraction Scope** (`DataExtractionScope`), **Present Validation Station** (`PresentValidationStation`), **Export Extraction Results** (`ExportExtractionResults`), and the Train Classifiers/Extractors scopes. Taxonomies, classifiers, and extractors drive the digitize → classify → extract → validate → export pipeline.
4
+
5
+ ## How These Activities Work
6
+
7
+ The pipeline combines local config (taxonomy, classifier/extractor configuration) with calls to external services:
8
+
9
+ 1. **Tenant / project setup.** The activities resolve the Document Understanding tenant context (project list, tenant key). If DU isn't enabled/licensed on the tenant, this fails before any document is processed.
10
+ 2. **DU server calls.** Digitization (OCR) and ML extraction/classification call a Document Understanding server / endpoint over HTTP (`DUServerCaller`). The call is authenticated with an API key / license; failures here surface as `UiPath.SmartData.Utils.DocumentUnderstandingClient.DUApiException` carrying the HTTP status, response content, `CF-RAY`, and `AppId`.
11
+ 3. **Storage access.** Taxonomy, trained models, and validated extraction results are read from / written to Orchestrator storage buckets and folders. A missing bucket / blob path / folder fails the read.
12
+ 4. **Validation Station.** `Present Validation Station` shows a human the extracted data; the human can reject the document, which raises `DocumentRejectedByUserException`.
13
+
14
+ ## Key Activities
15
+
16
+ - **Digitize Document** (`UiPath.IntelligentOCR.Activities.DigitizeDocument`) — OCR + text/layout via a DU endpoint.
17
+ - **Classify Document Scope** (`ClassifyDocumentScope`) — classify the document type.
18
+ - **Data Extraction Scope** (`DataExtractionScope`) — extract fields via configured extractors.
19
+ - **Present Validation Station** (`PresentValidationStation`) — human-in-the-loop validation.
20
+ - **Export Extraction Results** (`ExportExtractionResults`) — emit results (e.g. DataSet).
21
+
22
+ ## Common Failure Patterns
23
+
24
+ - **License / endpoint rejected the call** — `DUApiException`: `Your license could not be validated...`, `Failed to consume the requested number of pages...`, `You have exceeded the request size limitations...`, `The service has rejected the request. Please make sure you are using the correct endpoint...`, `Response signature is invalid. Endpoint is not supported.`, or the generic `DocumentUnderstanding server returned <code> ...`. See [du-license-or-endpoint-rejected.md](./playbooks/du-license-or-endpoint-rejected.md).
25
+ - **DU not enabled / tenant key** — `Failed to fetch Document Understanding projects list. Please connect to a tenant that has Document Understanding enabled.`, `Couldn't retrieve a tenant key.`, `Information about tenant <id> couldn't be retrieved.`. See [du-not-enabled-or-tenant-key.md](./playbooks/du-not-enabled-or-tenant-key.md).
26
+ - **Storage bucket / taxonomy / folder missing** — `No such bucket named '<name>'`, `Couldn't find path <p> in bucket <b> associated with '<x>'`, `The local directory path '<path>' could not be found.`, `Could not load the <x> from storage bucket <b> and path <p>`, `Could not find Orchestrator Folder '<name>'`. See [du-storage-or-taxonomy-missing.md](./playbooks/du-storage-or-taxonomy-missing.md).
27
+ - **Document rejected at Validation Station** — `DocumentRejectedByUserException` (a human rejected the document). See [du-document-rejected.md](./playbooks/du-document-rejected.md).
28
+
29
+ > The **invalid-API-key** failure occurs on the OCR call itself; **tenant-not-enabled**, **storage/taxonomy**, and **document-rejected** failures depend on the DU project / endpoint / storage / HITL setup. Diagnosis is evidence-based from the faulted job's exception text + configuration.
30
+
31
+ ## Package
32
+
33
+ NuGet: `UiPath.IntelligentOCR.Activities` · Exceptions: `UiPath.SmartData.Utils.DocumentUnderstandingClient.DUApiException`, `UiPath.IntelligentOCR.Exceptions.DocumentRejectedByUserException`
@@ -0,0 +1,32 @@
1
+ ---
2
+ confidence: medium
3
+ ---
4
+
5
+ # Document Understanding — Document rejected at Validation Station
6
+
7
+ ## Context
8
+
9
+ `Present Validation Station` (or a Validate Classification/Extraction step) faults with `UiPath.IntelligentOCR.Exceptions.DocumentRejectedByUserException` because a human reviewer **rejected** the document instead of confirming it. This is a deliberate business outcome surfaced as an exception, not a system/configuration fault.
10
+
11
+ What this looks like:
12
+
13
+ - `UiPath.IntelligentOCR.Exceptions.DocumentRejectedByUserException` — raised when the validation action result is "rejected." The exception carries a `DocumentRejectionReason` (the reason the reviewer picked) and an `Attributes` dictionary; the message reflects the rejection.
14
+
15
+ What can cause it:
16
+ - **Reviewer rejected the document** — the human in Validation Station marked it rejected (e.g. wrong document type, illegible, not processable, out of scope) rather than confirming the extracted data.
17
+
18
+ What to look for:
19
+ - The exception **type is `DocumentRejectedByUserException`** — the pipeline worked; a person chose to reject. The fix is workflow handling of rejection, not a technical repair. Read `DocumentRejectionReason` to understand *why* it was rejected.
20
+
21
+ > **Different cause — do not apply this playbook:**
22
+ > - `DUApiException` / tenant / storage errors are technical failures upstream of human validation → use the [license/endpoint](./du-license-or-endpoint-rejected.md), [tenant](./du-not-enabled-or-tenant-key.md), or [storage](./du-storage-or-taxonomy-missing.md) playbooks.
23
+
24
+ ## Investigation
25
+
26
+ 1. **Confirm the exception type** is `DocumentRejectedByUserException` and read `DocumentRejectionReason` / `Attributes`.
27
+ 2. **Determine whether rejection is an expected path** for this process (some workflows route rejected documents to an exception queue / human follow-up) versus an unhandled fault.
28
+
29
+ ## Resolution
30
+
31
+ - **If rejection is a valid business outcome:** handle `DocumentRejectedByUserException` in the workflow — catch it and route the document to the rejection path (exception queue, notification, manual handling) instead of letting the job fault. Do not treat it as a technical bug. (Apply workflow changes only with explicit user approval.)
32
+ - **If the rejection was unexpected:** review the `DocumentRejectionReason` with the reviewer — the document content/type or the extraction quality drove the rejection; address the upstream data quality or document routing.
@@ -0,0 +1,63 @@
1
+ ---
2
+ confidence: medium
3
+ ---
4
+
5
+ # Document Understanding — License or endpoint rejected the call
6
+
7
+ ## Context
8
+
9
+ A DU activity (`Digitize Document`, `Data Extraction Scope`, `Classify Document Scope`) faults when its call to the Document Understanding OCR / server endpoint is rejected. There are **two distinct error shapes** depending on which DU client made the call — match the one you see:
10
+
11
+ **A. `Digitize Document` via the UiPath Document OCR engine** (the common case). The fault is a `System.AggregateException` (the OCR call runs async), and the inner message carries the DU OCR server's response verbatim. Signature for an invalid API key:
12
+
13
+ ```
14
+ System.AggregateException
15
+ Message: One or more errors occurred. (Request CorrelationId: <guid>
16
+ Request PredictionId: <id>
17
+ Server response: Invalid API key specified Error:UiPathOCRInvalidApiKey CF-RAY: <ray>. AppId: )
18
+ at UiPath.DocumentUnderstanding.Digitizer.Digitization.PageDigitizer.ApplyOcr(...)
19
+ at UiPath.IntelligentOCR.Activities.Digitization.DigitizeDocument.ExecuteAsync(...)
20
+ ```
21
+
22
+ The `Server response:` line + `Error:UiPathOCRInvalidApiKey` is the discriminator — the configured **UiPath Document OCR `ApiKey`** is wrong/expired/empty. Related OCR-engine server errors surface the same way (`Server response: <detail> Error:<code>`).
23
+
24
+ **B. `UiPath.SmartData.Utils.DocumentUnderstandingClient.DUApiException`** (SmartData/`DUServerCaller` client path — extraction/classification/tenant calls). Carries the HTTP status, response content, `CF-RAY`, `AppId`. Verbatim messages by status:
25
+
26
+ - `Your license could not be validated. Please make sure that the API key parameter is correctly configured.` (HTTP **401**) — the API key / license parameter is missing, wrong, or not valid for this endpoint.
27
+ - `Failed to consume the requested number of pages. Please check that your license key is valid and has enough units available.` (HTTP **403**) — the license is valid but out of page units / not entitled for the volume.
28
+ - `You have exceeded the request size limitations of the currently used plan.` (HTTP **413**) — the document/request is larger than the plan allows.
29
+ - `The service has rejected the request. Please make sure you are using the correct endpoint for the activity and that the API key parameter is correctly configured.` (HTTP **400**) — wrong endpoint for the activity, or a malformed/misconfigured API key.
30
+ - `Response signature is invalid. Endpoint is not supported.` — the endpoint responded but isn't a supported DU endpoint.
31
+ - `DocumentUnderstanding server returned <code> (<reason>). Additional details: <content>. CF-RAY: <cfray>. AppId: <appId>` — generic; any other non-success status (incl. 5xx — server-side / transient).
32
+ - `Failed to parse response.` — the server response couldn't be parsed (often downstream of one of the above).
33
+
34
+ What can cause it:
35
+ - **API key / license misconfigured** (401/400) — the key parameter is empty/wrong, or doesn't match the endpoint.
36
+ - **Out of units / not entitled** (403) — the license ran out of page units or lacks entitlement.
37
+ - **Request too large** (413) — document exceeds the plan's size limit.
38
+ - **Wrong / unsupported endpoint** (400 / signature-invalid) — the activity points at the wrong endpoint for its operation.
39
+ - **Server-side / transient** (5xx generic) — the DU service had a temporary failure.
40
+
41
+ What to look for:
42
+ - For **`Digitize Document`**, the fault is a `System.AggregateException` whose message contains `Server response: ... Error:<code>` — read that server response, not the generic `One or more errors occurred.` wrapper. `Error:UiPathOCRInvalidApiKey` = bad UiPath Document OCR `ApiKey`.
43
+ - For the **`DUApiException`** path, the connection reached the server; the **HTTP status + message** name the cause. Capture `CF-RAY` and `AppId` for escalation.
44
+
45
+ > **Different cause — do not apply this playbook:**
46
+ > - `Failed to fetch Document Understanding projects list...` / `Couldn't retrieve a tenant key.` → DU not enabled / tenant setup, before an endpoint call → use [du-not-enabled-or-tenant-key.md](./du-not-enabled-or-tenant-key.md).
47
+ > - `No such bucket ...` / `Could not load the ... from storage bucket ...` → storage/taxonomy access → use [du-storage-or-taxonomy-missing.md](./du-storage-or-taxonomy-missing.md).
48
+
49
+ ## Investigation
50
+
51
+ 1. **Identify the error shape.** `System.AggregateException` with `Server response: ... Error:<code>` from `PageDigitizer.ApplyOcr` → the UiPath Document OCR engine (Digitize). `DUApiException` with an HTTP status → the SmartData DU client. Read the inner `Server response:` / message, not the `AggregateException` wrapper.
52
+ 2. **Map the code/status to its cause** (`UiPathOCRInvalidApiKey` = bad OCR ApiKey; 401 license/key, 403 units, 413 size, 400 endpoint/key, signature-invalid, 5xx server).
53
+ 3. **For 401/400**, capture which endpoint and API-key parameter the activity is configured with (don't expose the key value).
54
+ 4. **For 5xx / generic**, check the failure window for a transient DU-service outage.
55
+
56
+ ## Resolution
57
+
58
+ - **If `Server response: Invalid API key specified Error:UiPathOCRInvalidApiKey` (Digitize / UiPath Document OCR):** set a valid **UiPath Document OCR `ApiKey`** (copy the tenant's Document Understanding API key from Automation Cloud → Licenses → Consumables → AI Units; re-enter it on the OCR engine). Store it as a secure asset/credential.
59
+ - **If 401 `Your license could not be validated...` (`DUApiException`):** correct the API key / license parameter for this endpoint (re-enter the key; confirm it's valid for the targeted DU endpoint).
60
+ - **If 403 `Failed to consume the requested number of pages...`:** top up / fix the license units, or confirm the tenant is entitled for the volume.
61
+ - **If 413 `You have exceeded the request size limitations...`:** reduce the document/request size (split the document, lower DPI/page count) or move to a plan that allows it.
62
+ - **If 400 `The service has rejected the request...` / `Response signature is invalid. Endpoint is not supported.`:** point the activity at the correct DU endpoint for its operation and verify the API key.
63
+ - **If generic 5xx `DocumentUnderstanding server returned ...`:** retry transient failures; if persistent, escalate to the DU service with the `CF-RAY` and `AppId`.
@@ -0,0 +1,38 @@
1
+ ---
2
+ confidence: medium
3
+ ---
4
+
5
+ # Document Understanding — Not enabled on tenant / tenant key
6
+
7
+ ## Context
8
+
9
+ A DU activity faults while resolving the Document Understanding tenant context — listing projects or retrieving the tenant key — before processing any document. The tenant either doesn't have DU enabled/licensed, or the tenant context couldn't be resolved.
10
+
11
+ What this looks like — verbatim:
12
+
13
+ - `Failed to fetch Document Understanding projects list. Please connect to a tenant that has Document Understanding enabled.` — the project list couldn't be retrieved; DU is not enabled/licensed on the connected tenant (or the robot is connected to the wrong tenant).
14
+ - `Couldn't retrieve a tenant key.` — the DU tenant key couldn't be obtained (auth/entitlement to DU not in place).
15
+ - `Information about tenant <id> couldn't be retrieved.` — tenant metadata lookup failed.
16
+
17
+ What can cause it:
18
+ - **DU not enabled / licensed on the tenant** — the tenant has no Document Understanding entitlement, so the project list / tenant key can't be resolved.
19
+ - **Wrong tenant** — the robot is connected to a tenant other than the one where DU is set up.
20
+ - **Auth / entitlement gap** — the running identity can't obtain the DU tenant key.
21
+
22
+ What to look for:
23
+ - These fire at **setup / tenant resolution**, not on a per-document endpoint call. There is no HTTP status / `DUApiException` here — it's a tenant-enablement problem, not a license-key-on-endpoint problem.
24
+
25
+ > **Different cause — do not apply this playbook:**
26
+ > - `DUApiException` with an HTTP status (401/403/400/...) → the tenant resolved and an **endpoint** call was rejected → use [du-license-or-endpoint-rejected.md](./du-license-or-endpoint-rejected.md).
27
+ > - `No such bucket ...` / `Could not find Orchestrator Folder ...` → storage/folder access → use [du-storage-or-taxonomy-missing.md](./du-storage-or-taxonomy-missing.md).
28
+
29
+ ## Investigation
30
+
31
+ 1. **Confirm the message** is the projects-list / tenant-key / tenant-info form (no HTTP status).
32
+ 2. **Identify the connected tenant** and confirm whether Document Understanding is enabled/licensed on it.
33
+ 3. **Confirm the robot is connected to the intended tenant** — not a different tenant that lacks DU.
34
+
35
+ ## Resolution
36
+
37
+ - **If `Failed to fetch Document Understanding projects list. Please connect to a tenant that has Document Understanding enabled.`:** enable / license Document Understanding on the tenant, or connect the robot to the tenant where DU is set up.
38
+ - **If `Couldn't retrieve a tenant key.` / `Information about tenant <id> couldn't be retrieved.`:** confirm DU entitlement and that the running identity can resolve the tenant context; re-check the tenant connection. Escalate to the DU/tenant admin if the entitlement is present but the key still can't be retrieved.
@@ -0,0 +1,44 @@
1
+ ---
2
+ confidence: medium
3
+ ---
4
+
5
+ # Document Understanding — Storage bucket / taxonomy / folder missing
6
+
7
+ ## Context
8
+
9
+ A DU activity faults reading or writing a storage location — a taxonomy, a trained model, or validated extraction results held in an Orchestrator storage bucket / folder, or a local directory. The named resource doesn't exist where the activity looked, or the robot can't access it.
10
+
11
+ What this looks like — verbatim:
12
+
13
+ - `No such bucket named '<name>'` — the configured storage bucket doesn't exist in the folder/tenant the robot runs in.
14
+ - `Couldn't find path <path> in bucket <bucket> associated with '<x>'` — the blob (taxonomy/model) isn't at that path in the bucket.
15
+ - `Could not load the <x> from storage bucket <bucket> and path <path>` — a validated-extraction / results blob couldn't be loaded from that bucket+path.
16
+ - `The local directory path '<path>' could not be found.` — a configured local directory doesn't exist on the robot host.
17
+ - `Could not find Orchestrator Folder '<name>'` — the Orchestrator folder the activity targets (e.g. for Action Center / storage) doesn't exist or isn't visible to the robot.
18
+
19
+ What can cause it:
20
+ - **Bucket / blob / folder doesn't exist** — never created, deleted, or created in a different folder/tenant.
21
+ - **Out of scope for the robot** — the bucket/folder exists but the robot account / the folder the process runs in can't see it.
22
+ - **Wrong path** — the blob path / local directory configured on the activity is wrong or relative to an unexpected root.
23
+ - **Pipeline gap** — an upstream step that should have produced the results blob didn't, so the load can't find it.
24
+
25
+ What to look for:
26
+ - The message names the exact bucket / path / folder — that is the missing resource. These are storage-access failures, not endpoint or tenant-enablement failures.
27
+
28
+ > **Different cause — do not apply this playbook:**
29
+ > - `DUApiException` (HTTP status) → the DU endpoint call → use [du-license-or-endpoint-rejected.md](./du-license-or-endpoint-rejected.md).
30
+ > - `Failed to fetch Document Understanding projects list...` / `Couldn't retrieve a tenant key.` → tenant not enabled → use [du-not-enabled-or-tenant-key.md](./du-not-enabled-or-tenant-key.md).
31
+
32
+ ## Investigation
33
+
34
+ 1. **Read the named resource** from the message — bucket, blob path, Orchestrator folder, or local directory.
35
+ 2. **Confirm it exists** in the tenant/folder the robot runs in (storage bucket / folder list), and that the robot account has read access.
36
+ 3. **For a results-load failure (`Could not load the ... from storage bucket ...`),** check whether the upstream step that should have written that blob actually ran and completed.
37
+ 4. **For a local-directory error,** confirm the path exists on the robot host (not just the dev machine).
38
+
39
+ ## Resolution
40
+
41
+ - **If `No such bucket named '<name>'`:** create / correct the storage bucket in the folder the process runs in, or point the activity at the right bucket; ensure the robot account can access it.
42
+ - **If `Couldn't find path ... in bucket ...` / `Could not load the ... from storage bucket ...`:** correct the blob path, upload the missing taxonomy/model, or fix the upstream step that should produce the results blob.
43
+ - **If `The local directory path '<path>' could not be found.`:** create / correct the local directory on the robot host (use an absolute path that exists there).
44
+ - **If `Could not find Orchestrator Folder '<name>'`:** correct the folder name, or create it / grant the robot account access to it.
@@ -0,0 +1,10 @@
1
+ # Intelligent OCR / Document Understanding (Classic) Activities Playbooks
2
+
3
+ **Investigation guide:** [investigation_guide.md](./investigation_guide.md) — data correlation rules and testing prerequisites for Intelligent OCR / Document Understanding Activities investigations
4
+
5
+ | Issue | Confidence | Description | Playbook |
6
+ |-------|:---:|-------------|----------|
7
+ | Document Understanding — License or Endpoint Rejected the Call | Medium | A DU activity's HTTP call to the Document Understanding server is rejected with `UiPath.SmartData.Utils.DocumentUnderstandingClient.DUApiException` (carries HTTP status, `CF-RAY`, `AppId`): `Your license could not be validated...` (401), `Failed to consume the requested number of pages...` (403), `You have exceeded the request size limitations...` (413), `The service has rejected the request. Please make sure you are using the correct endpoint...` (400), `Response signature is invalid. Endpoint is not supported.`, or generic `DocumentUnderstanding server returned <code> ...` (5xx). | [du-license-or-endpoint-rejected.md](./playbooks/du-license-or-endpoint-rejected.md) |
8
+ | Document Understanding — Not Enabled on Tenant / Tenant Key | Medium | A DU activity faults resolving the tenant context before processing: `Failed to fetch Document Understanding projects list. Please connect to a tenant that has Document Understanding enabled.`, `Couldn't retrieve a tenant key.`, or `Information about tenant <id> couldn't be retrieved.`. DU isn't enabled/licensed on the connected tenant, or the robot is on the wrong tenant. | [du-not-enabled-or-tenant-key.md](./playbooks/du-not-enabled-or-tenant-key.md) |
9
+ | Document Understanding — Storage Bucket / Taxonomy / Folder Missing | Medium | A DU activity can't read/write a storage location: `No such bucket named '<name>'`, `Couldn't find path <p> in bucket <b> associated with '<x>'`, `Could not load the <x> from storage bucket <b> and path <p>`, `The local directory path '<path>' could not be found.`, or `Could not find Orchestrator Folder '<name>'`. The taxonomy/model/results blob, bucket, folder, or local directory doesn't exist where the activity looked or isn't accessible to the robot. | [du-storage-or-taxonomy-missing.md](./playbooks/du-storage-or-taxonomy-missing.md) |
10
+ | Document Understanding — Document Rejected at Validation Station | Medium | `Present Validation Station` faults with `UiPath.IntelligentOCR.Exceptions.DocumentRejectedByUserException` because a human reviewer rejected the document (carries `DocumentRejectionReason` + `Attributes`). A business outcome surfaced as an exception — handle the rejection path in the workflow, not a technical repair. | [du-document-rejected.md](./playbooks/du-document-rejected.md) |
@@ -0,0 +1,34 @@
1
+ # IPC Activities Investigation Guide
2
+
3
+ ## Data Correlation
4
+
5
+ Before using any fetched data, verify it matches the user's reported problem:
6
+
7
+ - **Activity** — the faulted activity's namespace and class match the reported failure (`UiPath.IPC.Activities.BroadcastMessage`, `UiPath.IPC.Activities.SendMessage`). The activity is the discriminator, **not** the exception FQN: `System.TimeoutException` and `System.UnauthorizedAccessException` are generic framework types — routing to this package depends on the faulted-activity label (`[Broadcast Message]`) and a `UiPath.IPC.Activities.*` stack frame, not on the `System.*` prefix.
8
+ - **Exception class** — `System.TimeoutException` and `System.UnauthorizedAccessException` are distinct root causes with distinct fixes; do not apply one's cause to the other. `TimeoutException` = no receiver found on the channel in time (a **timing / channel-name** problem); `UnauthorizedAccessException` = the named-pipe endpoint denied the connection (a **session / user / elevation boundary** problem).
9
+ - **Channel** — the `Channel` string in evidence matches the channel the user is asking about, and is compared **case-sensitively** against the receiver's channel. A sender and receiver on different channel names are effectively unrelated even when both look healthy.
10
+ - **Sender / receiver pairing** — IPC always involves two sides. Confirm which process holds the `Broadcast Message` / `Send Message` (the faulted side) and which holds the `Message Receiver Trigger`. A fault on the sender with no corresponding running receiver is the core signal for the timeout case.
11
+ - **Robot / machine / session identity** — the sender and receiver run on the **same robot, same Windows user, same session, same machine**. Evidence showing the two processes on different hosts, different robot accounts, different user sessions, or different elevation levels is the core signal for the unauthorized-access case — not transferable "healthy" data from a co-located pair.
12
+ - **Package version** — the `UiPath.IPC.Activities` version in each project's `project.json`. A protocol/version mismatch between sender and receiver is a distinct cause from timeout/access-denied.
13
+ - **Timestamp** — the failure occurred during the time window the user reported, and the receiver process was (or was not) alive at the broadcast instant. Load-bearing for the timeout case — a receiver that started a second too late reproduces only with the same timing.
14
+
15
+ If the data doesn't match: **discard it**. Do NOT use unrelated data as a proxy. Report the mismatch and ask for clarification.
16
+
17
+ ## What to Capture
18
+
19
+ 1. **Workflow source** — read the `Broadcast Message` / `Send Message` node from the `.xaml` to capture the literal `Channel` expression, the `Timeout` value, and the `Message` payload type. Property-panel summaries truncate; the XAML is authoritative.
20
+ 2. **Receiver existence + channel** — whether a `Message Receiver Trigger` process exists, its exact `Channel` string, and whether it was **running in parallel** and past its listener-initialization at the broadcast instant.
21
+ 3. **Launch ordering** — how and when the receiver process is started relative to the broadcast (e.g. a `Run Parallel Process` / background job launched **before** the sender broadcasts, vs launched after / not at all).
22
+ 4. **Session / user / elevation** — the Windows session, user account, and elevation level of **both** the sender and receiver processes. Attended user session vs unattended Session 0, two different robot accounts, or one elevated + one not are the access-denied signals.
23
+ 5. **Timeout value** — the literal `Timeout` (ms). `0` drops silently with no exception; a low value can expire before a legitimately-launched receiver finishes initializing.
24
+ 6. **Package version** — `UiPath.IPC.Activities` version in both the sender and receiver `project.json`, compared against each other.
25
+
26
+ ## Testing Prerequisites
27
+
28
+ When testing hypotheses for `Broadcast Message` / `Send Message` issues, gather and verify these before drawing conclusions:
29
+
30
+ 1. **Activity identity** — confirm the faulted activity is `UiPath.IPC.Activities.BroadcastMessage` / `SendMessage` and the exception class (`TimeoutException` vs `UnauthorizedAccessException`) from the job error / logs.
31
+ 2. **Receiver state** — whether a Message Receiver Trigger on the **exact same channel** was alive and listening in parallel at the broadcast instant. The user (or someone with desktop/robot access) must confirm; it cannot be inferred from the sender's log alone.
32
+ 3. **Channel match** — the sender's `Channel` string character-for-character (case-sensitive) against the receiver's. A silent mismatch presents identically to "no receiver".
33
+ 4. **Session/user/elevation parity** — for an access-denied fault, whether both processes run under the same session, user, and elevation. This is a host-level fact, not visible in job logs.
34
+ 5. **Timeout adequacy** — the configured `Timeout` versus how long the receiver takes to come up; `0` means silent-drop, low values race the receiver's startup.
@@ -0,0 +1,35 @@
1
+ # IPC Activities
2
+
3
+ Activities from the `UiPath.IPC.Activities` package for **inter-process communication** between UiPath processes running at the same time. One process broadcasts or sends a message on a named **channel**; another process, running a **Message Receiver Trigger** on the same channel, receives it. The transport is a local **named pipe** — communication is confined to the **same robot, same Windows user, same session, same machine**. It is not a network / cross-machine / cross-user bus.
4
+
5
+ Do NOT confuse this package with the internal `UiPath.Ipc` / `UiPath.CoreIpc` transport that Integration Service connector activities use under the hood (`RemoteException`, `DAP-*` codes) — that is a different concern documented under Integration Service.
6
+
7
+ ## How Broadcast Message Executes
8
+
9
+ `Broadcast Message` (`UiPath.IPC.Activities.BroadcastMessage`) publishes a message to every active listener on a channel. Behaviour chain:
10
+
11
+ 1. Open / connect to the local named-pipe endpoint for the configured `Channel` string.
12
+ 2. Search for an active **Message Receiver Trigger** listening on that exact channel, up to the `Timeout` (milliseconds).
13
+ 3. Deliver the `Message` payload to the receiver(s) found.
14
+
15
+ Failures originate at distinct layers — **no receiver found within the timeout** (step 2, `System.TimeoutException`), **the pipe / session boundary denies the connection** (step 1, `System.UnauthorizedAccessException`), a **channel-string mismatch** (the receiver is up but on a different channel name — surfaces as a timeout, or silently drops when `Timeout = 0`), or a **package-version mismatch** between sender and receiver (protocol incompatibility). Knowing which layer produced the error narrows the investigation.
16
+
17
+ ## Key Activities
18
+
19
+ - **Broadcast Message** (`BroadcastMessage`, display name "Broadcast Message") — publish a `Message` to all listeners on `Channel`, waiting up to `Timeout` ms for a receiver. Key properties: `Channel` (exact, case-sensitive string), `Message` (payload), `Timeout` (Int32 ms — `0` = drop immediately if no receiver, no exception).
20
+ - **Send Message** (`SendMessage`, display name "Send Message") — send a `Message` to a single receiver on `Channel`, optionally awaiting a response. Same channel / timeout / session model as Broadcast Message.
21
+ - **Message Receiver Trigger** (`MessageReceiverTrigger`, display name "Message Receiver Trigger") — the listener side. Runs in the receiver process and fires when a message arrives on its `Channel`. Must be **running in parallel** before the sender broadcasts.
22
+ - **Get Messages** (`GetMessages`) — retrieve queued messages received on a channel.
23
+
24
+ ## Common Failure Patterns
25
+
26
+ - **`System.TimeoutException` — no channel / receiver found** — `Broadcast Message` (or `Send Message`) faults with `Timeout of <N> ms has passed and no channel was found to send the message to.`. The activity searched for a live Message Receiver Trigger on the channel but the timeout expired first. Causes: the receiver process was **not running in parallel** (not launched, launched too late, still initializing its listener loop, or already exited), the **channel string does not match** (case-sensitive) between sender and receiver, or the `Timeout` is set **too low** for the receiver to come up. See [broadcast-message-timeout.md](./playbooks/broadcast-message-timeout.md).
27
+ - **`System.UnauthorizedAccessException` — pipe / session boundary denies the connection** — `Broadcast Message` faults with `Access to the path is denied.` / a named-pipe access-denied while opening the channel endpoint. IPC is confined to the same robot, user, and session; the named-pipe ACL rejects a peer in a **different Windows user session**, under a **different user account**, or at a **different elevation level** (one process elevated / "Run as administrator", the other not). Causes: sender and receiver split across sessions (e.g. attended user session vs unattended Session 0), different robot accounts, or an elevation mismatch. See [broadcast-message-unauthorized-access.md](./playbooks/broadcast-message-unauthorized-access.md).
28
+ - **Messages silently dropped (`Timeout = 0`)** — no exception, but the receiver never gets the message because `Timeout` is `0` and no listener was active at the instant of the broadcast. Trace the receiver's actual receipt, not just the absence of an exception on the sender.
29
+ - **Package-version mismatch** — sender and receiver reference **different `UiPath.IPC.Activities` versions**, so the wire protocol is incompatible even when the channel and session match. Align the package version in both projects (Manage Packages → same version).
30
+
31
+ ## Package
32
+
33
+ NuGet: `UiPath.IPC.Activities`
34
+
35
+ Version-specific behaviour is documented in the relevant playbooks.
@@ -0,0 +1,38 @@
1
+ ---
2
+ confidence: medium
3
+ ---
4
+
5
+ # Broadcast Message — System.TimeoutException (No Channel / Receiver Found)
6
+
7
+ ## Context
8
+
9
+ What this looks like:
10
+ - Activity `Broadcast Message` / `Send Message` (`UiPath.IPC.Activities.BroadcastMessage` / `SendMessage`) faults with `System.TimeoutException`
11
+ - Message: `Timeout of <N> ms has passed and no channel was found to send the message to.`
12
+ - May be intermittent — succeeds when the receiver is up in time, faults when it is not
13
+
14
+ What can cause it:
15
+ - The activity searches for an active **Message Receiver Trigger** listening on the configured `Channel`, up to `Timeout` (ms). The timeout expired before a live receiver was found. Root causes:
16
+ - **Receiver not running in parallel** — the receiver process was not launched, was launched *after* the broadcast, was still initializing its listener loop, or had already exited when the sender broadcast.
17
+ - **Channel-string mismatch** — the receiver is up, but its `Channel` does not match the sender's **exactly** (the comparison is case-sensitive). To the sender this is indistinguishable from "no receiver".
18
+ - **`Timeout` too low** — the receiver comes up legitimately but slower than the configured window, so the search expires first.
19
+
20
+ What to look for:
21
+ - Whether a Message Receiver Trigger process on the **same channel** was alive and past initialization at the broadcast instant.
22
+ - The sender's `Channel` string vs the receiver's, character-for-character (case-sensitive).
23
+ - The launch ordering — is the receiver started **before** the broadcast?
24
+
25
+ ## Investigation
26
+
27
+ 1. Confirm the faulted activity is `Broadcast Message` / `Send Message` and the exception is `System.TimeoutException` with the `no channel was found` message; capture `<N>` (the configured `Timeout`).
28
+ 2. Read the sender `.xaml` for the literal `Channel` string and `Timeout` value.
29
+ 3. Ask the user (or someone with robot access) whether the receiver process (Message Receiver Trigger) was running in parallel on the **exact same channel** at the broadcast time, and how/when it is launched relative to the sender.
30
+
31
+ ## Resolution
32
+
33
+ - **Launch the receiver in parallel first** — start the Message Receiver Trigger process **before** the sender broadcasts, e.g. via a `Run Parallel Process` activity or a background job, and confirm its listener is initialized. IPC requires the receiver to be actively listening at the moment of the broadcast.
34
+ - **Match the channel string exactly** — verify both sides use the identical, case-sensitive `Channel` value (prefer a shared config asset / constant over hand-typed literals to avoid `OrderBus` vs `orderbus` drift).
35
+ - **Raise the `Timeout`** — set `Timeout` to at least **5000–10000 ms** so the receiver has time to initialize its listener loop before the search expires. Do not set it too low. (`Timeout = 0` drops the message immediately with **no** exception — a different, silent failure mode.)
36
+ - **Wrap in Try Catch** — if a receiver may legitimately be absent, wrap `Broadcast Message` in a Try Catch to handle the `TimeoutException` gracefully rather than faulting the job.
37
+
38
+ > Related: a receiver that IS up on the same channel but the pipe endpoint denies the connection (different session / user / elevation) throws `System.UnauthorizedAccessException`, not a timeout → [broadcast-message-unauthorized-access.md](./broadcast-message-unauthorized-access.md).
@@ -0,0 +1,38 @@
1
+ ---
2
+ confidence: medium
3
+ ---
4
+
5
+ # Broadcast Message — System.UnauthorizedAccessException (Pipe / Session Boundary)
6
+
7
+ ## Context
8
+
9
+ What this looks like:
10
+ - Activity `Broadcast Message` / `Send Message` (`UiPath.IPC.Activities.BroadcastMessage` / `SendMessage`) faults with `System.UnauthorizedAccessException`
11
+ - Message: `Access to the path is denied.` (or a named-pipe access-denied while opening the channel endpoint)
12
+ - Often reproduces **consistently** for a given deployment topology (unlike the timing-dependent timeout case)
13
+
14
+ What can cause it:
15
+ - IPC runs over a **local named pipe** confined to the **same robot, same Windows user, same session, same machine**. The pipe's ACL rejects a peer that lives across a boundary:
16
+ - **Different Windows user session** — sender and receiver split across sessions (e.g. an attended user session on one side, an unattended **Session 0** robot on the other).
17
+ - **Different user account** — the two processes run under different robot / Windows accounts, so neither can open the other's session-scoped pipe.
18
+ - **Elevation mismatch** — one process runs **elevated** ("Run as administrator" / high integrity) and the other does not; the integrity-level boundary denies the connection.
19
+
20
+ What to look for:
21
+ - The Windows session, user account, and elevation level of **both** the sender and receiver processes.
22
+ - Whether the deployment split the two processes across attended vs unattended, or across two robot accounts.
23
+ - That this is a boundary/permission fault, not a timing fault — the receiver may be perfectly alive on the right channel.
24
+
25
+ ## Investigation
26
+
27
+ 1. Confirm the faulted activity is `Broadcast Message` / `Send Message` and the exception is `System.UnauthorizedAccessException` (access-denied on the channel endpoint) — not `TimeoutException`.
28
+ 2. Establish where the receiver process runs: which robot / Windows user, which session, and at what elevation, versus the sender.
29
+ 3. Ask the user (or someone with robot/host access) to confirm both processes are intended to run on the **same** robot, user, session, and elevation — this is a host-level fact not visible in the sender's job log.
30
+
31
+ ## Resolution
32
+
33
+ - **Co-locate both processes** — run the sender and receiver on the **same robot, same Windows user, same session, same machine**. `UiPath.IPC.Activities` does **not** support communication across machines or across Windows user sessions.
34
+ - **Match elevation** — ensure both processes run at the **same integrity level**: either both elevated or both non-elevated. A single elevated peer will be denied by the other's pipe ACL.
35
+ - **Align the robot account** — if the two processes run under different robot accounts, reconfigure so they execute under the **same** account in the same session (e.g. both as the same unattended robot, launched via `Run Parallel Process` so they share the session).
36
+ - **Do not treat as a timeout** — raising `Timeout` will not fix an access-denied fault; the connection is refused at the pipe, not lost to timing.
37
+
38
+ > Related: a receiver that is simply absent / on a mismatched channel / not up in time throws `System.TimeoutException` instead → [broadcast-message-timeout.md](./broadcast-message-timeout.md).
@@ -0,0 +1,9 @@
1
+ # IPC Activities Presentation Rules
2
+
3
+ - **Activities** — use the display name (e.g., "Broadcast Message", "Send Message", "Message Receiver Trigger"), not the fully qualified class name (e.g., `UiPath.IPC.Activities.BroadcastMessage`)
4
+ - **Channels** — quote the `Channel` string exactly as configured, in backticks, and flag case sensitivity when a mismatch is suspected (e.g. "sender channel `OrderBus` vs receiver channel `orderbus`")
5
+ - **Sender / receiver** — always name which side you mean: the **sender** (the process holding `Broadcast Message` / `Send Message`) and the **receiver** (the process holding the `Message Receiver Trigger`). Never say just "the process" when both are in play
6
+ - **Exceptions** — quote the exact exception class and message together (e.g. "`System.TimeoutException`: `Timeout of 3000 ms has passed and no channel was found to send the message to.`"), and state which layer it maps to (no-receiver-in-time vs pipe-ACL-denied)
7
+ - **Timeout** — refer to the `Timeout` property in milliseconds and state the practical floor (5000–10000 ms) when recommending a raise; call out `Timeout = 0` explicitly as the silent-drop setting
8
+ - **Run surface** — name the session/user in the user's terms (e.g. "attended user session", "unattended robot (Session 0)", "elevated / Run as administrator") so the user can check the boundary, not internal runtime flags
9
+ - **Launch mechanism** — name the concrete mechanism the user configures (e.g. "`Run Parallel Process`", "a background job started before the broadcast"), not an abstract "run it in parallel"
@@ -0,0 +1,9 @@
1
+ # IPC Activities Playbooks
2
+
3
+ **Overview:** [overview.md](./overview.md) — `UiPath.IPC.Activities` package, channel / named-pipe execution model, and common failure patterns
4
+ **Investigation guide:** [investigation_guide.md](./investigation_guide.md) — data correlation rules and testing prerequisites for IPC Activities investigations
5
+
6
+ | Issue | Confidence | Description | Playbook |
7
+ |-------|:---:|-------------|----------|
8
+ | Broadcast Message — `System.TimeoutException` (no channel / receiver found) | Medium | `Broadcast Message` / `Send Message` faults with `Timeout of <N> ms has passed and no channel was found to send the message to.` — no live Message Receiver Trigger was found on the channel before the `Timeout` expired. Causes: the receiver process was not running in parallel (not launched, launched too late, still initializing, or exited), the `Channel` string does not match (case-sensitive) between sender and receiver, or `Timeout` is too low for the receiver to come up. Fix: launch the receiver in parallel first, match the channel string exactly, raise `Timeout` (5000–10000 ms) | [broadcast-message-timeout.md](./playbooks/broadcast-message-timeout.md) |
9
+ | Broadcast Message — `System.UnauthorizedAccessException` (pipe / session boundary) | Medium | `Broadcast Message` / `Send Message` faults with `Access to the path is denied.` / a named-pipe access-denied on the channel endpoint. IPC is confined to the same robot, user, and session; the pipe ACL rejects a peer in a different Windows user session, under a different user account, or at a different elevation level (one process elevated, the other not). Fix: run both processes on the same robot / user / session / elevation | [broadcast-message-unauthorized-access.md](./playbooks/broadcast-message-unauthorized-access.md) |
@@ -0,0 +1,31 @@
1
+ # Jira Activities Investigation Guide
2
+
3
+ ## Data Correlation
4
+
5
+ Before using any fetched data, verify it matches the user's reported problem:
6
+
7
+ - **Activity** — the faulted activity's namespace and class match the reported failure (e.g., `UiPath.Jira.Activities.JiraApplicationScope` / "Jira Scope", or a child activity like "Get Issue" / "Search Issues"). A fault **at scope open** (authentication) and a fault **on a child activity** (a bad response, a failed query) are different code paths — treat them as different.
8
+ - **Error string** — `Authentication information is invalid`, `Response was not recognized as JSON`, an HTTP `5xx`, and `This activity is either missing or could not be loaded properly` map to different playbooks. Read the literal message, not a paraphrase.
9
+ - **Jira instance identity** — the `Server URL` in the workflow matches the instance the user reports, and whether it is Jira **Cloud** (`https://<domain>.atlassian.net`) or an on-premises **Server / Data Center** host. The classic pack targets Cloud; the deployment type is load-bearing for the not-JSON / `500` family.
10
+ - **Authentication configuration** — the `Authentication Type` (`Api Token` / `Basic` / `OAuth 2.0`) and which credential properties are populated. A credential rejection is interpreted differently depending on which auth mode is configured and whether stray properties from another mode are still set.
11
+ - **Account / org policy** — whether the Atlassian org enforces MFA/SSO. Load-bearing for the password-vs-API-token sub-case: basic password auth fails under enforced MFA even with correct credentials.
12
+ - **Package + project dependencies** — the `UiPath.Jira.Activities` version from `project.json` and the other packages in the project (anything that also pins **RestSharp** or other shared transitive libraries). Load-bearing for the activity-load family.
13
+ - **Timestamp** — the failure occurred during the time window the user reported.
14
+
15
+ If the data doesn't match: **discard it**. Do NOT use unrelated data as a proxy. Report the mismatch and ask for clarification.
16
+
17
+ ## Testing Prerequisites
18
+
19
+ When testing hypotheses for `Jira Scope` failures, gather and verify these before drawing conclusions:
20
+
21
+ 1. **Activity identity** — confirm the faulted activity (`Jira Scope` vs a specific child) and the exact error string. Scope-open authentication faults, child-activity response faults, and activity-load faults are different families.
22
+ 2. **Scope configuration** — from the `.xaml`, capture `Server URL`, `Authentication Type`, `Username`, and which credential properties (`Api Token`, `Password`, `Client Id`, `Client Secret`) are set. Note the **data type** bound to `Api Token` / `Password` (must be `SecureString`, not `String`).
23
+ 3. **Username format** — whether `Username` is the account **email** (Cloud requirement) or an alphanumeric `accountId`.
24
+ 4. **Server URL shape** — whether `Server URL` is the bare root instance (`https://<domain>.atlassian.net`) or has a path appended (`/secure/Dashboard.jspa`, a project key, a `/browse/...` link).
25
+ 5. **Deployment type** — Jira Cloud vs on-premises Server / Data Center. Not always in the job log; the `Server URL` host and the user confirm it.
26
+ 6. **Org auth policy** — whether MFA/SSO is enforced for the account. Determines whether basic password auth can ever succeed. Confirmed by the user / Atlassian org admin, not the job log.
27
+ 7. **Project dependency set** — `UiPath.Jira.Activities` version and any sibling package that pins a conflicting **RestSharp** (or other shared assembly). Read from `project.json` and, when available, the build/restore log.
28
+
29
+ ### Out-of-band confirmation
30
+
31
+ Two deciding proofs for Jira causes live outside the job log: whether the Atlassian org **enforces MFA/SSO** (org admin / Atlassian account settings), and whether a freshly generated **API token** authenticates the same `Server URL` (the user regenerates a token at *Atlassian Account → Security → API tokens* and retries). Record these as out-of-band confirmation steps — they do not block a hypothesis when no alternative cause is better supported, but they are how the user closes the case.