@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
|
@@ -12,6 +12,7 @@ Capability index for `uip maestro flow eval` — evaluator CRUD (7 types), eval
|
|
|
12
12
|
- Create evaluators (`exact-match`, `json-similarity`, `contains`, `llm-judge-*` types) for a Flow project
|
|
13
13
|
- Create or remove eval sets, link them to evaluators, pin entry points
|
|
14
14
|
- Add, list, or remove simulations on data points (`uip maestro flow eval simulation`)
|
|
15
|
+
- Add, list, or remove child tool simulations on agent nodes (`--parent` flag)
|
|
15
16
|
- Start an eval run on Studio Web, poll its status, fetch detailed results
|
|
16
17
|
- Compare two eval runs to verify a change improved scores without regressions
|
|
17
18
|
|
|
@@ -20,7 +21,7 @@ For agent (`agent.json`) evaluations read the `uipath-agents` skill. For BPMN ev
|
|
|
20
21
|
## Critical rules
|
|
21
22
|
|
|
22
23
|
1. **Check Flow eval CLI availability once.** Run `uip maestro flow eval --help --output json` before using eval commands. If it returns `unknown command 'eval'`, the installed CLI does not expose Flow eval yet. Stop, report that the user needs a CLI/tool version with Flow eval support, and do not spend turns searching npm packages or source bundles.
|
|
23
|
-
2. **Never run `uip solution upload` automatically as part of an eval workflow.** The eval run requires the Flow solution to already exist in Studio Web, but uploading from the local working tree clobbers whatever is on Studio Web. If the project was pulled from Studio Web (`uip solution download`), edited locally in VS Code, or scaffolded on disk and never uploaded, an unprompted upload will overwrite or push unintended state. Ask the user explicitly before any `uip solution upload` — see [upload-safety.md](
|
|
24
|
+
2. **Never run `uip solution upload` automatically as part of an eval workflow.** The eval run requires the Flow solution to already exist in Studio Web, but uploading from the local working tree clobbers whatever is on Studio Web. If the project was pulled from Studio Web (`uip solution download`), edited locally in VS Code, or scaffolded on disk and never uploaded, an unprompted upload will overwrite or push unintended state. Ask the user explicitly before any `uip solution upload` — see [upload-safety.md](upload-safety.md).
|
|
24
25
|
3. **`--path` accepts a Flow project directory OR a solution directory containing exactly one Flow project.** If the solution holds multiple Flow projects, point `--path` at the specific project directory.
|
|
25
26
|
4. **Local CRUD does not require login.** `add`, `remove`, `list` (data points / eval sets / evaluators) edit JSON on disk. Only `uip maestro flow eval run *` requires `uip login` and an existing Studio Web solution.
|
|
26
27
|
5. **Pin a model on every LLM-judge evaluator.** Empty/missing `model` produces a cryptic 500 from the LLM gateway after retries. Pass `--model <name>` on `evaluator add` or set `model` in the JSON.
|
|
@@ -73,33 +74,34 @@ uip maestro flow eval run results <eval_set_run_id> \
|
|
|
73
74
|
|
|
74
75
|
| Journey | Read |
|
|
75
76
|
| --- | --- |
|
|
76
|
-
| Look up any `uip maestro flow eval` subcommand syntax, flags, defaults, output codes | [commands-reference.md](
|
|
77
|
-
| Choose among the 7 evaluator types, write custom prompts, hand-write evaluator JSON | [evaluators-guide.md](
|
|
78
|
-
| Create eval sets, add data points, map `--inputs`/`--expected`/`--criteria` to evaluator types, attach files | [eval-sets-guide.md](
|
|
79
|
-
| Start a Studio Web run, poll status, read results, export CSV/JSON, compare two runs | [running-guide.md](
|
|
80
|
-
| Decide whether to call `uip solution upload` (almost always: don't auto-run; ask first) | [upload-safety.md](
|
|
77
|
+
| Look up any `uip maestro flow eval` subcommand syntax, flags, defaults, output codes | [commands-reference.md](commands-reference.md) |
|
|
78
|
+
| Choose among the 7 evaluator types, write custom prompts, hand-write evaluator JSON | [evaluators-guide.md](evaluators-guide.md) |
|
|
79
|
+
| Create eval sets, add data points, map `--inputs`/`--expected`/`--criteria` to evaluator types, attach files | [eval-sets-guide.md](eval-sets-guide.md) |
|
|
80
|
+
| Start a Studio Web run, poll status, read results, export CSV/JSON, compare two runs | [running-guide.md](running-guide.md) |
|
|
81
|
+
| Decide whether to call `uip solution upload` (almost always: don't auto-run; ask first) | [upload-safety.md](upload-safety.md) |
|
|
81
82
|
|
|
82
83
|
## Common tasks
|
|
83
84
|
|
|
84
85
|
| I need to... | Read these |
|
|
85
86
|
| --- | --- |
|
|
86
|
-
| **Add an evaluator** | [evaluators-guide.md](
|
|
87
|
-
| **Pick the right evaluator type** | [evaluators-guide.md — When to Pick Each Type](
|
|
88
|
-
| **Create an eval set and pin an entry point** | [eval-sets-guide.md — Eval Set Lifecycle](
|
|
89
|
-
| **Add a data point with file attachments** | [eval-sets-guide.md — `--input-file`](
|
|
90
|
-
| **Set per-data-point criteria for trajectory evaluators** | [eval-sets-guide.md — `--criteria`](
|
|
91
|
-
| **Add a simulation to a data point** | [eval-sets-guide.md — Simulations](
|
|
92
|
-
| **
|
|
93
|
-
| **
|
|
94
|
-
| **
|
|
95
|
-
| **
|
|
96
|
-
| **
|
|
97
|
-
| **
|
|
98
|
-
| **
|
|
87
|
+
| **Add an evaluator** | [evaluators-guide.md](evaluators-guide.md) + [commands-reference.md — Evaluators](commands-reference.md#evaluators) |
|
|
88
|
+
| **Pick the right evaluator type** | [evaluators-guide.md — When to Pick Each Type](evaluators-guide.md#when-to-pick-each-type) |
|
|
89
|
+
| **Create an eval set and pin an entry point** | [eval-sets-guide.md — Eval Set Lifecycle](eval-sets-guide.md#eval-set-lifecycle) |
|
|
90
|
+
| **Add a data point with file attachments** | [eval-sets-guide.md — `--input-file`](eval-sets-guide.md#--input-file-keypath) |
|
|
91
|
+
| **Set per-data-point criteria for trajectory evaluators** | [eval-sets-guide.md — `--criteria`](eval-sets-guide.md#--criteria) |
|
|
92
|
+
| **Add a simulation to a data point** | [eval-sets-guide.md — Simulations](eval-sets-guide.md#simulations-on-data-points) + [commands-reference.md — Simulations](commands-reference.md#simulations) |
|
|
93
|
+
| **Add a child tool simulation to an agent node** | [eval-sets-guide.md — Child Simulations](eval-sets-guide.md#child-simulations-agent-tool-simulation) + [commands-reference.md — Simulations](commands-reference.md#simulations) |
|
|
94
|
+
| **Start a Studio Web eval run** | [running-guide.md — Start a Run](running-guide.md#start-a-run) |
|
|
95
|
+
| **Poll run status without `--wait`** | [running-guide.md — Check Status](running-guide.md#check-status) |
|
|
96
|
+
| **Inspect only failed data points** | [running-guide.md — Detailed Results](running-guide.md#detailed-results) (`--only-failed --verbose`) |
|
|
97
|
+
| **Compare two runs side-by-side** | [running-guide.md — Compare Two Runs](running-guide.md#compare-two-runs) |
|
|
98
|
+
| **Decide whether to call `uip solution upload`** | [upload-safety.md](upload-safety.md) |
|
|
99
|
+
| **Look up the `eval` subcommand tree, flags, defaults, output codes** | [commands-reference.md](commands-reference.md) |
|
|
100
|
+
| **My eval run failed** | [running-guide.md — Failure Detection](running-guide.md#failure-detection); for flow-level faults [diagnose/CAPABILITY.md](../diagnose/CAPABILITY.md) |
|
|
99
101
|
|
|
100
102
|
## Anti-patterns
|
|
101
103
|
|
|
102
|
-
- **Don't auto-run `uip solution upload`.** Even when an eval run errors with "solution not found in Studio Web", stop and ask the user — see [upload-safety.md](
|
|
104
|
+
- **Don't auto-run `uip solution upload`.** Even when an eval run errors with "solution not found in Studio Web", stop and ask the user — see [upload-safety.md](upload-safety.md). The local project may be ahead of, or diverged from, Studio Web.
|
|
103
105
|
- **Don't hand-write `evaluatorRefs` unless you are repairing an eval set.** Prefer the default all-evaluators behavior so the CLI writes generated file refs, or pass generated evaluator ids/file refs explicitly. Do not pass evaluator display names to `--evaluators`.
|
|
104
106
|
- **Don't pass `--type` in PascalCase.** Only kebab-case is accepted: `exact-match`, `json-similarity`, `contains`, `llm-judge-output`, `llm-judge-strict-json`, `llm-judge-trajectory`, `llm-judge-trajectory-simulation`.
|
|
105
107
|
- **Don't depend on a specific `--wait` polling cadence.** Treat `--wait` as a black-box block; if you need precise progress, omit it and call `eval run status` yourself.
|
|
@@ -120,11 +122,11 @@ After a run completes, report:
|
|
|
120
122
|
|
|
121
123
|
### Evaluate-scoped
|
|
122
124
|
|
|
123
|
-
- [commands-reference.md](
|
|
124
|
-
- [evaluators-guide.md](
|
|
125
|
-
- [eval-sets-guide.md](
|
|
126
|
-
- [running-guide.md](
|
|
127
|
-
- [upload-safety.md](
|
|
125
|
+
- [commands-reference.md](commands-reference.md) — every `uip maestro flow eval` subcommand, flags, defaults, output `Code` enum
|
|
126
|
+
- [evaluators-guide.md](evaluators-guide.md) — 7 evaluator types mapped to internal `uipath-*` IDs, JSON shapes, template variables
|
|
127
|
+
- [eval-sets-guide.md](eval-sets-guide.md) — eval set + data point CRUD, `--inputs`/`--expected`/`--criteria`/`--input-file`/`--search-text`, simulations
|
|
128
|
+
- [running-guide.md](running-guide.md) — run start/status/results/list/compare, JMESPath `--output-filter`, failure detection
|
|
129
|
+
- [upload-safety.md](upload-safety.md) — the `solution upload` rule
|
|
128
130
|
|
|
129
131
|
### Cross-capability (shared)
|
|
130
132
|
|
|
@@ -141,25 +141,30 @@ Add or replace a simulation on a data point. If a simulation for `<component-id>
|
|
|
141
141
|
| `--set <name>` | Yes | Eval set name or ID |
|
|
142
142
|
| `--data-point <id>` | Yes | Data point name or ID |
|
|
143
143
|
| `--strategy <strategy>` | Yes | `Llm` or `Static` |
|
|
144
|
-
| `--component-type <type>` |
|
|
144
|
+
| `--component-type <type>` | No | Component type (e.g. `connector`, `agent`, `subflow`). Required unless `--parent` is used (defaults to `Node`). |
|
|
145
145
|
| `--component-description <text>` | No | Human-readable label for the component |
|
|
146
146
|
| `--simulation-instructions <text>` | No | LLM prompt describing what the component should return (for `Llm` strategy) |
|
|
147
147
|
| `--mock-value <json>` | No | Static JSON output (for `Static` strategy) |
|
|
148
|
-
| `--
|
|
148
|
+
| `--parent <component-id>` | No | Parent agent node component ID. When set, the simulation is added as a child tool simulation nested inside the parent agent node's simulation. If no parent simulation exists yet, one is auto-created (type `agent`, strategy `Llm`). `--component-type` defaults to `Node`. |
|
|
149
149
|
| `--path <path>` | No | (see Common Options) |
|
|
150
150
|
|
|
151
151
|
**Strategy guide:**
|
|
152
152
|
|
|
153
153
|
| Strategy | When to use | Key flags |
|
|
154
154
|
|----------|-------------|-----------|
|
|
155
|
-
| `Llm` | Output should be realistic but non-deterministic | `--simulation-instructions
|
|
155
|
+
| `Llm` | Output should be realistic but non-deterministic | `--simulation-instructions` (output schema auto-resolved) |
|
|
156
156
|
| `Static` | Output is fixed and deterministic | `--mock-value` |
|
|
157
157
|
|
|
158
|
-
|
|
158
|
+
**Output schema auto-resolution:** The CLI always auto-resolves the output schema for both top-level and child (`--parent`) simulations:
|
|
159
159
|
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
160
|
+
- **Top-level simulations:** reads the `.flow` file, finds the node by `<component-id>`, and derives the schema from the node's output definition (connector `outputJsonSchema`, agent `agentOutputVariables`, or `node.outputs`).
|
|
161
|
+
- **Child simulations (inline canvas agents):** finds the child tool node via edges in the `.flow` file and extracts its output schema.
|
|
162
|
+
- **Child simulations (same-solution agents):** reads the inline agent's `agent.json` and matches the tool by name in the `resources[]` array.
|
|
163
|
+
- **Child simulations (published agents):** calls the platform API (`simulatableComponents`) using the current login session to fetch the tool's schema. Requires `uip login`.
|
|
164
|
+
|
|
165
|
+
Fails with an actionable error if the node/tool is not found or has no outputs.
|
|
166
|
+
|
|
167
|
+
**Static mock value validation:** For `Static` child simulations, the CLI validates that `--mock-value` keys match the auto-resolved schema properties, catching shape mismatches early.
|
|
163
168
|
|
|
164
169
|
Example — LLM strategy:
|
|
165
170
|
|
|
@@ -185,6 +190,33 @@ uip maestro flow eval simulation add agent-lookup \
|
|
|
185
190
|
--path ./MySolution/MyFlow --output json
|
|
186
191
|
```
|
|
187
192
|
|
|
193
|
+
Example — Child simulation (tool inside an agent node):
|
|
194
|
+
|
|
195
|
+
```bash
|
|
196
|
+
# Add a child tool simulation (Static). No separate parent simulation step
|
|
197
|
+
# needed — --parent auto-creates the parent if it does not exist.
|
|
198
|
+
# Output schema is auto-resolved from the agent's tool definitions.
|
|
199
|
+
uip maestro flow eval simulation add Web_Search \
|
|
200
|
+
--parent agent-lookup \
|
|
201
|
+
--set "Smoke Tests" \
|
|
202
|
+
--data-point "hello-test" \
|
|
203
|
+
--strategy Static \
|
|
204
|
+
--mock-value '{"results": [{"title": "Example", "url": "https://example.com"}]}' \
|
|
205
|
+
--path ./MySolution/MyFlow --output json
|
|
206
|
+
|
|
207
|
+
# Add a child tool simulation (Llm). Output schema auto-resolved —
|
|
208
|
+
# works for inline, same-solution, and published agents.
|
|
209
|
+
uip maestro flow eval simulation add Send_Email \
|
|
210
|
+
--parent agent-lookup \
|
|
211
|
+
--set "Smoke Tests" \
|
|
212
|
+
--data-point "hello-test" \
|
|
213
|
+
--strategy Llm \
|
|
214
|
+
--simulation-instructions "Return a success status with a generated messageId." \
|
|
215
|
+
--path ./MySolution/MyFlow --output json
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
The child's `<component-id>` is the tool's **runtime name** (e.g. `Web_Search`, `Send_Email`), not a `.flow` node ID. Child simulations are stored in the parent's `childSimulations` array.
|
|
219
|
+
|
|
188
220
|
### `uip maestro flow eval simulation list`
|
|
189
221
|
|
|
190
222
|
List all simulations configured on a data point.
|
|
@@ -193,13 +225,22 @@ List all simulations configured on a data point.
|
|
|
193
225
|
|------|----------|-------------|
|
|
194
226
|
| `--set <name>` | Yes | Eval set name or ID |
|
|
195
227
|
| `--data-point <id>` | Yes | Data point name or ID |
|
|
228
|
+
| `--parent <component-id>` | No | Parent agent component ID. When set, lists child tool simulations on that parent instead of top-level simulations. |
|
|
196
229
|
| `--path <path>` | No | (see Common Options) |
|
|
197
230
|
|
|
198
231
|
```bash
|
|
232
|
+
# List top-level simulations
|
|
199
233
|
uip maestro flow eval simulation list \
|
|
200
234
|
--set "Smoke Tests" \
|
|
201
235
|
--data-point "hello-test" \
|
|
202
236
|
--path ./MySolution/MyFlow --output json
|
|
237
|
+
|
|
238
|
+
# List child simulations on an agent node
|
|
239
|
+
uip maestro flow eval simulation list \
|
|
240
|
+
--parent agent-lookup \
|
|
241
|
+
--set "Smoke Tests" \
|
|
242
|
+
--data-point "hello-test" \
|
|
243
|
+
--path ./MySolution/MyFlow --output json
|
|
203
244
|
```
|
|
204
245
|
|
|
205
246
|
### `uip maestro flow eval simulation remove <component-id>`
|
|
@@ -210,13 +251,22 @@ Remove a simulation from a data point. Returns an error if no simulation with th
|
|
|
210
251
|
|------|----------|-------------|
|
|
211
252
|
| `--set <name>` | Yes | Eval set name or ID |
|
|
212
253
|
| `--data-point <id>` | Yes | Data point name or ID |
|
|
254
|
+
| `--parent <component-id>` | No | Parent agent component ID. When set, removes a child tool simulation from the parent instead of a top-level simulation. |
|
|
213
255
|
| `--path <path>` | No | (see Common Options) |
|
|
214
256
|
|
|
215
257
|
```bash
|
|
258
|
+
# Remove a top-level simulation
|
|
216
259
|
uip maestro flow eval simulation remove connector-send-email \
|
|
217
260
|
--set "Smoke Tests" \
|
|
218
261
|
--data-point "hello-test" \
|
|
219
262
|
--path ./MySolution/MyFlow --output json
|
|
263
|
+
|
|
264
|
+
# Remove a child simulation from an agent node
|
|
265
|
+
uip maestro flow eval simulation remove Web_Search \
|
|
266
|
+
--parent agent-lookup \
|
|
267
|
+
--set "Smoke Tests" \
|
|
268
|
+
--data-point "hello-test" \
|
|
269
|
+
--path ./MySolution/MyFlow --output json
|
|
220
270
|
```
|
|
221
271
|
|
|
222
272
|
## Run
|
|
@@ -296,6 +346,7 @@ The CLI emits a `Code` field on every JSON response. Useful when filtering or sc
|
|
|
296
346
|
| `eval set add` / `list` / `remove` | `FlowEvalSetAdd` / `FlowEvalSetList` / `FlowEvalSetRemove` |
|
|
297
347
|
| `eval evaluator add` / `list` / `remove` | `FlowEvalEvaluatorAdd` / `FlowEvalEvaluatorList` / `FlowEvalEvaluatorRemove` |
|
|
298
348
|
| `eval simulation add` / `list` / `remove` | `FlowEvalSimulationAdd` / `FlowEvalSimulationList` / `FlowEvalSimulationRemove` |
|
|
349
|
+
| `eval simulation add --parent` / `list --parent` / `remove --parent` | `FlowEvalChildSimulationAdd` / `FlowEvalChildSimulationList` / `FlowEvalChildSimulationRemove` |
|
|
299
350
|
| `eval run start` (no `--wait`) | `FlowEvalRunStarted` |
|
|
300
351
|
| `eval run start --wait` (summary) | `FlowEvalRunCompleted` |
|
|
301
352
|
| `eval run status` | `FlowEvalRunStatus` |
|
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
# Eval Sets and Data Points
|
|
2
|
+
|
|
3
|
+
An eval set is a JSON file containing test cases (data points) and evaluators. A Flow project may have multiple sets, typically one per scenario.
|
|
4
|
+
|
|
5
|
+
## Eval Set Lifecycle
|
|
6
|
+
|
|
7
|
+
Run:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
uip maestro flow eval set add "<set_name>" \
|
|
11
|
+
[--evaluators <ref1>,<ref2>] \
|
|
12
|
+
[--entry-point <node_id>] \
|
|
13
|
+
--path <flow_project> --output json
|
|
14
|
+
|
|
15
|
+
uip maestro flow eval set list --path <flow_project> --output json
|
|
16
|
+
|
|
17
|
+
uip maestro flow eval set remove "<id_or_name>" --path <flow_project> --output json
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
`--evaluators` accepts comma-separated evaluator IDs or generated file base names. If omitted, the set links to all evaluators present at creation and writes generated evaluator file refs such as `greeting-match-62c0793a.json`; prefer omission when using every current evaluator. Do not pass an evaluator display name such as `greeting-match`: this writes the display name into `evaluatorRefs`, which Studio Web eval runs cannot resolve. For an explicit list, run `uip maestro flow eval evaluator add/list --output json` and pass the generated ID/file ref. Evaluators added later are not auto-attached; rerun `set add` with explicit generated refs or carefully repair `evaluatorRefs` using CLI-created evaluator file refs.
|
|
21
|
+
|
|
22
|
+
`--entry-point` is stored as `selectedEntrypoint` and accepts `/Main.bpmn#start` or a start node ID such as `start_a1b2c3d4`. `eval run start` uses it unless overridden with `--entry-point`. Pin it when multiple entry points exist; otherwise the first start node found is used.
|
|
23
|
+
|
|
24
|
+
## Data Point Lifecycle
|
|
25
|
+
|
|
26
|
+
Data points live inline in the eval set JSON. Run:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
uip maestro flow eval add "<data_point_name>" \
|
|
30
|
+
--set "<set_name>" \
|
|
31
|
+
--inputs '{"...":"..."}' \
|
|
32
|
+
[--expected '{"...":"..."}'] \
|
|
33
|
+
[--criteria '{"<evaluator_id>": {...}}'] \
|
|
34
|
+
[--input-file <key>=<path>] \
|
|
35
|
+
[--search-text "<text>"] \
|
|
36
|
+
--path <flow_project> --output json
|
|
37
|
+
|
|
38
|
+
uip maestro flow eval list --set "<set_name>" --path <flow_project> --output json
|
|
39
|
+
|
|
40
|
+
uip maestro flow eval remove "<id_or_name>" --set "<set_name>" --path <flow_project> --output json
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
<a id="--criteria"></a>
|
|
44
|
+
<a id="--input-file-keypath"></a>
|
|
45
|
+
### Inputs, Expected Values, and Criteria
|
|
46
|
+
|
|
47
|
+
`--inputs` must contain only keys matching the chosen entry point's declared input variables. If a variable is missing, add it or change the input JSON. To add a string input named `name`, run:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
uip maestro flow variable add ./MySolution/MyFlow/MyFlow.flow name \
|
|
51
|
+
--direction in --type string --output json
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Evaluator behavior:
|
|
55
|
+
|
|
56
|
+
- `exact-match`: compares output verbatim, or `expected[targetKey]` when the evaluator has `--target-key`.
|
|
57
|
+
- `json-similarity`: tree-compares with tolerance.
|
|
58
|
+
- `contains`: does not use `--expected`; use `--search-text`.
|
|
59
|
+
- `llm-judge-output`: substitutes `--expected` into `{{ExpectedOutput}}`.
|
|
60
|
+
- `llm-judge-strict-json`: substitutes it per key into `{{ExpectedOutput}}`.
|
|
61
|
+
- `llm-judge-trajectory`: uses it with `--expected-agent-behavior` set through `--criteria`.
|
|
62
|
+
- `llm-judge-trajectory-simulation`: behaves like `trajectory`, with simulation context.
|
|
63
|
+
|
|
64
|
+
`--criteria` contains per-evaluator overrides keyed by evaluator ID. Use it when evaluators in one set need different criteria:
|
|
65
|
+
|
|
66
|
+
```json
|
|
67
|
+
{
|
|
68
|
+
"<evaluator_ref_for_trajectory>": {
|
|
69
|
+
"expectedAgentBehavior": "Agent calls the weather tool with the user's location, then returns a one-sentence summary."
|
|
70
|
+
},
|
|
71
|
+
"<evaluator_ref_for_output>": {
|
|
72
|
+
"expectedOutput": {"summary": "Sunny in NYC, 72°F"}
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
When omitted, output evaluators fall back to `--expected` and trajectory evaluators use defaults. Always provide `expectedAgentBehavior` for trajectory evaluators; scoring against an empty `{{ExpectedAgentBehavior}}` is meaningless.
|
|
78
|
+
|
|
79
|
+
### File and Contains Inputs
|
|
80
|
+
|
|
81
|
+
`--input-file <key>=<path>` is repeatable and attaches a staged file under the specified key for runtime use, including PDFs, CSVs, and images. Do not delete the source before the run completes.
|
|
82
|
+
|
|
83
|
+
`--search-text` is for `contains` evaluators. It attaches the substring to test and is equivalent to writing `criteria` for that evaluator.
|
|
84
|
+
|
|
85
|
+
## Eval Set JSON Shape
|
|
86
|
+
|
|
87
|
+
```json
|
|
88
|
+
{
|
|
89
|
+
"id": "<uuid>",
|
|
90
|
+
"name": "Smoke Tests",
|
|
91
|
+
"version": "1.0",
|
|
92
|
+
"evaluatorRefs": ["<evaluator-file-ref-1>.json", "<evaluator-file-ref-2>.json"],
|
|
93
|
+
"selectedEntrypoint": "/Main.bpmn#start",
|
|
94
|
+
"evaluations": [
|
|
95
|
+
{
|
|
96
|
+
"id": "<uuid>",
|
|
97
|
+
"name": "hello-test",
|
|
98
|
+
"inputs": {"message": "hello"},
|
|
99
|
+
"expectedOutput": {"reply": "Hello! How can I help you?"},
|
|
100
|
+
"evaluationCriterias": {
|
|
101
|
+
"<evaluator-ref-2>": {
|
|
102
|
+
"expectedAgentBehavior": "Agent responds with a friendly greeting."
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
]
|
|
107
|
+
}
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Keep `version: "1.0"`; it identifies the new eval format. <!-- version-check-skip --> (eval-set file schema version, CLI-emitted by `eval set add` — not a `.flow` version)
|
|
111
|
+
|
|
112
|
+
- `evaluatorRefs` references CLI-generated evaluator files; prefer CLI commands over hand-editing.
|
|
113
|
+
- `selectedEntrypoint` pins the set's entry point; override it per run with `eval run start --entry-point`.
|
|
114
|
+
- `evaluations[]` is the inline data-point list; order is informational.
|
|
115
|
+
- `evaluationCriterias` (plural) maps per-data-point, per-evaluator overrides.
|
|
116
|
+
|
|
117
|
+
## Aligning Inputs with the Flow Schema
|
|
118
|
+
|
|
119
|
+
The data point's `inputs` must match the chosen entry point's input schema. Mismatches produce errors such as `Input "name" is not declared as an input variable in the flow`. Before adding data points, inspect `<flow>.flow` for `variables` entries with `direction: "in"`, or run:
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
uip maestro flow variable list <flow_file> --output json
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
## Simulations on Data Points
|
|
126
|
+
|
|
127
|
+
Simulations replace selected nodes during an eval run with controlled outputs. Target a component by its `.flow` node `id`. Run:
|
|
128
|
+
|
|
129
|
+
```bash
|
|
130
|
+
uip maestro flow eval simulation add <component-id> \
|
|
131
|
+
--set "<set_name>" \
|
|
132
|
+
--data-point "<data_point_name>" \
|
|
133
|
+
--strategy Llm \
|
|
134
|
+
--component-type connector \
|
|
135
|
+
--simulation-instructions "Pretend to send the email and return success." \
|
|
136
|
+
--path <flow_project> --output json
|
|
137
|
+
|
|
138
|
+
uip maestro flow eval simulation add <component-id> \
|
|
139
|
+
--set "<set_name>" \
|
|
140
|
+
--data-point "<data_point_name>" \
|
|
141
|
+
--strategy Static \
|
|
142
|
+
--component-type agent \
|
|
143
|
+
--mock-value '{"status":"ok"}' \
|
|
144
|
+
--path <flow_project> --output json
|
|
145
|
+
|
|
146
|
+
uip maestro flow eval simulation list \
|
|
147
|
+
--set "<set_name>" \
|
|
148
|
+
--data-point "<data_point_name>" \
|
|
149
|
+
--path <flow_project> --output json
|
|
150
|
+
|
|
151
|
+
uip maestro flow eval simulation remove <component-id> \
|
|
152
|
+
--set "<set_name>" \
|
|
153
|
+
--data-point "<data_point_name>" \
|
|
154
|
+
--path <flow_project> --output json
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
| Strategy | Use | Required or relevant flags |
|
|
158
|
+
|---|---|---|
|
|
159
|
+
| `Llm` | Plausible, non-deterministic output | `--simulation-instructions` (output schema auto-resolved) |
|
|
160
|
+
| `Static` | Identical output every run | `--mock-value <json>` |
|
|
161
|
+
|
|
162
|
+
The output schema is always auto-resolved — for both top-level and child (`--parent`) simulations. Top-level reads the `.flow` node outputs; child simulations resolve from the `.flow` edges (inline agents), `agent.json` resources (same-solution agents), or the platform API (published agents, requires `uip login`).
|
|
163
|
+
|
|
164
|
+
Simulations are stored inline in the data point's `simulations` array. Adding one for an existing `<component-id>` and data point replaces the existing simulation.
|
|
165
|
+
|
|
166
|
+
### Child Simulations (Agent Tool Simulation)
|
|
167
|
+
|
|
168
|
+
When a flow has an agent node, you can simulate individual tools inside that agent instead of mocking the whole agent as one unit. Use `--parent <agent-component-id>` to target a child tool. The child's `<component-id>` is the tool's runtime name (e.g. `Web_Search`, `Send_Email`), not a workflow node ID.
|
|
169
|
+
|
|
170
|
+
```bash
|
|
171
|
+
# Add a child tool simulation (Static — fixed output).
|
|
172
|
+
# If no parent simulation exists for <agent-node-id>, one is auto-created
|
|
173
|
+
# (type: agent, strategy: Llm).
|
|
174
|
+
uip maestro flow eval simulation add Web_Search \
|
|
175
|
+
--parent <agent-node-id> \
|
|
176
|
+
--set "<set_name>" \
|
|
177
|
+
--data-point "<data_point_name>" \
|
|
178
|
+
--strategy Static \
|
|
179
|
+
--mock-value '{"results": [{"title": "Example", "url": "https://example.com"}]}' \
|
|
180
|
+
--path <flow_project> --output json
|
|
181
|
+
|
|
182
|
+
# Add a child tool simulation (Llm — prompt-guided).
|
|
183
|
+
# Output schema is auto-resolved from the agent's tool definitions
|
|
184
|
+
# (inline, same-solution, or published agents).
|
|
185
|
+
uip maestro flow eval simulation add Send_Email \
|
|
186
|
+
--parent <agent-node-id> \
|
|
187
|
+
--set "<set_name>" \
|
|
188
|
+
--data-point "<data_point_name>" \
|
|
189
|
+
--strategy Llm \
|
|
190
|
+
--simulation-instructions "Return a success status with a generated messageId." \
|
|
191
|
+
--path <flow_project> --output json
|
|
192
|
+
|
|
193
|
+
# List child simulations on an agent node
|
|
194
|
+
uip maestro flow eval simulation list \
|
|
195
|
+
--parent <agent-node-id> \
|
|
196
|
+
--set "<set_name>" \
|
|
197
|
+
--data-point "<data_point_name>" \
|
|
198
|
+
--path <flow_project> --output json
|
|
199
|
+
|
|
200
|
+
# Remove a child simulation
|
|
201
|
+
uip maestro flow eval simulation remove Web_Search \
|
|
202
|
+
--parent <agent-node-id> \
|
|
203
|
+
--set "<set_name>" \
|
|
204
|
+
--data-point "<data_point_name>" \
|
|
205
|
+
--path <flow_project> --output json
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
No separate parent simulation step is needed — passing `--parent` auto-creates the parent simulation (type `agent`, strategy `Llm`) if it does not exist yet. This means a single command is enough to add a child tool simulation.
|
|
209
|
+
|
|
210
|
+
When `--parent` is used, `--component-type` defaults to `Node` (the convention for child tool simulations). You can override it if needed.
|
|
211
|
+
|
|
212
|
+
The output schema is auto-resolved for child simulations on all agent types:
|
|
213
|
+
- **Inline canvas agents** (`uipath.agent.*`): resolved from the child tool node's outputs in the `.flow` file.
|
|
214
|
+
- **Same-solution agents** (with `inputs.source`): resolved from the inline agent's `agent.json` resources.
|
|
215
|
+
- **Published agents** (`uipath.core.agent.*`): resolved via the platform API (`simulatableComponents`). Requires `uip login`.
|
|
216
|
+
|
|
217
|
+
For `Static` strategy, the CLI also validates that `--mock-value` keys match the resolved schema properties, catching shape mismatches before the eval run.
|
|
218
|
+
|
|
219
|
+
Child simulations are stored in the parent's `childSimulations` array in the eval set JSON. Running `simulation add` with `--parent` twice for the same child `<component-id>` replaces the existing child simulation.
|
|
220
|
+
|
|
221
|
+
## Anti-patterns
|
|
222
|
+
|
|
223
|
+
- Do not hand-write data-point `id` UUIDs. Run `uip maestro flow eval add`; the CLI generates fresh UUIDs and maintains `evalSetId`.
|
|
224
|
+
- Do not pass `--inputs` keys absent from the flow input schema; the CLI rejects them.
|
|
225
|
+
- Do not set `--expected '{}'` while omitting `--criteria` for trajectory evaluators; both placeholders are empty and scoring is meaningless.
|
|
226
|
+
- Do not delete attached input files before the run completes; the CLI references them until upload to Studio Web finishes.
|
|
227
|
+
- Do not expect `--evaluators` on `set add` to update automatically; later evaluators are not retroactively linked.
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# Upload Safety: Do Not Auto-Run `uip solution upload`
|
|
2
|
+
|
|
3
|
+
Never run `uip solution upload` automatically during an evaluation workflow. Always ask the user first. This applies to locally created, Studio Web-downloaded, VS Code-authored, or otherwise divergent solutions, including when the CLI reports `solution-id could not be resolved` or a similar error.
|
|
4
|
+
|
|
5
|
+
`uip solution upload` creates or overwrites the solution matched by the local `SolutionId` in Studio Web. Automatic upload can publish work in progress, overwrite concurrent Studio Web changes, or silently discard remote changes because local and remote state is not merged.
|
|
6
|
+
|
|
7
|
+
## Read-Only Resolution Check
|
|
8
|
+
|
|
9
|
+
This applies regardless of whether:
|
|
10
|
+
|
|
11
|
+
- The local project was created via `uip maestro flow init` and never uploaded.
|
|
12
|
+
- The local project was downloaded from Studio Web via `uip solution download` and edited locally.
|
|
13
|
+
- The user is working in a VS Code-authored solution / personal workspace and the project may not match what is on Studio Web.
|
|
14
|
+
- The CLI errors with `solution-id could not be resolved` or any variant.
|
|
15
|
+
|
|
16
|
+
## Why
|
|
17
|
+
|
|
18
|
+
`uip solution upload` is a write operation against Studio Web. It either creates a new solution or **overwrites** the existing one matched by the `SolutionId` in the local `.uipx` (bundling generates `SolutionStorage.json` from it; that file is read back only for a direct `.uis` upload) — the overwrite needs no flag and raises no prompt. The replaced contents are recorded as a restorable version (skipped entirely with `--no-snapshot`), but recovery is browser-only, after the fact, by the user — and it does not undo failure mode 1 below. None of this is a reason to skip asking. Three concrete failure modes if the skill auto-uploads:
|
|
19
|
+
|
|
20
|
+
1. **The user is iterating locally** in VS Code or the filesystem and intended to test something **before** publishing. Auto-upload pushes work-in-progress to Studio Web where teammates and triggers may pick it up.
|
|
21
|
+
2. **The user pulled the solution from Studio Web** to edit a small piece. Auto-upload sends the partial local state back, potentially **overwriting** changes another user made on Studio Web in the meantime.
|
|
22
|
+
3. **The local solution diverged from Studio Web** (e.g., a teammate edited the solution on Studio Web while the dev was working locally). Auto-upload silently discards the remote-side changes — they are not merged.
|
|
23
|
+
|
|
24
|
+
In all three cases the user loses work or surprises a teammate. The cost of pausing to ask is one prompt; the cost of an unwanted upload can be hours of recovery.
|
|
25
|
+
|
|
26
|
+
## What To Do Instead
|
|
27
|
+
|
|
28
|
+
When `eval run start` cannot resolve the solution:
|
|
29
|
+
|
|
30
|
+
1. **Stop and ask the user.** Use plain language: "Your Flow solution doesn't appear to be in Studio Web (or its IDs aren't resolvable from the local working tree). I can't run an eval until it is. How do you want to proceed?"
|
|
31
|
+
2. **Offer the options explicitly:**
|
|
32
|
+
- **Upload now** — the user runs (or asks the skill to run) `uip solution upload <SolutionDir> --output json`. They acknowledge that this will write to Studio Web.
|
|
33
|
+
- **Pass IDs explicitly** — the user provides `--solution-id` and `--project-id` for an existing Studio Web solution. The skill plumbs them through to `eval run start`.
|
|
34
|
+
- **Cancel** — they meant to test something else (e.g., `flow debug`).
|
|
35
|
+
3. **Wait for an explicit decision.** Do not infer one from context, prior commands, or comments in the project.
|
|
36
|
+
|
|
37
|
+
## How to Detect "Local Workspace or VS Code"
|
|
38
|
+
|
|
39
|
+
There is no single CLI flag that says "this project is local-only." The signals to weigh, in priority order:
|
|
40
|
+
|
|
41
|
+
1. **The `.uipx` carries an id Studio Web has never seen** (a fresh `solution init`, never uploaded). The upload would CREATE a new solution; the user might not want a new tenant entry.
|
|
42
|
+
2. **`.vscode/` directory exists in the solution root.** Strong signal that the dev is authoring in VS Code; assume they are iterating locally.
|
|
43
|
+
3. **The directory is under a workspace path the user has indicated they edit locally** (`~/Code/...`, `~/dev/...`, etc., or any path that is not the default Studio Web download location). Treat as local-first.
|
|
44
|
+
4. **`uip solution upload` has never been recorded** in the recent shell history or in the conversation. If the skill cannot point to a prior explicit upload, do not assume the project is in Studio Web.
|
|
45
|
+
|
|
46
|
+
If ANY of these signals is true, skip auto-upload entirely and ask.
|
|
47
|
+
|
|
48
|
+
None of these signals separates a first import from an overwrite of a live solution: an id from a downloaded or copied project names a solution the upload would replace, and the local tree alone cannot tell the two apart. Treat both as writes to ask about.
|
|
49
|
+
|
|
50
|
+
## How to Detect "Solution Already in Studio Web"
|
|
51
|
+
|
|
52
|
+
The cheapest check is to attempt a read-only run command before doing anything else:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
uip maestro flow eval run list --set "<set_name>" --path <flow_project> --output json
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
A successful response, including zero past runs, indicates that the solution is in Studio Web. A missing-solution or auth error means it is not uploaded for this workflow; ask before uploading. If `eval run start` fails with a resolution error, never auto-upload or retry by uploading.
|
|
59
|
+
|
|
60
|
+
## If Evaluation Cannot Resolve the Solution
|
|
61
|
+
|
|
62
|
+
1. Stop and ask: "Your Flow solution doesn't appear to be in Studio Web (or its IDs aren't resolvable from the local working tree). I can't run an eval until it is. How do you want to proceed?"
|
|
63
|
+
2. Offer:
|
|
64
|
+
- **Upload now** — the user runs, or explicitly asks the skill to run, `uip solution upload <SolutionDir> --output json`; state that this writes to Studio Web.
|
|
65
|
+
- **Pass IDs explicitly** — the user provides `--solution-id` and `--project-id` for an existing Studio Web solution; pass them through to `eval run start`.
|
|
66
|
+
- **Cancel** — they intended to test something else, such as `flow debug`.
|
|
67
|
+
3. Wait for an explicit decision. Never infer consent from context, prior commands, or project comments.
|
|
68
|
+
|
|
69
|
+
## Local-Workspace Signals
|
|
70
|
+
|
|
71
|
+
Treat the project as local-first and skip auto-upload if any signal is present:
|
|
72
|
+
|
|
73
|
+
1. `SolutionStorage.json` is missing or has no `SolutionId`; upload would create a new solution.
|
|
74
|
+
2. A `.vscode/` directory exists in the solution root.
|
|
75
|
+
3. The directory is under a user-indicated local workspace path, such as `~/Code/...` or `~/dev/...`, rather than the default Studio Web download location.
|
|
76
|
+
4. No prior `uip solution upload` appears in recent shell history or the conversation; without a recorded explicit upload, do not assume the project is in Studio Web.
|
|
77
|
+
|
|
78
|
+
## Explicit Upload Consent
|
|
79
|
+
|
|
80
|
+
When the user explicitly asks to upload, you may run:
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
uip solution upload <SolutionDir> --output json
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
Before running it, echo the exact command and warn that concurrent Studio Web edits may be overwritten. Afterward, report `SolutionId` and `DesignerUrl` from the output, surface the result, and only then proceed with the eval run. Do not silently chain the upload into the next step.
|
|
87
|
+
|
|
88
|
+
## Anti-Patterns
|
|
89
|
+
|
|
90
|
+
- Do not run `uip solution upload` to fix an eval-run error.
|
|
91
|
+
- Do not treat "make the eval work" as upload consent.
|
|
92
|
+
- Do not auto-retry an eval after solution resolution fails by uploading and rerunning.
|
|
93
|
+
- Do not upload while another user may be editing the solution on Studio Web without warning about possible overwrites, even with consent.
|
|
94
|
+
- Do not combine `flow debug` and `eval run` in one session against the same solution; each has its own Studio Web debug session, and mixing them can confuse run IDs and trigger unexpected uploads.
|
|
@@ -27,27 +27,27 @@ Capability index for the lifecycle of a flow as a deployed asset. Operate owns e
|
|
|
27
27
|
|
|
28
28
|
| Journey | Read |
|
|
29
29
|
| --- | --- |
|
|
30
|
-
| Publish a flow (Studio Web default, Orchestrator on request) | [ship.md](
|
|
31
|
-
| Run a flow on demand or check progress | [run.md](
|
|
32
|
-
| Intervene in a running instance | [manage.md](
|
|
30
|
+
| Publish a flow (Studio Web default, Orchestrator on request) | [ship.md](ship.md) |
|
|
31
|
+
| Run a flow on demand or check progress | [run.md](run.md) |
|
|
32
|
+
| Intervene in a running instance | [manage.md](manage.md) |
|
|
33
33
|
|
|
34
34
|
## Common tasks
|
|
35
35
|
|
|
36
36
|
| I need to... | Read these |
|
|
37
37
|
| --- | --- |
|
|
38
|
-
| **Publish a flow to Studio Web** | [ship.md — Path 1](
|
|
39
|
-
| **Deploy a flow to Orchestrator** (only if explicitly requested) | [ship.md — Path 2](
|
|
40
|
-
| **Sync solution resource declarations** | [ship.md — Pre-flight](
|
|
41
|
-
| **Debug a flow end-to-end** | [run.md — Debug](
|
|
42
|
-
| **Pass input arguments to `flow debug`** | [run.md — Debug](
|
|
43
|
-
| **Bind local files to file-typed inputs** | [run.md — Debug](
|
|
44
|
-
| **Trigger a deployed process** | [run.md — Process run](
|
|
45
|
-
| **Check status of a running job** | [run.md — Job inspection](
|
|
46
|
-
| **Stream verbose execution traces** | [run.md — Job inspection](
|
|
47
|
-
| **Pause a running instance** | [manage.md](
|
|
48
|
-
| **Resume a paused instance** | [manage.md](
|
|
49
|
-
| **Cancel an instance** | [manage.md](
|
|
50
|
-
| **Retry a faulted instance** | [manage.md](
|
|
38
|
+
| **Publish a flow to Studio Web** | [ship.md — Path 1](ship.md#path-1--studio-web-upload-default) |
|
|
39
|
+
| **Deploy a flow to Orchestrator** (only if explicitly requested) | [ship.md — Path 2](ship.md#path-2--orchestrator-deploy-explicit-only) + [/uipath:uipath-solution](/uipath:uipath-solution) |
|
|
40
|
+
| **Sync solution resource declarations** | [ship.md — Pre-flight](ship.md#pre-flight) (the `uip solution resources refresh` step) |
|
|
41
|
+
| **Debug a flow end-to-end** | [run.md — Debug](run.md#debug--controlled-end-to-end-run) |
|
|
42
|
+
| **Pass input arguments to `flow debug`** | [run.md — Debug](run.md#debug--controlled-end-to-end-run) (the `--inputs` flag) |
|
|
43
|
+
| **Bind local files to file-typed inputs** | [run.md — Debug](run.md#debug--controlled-end-to-end-run) and [run.md — Process run](run.md#process-run--trigger-a-deployed-process) (same `--attachment <variableId>=<localPath>` flag on both, repeatable; `--attachment` overrides `--inputs` on key collisions) |
|
|
44
|
+
| **Trigger a deployed process** | [run.md — Process run](run.md#process-run--trigger-a-deployed-process) |
|
|
45
|
+
| **Check status of a running job** | [run.md — Job inspection](run.md#job-inspection--status-and-traces) |
|
|
46
|
+
| **Stream verbose execution traces** | [run.md — Job inspection](run.md#job-inspection--status-and-traces) (use sparingly — see [diagnose/CAPABILITY.md](../diagnose/CAPABILITY.md)) |
|
|
47
|
+
| **Pause a running instance** | [manage.md](manage.md) |
|
|
48
|
+
| **Resume a paused instance** | [manage.md](manage.md) |
|
|
49
|
+
| **Cancel an instance** | [manage.md](manage.md) |
|
|
50
|
+
| **Retry a faulted instance** | [manage.md](manage.md) (after diagnosing root cause via [diagnose/CAPABILITY.md](../diagnose/CAPABILITY.md)) |
|
|
51
51
|
| **Look up `solution` / `flow pack` / `flow debug` / `process` / `job` / `instance` CLI syntax** | [shared/cli-commands.md](../shared/cli-commands.md) |
|
|
52
52
|
| **My flow run failed** | [diagnose/CAPABILITY.md](../diagnose/CAPABILITY.md) |
|
|
53
53
|
|
|
@@ -55,7 +55,7 @@ Capability index for the lifecycle of a flow as a deployed asset. Operate owns e
|
|
|
55
55
|
|
|
56
56
|
- **Never run `solution upload` without `solution resources refresh` first.** Stale resource declarations cause runtime binding failures.
|
|
57
57
|
- **Never default to Orchestrator deploy when the user said "publish".** "Publish" → Studio Web upload. Confirm explicitly before running `flow pack` + `solution publish`.
|
|
58
|
-
- **Never run `flow debug` as a validation step.**
|
|
58
|
+
- **Never run `flow debug` as a validation step, and never re-run a completed one to reshape its output.** Each run re-uploads the solution and executes the flow again against real systems; extract report fields from the payload the completed run already returned, and when that run faulted, read the cause from it first — see [diagnose/troubleshooting-guide.md — Step 0](../diagnose/troubleshooting-guide.md#step-0--read-the-cause-in-the-debug-output-you-already-have). Use `uip maestro flow validate` for correctness checking.
|
|
59
59
|
- **Never `retry` a faulted instance without diagnosing the root cause first.** Triage via [diagnose/CAPABILITY.md](../diagnose/CAPABILITY.md) — read incidents, runtime variables, and the deployed asset. Then decide whether to retry, cancel, or re-author.
|
|
60
60
|
- **Never start diagnosis from `job traces`.** Traces are last-resort verbose output. Begin with incidents — see [diagnose/CAPABILITY.md](../diagnose/CAPABILITY.md) for the priority ladder.
|
|
61
61
|
|
|
@@ -63,14 +63,14 @@ Capability index for the lifecycle of a flow as a deployed asset. Operate owns e
|
|
|
63
63
|
|
|
64
64
|
### Operate-scoped
|
|
65
65
|
|
|
66
|
-
- [ship.md](
|
|
67
|
-
- [run.md](
|
|
68
|
-
- [manage.md](
|
|
66
|
+
- [ship.md](ship.md) — Studio Web upload (default) and Orchestrator deploy (explicit)
|
|
67
|
+
- [run.md](run.md) — debug, process run, job status/traces
|
|
68
|
+
- [manage.md](manage.md) — instance lifecycle (pause, resume, cancel, retry)
|
|
69
69
|
|
|
70
70
|
### Cross-capability (shared)
|
|
71
71
|
|
|
72
72
|
- [shared/cli-commands.md](../shared/cli-commands.md) — flat CLI lookup including `solution upload`, `solution resources refresh`, `flow pack`, `flow debug`, `flow process`, `flow job`, `flow instance`
|
|
73
|
-
- [shared/cli-conventions.md](../shared/cli-conventions.md) — login states, FOLDER_KEY,
|
|
73
|
+
- [shared/cli-conventions.md](../shared/cli-conventions.md) — login states, FOLDER_KEY, UIP_LOG_LEVEL, JSON output shape
|
|
74
74
|
- [shared/variables-and-expressions.md](../shared/variables-and-expressions.md) — `--inputs` JSON shape for `flow debug`
|
|
75
75
|
|
|
76
76
|
For Orchestrator deployment via `uip solution publish`, see [/uipath:uipath-solution](/uipath:uipath-solution).
|