@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,7 +12,7 @@ Create a solution, add automation projects, and sync resource declarations.
|
|
|
12
12
|
|
|
13
13
|
## Prerequisites
|
|
14
14
|
|
|
15
|
-
- Authenticated — verify with `uip login status` (required for remote resource lookup during `
|
|
15
|
+
- Authenticated — verify with `uip login status` (required for remote resource lookup during `resources refresh` and for `upload`); if not logged in, ask the user to run `uip login` (interactive browser flow)
|
|
16
16
|
- Projects to add must contain `project.uiproj` or `project.json`
|
|
17
17
|
|
|
18
18
|
## Flow
|
|
@@ -44,7 +44,7 @@ Creates `InvoiceAutomation/InvoiceAutomation.uipx`. All projects must live insid
|
|
|
44
44
|
|
|
45
45
|
## Step 2: Add Existing Projects
|
|
46
46
|
|
|
47
|
-
> **Prerequisite for Coded Function and Coded Agent projects:** before running `uip solution projects add`, run `uip function init` (Coded Functions) or `uip codedagent init` (LangGraph/LlamaIndex/OpenAI Agents) inside the project directory to generate `entry-points.json`. Registration without
|
|
47
|
+
> **Prerequisite for Coded Function and Coded Agent projects:** before running `uip solution projects add`, run `uip function init` (Python Coded Functions) or `uip codedagent init` (LangGraph/LlamaIndex/OpenAI Agents) inside the project directory to generate `entry-points.json`. JS/TS Coded Functions have no `init` — their `uipath.json` functions map is the registration marker (`entry-points.json` is generated at pack). Registration without these creates an incomplete solution entry.
|
|
48
48
|
|
|
49
49
|
Register a project that already lives inside the solution directory.
|
|
50
50
|
|
|
@@ -64,12 +64,12 @@ The `.uipx` is auto-discovered by walking up from the project path if not specif
|
|
|
64
64
|
Copy a project from outside the solution tree into the solution directory and register it.
|
|
65
65
|
|
|
66
66
|
```bash
|
|
67
|
-
uip solution projects import
|
|
67
|
+
uip solution projects import /path/to/ExternalProject --output json
|
|
68
68
|
```
|
|
69
69
|
|
|
70
70
|
Unlike `add`, `import` copies source files into the solution directory first, then registers the copy.
|
|
71
71
|
|
|
72
|
-
> **Three names can diverge after `import`.** The destination folder name is the basename of
|
|
72
|
+
> **Three names can diverge after `import`.** The destination folder name is the basename of the source path. The `ProjectRelativePath` in `.uipx` matches the folder. The auto-generated package resource name is taken from the project metadata (e.g., `pyproject.toml [project].name` for Python coded agents) — which may differ from the folder. Rename the source directory to the intended project name **before** importing, or trace the relationship via the `projectKey` UUID inside the resource files.
|
|
73
73
|
|
|
74
74
|
## Step 4: Remove a Project
|
|
75
75
|
|
|
@@ -331,8 +331,8 @@ An *already-imported* key is not an error — the idempotency check runs first,
|
|
|
331
331
|
|
|
332
332
|
| Mechanism | When to use | Behavior |
|
|
333
333
|
|---|---|---|
|
|
334
|
-
| `
|
|
335
|
-
| `
|
|
334
|
+
| `resources refresh` | A `bindings_v2.json` was edited (by Studio Web, Maestro Flow/Case scaffolds, `maestro flow new`) and you need to reconcile all projects | Scans every project's bindings, creates / imports for everything new, suffixes name collisions across folders |
|
|
335
|
+
| `resources add` | One specific resource that's not driven by a binding (CI provisioning a queue, an agent that knows exactly what it wants to import) | Single resource, idempotent, no project scan |
|
|
336
336
|
|
|
337
337
|
`add` does **not** mutate any `bindings_v2.json`. If a binding references this resource, you still need the binding file to be present — `add` just creates the solution-level artefact so deploy validation passes.
|
|
338
338
|
|
|
@@ -347,7 +347,7 @@ uip solution resources remove 8f3a1b2c-1234-4abc-9def-0123456789ab --output json
|
|
|
347
347
|
uip solution resources remove 8f3a1b2c-... --solution-folder ./InvoiceAutomation --output json
|
|
348
348
|
```
|
|
349
349
|
|
|
350
|
-
`<resource-key>` is positional and required, validated as a GUID. Use `
|
|
350
|
+
`<resource-key>` is positional and required, validated as a GUID. Use `resources list --source local` to discover keys.
|
|
351
351
|
|
|
352
352
|
| Option | Values | Default |
|
|
353
353
|
|--------|--------|---------|
|
|
@@ -368,9 +368,9 @@ uip solution resources remove 8f3a1b2c-... --solution-folder ./InvoiceAutomation
|
|
|
368
368
|
}
|
|
369
369
|
```
|
|
370
370
|
|
|
371
|
-
If the key isn't in the local solution, the command exits with `Failure` and `Resource not found in solution` — there's no fallback to remote (unlike `
|
|
371
|
+
If the key isn't in the local solution, the command exits with `Failure` and `Resource not found in solution` — there's no fallback to remote (unlike `resources get`). Use `resources list --source local` to confirm what's actually tracked.
|
|
372
372
|
|
|
373
|
-
> Removing a resource does **not** delete the binding in any `bindings_v2.json` that still references it. The next `
|
|
373
|
+
> Removing a resource does **not** delete the binding in any `bindings_v2.json` that still references it. The next `resources refresh` will re-import it. To make a removal stick, either fix the binding through the owning product (Maestro Flow / Case, Studio Web, agent code) or remove the project from the solution first.
|
|
374
374
|
|
|
375
375
|
## Step 11: Edit a Resource
|
|
376
376
|
|
|
@@ -389,7 +389,7 @@ echo '{"slaInHours":"4"}' | uip solution resources edit <resource-key> --patch -
|
|
|
389
389
|
|
|
390
390
|
| Option | Values | Default |
|
|
391
391
|
|--------|--------|---------|
|
|
392
|
-
| `<resource-key>` | Solution resource key (GUID, positional) — discover via `
|
|
392
|
+
| `<resource-key>` | Solution resource key (GUID, positional) — discover via `resources list --source local` | **required** |
|
|
393
393
|
| `--patch <json\|->` | JSON object of spec property → value; `-` reads the JSON from stdin | **required** |
|
|
394
394
|
| `--solution-folder <path>` | Path to solution root (must directly contain a `.uipx`) | Current working directory |
|
|
395
395
|
|
|
@@ -420,7 +420,7 @@ echo '{"slaInHours":"4"}' | uip solution resources edit <resource-key> --patch -
|
|
|
420
420
|
}
|
|
421
421
|
```
|
|
422
422
|
|
|
423
|
-
`Data` is the SDK's `ResourceConfiguration` — the **same shape `
|
|
423
|
+
`Data` is the SDK's `ResourceConfiguration` — the **same shape `resources get` returns**, so `get`↔`edit` round-trips cleanly: `resources get <key> --output json`, mutate the JSON, feed it back via `--patch`. If you need a before/after diff, run `get` first.
|
|
424
424
|
|
|
425
425
|
## Step 12: Upload to Studio Web
|
|
426
426
|
|
|
@@ -430,7 +430,13 @@ Upload the solution for browser-based editing. Accepts a directory, `.uipx` file
|
|
|
430
430
|
uip solution upload ./InvoiceAutomation --output json
|
|
431
431
|
```
|
|
432
432
|
|
|
433
|
-
|
|
433
|
+
The CLI probes Studio Web for the bundled `SolutionId` and picks the operation itself, so the same command serves the first upload and every one after it. `Data.Action` reports which ran — `"Imported"` or `"Overwritten"`. See [`upload` decides import or overwrite from what the cloud holds](#upload-decides-import-or-overwrite-from-what-the-cloud-holds) for the decision rules, snapshot recording, and failure modes.
|
|
434
|
+
|
|
435
|
+
| Flag | Purpose | Default |
|
|
436
|
+
|------|---------|---------|
|
|
437
|
+
| `--no-snapshot` | Skip recording the restorable pre-overwrite version. Overwrite only | Version recorded |
|
|
438
|
+
| `--force` | Assert the solution exists and overwrite it without the probe. Not normally needed; fails `not_found` when the cloud solution is gone | Probe runs |
|
|
439
|
+
| `--login-validity <minutes>` | Minimum minutes left on token before refresh | `10` |
|
|
434
440
|
|
|
435
441
|
> A project's target framework (platform) is fixed at creation and **cannot be mutated** — re-uploading or editing configuration will not change it. To target a different platform (e.g., Windows → Cross-platform), **recreate the project** with the correct target framework and upload that.
|
|
436
442
|
|
|
@@ -493,7 +499,7 @@ ls -1 ./MySolution/resources/solution_folder/process/
|
|
|
493
499
|
# 3. The two sets MUST agree by name. If not, the solution is corrupt.
|
|
494
500
|
```
|
|
495
501
|
|
|
496
|
-
Steps 1–3 verify *project* mutations (`
|
|
502
|
+
Steps 1–3 verify *project* mutations (`projects add`/`remove`, `refresh`). For *resource* mutations (`resources add`/`remove`) the relevant files live under other `resources/solution_folder/<kind>/` subtrees (`queue/`, `asset/`, `bucket/`, …), so verify at the resource level instead:
|
|
497
503
|
|
|
498
504
|
```bash
|
|
499
505
|
uip solution resources list --source local --output json
|
|
@@ -508,13 +514,13 @@ If `.uipx` and `resources/solution_folder/` disagree, follow the recovery proced
|
|
|
508
514
|
| `bindings.json` | `uipath init` (coded agent) | the agent at runtime |
|
|
509
515
|
| `bindings_v2.json` | `uip maestro flow new`, Maestro Case scaffold, Studio Web (mirrors agent bindings up to solution root) | `uip solution resources refresh` |
|
|
510
516
|
|
|
511
|
-
Copying `bindings.json` → `bindings_v2.json` does **not** work — the schemas differ, and `
|
|
517
|
+
Copying `bindings.json` → `bindings_v2.json` does **not** work — the schemas differ, and `resources refresh` will silently fail (see "false success" gotcha above). Naive hand-authoring or copy-paste from `bindings.json` produces the opaque error `TypeError: Cannot read properties of undefined (reading 'toLowerCase')`. When a project's tooling already manages `bindings_v2.json` (Flow / Case / agent solutions), edit through that product's commands rather than the file directly, then run `resources refresh` to reconcile.
|
|
512
518
|
|
|
513
|
-
### `
|
|
519
|
+
### `resources refresh` reports false success on schema errors
|
|
514
520
|
|
|
515
521
|
See [Step 7](#step-7-refresh-resources). Always capture stderr and grep for `ERROR`. The `Warnings` field stays empty even when the underlying parser throws.
|
|
516
522
|
|
|
517
|
-
### `
|
|
523
|
+
### `projects remove` leaves orphan package resources
|
|
518
524
|
|
|
519
525
|
See [Step 4](#step-4-remove-a-project). After `remove`, manually delete `resources/solution_folder/package/<name>.json` if you plan to re-add with the same name. To fully delete a project, also remove the project folder — `remove` does not touch source files.
|
|
520
526
|
|
|
@@ -524,7 +530,7 @@ See [Step 4](#step-4-remove-a-project). After `remove`, manually delete `resourc
|
|
|
524
530
|
|
|
525
531
|
### `add` vs `import`
|
|
526
532
|
|
|
527
|
-
| | `
|
|
533
|
+
| | `projects add` | `projects import` |
|
|
528
534
|
|-|----------------|-------------------|
|
|
529
535
|
| Project location | Must already be inside the solution directory | Can be anywhere on disk |
|
|
530
536
|
| File handling | Registers only (no file copy) | Copies into solution tree, then registers |
|
|
@@ -532,9 +538,9 @@ See [Step 4](#step-4-remove-a-project). After `remove`, manually delete `resourc
|
|
|
532
538
|
|
|
533
539
|
### `remove` does not delete files
|
|
534
540
|
|
|
535
|
-
`
|
|
541
|
+
`projects remove` unregisters from `.uipx` but leaves the project directory intact. Delete files manually if needed.
|
|
536
542
|
|
|
537
|
-
### `
|
|
543
|
+
### `resources refresh` is the sync mechanism
|
|
538
544
|
|
|
539
545
|
Adding a project does not automatically sync its resources. The refresh scans all registered projects for `bindings_v2.json`, creates solution resources for untracked bindings, imports from Orchestrator when a match exists, and skips already-tracked bindings.
|
|
540
546
|
|
|
@@ -559,15 +565,20 @@ Refresh reads both. Don't hand-edit these — they're regenerated whenever Studi
|
|
|
559
565
|
|
|
560
566
|
`userProfile/<userId>/debug_overwrites.json` is per-user state (the `userId` is your UiPath user GUID). Refresh writes only your own entries; another user opening the bundled solution would have separate entries. The bundle (`.uis`) carries `userProfile/` for everyone who ran refresh; Studio Web picks the active user's at runtime.
|
|
561
567
|
|
|
562
|
-
### `upload`
|
|
568
|
+
### `upload` decides import or overwrite from what the cloud holds
|
|
563
569
|
|
|
564
570
|
The `SolutionId` in `.uipx` determines identity. Before uploading, the CLI probes Studio Web for that id:
|
|
565
571
|
|
|
566
|
-
- **Cloud has no solution with that id** →
|
|
567
|
-
- **Cloud already has that id
|
|
568
|
-
|
|
572
|
+
- **Cloud has no solution with that id** → imported as new. This is the freshly `solution init`-ed flow. Studio Web assigns its own `SolutionId` — it never honors the one in the archive — so the CLI repoints the local `.uipx` to the assigned id and reports the rewrite under `Data.LocalSolutionIdUpdated` (`Path`, `From`, `To`). That link is what makes the next upload an update rather than a second cloud solution. The file is written only when the id actually changed.
|
|
573
|
+
- **Cloud already has that id** → overwritten in place under the same id. The solution's Studio Web version history is **kept** — history rows key on the solution id, which does not change. The contents being replaced are recorded first as a restorable version (`Data.SnapshotCreated: true`), so an overwrite is recoverable. The local `.uipx` is not touched.
|
|
574
|
+
|
|
575
|
+
`--no-snapshot` suppresses that recording. Anything edited **in Studio Web** since the last upload is then lost with no way back; local files are never affected.
|
|
576
|
+
|
|
577
|
+
`--force` asserts that the solution exists — it is not a request to replace history. Not normally needed: a plain upload overwrites an existing cloud solution on its own. Use it when the probe cannot run, since the probe needs read access to the solution. When that solution is gone, the upload fails with `ErrorCode: not_found` (exit 1, `Retry: RetryWillNotFix`) rather than importing a duplicate. With no `SolutionId` bundled it changes nothing: the upload imports as new.
|
|
578
|
+
|
|
579
|
+
A direct `.uis` upload has no local `.uipx` to read, so the CLI takes the `SolutionId` out of the archive (`SolutionStorage.json`, root `.uipx` as fallback, GUID-shaped values only). Re-uploading a `.uis` produced by `uip solution download` therefore updates the solution it came from instead of minting a `"<name> 1"` copy each time. An archive carrying no usable id imports as new.
|
|
569
580
|
|
|
570
|
-
To upload as an unrelated new cloud solution rather than overwriting, scaffold a fresh solution with `uip solution init
|
|
581
|
+
To upload as an unrelated new cloud solution rather than overwriting, scaffold a fresh solution with `uip solution init`, or replace the `SolutionId` in the local `.uipx` with a fresh GUID and re-run `upload` — removing the field entirely fails `.uipx` validation.
|
|
571
582
|
|
|
572
583
|
### `delete` uses the solution UUID, not the name
|
|
573
584
|
|
|
@@ -579,13 +590,13 @@ When `[solutionFile]` is omitted, the CLI walks up from the project path looking
|
|
|
579
590
|
|
|
580
591
|
### `--solution-folder` defaults to cwd
|
|
581
592
|
|
|
582
|
-
`
|
|
593
|
+
`resources list / refresh / get / add / remove / edit` default `--solution-folder` to the current working directory. Run them from inside the solution dir for the shortest invocation (`uip solution resources list`) or pass `--solution-folder <path>` explicitly.
|
|
583
594
|
|
|
584
595
|
### `add` / `remove` / `edit` / `refresh` require a `.uipx` manifest in the target folder
|
|
585
596
|
|
|
586
|
-
Unlike `
|
|
597
|
+
Unlike `resources get` and `list` (which fall back to RCS when local state is missing), the write commands refuse to operate on a directory that doesn't directly contain a `.uipx`. This prevents `--solution-folder /tmp` from silently writing stray resource files anywhere on disk. If you see `<path> is not a UiPath solution (no .uipx manifest found)`, you're pointed at the wrong directory.
|
|
587
598
|
|
|
588
|
-
### `
|
|
599
|
+
### `resources get` for cross-folder inspection
|
|
589
600
|
|
|
590
601
|
Because `get` falls back to RCS + FPS export when the key isn't local, it works as a quick way to fetch the full server spec for any resource your tenant exposes — even ones that aren't yet bound to this solution. Pair with `solution resources list --kind <kind> --source remote` to discover keys.
|
|
591
602
|
|
|
@@ -597,7 +608,7 @@ Because `get` falls back to RCS + FPS export when the key isn't local, it works
|
|
|
597
608
|
|---|---|---|
|
|
598
609
|
| Create a fresh solution | `uip solution init <name>` | Accepts an existing empty directory; drops `.uipx` inside |
|
|
599
610
|
| Add a project already in the solution dir | `uip solution projects add ./<dir>` | Transactional — `.uipx` and `resources/solution_folder/{package,process}/` agree on success |
|
|
600
|
-
| Pull in an external project | `uip solution projects import
|
|
611
|
+
| Pull in an external project | `uip solution projects import <path>` | Rename source folder first to avoid 3-name divergence |
|
|
601
612
|
| Remove a project | `uip solution projects remove ./<dir>` | Manually delete `resources/.../package/<name>.json` afterwards |
|
|
602
613
|
| Sync resource bindings | `uip solution resources refresh --solution-folder <solution-dir>` | **Check stderr for ERROR**; `Result: Success` with 0/0/0 counts is suspicious if `bindings_v2.json` exists |
|
|
603
614
|
| Add a virtual queue / asset / bucket | `uip solution resources add --source local --kind <kind> --name <name>` | Offline-friendly; idempotent (re-run returns `Status: "Unchanged"`) |
|
|
@@ -85,6 +85,54 @@ uip solution publish ./output/MySolution_2.0.0.zip --tenant "Production" --outpu
|
|
|
85
85
|
|
|
86
86
|
After publishing, the package is visible via `uip solution packages list` and available for deployment.
|
|
87
87
|
|
|
88
|
+
### Publishing to a non-tenant feed
|
|
89
|
+
|
|
90
|
+
By default everything targets the **tenant** feed. A package can instead go to your
|
|
91
|
+
Personal Workspace or to a specific **folder feed**. Start by listing what you can
|
|
92
|
+
actually target — a raw folder key is not necessarily a publishable feed:
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
uip solution feeds list --output json
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
`Data` is a list of `{ Name, Key, Type, IsMyPersonalWorkspace }` where `Type` is
|
|
99
|
+
`Tenant`, `PersonalWorkspace`, or `Folder`. Only feeds in this list can be
|
|
100
|
+
targeted; passing anything else fails with *"is not an available publish
|
|
101
|
+
location"*. Personal Workspaces belonging to other users are filtered out even
|
|
102
|
+
when you can browse them.
|
|
103
|
+
|
|
104
|
+
Then target a feed with `--feed <name-or-key>` (accepts either the feed's name or
|
|
105
|
+
its folder key) or `--personal-workspace`:
|
|
106
|
+
|
|
107
|
+
```bash
|
|
108
|
+
# Publish into a folder feed
|
|
109
|
+
uip solution publish ./output/MySolution_2.0.0.zip --feed "Finance" --output json
|
|
110
|
+
|
|
111
|
+
# Publish into your own Personal Workspace
|
|
112
|
+
uip solution publish ./output/MySolution_2.0.0.zip --personal-workspace --output json
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
The same two flags scope the rest of the lifecycle, and they are **mutually
|
|
116
|
+
exclusive** everywhere:
|
|
117
|
+
|
|
118
|
+
| Command | What the flag scopes |
|
|
119
|
+
|---|---|
|
|
120
|
+
| `uip solution publish --feed / --personal-workspace` | Which feed the package is uploaded to |
|
|
121
|
+
| `uip solution deploy run --feed / --personal-workspace` | Which feed the package is deployed **from** |
|
|
122
|
+
| `uip solution deploy list --feed / --personal-workspace` | Which feed's deployments are listed |
|
|
123
|
+
| `uip solution packages list --feed / --personal-workspace` | Which feed's packages are listed |
|
|
124
|
+
| `uip solution packages delete --feed / --personal-workspace` | Which feed the version is deleted from |
|
|
125
|
+
|
|
126
|
+
**Deploy from the feed you published to.** A package published to a folder feed or
|
|
127
|
+
Personal Workspace is not in the tenant feed, so a plain `deploy run` cannot see
|
|
128
|
+
it — pass the same `--feed` / `--personal-workspace` there too. Likewise, omitting
|
|
129
|
+
the flag on `packages list` shows only tenant packages, which is the usual reason
|
|
130
|
+
a freshly published feed package looks missing.
|
|
131
|
+
|
|
132
|
+
`deploy run --feed` also accepts `--parent-folder-path` / `--parent-folder-key` to
|
|
133
|
+
pick **where inside** the feed's folder the deployment lands; without them it goes
|
|
134
|
+
to the feed folder itself.
|
|
135
|
+
|
|
88
136
|
## Step 3 (Alternative): Upload to Studio Web
|
|
89
137
|
|
|
90
138
|
If the goal is browser-based editing rather than deployment, use `upload` instead of `publish`:
|
|
@@ -93,7 +141,7 @@ If the goal is browser-based editing rather than deployment, use `upload` instea
|
|
|
93
141
|
uip solution upload ./MySolution --output json
|
|
94
142
|
```
|
|
95
143
|
|
|
96
|
-
This uploads to Studio Web for collaborative editing. It does **not** place the package on the solution feed and cannot be used with `deploy run`. If the `SolutionId` in `.uipx` already exists in Studio Web, `upload`
|
|
144
|
+
This uploads to Studio Web for collaborative editing. It does **not** place the package on the solution feed and cannot be used with `deploy run`. If the `SolutionId` in `.uipx` already exists in Studio Web, `upload` overwrites that solution in place; otherwise it imports as new — see [develop-solution.md § `upload` decides import or overwrite from what the cloud holds](develop-solution.md#upload-decides-import-or-overwrite-from-what-the-cloud-holds) for the decision rules and snapshot recording.
|
|
97
145
|
|
|
98
146
|
`upload` always lands the solution in Studio Web's **Cloud workspace** tab, not the Local tab. SW's Local tab is a separate registration for solutions whose source of truth is a tracked local folder — populated by SW-initiated flows (creating a solution from the SW UI, or downloading a cloud solution to local) or by Studio Desktop signing into the same tenant. `uip solution upload` does not address the Local tab. Authoring with `uip solution init` then `upload` produces a Cloud-tab solution; the local folder on disk has no live link to either tab afterward — edits in one place do not propagate to the other without a re-upload (Cloud) or a download (Local).
|
|
99
147
|
|
|
@@ -7,7 +7,7 @@ Symptoms that don't fit a single scenario but bite often enough to call out. Use
|
|
|
7
7
|
| `[1009] <kind> <name>: Invalid argument 'Value'` at deploy | Virtual resource without `value` set ([virtual-resource](virtual-resource.md)) | `deploy config set <file> <name> value <val>` or `deploy config link <file> <name> --name <existing>` |
|
|
8
8
|
| `Folder already exists` at deploy | `--folder-name` collides with an existing folder under `--parent-folder-path` | Pick a different `--folder-name`, or `solution deploy uninstall <existing>` first |
|
|
9
9
|
| Suffix `_N` keeps growing on re-refresh (`_1`, `_2`, `_3`...) | Old CLI version (pre-suffix-amplification fix) | Upgrade `@uipath/cli` to a build that ships the SDK bump (`resource-builder-sdk` ≥ `2025.11.0-alpha3780`); the current refresh is idempotent on cloud key |
|
|
10
|
-
| Tool dialog in Studio Web doesn't open for one of two same-name tools | SW UI bug — affects pure-SW solutions too ([same-name-across-folders](same-name-across-folders.md)) | Verified at deploy/runtime — ignore the UI symptom; check the tool resolves correctly via `
|
|
10
|
+
| Tool dialog in Studio Web doesn't open for one of two same-name tools | SW UI bug — affects pure-SW solutions too ([same-name-across-folders](same-name-across-folders.md)) | Verified at deploy/runtime — ignore the UI symptom; check the tool resolves correctly via `resources list --source remote` after deploy |
|
|
11
11
|
| Refresh imports 0 of N bindings, no warnings | `bindings_v2.json` not at expected path (project root, not nested) | Move file to `<ProjectName>/bindings_v2.json`; `agent validate` regenerates it for agent projects |
|
|
12
12
|
| `processKey` collision on `solution publish` | Republishing same name+version | Bump version (`solution pack --version 1.0.1 …`); the feed rejects duplicate `name+version` pairs |
|
|
13
13
|
|
|
@@ -29,7 +29,7 @@ The right `referenceKey` for the Worker tool is the **solution-resource key** of
|
|
|
29
29
|
"name": "WorkerTool",
|
|
30
30
|
"type": "agent",
|
|
31
31
|
"location": "solution", // ← intra-solution, not "external"
|
|
32
|
-
"referenceKey": "<solution-resource-key-of-Worker>", // from `
|
|
32
|
+
"referenceKey": "<solution-resource-key-of-Worker>", // from `resources list --kind Process --source local`
|
|
33
33
|
"properties": {
|
|
34
34
|
"processName": "Worker",
|
|
35
35
|
"folderPath": "solution_folder"
|
|
@@ -40,13 +40,13 @@ The right `referenceKey` for the Worker tool is the **solution-resource key** of
|
|
|
40
40
|
## What happens at refresh + pack
|
|
41
41
|
|
|
42
42
|
- `solution projects add` writes `Worker.json` and `Coordinator.json` under `resources/solution_folder/process/agent/` with stable solution-resource keys (UUIDs minted by the SDK at add time).
|
|
43
|
-
- `
|
|
43
|
+
- `resources refresh` doesn't re-mint those keys — they're stable for the life of the solution.
|
|
44
44
|
- At pack, the Coordinator's `runtimeDependencies` entry for the Worker tool carries the same solution-resource key as `referenceKey`. Orchestrator's deploy pipeline resolves intra-solution links by matching this key to a sibling resource in the deployment.
|
|
45
45
|
|
|
46
46
|
## Gotchas
|
|
47
47
|
|
|
48
48
|
- **Don't put the cloud key of a different (already-published) Worker** if you intend to ship Worker as part of this solution. `referenceKey` to a cloud key skips the intra-solution link and points the runtime at the cloud copy — which may or may not exist in the target tenant at deploy time.
|
|
49
|
-
- **The solution-resource key is stable across refreshes within an instance** but **regenerates if you delete and re-create the solution** (`solution init` → mint fresh UUIDs). Hard-coding the key in `resource.json` survives normal refresh cycles but breaks if anyone wipes-and-recreates. If that's a risk, rebuild the file from `
|
|
49
|
+
- **The solution-resource key is stable across refreshes within an instance** but **regenerates if you delete and re-create the solution** (`solution init` → mint fresh UUIDs). Hard-coding the key in `resource.json` survives normal refresh cycles but breaks if anyone wipes-and-recreates. If that's a risk, rebuild the file from `resources list --kind Process --source local` output as part of CI.
|
|
50
50
|
- **`location` must be `"solution"`, not `"external"`** for intra-solution tools. SW UI shows external-tool dialogs differently and won't render the link state correctly.
|
|
51
51
|
- **Worker → Coordinator cycles**: nothing prevents you from declaring a tool in Worker that points back at Coordinator. The runtime supports it; if the agent prompts loop, that's an authoring issue, not a deploy one.
|
|
52
52
|
|
|
@@ -89,7 +89,7 @@ After any solution-level edit, run a sanity check:
|
|
|
89
89
|
uip solution resources list --kind <kind> --solution-folder . --source local --output json
|
|
90
90
|
```
|
|
91
91
|
|
|
92
|
-
The list should show your resource with the new spec. If `
|
|
92
|
+
The list should show your resource with the new spec. If `resources refresh` reverts the change on the next run, you edited a field the bindings re-derive — back out and use the deploy-config path or SW UI instead.
|
|
93
93
|
|
|
94
94
|
## Deploy config files (`deploy-config.json`)
|
|
95
95
|
|
|
@@ -23,8 +23,8 @@ Land here from a grep on an error message? Pick the matching row.
|
|
|
23
23
|
| I want to import one existing remote resource into the solution | `uip solution resources add --source remote --kind <kind> --name <name> --folder-path <folder>` — see [develop-solution.md Step 9](develop-solution.md#step-9-add-a-resource-atomically) |
|
|
24
24
|
| I want to delete a single resource by key | `uip solution resources remove <resource-key>` — see [develop-solution.md Step 10](develop-solution.md#step-10-remove-a-resource) |
|
|
25
25
|
| I want to change a field on an existing resource's spec | `uip solution resources edit <resource-key> --patch '{...}'` — see [develop-solution.md Step 11](develop-solution.md#step-11-edit-a-resource) |
|
|
26
|
-
| I edited a spec field but `refresh` didn't pick it up | Expected — `refresh` never overwrites a resource already in the solution. Use `
|
|
27
|
-
| `
|
|
26
|
+
| I edited a spec field but `refresh` didn't pick it up | Expected — `refresh` never overwrites a resource already in the solution. Use `resources edit` to mutate spec. |
|
|
27
|
+
| `resources edit` silently ignored a property I passed | The SDK skips unknown / reference / read-only props by design — see [manual-edits](scenarios/manual-edits.md) for what's editable vs not |
|
|
28
28
|
| My hand-edit got reverted on the next refresh | [manual-edits](scenarios/manual-edits.md) (the SDK re-derives bindings) |
|
|
29
29
|
| Other deploy / refresh failures (folder collision, suffix amplification, missing bindings, version collision) | [failure-modes](scenarios/failure-modes.md) |
|
|
30
30
|
|
|
@@ -62,10 +62,10 @@ MySolution/
|
|
|
62
62
|
│ └── source/dist/ <- Build output (bundlePath: "source/dist").
|
|
63
63
|
├── resources/ <- Auto-generated on add/import. NEVER hand-edit.
|
|
64
64
|
│ └── solution_folder/
|
|
65
|
-
│ ├── package/<name>.json <- Auto-created on add. NOT cleaned by `
|
|
65
|
+
│ ├── package/<name>.json <- Auto-created on add. NOT cleaned by `projects remove`.
|
|
66
66
|
│ ├── process/{process,flow}/<name>.json <- Auto-created on add. Auto-cleaned on remove.
|
|
67
67
|
│ └── app/{Coded,CodedAction}/<name>.json <- AppV2 apps only. `kind: "app"`, `apiVersion: apps.uipath.com/v1`.
|
|
68
|
-
└── userProfile/<user-uuid>/ <- Appears after first `
|
|
68
|
+
└── userProfile/<user-uuid>/ <- Appears after first `projects remove`.
|
|
69
69
|
```
|
|
70
70
|
|
|
71
71
|
> `.uipx` and `resources/solution_folder/` must always agree on the set of projects. Diffing them is the fastest way to detect a corrupted state — see [develop-solution.md - Field-tested gotchas](develop-solution.md#field-tested-gotchas).
|
|
@@ -110,12 +110,14 @@ uip solution
|
|
|
110
110
|
├── restore <solution> Resolve NuGet deps in place before pack (needs login; no package produced)
|
|
111
111
|
├── pack <solution> <output> Pack into a deployable .zip package
|
|
112
112
|
├── publish <package> Upload packed solution to UiPath
|
|
113
|
-
├── project
|
|
113
|
+
├── projects (`project` still works as a hidden, deprecated alias)
|
|
114
114
|
│ ├── add <project-path> [solutionFile] Register an existing subfolder in .uipx
|
|
115
115
|
│ ├── remove <project-path> [solutionFile] Unregister a project from .uipx
|
|
116
|
-
│ ├── import
|
|
117
|
-
│
|
|
118
|
-
├──
|
|
116
|
+
│ ├── import <path> Copy external project into solution and register
|
|
117
|
+
│ ├── list List projects registered in the local .uipx (no backend call)
|
|
118
|
+
│ ├── publish Publish a cloud solution project as a package (--project-name, --package-name, --package-version)
|
|
119
|
+
│ └── resync [project-name] Sync or reset a cloud solution project (--sync-option Sync|Reset)
|
|
120
|
+
├── resources
|
|
119
121
|
│ ├── list List local, remote, or all resources (--solution-folder, default cwd)
|
|
120
122
|
│ ├── refresh Sync resource declarations from project bindings (--solution-folder, default cwd)
|
|
121
123
|
│ ├── get <resource-key> Get full configuration for a single resource — local or remote (--solution-folder, default cwd)
|
|
@@ -127,18 +129,25 @@ uip solution
|
|
|
127
129
|
│ ├── status <id> Check deployment status
|
|
128
130
|
│ ├── list List deployments
|
|
129
131
|
│ ├── activate <name> Activate a deployment (only needed after --skip-activate or to retry a failed auto-activation)
|
|
132
|
+
│ ├── upgrade <deployment-key> Move a deployment to a newer package version in place, keeping its existing configuration
|
|
130
133
|
│ ├── uninstall <name> Uninstall a deployment
|
|
131
134
|
│ └── config
|
|
132
135
|
│ ├── get <package-name> Fetch default deploy config
|
|
133
136
|
│ ├── set <file> ... Set a resource property in config
|
|
134
137
|
│ ├── link <file> <resource> Link to an existing Orchestrator resource
|
|
135
138
|
│ └── unlink <file> <resource> Remove a resource link
|
|
139
|
+
├── feeds
|
|
140
|
+
│ └── list List the feeds you can publish or deploy to (tenant, your Personal Workspace, folder feeds)
|
|
136
141
|
└── packages
|
|
137
142
|
├── list List published solution packages
|
|
138
143
|
├── download <name> [version] Download a published solution package .zip
|
|
139
144
|
└── delete <name> <version> Delete a specific package version
|
|
140
145
|
```
|
|
141
146
|
|
|
147
|
+
`publish`, `deploy run`, `deploy list`, `packages list` and `packages delete` all take
|
|
148
|
+
`--feed <name-or-key>` or `--personal-workspace` to target a feed other than the
|
|
149
|
+
tenant's. See [Pack and Deploy — Publishing to a non-tenant feed](pack-and-deploy.md#publishing-to-a-non-tenant-feed).
|
|
150
|
+
|
|
142
151
|
---
|
|
143
152
|
|
|
144
153
|
## Workflow References
|
|
@@ -124,25 +124,25 @@ uip tasks complete <task-id> --type ExternalTask --folder-id <folder-id> --outpu
|
|
|
124
124
|
|
|
125
125
|
2. **Task IDs are numeric.** Unlike other UiPath services that use GUIDs, Action Center uses numeric task IDs. Use `tasks list` to discover task IDs.
|
|
126
126
|
|
|
127
|
-
3. **Folder
|
|
127
|
+
3. **Folder scope comes in three interchangeable forms.** Folder-scoped commands accept `--folder-id <numeric-id>`, `--folder-path <path>`, or `--folder-key <guid>` (mutually exclusive). Path and key are exactly what `uip or folders list` prints (it has no numeric ID column), so prefer them when the folder came from folder discovery; the numeric id still works when a task row gave you `folderId`.
|
|
128
128
|
|
|
129
129
|
4. **Complete requires `--type`.** The API routes to different endpoints per task type. Always include `--type` when completing a task. Use `tasks get` to check the task type first.
|
|
130
130
|
|
|
131
131
|
5. **FormTask and AppTask require `--action` and `--data` for completion.** Other task types allow optional action and data.
|
|
132
132
|
|
|
133
|
-
6. **Assign accepts `--user-id` or `--user` (email).** Use `tasks users <folder-id>` to discover assignable users and their IDs.
|
|
133
|
+
6. **Assign accepts `--user-id` or `--user` (email).** Use `tasks users <folder-id>` (or `tasks users --folder-path <path>` / `--folder-key <guid>`) to discover assignable users and their IDs.
|
|
134
134
|
|
|
135
135
|
7. **Always discover before acting.** Use `tasks list` or `tasks get` to inspect task state before performing assign/complete operations.
|
|
136
136
|
|
|
137
137
|
8. **Do not complete already-completed tasks.** Check the task `status` field — if it is `Completed`, inform the user.
|
|
138
138
|
|
|
139
|
-
9. **Folder
|
|
139
|
+
9. **Folder scope for complete/catalogs/comments/labels/metadata/data.** These commands need a folder. Pass one of `--folder-id`/`--folder-path`/`--folder-key`, or omit all three on an interactive terminal to pick from a list. A folder option is required in non-interactive runs (agents, CI) — the command fails with `A folder is required` otherwise, so always pass one explicitly there.
|
|
140
140
|
|
|
141
141
|
10. **Retention actions are `Delete` or `Archive`.** `Archive` also needs `--retention-bucket-id`. `--encrypted` is create-only and cannot be changed on update.
|
|
142
142
|
|
|
143
143
|
11. **Labels replace the full set.** `tasks labels --labels` overwrites all labels on the task — include every label to keep, and pass `[]` to clear them all.
|
|
144
144
|
|
|
145
|
-
12. **`data save` takes no type flag.** The command resolves the task type itself; pass the task ID, `--folder-id
|
|
145
|
+
12. **`data save` takes no type flag.** The command resolves the task type itself; pass the task ID, a folder option (`--folder-id`/`--folder-path`/`--folder-key`), and `--data` (a JSON object).
|
|
146
146
|
|
|
147
147
|
---
|
|
148
148
|
|
|
@@ -152,6 +152,7 @@ uip tasks complete <task-id> --type ExternalTask --folder-id <folder-id> --outpu
|
|
|
152
152
|
|------|----------------|
|
|
153
153
|
| List all tasks | `tasks list` |
|
|
154
154
|
| List tasks in a folder | `tasks list --folder-id <id>` |
|
|
155
|
+
| List tasks in a folder by path/key | `tasks list --folder-path "<path>"` or `tasks list --folder-key <guid>` |
|
|
155
156
|
| List tasks as admin | `tasks list --as-admin` |
|
|
156
157
|
| Get task details | `tasks get <task-id>` |
|
|
157
158
|
| Get task with type hint | `tasks get <task-id> --task-type FormTask --folder-id <id>` |
|
|
@@ -161,14 +162,14 @@ uip tasks complete <task-id> --type ExternalTask --folder-id <folder-id> --outpu
|
|
|
161
162
|
| Unassign a task | `tasks unassign <task-id>` |
|
|
162
163
|
| Complete a task | `tasks complete <task-id> --type <type> --folder-id <id>` |
|
|
163
164
|
| Complete with action | `tasks complete <task-id> --type FormTask --folder-id <id> --action "Approve" --data '{...}'` |
|
|
164
|
-
| List assignable users | `tasks users <folder-id>` |
|
|
165
|
+
| List assignable users | `tasks users <folder-id>`, `tasks users --folder-path "<path>"`, or `tasks users --folder-key <guid>` |
|
|
165
166
|
| List task catalogs | `tasks catalogs list --folder-id <id>` |
|
|
166
167
|
| Get a catalog | `tasks catalogs get <catalog-id> --folder-id <id>` |
|
|
167
168
|
| Create a catalog | `tasks catalogs create --name <name> --folder-id <id>` |
|
|
168
169
|
| Update a catalog | `tasks catalogs update <catalog-id> --folder-id <id>` |
|
|
169
170
|
| List task comments | `tasks comments list <task-id> --folder-id <id>` |
|
|
170
171
|
| Add a comment | `tasks comments add <task-id> --text <text> --folder-id <id>` |
|
|
171
|
-
| Set task labels | `tasks labels <task-id> --labels '[{"name":"
|
|
172
|
+
| Set task labels | `tasks labels <task-id> --labels '[{"name":"region","displayName":"Region","displayValue":"EMEA"}]' --folder-id <id>` |
|
|
172
173
|
| Edit task metadata | `tasks metadata <task-id> --folder-id <id> [--title --priority --catalog-id]` |
|
|
173
174
|
| Get task data | `tasks data get <task-id> --folder-id <id>` |
|
|
174
175
|
| Save task data | `tasks data save <task-id> --data '{...}' --folder-id <id>` |
|
|
@@ -216,6 +217,10 @@ uip tasks get <task-id> --output json
|
|
|
216
217
|
| Completion fails | Wrong `--type` | Use `tasks get` to check the actual task type |
|
|
217
218
|
| Completion fails for FormTask | Missing `--action` or `--data` | FormTask and AppTask require both `--action` and `--data` |
|
|
218
219
|
| Cannot assign | User lacks permissions in folder | Run `tasks users <folder-id>` to list eligible users |
|
|
220
|
+
| `A folder is required` | Non-interactive run without a folder option | Pass `--folder-id`, `--folder-path`, or `--folder-key` |
|
|
221
|
+
| `Folder not found: '<value>'.` | The path/key doesn't match a folder this login can access | Run `uip or folders list` and use a listed `Path` or `Key` |
|
|
222
|
+
| `Invalid --folder-key: <value>` | The key is not a UUID | Use the GUID from the `Key` column of `uip or folders list` |
|
|
223
|
+
| `Error resolving folder path/key '<value>'` | The folder lookup itself failed (permissions or network) | Check the error detail in `Instructions`; verify access with `uip or folders list` |
|
|
219
224
|
|
|
220
225
|
---
|
|
221
226
|
|
|
@@ -6,6 +6,11 @@ Before assigning a task, discover which users have task permissions in the folde
|
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
8
|
uip tasks users <folder-id> --output json
|
|
9
|
+
|
|
10
|
+
# Or by folder path/key — the values `uip or folders list` prints.
|
|
11
|
+
# Quote the path: folder paths may contain spaces.
|
|
12
|
+
uip tasks users --folder-path "<folder-path>" --output json
|
|
13
|
+
uip tasks users --folder-key <folder-key> --output json
|
|
9
14
|
```
|
|
10
15
|
|
|
11
16
|
Response includes user details:
|
|
@@ -10,10 +10,13 @@ another, and catalog IDs are numeric. See the
|
|
|
10
10
|
|
|
11
11
|
## Folder scoping
|
|
12
12
|
|
|
13
|
-
Every catalog command needs a folder
|
|
14
|
-
`--folder-id
|
|
15
|
-
|
|
16
|
-
|
|
13
|
+
Every catalog command needs a folder, given one of three mutually exclusive
|
|
14
|
+
ways: `--folder-id <numeric-id>`, `--folder-path <path>`, or
|
|
15
|
+
`--folder-key <guid>` (path and key are what `uip or folders list` prints). In
|
|
16
|
+
an interactive terminal you can omit all three and pick a folder from a list.
|
|
17
|
+
In a non-interactive run (a coding agent or CI, where no picker can be shown)
|
|
18
|
+
you must pass one explicitly, otherwise the command fails with
|
|
19
|
+
`A folder is required`.
|
|
17
20
|
|
|
18
21
|
## List
|
|
19
22
|
|
|
@@ -88,7 +88,9 @@ Before completing a task, always verify:
|
|
|
88
88
|
|
|
89
89
|
3. **Folder ID matches:**
|
|
90
90
|
```bash
|
|
91
|
-
# The "folderId" field in the response gives you the --folder-id value
|
|
91
|
+
# The "folderId" field in the response gives you the --folder-id value.
|
|
92
|
+
# If you only know the folder from `uip or folders list`, pass its Path or
|
|
93
|
+
# Key instead: --folder-path <path> / --folder-key <guid>.
|
|
92
94
|
```
|
|
93
95
|
|
|
94
96
|
## SLA Tracking
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
Task data is the business/form field payload attached to a task: a JSON object of
|
|
4
4
|
key/value pairs whose keys are the task's schema fields (the values an approver
|
|
5
|
-
reviews). Folder-scoped: pass `--folder-id <id
|
|
6
|
-
|
|
7
|
-
Task IDs are numeric.
|
|
5
|
+
reviews). Folder-scoped: pass `--folder-id <id>` (or `--folder-path <path>` /
|
|
6
|
+
`--folder-key <guid>`), or omit them in an interactive terminal to pick a folder
|
|
7
|
+
(in a non-interactive run you must pass one). Task IDs are numeric.
|
|
8
8
|
|
|
9
9
|
## Get data
|
|
10
10
|
|
|
@@ -9,10 +9,19 @@ uip tasks list --output json
|
|
|
9
9
|
# List tasks in a specific folder
|
|
10
10
|
uip tasks list --folder-id <folder-id> --output json
|
|
11
11
|
|
|
12
|
+
# Same, by folder path or key — the values `uip or folders list` prints.
|
|
13
|
+
# Quote the path: folder paths may contain spaces.
|
|
14
|
+
uip tasks list --folder-path "<folder-path>" --output json
|
|
15
|
+
uip tasks list --folder-key <folder-key> --output json
|
|
16
|
+
|
|
12
17
|
# List tasks as admin (elevated access)
|
|
13
18
|
uip tasks list --as-admin --output json
|
|
14
19
|
```
|
|
15
20
|
|
|
21
|
+
`--folder-id`, `--folder-path`, and `--folder-key` are mutually exclusive. Path
|
|
22
|
+
and key are resolved to the numeric folder id before the task query runs, so
|
|
23
|
+
all three scope the same way.
|
|
24
|
+
|
|
16
25
|
## Getting Task Details
|
|
17
26
|
|
|
18
27
|
```bash
|
|
@@ -38,6 +47,8 @@ Type-specific endpoints are faster because they avoid the generic OData lookup:
|
|
|
38
47
|
# 1. List tasks and discover folder users
|
|
39
48
|
uip tasks list --output json
|
|
40
49
|
uip tasks users <folder-id> --output json
|
|
50
|
+
# (or by path/key when the folder came from `uip or folders list`:
|
|
51
|
+
# uip tasks users --folder-path "<folder-path>" --output json)
|
|
41
52
|
|
|
42
53
|
# 2. Assign to a user
|
|
43
54
|
uip tasks assign <task-id> --user alice@company.com --output json
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
# Task Metadata, Comments & Labels Reference
|
|
2
2
|
|
|
3
3
|
Operations that annotate or reorganize an existing task. All are folder-scoped:
|
|
4
|
-
pass `--folder-id <id
|
|
5
|
-
|
|
4
|
+
pass `--folder-id <id>` (or `--folder-path <path>` / `--folder-key <guid>`), or
|
|
5
|
+
omit them on an interactive terminal to pick a folder (a folder option is
|
|
6
|
+
required when stdout is not a TTY). Task IDs are numeric.
|
|
6
7
|
|
|
7
8
|
## Edit metadata
|
|
8
9
|
|
|
@@ -60,7 +61,7 @@ keep. Use `[]` to clear all labels.
|
|
|
60
61
|
|
|
61
62
|
```bash
|
|
62
63
|
# Set labels
|
|
63
|
-
uip tasks labels <task-id> --folder-id <folder-id> --labels '[{"name":"
|
|
64
|
+
uip tasks labels <task-id> --folder-id <folder-id> --labels '[{"name":"region","displayName":"Region","displayValue":"EMEA"}]' --output json
|
|
64
65
|
|
|
65
66
|
# Clear all labels
|
|
66
67
|
uip tasks labels <task-id> --folder-id <folder-id> --labels '[]' --output json
|