@uipath/skills 1.201.0-preview.621 → 1.202.0-preview.635
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.
- package/.claude-plugin/marketplace.json +1 -1
- package/.claude-plugin/plugin.json +1 -1
- package/.cursor-plugin/plugin.json +1 -1
- package/CODEOWNERS +41 -29
- package/README.md +1 -0
- package/assets/skill-status.json +13 -2
- package/assets/uip-catalog-snapshot.json +95 -46
- package/package.json +2 -1
- package/skills/uipath-admin/SKILL.md +107 -197
- package/skills/uipath-admin/references/audit-commands.md +69 -120
- package/skills/uipath-admin/references/audit-workflow-guide.md +101 -152
- package/skills/uipath-admin/references/authorization/authorization-commands.md +121 -210
- package/skills/uipath-admin/references/authorization/check-access.md +39 -63
- package/skills/uipath-admin/references/authorization/grant-permissions.md +38 -49
- package/skills/uipath-admin/references/authorization/permission-catalog.md +32 -34
- package/skills/uipath-admin/references/authorization/role-assignment-management.md +96 -99
- package/skills/uipath-admin/references/authorization/role-management.md +113 -142
- package/skills/uipath-admin/references/diagnose/CAPABILITY.md +13 -14
- package/skills/uipath-admin/references/diagnose/{references/failure-modes.md → failure-modes.md} +90 -46
- package/skills/uipath-admin/references/diagnose/{references/troubleshooting-guide.md → troubleshooting-guide.md} +21 -14
- package/skills/uipath-admin/references/external-app-management.md +42 -39
- package/skills/uipath-admin/references/identity-commands.md +72 -625
- package/skills/uipath-admin/references/identity-troubleshoot-guide.md +73 -95
- package/skills/uipath-admin/references/ip-restriction/bypass-rule-management.md +25 -54
- package/skills/uipath-admin/references/ip-restriction/enforcement-management.md +19 -31
- package/skills/uipath-admin/references/ip-restriction/ip-range-management.md +48 -45
- package/skills/uipath-admin/references/ip-restriction/ip-restriction-commands.md +89 -146
- package/skills/uipath-admin/references/key-concepts.md +24 -0
- package/skills/uipath-admin/references/organization-management.md +49 -70
- package/skills/uipath-admin/references/organizations-commands.md +39 -74
- package/skills/uipath-admin/references/pat-management.md +25 -38
- package/skills/uipath-admin/references/robot-account-management.md +16 -14
- package/skills/uipath-admin/references/smtp-management.md +19 -14
- package/skills/uipath-admin/references/tenant-management.md +1 -1
- package/skills/uipath-admin/references/tenants-commands.md +82 -148
- package/skills/uipath-admin/references/user-management.md +70 -56
- package/skills/uipath-agents/SKILL.md +4 -3
- package/skills/uipath-agents/references/authentication.md +4 -3
- package/skills/uipath-agents/references/coded/capabilities/datafabric.md +465 -0
- package/skills/uipath-agents/references/coded/capabilities/guardrails/guardrails-recommend.md +5 -0
- package/skills/uipath-agents/references/coded/capabilities/guardrails/guardrails.md +2 -0
- package/skills/uipath-agents/references/coded/capabilities/human-in-the-loop.md +12 -6
- package/skills/uipath-agents/references/coded/flow-integration.md +2 -2
- package/skills/uipath-agents/references/coded/frameworks/langgraph-integration.md +48 -16
- package/skills/uipath-agents/references/coded/frameworks/openai-agents-integration.md +1 -1
- package/skills/uipath-agents/references/coded/lifecycle/deployment.md +11 -1
- package/skills/uipath-agents/references/coded/quickstart.md +11 -8
- package/skills/uipath-agents/references/lowcode/capabilities/inline-in-flow/inline-in-flow.md +3 -3
- package/skills/uipath-agents/references/lowcode/capabilities/memory/memory.md +19 -2
- package/skills/uipath-agents/references/lowcode/evaluations/evaluate.md +2 -2
- package/skills/uipath-agents/references/lowcode/evaluations/orchestrator-eval-run.md +409 -155
- package/skills/uipath-agents/references/lowcode/evaluations/running-evaluations.md +2 -2
- package/skills/uipath-agents/references/lowcode/prompting/autonomous-agent-prompting-guide.md +1 -1
- package/skills/uipath-aops/SKILL.md +313 -0
- package/skills/uipath-aops/assets/templates/pipeline-dto-template.json +15 -0
- package/skills/uipath-aops/references/discovery-flow.md +312 -0
- package/skills/uipath-aops/references/migration-guide.md +146 -0
- package/skills/uipath-aops/references/pipeline-dto-guide.md +276 -0
- package/skills/uipath-aops/references/save-and-run-guide.md +156 -0
- package/skills/uipath-api-workflow/SKILL.md +48 -6
- package/skills/uipath-api-workflow/assets/templates/file-base64-roundtrip-example.json +154 -0
- package/skills/uipath-api-workflow/assets/templates/nested-control-flow-example.json +0 -1
- package/skills/uipath-api-workflow/references/cli-reference.md +20 -1
- package/skills/uipath-api-workflow/references/expressions-and-context.md +19 -0
- package/skills/uipath-api-workflow/references/files-and-base64.md +153 -0
- package/skills/uipath-api-workflow/references/operating-published-workflows.md +3 -2
- package/skills/uipath-api-workflow/references/task-types.md +89 -3
- package/skills/uipath-api-workflow/references/testing-and-evals.md +224 -0
- package/skills/uipath-api-workflow/references/troubleshooting.md +124 -4
- package/skills/uipath-coded-apps/SKILL.md +4 -2
- package/skills/uipath-coded-apps/assets/scripts/dashboards/build-dashboard.mjs +1 -1
- package/skills/uipath-coded-apps/references/dashboards/CAPABILITY.md +11 -1
- package/skills/uipath-coded-apps/references/dashboards/plugins/build/impl.md +5 -3
- package/skills/uipath-coded-apps/references/dashboards/plugins/deploy/impl.md +1 -0
- package/skills/uipath-coded-apps/references/oauth-client-setup.md +2 -0
- package/skills/uipath-coded-apps/references/pack-publish-deploy.md +18 -0
- package/skills/uipath-coded-apps/references/sdk/orchestrator.md +4 -0
- package/skills/uipath-connector-builder/SKILL.md +7 -5
- package/skills/uipath-connector-builder/references/debugging.md +5 -1
- package/skills/uipath-connector-builder/references/element-json.md +3 -1
- package/skills/uipath-connector-builder/references/standard-resources.md +37 -6
- package/skills/uipath-functions/SKILL.md +134 -222
- package/skills/uipath-functions/references/js/authoring-guide.md +141 -0
- package/skills/uipath-functions/references/js/bindings-guide.md +120 -0
- package/skills/uipath-functions/references/js/calling-uipath-apis-guide.md +112 -0
- package/skills/uipath-functions/references/js/coded-app-wiring-guide.md +103 -0
- package/skills/uipath-functions/references/js/deployment-guide.md +109 -0
- package/skills/uipath-functions/references/js/http-semantics-guide.md +80 -0
- package/skills/uipath-functions/references/js/job-mode-guide.md +114 -0
- package/skills/uipath-functions/references/js/local-dev-guide.md +107 -0
- package/skills/uipath-functions/references/python/workflow-guide.md +224 -0
- package/skills/uipath-governance/SKILL.md +9 -8
- package/skills/uipath-governance/references/compliance-pack/catalog/impl.md +36 -8
- package/skills/uipath-governance/references/compliance-pack/coverage/impl.md +14 -12
- package/skills/uipath-governance/references/compliance-pack/disable/impl.md +5 -3
- package/skills/uipath-governance/references/compliance-pack/full-apply/impl.md +7 -5
- package/skills/uipath-governance/references/compliance-pack/partial-apply/impl.md +14 -7
- package/skills/uipath-governance/references/compliance-pack/partial-apply/planning.md +3 -1
- package/skills/uipath-governance/references/compliance-pack/preview-gate.md +1 -1
- package/skills/uipath-governance/references/compliance-pack/query/impl.md +4 -2
- package/skills/uipath-governance/references/diagnose/CAPABILITY.md +12 -12
- package/skills/uipath-governance/references/diagnose/{references/failure-modes.md → failure-modes.md} +5 -5
- package/skills/uipath-governance/references/diagnose/{references/troubleshooting-guide.md → troubleshooting-guide.md} +2 -2
- package/skills/uipath-governance/references/disambiguation-guide.md +15 -7
- package/skills/uipath-human-in-the-loop/SKILL.md +107 -9
- package/skills/uipath-human-in-the-loop/references/hitl-casetask-action.md +413 -0
- package/skills/uipath-insights/SKILL.md +21 -14
- package/skills/uipath-insights/references/alerts-reads-guide.md +242 -0
- package/skills/uipath-insights/references/filter-discovery-guide.md +1 -1
- package/skills/uipath-insights/references/jobs-commands-guide.md +2 -2
- package/skills/uipath-ixp/references/cli-reference.md +1 -1
- package/skills/uipath-ixp/references/improve-prompts-guide.md +5 -6
- package/skills/uipath-maestro-bpmn/SKILL.md +87 -15
- package/skills/uipath-maestro-bpmn/references/diagnose/CAPABILITY.md +10 -10
- package/skills/uipath-maestro-bpmn/references/diagnose/{references/troubleshooting-guide.md → troubleshooting-guide.md} +1 -1
- package/skills/uipath-maestro-bpmn/references/expression-authoring.md +12 -2
- package/skills/uipath-maestro-bpmn/references/operate/CAPABILITY.md +12 -12
- package/skills/uipath-maestro-bpmn/references/operate/{references/run.md → run.md} +2 -2
- package/skills/uipath-maestro-bpmn/references/operate/{references/ship.md → ship.md} +3 -3
- package/skills/uipath-maestro-bpmn/references/patterns/ai-decision-review-guide.md +138 -0
- package/skills/uipath-maestro-bpmn/references/patterns/approval-chain-guide.md +136 -0
- package/skills/uipath-maestro-bpmn/references/patterns/composing-guide.md +113 -0
- package/skills/uipath-maestro-bpmn/references/patterns/external-wait-guide.md +145 -0
- package/skills/uipath-maestro-bpmn/references/patterns/failure-escalation-guide.md +103 -0
- package/skills/uipath-maestro-bpmn/references/patterns/high-volume-batch-guide.md +107 -0
- package/skills/uipath-maestro-bpmn/references/patterns/queue-distribution-guide.md +129 -0
- package/skills/uipath-maestro-bpmn/references/patterns/smart-triage-guide.md +129 -0
- package/skills/uipath-maestro-bpmn/references/registry-workflow.md +15 -0
- package/skills/uipath-maestro-bpmn/references/shared/local-metadata-regeneration-guide.md +67 -36
- package/skills/uipath-maestro-bpmn/references/shared/project-layout.md +6 -5
- package/skills/uipath-maestro-bpmn/references/structural-bpmn.md +23 -5
- package/skills/uipath-maestro-bpmn/validator/bpmn-spec.json +101 -53
- package/skills/uipath-maestro-case/SKILL.md +23 -24
- package/skills/uipath-maestro-case/references/bindings-and-expressions.md +30 -17
- package/skills/uipath-maestro-case/references/bindings-v2-sync.md +5 -5
- package/skills/uipath-maestro-case/references/brownfield.md +3 -3
- package/skills/uipath-maestro-case/references/case-commands.md +8 -4
- package/skills/uipath-maestro-case/references/case-editing-operations.md +19 -19
- package/skills/uipath-maestro-case/references/case-schema.md +17 -3
- package/skills/uipath-maestro-case/references/connector-integration.md +25 -16
- package/skills/uipath-maestro-case/references/connector-trigger-impl.md +15 -15
- package/skills/uipath-maestro-case/references/connector-trigger-planning.md +32 -29
- package/skills/uipath-maestro-case/references/entry-points-sync.md +2 -1
- package/skills/uipath-maestro-case/references/evals/evals.json +11 -11
- package/skills/uipath-maestro-case/references/implementation.md +74 -44
- package/skills/uipath-maestro-case/references/phased-execution.md +23 -21
- package/skills/uipath-maestro-case/references/placeholder-tasks.md +28 -23
- package/skills/uipath-maestro-case/references/planning.md +37 -252
- package/skills/uipath-maestro-case/references/plugins/case/impl-json.md +3 -3
- package/skills/uipath-maestro-case/references/plugins/case/planning.md +8 -6
- package/skills/uipath-maestro-case/references/plugins/conditions/case-exit-conditions/impl-json.md +3 -3
- package/skills/uipath-maestro-case/references/plugins/conditions/case-exit-conditions/planning.md +11 -10
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-entry-conditions/impl-json.md +6 -6
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-entry-conditions/planning.md +12 -12
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-exit-conditions/impl-json.md +4 -4
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-exit-conditions/planning.md +10 -9
- package/skills/uipath-maestro-case/references/plugins/conditions/task-entry-conditions/impl-json.md +5 -5
- package/skills/uipath-maestro-case/references/plugins/conditions/task-entry-conditions/planning.md +16 -14
- package/skills/uipath-maestro-case/references/plugins/logging/impl-json.md +3 -3
- package/skills/uipath-maestro-case/references/plugins/sla/impl-json.md +15 -15
- package/skills/uipath-maestro-case/references/plugins/sla/planning.md +20 -21
- package/skills/uipath-maestro-case/references/plugins/stages/impl-json.md +6 -6
- package/skills/uipath-maestro-case/references/plugins/stages/planning.md +9 -9
- package/skills/uipath-maestro-case/references/plugins/tasks/action/impl-json.md +9 -9
- package/skills/uipath-maestro-case/references/plugins/tasks/action/planning.md +38 -38
- package/skills/uipath-maestro-case/references/plugins/tasks/agent/impl-json.md +3 -3
- package/skills/uipath-maestro-case/references/plugins/tasks/agent/planning.md +24 -20
- package/skills/uipath-maestro-case/references/plugins/tasks/api-workflow/impl-json.md +3 -3
- package/skills/uipath-maestro-case/references/plugins/tasks/api-workflow/planning.md +24 -20
- package/skills/uipath-maestro-case/references/plugins/tasks/case-management/impl-json.md +4 -4
- package/skills/uipath-maestro-case/references/plugins/tasks/case-management/planning.md +25 -21
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-activity/impl-json.md +30 -22
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-activity/planning.md +44 -28
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-trigger/impl-json.md +10 -10
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-trigger/planning.md +27 -23
- package/skills/uipath-maestro-case/references/plugins/tasks/create-inline-common.md +3 -3
- package/skills/uipath-maestro-case/references/plugins/tasks/process/impl-json.md +3 -3
- package/skills/uipath-maestro-case/references/plugins/tasks/process/planning.md +25 -22
- package/skills/uipath-maestro-case/references/plugins/tasks/rpa/impl-json.md +3 -3
- package/skills/uipath-maestro-case/references/plugins/tasks/rpa/planning.md +25 -21
- package/skills/uipath-maestro-case/references/plugins/tasks/wait-for-timer/impl-json.md +4 -4
- package/skills/uipath-maestro-case/references/plugins/tasks/wait-for-timer/planning.md +5 -4
- package/skills/uipath-maestro-case/references/plugins/triggers/event/impl-json.md +9 -9
- package/skills/uipath-maestro-case/references/plugins/triggers/event/planning.md +30 -19
- package/skills/uipath-maestro-case/references/plugins/triggers/manual/impl-json.md +4 -4
- package/skills/uipath-maestro-case/references/plugins/triggers/manual/planning.md +8 -7
- package/skills/uipath-maestro-case/references/plugins/triggers/timer/impl-json.md +3 -3
- package/skills/uipath-maestro-case/references/plugins/triggers/timer/planning.md +5 -4
- package/skills/uipath-maestro-case/references/plugins/variables/bindings/impl-json.md +5 -5
- package/skills/uipath-maestro-case/references/plugins/variables/global-vars/impl-json.md +7 -7
- package/skills/uipath-maestro-case/references/plugins/variables/global-vars/planning.md +21 -17
- package/skills/uipath-maestro-case/references/plugins/variables/io-binding/impl-json.md +29 -21
- package/skills/uipath-maestro-case/references/plugins/variables/io-binding/planning.md +23 -21
- package/skills/uipath-maestro-case/references/registry-discovery.md +5 -5
- package/skills/uipath-maestro-flow/.maintenance/README.md +35 -28
- package/skills/uipath-maestro-flow/.maintenance/check-anchors.sh +19 -1
- package/skills/uipath-maestro-flow/.maintenance/check-links.sh +3 -0
- package/skills/uipath-maestro-flow/.maintenance/check-plugin-pairs.sh +2 -2
- package/skills/uipath-maestro-flow/SKILL.md +66 -76
- package/skills/uipath-maestro-flow/references/author/CAPABILITY.md +75 -72
- package/skills/uipath-maestro-flow/references/author/brownfield.md +90 -0
- package/skills/uipath-maestro-flow/references/author/{references/editing-operations-cli.md → editing-operations-cli.md} +9 -4
- package/skills/uipath-maestro-flow/references/author/editing-operations-json.md +373 -0
- package/skills/uipath-maestro-flow/references/author/editing-operations.md +103 -0
- package/skills/uipath-maestro-flow/references/author/{references/greenfield.md → greenfield.md} +32 -20
- package/skills/uipath-maestro-flow/references/author/planning-arch.md +342 -0
- package/skills/uipath-maestro-flow/references/author/planning-impl.md +283 -0
- package/skills/uipath-maestro-flow/references/author/plugins/agent/impl.md +227 -0
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/agent/planning.md +2 -2
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/agentic-process/impl.md +2 -2
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/agentic-process/planning.md +1 -1
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/api-workflow/impl.md +2 -2
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/api-workflow/planning.md +1 -1
- package/skills/uipath-maestro-flow/references/author/plugins/batch-transform/impl.md +171 -0
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/batch-transform/planning.md +1 -1
- package/skills/uipath-maestro-flow/references/author/plugins/connector/impl.md +449 -0
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/connector/planning.md +3 -3
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/connector-trigger/impl.md +20 -18
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/connector-trigger/planning.md +2 -2
- package/skills/uipath-maestro-flow/references/author/plugins/data-fabric/impl.md +427 -0
- package/skills/uipath-maestro-flow/references/author/plugins/data-fabric/planning.md +185 -0
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/decision/impl.md +5 -0
- package/skills/uipath-maestro-flow/references/author/plugins/delay/impl.md +38 -0
- package/skills/uipath-maestro-flow/references/author/plugins/end/impl.md +56 -0
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/flow/impl.md +2 -2
- package/skills/uipath-maestro-flow/references/author/plugins/hitl/impl.md +178 -0
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/hitl/planning.md +14 -1
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/http/impl-connector.md +4 -4
- package/skills/uipath-maestro-flow/references/author/plugins/http/impl-manual.md +68 -0
- package/skills/uipath-maestro-flow/references/author/plugins/http/impl.md +173 -0
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/http/planning.md +3 -3
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/inline-agent/impl.md +6 -6
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/inline-agent/planning.md +1 -1
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/inline-voice-agent/impl.md +4 -4
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/inline-voice-agent/planning.md +1 -1
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/ixp/impl.md +8 -8
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/loop/impl.md +1 -1
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/loop/planning.md +1 -1
- package/skills/uipath-maestro-flow/references/author/plugins/merge/impl.md +43 -0
- package/skills/uipath-maestro-flow/references/author/plugins/merge/planning.md +24 -0
- package/skills/uipath-maestro-flow/references/author/plugins/rpa/impl.md +117 -0
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/rpa/planning.md +1 -1
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/scheduled-trigger/impl.md +6 -8
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/script/impl.md +5 -5
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/script/planning.md +1 -1
- package/skills/uipath-maestro-flow/references/author/plugins/subflow/impl.md +164 -0
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/subflow/planning.md +1 -1
- package/skills/uipath-maestro-flow/references/author/plugins/summarize/impl.md +189 -0
- package/skills/uipath-maestro-flow/references/author/plugins/summarize/planning.md +66 -0
- package/skills/uipath-maestro-flow/references/author/plugins/switch/planning.md +34 -0
- package/skills/uipath-maestro-flow/references/author/plugins/terminate/impl.md +48 -0
- package/skills/uipath-maestro-flow/references/author/plugins/transform/impl.md +241 -0
- package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/transform/planning.md +1 -1
- package/skills/uipath-maestro-flow/references/diagnose/CAPABILITY.md +39 -37
- package/skills/uipath-maestro-flow/references/diagnose/{references/failure-modes.md → failure-modes.md} +22 -22
- package/skills/uipath-maestro-flow/references/diagnose/{references/troubleshooting-guide.md → troubleshooting-guide.md} +60 -1
- package/skills/uipath-maestro-flow/references/evaluate/CAPABILITY.md +27 -25
- package/skills/uipath-maestro-flow/references/evaluate/{references/commands-reference.md → commands-reference.md} +58 -7
- package/skills/uipath-maestro-flow/references/evaluate/eval-sets-guide.md +227 -0
- package/skills/uipath-maestro-flow/references/evaluate/upload-safety.md +94 -0
- package/skills/uipath-maestro-flow/references/operate/CAPABILITY.md +21 -21
- package/skills/uipath-maestro-flow/references/operate/{references/manage.md → manage.md} +4 -4
- package/skills/uipath-maestro-flow/references/operate/run.md +121 -0
- package/skills/uipath-maestro-flow/references/operate/{references/ship.md → ship.md} +5 -5
- package/skills/uipath-maestro-flow/references/shared/action-nodes.md +30 -22
- package/skills/uipath-maestro-flow/references/shared/cli-commands.md +76 -184
- package/skills/uipath-maestro-flow/references/shared/cli-conventions.md +49 -60
- package/skills/uipath-maestro-flow/references/shared/file-format.md +32 -11
- package/skills/uipath-maestro-flow/references/shared/node-output-wiring.md +49 -104
- package/skills/uipath-maestro-flow/references/shared/ux-narration-and-todos.md +66 -103
- package/skills/uipath-maestro-flow/references/shared/variables-and-expressions.md +4 -4
- package/skills/uipath-planner/SKILL.md +1 -1
- package/skills/uipath-planner/assets/templates/case/case-sdd-template.md +5 -3
- package/skills/uipath-planner/references/case/case-design-lane-guide.md +1 -1
- package/skills/uipath-planner/references/case/case-design-layers-guide.md +2 -2
- package/skills/uipath-planner/references/non-pdd-lane-guide.md +2 -1
- package/skills/uipath-planner/references/pdd-driven-lane-guide.md +3 -2
- package/skills/uipath-planner/references/sdd-generation-guide.md +1 -0
- package/skills/uipath-planner/scripts/case/audit_sdd.py +77 -1
- package/skills/uipath-platform/SKILL.md +6 -4
- package/skills/uipath-platform/references/integration-service/activities.md +7 -4
- package/skills/uipath-platform/references/integration-service/reference-resolution.md +28 -0
- package/skills/uipath-platform/references/integration-service/resources.md +11 -0
- package/skills/uipath-platform/references/integration-service/triggers.md +2 -2
- package/skills/uipath-platform/references/licensing/diagnose/CAPABILITY.md +80 -0
- package/skills/uipath-platform/references/licensing/diagnose/references/failure-modes.md +147 -0
- package/skills/uipath-platform/references/licensing/diagnose/references/troubleshooting-guide.md +125 -0
- package/skills/uipath-platform/references/licensing/licensing.md +3 -0
- package/skills/uipath-platform/references/licensing/user-licenses-allocations.md +5 -0
- package/skills/uipath-platform/references/orchestrator/run-jobs.md +11 -2
- package/skills/uipath-platform/references/traces/feedback.md +4 -4
- package/skills/uipath-platform/references/traces/traces.md +1 -1
- package/skills/uipath-process-mining/SKILL.md +6 -6
- package/skills/uipath-process-mining/references/lifecycle-and-rbac.md +10 -8
- package/skills/uipath-process-mining/references/model-editing.md +1 -1
- package/skills/uipath-process-mining/references/querying.md +4 -3
- package/skills/uipath-review/SKILL.md +171 -541
- package/skills/uipath-review/references/agents/agents-lowcode-rules.md +73 -92
- package/skills/uipath-review/references/agents/guardrails/coded-guardrails-review.md +4 -0
- package/skills/uipath-review/references/agents/guardrails/guardrails-review.md +73 -180
- package/skills/uipath-review/references/architecture-assessment-guide.md +93 -105
- package/skills/uipath-review/references/review-workflow-guide.md +1 -1
- package/skills/uipath-review/references/rpa/modern-studio-issues.md +44 -44
- package/skills/uipath-review/references/rpa/rpa-common-issues.md +251 -321
- package/skills/uipath-review/references/rpa/rpa-review-checklist.md +1 -1
- package/skills/uipath-review/references/rule-catalog-workflow.md +25 -45
- package/skills/uipath-review/references/rule-format.md +21 -21
- package/skills/uipath-rpa/.maintenance/pattern-card-maintenance.md +1 -1
- package/skills/uipath-rpa/CLAUDE.md +4 -5
- package/skills/uipath-rpa/SKILL.md +40 -246
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/FindText.md +2 -10
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/GetColorAtPosition.md +2 -10
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/GetCursorPosition.md +2 -10
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/GetField.md +13 -13
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/GetFieldAtPosition.md +2 -10
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/GetScreenArea.md +27 -8
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/GetText.md +2 -14
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/GetTextAtPosition.md +2 -10
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/MoveCursor.md +3 -11
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/MoveCursorToText.md +2 -10
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/SendControlKey.md +2 -8
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/SendKeys.md +2 -10
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/SendKeysSecure.md +2 -10
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/SetField.md +14 -13
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/SetFieldAtPosition.md +4 -7
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/TerminalSession/_common-options.md +29 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/TerminalSession/authoring-paths.md +58 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/TerminalSession.md +197 -11
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/WaitFieldText.md +2 -10
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/WaitScreenReady.md +9 -10
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/WaitScreenText.md +2 -14
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities/WaitTextAtPosition.md +2 -10
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/activities.json +271 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/coded/coded-api.md +61 -3
- package/skills/uipath-rpa/references/activity-docs/UiPath.Terminal.Activities/2.10/overview.md +76 -0
- package/skills/uipath-rpa/references/cli-reference.md +63 -29
- package/skills/uipath-rpa/references/coded/codedworkflow-reference.md +59 -1
- package/skills/uipath-rpa/references/coded/operations-guide.md +2 -1
- package/skills/uipath-rpa/references/debugging.md +29 -12
- package/skills/uipath-rpa/references/environment-setup.md +54 -1
- package/skills/uipath-rpa/references/execution-maps-guide.md +10 -9
- package/skills/uipath-rpa/references/legacy/activity-docs/_INVOKE-CODE.md +1 -1
- package/skills/uipath-rpa/references/uia-starter-guide.md +46 -8
- package/skills/uipath-rpa/references/xaml/common-pitfalls.md +3 -4
- package/skills/uipath-rpa/references/xaml/csharp-activity-binding-guide.md +7 -8
- package/skills/uipath-rpa/references/xaml/xaml-basics-and-rules.md +132 -42
- package/skills/uipath-solution/SKILL.md +9 -6
- package/skills/uipath-solution/references/activate-and-manage.md +11 -6
- package/skills/uipath-solution/references/develop-solution.md +39 -28
- package/skills/uipath-solution/references/pack-and-deploy.md +49 -1
- package/skills/uipath-solution/references/scenarios/failure-modes.md +1 -1
- package/skills/uipath-solution/references/scenarios/intra-solution-references.md +3 -3
- package/skills/uipath-solution/references/scenarios/manual-edits.md +1 -1
- package/skills/uipath-solution/references/scenarios.md +2 -2
- package/skills/uipath-solution/references/solution-overview.md +15 -6
- package/skills/uipath-tasks/SKILL.md +11 -6
- package/skills/uipath-tasks/references/task-assignment.md +5 -0
- package/skills/uipath-tasks/references/task-catalogs.md +7 -4
- package/skills/uipath-tasks/references/task-completion.md +3 -1
- package/skills/uipath-tasks/references/task-data.md +3 -3
- package/skills/uipath-tasks/references/task-lifecycle.md +11 -0
- package/skills/uipath-tasks/references/task-metadata.md +4 -3
- package/skills/uipath-test/SKILL.md +13 -28
- package/skills/uipath-test/references/failure-triage-guide.md +90 -0
- package/skills/uipath-test/references/playwright-first-mile-guide.md +2 -2
- package/skills/uipath-test/references/publish-and-link-guide.md +0 -1
- package/skills/uipath-test/references/test-result-report-guide.md +1 -2
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/interpretations/healing-agent-data.md +1 -1
- package/skills/uipath-troubleshoot/references/presenting.md +1 -1
- package/skills/uipath-troubleshoot/references/products/maestro/playbooks/folder-not-accessible.md +1 -1
- package/skills/uipath-troubleshoot/references/products/maestro/playbooks/generic-error-400.md +4 -4
- package/skills/uipath-troubleshoot/references/products/maestro/playbooks/integration-service-400.md +2 -2
- package/skills/uipath-troubleshoot/references/products/maestro/playbooks/job-operation-timeout.md +1 -1
- package/skills/uipath-troubleshoot/references/products/maestro/playbooks/no-suitable-runtime-machine.md +1 -1
- package/version-manifest.json +2 -2
- package/skills/uipath-maestro-case/scripts/audit_plan.py +0 -231
- package/skills/uipath-maestro-flow/references/author/references/brownfield.md +0 -93
- package/skills/uipath-maestro-flow/references/author/references/editing-operations-json.md +0 -545
- package/skills/uipath-maestro-flow/references/author/references/editing-operations.md +0 -131
- package/skills/uipath-maestro-flow/references/author/references/planning-arch.md +0 -638
- package/skills/uipath-maestro-flow/references/author/references/planning-impl.md +0 -306
- package/skills/uipath-maestro-flow/references/author/references/plugins/agent/impl.md +0 -229
- package/skills/uipath-maestro-flow/references/author/references/plugins/batch-transform/impl.md +0 -174
- package/skills/uipath-maestro-flow/references/author/references/plugins/connector/impl.md +0 -741
- package/skills/uipath-maestro-flow/references/author/references/plugins/delay/impl.md +0 -75
- package/skills/uipath-maestro-flow/references/author/references/plugins/end/impl.md +0 -65
- package/skills/uipath-maestro-flow/references/author/references/plugins/hitl/impl.md +0 -204
- package/skills/uipath-maestro-flow/references/author/references/plugins/http/impl-manual.md +0 -65
- package/skills/uipath-maestro-flow/references/author/references/plugins/http/impl.md +0 -201
- package/skills/uipath-maestro-flow/references/author/references/plugins/merge/impl.md +0 -43
- package/skills/uipath-maestro-flow/references/author/references/plugins/merge/planning.md +0 -29
- package/skills/uipath-maestro-flow/references/author/references/plugins/rpa/impl.md +0 -121
- package/skills/uipath-maestro-flow/references/author/references/plugins/subflow/impl.md +0 -230
- package/skills/uipath-maestro-flow/references/author/references/plugins/summarize/impl.md +0 -198
- package/skills/uipath-maestro-flow/references/author/references/plugins/summarize/planning.md +0 -71
- package/skills/uipath-maestro-flow/references/author/references/plugins/switch/planning.md +0 -38
- package/skills/uipath-maestro-flow/references/author/references/plugins/terminate/impl.md +0 -48
- package/skills/uipath-maestro-flow/references/author/references/plugins/transform/impl.md +0 -287
- package/skills/uipath-maestro-flow/references/evaluate/references/eval-sets-guide.md +0 -226
- package/skills/uipath-maestro-flow/references/evaluate/references/upload-safety.md +0 -82
- package/skills/uipath-maestro-flow/references/operate/references/run.md +0 -99
- /package/skills/uipath-maestro-bpmn/references/diagnose/{references/failure-modes.md → failure-modes.md} +0 -0
- /package/skills/uipath-maestro-bpmn/references/operate/{references/manage.md → manage.md} +0 -0
- /package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/decision/planning.md +0 -0
- /package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/delay/planning.md +0 -0
- /package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/end/planning.md +0 -0
- /package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/flow/planning.md +0 -0
- /package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/ixp/planning.md +0 -0
- /package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/queue/impl.md +0 -0
- /package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/queue/planning.md +0 -0
- /package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/scheduled-trigger/planning.md +0 -0
- /package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/switch/impl.md +0 -0
- /package/skills/uipath-maestro-flow/references/author/{references/plugins → plugins}/terminate/planning.md +0 -0
- /package/skills/uipath-maestro-flow/references/evaluate/{references/evaluators-guide.md → evaluators-guide.md} +0 -0
- /package/skills/uipath-maestro-flow/references/evaluate/{references/running-guide.md → running-guide.md} +0 -0
|
@@ -7,33 +7,27 @@ user-invocable: true
|
|
|
7
7
|
|
|
8
8
|
# UiPath Solution & Artifact Reviewer
|
|
9
9
|
|
|
10
|
-
Review UiPath solutions and
|
|
10
|
+
Review UiPath solutions and artifacts for structural validity, quality, best practices, optimization, correctness, and business alignment. Produce a structured review report with findings and recommendations.
|
|
11
11
|
|
|
12
|
-
## When to Use
|
|
12
|
+
## When to Use
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
- User asks "is this solution good?" or "what can be improved?"
|
|
16
|
-
- User wants a pre-deployment quality gate check
|
|
17
|
-
- User wants to understand the business value and architecture of an existing solution
|
|
18
|
-
- User asks about best practices for a specific artifact type
|
|
19
|
-
- User has inherited a UiPath project and wants to understand its quality
|
|
14
|
+
Use for requests to review, audit, check, evaluate, improve, quality-gate, or understand the business value or architecture of a UiPath project, solution, or artifact; artifact-type best-practice reviews; and inheritance of an existing solution.
|
|
20
15
|
|
|
21
16
|
## Critical Rules
|
|
22
17
|
|
|
23
|
-
1. **
|
|
24
|
-
2. **
|
|
25
|
-
3.
|
|
26
|
-
4.
|
|
27
|
-
5.
|
|
28
|
-
6.
|
|
29
|
-
7.
|
|
30
|
-
8.
|
|
31
|
-
9.
|
|
32
|
-
10.
|
|
33
|
-
11.
|
|
34
|
-
12.
|
|
35
|
-
13.
|
|
36
|
-
14. **These paths are CLI-managed — `uip agent refresh` owns them:** `.agent-builder/`, `.local/build/`, and (low-code only) the root `entry-points.json`, regenerated from `agent.json`. Do not open their contents. Exclude them from classification, source-file selection, structural metrics, and manual checks. Raise a finding only when `refresh` fails to fix them — a pre-refresh mismatch is stale by construction, not a defect. Read low-code schemas from `agent.json` (`.inputSchema` / `.outputSchema`).
|
|
18
|
+
1. **Read-only.** Never manually modify files. The sole exception is mandatory `uip agent refresh` for low-code agents; it may update derived files, which must not be restored or cleaned up. Report fixes and route them to `uipath-rpa`, `uipath-agents`, `uipath-maestro-flow`, `uipath-maestro-bpmn`, `uipath-api-workflow`, `uipath-coded-apps`, `uipath-platform`, or `uipath-solution`.
|
|
19
|
+
2. **Validate first.** Every RPA entry point requires `uip rpa validate`, plus a project-level `uip rpa build` — `build` compiles the whole project, including entry points `validate` was never pointed at, so a clean per-file `validate` can still fail `build`. Low-code agents require `uip agent refresh` then `uip agent validate`; use `uip maestro flow validate`, `uip maestro bpmn validate`, and `uip api-workflow validate` as applicable. Every CLI validation command uses `--output json`. Report each command's Error, Warning, and Info counts; detail every Error and Warning, but add no detail lines for clean results. A review without both RPA `validate` and `build` is incomplete.
|
|
20
|
+
3. Discover and classify every project before reviewing any project.
|
|
21
|
+
4. Classify findings as **Critical** (blocks deployment), **Warning** (should fix), or **Info** (improvement opportunity).
|
|
22
|
+
5. Establish or infer business context before optimization; queues and additional components are not automatically better.
|
|
23
|
+
6. Do not duplicate validation findings. Reference the output rule ID and message rather than restating checks or passes. Counts include all results; Errors and Warnings also receive detail lines.
|
|
24
|
+
7. Limit analysis to 30 minutes. For solutions with 10+ projects, provide a summary and deep dives for the three highest-risk projects, offering the remainder separately.
|
|
25
|
+
8. Every agent requires `uip agent review` or `uip codedagent review` first, followed by the applicable judgment catalog, including when review began before this skill loaded; merge prior findings only after both passes.
|
|
26
|
+
9. Review-CLI findings are authoritative. Preserve `RuleId`, `Severity`, `Description`, `File`, and `SuggestedFix` verbatim. Format `Recommendation` as `<File>: <Description>. <SuggestedFix>`. Judgment findings use the same format. Map `error` to Critical, `warning` to Warning, and `info` to Info; `judgment` defaults to Warning and may change only with reasoning in the finding description.
|
|
27
|
+
10. Put intended but unapplied rules in **Rules Skipped**, including missing tooling/files, unavailable review CLI, and `status: deferred`. Do not list non-applicable rules.
|
|
28
|
+
11. Never invent `rule_id` values. Each cited ID must occur verbatim in a loaded `references/agents/agents-*-rules.md` catalog or review-CLI JSON. Verify every ID before reporting. A real Critical issue covered by neither source is reported without a `rule_id`; unrule'd Warnings and Infos are dropped. This governs agent findings.
|
|
29
|
+
12. Grade agent projects only with `A`, `B`, `C`, `D`, or `F`, with no `+`/`-`, per agent and overall: `min(G_det, G_jud)`. Read `G_det` from review CLI `Data.Grade`; do not recompute it. Compute `G_jud` from judgment findings only. Show the binding constraint for every grade; low-code reports omit the printed derivation as required by the rubric. A security or data-integrity judgment Critical forces F. The skill grade cannot exceed `Data.Grade`; report both. Do not grade RPA, flows, or coded apps. See [references/agents/agent-grading-rubric.md](references/agents/agent-grading-rubric.md).
|
|
30
|
+
13. `uip agent refresh` owns `.agent-builder/`, `.local/build/`, and, for low-code agents, regenerated root `entry-points.json` from `agent.json`. Do not open these contents. Exclude them from classification, authored-file selection, structural metrics, and manual checks. Report a defect only if refresh fails to fix them. Read low-code schemas from `agent.json` `.inputSchema` and `.outputSchema`.
|
|
37
31
|
|
|
38
32
|
## Review Workflow
|
|
39
33
|
|
|
@@ -41,633 +35,269 @@ Review UiPath solutions and individual artifacts for structural validity, qualit
|
|
|
41
35
|
|
|
42
36
|
#### 0a. Probe the Filesystem
|
|
43
37
|
|
|
44
|
-
Run
|
|
38
|
+
Run from the user-specified directory or current working directory, excluding managed build directories:
|
|
45
39
|
|
|
46
40
|
```bash
|
|
47
|
-
# Discover solution files, project markers, and documentation
|
|
48
41
|
find . -maxdepth 3 \( -type d \( -name ".agent-builder" -o -path "*/.local/build" \) \) -prune -o \( -name "*.uipx" -o -name "project.json" -o -name "project.uiproj" -o -name "agent.json" -o -name "*.flow" -o -name "*.bpmn" -o -name "app.config.json" -o -name ".uipath" -o -name "pyproject.toml" -o -name "langgraph.json" -o -name "llama_index.json" -o -name "openai_agents.json" -o -name "uipath.json" -o -name "main.py" \) -print 2>/dev/null
|
|
49
|
-
|
|
50
|
-
# Search for PDD or design documents
|
|
51
42
|
find . -maxdepth 3 \( -type d \( -name ".agent-builder" -o -path "*/.local/build" \) \) -prune -o \( -name "*PDD*" -o -name "*pdd*" -o -name "*Process_Design*" -o -name "*process_design*" -o -name "*Process-Design*" -o -name "*ProcessDesign*" -o -name "*SDD*" -o -name "*Solution_Design*" -o -name "*design_document*" -o -name "*DesignDocument*" -o -name "*requirements*" -o -name "*specification*" \) -print 2>/dev/null
|
|
52
43
|
```
|
|
53
44
|
|
|
54
|
-
#### 0b. Locate the PDD
|
|
55
|
-
|
|
56
|
-
The PDD is the **source of truth** for the review. It defines what the automation should do, its business context, expected inputs/outputs, exception handling requirements, and success criteria. The review evaluates whether the implementation matches the PDD.
|
|
57
|
-
|
|
58
|
-
**Search for PDD in this order:**
|
|
59
|
-
|
|
60
|
-
1. **Check common locations:** `./docs/`, `./documentation/`, `./Design/`, project root
|
|
61
|
-
2. **Check common names:** `PDD.docx`, `PDD.pdf`, `PDD.md`, `Process_Design_Document.*`, `SDD.*`, `Solution_Design_Document.*`, `Requirements.*`
|
|
62
|
-
3. **Check AGENTS.md or README.md** at project root — may contain or reference the PDD
|
|
63
|
-
4. **Check project.json** `description` field or any metadata pointing to documentation
|
|
45
|
+
#### 0b. Locate and Use the PDD
|
|
64
46
|
|
|
65
|
-
|
|
66
|
-
- Read it (supports .md, .pdf, .docx via appropriate tools)
|
|
67
|
-
- Extract the key review criteria: business process description, expected inputs/outputs, exception handling requirements, SLAs, transaction definitions, queue specifications, application list, credential requirements
|
|
68
|
-
- Use it as the **primary benchmark** for all subsequent review steps
|
|
47
|
+
The PDD is the source of truth for process behavior, business context, inputs/outputs, exceptions, SLAs, transactions, queues, applications, credentials, and success criteria. Search in order: `./docs/`, `./documentation/`, `./Design/`, project root; names containing `PDD.*`, `Process_Design_Document.*`, `SDD.*`, `Solution_Design_Document.*`, or `Requirements.*`; root `AGENTS.md` or `README.md`; then `project.json.description` and metadata. Read supported documents with appropriate tools and extract review criteria.
|
|
69
48
|
|
|
70
|
-
|
|
49
|
+
If none is found, use the `AskUserQuestion` tool to ask interactively (do not print the question as prose):
|
|
71
50
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
Question: "I could not find a Process Design Document (PDD) in this project. Do you have one I can use as the source of truth for this review?"
|
|
76
|
-
Header: "PDD"
|
|
51
|
+
```text
|
|
52
|
+
Question: I could not find a Process Design Document (PDD) in this project. Do you have one I can use as the source of truth for this review?
|
|
53
|
+
Header: PDD
|
|
77
54
|
Options:
|
|
78
|
-
1.
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
Description: "I'll copy/paste the PDD content (or key sections) directly into the chat"
|
|
82
|
-
3. Label: "No, proceed without"
|
|
83
|
-
Description: "Skip PDD alignment — review will cover technical quality and best practices only, not business logic verification"
|
|
55
|
+
1. Yes, I have a file — provide a path, URL, or Confluence/SharePoint link.
|
|
56
|
+
2. I'll paste the content — provide the PDD or relevant sections.
|
|
57
|
+
3. No, proceed without — review technical quality and best practices only; business-logic alignment cannot be verified.
|
|
84
58
|
```
|
|
85
59
|
|
|
86
|
-
|
|
87
|
-
- **If user selects "I'll paste the content":** they will paste the PDD text (or relevant sections) in their next message. Use that content as the PDD for the review.
|
|
88
|
-
- **If user selects "No, proceed without":** proceed without it — the review will focus on technical quality, best practices, and structural correctness, but cannot verify business logic alignment. Note this limitation in the report.
|
|
89
|
-
|
|
90
|
-
#### 0c. Determine Review Scope
|
|
60
|
+
Read supplied or pasted content; if declined, record the limitation. Use the PDD as the primary benchmark.
|
|
91
61
|
|
|
92
|
-
|
|
62
|
+
#### 0c. Determine Scope
|
|
93
63
|
|
|
94
|
-
|
|
64
|
+
Internal labels such as “Path A”, “Path B”, and “Step 3a” must not appear in the final report. Use the user-facing Review Scope vocabulary from Step 5.
|
|
95
65
|
|
|
96
|
-
**
|
|
97
|
-
|
|
98
|
-
- Executable project = `project.json` with `outputType` of `Process`/`Tests`/unspecified, OR a low-code `agent.json`, OR a coded-agent Python project (`pyproject.toml` + framework/`uipath.json` configuration), OR `.flow`, OR `project.uiproj` with `ProjectType` `Flow`/`ProcessOrchestration`/`Api`
|
|
99
|
-
- Library projects (`outputType: "Library"`) co-located with consumers do NOT trigger this scope — that is the normal library+consumer pattern
|
|
100
|
-
- **Windows-Legacy executables do NOT trigger this scope for `.uipx` purposes**: `.uipx` solutions are not supported for Legacy projects. If any detected executable is Legacy, do not flag missing `.uipx` — recommend migration to Modern compatibility if solution bundling is desired. Review each Legacy project independently.
|
|
101
|
-
|
|
102
|
-
Steps for Solution / Multi-project scope:
|
|
103
|
-
1. Read the `.uipx` file (if present) to enumerate all projects
|
|
104
|
-
2. Scan subdirectories for project markers not listed in `.uipx` (orphan executables)
|
|
105
|
-
3. Classify each project using the detection table in Step 1
|
|
106
|
-
4. Run solution-level checks: missing config.json, version mismatches, cross-project dependencies, circular dependencies
|
|
107
|
-
5. Build a solution map: every project with its type, path, and relationship to others
|
|
108
|
-
6. Cross-reference with PDD (if available)
|
|
109
|
-
7. Read [references/solution-review-guide.md](references/solution-review-guide.md) for the full procedure
|
|
110
|
-
8. Proceed to Step 1 for each project individually
|
|
111
|
-
|
|
112
|
-
**Scope: Single Project** — one `project.json` / `agent.json` / `.flow` / coded-app marker, or one Python coded-agent project, at root; no `.uipx`, no executable siblings.
|
|
113
|
-
|
|
114
|
-
1. Classify the project using the detection table in Step 1
|
|
115
|
-
2. Cross-reference with PDD (if available)
|
|
116
|
-
3. Skip solution-level checks; go directly to Step 1
|
|
117
|
-
|
|
118
|
-
If the user pointed to a specific file (e.g., `Main.xaml`), walk up to the enclosing project directory and review the full project.
|
|
119
|
-
|
|
120
|
-
---
|
|
66
|
+
**Solution/multi-project scope:** a root `.uipx`, or at least two executable project markers in different subdirectories. Executable markers are `project.json` with `outputType` Process/Tests/unspecified, low-code `agent.json`, coded-agent Python (`pyproject.toml` plus framework or `uipath.json` configuration), `.flow`, or `project.uiproj` with `ProjectType` Flow/ProcessOrchestration/Api. Libraries (`outputType: Library`) do not trigger this scope. Windows-Legacy executables do not trigger `.uipx` scope; do not flag missing `.uipx`, and recommend Modern migration only when solution bundling is desired.
|
|
121
67
|
|
|
122
|
-
|
|
68
|
+
For solution scope, read `.uipx`; find orphan executables; classify all projects; check `config.json`, versions, dependencies, circular dependencies, and cross-project relationships; build a project map; cross-reference the PDD; read [references/solution-review-guide.md](references/solution-review-guide.md); then review each project.
|
|
123
69
|
|
|
124
|
-
|
|
70
|
+
**Single-project scope:** one root project marker, no `.uipx`, and no executable siblings. Classify it, cross-reference the PDD, skip solution checks, and proceed. If given a file, walk upward to its enclosing project and review the full project.
|
|
125
71
|
|
|
126
|
-
|
|
72
|
+
### Step 1 — Classify Project Type and Language
|
|
127
73
|
|
|
128
|
-
|
|
74
|
+
For every project, read `project.json.expressionLanguage` for RPA (`VisualBasic` or `CSharp`) and adapt expression, null/type, string, LINQ, naming, and Unit of Work checks; never assume VB.
|
|
129
75
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
| Filesystem Signal | Project Type | Review Checklist |
|
|
76
|
+
| Signal | Type | Checklist/catalog |
|
|
133
77
|
|---|---|---|
|
|
134
|
-
| `project.json` + `.cs`
|
|
135
|
-
| `project.json` + `.xaml`
|
|
136
|
-
|
|
|
137
|
-
|
|
|
138
|
-
|
|
|
139
|
-
| `agent.json
|
|
140
|
-
| Python coded-agent
|
|
141
|
-
| `*.flow` + `project.uiproj
|
|
142
|
-
| `*.bpmn` + `
|
|
143
|
-
| `Workflow.json`
|
|
144
|
-
| `.uipath/`
|
|
145
|
-
|
|
146
|
-
For
|
|
147
|
-
|
|
148
|
-
```markdown
|
|
149
|
-
| # | Project Path | Type | Language | Entry Points |
|
|
150
|
-
|---|---|---|---|---|
|
|
151
|
-
| 1 | ./InvoiceProcessor/ | RPA (XAML) | VisualBasic | Main.xaml, Helper.xaml |
|
|
152
|
-
| 2 | ./Dispatcher/ | RPA (Coded) | CSharp | Main.cs |
|
|
153
|
-
| 3 | ./ClassifierAgent/ | Agent (Coded) | Python | main.py |
|
|
154
|
-
| 4 | ./Orchestration.flow | Flow | — | — |
|
|
155
|
-
```
|
|
156
|
-
|
|
157
|
-
**Step 1c — Inventory the authored files** for every project you will review. Run this instead of writing your own `find`, to avoid listing runtime artifacts:
|
|
78
|
+
| `project.json` + `.cs` with `[Workflow]` | RPA (Coded) | [rpa-review-checklist.md](references/rpa/rpa-review-checklist.md) |
|
|
79
|
+
| `project.json` + `.xaml` | RPA (XAML) | [rpa-review-checklist.md](references/rpa/rpa-review-checklist.md) |
|
|
80
|
+
| absent `targetFramework` or `Legacy` | RPA (Windows-Legacy) | [rpa-review-checklist.md](references/rpa/rpa-review-checklist.md) §10; recommend `uipath-rpa` Legacy mode |
|
|
81
|
+
| both `.cs` and `.xaml` | RPA (Hybrid) | RPA checklist |
|
|
82
|
+
| DU packages `UiPath.IntelligentOCR.Activities` or `UiPath.DocumentUnderstanding.ML.Activities` | RPA + Document Understanding | RPA + [du-review-checklist.md](references/document-understanding/du-review-checklist.md) |
|
|
83
|
+
| `agent.json.type == lowCode` | Agent (Low-Code) | [agents-lowcode-rules.md](references/agents/agents-lowcode-rules.md) |
|
|
84
|
+
| Python coded-agent signals, including `agent.json.type == coded` | Agent (Coded) | [agents-coded-rules.md](references/agents/agents-coded-rules.md) |
|
|
85
|
+
| `*.flow` + `project.uiproj.ProjectType == Flow` | Flow | [flow-review-checklist.md](references/flows/flow-review-checklist.md) |
|
|
86
|
+
| `*.bpmn` + `ProjectType == ProcessOrchestration` | Maestro BPMN | [bpmn-review-checklist.md](references/bpmn/bpmn-review-checklist.md) |
|
|
87
|
+
| `Workflow.json` with `document.dsl` and `do[]` + `ProjectType == Api` | API Workflow | [api-workflow-review-checklist.md](references/api-workflows/api-workflow-review-checklist.md) |
|
|
88
|
+
| `.uipath/` or `app.config.json` | Coded App | [coded-app-review-checklist.md](references/coded-apps/coded-app-review-checklist.md) |
|
|
89
|
+
|
|
90
|
+
For solutions, record path, type, language, and entry points. Inventory authored files, excluding managed/build/dependency directories:
|
|
158
91
|
|
|
159
92
|
```bash
|
|
160
93
|
find "<PROJECT_DIR>" \( -type d \( -name ".agent-builder" -o -path "*/.local/build" -o -name "node_modules" -o -name ".venv" -o -name "obj" -o -name "bin" \) \) -prune -o -type f -print 2>/dev/null | sort
|
|
161
94
|
```
|
|
162
95
|
|
|
163
|
-
|
|
96
|
+
Only this authored-file set is in scope for reading, citation, and metrics.
|
|
164
97
|
|
|
165
98
|
### Step 2 — Run Automated Validation and Workflow Analyzer
|
|
166
99
|
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
- **Solution / Multi-project scope:** Run validation on **every project** in the solution. For each RPA project, validate **every entry point file**.
|
|
170
|
-
- **Single Project scope:** Run validation on the single project. For RPA projects, validate **every entry point file**.
|
|
171
|
-
|
|
172
|
-
Account for **all** results in the final review report: Error / Warning / Info counts in the validation table, plus a detail line per Error and Warning (Step 2d).
|
|
100
|
+
Run commands yourself before manual review, for every project and every RPA entry point. Record all results.
|
|
173
101
|
|
|
174
|
-
#### 2a. RPA
|
|
102
|
+
#### 2a. RPA
|
|
175
103
|
|
|
176
|
-
|
|
177
|
-
2. For **each** entry point file, run validation yourself:
|
|
104
|
+
Read `entryPoints` from `project.json` and run each:
|
|
178
105
|
|
|
179
106
|
```bash
|
|
180
107
|
uip rpa validate --file-path "<ENTRY_FILE>" --project-dir "<PROJECT_DIR>" --output json
|
|
181
|
-
```
|
|
182
|
-
|
|
183
|
-
3. **Then run a project-level build** to catch what `validate` misses (unknown member names like `NGetText.Value`, invalid enum values like `Operator="StartsWith"`, member resolution / CacheMetadata failures, attribute-form C# expression JIT failures):
|
|
184
|
-
|
|
185
|
-
```bash
|
|
186
108
|
uip rpa build "<PROJECT_DIR>" --log-level Warn --output json
|
|
187
109
|
```
|
|
188
110
|
|
|
189
|
-
|
|
190
|
-
5. If any entry point has `validate` errors **or** the project fails to `build`, the project is **not deployable**
|
|
191
|
-
|
|
192
|
-
> Do NOT validate only Main.xaml — validate every file listed in `entryPoints`. A project can have multiple entry points and errors in any of them block deployment.
|
|
193
|
-
|
|
194
|
-
> Do NOT report a clean review based on `validate` alone. `validate` is static analysis; it does not catch unknown member names or invalid enum values. A "0 errors" `validate` result with a failing `build` is a real bug that ships if the reviewer skips `build`.
|
|
111
|
+
Any entry-point validation error or project build failure means the project is not deployable. Do not validate only `Main.xaml`.
|
|
195
112
|
|
|
196
|
-
#### 2b.
|
|
197
|
-
|
|
198
|
-
The Workflow Analyzer checks code quality rules (ST-NMG naming, ST-DBP design, ST-MRD maintainability, ST-USG usage, ST-SEC security, ST-REL reliability). Run it explicitly:
|
|
113
|
+
#### 2b. Workflow Analyzer
|
|
199
114
|
|
|
200
115
|
```bash
|
|
201
116
|
uip rpa analyze --project-dir "<PROJECT_DIR>" --output json
|
|
202
117
|
```
|
|
203
118
|
|
|
204
|
-
If
|
|
205
|
-
|
|
206
|
-
- **Error-level violations** → report as **Critical** findings (e.g., ST-SEC-007 SecureString, ST-ANA-005 missing project.json)
|
|
207
|
-
- **Warning-level violations** → report as **Warning** findings (e.g., ST-DBP-003 empty Catch, ST-MRD-011 Write Line usage, ST-NMG-001 naming)
|
|
208
|
-
- **Info-level violations** → report as **Info** findings (e.g., ST-ANA-003 workflow count, ST-ANA-009 file activity stats)
|
|
119
|
+
If unavailable, use Analyzer results included by `uip rpa validate`. Report every violation: Error as Critical, Warning as Warning, and Info as Info, preserving rule ID, file, and description. Examples include ST-SEC-007, ST-ANA-005, ST-DBP-003, ST-MRD-011, ST-NMG-001, ST-ANA-003, and ST-ANA-009 when emitted.
|
|
209
120
|
|
|
210
|
-
|
|
121
|
+
#### 2c. Other Types
|
|
211
122
|
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
|
215
|
-
|
|
216
|
-
|
|
|
217
|
-
|
|
|
218
|
-
|
|
|
219
|
-
|
|
|
220
|
-
| Coded App | `uip codedapp pack dist --dry-run --output json` | Yes — build errors, pack warnings |
|
|
221
|
-
| Solution | `uip solution pack "<SOLUTION_DIR>" "<OUTPUT_DIR>" --output json` | Yes — per-project pack results |
|
|
123
|
+
| Type | Command |
|
|
124
|
+
|---|---|
|
|
125
|
+
| Agent (Low-Code) | `uip agent refresh "<PROJECT_DIR>" --output json`; then `uip agent validate "<PROJECT_DIR>" --output json` |
|
|
126
|
+
| Flow | `uip maestro flow validate "<PROJECT_NAME>.flow" --output json` |
|
|
127
|
+
| Maestro BPMN | `uip maestro bpmn validate "<FILE>.bpmn" --output json` |
|
|
128
|
+
| API Workflow | `uip api-workflow validate "<WORKFLOW_JSON>" --output json` |
|
|
129
|
+
| Coded App | `uip codedapp pack dist --dry-run --output json` |
|
|
130
|
+
| Solution | `uip solution pack "<SOLUTION_DIR>" "<OUTPUT_DIR>" --output json` |
|
|
222
131
|
|
|
223
|
-
|
|
132
|
+
Report all severities. API workflow validation is offline; never run `uip api-workflow run`. If older CLI versions lack BPMN or API validation, record unavailable rules under Rules Skipped and use the relevant checklist.
|
|
224
133
|
|
|
225
|
-
#### 2d.
|
|
134
|
+
#### 2d. Validation Results
|
|
226
135
|
|
|
227
|
-
|
|
136
|
+
Every report includes:
|
|
228
137
|
|
|
229
138
|
```markdown
|
|
230
|
-
### Validation Results
|
|
139
|
+
### Automated Validation Results
|
|
231
140
|
|
|
232
141
|
| Project | Command | Errors | Warnings | Info |
|
|
233
|
-
|
|
234
|
-
|
|
|
235
|
-
| InvoiceProcessor | uip rpa validate (Helper.cs) | 1 | 0 | 0 |
|
|
236
|
-
| InvoiceDispatcher | uip maestro flow validate | 0 | 0 | 0 |
|
|
237
|
-
| ClassifierAgent | uip agent validate | 0 | 1 | 0 |
|
|
142
|
+
|---|---|---:|---:|---:|
|
|
143
|
+
| ... | ... | ... | ... | ... |
|
|
238
144
|
|
|
239
145
|
#### Validation Details
|
|
240
|
-
- [E-001]
|
|
241
|
-
- [W-001]
|
|
242
|
-
- [W-002] InvoiceProcessor/Main.xaml: ST-DBP-003 — Empty Catch block in TryCatch_1
|
|
243
|
-
- [W-003] InvoiceProcessor/Main.xaml: ST-NMG-001 — Variable 'temp_val' does not match naming convention
|
|
244
|
-
- [W-004] ClassifierAgent: Missing tool description for 'lookup_customer'
|
|
146
|
+
- [V-E-001] <file>: <rule ID> — <message>
|
|
147
|
+
- [V-W-001] <file>: <rule ID> — <message>
|
|
245
148
|
```
|
|
246
149
|
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
**Counts in the table; detail lines for Errors and Warnings only.** Every command's Error / Warning / Info counts go in the table — that is where Info is reported. Write a detail line only for an Error or a Warning. Never write a detail line that narrates a clean or successful result (`Status: Valid`, `Verdict: PASS`, `Score: 100`, "no drift", "0 issues", "N files regenerated", "already at schema X") — the `0` in the table already says it, and the Info column already carries the count.
|
|
150
|
+
Include counts for every command. Detail Errors and Warnings only. Do not narrate clean results, passes, zero issues, drift status, scores, regeneration counts, or schema status; the table is sufficient.
|
|
250
151
|
|
|
251
|
-
### Step 2.5 — Run the Review CLI,
|
|
152
|
+
### Step 2.5 — Run the Review CLI, Then Apply the Judgment Catalog
|
|
252
153
|
|
|
253
|
-
|
|
154
|
+
Apply to every encountered agent, including late-invoked reviews.
|
|
254
155
|
|
|
255
|
-
|
|
156
|
+
#### 2.5a. Deterministic CLI pass
|
|
256
157
|
|
|
257
|
-
|
|
158
|
+
Run once and capture JSON:
|
|
258
159
|
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
| Agent type | Command |
|
|
160
|
+
| Type | Command |
|
|
262
161
|
|---|---|
|
|
263
|
-
| Low-
|
|
162
|
+
| Low-Code | `uip agent review "<PROJECT_DIR>" --output json` |
|
|
264
163
|
| Coded | `uip codedagent review "<PROJECT_DIR>" --output json` |
|
|
265
164
|
|
|
266
|
-
|
|
165
|
+
Parse `Data.Issues[]` objects `{RuleId, Category, Severity, Description, File, SuggestedFix}` and carry them verbatim. Guardrail configuration validity is CLI-only: run the review CLI or `--checks guardrails` when appropriate, including every emitted `GUARDRAIL_*` finding verbatim; do not eyeball or re-flag CLI guardrail findings.
|
|
267
166
|
|
|
268
|
-
|
|
167
|
+
#### 2.5b. Judgment pass
|
|
269
168
|
|
|
270
|
-
|
|
169
|
+
Load each applicable catalog fully and apply every rule's `detection_method` to its named source material, including prompts, tools, eval datapoints, and schemas. Track intended rules that cannot be applied.
|
|
271
170
|
|
|
272
|
-
|
|
171
|
+
| Signal | Catalog |
|
|
172
|
+
|---|---|
|
|
173
|
+
| `agent.json.type == lowCode` | `references/agents/agents-lowcode-rules.md` |
|
|
174
|
+
| Python coded-agent or `agent.json.type == coded` | `references/agents/agents-coded-rules.md` |
|
|
175
|
+
| `pyproject.toml` + `main.py` + `uipath.json[functions]` without framework config | coded catalog |
|
|
176
|
+
| `package.json` + `uipath.json[functions]` (no `pyproject.toml`) — Coded Function (JS/TS) | phase 2; no agent catalog |
|
|
177
|
+
| RPA, Flow, Coded App | phase 2; no agent catalog |
|
|
273
178
|
|
|
274
|
-
|
|
275
|
-
|---|---|---|
|
|
276
|
-
| `agent.json.type == "lowCode"` | Agent (low-code) | `references/agents/agents-lowcode-rules.md` |
|
|
277
|
-
| Python coded-agent signals or `agent.json.type == "coded"` | Agent (coded) | `references/agents/agents-coded-rules.md` |
|
|
278
|
-
| `pyproject.toml` + `main.py` + `uipath.json[functions]` only (no framework config) | Agent (coded — Simple Function) | same as Agent (coded) |
|
|
279
|
-
| `project.json` + `.xaml` / `.cs` | RPA | *(phase 2)* |
|
|
280
|
-
| `*.flow` | Flow | *(phase 2)* |
|
|
281
|
-
| `.uipath/` or `app.config.json` | Coded App | *(phase 2)* |
|
|
282
|
-
|
|
283
|
-
2. **Read each catalog file in full.** Every rule is judgment-form.
|
|
284
|
-
3. **Guardrails — apply the structured guardrail workflow** (project-type specific; Step 0 fetches the authored `uip agent guardrails catalog` — 30-min cache — plus the never-cached tenant-availability `uip agent guardrails list` → **Audit Mode** for existing guardrails + **Recommend Mode** for missing ones):
|
|
285
|
-
- **Low-code** (`agent.json`): when `guardrails[]` is non-empty or the agent matches a guardrail use case, apply [`references/agents/guardrails/guardrails-review.md`](references/agents/guardrails/guardrails-review.md). Emits `LC_GUARDRAIL_ACTION_INEFFECTIVE` / `LC_GUARDRAIL_MISAPPLIED` (defects, `judgment` band) and `LC_GUARDRAIL_RECOMMENDED` (Info, one per missing guardrail).
|
|
286
|
-
- **Coded** (SDK middleware / `@guardrail` decorators wired in the entry `.py`): when the entry source wires guardrails or the agent matches a use case, apply [`references/agents/guardrails/coded-guardrails-review.md`](references/agents/guardrails/coded-guardrails-review.md) (its Step 0 fetches the public Python SDK docs only when a finding must name Python classes not already visible in the agent source). Emits `CODED_GUARDRAIL_ACTION_INEFFECTIVE` / `CODED_GUARDRAIL_MISAPPLIED` (defects, `judgment` band) and `CODED_GUARDRAIL_RECOMMENDED` (Info). The CLI's deterministic `CODED_GUARDRAIL_WRONG_IMPORT` / `CODED_GUARDRAIL_TOOL_SCOPE_NO_TOOLS` / `CODED_GUARDRAIL_INVALID_CONTRACT` (Step 2.5a) are carried verbatim and **not** re-flagged here.
|
|
287
|
-
- Either way, if the guardrail catalog is unavailable, record the Audit-Mode rules under "Rules Skipped" and keep Recommend Mode's source-only detection.
|
|
288
|
-
4. **Apply each rule's `detection_method`:** read the named source material (system prompt, tool descriptions, eval datapoints, schemas) and reason about it. Emit a finding when the criteria hold; log the reasoning in the finding's `description`.
|
|
289
|
-
5. **Track skipped rules** with their reason (`status: deferred`, missing optional file, review CLI unavailable). Never silently skip.
|
|
290
|
-
6. **Verify rule_id provenance.** Before merging, confirm each cited `rule_id` appears **verbatim** in EITHER a loaded catalog file OR the `uip agent review` / `uip codedagent review` JSON output. Any finding whose `rule_id` matches neither is **demoted** to a `rule_id`-less Critical (the observation stays; the false citation goes) — or dropped when it is a Warning or Info. This enforces Critical Rule 12.
|
|
291
|
-
7. **Merge findings into the Step 5 report** — into the Critical / Warning / Info findings tables, one row per finding:
|
|
292
|
-
|
|
293
|
-
```
|
|
294
|
-
| <id> | `<rule_id>` | `<file>`: <issue>. <fix>. |
|
|
295
|
-
```
|
|
296
|
-
|
|
297
|
-
where prefix is `C-D-` (Critical), `W-D-` (Warning), or `I-D-` (Info) per the severity mapping in [`references/rule-format.md`](references/rule-format.md).
|
|
298
|
-
|
|
299
|
-
See [`references/rule-catalog-workflow.md`](references/rule-catalog-workflow.md) for the full procedure including the CLI contract and determinism rules.
|
|
179
|
+
For guardrails, running the guardrail workflow is **mandatory** whenever `guardrails[]` is non-empty or the use case calls for guardrails — do not eyeball `agent.json`:
|
|
300
180
|
|
|
301
|
-
|
|
181
|
+
- Low-code: **open [guardrails-review.md](references/agents/guardrails/guardrails-review.md) and follow its Step 0 — you MUST run `uip agent guardrails catalog --output json` (30-min cache) and the never-cached tenant `uip agent guardrails list`** before auditing, then apply Audit Mode and Recommend Mode. Emit `LC_GUARDRAIL_ACTION_INEFFECTIVE`, `LC_GUARDRAIL_MISAPPLIED`, and `LC_GUARDRAIL_RECOMMENDED` as applicable.
|
|
182
|
+
- Coded: **open [coded-guardrails-review.md](references/agents/guardrails/coded-guardrails-review.md) and follow it** when middleware/decorators are wired or the use case calls for guardrails. Public Python SDK docs may be fetched only when a finding must name classes not visible in source. Emit `CODED_GUARDRAIL_ACTION_INEFFECTIVE`, `CODED_GUARDRAIL_MISAPPLIED`, and `CODED_GUARDRAIL_RECOMMENDED`; do not duplicate CLI IDs `CODED_GUARDRAIL_WRONG_IMPORT`, `CODED_GUARDRAIL_TOOL_SCOPE_NO_TOOLS`, or `CODED_GUARDRAIL_INVALID_CONTRACT`.
|
|
183
|
+
- If the guardrail catalog is unavailable, put Audit-Mode rules in Rules Skipped and retain source-only Recommend Mode detection.
|
|
302
184
|
|
|
303
|
-
|
|
185
|
+
Before merging, verify every `rule_id` against a loaded catalog or CLI JSON. Remove absent IDs and retain only a Critical observation; drop unrule'd Warnings and Infos. Merge one row per finding into the Step 5 severity table using `C-D-`, `W-D-`, or `I-D-` prefixes as described in [references/rule-format.md](references/rule-format.md).
|
|
304
186
|
|
|
305
|
-
|
|
187
|
+
### Step 3 — Manual Quality Review
|
|
188
|
+
|
|
189
|
+
For each project, load its type-specific checklist and inspect only authored files.
|
|
306
190
|
|
|
307
|
-
|
|
191
|
+
#### 3a. Unit of Work Discovery
|
|
308
192
|
|
|
309
|
-
|
|
193
|
+
Derive both the declared contract unit and actual execution unit; do not ask the user. A mismatch is Critical-to-Warning regardless of type.
|
|
310
194
|
|
|
311
|
-
|
|
|
195
|
+
| Type | Declared unit location |
|
|
312
196
|
|---|---|
|
|
313
|
-
| RPA
|
|
197
|
+
| RPA with queue | Queue schema or fields used by `Add Queue Item`/`Get Transaction Item` |
|
|
314
198
|
| RPA without queue | `Main.xaml` input arguments |
|
|
315
|
-
| Flow | `.flow
|
|
316
|
-
| Maestro BPMN |
|
|
317
|
-
|
|
|
318
|
-
|
|
|
319
|
-
| API workflow |
|
|
320
|
-
| Coded app | Entry
|
|
321
|
-
|
|
322
|
-
**Step 3a.2 — Discover the actual unit of work** (core execution body):
|
|
199
|
+
| Flow | `.flow.variables.globals` entries with `in`/`inout` direction |
|
|
200
|
+
| Maestro BPMN | Start-event payload/process inputs |
|
|
201
|
+
| Low-code agent | `agent.json.inputSchema` |
|
|
202
|
+
| Coded agent | `Input` Pydantic `BaseModel` in `main.py` |
|
|
203
|
+
| API workflow | `Workflow.json` request schema |
|
|
204
|
+
| Coded app | Entry-point schema in `operate.json`/`entry-points.json` |
|
|
323
205
|
|
|
324
|
-
|
|
206
|
+
Find the core execution body and inspect iteration and effects:
|
|
325
207
|
|
|
326
208
|
```bash
|
|
327
|
-
# Detect iteration inside the execution body
|
|
328
209
|
grep -n 'ForEach\|While' <EXECUTION_FILE>
|
|
329
|
-
|
|
330
|
-
# Detect external-effect activities (writes, API calls, queue pushes, workflow invocations)
|
|
331
210
|
grep -n 'HttpRequest\|Add Queue Item\|InvokeWorkflowFile\|Write Range\|Write Line\|SqlCommand' <EXECUTION_FILE>
|
|
332
211
|
```
|
|
333
212
|
|
|
334
|
-
For coded projects
|
|
335
|
-
|
|
336
|
-
**Step 3a.3 — Classify using this matrix:**
|
|
213
|
+
For coded projects inspect `for`, `foreach`, `while`, and external I/O. Classify:
|
|
337
214
|
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
| Actual execution pattern | Transaction Shape |
|
|
215
|
+
| Pattern | Shape |
|
|
341
216
|
|---|---|
|
|
342
|
-
| One invocation
|
|
343
|
-
|
|
|
344
|
-
|
|
|
345
|
-
| No
|
|
346
|
-
| Contract or execution cannot be
|
|
347
|
-
|
|
348
|
-
**External effects inside a loop body that make it one-to-many** (none of these are defeated by session scope, shared credentials, single portal, or business-model arguments):
|
|
217
|
+
| One invocation causes one atomic external state change | one-to-one |
|
|
218
|
+
| Loop over an input collection with external effects in the loop | one-to-many |
|
|
219
|
+
| Retry/UI enumeration/in-memory-only loop | one-to-one |
|
|
220
|
+
| No loop | one-to-one |
|
|
221
|
+
| Contract or execution cannot be mapped deterministically | unclear |
|
|
349
222
|
|
|
350
|
-
- `
|
|
351
|
-
- HTTP activities (`HTTP Request`, connector activities, REST calls)
|
|
352
|
-
- Queue operations (`Add Queue Item`, `Set Transaction Progress`, `Set Transaction Status`)
|
|
353
|
-
- Database writes (`Execute Non Query`, `Insert Data Table`, `Bulk Insert`)
|
|
354
|
-
- File writes outside `Temp/` directories (`Write Range`, `Write CSV`, `Append to File`)
|
|
355
|
-
- UI activities that modify target-system state (Click on submit/save, Type Into fields that persist, SAP `Call Transaction`)
|
|
356
|
-
- Email send activities
|
|
223
|
+
Side effects making a loop one-to-many include invoked side-effect workflows, HTTP/connectors, queue operations (`Add Queue Item`, `Set Transaction Progress`), database writes (`Execute Non Query`, `Insert Data Table`, `Bulk Insert`), non-temporary file writes (`Write Range`, `Write CSV`, `Append to File`), state-changing UI actions (Click submit/save, persistent Type Into, SAP `Call Transaction`), and email sends. Session scope, shared credentials, one portal, PDD wording, idempotency, or queue size do not reclassify the shape.
|
|
357
224
|
|
|
358
|
-
|
|
359
|
-
- "The portal models this as one transaction" (UX framing ≠ atomicity)
|
|
360
|
-
- "One browser session" (session ≠ transaction)
|
|
361
|
-
- "Idempotency guards exist so it's fine" (guards are a remediation signal, not a reclassifier)
|
|
362
|
-
- "The PDD calls it one transaction" (declared intent ≠ execution reality)
|
|
363
|
-
- "The queue only has one item" (queue is the declared unit; actual unit is what gets written)
|
|
225
|
+
For one-to-many, determine whether sub-units can be independently queued. If yes, recommend dispatcher/performer splitting. If no, use the 10-point hardening checklist in [rpa-common-issues.md](references/rpa/rpa-common-issues.md) under “When it cannot be split — hardening checklist”; report each missing safeguard separately. Check read-before-write, conditional skips, `UniqueReference`, SQL `MERGE`/`ON CONFLICT`/`UPSERT`/`WHERE NOT EXISTS`, HTTP idempotency headers, status filters, pre-check workflows, and per-sub-item progress.
|
|
364
226
|
|
|
365
|
-
|
|
227
|
+
Severity: splittable with no guards and `MaxRetryNumber < 2` is Critical; splittable with guards but weak progress/output is Warning; unsplittable missing safeguards is Warning–Critical; splittable with guards, retry, and per-item output is Info; unclear mapping is Info. Report one Transaction Shape summary line per project and never create a separate Unit of Work Analysis section.
|
|
366
228
|
|
|
367
|
-
|
|
229
|
+
#### 3b. PDD Alignment
|
|
368
230
|
|
|
369
|
-
|
|
231
|
+
When available, compare business process, inputs/outputs, exceptions/retries, applications, transaction definition, queues, credentials, SLAs/performance, happy-path and exception scenarios, and out-of-scope items. Mismatches are generally Warning; hardcoded credentials are Critical; SLA/performance and out-of-scope concerns are Info. Use a dedicated PDD Alignment section. Without a PDD, state: “No PDD was available for this review. Business logic alignment could not be verified. This review covers technical quality and best practices only.”
|
|
370
232
|
|
|
371
|
-
|
|
233
|
+
#### 3c. Technical Review
|
|
372
234
|
|
|
373
|
-
|
|
374
|
-
- Yes: the proper fix is dispatcher/performer — split the queue so each sub-unit is an atomic transaction. Use this when sub-units are independent (one invoice, one employee record, one order, one file).
|
|
375
|
-
- No: the domain forces a sequential session-bound submission (SAP new-plan enrollment, carrier portal group application, bank multi-step wire). Queue splitting is infeasible. The fix is not architectural — it is operational: verify atomicity, error handling, crash recovery, and progress tracking using the **10-point hardening checklist** in [rpa-common-issues.md](references/rpa/rpa-common-issues.md) → "When it cannot be split — hardening checklist." Each missing safeguard is a separate finding.
|
|
235
|
+
Load the applicable checklist. For solutions also read [solution-review-guide.md](references/solution-review-guide.md) for `.uipx`, `config.json`, orphan, dependency, consistency, and architecture checks. Skip `.uipx` checks for Windows-Legacy executables and recommend migration instead.
|
|
376
236
|
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
Look for any of these patterns (semantically, not by filename):
|
|
380
|
-
|
|
381
|
-
| Pattern | Detection |
|
|
382
|
-
|---|---|
|
|
383
|
-
| Read-check-before-write before each sub-unit write | Inspect activity sequence in the loop body |
|
|
384
|
-
| Conditional skip based on "already exists/processed" state | Inspect If/Switch branches wrapping writes |
|
|
385
|
-
| Orchestrator queue dedup via `UniqueReference` | Check `Add Queue Item` properties |
|
|
386
|
-
| SQL idempotent writes (`MERGE`, `ON CONFLICT`, `UPSERT`, `WHERE NOT EXISTS`) | Grep SQL statements |
|
|
387
|
-
| HTTP idempotency (`Idempotency-Key` header, ETag `If-Match` / `If-None-Match`) | Check HTTP Request headers |
|
|
388
|
-
| Status-column filters (`WHERE Status != 'Processed'`) | Grep queries |
|
|
389
|
-
| Pre-check workflow invocation (names often contain `check`/`verify`/`exists`/`processed`/`already`/`skip`/`idempoten` — one of many forms, not the only signal) | Inspect invoked workflow names and bodies |
|
|
390
|
-
| Per-sub-item progress written to queue `Output` / Data Service / external state | Inspect what's persisted during the loop |
|
|
391
|
-
|
|
392
|
-
**Severity and finding framing:**
|
|
393
|
-
|
|
394
|
-
| Scenario | Severity | Finding framing |
|
|
395
|
-
|---|---|---|
|
|
396
|
-
| One-to-many + sub-units splittable + no idempotency guards + `MaxRetryNumber` < 2 | **Critical** | "Transaction granularity: split into dispatcher/performer. Current architecture risks partial-state corruption on transient failure." |
|
|
397
|
-
| One-to-many + sub-units splittable + idempotency guards exist but progress/output fidelity weak | **Warning** | "Transaction granularity: consider dispatcher/performer split for better analytics and retry isolation." |
|
|
398
|
-
| One-to-many + sub-units NOT splittable (domain constraint) + missing safeguards | **Warning–Critical** | "Cannot be split — run the 10-point hardening checklist in [rpa-common-issues.md](references/rpa/rpa-common-issues.md) → 'When it cannot be split.' Report each missing safeguard as a separate finding." |
|
|
399
|
-
| One-to-many + splittable + guards + retry + per-sub-item output | Info (tech debt) | "Transaction granularity: working with compensation; consider dispatcher/performer if volume grows." |
|
|
400
|
-
| Unclear | Info | "Unit of work ambiguous — schema/code documentation gap." |
|
|
401
|
-
|
|
402
|
-
The shape observation belongs in the **Executive Summary** of the report as a one-liner (see Step 5). Any finding generated from the shape analysis becomes a normal numbered finding in the Critical/Warning/Info sections — not a separate "Unit of Work Analysis" block.
|
|
403
|
-
|
|
404
|
-
#### 3b. PDD Alignment Review (if PDD is available)
|
|
405
|
-
|
|
406
|
-
If a PDD was found or provided in Step 0, use it as the **primary benchmark** for the manual review. For each project, verify:
|
|
407
|
-
|
|
408
|
-
| PDD Section | What to Check | Severity if Mismatched |
|
|
409
|
-
|---|---|---|
|
|
410
|
-
| Business process description | Does the implementation match the described process flow? | Warning |
|
|
411
|
-
| Expected inputs/outputs | Do workflow arguments match PDD-defined inputs and outputs? | Warning |
|
|
412
|
-
| Exception handling requirements | Are Business Exceptions thrown for the cases the PDD defines? Are retries configured per PDD specs? | Warning |
|
|
413
|
-
| Application list | Are all applications from the PDD automated? Any missing? Any extras not in PDD? | Warning |
|
|
414
|
-
| Transaction definition | Does the transaction item structure match the PDD? | Warning |
|
|
415
|
-
| Queue specifications | Queue names, retry counts, SLAs match PDD? | Warning |
|
|
416
|
-
| Credential requirements | Are all credentials from PDD stored securely (assets/vault)? | Critical if hardcoded |
|
|
417
|
-
| SLAs and performance targets | Does the automation design support PDD-defined throughput/timing? | Info |
|
|
418
|
-
| Happy path + exception scenarios | Are all PDD-documented scenarios handled? | Warning |
|
|
419
|
-
| Out of scope items | Does the automation stay within PDD-defined scope? | Info |
|
|
420
|
-
|
|
421
|
-
**Report PDD mismatches** as a dedicated section in the review report. A technically sound automation that doesn't match its PDD is still a problem.
|
|
422
|
-
|
|
423
|
-
If no PDD is available, skip this sub-step and note in the report:
|
|
424
|
-
> **Note:** No PDD was available for this review. Business logic alignment could not be verified. This review covers technical quality and best practices only.
|
|
425
|
-
|
|
426
|
-
#### 3c. Technical Quality Review
|
|
427
|
-
|
|
428
|
-
For **each** project, load the type-specific checklist:
|
|
429
|
-
|
|
430
|
-
For **Solution / Multi-project scope**, also perform solution-level checks from [references/solution-review-guide.md](references/solution-review-guide.md):
|
|
431
|
-
- Solution structure validation (.uipx, config.json, orphan projects) — **skip `.uipx` checks if any detected executable is Windows-Legacy; recommend migration instead**
|
|
432
|
-
- Cross-project dependency checks
|
|
433
|
-
- Configuration consistency across projects
|
|
434
|
-
- Multi-project architecture pattern assessment
|
|
435
|
-
|
|
436
|
-
For deep-dive RPA reviews, also consult:
|
|
437
|
-
- RPA (advanced): [rpa-advanced-checklist.md](references/rpa/rpa-advanced-checklist.md) — project organization, selector robustness, variable hygiene, data patterns, error handling depth, testing maturity, idempotency
|
|
438
|
-
- RPA (long-running): [long-running-workflow-issues.md](references/rpa/long-running-workflow-issues.md) — load when project uses persistence activities (`Suspend`, `Wait and Resume`, `Create Form Task`, Orchestration Process type)
|
|
439
|
-
- RPA (Modern Studio): [modern-studio-issues.md](references/rpa/modern-studio-issues.md) — load for Studio 2024.10+ projects (Modern vs Classic mixing, coded/XAML interop, Object Repository, Data Manager, Healing Agent)
|
|
440
|
-
- Document Understanding: [du-review-checklist.md](references/document-understanding/du-review-checklist.md) — load when DU packages detected in `project.json` dependencies
|
|
441
|
-
|
|
442
|
-
For common antipatterns per project type, also consult:
|
|
443
|
-
- RPA: [rpa-common-issues.md](references/rpa/rpa-common-issues.md)
|
|
444
|
-
- Flows: [flow-common-issues.md](references/flows/flow-common-issues.md)
|
|
237
|
+
Consult as applicable: [rpa-advanced-checklist.md](references/rpa/rpa-advanced-checklist.md); [long-running-workflow-issues.md](references/rpa/long-running-workflow-issues.md) for persistence activities or Orchestration Process; [modern-studio-issues.md](references/rpa/modern-studio-issues.md) for Studio 2024.10+; [du-review-checklist.md](references/document-understanding/du-review-checklist.md) when DU packages are present; [rpa-common-issues.md](references/rpa/rpa-common-issues.md); and [flow-common-issues.md](references/flows/flow-common-issues.md).
|
|
445
238
|
|
|
446
239
|
### Step 4 — Evaluate Optimization
|
|
447
240
|
|
|
448
|
-
Only after validation
|
|
241
|
+
Only after validation and manual review, assess business suitability, architecture, dependencies, queue usage, bulk operations, transaction/error recovery, redundant calls, logging, selectors, files, data handling, configuration consistency, environment separation, and performance. For solutions assess cross-project architecture, pinned libraries, circular dependencies, dispatcher/performer suitability, and shared configuration. For single projects assess queues for more than 50 independent items, batching, REFramework/equivalent retry, resource efficiency, and selector/data patterns. Read [review-workflow-guide.md](references/review-workflow-guide.md) and [architecture-assessment-guide.md](references/architecture-assessment-guide.md).
|
|
449
242
|
|
|
450
|
-
|
|
451
|
-
- **Architecture:** Is the multi-project design appropriate (dispatcher/performer, main + libraries, flow + resources)?
|
|
452
|
-
- **Cross-project dependencies:** Are library versions pinned? Any circular dependencies?
|
|
453
|
-
- **Queue usage:** Should this solution use queues for work distribution?
|
|
454
|
-
- **Bulk operations:** Are there loops that could use bulk APIs?
|
|
455
|
-
- **Transaction handling:** Is error recovery and retry properly implemented across projects?
|
|
456
|
-
- **Resource efficiency:** Are there redundant API calls, excessive logging, or unnecessarily large files?
|
|
457
|
-
- **Configuration consistency:** Do all projects use the same pattern for configuration (assets, config.json)?
|
|
243
|
+
### Step 4.5 — Compute Agent Grade
|
|
458
244
|
|
|
459
|
-
|
|
460
|
-
- **Queue usage:** If processing >50 independent items, should this use queues?
|
|
461
|
-
- **Bulk operations:** Are there loops with individual API calls that could be batched?
|
|
462
|
-
- **Transaction handling:** Is REFramework or equivalent retry logic needed?
|
|
463
|
-
- **Resource efficiency:** File sizes, logging volume, selector efficiency, data handling patterns
|
|
464
|
-
|
|
465
|
-
Read [references/review-workflow-guide.md](references/review-workflow-guide.md) for the full optimization evaluation criteria.
|
|
466
|
-
|
|
467
|
-
Read [references/architecture-assessment-guide.md](references/architecture-assessment-guide.md) for the architecture-level evaluation framework — process suitability, complexity classification, environment separation, and architecture principles scoring.
|
|
468
|
-
|
|
469
|
-
### Step 4.5 — Compute the Agent Letter Grade (A–F)
|
|
470
|
-
|
|
471
|
-
**Agent projects only** (phase 1) — matching the Step 2.5 judgment catalog, which is agent-only today. Grade every **agent** project, and (for a multi-agent solution) the agent set overall, on an A–F scale. Non-agent projects are **not** graded yet (RPA, flows, coded apps are future phases) — report their findings without a grade. The grade is **derived** — never a fresh judgment. Take the worse of two sub-grades: G_det is **read from the review CLI**, G_jud you compute from judgment:
|
|
245
|
+
Agents only:
|
|
472
246
|
|
|
247
|
+
```text
|
|
248
|
+
Final grade = min(G_det, G_jud)
|
|
473
249
|
```
|
|
474
|
-
Final grade = min(G_det, G_jud) where G_det = <review CLI>.Data.Grade
|
|
475
|
-
```
|
|
476
|
-
|
|
477
|
-
- **G_det (deterministic)** — **read it from the review CLI; do not recompute.** `uip agent review` / `uip codedagent review` (Step 2.5a) returns `Data.Grade` — that letter, collapsed to its base letter (`C+` → `C`), **is** G_det. (`Data.Issues[]` are still reported verbatim, but the grade comes from `Data.Grade`, not from tallying them.)
|
|
478
|
-
- **G_jud (non-deterministic)** — the only sub-grade you compute, from the judgment-catalog (2.5b) + manual review (Step 3) findings.
|
|
479
|
-
|
|
480
|
-
CLI findings already shaped `Data.Grade` (G_det); only **judgment** findings feed G_jud — so each finding lands in exactly one sub-grade.
|
|
481
250
|
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
**Overall Agent Grade:** single agent → its grade. Multiple agents → the **worst** per-agent grade. Never average grades.
|
|
485
|
-
|
|
486
|
-
Report the **binding constraint** in one line (e.g. "B — gated by G_det = CLI Data.Grade B; judgment clean (G_jud A)"). Since the skill grade is `min(Data.Grade, G_jud)`, it is always ≤ `Data.Grade` — report both; never overwrite the CLI grade. This goes in the Summary's `Agent Grade` line, and the letter alone is restated as `**Final grade: <A–F>**` on the report's last line (Step 5).
|
|
487
|
-
|
|
488
|
-
Full rubric, grade chart, low-code section omissions, edge cases (no-PDD / CLI-unavailable / no-eval-set), CLI-grade alignment, and worked examples: [references/agents/agent-grading-rubric.md](references/agents/agent-grading-rubric.md).
|
|
251
|
+
`G_det` is the letter in CLI `Data.Grade`; never recompute it from issue counts. For judgment findings only, calculate `100 − (15 × Criticals) − (4 × Warnings) − (1 × Infos)`, floored at 0; map `85–100 A`, `65–84 B`, `45–64 C`, `25–44 D`, `0–24 F`. Any unmitigated judgment Critical caps at D; a security/data-integrity judgment Critical forces F. Architecture-principle scores do not affect the grade. For multiple agents use the worst grade, never an average. Show the binding constraint, for example `B — gated by G_det = CLI Data.Grade B; judgment clean (G_jud A)`. Use [agent-grading-rubric.md](references/agents/agent-grading-rubric.md) for omissions, edge cases, no-PDD/CLI/no-eval handling, and examples.
|
|
489
252
|
|
|
490
253
|
### Step 5 — Produce the Review Report
|
|
491
254
|
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
**Report rules — do not violate:**
|
|
495
|
-
|
|
496
|
-
1. NEVER use internal workflow labels in the output. Forbidden terms: "Path A", "Path B", "Step 3a", "Step 0c", "Mismatch"/"Aligned" (use "one-to-one" / "one-to-many" / "unclear"), "disqualifying criteria", "verdict". The report is for the user, not a trace of the skill's internal workflow.
|
|
497
|
-
2. Do NOT create a separate "Unit of Work Analysis" section. The shape observation is a one-liner in the Summary. If the shape analysis produces a concern, it becomes a normal numbered finding.
|
|
498
|
-
3. Size metrics per file type use **activity / variable / node counts**, not "lines". Lines are meaningless for XAML and misleading for any file. See "Structural Metrics" table below.
|
|
499
|
-
4. Low-code agent reviews omit some sections — see [agent-grading-rubric.md](references/agents/agent-grading-rubric.md#low-code-agent-reports--omit-these-sections).
|
|
500
|
-
5. Validation Status for Legacy projects says "Use `uipath-rpa` (Legacy mode) for Legacy-specific validation" — it does NOT say "Could not run" or "Failed". Legacy is supported indefinitely in Studio LTS; the `uip rpa` CLI targets Modern projects (Legacy mode uses the `uip rpa-legacy` CLI internally).
|
|
501
|
-
|
|
502
|
-
**Structural metrics to report (never "lines"):**
|
|
503
|
-
|
|
504
|
-
| File type | Metrics to use |
|
|
505
|
-
|---|---|
|
|
506
|
-
| `.xaml` | Activity count, max nesting depth, root-scope variable count, argument count, invoke-workflow count |
|
|
507
|
-
| `.cs` (coded workflow) | Method count, statement count (LOC excluding blank/comment), class count |
|
|
508
|
-
| `.flow` | Node count, gateway count, longest path depth, subflow count |
|
|
509
|
-
| `.py` (coded agent) | Function count, statement count, import count |
|
|
510
|
-
| Config (JSON/XLSX) | Entry count, nesting depth |
|
|
511
|
-
|
|
512
|
-
**Required report structure:**
|
|
513
|
-
|
|
514
|
-
```markdown
|
|
515
|
-
## Review Report: <Project or Solution Name>
|
|
516
|
-
|
|
517
|
-
### Summary
|
|
518
|
-
- **Overall Quality:** Good / Needs Improvement / Critical Issues
|
|
519
|
-
- **Agent Grade:** <A–F> — <verdict label> (<binding constraint, e.g. "gated by G_det = CLI Data.Grade B; judgment clean (G_jud A, 91)">) — *agent projects only; omit this line if the review has no agent projects*
|
|
520
|
-
- **Business Value:** <1-2 sentence description of what this automation does>
|
|
521
|
-
- **Review Scope:** Single project / Solution (N projects) / Multi-project repo (N executables + M libraries)
|
|
522
|
-
- **Project Types Found:** <list with type and language, e.g., "RPA (XAML, VisualBasic)", "Agent (Coded, Python)">
|
|
523
|
-
- **Validation Status:** <per project: pass with counts, or "Validation via uipath-rpa (Legacy mode)" for Legacy>
|
|
524
|
-
- **PDD Available:** Yes (path) / No — business logic alignment not verified
|
|
525
|
-
- **Transaction Shape:** <one line per project, e.g., "Processes 1 invoice per invocation (one-to-one)." or "Processes 1 company per invocation; internally writes N employee enrollments (one-to-many) — see [W-002].">
|
|
526
|
-
|
|
527
|
-
### PDD Alignment (only if PDD was available)
|
|
528
|
-
|
|
529
|
-
| PDD Requirement | Implementation Status | Finding |
|
|
530
|
-
|---|---|---|
|
|
531
|
-
| ... | ... | ... |
|
|
532
|
-
|
|
533
|
-
> If no PDD: "No PDD was available for this review. Business logic alignment could not be verified."
|
|
534
|
-
|
|
535
|
-
### Automated Validation Results
|
|
536
|
-
|
|
537
|
-
| Project | File | Command | Errors | Warnings | Info |
|
|
538
|
-
|---|---|---|---|---|---|
|
|
539
|
-
| ... | ... | ... | ... | ... | ... |
|
|
540
|
-
|
|
541
|
-
**Validation Details:** *(Errors and Warnings only — omit the heading entirely when there are none)*
|
|
542
|
-
- [V-E-001] <project>/<file>: **<rule-id>** — <message>
|
|
543
|
-
- [V-W-001] <project>/<file>: **<rule-id>** — <message>
|
|
255
|
+
Write the report in chat; **and when the task asks you to save it to a path (e.g. `./_review_report.md`), also write it to that exact path** (≥500 bytes). The read-only rule forbids creating or editing files **inside the project under review** — it does NOT forbid writing the requested report file. Do not use internal labels such as “Path A”, “Path B”, “Step 3a”, or “Step 0c”; do not use “Mismatch”, “Aligned”, “disqualifying criteria”, or “verdict”. Use one-to-one, one-to-many, or unclear. Do not create a Unit of Work Analysis section.
|
|
544
256
|
|
|
545
|
-
|
|
257
|
+
Required sections, in order:
|
|
546
258
|
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
| ID | Rule | Recommendation |
|
|
559
|
-
|---|---|---|
|
|
560
|
-
| C-D-001 | `LOWCODE_SYSTEM_MESSAGE_MISSING` | `ClassifierAgent/agent.json`: `messages[0]` (system role) has empty content. Set `messages[0].content` to a non-empty system prompt. |
|
|
561
|
-
| C-001 | — | `ProjectA/Helper.cs`: Password argument uses `String`. Change the argument type to `SecureString`. |
|
|
562
|
-
|
|
563
|
-
### Warnings (should fix before production)
|
|
564
|
-
|
|
565
|
-
| ID | Rule | Recommendation |
|
|
566
|
-
|---|---|---|
|
|
567
|
-
| W-D-002 | `LC_PROMPT_ROLE_DEFINITION` | `ClassifierAgent/agent.json`: System prompt starts with task instructions before defining the agent's role. Open with: "You are an X that does Y." |
|
|
568
|
-
|
|
569
|
-
### Improvement Opportunities
|
|
570
|
-
|
|
571
|
-
| ID | Rule | Recommendation |
|
|
572
|
-
|---|---|---|
|
|
573
|
-
| I-D-001 | `LC_GUARDRAIL_RECOMMENDED` | `ClassifierAgent/agent.json`: `inputSchema.properties` contains `customer_email` and `ssn` without a PII guardrail. Add an Agent-scope PII guardrail with a block action. |
|
|
574
|
-
|
|
575
|
-
> One row per finding. Format each recommendation as `<file>: <issue>. <fix>.` Use the CLI's `File`, `Description`, and `SuggestedFix` verbatim; keep judgment and manual findings concise. Review-CLI, judgment-catalog, and manual-checklist findings all go in these three tables — do not split them into separate sections by source, and never list a finding in more than one table. `Rule` is `—` for a finding with no `rule_id` (Critical Rule 12).
|
|
576
|
-
|
|
577
|
-
### Per-Project Summary
|
|
578
|
-
| Project | Type | Language | Size | Validation | Quality | Grade | Key Findings |
|
|
579
|
-
|---|---|---|---|---|---|---|---|
|
|
580
|
-
| ClassifierAgent | Agent (Coded) | Python | 14 functions, 220 statements | Pass | Good | B | W-D-002 |
|
|
581
|
-
| ProjectA | RPA (Coded) | CSharp | 42 methods, 1,300 statements | 1 error, 2 warnings | Needs Improvement | — | V-E-001, W-001 |
|
|
582
|
-
| ProjectB | Flow | — | 18 nodes, 3 gateways, depth 5 | Pass | Good | — | I-001 |
|
|
583
|
-
| ProjectC | RPA (XAML) | VisualBasic | 84 activities, 50 vars, depth 12 | Via uipath-rpa (Legacy mode) | Needs Improvement | — | C-002, W-003 |
|
|
584
|
-
|
|
585
|
-
> The **Grade** column is the per-agent `min(G_det, G_jud)` from Step 4.5 — **agent projects only** (`—` for other types, phase 1). Append the review CLI's `Data.Grade` when it differs, e.g. `B (CLI: A)`. The **Quality** column (Good / Needs Improvement / Critical Issues) applies to every project type.
|
|
586
|
-
|
|
587
|
-
### Recommended Next Steps
|
|
588
|
-
|
|
589
|
-
Route each fix to the appropriate skill:
|
|
590
|
-
|
|
591
|
-
| Fix needed | Use skill |
|
|
592
|
-
|---|---|
|
|
593
|
-
| Fix RPA workflow / coded workflow / XAML / project.json | `uipath-rpa` |
|
|
594
|
-
| Fix RPA Windows-Legacy project | `uipath-rpa` (Legacy mode) |
|
|
595
|
-
| Fix agent (coded or low-code) | `uipath-agents` |
|
|
596
|
-
| Fix flow (.flow) | `uipath-maestro-flow` |
|
|
597
|
-
| Fix Maestro BPMN (.bpmn) | `uipath-maestro-bpmn` |
|
|
598
|
-
| Fix API workflow (Workflow.json) | `uipath-api-workflow` |
|
|
599
|
-
| Fix coded app | `uipath-coded-apps` |
|
|
600
|
-
| Fix Orchestrator resources (assets, queues, folders) | `uipath-platform` |
|
|
601
|
-
| Fix `.uipx` solution / pack / publish / deploy lifecycle | `uipath-solution` |
|
|
602
|
-
|
|
603
|
-
1. Fix [C-001] using `uipath-rpa` — change argument type to SecureString
|
|
604
|
-
2. ...
|
|
605
|
-
|
|
606
|
-
### Optimization Notes
|
|
607
|
-
- <queue usage, bulk operations, retry/idempotency observations — e.g., partial-failure handling for one-to-many shapes. Only print section when optimization is relevant and applicable to the project or solution.>
|
|
608
|
-
|
|
609
|
-
**Final grade: <A–F>**
|
|
610
|
-
```
|
|
611
|
-
|
|
612
|
-
> **`Final grade:` is the report's last line — nothing follows it.** No notes, caveats, or commentary, inside the report or after it. It restates the Summary's `Agent Grade` letter so the grade stays visible at the tail of a long report; the two must always match. Letter only. Only print for agent projects.
|
|
613
|
-
|
|
614
|
-
**Finding severity labels (never "Mismatch"/"Aligned"):**
|
|
615
|
-
- Overall Quality: `Good` / `Needs Improvement` / `Critical Issues` (all project types)
|
|
616
|
-
- Agent Grade: `A` / `B` / `C` / `D` / `F` (no `+`/`-`) — agent projects only; see Step 4.5 and [agent-grading-rubric.md](references/agents/agent-grading-rubric.md)
|
|
617
|
-
- Transaction Shape: `one-to-one` / `one-to-many` / `unclear`
|
|
618
|
-
- Findings: `Critical` / `Warning` / `Info`
|
|
619
|
-
|
|
620
|
-
**Overall Quality thresholds** (all project types):
|
|
621
|
-
- **Good** — 0 Critical, 0–3 Warnings
|
|
622
|
-
- **Needs Improvement** — 0 Critical, 4+ Warnings OR 1 Critical with clear fix
|
|
623
|
-
- **Critical Issues** — 2+ Critical OR 1 Critical with security/data-integrity implications
|
|
624
|
-
|
|
625
|
-
**Agent Grade → verdict label** (agent projects only; the line reads "B — Good"):
|
|
626
|
-
|
|
627
|
-
| Grade | Verdict label |
|
|
628
|
-
|---|---|
|
|
629
|
-
| **A** / **B** | Good |
|
|
630
|
-
| **C** / **D** | Needs Improvement |
|
|
631
|
-
| **F** | Critical Issues |
|
|
259
|
+
1. `## Review Report: <name>`
|
|
260
|
+
2. `### Summary` — render as a **bullet list, not a table**. Bullets: Overall Quality; **Agent Grade** (agents only — exact form `- **Agent Grade:** <A–F> — <verdict>`, letter only, no `+`/`-`, keep any commentary in a later clause); Business Value; Review Scope; Project Types Found; Validation Status; PDD Available; Transaction Shape per project.
|
|
261
|
+
3. `### PDD Alignment` — only when a PDD is available.
|
|
262
|
+
4. `### Automated Validation Results` — counts table and Error/Warning details only.
|
|
263
|
+
5. `### Rules Skipped` — intended but unapplied rules only.
|
|
264
|
+
6. `### Critical Findings`, `### Warnings`, `### Improvement Opportunities` — one row per finding: `| <id> | <rule> | <file>: <issue>. <fix>. |`; use `—` when no `rule_id`; never duplicate or split findings by source.
|
|
265
|
+
7. `### Per-Project Summary` — Grade for agents and `—` otherwise; Quality for all. Report size as structural counts, never lines: `.xaml` activity/nesting/variable/argument counts, `.cs` method/statement counts, `.flow` node/gateway/depth counts, `.py` function/statement/import counts, config entry/nesting counts.
|
|
266
|
+
8. `### Recommended Next Steps` — route fixes to the appropriate skill.
|
|
267
|
+
9. `### Optimization Notes` — only when relevant.
|
|
268
|
+
10. `**Final grade: <A–F>**` — agents only, on its own line as the **last line** of the report (nothing after it); the letter **must match** the Summary Agent Grade.
|
|
632
269
|
|
|
633
|
-
|
|
270
|
+
Legacy validation status must say: `Use uipath-rpa (Legacy mode) for Legacy-specific validation`. Do not say “Could not run” or “Failed”. Legacy is supported indefinitely in Studio LTS and is not a Critical deployment blocker. Recommend migration based on actual needs. Overall Quality is **Good** for 0 Critical and 0–3 Warnings; **Needs Improvement** for 0 Critical and 4+ Warnings or 1 Critical with a clear fix; **Critical Issues** for 2+ Critical or 1 security/data-integrity Critical. For agents, A/B maps to Good, C/D to Needs Improvement, and F to Critical Issues. Never use “Mismatch” or “Aligned”.
|
|
634
271
|
|
|
635
272
|
## Task Navigation
|
|
636
273
|
|
|
637
|
-
|
|
|
274
|
+
| Need | Reference |
|
|
638
275
|
|---|---|
|
|
639
|
-
|
|
|
640
|
-
|
|
|
641
|
-
|
|
|
642
|
-
|
|
|
643
|
-
|
|
|
644
|
-
|
|
|
645
|
-
|
|
|
646
|
-
|
|
|
647
|
-
|
|
|
648
|
-
|
|
|
649
|
-
|
|
|
650
|
-
|
|
|
651
|
-
|
|
|
652
|
-
|
|
|
653
|
-
|
|
|
654
|
-
|
|
|
655
|
-
|
|
|
656
|
-
|
|
|
657
|
-
|
|
|
658
|
-
|
|
|
659
|
-
|
|
|
660
|
-
|
|
661
|
-
## Anti-Patterns
|
|
662
|
-
|
|
663
|
-
1. **
|
|
664
|
-
2.
|
|
665
|
-
3.
|
|
666
|
-
4.
|
|
667
|
-
5. **Do not provide a review without severity ratings.** Every finding must be Critical, Warning, or Info. An undifferentiated list of issues is not actionable.
|
|
668
|
-
6. **Do not recommend architecture changes without understanding business context.** Ask about volume, frequency, SLA, and error tolerance before suggesting queue-based processing, parallel execution, or other architectural patterns.
|
|
669
|
-
7. **Do not attempt to fix issues yourself.** Report the issue, suggest the fix, name the skill that can apply it. Stop there.
|
|
670
|
-
8. **Do not flag Windows-Legacy compatibility as Critical.** Legacy is supported **indefinitely** in Studio LTS — 2024.10, 2025.10, 2026.10, and all future LTS releases continue to support creating, opening, editing, running, and deploying Legacy projects. It is NOT a deployment blocker and NOT a mid-term support risk. Deprecation means "no new features added to Legacy," not "Legacy will be removed." Flag as **Warning** (if the project would benefit from capabilities Legacy lacks — see [rpa-review-checklist.md §10](references/rpa/rpa-review-checklist.md) for ranked feature list) or **Info** (if Studio LTS is the organizational standard or SOAP web services are required). When recommending migration, lead with the 2-3 features most relevant to the project's actual pain (typically **Healing Agent**, **Unified Target / Modern UIA**, **Object Repository**, **ScreenPlay**, **coded test cases**, **Autopilot**, **Agents/Maestro**). Route Legacy-specific deep validation to `uipath-rpa` (Legacy mode).
|
|
671
|
-
9. **Do not recommend removing a dependency without grepping for usages.** A package may be the sole supplier of an activity used elsewhere — recommend removal only after confirming no consumers exist.
|
|
672
|
-
10. **Do not flag `-preview` package versions.** Many UiPath packages currently ship preview-by-default during the public preview phase, and resolution defaults to bringing them in with explicit user confirmation. Surface stability concerns through activity-owner channels, not user-facing review reports.
|
|
673
|
-
11. **Do not run scripts or install Python packages from this skill.** Deterministic checks run in the `uip agent review` / `uip codedagent review` CLI (Step 2.5a), not via scripts. The skill itself ships no executable code.
|
|
276
|
+
| Agent grade | [agent-grading-rubric.md](references/agents/agent-grading-rubric.md) |
|
|
277
|
+
| Rule schema | [rule-format.md](references/rule-format.md) |
|
|
278
|
+
| Review CLI/catalog workflow | [rule-catalog-workflow.md](references/rule-catalog-workflow.md) |
|
|
279
|
+
| Low-code catalog | [agents-lowcode-rules.md](references/agents/agents-lowcode-rules.md) |
|
|
280
|
+
| Coded catalog | [agents-coded-rules.md](references/agents/agents-coded-rules.md) |
|
|
281
|
+
| Full workflow | [review-workflow-guide.md](references/review-workflow-guide.md) |
|
|
282
|
+
| Solution | [solution-review-guide.md](references/solution-review-guide.md) |
|
|
283
|
+
| RPA | [rpa-review-checklist.md](references/rpa/rpa-review-checklist.md) |
|
|
284
|
+
| RPA common issues | [rpa-common-issues.md](references/rpa/rpa-common-issues.md) |
|
|
285
|
+
| Flow | [flow-review-checklist.md](references/flows/flow-review-checklist.md) |
|
|
286
|
+
| Flow common issues | [flow-common-issues.md](references/flows/flow-common-issues.md) |
|
|
287
|
+
| BPMN | [bpmn-review-checklist.md](references/bpmn/bpmn-review-checklist.md) |
|
|
288
|
+
| API workflow | [api-workflow-review-checklist.md](references/api-workflows/api-workflow-review-checklist.md) |
|
|
289
|
+
| Coded app | [coded-app-review-checklist.md](references/coded-apps/coded-app-review-checklist.md) |
|
|
290
|
+
| Platform resources | [platform-resources-checklist.md](references/platform/platform-resources-checklist.md) |
|
|
291
|
+
| RPA deep dive | [rpa-advanced-checklist.md](references/rpa/rpa-advanced-checklist.md) |
|
|
292
|
+
| Long-running workflow | [long-running-workflow-issues.md](references/rpa/long-running-workflow-issues.md) |
|
|
293
|
+
| Modern Studio | [modern-studio-issues.md](references/rpa/modern-studio-issues.md) |
|
|
294
|
+
| Document Understanding | [du-review-checklist.md](references/document-understanding/du-review-checklist.md) |
|
|
295
|
+
| Architecture | [architecture-assessment-guide.md](references/architecture-assessment-guide.md) |
|
|
296
|
+
| DevOps readiness | [devops-readiness-checklist.md](references/devops-readiness-checklist.md) |
|
|
297
|
+
|
|
298
|
+
## Anti-Patterns
|
|
299
|
+
|
|
300
|
+
1. **Never flag Windows-Legacy (absent or `Legacy` `targetFramework`) as a Critical issue** — the Legacy targetFramework itself is never a Critical finding or deployment blocker; it is supported indefinitely in Studio LTS. Flag Warning only when relevant capabilities are missing; otherwise Info. Recommend migration based on actual needs, especially Healing Agent, Unified Target/Modern UIA, Object Repository, ScreenPlay, coded test cases, Autopilot, or Agents/Maestro. Route deep validation to `uipath-rpa` Legacy mode. **On a clean Legacy project, do not let Overall Quality read as "Critical Issues" on account of the Legacy runtime, an incomplete/stubbed integration, or a design gap — those are Warnings unless you have concrete evidence of a shipped security or data-integrity defect. If you do cite a genuine Critical, its recommendation must state plainly that it is unrelated to the Windows-Legacy targetFramework** (never place the Legacy label and a Critical rating together without that disclaimer).
|
|
301
|
+
2. Do not recommend removing a dependency until usages have been searched and no consumers remain.
|
|
302
|
+
3. Do not flag `-preview` package versions; address stability through activity-owner channels rather than the user-facing report.
|
|
303
|
+
4. Do not run scripts or install Python packages. Deterministic checks belong in `uip agent review` or `uip codedagent review`; the skill ships no executable code.
|