@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
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# Job Mode Guide
|
|
2
|
+
|
|
3
|
+
How a JS/TS coded function executes as an Orchestrator job: the runtime context, `ctx` in job mode, fault semantics, the StandardError→JobErrorData contract, and job logging. Local one-shot parity → [local-dev-guide.md](local-dev-guide.md); deploy/release mechanics → [deployment-guide.md](deployment-guide.md).
|
|
4
|
+
|
|
5
|
+
## The Model
|
|
6
|
+
|
|
7
|
+
A function has exactly one calling mode, selected by its declaration:
|
|
8
|
+
|
|
9
|
+
- **Run-as-job** — `method` + `path` omitted. Started by anything that can start an Orchestrator job on the function's release: the job-start API, a schedule or trigger, a Maestro process, an RPA process, an agent, or another coded function. This guide's subject.
|
|
10
|
+
- **HTTP** — `method` + `path` declared: called synchronously through the Orchestrator HTTP trigger ([http-semantics-guide.md](http-semantics-guide.md)). Under the hood the trigger executes each call as a job (which is why the fault semantics below also apply), but the function's one caller surface is its trigger.
|
|
11
|
+
|
|
12
|
+
Do not design a function for both modes. The runtime does not yet enforce the split (an HTTP-declared function can currently be started as a plain job) — that is an enforcement gap, never a supported pattern. Logic needed on both surfaces: two thin `defineFunction` entries sharing a `_`-prefixed helper module in one project — the `bindings_v2.json` HttpTrigger row exists only for the HTTP one ([bindings-guide.md](bindings-guide.md)).
|
|
13
|
+
|
|
14
|
+
### Picking the mode (a design-time choice)
|
|
15
|
+
|
|
16
|
+
| | HTTP | Run-as-job |
|
|
17
|
+
|---|---|---|
|
|
18
|
+
| Caller | any HTTP client with a platform token (Coded App, service, curl) | any job-starter (API, schedule/trigger, Maestro, RPA, another function) |
|
|
19
|
+
| Timing | synchronous; 25 s gateway budget ([SKILL.md](../../SKILL.md) JS Rule 6) | job lifecycle; the 25 s gateway budget does not apply |
|
|
20
|
+
| Caller identity | `ctx.user` = caller's delegated token | no caller identity — `ctx.robot` only |
|
|
21
|
+
| Errors surface as | HTTP status + `{error, details?}` body | Faulted job + the StandardError contract below |
|
|
22
|
+
| Result | HTTP response body | job output arguments |
|
|
23
|
+
|
|
24
|
+
Pick HTTP when a synchronous answer goes back to an interactive caller; pick run-as-job for long-running, scheduled, or orchestrated work, or when the caller is itself a job.
|
|
25
|
+
|
|
26
|
+
## How a Job Run Executes
|
|
27
|
+
|
|
28
|
+
One process, one job, one function. The platform writes `.uipath/run/runtime-context.json`; the runtime reads it, imports only the target module (no HTTP server, no route table), validates input, runs the handler, validates output, and reports one terminal job result.
|
|
29
|
+
|
|
30
|
+
| runtime-context field | Effect |
|
|
31
|
+
|---|---|
|
|
32
|
+
| `workloadAccessToken` | → `ctx.robot.accessToken` — the job's robot identity |
|
|
33
|
+
| `robotKey` | → `ctx.robot.key` |
|
|
34
|
+
| `baseUrl`, `orgId`, `tenantId`, `folderKey` | → `ctx.platform` (all-or-nothing rule → [authoring-guide.md](authoring-guide.md) FunctionContext table) |
|
|
35
|
+
| `jobId` | serverless-internal job id, echoed in the result — not the Orchestrator JobKey |
|
|
36
|
+
| `jobApiEndpoint` | IPC endpoint (named pipe / unix socket) for result + log reporting; absent locally — result goes to stdout |
|
|
37
|
+
| `resourceOverwrites` | not on `ctx` — installed process-wide for `@uipath/uipath-typescript` to read; see [bindings-guide.md](bindings-guide.md) |
|
|
38
|
+
|
|
39
|
+
## ctx in Job Mode
|
|
40
|
+
|
|
41
|
+
- `ctx.user` carries no caller identity — there is no HTTP caller. Treat it as null, but do not test `if (!ctx.user)` to detect job mode: the current runtime sets a legacy compat object (`{workloadAccessToken}`, for packages built against SDK < 0.5) whenever a robot token exists. Check `ctx.user?.accessToken` instead.
|
|
42
|
+
- `ctx.robot` is populated from the runtime context (`{key, accessToken}`); null when the context provides neither field (e.g. a bare local `uip function run`).
|
|
43
|
+
- `ctx.params` and `ctx.headers` are `{}` — the job key does NOT surface in a pure job run. `ctx.headers["x-uipath-jobkey"]` exists only on deployed HTTP-triggered executions (→ [authoring-guide.md](authoring-guide.md) FunctionContext table).
|
|
44
|
+
- `ctx.platform` comes only from the context file; local token/coordinate fallbacks → [local-dev-guide.md](local-dev-guide.md).
|
|
45
|
+
|
|
46
|
+
## Fault Semantics
|
|
47
|
+
|
|
48
|
+
Handler outcome → job status:
|
|
49
|
+
|
|
50
|
+
| Handler outcome | Job result |
|
|
51
|
+
|---|---|
|
|
52
|
+
| Plain return value passing the output schema | Successful; value = job output arguments |
|
|
53
|
+
| `FunctionResponse` / raw `Response`, status < 400 | Successful; body = output (raw body JSON-parsed when possible); output schema skipped |
|
|
54
|
+
| `FunctionResponse` / raw `Response`, status >= 400 | **Faulted** — a returned error response is an error outcome, not output |
|
|
55
|
+
| Thrown `FunctionError` | **Faulted**, author-controlled error fields |
|
|
56
|
+
| Any other throw | **Faulted**, `JsCodedFunction.HandlerError` |
|
|
57
|
+
| Return value failing the output schema | **Faulted**, `JsCodedFunction.OutputValidationFailed` |
|
|
58
|
+
| Input failing the input schema | **Faulted**, `JsCodedFunction.ValidationFailed` — the handler never runs |
|
|
59
|
+
|
|
60
|
+
## The Error Contract
|
|
61
|
+
|
|
62
|
+
Every fault renders as one `StandardError {code, title, detail, category, status}` and travels field-for-field to Orchestrator's `JobErrorData` (the job error info). Job-surface only — HTTP error bodies keep the `{error, details?}` shape ([http-semantics-guide.md](http-semantics-guide.md)).
|
|
63
|
+
|
|
64
|
+
| StandardError field | From `FunctionError` | From plain throw |
|
|
65
|
+
|---|---|---|
|
|
66
|
+
| `code` | `errorCode` (default `JsCodedFunction.FunctionError`) | `JsCodedFunction.HandlerError` |
|
|
67
|
+
| `title` | `message` | `message` |
|
|
68
|
+
| `detail` | `details` (string as-is, else JSON-stringified) | stack |
|
|
69
|
+
| `status` | `status` (absent when not given — never invented) | absent |
|
|
70
|
+
| `category` | `User` | `User` |
|
|
71
|
+
|
|
72
|
+
System-category failures (the runtime's own machinery) are sanitized: generic title/detail on every surface, real error only in the runtime logs.
|
|
73
|
+
|
|
74
|
+
### Emitted error codes (all `JsCodedFunction.`-prefixed)
|
|
75
|
+
|
|
76
|
+
| Code | Emitted when |
|
|
77
|
+
|---|---|
|
|
78
|
+
| `FunctionError` | `FunctionError` thrown without explicit `errorCode` |
|
|
79
|
+
| `HandlerError` | unanticipated throw from handler code |
|
|
80
|
+
| `ErrorResponse` | handler returned (not threw) a status >= 400 response |
|
|
81
|
+
| `ValidationFailed` | input rejected by the input schema |
|
|
82
|
+
| `OutputValidationFailed` | output rejected by the output schema |
|
|
83
|
+
| `InvalidInput` | job input was not valid JSON |
|
|
84
|
+
| `InvalidFunctionDefinition` | target function/module could not be resolved or loaded (category Deployment) |
|
|
85
|
+
| `RunFailed` | one-shot run failed outside the handler |
|
|
86
|
+
| `InternalError` | runtime machinery failed (category System) |
|
|
87
|
+
|
|
88
|
+
### FunctionError for job-only functions
|
|
89
|
+
|
|
90
|
+
A job fault has no inherent HTTP status — use the status-less options form instead of inventing one:
|
|
91
|
+
|
|
92
|
+
```typescript
|
|
93
|
+
throw new FunctionError("Contract already renewed", { errorCode: "ALREADY_RENEWED" });
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Job error info shows `code: "ALREADY_RENEWED"`, `title: "Contract already renewed"`, `category: "User"`, no `status`. Full constructor forms and the `(message, status)` argument-order gotcha → [authoring-guide.md](authoring-guide.md).
|
|
97
|
+
|
|
98
|
+
## Job Logging
|
|
99
|
+
|
|
100
|
+
Only SDK `logger.*` reaches Orchestrator job logs ([SKILL.md](../../SKILL.md) JS Rule 10). Job mode adds two specifics: forwarding is installed before the target module is imported, so `logger.*` calls at module top level are captured for the job too; and all forwarded logs are flushed before the result is reported, so nothing is lost to a fast exit. Logs are scoped to the job. `console.*` prints to process output only.
|
|
101
|
+
|
|
102
|
+
## Local Parity: uip function run
|
|
103
|
+
|
|
104
|
+
`uip function run` executes the same one-shot code path the platform uses — same validation, same fault semantics, same StandardError rendering — with the exit code mirroring the job outcome (0 Successful, 1 Faulted):
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
uip function run --function <FUNCTION_NAME> --input-file input.json --context-file ctx.json
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
`--context-file` / `--context` inject a runtime-context JSON to simulate platform fields (`workloadAccessToken`, `baseUrl`, `orgId`, `tenantId`, `folderKey`, …). Flags, env fallbacks, and runtime selection → [local-dev-guide.md](local-dev-guide.md).
|
|
111
|
+
|
|
112
|
+
## Starting Deployed Functions as Jobs
|
|
113
|
+
|
|
114
|
+
There is no function-specific job API. Publish the package and update the Function Release to the new version ([SKILL.md](../../SKILL.md) JS Rule 12), then start jobs the standard Orchestrator way against that release — any job-starter works: the job-start API, a schedule or trigger, a Maestro process, an RPA process, or another coded function. The job's input arguments are validated against the function's input schema before the handler runs. Release update, versioning, and invoke mechanics → [deployment-guide.md](deployment-guide.md).
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# Local Development Guide
|
|
2
|
+
|
|
3
|
+
The local loop for JS/TS coded functions: `uip function serve` for the HTTP surface, `uip function run` for one-shot job execution, plus the env/ctx differences between local and deployed. Handler authoring → [authoring-guide.md](authoring-guide.md); deployed behavior → [deployment-guide.md](deployment-guide.md).
|
|
4
|
+
|
|
5
|
+
## `uip function serve` — local HTTP server
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
uip function serve [--port 7070] [--runtime node|deno]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
- Hot reload; auto-syncs the `uipath.json` functions map on start.
|
|
12
|
+
- Default port `7070`. Sharp edge: serve frees its port by killing whatever process currently holds it — anything else listening there dies. Run with `--port <PORT>` when another dev server you care about might occupy the default.
|
|
13
|
+
- `--runtime node` (default) or `deno` — the choice matters for `.env` loading (below).
|
|
14
|
+
- `GET http://localhost:7070/` = health check + list of all registered routes. Use it to confirm your function file was picked up.
|
|
15
|
+
- CORS is open ([http-semantics-guide.md](http-semantics-guide.md#cors)) — a browser app on another port (e.g. Vite `:5173`) fetches directly; never add a dev proxy. Frontend wiring → [coded-app-wiring-guide.md](coded-app-wiring-guide.md).
|
|
16
|
+
|
|
17
|
+
## The `.env` problem
|
|
18
|
+
|
|
19
|
+
Node cannot auto-load `.env`: the CLI's `--env-file` injection breaks in some environments (`node: --env-file= is not allowed in NODE_OPTIONS`). Two working options:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
# Option A — Deno reads .env natively
|
|
23
|
+
uip function serve --runtime deno
|
|
24
|
+
|
|
25
|
+
# Option B — load .env into the shell, then serve on Node
|
|
26
|
+
set -a && source .env && set +a
|
|
27
|
+
uip function serve
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
`.env` for local platform access:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
UIPATH_ACCESS_TOKEN=<OAUTH_TOKEN>
|
|
34
|
+
UIPATH_BASE_URL=https://cloud.uipath.com
|
|
35
|
+
UIPATH_ORG_ID=<ORG_UUID>
|
|
36
|
+
UIPATH_TENANT_ID=<TENANT_UUID>
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## What is null locally
|
|
40
|
+
|
|
41
|
+
| ctx field | Deployed source | Under local serve |
|
|
42
|
+
|---|---|---|
|
|
43
|
+
| `ctx.user` | Gateway-forwarded caller identity | null unless the request carries `Authorization: Bearer <JWT>` — claims decoded straight from the token, so send a real token to exercise auth paths |
|
|
44
|
+
| `ctx.robot` | Platform-injected robot-identity headers | always null — nothing sends those headers locally |
|
|
45
|
+
| `ctx.platform` | Platform-injected `X-UiPath-*` headers (HTTP) / `runtime-context.json` (job) | null unless `UIPATH_BASE_URL` + `UIPATH_ORG_ID` + `UIPATH_TENANT_ID` are all set (all-or-nothing rule → [authoring-guide.md](authoring-guide.md)) |
|
|
46
|
+
|
|
47
|
+
Token fallback in handlers (robot-first to `UIPATH_ACCESS_TOKEN` — the local fallback for both identities) → [calling-uipath-apis-guide.md](calling-uipath-apis-guide.md). Never read base URL/org/tenant from input ([SKILL.md](../../SKILL.md) JS Rule 9).
|
|
48
|
+
|
|
49
|
+
## Testing the HTTP surface
|
|
50
|
+
|
|
51
|
+
curl/fetch against the serve server — there is no `uip`-exposed invoke command ([SKILL.md](../../SKILL.md) JS Rule 13):
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
curl -s http://localhost:7070/ # health + route list
|
|
55
|
+
curl -s "http://localhost:7070/invoices?limit=5" # GET: query string is the input
|
|
56
|
+
curl -s -X POST http://localhost:7070/invoice \
|
|
57
|
+
-H 'Content-Type: application/json' \
|
|
58
|
+
-H "Authorization: Bearer $UIPATH_ACCESS_TOKEN" \
|
|
59
|
+
-d '{"invoiceId":"INV-1"}'
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Local-only leniency: an empty or unparseable POST body becomes `{}` before schema validation; deployed, the gateway rejects it ([http-semantics-guide.md](http-semantics-guide.md)) — always send `-d '{}'` so the habit carries to production. Deployed-only failure modes → [deployment-guide.md](deployment-guide.md).
|
|
63
|
+
|
|
64
|
+
## `uip function run` — one-shot local job execution
|
|
65
|
+
|
|
66
|
+
Runs one function to completion with no server — the same code path a production job run uses. Job semantics, not an HTTP call ([SKILL.md](../../SKILL.md) JS Rule 13).
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
uip function run --function <NAME> --input '{"key":"value"}'
|
|
70
|
+
uip function run --entrypoint functions/<FILE>.ts --input-file <INPUT_JSON_PATH>
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
| Flag | Meaning |
|
|
74
|
+
|---|---|
|
|
75
|
+
| `--function <NAME>` \| `--entrypoint <PATH>` | Target — exactly one: name resolved via `uipath.json`, or file path |
|
|
76
|
+
| `--input '<JSON>'` \| `--input-file <PATH>` | Input payload (default `{}`; file takes priority) |
|
|
77
|
+
| `--context '<JSON>'` \| `--context-file <PATH>` | Runtime-context JSON — simulate job identity/platform values (file takes priority) |
|
|
78
|
+
| `--runtime node\|deno` | Runtime (default `node`) |
|
|
79
|
+
|
|
80
|
+
Exit code mirrors the job outcome: non-zero when the run would Fault. Fault mapping and the runtime-context shape → [job-mode-guide.md](job-mode-guide.md).
|
|
81
|
+
|
|
82
|
+
Sharp edge: the CLI help for `run` may describe an HTTP invoke against the serve endpoint — that text is stale. `run` is the job runner; the flags above are the real surface and are forwarded correctly.
|
|
83
|
+
|
|
84
|
+
## Worked loop
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
# terminal 1
|
|
88
|
+
uip function serve --runtime deno
|
|
89
|
+
|
|
90
|
+
# terminal 2 — HTTP surface
|
|
91
|
+
curl -s http://localhost:7070/ # confirm the route registered
|
|
92
|
+
curl -s -X POST http://localhost:7070/invoice \
|
|
93
|
+
-H 'Content-Type: application/json' -d '{"invoiceId":"INV-1","amount":50}'
|
|
94
|
+
|
|
95
|
+
# job surface — same handler, job semantics
|
|
96
|
+
uip function run --function approve-invoice --input '{"invoiceId":"INV-1","amount":50}'
|
|
97
|
+
echo $? # 0 = Successful, non-zero = Faulted
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Mock at the network boundary
|
|
101
|
+
|
|
102
|
+
Not internal modules: stub `fetch`/HTTP responses so handler code runs unmodified — the same code that runs deployed. Module-level mocks hide the two classic local-passes-deployed-fails bugs:
|
|
103
|
+
|
|
104
|
+
- extensionless intra-project imports resolve locally but hang the deployed cold start with no logs — always `./_helpers.ts` ([SKILL.md](../../SKILL.md) JS Rule 4);
|
|
105
|
+
- empty POST body accepted locally, rejected `400 4804` deployed (above).
|
|
106
|
+
|
|
107
|
+
Both surface only in production — [deployment-guide.md](deployment-guide.md).
|
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
# Python Workflow Guide
|
|
2
|
+
|
|
3
|
+
The end-to-end Python Coded Function workflow: scaffold → schema → logic → registration → dependencies → entry points → SDK usage → pack/publish. Language split and shared rules → [SKILL.md](../../SKILL.md).
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
## Step 1: Scaffold
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
uip function new <name> --language py # Python Coded Function
|
|
11
|
+
uip function new <name> --language ts # TypeScript Function → ../js/
|
|
12
|
+
uip function new <name> --language js # JavaScript Function → ../js/
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
**`--language py` is required for Python.** The default language is TypeScript — omitting `--language` scaffolds a JS/TS project. Always pass `-l py` or `--language py` when building a Python Coded Function.
|
|
16
|
+
|
|
17
|
+
`--empty` skips the hello-world function (JS/TS only).
|
|
18
|
+
|
|
19
|
+
**The scaffold follows the installed packages.** With a framework package present in the environment (`uipath-langchain`, `llama-index`, `openai-agents`), `uip function new -l py` emits that framework's **agent** scaffold — `langgraph.json` plus an LLM `main.py` — not a function scaffold. Expected behaviour, not a broken flag. Recovery, in one pass:
|
|
20
|
+
|
|
21
|
+
1. Delete the framework config (`langgraph.json` and equivalents).
|
|
22
|
+
2. Replace `main.py` with the function template (Step 3).
|
|
23
|
+
3. Keep `pyproject.toml`'s `[project]` metadata (Step 5) — swap `dependencies` for what the function needs.
|
|
24
|
+
|
|
25
|
+
Do not re-run `new` with different flag spellings, and do not read CLI or SDK internals to explain the scaffold. Reshape the project and move on.
|
|
26
|
+
|
|
27
|
+
## Step 2: Define Function Schema
|
|
28
|
+
|
|
29
|
+
Use typed I/O. The SDK accepts pydantic `BaseModel`, `pydantic.dataclasses.dataclass`, a stdlib `@dataclass`, or a thin class with typed annotations. The shipped samples favor **pydantic** (`BaseModel` in csv-processor, `pydantic.dataclasses.dataclass` in calculator/greeter):
|
|
30
|
+
|
|
31
|
+
```python
|
|
32
|
+
from pydantic import BaseModel
|
|
33
|
+
|
|
34
|
+
class Input(BaseModel):
|
|
35
|
+
document_id: str = ""
|
|
36
|
+
|
|
37
|
+
class Output(BaseModel):
|
|
38
|
+
vendor_name: str = ""
|
|
39
|
+
total_amount: float = 0.0
|
|
40
|
+
error_type: str = "" # populated on failure, empty on success
|
|
41
|
+
error_message: str = "" # human-readable error detail
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Step 3: Implement Business Logic
|
|
45
|
+
|
|
46
|
+
**Do NOT make LLM calls inside a Coded Function.** LLM calls introduce non-determinism and latency that break the function contract. If the step requires LLM reasoning or multi-step AI decisions, use a framework-based agent (LangGraph, LlamaIndex, OpenAI Agents) instead.
|
|
47
|
+
|
|
48
|
+
### Minimal template
|
|
49
|
+
|
|
50
|
+
```python
|
|
51
|
+
from __future__ import annotations
|
|
52
|
+
|
|
53
|
+
from pydantic import BaseModel
|
|
54
|
+
from uipath.tracing import traced
|
|
55
|
+
from uipath.platform import UiPath
|
|
56
|
+
|
|
57
|
+
class Input(BaseModel):
|
|
58
|
+
document_id: str = ""
|
|
59
|
+
|
|
60
|
+
class Output(BaseModel):
|
|
61
|
+
result: str = ""
|
|
62
|
+
error_type: str = ""
|
|
63
|
+
error_message: str = ""
|
|
64
|
+
|
|
65
|
+
# Lazy SDK singleton — never instantiate UiPath() at module level
|
|
66
|
+
_sdk: UiPath | None = None
|
|
67
|
+
|
|
68
|
+
def sdk() -> UiPath:
|
|
69
|
+
global _sdk
|
|
70
|
+
if _sdk is None:
|
|
71
|
+
_sdk = UiPath()
|
|
72
|
+
return _sdk
|
|
73
|
+
|
|
74
|
+
@traced(name="my_function", run_type="uipath")
|
|
75
|
+
def my_function(input: Input) -> Output:
|
|
76
|
+
out = Output()
|
|
77
|
+
try:
|
|
78
|
+
# SDK calls, data processing, rule-based logic only
|
|
79
|
+
asset = sdk().assets.retrieve("MY_ASSET", folder_path="Shared")
|
|
80
|
+
out.result = str(asset.value)
|
|
81
|
+
except Exception as exc:
|
|
82
|
+
out.error_type = "FAILED"
|
|
83
|
+
out.error_message = str(exc)
|
|
84
|
+
return out
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Key rules:
|
|
88
|
+
- **Typed I/O** — pydantic `BaseModel`, `pydantic.dataclasses.dataclass`, stdlib `@dataclass`, or a thin class with typed annotations; samples favor pydantic
|
|
89
|
+
- **`def` or `async def`** — both supported (csv-processor uses `async def main`); the function name is arbitrary
|
|
90
|
+
- **Lazy SDK init** — instantiate `UiPath()` inside a getter, never at module level
|
|
91
|
+
- **Errors returned, not raised** — populate `error_type`/`error_message` output fields and return; never let exceptions bubble out of the entrypoint
|
|
92
|
+
- **`@traced(name=..., run_type="uipath")`** — apply to the entrypoint and any sub-functions you want visible in LLM Ops Traces
|
|
93
|
+
|
|
94
|
+
## Step 4: Register in `uipath.json`
|
|
95
|
+
|
|
96
|
+
```json
|
|
97
|
+
{
|
|
98
|
+
"runtimeOptions": { "isConversational": false },
|
|
99
|
+
"functions": {
|
|
100
|
+
"main": "main.py:my_function"
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
The key is the entrypoint name — it can be any string and marks this as the callable entrypoint. The value is `"<file>:<function_name>"`. Both the key and the function name are arbitrary.
|
|
106
|
+
|
|
107
|
+
**This `functions` map is what identifies the project as a Coded Function** — the runtime's `determine_project_type()` reads the entrypoint type from `uipath.json`.
|
|
108
|
+
|
|
109
|
+
## Step 5: Declare dependencies in `pyproject.toml`
|
|
110
|
+
|
|
111
|
+
```toml
|
|
112
|
+
[project]
|
|
113
|
+
name = "my-function"
|
|
114
|
+
version = "0.1.0"
|
|
115
|
+
description = "..."
|
|
116
|
+
authors = [{ name = "Your Name", email = "you@example.com" }]
|
|
117
|
+
requires-python = ">=3.11"
|
|
118
|
+
dependencies = [
|
|
119
|
+
"uipath",
|
|
120
|
+
"httpx>=0.28", # if making HTTP calls
|
|
121
|
+
"pydantic-settings>=2", # if using Settings for env/asset config
|
|
122
|
+
]
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
`authors` is **required** — without it `uip function pack` rejects the package with `Project authors cannot be empty`.
|
|
126
|
+
|
|
127
|
+
No `[build-system]` section. The project is identified as a Coded Function by the `functions` map in `uipath.json` (Step 4).
|
|
128
|
+
|
|
129
|
+
## Step 6: Generate Entry Points
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
uip function init
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
Python only. Discovers entrypoints and generates `entry-points.json`, `bindings.json`, and `project.uiproj`. Must run before `pack` or `push`. Re-run whenever Input/Output schemas or the entrypoint registration in `uipath.json` changes.
|
|
136
|
+
|
|
137
|
+
## Step 7: SDK Capabilities
|
|
138
|
+
|
|
139
|
+
Full SDK reference: https://uipath.github.io/uipath-python/
|
|
140
|
+
|
|
141
|
+
Access UiPath platform resources via `sdk()`:
|
|
142
|
+
|
|
143
|
+
```python
|
|
144
|
+
from uipath.platform import UiPath
|
|
145
|
+
from uipath.platform.connections.connections import ActivityMetadata, ActivityParameterLocationInfo
|
|
146
|
+
|
|
147
|
+
# Assets — retrieve named credentials or config values
|
|
148
|
+
asset = sdk().assets.retrieve("ASSET_NAME", folder_path="Shared")
|
|
149
|
+
value = asset.string_value # or credential_username / credential_password
|
|
150
|
+
|
|
151
|
+
# Buckets — download files for processing
|
|
152
|
+
sdk().buckets.download(
|
|
153
|
+
name="BucketName",
|
|
154
|
+
blob_file_path="relative/path/file.pdf",
|
|
155
|
+
destination_path="/tmp/local.pdf",
|
|
156
|
+
folder_path="Shared",
|
|
157
|
+
)
|
|
158
|
+
|
|
159
|
+
# Integration Service connections — invoke connector activities (ERP, CRM, etc.)
|
|
160
|
+
result = sdk().connections.invoke_activity(
|
|
161
|
+
activity_metadata=ActivityMetadata(
|
|
162
|
+
object_path="/executeSuiteQL",
|
|
163
|
+
method_name="POST",
|
|
164
|
+
content_type="application/json",
|
|
165
|
+
parameter_location_info=ActivityParameterLocationInfo(body_fields=["q"]),
|
|
166
|
+
),
|
|
167
|
+
connection_id="<connection-uuid>",
|
|
168
|
+
activity_input={"q": "SELECT id FROM vendor WHERE ..."},
|
|
169
|
+
)
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### File attachment inputs
|
|
173
|
+
|
|
174
|
+
To accept a runtime file, type an `Input` field as `Attachment` (pydantic model, not a dataclass):
|
|
175
|
+
|
|
176
|
+
```python
|
|
177
|
+
from pydantic import BaseModel
|
|
178
|
+
from uipath.platform.attachments import Attachment
|
|
179
|
+
|
|
180
|
+
class Input(BaseModel):
|
|
181
|
+
attachment: Attachment
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
`uip function init` recognizes the `Attachment` type and emits `x-uipath-resource-kind: JobAttachment` in `entry-points.json` — the schema Studio Web and Orchestrator read to render a file picker for that field. Access fields snake_case: `attachment.full_name`, `attachment.content`.
|
|
185
|
+
|
|
186
|
+
## Step 8: Pack and Publish
|
|
187
|
+
|
|
188
|
+
```bash
|
|
189
|
+
uip function pack # creates .nupkg
|
|
190
|
+
uip function publish # upload to Orchestrator (interactive feed picker)
|
|
191
|
+
uip function publish --feed-id <FEED_ID> # CI/non-interactive
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
To sync to Studio Web instead of publishing to Orchestrator:
|
|
195
|
+
|
|
196
|
+
```bash
|
|
197
|
+
uip function push
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
### What Goes Into the Package
|
|
201
|
+
|
|
202
|
+
`.nupkg` produced by `pack` contains project files (source, `pyproject.toml`, `uipath.json`, `uv.lock` when present) and generated metadata (`entry-points.json`, `bindings_v2.json`, `package-descriptor.json`, `operate.json`). Control inclusion and exclusion via `packOptions` in `uipath.json` — keep local-only fixtures, test data, and caches out of the published artifact:
|
|
203
|
+
|
|
204
|
+
| Property | Type | Required | Default | Description |
|
|
205
|
+
|----------|------|----------|---------|-------------|
|
|
206
|
+
| `fileExtensionsIncluded` | `string[]` | No | `[".py", ".mermaid", ".json", ".yaml", ".yml", ".md"]` | File extensions to include in the package |
|
|
207
|
+
| `filesIncluded` | `string[]` | No | `["pyproject.toml"]` | Specific files to always include |
|
|
208
|
+
| `filesExcluded` | `string[]` | No | `[]` | Specific files to exclude |
|
|
209
|
+
| `directoriesExcluded` | `string[]` | No | `[]` | Directories to exclude from packaging |
|
|
210
|
+
| `includeUvLock` | `boolean` | No | `false` | Whether to include `uv.lock` file |
|
|
211
|
+
|
|
212
|
+
**Example:**
|
|
213
|
+
|
|
214
|
+
```json
|
|
215
|
+
{
|
|
216
|
+
"packOptions": {
|
|
217
|
+
"fileExtensionsIncluded": [".py", ".json"],
|
|
218
|
+
"filesIncluded": ["config.yaml"],
|
|
219
|
+
"filesExcluded": ["test_*.py"],
|
|
220
|
+
"directoriesExcluded": ["tests", "__pycache__"],
|
|
221
|
+
"includeUvLock": true
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
```
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: uipath-governance
|
|
3
|
-
description: "UiPath governance via `uip gov` — author, deploy, and diagnose policies on three layers. AOps product policies (`uip gov aops-policy`): block/restrict/enforce features in Studio, StudioX, Assistant, Robot, AI Trust Layer, Agent Builder; deploy to user/group/tenant. Access ToolUsePolicy (`uip gov access-policy`): allow/deny when one workflow invokes another as a tool (Agent→Agent/Maestro/Flow/RPA/API/Case), gated by tag, caller, or actor (User/Group). Compliance Standards (ISO 42001): check posture and configure recommended settings across products in one operation. Operate: deploy/undeploy, query effective deployed policy. Diagnose: policy not taking effect, deployment precedence (user>group>tenant), blocked tool invocations. For platform ops→uipath-platform."
|
|
3
|
+
description: "UiPath governance via `uip gov` — author, deploy, and diagnose policies on three layers. AOps product policies (`uip gov aops-policy`): block/restrict/enforce features in Studio, StudioX, Assistant, Robot, AI Trust Layer, Agent Builder; deploy to user/group/tenant. Access ToolUsePolicy (`uip gov access-policy`): allow/deny when one workflow invokes another as a tool (Agent→Agent/Maestro/Flow/RPA/API/Case), gated by tag, caller, or actor (User/Group). Compliance Standards (ISO 42001, ISO 27001): check posture and configure recommended settings across products in one operation. Operate: deploy/undeploy, query effective deployed policy. Diagnose: policy not taking effect, deployment precedence (user>group>tenant), blocked tool invocations. For platform ops→uipath-platform."
|
|
4
4
|
allowed-tools: Bash, Read, Write, Edit, Grep, Glob
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -26,7 +26,7 @@ Activate on **any** governance / policy / rule intent — even when the user did
|
|
|
26
26
|
- `who can / which … can / on behalf of` — actor- or identity-shaped governance
|
|
27
27
|
- `compliance / posture / audit` framing on top of policies
|
|
28
28
|
- `.uipolicy` file path, `compliance standard`, `apply standard`
|
|
29
|
-
- Standard names: `ISO 42001`
|
|
29
|
+
- Standard names: `ISO 42001`, `ISO 27001`, `GDPR`, `HIPAA`, `SOC 2`, `EU AI Act`. Route on the name alone — which of them are actually usable varies by environment and is read from `catalog list` at runtime, never assumed here.
|
|
30
30
|
- `check compliance`, `compliance posture`, `posture against`, `drift check`
|
|
31
31
|
- `is my tenant compliant`, `am I compliant with`
|
|
32
32
|
- `organization-wide`, `all tenants`, `entire org`, `across all tenants` — org-scope full apply
|
|
@@ -54,11 +54,12 @@ Activate on **any** governance / policy / rule intent — even when the user did
|
|
|
54
54
|
6. **Always show a receipt after any apply.** Present the post-apply report (settings configured, manual steps needed, Applied by / date) so the user has a record. No local file write is needed — the CLI and UiPath platform are the source of truth.
|
|
55
55
|
7. **Compliance Standards is a preview feature — gate every compliance-pack flow.** Append the preview disclaimer to user-facing compliance-standard responses, and on any `uip gov compliance-packs …` call returning **HTTP 403 / Forbidden**, stop immediately (do not retry, run no further compliance commands) and tell the user the feature requires enrolling in the preview program. Exact wording + placement in [`references/compliance-pack/preview-gate.md`](./references/compliance-pack/preview-gate.md). A **403** is preview-not-enabled; a **401** is a normal login failure — do NOT conflate them.
|
|
56
56
|
8. **Always `uip login` before any `uip gov …` command.** `evaluate` (Access) additionally requires tenant-scoped login — see [`access-policy-overview-guide.md` § Critical Rules](./references/access-policy/access-policy-overview-guide.md#critical-rules).
|
|
57
|
-
9. **Never
|
|
57
|
+
9. **Never run a pack-scoped command before the standard is settled.** `state coverage`, `state get`, `state enable`, `state disable`, `state restore` and `catalog get` all take a `packId`, and several standards are available — so a request that names none ("check my compliance posture", "am I compliant") does NOT identify a pack. Run `catalog list`, present the usable standards, ask which, and END YOUR REPLY. Never pick one because it is first in the list, most common, or the only one you have seen before: posture reported against a standard the user did not ask about is wrong even when every command succeeds. Resolution rules in [`references/compliance-pack/catalog/impl.md` § Pack ID lookup](./references/compliance-pack/catalog/impl.md#pack-id-lookup).
|
|
58
|
+
10. **Never fabricate UUIDs.** Resolve every named user / group / process / agent / flow / robot / tenant via the relevant branch's lookups.
|
|
58
59
|
|
|
59
60
|
## Workflow
|
|
60
61
|
|
|
61
|
-
1. **Classify the intent silently — never announce routing to the user.** Internal flow labels (AOps / Access / Compliance standard) are implementation details; the user sees only the outcome. Read [`references/disambiguation-guide.md`](./references/disambiguation-guide.md) — it lists the strong signals for each flow, the phrase patterns that need disambiguation, and the canonical worked example. If a strong signal matches, route silently. If the phrasing is ambiguous (matches AOps or Access), ask the [disambiguation question](#disambiguation-question) and wait for a digit reply. If the user replies with anything other than `1` or `2`, treat it as a re-statement of intent and re-classify. **Do not run any CLI command before classification is settled** — the disambiguation question itself does not need `uip`, and an unrelated request (platform ops, agent authoring) must redirect to a sibling skill before any setup happens here. If the request contains a standard name (`ISO 42001`), `apply standard`, `compliance posture`, `drift check`, `am I compliant`, `is my tenant compliant`, `what packs are available`, `what packs are configured`, `which standards are enabled`, `organization-wide`, `disable standard`, or `reset` / `restore` / `undo drift on a standard` → route silently to the appropriate compliance standard plugin. Read `partial-apply/planning.md` for scoped requests; `coverage/impl.md` for posture checks; `catalog/impl.md` for discovery; `query/impl.md` for information queries; `full-apply/impl.md` after confirming the posture plan; `disable/impl.md` for removal; `restore/impl.md` for resetting a configured standard back to its recommended settings; `catalog/impl.md` + `state list` for listing currently configured packs.
|
|
62
|
+
1. **Classify the intent silently — never announce routing to the user.** Internal flow labels (AOps / Access / Compliance standard) are implementation details; the user sees only the outcome. Read [`references/disambiguation-guide.md`](./references/disambiguation-guide.md) — it lists the strong signals for each flow, the phrase patterns that need disambiguation, and the canonical worked example. If a strong signal matches, route silently. If the phrasing is ambiguous (matches AOps or Access), ask the [disambiguation question](#disambiguation-question) and wait for a digit reply. If the user replies with anything other than `1` or `2`, treat it as a re-statement of intent and re-classify. **Do not run any CLI command before classification is settled** — the disambiguation question itself does not need `uip`, and an unrelated request (platform ops, agent authoring) must redirect to a sibling skill before any setup happens here. If the request contains a standard name (`ISO 42001`, `ISO 27001`, `GDPR`, `HIPAA`, `SOC 2`, `EU AI Act`), `apply standard`, `compliance posture`, `drift check`, `am I compliant`, `is my tenant compliant`, `what packs are available`, `what packs are configured`, `which standards are enabled`, `organization-wide`, `disable standard`, or `reset` / `restore` / `undo drift on a standard` → route silently to the appropriate compliance standard plugin, **resolving which standard first** ([`references/compliance-pack/catalog/impl.md` § Pack ID lookup](./references/compliance-pack/catalog/impl.md#pack-id-lookup)) — multiple standards are available, so a request that names none (e.g. "check my compliance posture") needs the standard settled before any pack-scoped command runs. Read `partial-apply/planning.md` for scoped requests; `coverage/impl.md` for posture checks; `catalog/impl.md` for discovery; `query/impl.md` for information queries; `full-apply/impl.md` after confirming the posture plan; `disable/impl.md` for removal; `restore/impl.md` for resetting a configured standard back to its recommended settings; `catalog/impl.md` + `state list` for listing currently configured packs.
|
|
62
63
|
2. **Verify `uip` and login** *(only after classification routes to a governance flow).*
|
|
63
64
|
```bash
|
|
64
65
|
which uip && uip --version
|
|
@@ -99,16 +100,16 @@ The canonical ambiguous prompt is *"Block ChatGPT for my finance team using Stud
|
|
|
99
100
|
| **Look up CLI flags / output shapes** (Access) | [`references/access-policy/access-policy-commands.md`](./references/access-policy/access-policy-commands.md) |
|
|
100
101
|
| **Resolve a name to a UUID for Access** | [`references/access-policy/resource-lookup-guide.md`](./references/access-policy/resource-lookup-guide.md) |
|
|
101
102
|
| **Diagnose a governance failure (capability index)** | [`references/diagnose/CAPABILITY.md`](./references/diagnose/CAPABILITY.md) |
|
|
102
|
-
| **Recognize a known governance failure pattern** | [`references/diagnose/
|
|
103
|
-
| **Walk the diagnostic priority ladder** | [`references/diagnose/
|
|
104
|
-
| **Discover available compliance standards** | [`references/compliance-pack/catalog/impl.md`](./references/compliance-pack/catalog/impl.md) |
|
|
103
|
+
| **Recognize a known governance failure pattern** | [`references/diagnose/failure-modes.md`](references/diagnose/failure-modes.md) |
|
|
104
|
+
| **Walk the diagnostic priority ladder** | [`references/diagnose/troubleshooting-guide.md`](references/diagnose/troubleshooting-guide.md) |
|
|
105
|
+
| **Discover available compliance standards / resolve a standard name to a packId** | [`references/compliance-pack/catalog/impl.md`](./references/compliance-pack/catalog/impl.md) |
|
|
105
106
|
| **List which compliance standards are currently configured** | [`references/compliance-pack/catalog/impl.md`](./references/compliance-pack/catalog/impl.md) — use `state list tenant <id>` |
|
|
106
107
|
| **Posture analysis** — what settings are configured vs recommended | [`references/compliance-pack/coverage/impl.md`](./references/compliance-pack/coverage/impl.md) |
|
|
107
108
|
| **Apply full compliance pack** | Run coverage first, then [`references/compliance-pack/full-apply/impl.md`](./references/compliance-pack/full-apply/impl.md) |
|
|
108
109
|
| **Apply specific controls / clauses** | [`references/compliance-pack/partial-apply/planning.md`](./references/compliance-pack/partial-apply/planning.md) |
|
|
109
110
|
| **Remove compliance standard settings** | [`references/compliance-pack/disable/impl.md`](./references/compliance-pack/disable/impl.md) |
|
|
110
111
|
| **Reset / restore a standard to its recommended settings (undo drift)** | [`references/compliance-pack/restore/impl.md`](./references/compliance-pack/restore/impl.md) |
|
|
111
|
-
| **Query — what does a clause / control recommend?** | `uip gov compliance-packs catalog get <packId> --output json` (
|
|
112
|
+
| **Query — what does a clause / control recommend?** | `uip gov compliance-packs catalog get <packId> --output json` (resolve `<packId>` from `catalog list` — never hardcode), then [`references/compliance-pack/query/impl.md`](./references/compliance-pack/query/impl.md) |
|
|
112
113
|
| **Preview disclaimer + 403 opt-in gate (all compliance flows)** | [`references/compliance-pack/preview-gate.md`](./references/compliance-pack/preview-gate.md) |
|
|
113
114
|
|
|
114
115
|
## Anti-patterns
|
|
@@ -8,10 +8,21 @@
|
|
|
8
8
|
uip gov compliance-packs catalog list --output json
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
Parse `Data.
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
11
|
+
Parse `Data.Packs[]` (PascalCase, like every other compliance-packs response). Each entry has:
|
|
12
|
+
`PackId`, `PackName`, `PackLongName`, `PackVersion`, `Description`, `Available` (bool), `PublishedAt`, `Summary`.
|
|
13
|
+
|
|
14
|
+
**`Available` decides whether a pack can be used at all.** The catalog lists standards that are announced but not yet shipped — they come back `Available: false` with `PublishedAt: null` and `Summary: null`. Running `catalog get` or any `state` command on one fails; there is no bundle behind it.
|
|
15
|
+
|
|
16
|
+
Treat it as a three-state field, because the response shape varies by service version:
|
|
17
|
+
|
|
18
|
+
| `Available` | Treat as | Why |
|
|
19
|
+
|---|---|---|
|
|
20
|
+
| `true` | Usable | Shipped, has a bundle. |
|
|
21
|
+
| `false` | Not usable | Announced only. Never offer to apply, check, or query it. |
|
|
22
|
+
| **absent** | Usable | Older services omit the field entirely. Requiring `Available == true` would reject every pack and break the whole flow. Only an explicit `false` blocks. |
|
|
23
|
+
|
|
24
|
+
- Present usable packs with `PackName`, `PackVersion`, and `Summary.ClauseCount` / `Summary.ControlCount` / `Summary.DeploymentPolicyCount`. When `Summary` is null, omit the counts rather than printing zeros.
|
|
25
|
+
- Mention `Available: false` entries, if at all, only as "announced, not yet available".
|
|
15
26
|
|
|
16
27
|
## Get full pack detail
|
|
17
28
|
|
|
@@ -59,12 +70,19 @@ TENANT_ID=$(grep '^UIPATH_TENANT_ID=' ~/.uipath/.auth | cut -d'=' -f2-)
|
|
|
59
70
|
uip gov compliance-packs state list tenant $TENANT_ID --output json
|
|
60
71
|
```
|
|
61
72
|
|
|
62
|
-
Parse `Data[]` — each entry has `packId`, `packVersion`, `active` (bool), `lastToggledAt`.
|
|
73
|
+
Parse `Data[]` — each entry has `packId`, `packVersion`, `active` (bool), `lastToggledAt`.
|
|
74
|
+
|
|
75
|
+
**Multiple standards can be active on one tenant simultaneously.** Enabling a second standard adds to the first, it does not replace it — so this array can legitimately hold several `active: true` entries, and every pack-scoped operation (coverage, disable, restore) applies to the one standard it names and leaves the others alone.
|
|
76
|
+
|
|
77
|
+
`state list` does NOT return a display name. Get `<packName>` by joining each `packId` to `catalog list` → `Data.Packs[].PackName`; run `catalog list` first if it has not been fetched this session. If the join finds no match (pack configured but no longer in the catalog), print the `packId` alone and say so — never invent a display name.
|
|
78
|
+
|
|
79
|
+
Present active packs to the user:
|
|
63
80
|
|
|
64
81
|
```
|
|
65
82
|
Compliance standards configured on <tenantName>:
|
|
66
83
|
|
|
67
|
-
|
|
84
|
+
<packName> (<packId> v<packVersion>) — Active since <lastToggledAt>
|
|
85
|
+
[repeat per active entry]
|
|
68
86
|
|
|
69
87
|
No other compliance standards are currently active.
|
|
70
88
|
```
|
|
@@ -73,7 +91,17 @@ If the array is empty: "No compliance standards are currently configured on this
|
|
|
73
91
|
|
|
74
92
|
## Pack ID lookup
|
|
75
93
|
|
|
76
|
-
|
|
94
|
+
**Resolve every standard name against `catalog list` — never hardcode a packId.** Match the user's wording case-insensitively against `Data.Packs[].PackName` and `PackLongName`, ignoring `ISO`/`IEC`/`ISO/IEC` prefixes and punctuation, so "27001", "ISO 27001" and "ISO/IEC 27001:2022" all hit the same entry.
|
|
95
|
+
|
|
96
|
+
**Then check `Available` before doing anything with the match.** A name resolving to a packId is NOT the same as that pack being usable — announced-but-unshipped standards are in the catalog with `Available: false`. Resolving one and passing it to `catalog get` or `state enable` produces a failure the user cannot act on. Check `Available` first, every time.
|
|
97
|
+
|
|
98
|
+
`PackLongName` is not reliably descriptive (ISO 27001's is literally "ISO 27001 compliance pack"), so common domain phrasings will NOT be found by name-matching alone. The alias table below carries them; it is a supplement to the catalog match, not a replacement for it.
|
|
99
|
+
|
|
100
|
+
| User says | Resolution |
|
|
77
101
|
|---|---|
|
|
78
102
|
| "ISO 42001" / "ISO/IEC 42001" / "AI Management System" | `iso-42001-2023` |
|
|
79
|
-
|
|
|
103
|
+
| "ISO 27001" / "ISO/IEC 27001" / "Information Security Management System" / "ISMS" | `iso-27001-2022` |
|
|
104
|
+
| A name matching a pack with an explicit `Available: false` (on cloud today: GDPR, HIPAA, SOC 2, EU AI Act — the set differs by environment, so read it from the response, never from this list) | Say that standard is announced but not yet available, name the ones that are, and stop. Do NOT run `catalog get` or any `state` command on it. |
|
|
105
|
+
| A standard name with no match at all | Tell the user that standard is not available, list the `Available: true` packs, and offer to proceed with one. |
|
|
106
|
+
| No standard named at all (e.g. "check my compliance posture") | Run `catalog list` and ask which standard. Never assume — more than one pack is available. |
|
|
107
|
+
| Two or more `Available: true` packs match the wording | Ask which one, listing the matches by `PackName`. |
|