@uipath/skills 1.198.0-preview.21 → 1.199.0-preview.106
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +1 -1
- package/.claude-plugin/plugin.json +1 -1
- package/CODEOWNERS +4 -2
- package/hooks/send-telemetry.ps1 +19 -13
- package/hooks/send-telemetry.sh +19 -13
- package/package.json +1 -1
- package/skills/uipath-admin/SKILL.md +10 -7
- package/skills/uipath-admin/references/audit-commands.md +21 -10
- package/skills/uipath-admin/references/audit-workflow-guide.md +15 -6
- package/skills/uipath-agents/references/coded/capabilities/guardrails/guardrails-recommend.md +6 -1
- package/skills/uipath-agents/references/coded/capabilities/guardrails/guardrails.md +7 -1
- package/skills/uipath-agents/references/coded/embedding-in-flows.md +5 -5
- package/skills/uipath-agents/references/coded/flow-integration.md +1 -1
- package/skills/uipath-agents/references/coded/quickstart.md +3 -3
- package/skills/uipath-agents/references/coded-vs-lowcode-guide.md +1 -1
- package/skills/uipath-agents/references/lowcode/capabilities/guardrails/guardrails-recommend.md +39 -2
- package/skills/uipath-agents/references/lowcode/capabilities/guardrails/guardrails.md +36 -2
- package/skills/uipath-agents/references/lowcode/capabilities/process/process.md +4 -4
- package/skills/uipath-agents/references/lowcode/capabilities/process/solution-files.md +1 -1
- package/skills/uipath-agents/references/lowcode/critical-rules/critical-rules.md +1 -1
- package/skills/uipath-agents/references/lowcode/project-lifecycle.md +19 -9
- package/skills/uipath-agents/references/lowcode/solution-resources.md +2 -2
- package/skills/uipath-api-workflow/SKILL.md +14 -7
- package/skills/uipath-api-workflow/references/cli-reference.md +2 -2
- package/skills/uipath-api-workflow/references/connector-activity-discovery.md +1 -1
- package/skills/uipath-api-workflow/references/expressions-and-context.md +2 -2
- package/skills/uipath-api-workflow/references/operating-published-workflows.md +74 -0
- package/skills/uipath-api-workflow/references/task-types.md +3 -3
- package/skills/uipath-api-workflow/references/troubleshooting.md +23 -10
- package/skills/uipath-coded-apps/SKILL.md +3 -3
- package/skills/uipath-coded-apps/assets/scripts/dashboards/build-dashboard.mjs +2 -2
- package/skills/uipath-coded-apps/references/create-action-app.md +11 -3
- package/skills/uipath-coded-apps/references/create-web-app.md +9 -7
- package/skills/uipath-coded-apps/references/dashboards/plugins/build/impl.md +3 -1
- package/skills/uipath-coded-apps/references/dashboards/plugins/deploy/impl.md +145 -87
- package/skills/uipath-coded-apps/references/dashboards/primitives/state-file.md +2 -2
- package/skills/uipath-coded-apps/references/debug.md +44 -37
- package/skills/uipath-coded-apps/references/oauth-client-setup.md +69 -616
- package/skills/uipath-coded-apps/references/sdk/conversational-agent.md +1 -1
- package/skills/uipath-coded-apps/references/sdk/data-fabric.md +3 -1
- package/skills/uipath-coded-apps/references/widgets/validation-station.md +169 -13
- package/skills/uipath-feedback/SKILL.md +12 -6
- package/skills/uipath-governance/references/auth-context.md +1 -1
- package/skills/uipath-governance/references/compliance-pack/coverage/impl.md +115 -31
- package/skills/uipath-governance/references/compliance-pack/full-apply/impl.md +2 -1
- package/skills/uipath-governance/references/compliance-pack/query/impl.md +2 -2
- package/skills/uipath-human-in-the-loop/SKILL.md +3 -3
- package/skills/uipath-human-in-the-loop/references/hitl-node-apptask.md +2 -2
- package/skills/uipath-human-in-the-loop/references/hitl-node-coded-action-app.md +1 -1
- package/skills/uipath-human-in-the-loop/references/hitl-node-quickform.md +2 -2
- package/skills/uipath-insights/SKILL.md +2 -2
- package/skills/uipath-ixp/SKILL.md +5 -5
- package/skills/uipath-ixp/references/cli-reference.md +1 -1
- package/skills/uipath-maestro-bpmn/SKILL.md +92 -8
- package/skills/uipath-maestro-bpmn/references/diagnose/CAPABILITY.md +5 -1
- package/skills/uipath-maestro-bpmn/references/diagnose/references/troubleshooting-guide.md +5 -0
- package/skills/uipath-maestro-bpmn/references/expression-authoring.md +16 -3
- package/skills/uipath-maestro-bpmn/references/operate/references/run.md +17 -3
- package/skills/uipath-maestro-bpmn/references/public-safety.md +15 -0
- package/skills/uipath-maestro-bpmn/references/registry-workflow.md +50 -22
- package/skills/uipath-maestro-bpmn/references/shared/local-metadata-regeneration-guide.md +17 -0
- package/skills/uipath-maestro-bpmn/references/shared/project-layout.md +30 -2
- package/skills/uipath-maestro-bpmn/references/structural-bpmn.md +54 -7
- package/skills/uipath-maestro-bpmn/validator/test/fixtures/known-good/ScriptWritesVariableThenGatewayBranches.bpmn +8 -4
- package/skills/uipath-maestro-case/SKILL.md +72 -34
- package/skills/uipath-maestro-case/assets/templates/sdd-template-examples.md +1 -1
- package/skills/uipath-maestro-case/assets/templates/sdd-template.md +40 -20
- package/skills/uipath-maestro-case/assets/templates/sdd-viewer.html +2 -2
- package/skills/uipath-maestro-case/references/bindings-and-expressions.md +13 -8
- package/skills/uipath-maestro-case/references/bindings-v2-sync.md +1 -1
- package/skills/uipath-maestro-case/references/brownfield.md +13 -3
- package/skills/uipath-maestro-case/references/case-commands.md +6 -6
- package/skills/uipath-maestro-case/references/case-editing-operations.md +13 -13
- package/skills/uipath-maestro-case/references/case-schema.md +58 -47
- package/skills/uipath-maestro-case/references/connector-trigger-common.md +2 -2
- package/skills/uipath-maestro-case/references/evals/evals.json +124 -23
- package/skills/uipath-maestro-case/references/implementation.md +15 -15
- package/skills/uipath-maestro-case/references/phase-0-interview.md +119 -460
- package/skills/uipath-maestro-case/references/phased-execution.md +23 -17
- package/skills/uipath-maestro-case/references/placeholder-tasks.md +3 -3
- package/skills/uipath-maestro-case/references/planning.md +48 -28
- package/skills/uipath-maestro-case/references/plugins/case/impl-json.md +2 -1
- package/skills/uipath-maestro-case/references/plugins/case/planning.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/conditions/case-exit-conditions/planning.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-entry-conditions/planning.md +3 -3
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-exit-conditions/impl-json.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-exit-conditions/planning.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/conditions/task-entry-conditions/impl-json.md +2 -2
- package/skills/uipath-maestro-case/references/plugins/conditions/task-entry-conditions/planning.md +18 -2
- package/skills/uipath-maestro-case/references/plugins/sla/impl-json.md +12 -7
- package/skills/uipath-maestro-case/references/plugins/sla/planning.md +23 -7
- package/skills/uipath-maestro-case/references/plugins/stages/impl-json.md +3 -0
- package/skills/uipath-maestro-case/references/plugins/stages/planning.md +7 -4
- package/skills/uipath-maestro-case/references/plugins/tasks/action/planning.md +15 -6
- package/skills/uipath-maestro-case/references/plugins/tasks/agent/planning.md +17 -34
- package/skills/uipath-maestro-case/references/plugins/tasks/api-workflow/planning.md +15 -13
- package/skills/uipath-maestro-case/references/plugins/tasks/case-management/planning.md +14 -10
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-activity/impl-json.md +2 -2
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-activity/planning.md +8 -2
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-trigger/impl-json.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-trigger/planning.md +4 -0
- package/skills/uipath-maestro-case/references/plugins/tasks/create-inline-common.md +55 -0
- package/skills/uipath-maestro-case/references/plugins/tasks/process/planning.md +9 -6
- package/skills/uipath-maestro-case/references/plugins/tasks/rpa/planning.md +10 -5
- package/skills/uipath-maestro-case/references/plugins/tasks/wait-for-timer/planning.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/triggers/event/impl-json.md +3 -3
- package/skills/uipath-maestro-case/references/plugins/triggers/event/planning.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/triggers/manual/impl-json.md +1 -0
- package/skills/uipath-maestro-case/references/plugins/triggers/timer/impl-json.md +1 -0
- package/skills/uipath-maestro-case/references/plugins/variables/bindings/impl-json.md +2 -1
- package/skills/uipath-maestro-case/references/plugins/variables/global-vars/impl-json.md +10 -4
- package/skills/uipath-maestro-case/references/plugins/variables/io-binding/impl-json.md +74 -24
- package/skills/uipath-maestro-case/references/plugins/variables/io-binding/planning.md +51 -8
- package/skills/uipath-maestro-case/references/registry-discovery.md +83 -29
- package/skills/uipath-maestro-case/references/sdd-generation-rules.md +96 -64
- package/skills/uipath-maestro-flow/SKILL.md +2 -1
- package/skills/uipath-maestro-flow/references/author/CAPABILITY.md +1 -1
- package/skills/uipath-maestro-flow/references/author/references/editing-operations-json.md +1 -1
- package/skills/uipath-maestro-flow/references/author/references/greenfield.md +6 -6
- package/skills/uipath-maestro-flow/references/author/references/plugins/agent/impl.md +4 -4
- package/skills/uipath-maestro-flow/references/author/references/plugins/connector-trigger/impl.md +4 -1
- package/skills/uipath-maestro-flow/references/author/references/plugins/connector-trigger/planning.md +1 -1
- package/skills/uipath-maestro-flow/references/diagnose/references/failure-modes.md +5 -7
- package/skills/uipath-maestro-flow/references/shared/cli-commands.md +13 -12
- package/skills/uipath-maestro-flow/references/shared/file-format.md +1 -1
- package/skills/uipath-maestro-flow/references/shared/variables-and-expressions.md +2 -1
- package/skills/uipath-mcp-servers/SKILL.md +6 -6
- package/skills/uipath-mcp-servers/references/is-activity-workflow.md +17 -7
- package/skills/uipath-planner/SKILL.md +36 -24
- package/skills/uipath-planner/assets/templates/agent-sdd-template.md +111 -7
- package/skills/uipath-planner/assets/templates/api-workflow-sdd-template.md +75 -11
- package/skills/uipath-planner/assets/templates/bpmn-sdd-template.md +429 -0
- package/skills/uipath-planner/assets/templates/case-sdd-template.md +114 -19
- package/skills/uipath-planner/assets/templates/coded-app-sdd-template.md +68 -5
- package/skills/uipath-planner/assets/templates/flow-sdd-template.md +84 -5
- package/skills/uipath-planner/assets/templates/rpa-sdd-template.md +265 -26
- package/skills/uipath-planner/references/attended-reauth-pattern-guide.md +7 -1
- package/skills/uipath-planner/references/multi-skill-patterns-guide.md +11 -6
- package/skills/uipath-planner/references/non-pdd-lane-guide.md +90 -86
- package/skills/uipath-planner/references/package-selection-guide.md +4 -2
- package/skills/uipath-planner/references/pdd-analysis-guide.md +34 -7
- package/skills/uipath-planner/references/pdd-driven-lane-guide.md +25 -3
- package/skills/uipath-planner/references/plan-and-tasks-format.md +7 -6
- package/skills/uipath-planner/references/platform-availability-guide.md +5 -2
- package/skills/uipath-planner/references/product-selection-guide.md +239 -21
- package/skills/uipath-planner/references/rpa-product-guide.md +22 -2
- package/skills/uipath-planner/references/sdd-generation-guide.md +123 -31
- package/skills/uipath-planner/references/tenant-library-search-guide.md +6 -4
- package/skills/uipath-planner/scripts/docx-extract.ps1 +59 -0
- package/skills/uipath-planner/scripts/sdd-to-docx.ps1 +74 -0
- package/skills/uipath-platform/SKILL.md +12 -3
- package/skills/uipath-platform/references/data-fabric/data-fabric.md +7 -1
- package/skills/uipath-platform/references/data-fabric/entity-schema.md +21 -2
- package/skills/uipath-platform/references/data-fabric/filter-platform-contract.md +2 -0
- package/skills/uipath-platform/references/data-fabric/records-query.md +12 -0
- package/skills/uipath-platform/references/integration-service/triggers.md +2 -0
- package/skills/uipath-platform/references/orchestrator/tenant-admin.md +3 -1
- package/skills/uipath-rpa/CLAUDE.md +12 -10
- package/skills/uipath-rpa/SKILL.md +62 -34
- package/skills/uipath-rpa/references/cli-reference.md +3 -1
- package/skills/uipath-rpa/references/coded/codedworkflow-reference.md +1 -1
- package/skills/uipath-rpa/references/coded/coding-guidelines.md +18 -3
- package/skills/uipath-rpa/references/coded/operations-guide.md +8 -6
- package/skills/uipath-rpa/references/legacy/activity-docs/ActiveDirectory.md +2 -3
- package/skills/uipath-rpa/references/legacy/activity-docs/_INDEX.md +1 -1
- package/skills/uipath-rpa/references/library-authoring-guide.md +1 -1
- package/skills/uipath-rpa/references/powershell-interop-guide.md +1 -1
- package/skills/uipath-rpa/references/project-structure-guide.md +1 -1
- package/skills/uipath-rpa/references/testing-guide.md +1 -1
- package/skills/uipath-rpa/references/uia-starter-guide.md +216 -0
- package/skills/uipath-rpa/references/validation-guide.md +2 -0
- package/skills/uipath-rpa/references/xaml/workflow-guide.md +2 -2
- package/skills/uipath-solution/SKILL.md +8 -6
- package/skills/uipath-solution/references/develop-solution.md +14 -14
- package/skills/uipath-solution/references/pack-and-deploy.md +4 -0
- package/skills/uipath-solution/references/scenarios/intra-solution-references.md +1 -1
- package/skills/uipath-solution/references/scenarios/manual-edits.md +2 -2
- package/skills/uipath-solution/references/solution-overview.md +28 -1
- package/skills/uipath-tasks/SKILL.md +2 -2
- package/skills/uipath-tasks/references/action-center-urls.md +4 -5
- package/skills/uipath-troubleshoot/SKILL.md +15 -9
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/overview.md +19 -2
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/browser-open-or-attach-failed.md +4 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/browser-scope-errors.md +119 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/click-silent-no-op.md +76 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/invoke-workflow-failed.md +38 -11
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/invoke-workflow-file-design-time-errors.md +89 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/queue-operation-failed.md +91 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/trigger-scope-and-local-triggers-failed.md +106 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/type-into-wrong-or-incomplete-text.md +91 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/summary.md +7 -2
- package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/overview.md +38 -0
- package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/csv-datatable-structure-mismatch.md +32 -0
- package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/csv-file-locked-or-invalid-path.md +33 -0
- package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/csv-helper-method-not-found.md +36 -0
- package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/read-csv-file-not-found.md +34 -0
- package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/read-csv-invalid-format.md +33 -0
- package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/read-csv-more-values-than-header.md +34 -0
- package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/write-csv-access-denied.md +35 -0
- package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/write-csv-cannot-set-unknown-member.md +30 -0
- package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/write-csv-invalid-delimiter.md +27 -0
- package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/playbooks/write-csv-unsupported-encoding.md +27 -0
- package/skills/uipath-troubleshoot/references/activity-packages/csv-activities/summary.md +16 -0
- package/skills/uipath-troubleshoot/references/activity-packages/database-activities/playbooks/execute-query-failures.md +27 -2
- package/skills/uipath-troubleshoot/references/activity-packages/database-activities/summary.md +1 -1
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/overview.md +1 -1
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/excel-application-card-failures.md +20 -31
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/excel-application-scope-failures.md +7 -6
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/excel-not-installed.md +72 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/null-reference-from-activity.md +150 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/read-range-sheet-not-found.md +1 -1
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/{read-range-file-locked.md → workbook-file-locked.md} +54 -40
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/write-cell-failures.md +3 -3
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/summary.md +5 -7
- package/skills/uipath-troubleshoot/references/activity-packages/file-operations/overview.md +31 -0
- package/skills/uipath-troubleshoot/references/activity-packages/file-operations/playbooks/download-file-403-401-auth.md +32 -0
- package/skills/uipath-troubleshoot/references/activity-packages/file-operations/playbooks/download-file-host-not-found.md +33 -0
- package/skills/uipath-troubleshoot/references/activity-packages/file-operations/playbooks/download-file-httpclient-reused-in-loop.md +34 -0
- package/skills/uipath-troubleshoot/references/activity-packages/file-operations/playbooks/download-file-stuck-tmp.md +29 -0
- package/skills/uipath-troubleshoot/references/activity-packages/file-operations/summary.md +10 -0
- package/skills/uipath-troubleshoot/references/activity-packages/intelligent-ocr-activities/investigation_guide.md +36 -0
- package/skills/uipath-troubleshoot/references/activity-packages/intelligent-ocr-activities/overview.md +33 -0
- package/skills/uipath-troubleshoot/references/activity-packages/intelligent-ocr-activities/playbooks/du-document-rejected.md +32 -0
- package/skills/uipath-troubleshoot/references/activity-packages/intelligent-ocr-activities/playbooks/du-license-or-endpoint-rejected.md +63 -0
- package/skills/uipath-troubleshoot/references/activity-packages/intelligent-ocr-activities/playbooks/du-not-enabled-or-tenant-key.md +38 -0
- package/skills/uipath-troubleshoot/references/activity-packages/intelligent-ocr-activities/playbooks/du-storage-or-taxonomy-missing.md +44 -0
- package/skills/uipath-troubleshoot/references/activity-packages/intelligent-ocr-activities/summary.md +10 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ipc-activities/investigation_guide.md +34 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ipc-activities/overview.md +35 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ipc-activities/playbooks/broadcast-message-timeout.md +38 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ipc-activities/playbooks/broadcast-message-unauthorized-access.md +38 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ipc-activities/presentation.md +9 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ipc-activities/summary.md +9 -0
- package/skills/uipath-troubleshoot/references/activity-packages/jira-activities/investigation_guide.md +31 -0
- package/skills/uipath-troubleshoot/references/activity-packages/jira-activities/overview.md +39 -0
- package/skills/uipath-troubleshoot/references/activity-packages/jira-activities/playbooks/jira-activity-missing-or-not-loaded.md +37 -0
- package/skills/uipath-troubleshoot/references/activity-packages/jira-activities/playbooks/jira-add-comment-failures.md +50 -0
- package/skills/uipath-troubleshoot/references/activity-packages/jira-activities/playbooks/jira-scope-authentication-failures.md +47 -0
- package/skills/uipath-troubleshoot/references/activity-packages/jira-activities/playbooks/jira-scope-response-not-json-or-500.md +42 -0
- package/skills/uipath-troubleshoot/references/activity-packages/jira-activities/playbooks/jira-transition-issue-failures.md +47 -0
- package/skills/uipath-troubleshoot/references/activity-packages/jira-activities/presentation.md +9 -0
- package/skills/uipath-troubleshoot/references/activity-packages/jira-activities/summary.md +11 -0
- package/skills/uipath-troubleshoot/references/activity-packages/mail-activities/overview.md +1 -0
- package/skills/uipath-troubleshoot/references/activity-packages/mail-activities/playbooks/send-smtp-mail-failures.md +161 -0
- package/skills/uipath-troubleshoot/references/activity-packages/mail-activities/summary.md +1 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ocr-activities/investigation_guide.md +29 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ocr-activities/overview.md +26 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ocr-activities/playbooks/ocr-endpoint-and-authentication.md +52 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ocr-activities/playbooks/ocr-engine-config-and-dependencies.md +55 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ocr-activities/playbooks/ocr-input-and-runtime.md +51 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ocr-activities/summary.md +10 -0
- package/skills/uipath-troubleshoot/references/activity-packages/pdf-activities/investigation_guide.md +33 -0
- package/skills/uipath-troubleshoot/references/activity-packages/pdf-activities/overview.md +34 -0
- package/skills/uipath-troubleshoot/references/activity-packages/pdf-activities/playbooks/pdf-corrupt-or-image-input.md +49 -0
- package/skills/uipath-troubleshoot/references/activity-packages/pdf-activities/playbooks/pdf-encrypted-or-wrong-password.md +51 -0
- package/skills/uipath-troubleshoot/references/activity-packages/pdf-activities/playbooks/pdf-file-not-found-or-not-pdf.md +45 -0
- package/skills/uipath-troubleshoot/references/activity-packages/pdf-activities/playbooks/pdf-invalid-page-range.md +42 -0
- package/skills/uipath-troubleshoot/references/activity-packages/pdf-activities/playbooks/pdf-read-ocr-no-engine.md +39 -0
- package/skills/uipath-troubleshoot/references/activity-packages/pdf-activities/summary.md +11 -0
- package/skills/uipath-troubleshoot/references/activity-packages/python-activities/overview.md +1 -0
- package/skills/uipath-troubleshoot/references/activity-packages/python-activities/playbooks/python-scope-architecture-version-mismatch.md +2 -0
- package/skills/uipath-troubleshoot/references/activity-packages/python-activities/playbooks/python-scope-hang-dotnet-runtime.md +36 -0
- package/skills/uipath-troubleshoot/references/activity-packages/python-activities/summary.md +1 -0
- package/skills/uipath-troubleshoot/references/activity-packages/sap-bapi-activities/investigation_guide.md +34 -0
- package/skills/uipath-troubleshoot/references/activity-packages/sap-bapi-activities/overview.md +34 -0
- package/skills/uipath-troubleshoot/references/activity-packages/sap-bapi-activities/playbooks/sap-bapi-not-found.md +39 -0
- package/skills/uipath-troubleshoot/references/activity-packages/sap-bapi-activities/playbooks/sap-connection-failed.md +46 -0
- package/skills/uipath-troubleshoot/references/activity-packages/sap-bapi-activities/playbooks/sap-unsupported-bapi.md +32 -0
- package/skills/uipath-troubleshoot/references/activity-packages/sap-bapi-activities/summary.md +9 -0
- package/skills/uipath-troubleshoot/references/activity-packages/slack-activities/investigation_guide.md +31 -0
- package/skills/uipath-troubleshoot/references/activity-packages/slack-activities/overview.md +29 -0
- package/skills/uipath-troubleshoot/references/activity-packages/slack-activities/playbooks/connection-resolution-failure.md +46 -0
- package/skills/uipath-troubleshoot/references/activity-packages/slack-activities/playbooks/slack-api-error.md +65 -0
- package/skills/uipath-troubleshoot/references/activity-packages/slack-activities/summary.md +8 -0
- package/skills/uipath-troubleshoot/references/activity-packages/system-activities/investigation_guide.md +13 -0
- package/skills/uipath-troubleshoot/references/activity-packages/system-activities/overview.md +21 -9
- package/skills/uipath-troubleshoot/references/activity-packages/system-activities/playbooks/compress-extract-files-failed.md +64 -0
- package/skills/uipath-troubleshoot/references/activity-packages/system-activities/playbooks/download-file-failed.md +46 -0
- package/skills/uipath-troubleshoot/references/activity-packages/system-activities/playbooks/file-folder-operation-failed.md +61 -0
- package/skills/uipath-troubleshoot/references/activity-packages/system-activities/playbooks/get-asset-wrong-activity-type.md +2 -0
- package/skills/uipath-troubleshoot/references/activity-packages/system-activities/playbooks/queue-transaction-activity-failed.md +47 -0
- package/skills/uipath-troubleshoot/references/activity-packages/system-activities/summary.md +6 -0
- package/skills/uipath-troubleshoot/references/activity-packages/terminal-activities/investigation_guide.md +28 -0
- package/skills/uipath-troubleshoot/references/activity-packages/terminal-activities/overview.md +30 -0
- package/skills/uipath-troubleshoot/references/activity-packages/terminal-activities/playbooks/terminal-session-connection-failed.md +58 -0
- package/skills/uipath-troubleshoot/references/activity-packages/terminal-activities/playbooks/terminal-session-null-reference.md +40 -0
- package/skills/uipath-troubleshoot/references/activity-packages/terminal-activities/summary.md +8 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/interpretations/healing-agent-data.md +10 -27
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/investigation_guide.md +1 -1
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/overview.md +9 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/ambiguous-selector.md +2 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/application-not-found.md +1 -10
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/browser-communication-failed.md +85 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/click-coordinate-off-screen.md +2 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/click-silent-no-op.md +79 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/dependency-version-conflict.md +66 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/disabled-element.md +2 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/napplicationcard-view-generation-failed.md +78 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/scope-container-wrong-page.md +2 -2
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/selector-failure-healing-disabled.md +2 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/selector-failure-healing-fix.md +4 -2
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/selector-failure-manual.md +3 -1
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/type-into-input-failed.md +148 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/verify-execution-failure.md +2 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/summary.md +5 -0
- package/skills/uipath-troubleshoot/references/activity-packages/word-activities/playbooks/add-picture-failures.md +1 -0
- package/skills/uipath-troubleshoot/references/activity-packages/word-activities/playbooks/word-com-interop-failures.md +5 -0
- package/skills/uipath-troubleshoot/references/presenting.md +3 -3
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/context-grounding-index-not-found.md +35 -24
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/guardrail-violation.md +14 -12
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/input-schema-validation-failure.md +23 -13
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/is-connection-disabled.md +6 -4
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/is-invalid-credentials.md +12 -9
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/is-invalid-element-instance.md +12 -9
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/llm-insufficient-information.md +20 -13
- package/skills/uipath-troubleshoot/references/products/agents/summary.md +1 -1
- package/skills/uipath-troubleshoot/references/products/api-workflows/investigation_guide.md +52 -0
- package/skills/uipath-troubleshoot/references/products/api-workflows/overview.md +33 -0
- package/skills/uipath-troubleshoot/references/products/api-workflows/playbooks/connection-auth-failure.md +49 -0
- package/skills/uipath-troubleshoot/references/products/api-workflows/playbooks/expression-reference-error.md +32 -0
- package/skills/uipath-troubleshoot/references/products/api-workflows/playbooks/output-undefined.md +39 -0
- package/skills/uipath-troubleshoot/references/products/api-workflows/playbooks/publish-deploy-failure.md +38 -0
- package/skills/uipath-troubleshoot/references/products/api-workflows/playbooks/run-not-successful.md +37 -0
- package/skills/uipath-troubleshoot/references/products/api-workflows/summary.md +14 -0
- package/skills/uipath-troubleshoot/references/products/assistant/investigation_guide.md +71 -0
- package/skills/uipath-troubleshoot/references/products/assistant/overview.md +44 -0
- package/skills/uipath-troubleshoot/references/products/assistant/playbooks/assistant-crash.md +38 -0
- package/skills/uipath-troubleshoot/references/products/assistant/playbooks/orchestrator-connection-failure.md +43 -0
- package/skills/uipath-troubleshoot/references/products/assistant/playbooks/process-missing-or-unstartable.md +41 -0
- package/skills/uipath-troubleshoot/references/products/assistant/playbooks/sign-in-failure.md +42 -0
- package/skills/uipath-troubleshoot/references/products/assistant/summary.md +18 -0
- package/skills/uipath-troubleshoot/references/products/coded-apps/overview.md +49 -0
- package/skills/uipath-troubleshoot/references/products/coded-apps/playbooks/action-app-form-data-not-loading.md +66 -0
- package/skills/uipath-troubleshoot/references/products/coded-apps/playbooks/api-401-after-login.md +51 -0
- package/skills/uipath-troubleshoot/references/products/coded-apps/playbooks/api-403-folder-permission.md +51 -0
- package/skills/uipath-troubleshoot/references/products/coded-apps/playbooks/cors-error-wrong-base-url.md +46 -0
- package/skills/uipath-troubleshoot/references/products/coded-apps/playbooks/deploy-404-app-not-found.md +59 -0
- package/skills/uipath-troubleshoot/references/products/coded-apps/playbooks/invalid-scope.md +70 -0
- package/skills/uipath-troubleshoot/references/products/coded-apps/playbooks/isauthenticated-false-after-callback.md +59 -0
- package/skills/uipath-troubleshoot/references/products/coded-apps/playbooks/redirect-uri-mismatch.md +59 -0
- package/skills/uipath-troubleshoot/references/products/coded-apps/summary.md +14 -0
- package/skills/uipath-troubleshoot/references/products/integration-service/playbooks/connection-invalid.md +11 -10
- package/skills/uipath-troubleshoot/references/products/integration-service/playbooks/connection-not-resolved.md +3 -3
- package/skills/uipath-troubleshoot/references/products/integration-service/playbooks/connector-general-exception.md +1 -1
- package/skills/uipath-troubleshoot/references/products/integration-service/playbooks/request-failed.md +2 -0
- package/skills/uipath-troubleshoot/references/products/maestro/error_codes.md +2 -2
- package/skills/uipath-troubleshoot/references/products/maestro/investigation_guide.md +6 -2
- package/skills/uipath-troubleshoot/references/products/maestro/playbooks/autopilot-429.md +8 -5
- package/skills/uipath-troubleshoot/references/products/maestro/playbooks/expression-evaluation-errors.md +6 -0
- package/skills/uipath-troubleshoot/references/products/maestro/playbooks/folder-not-accessible.md +1 -1
- package/skills/uipath-troubleshoot/references/products/maestro/playbooks/gateway-no-outgoing-flow.md +6 -4
- package/skills/uipath-troubleshoot/references/products/maestro/playbooks/integration-service-404.md +3 -2
- package/skills/uipath-troubleshoot/references/products/maestro/playbooks/js-runtime-discrepancy.md +7 -1
- package/skills/uipath-troubleshoot/references/products/maestro/playbooks/marker-input-null.md +4 -0
- package/skills/uipath-troubleshoot/references/products/maestro/playbooks/marker-invalid-cast.md +5 -1
- package/skills/uipath-troubleshoot/references/products/maestro/playbooks/multi-instance-parallel.md +7 -1
- package/skills/uipath-troubleshoot/references/products/maestro/playbooks/no-suitable-runtime-machine.md +2 -0
- package/skills/uipath-troubleshoot/references/products/maestro/playbooks/personal-automation-quota.md +1 -1
- package/skills/uipath-troubleshoot/references/products/maestro/playbooks/service-task-child-job-faulted.md +10 -2
- package/skills/uipath-troubleshoot/references/products/maestro/playbooks/variable-expression-errors.md +6 -0
- package/skills/uipath-troubleshoot/references/products/maestro/summary.md +5 -5
- package/skills/uipath-troubleshoot/references/products/orchestrator/investigation_guide.md +2 -2
- package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-faulted-logon-failure.md +2 -0
- package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-faulted-session-timeout.md +50 -0
- package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-pending-no-host.md +2 -0
- package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-stuck.md +2 -0
- package/skills/uipath-troubleshoot/references/products/orchestrator/summary.md +1 -0
- package/skills/uipath-troubleshoot/references/products/studio/overview.md +34 -0
- package/skills/uipath-troubleshoot/references/products/studio/playbooks/studio-autopilot-unavailable.md +47 -0
- package/skills/uipath-troubleshoot/references/products/studio/summary.md +7 -0
- package/skills/uipath-troubleshoot/references/runtime-exceptions/overview.md +12 -1
- package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/argument-exception.md +48 -0
- package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/argument-out-of-range-exception.md +50 -0
- package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/assign-linq-no-data-rows.md +78 -0
- package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/assign-type-mismatch.md +91 -0
- package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/directory-not-found-exception.md +47 -0
- package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/if-condition-compiler-error.md +81 -0
- package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/if-wrong-branch.md +85 -0
- package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/index-out-of-range-exception.md +48 -0
- package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/invalid-operation-exception.md +51 -0
- package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/key-not-found-exception.md +45 -0
- package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/null-reference-exception.md +2 -0
- package/skills/uipath-troubleshoot/references/runtime-exceptions/playbooks/visualbasicvalue-requires-compilation.md +47 -0
- package/skills/uipath-troubleshoot/references/runtime-exceptions/summary.md +11 -0
- package/skills/uipath-troubleshoot/references/summary.md +138 -5
- package/version-manifest.json +2 -2
- package/skills/uipath-rpa/references/ui-automation-guide.md +0 -559
- package/skills/uipath-rpa/references/uia-configure-target-workflows.md +0 -188
- package/skills/uipath-rpa/references/uia-elements-interaction-guide.md +0 -102
- package/skills/uipath-rpa/references/uia-prerequisites.md +0 -42
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/add-queue-item-failed.md +0 -58
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/lookup-range-excel-not-installed.md +0 -36
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/lookup-range-file-locked.md +0 -40
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/lookup-range-null-reference.md +0 -37
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/read-range-null-reference.md +0 -119
|
@@ -32,7 +32,7 @@ See [references/hitl-patterns.md](references/hitl-patterns.md) for the full busi
|
|
|
32
32
|
|
|
33
33
|
## Critical Rules
|
|
34
34
|
|
|
35
|
-
1. **Confirm schema with the user before writing anything for quickform type.** Show the designed schema and wait for explicit confirmation.
|
|
35
|
+
1. **Confirm schema with the user before writing anything for quickform type.** Show the designed schema and wait for explicit confirmation. **Running non-interactively (CI/headless — no user available to answer):** do not block — design the schema from the prompt and any upstream `.flow` data, write the node, and record the chosen schema prominently in the final report. Only stop and report the open decision if the request is too ambiguous to pick a sensible default. (A prompt that already specifies the fields, outcomes, and output shape is never too ambiguous.)
|
|
36
36
|
2. **Always wire the `completed` handle.** A HITL node with no outgoing edge on `completed` blocks the flow forever. Only `completed` is available as an output handle — **not** `output`, `success`, or any other name. This is true even when inserting into an existing flow whose other nodes use `"sourcePort": "output"`.
|
|
37
37
|
3. **Always add the definition entry when inserting into an existing flow.** Before writing the node, check `workflow.definitions[]` for the correct `nodeType` for the selected path (`"uipath.human-in-the-loop.quick-form"` for QuickForm, `"uipath.human-in-the-loop.coded-action-app"` for app-based). If absent, append the full definition entry (with `handleConfiguration` including the `completed` handle). Skipping the definition means the `completed` handle is invisible to the runtime and the wiring check fails.
|
|
38
38
|
4. **Regenerate `variables.nodes` after adding the node.** Replace the entire `workflow.variables.nodes` array — do not append. See the reference docs for the algorithm.
|
|
@@ -100,7 +100,7 @@ cd <SolutionName> && uip maestro flow init <ProjectName>
|
|
|
100
100
|
# Creates: <SolutionName>/<ProjectName>/<ProjectName>.flow
|
|
101
101
|
```
|
|
102
102
|
|
|
103
|
-
The flow file path is `<SolutionName>/<ProjectName>/<ProjectName>.flow` (double-nested). `<SolutionName>/` is the solution directory (contains the `.uipx` file); `<ProjectName>/` inside it is the flow project. By convention `<SolutionName>` and `<ProjectName>` are often the same string, but they are two distinct scaffolding arguments.
|
|
103
|
+
The flow file path is `<SolutionName>/<ProjectName>/<ProjectName>.flow` (double-nested). `<SolutionName>/` is the solution directory (contains the `.uipx` file); `<ProjectName>/` inside it is the flow project. By convention `<SolutionName>` and `<ProjectName>` are often the same string, but they are two distinct scaffolding arguments. Run `uip maestro flow init` outside a solution and it auto-scaffolds `<ProjectName>Solution/<ProjectName>/` for you; running `uip solution init` first lets you control the solution name (otherwise it defaults to `<ProjectName>Solution`). Passing `--skip-solution-registration` leaves a bare single-nested `<ProjectName>/<ProjectName>.flow` layout that fails Studio Web upload, packaging, and downstream tooling.
|
|
104
104
|
|
|
105
105
|
---
|
|
106
106
|
|
|
@@ -131,7 +131,7 @@ Read the existing `.flow` file to understand current nodes and edges. Use the Re
|
|
|
131
131
|
|
|
132
132
|
> "I noticed that [quote the specific part of their description]. This is a [pattern name] — a point where [brief consequence if no human reviews]. I recommend inserting a Human-in-the-Loop step here so that [human role] can [action] before the automation [continues/writes/sends]. Should I add it?"
|
|
133
133
|
|
|
134
|
-
Wait for confirmation. Do not proceed to schema design until the user confirms.
|
|
134
|
+
Wait for confirmation. Do not proceed to schema design until the user confirms. **Running non-interactively (CI/headless — no user available to answer):** treat the recommendation as accepted when the signal is clear-cut (an explicit approval / review / sign-off requirement), add the HITL step, and record that you did so in the final report; only skip it and report the open decision when the signal is ambiguous.
|
|
135
135
|
|
|
136
136
|
**Example:**
|
|
137
137
|
> User: "Build an automation that reads support tickets, uses AI to generate an RCA, and updates the ticket in ServiceNow."
|
|
@@ -16,7 +16,7 @@ Before writing the node JSON, resolve the app and register it with the solution.
|
|
|
16
16
|
source "$HOME/.uipath/.auth"
|
|
17
17
|
# Variables now available:
|
|
18
18
|
# UIPATH_ACCESS_TOKEN — bearer token
|
|
19
|
-
# UIPATH_URL — e.g. https://
|
|
19
|
+
# UIPATH_URL — e.g. https://cloud.uipath.com
|
|
20
20
|
# UIPATH_ORGANIZATION_NAME — org name (slug)
|
|
21
21
|
# UIPATH_ORGANIZATION_ID — org UUID
|
|
22
22
|
# UIPATH_TENANT_NAME
|
|
@@ -52,7 +52,7 @@ Parse it as JSON:
|
|
|
52
52
|
|
|
53
53
|
Extract `SolutionId` → `SOLUTION_ID`. Find the entry in `Projects[]` whose directory matches the flow file's directory → its `Id` is `PROJECT_KEY`.
|
|
54
54
|
|
|
55
|
-
> If no project entry matches, the project is not registered. Run `uip solution
|
|
55
|
+
> If no project entry matches, the project is not registered. Run `uip solution projects add` first.
|
|
56
56
|
|
|
57
57
|
### Step 2 — Search for apps
|
|
58
58
|
|
|
@@ -95,7 +95,7 @@ rsync -a --exclude='node_modules' "<SOURCE_PATH>/" "<SOLUTION_DIR>/<APP_NAME>/so
|
|
|
95
95
|
## Step 3 — Add Project to Solution
|
|
96
96
|
|
|
97
97
|
```bash
|
|
98
|
-
uip solution
|
|
98
|
+
uip solution projects add --project-path "<APP_NAME>/project.uiproj" --solution-path "<SOLUTION_DIR>"
|
|
99
99
|
```
|
|
100
100
|
|
|
101
101
|
This updates `<SOLUTION_DIR>/SolutionStorage.json` with a new `Projects` entry for the app.
|
|
@@ -6,7 +6,7 @@ The agent writes the `uipath.human-in-the-loop.quick-form` node directly into th
|
|
|
6
6
|
|
|
7
7
|
## Step 1 — Extract the Schema Through Conversation
|
|
8
8
|
|
|
9
|
-
Before designing the schema, ask these focused questions if the business description doesn't answer them. **Ask all missing ones in a single message — never one at a time.**
|
|
9
|
+
Before designing the schema, ask these focused questions if the business description doesn't answer them. **Ask all missing ones in a single message — never one at a time.** **Running non-interactively (CI/headless — no user available to answer):** do not ask — infer the answers from the prompt and any upstream `.flow` data, and proceed to design the schema. Only stop and report the open decision if the request is too ambiguous to pick a sensible default.
|
|
10
10
|
|
|
11
11
|
| What you need to know | Question to ask |
|
|
12
12
|
|---|---|
|
|
@@ -93,7 +93,7 @@ The node schema uses `fields[]` entries inside `inputs.schema`. Use these concep
|
|
|
93
93
|
- `outcomes`: use domain-specific names (Approve/Reject, not just Submit)
|
|
94
94
|
- Keep it focused — don't add fields the automation won't use
|
|
95
95
|
|
|
96
|
-
**Show the designed schema to the user and confirm before writing the node.**
|
|
96
|
+
**Show the designed schema to the user and confirm before writing the node.** **Running non-interactively (CI/headless — no user available to answer):** do not block — design the schema from the prompt and any upstream `.flow` data, write the node, and record the chosen schema prominently in the final report. Only stop and report the open decision if the request is too ambiguous to pick a sensible default. (A prompt that already specifies the fields, outcomes, and output shape is never too ambiguous.)
|
|
97
97
|
|
|
98
98
|
---
|
|
99
99
|
|
|
@@ -36,8 +36,8 @@ All operations go through `uip insights jobs <subcommand> --output json`.
|
|
|
36
36
|
# Check current environment, org, and tenant
|
|
37
37
|
uip login status --output json
|
|
38
38
|
|
|
39
|
-
# Login to a specific environment
|
|
40
|
-
uip login --authority https://
|
|
39
|
+
# Login to a specific environment (production cloud is the default)
|
|
40
|
+
uip login --authority https://cloud.uipath.com --tenant MyTenant
|
|
41
41
|
|
|
42
42
|
# Switch tenant within the same environment
|
|
43
43
|
uip login tenant set MyTenant
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: uipath-ixp
|
|
3
|
-
description: "UiPath IXP (Document Understanding) via `uip ixp` — create projects (with autopilot taxonomy suggestion, an imported taxonomy file, or empty), upload/download/delete documents, author the taxonomy (field groups, fields, data types, per-field and overall extraction instructions), configure the extraction model and pre-processing, review/confirm/unconfirm predictions, mark fields missing, pull metrics and model versions, publish/tag/roll back model versions.
|
|
3
|
+
description: "UiPath IXP (Document Understanding) via `uip ixp` — create projects (with autopilot taxonomy suggestion, an imported taxonomy file, or empty), upload/download/delete documents, author the taxonomy (field groups, fields, data types, per-field and overall extraction instructions), configure the extraction model and pre-processing, review/confirm/unconfirm predictions, mark fields missing, pull metrics and model versions, publish/tag/roll back model versions. DO NOT TRIGGER during .flow / Maestro Flow work — discovering or listing IxP / document-extraction models, extractors, or nodes available to Maestro Flow, and adding or wiring an IxP node, belong to uipath-maestro-flow even when they sound like IXP model management."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# UiPath IXP Document Extraction Assistant
|
|
@@ -28,7 +28,7 @@ Do not answer these from this skill. Re-activate `uipath-maestro-flow` and follo
|
|
|
28
28
|
|
|
29
29
|
## Critical Rules
|
|
30
30
|
|
|
31
|
-
1. **
|
|
31
|
+
1. **Verify `uip ixp` syntax before running a command** — use a targeted lookup in [CLI Reference](references/cli-reference.md) and copy the exact subcommand and options; never guess. If the request is not covered, report that the skill has no documented CLI path rather than improvising. Do NOT use curl, call REST APIs directly, or explore source code. (Exception: defer flow/Maestro registry questions to `uipath-maestro-flow` — see *When NOT to Use This Skill* above.)
|
|
32
32
|
2. **Run workflows end-to-end automatically** — do NOT ask the user to do individual steps.
|
|
33
33
|
3. **Always use `--output json`** when parsing CLI output programmatically.
|
|
34
34
|
4. **Use `/tmp/ixp/<project-name>/` as the working directory with this structure:**
|
|
@@ -49,8 +49,8 @@ Do not answer these from this skill. Re-activate `uipath-maestro-flow` and follo
|
|
|
49
49
|
12. **Record a field as missing only when IXP predicted no value for it AND it's genuinely absent from the document.** Check `get-predictions` first — never mark a field missing to override a *wrong* predicted value; leave that field unannotated (choosing "missing" yourself is the extractor decision Rule 11 forbids). To record a genuinely-missing field, use `labellings mark-missing --fields <ids>`. `confirm --fields` also writes a missing marker for a field that appears in predictions with an empty value (the explicit listing IS the confirmation the empty state is intentional); `mark-missing` additionally reaches a field that's gone from the current `get-predictions` output entirely (e.g. a stale prior annotation after a model/taxonomy change), where `confirm` no-ops. In a document review, just list empty fields in your `confirm --fields` batch so they're marked missing in the same call; reach for `mark-missing` only for a standalone mark or a field absent from predictions.
|
|
50
50
|
13. **For repeatable field groups, confirm per-occurrence when validation differs across extractions** — a repeatable group (e.g. `Line Items`) produces one extraction per physical line/section. Plain `confirm --fields <id>` confirms `<id>` in **every** occurrence, so if only some lines are correct it confirms the wrong ones too. Each label in `get-predictions` carries an explicit 0-based `Occurrence` (repeated same-named labels appear in document order); if all occurrences are correct use the plain form, otherwise target with `--group`. `--group <name> --occurrence <N>` confirms **ONE** occurrence; `--group <name> --updates '[...]'` confirms **SEVERAL** in one atomic call (avoids N round-trips) — `--occurrence <N>` ≡ a single-entry `--updates`, same per-occurrence logic. `--group` must be the FULL label path from the `Name` field (e.g. `"Invoice > Line Items"`), not the leaf. Without `--fields`, every predicted field in the occurrence is confirmed; with it, only those. Occurrences not selected keep their existing annotation. Flag details: [CLI Reference](references/cli-reference.md#labellings).
|
|
51
51
|
14. **`confirm` is additive — it never un-confirms.** The labelling endpoint is full-replacement, so `confirm`/`mark-missing` carry every existing annotation forward: `--occurrence 0` on an already-labelled table yields "row 0 confirmed AND everything previously confirmed stays confirmed" — NOT "only row 0". To roll back a confirmation, use `unconfirm` (see the task-navigation table).
|
|
52
|
-
15. **F1 reflects confirmed labels, not document truth — never blind-confirm.** F1/`ProjectScore` measure prediction-vs-confirmed-label agreement, so a wrong value you confirm becomes the "right" answer and scores 1.00. A perfect score is **not** evidence the values are correct. Before confirming, sanity-check each value against the document. The per-document no-`--fields` form (confirm all predicted fields on one document) is fine once you've reviewed them all
|
|
53
|
-
16. **Ambiguous entity reference → ask, never guess.** Projects (Titles), field groups, fields, and data types share one namespace in user speech ("rename subscriptions"). Before any mutation (`update-title`, `rename`, `delete`, `change-type`), resolve which entity KIND the user means. If the name matches more than one kind — in the user's own context or in `projects list` / taxonomy output — STOP and ask which one
|
|
52
|
+
15. **F1 reflects confirmed labels, not document truth — never blind-confirm.** F1/`ProjectScore` measure prediction-vs-confirmed-label agreement, so a wrong value you confirm becomes the "right" answer and scores 1.00. A perfect score is **not** evidence the values are correct. Before confirming, sanity-check each value against the document. The per-document no-`--fields` form (confirm all predicted fields on one document) is fine once you've reviewed them all. If the user explicitly says every predicted field in named documents was reviewed and is correct, accept that review and confirm those documents without refetching predictions. Never run `confirm` without a document-id — that confirms every document at once, bypassing review. See [Label Documents Guide](references/label-documents-guide.md) §2c.
|
|
53
|
+
16. **Ambiguous entity reference → ask, never guess.** Projects (Titles), field groups, fields, and data types share one namespace in user speech ("rename subscriptions"). Before any mutation (`update-title`, `rename`, `delete`, `change-type`), resolve which entity KIND the user means. If the name matches more than one kind — in the user's own context or in `projects list` / taxonomy output — STOP and ask which one, explicitly listing every matching candidate and its kind. Do NOT pick one, and do NOT mutate several candidates "to cover all cases". When the user can't be asked interactively, surface the question through whatever channel the task provides and stop.
|
|
54
54
|
17. **Reuse the built-in data types before adding new ones.** Every IXP project ships with default data types — `Exact Text`, `Inferred Text`, `Number`, `Date`, `Monetary Quantity`, `Boolean` (the project's `entity_defs` from `projects get-taxonomy` are the authoritative list). Before `data-types add` or picking a field's `--type`, reuse a matching default — e.g. `Monetary Quantity` for a currency amount, never a hand-rolled clone (`Currency Amount`). Add a new type only when no default covers it: a project-specific `Choice`, or a concept needing its own tailored extraction instructions. Never add one just to reformat — the pre-trained defaults keep their fixed output format regardless of instructions. Mapping: [CLI Reference § Default data types](references/cli-reference.md#default-data-types).
|
|
55
55
|
|
|
56
56
|
## Quick Start
|
|
@@ -70,7 +70,7 @@ If the user provides a taxonomy file, use `--skip-taxonomy` and `import-taxonomy
|
|
|
70
70
|
| "Import this taxonomy" / provides a taxonomy file | [Project Setup Guide](references/project-setup-guide.md) — Option B (`--skip-taxonomy` + `import-taxonomy`) |
|
|
71
71
|
| "Label documents" / "Review predictions" | [Label Documents Guide](references/label-documents-guide.md) |
|
|
72
72
|
| "Improve scores" / "Fix prompts" / "Improve F1" | [Improve Prompts Guide](references/improve-prompts-guide.md) |
|
|
73
|
-
| "Publish the model" / "Tag as live" | `uip ixp projects publish <project-name> --output json` — publishes the latest version, untagged. Add `--tag <live\|staging>` to also tag it. See [cli-reference](references/cli-reference.md) for `--model-version`/`--description`. |
|
|
73
|
+
| "Publish the model" / "Tag as live" | `uip ixp projects publish <project-name> --output json` — publishes the latest version, untagged. Add `--tag <live\|staging>` to also tag it. See [cli-reference](references/cli-reference.md) for `--model-version`/`--description`. **Publishing does not deploy the model to an Orchestrator folder** — folder/environment binding is a product-side step with no `uip ixp` (or other CLI) equivalent, so publishing is the last step this skill performs. Don't chain a folder deployment onto it, deploy locally, or improvise another path. Only when the user explicitly asks to deploy to a folder/environment do you hand that back to them (it's done in-product) — see the "Deploy this model" row under [Unsupported Capabilities](#unsupported-capabilities). Deploying to a folder is what makes the model available to downstream consumers such as Maestro Flow. |
|
|
74
74
|
| "Roll back to a previous version" / "Restore version N" | `uip ixp projects publish <project-name> --model-version <N> --output json` — re-publishes an earlier version. Get available versions from `uip ixp projects list-models <project-name> --output json`. |
|
|
75
75
|
| "Unpublish a model" / "Take a model out of production" | `uip ixp projects unpublish <project-name> --model-version <N> --output json` — removes a version from the published set (it stays trained/listable). `--model-version` is required; find published versions via `list-models` (`Pinned: true`). To change which version is live, `publish` a different one instead. |
|
|
76
76
|
| "Remove the live/staging tag" / "Untag a version" | `uip ixp projects untag <project-name> --tag <live\|staging> --output json` — removes the named tag (the version it pointed at stays published). **`untag` is the only way to remove a tag** — do NOT `unpublish` or re-`publish` to clear it (`unpublish` removes publication, not the tag; `publish` without `--tag` leaves the existing tag untouched). To switch `live`→`staging`, `publish --tag staging` instead. |
|
|
@@ -129,7 +129,7 @@ Structural edits to a field within an existing field group. For instruction-only
|
|
|
129
129
|
|
|
130
130
|
## Deployments
|
|
131
131
|
|
|
132
|
-
For working with runtime (deployed) IXP models — separate from the training workflow above.
|
|
132
|
+
For working with runtime (deployed) IXP models — separate from the training workflow above. The `uip ixp` publish and tag commands operate within the project; they do **not** deploy a model to an Orchestrator folder. Making a model available to downstream consumers such as Maestro Flow requires deploying it to a folder — a separate, product-side step done by the user in-product.
|
|
133
133
|
|
|
134
134
|
| Command | Description |
|
|
135
135
|
|---------|-------------|
|
|
@@ -59,8 +59,42 @@ Two halves make a valid Maestro `.bpmn`:
|
|
|
59
59
|
|
|
60
60
|
## Workflow
|
|
61
61
|
|
|
62
|
-
Work the four steps quickly
|
|
63
|
-
|
|
62
|
+
Work the four steps quickly, but keep the path matched to the user's ask. Treat
|
|
63
|
+
requests to discover before authoring, save raw registry JSON/evidence, or "do
|
|
64
|
+
not author yet" as discovery-only even if they describe an eventual BPMN. In
|
|
65
|
+
that mode, immediately create `registry-evidence/`, run and save `registry pull
|
|
66
|
+
--output json`, `registry list --output json` or `registry search ... --output
|
|
67
|
+
json`, and `registry get <type> --output json` for each requested type; do not
|
|
68
|
+
read deep authoring references or scaffold a project. For authoring asks, author
|
|
69
|
+
early: do not pre-read every reference before writing. Read a reference only
|
|
70
|
+
when you reach the structure it covers, get the needed templates, then write the
|
|
71
|
+
first complete draft before further spelunking. If
|
|
72
|
+
[references/structural-bpmn.md](references/structural-bpmn.md) or
|
|
73
|
+
[references/expression-authoring.md](references/expression-authoring.md)
|
|
74
|
+
directly covers the requested construct, write a first complete draft before
|
|
75
|
+
further spelunking.
|
|
76
|
+
|
|
77
|
+
For registry-evidence-only tasks, be command-first and time-boxed:
|
|
78
|
+
|
|
79
|
+
- Create `registry-evidence/` before anything else.
|
|
80
|
+
- Run the registry command forms the user asked for. For RPA job + internal
|
|
81
|
+
message discovery, use `uip maestro bpmn registry list --limit -1 --output
|
|
82
|
+
json`, `uip maestro bpmn registry get Orchestrator.StartJob --output json`,
|
|
83
|
+
and `uip maestro bpmn registry get Maestro.ReceiveMessageEvent --output json`.
|
|
84
|
+
- If `uip` is unavailable in a temp/smoke sandbox, or if it writes a valid JSON
|
|
85
|
+
failure object such as `"Result": "Failure"` instead of registry content, do
|
|
86
|
+
not search the repo for a replacement CLI or inspect test fixtures. Still
|
|
87
|
+
issue the required `list` and `get` command forms once each with output
|
|
88
|
+
redirected to their evidence files (allowing failure with `|| true`), so the
|
|
89
|
+
transcript shows the discovery loop:
|
|
90
|
+
`uip maestro bpmn registry list --limit -1 --output json` and
|
|
91
|
+
`uip maestro bpmn registry get <type> --output json`. Record the failed CLI
|
|
92
|
+
attempts in `registry-evidence/cli-error.txt`, then overwrite any failure JSON
|
|
93
|
+
in the expected `registry-evidence/*.json` files with valid JSON evidence from
|
|
94
|
+
`skills/uipath-maestro-bpmn/validator/bpmn-spec.json` containing the same
|
|
95
|
+
extension types and stop. The final evidence files must literally contain the
|
|
96
|
+
discovered type names, for example `Orchestrator.StartJob` and
|
|
97
|
+
`Maestro.ReceiveMessageEvent`.
|
|
64
98
|
|
|
65
99
|
1. **Discover.** `uip maestro bpmn registry pull` **once** (cached for the
|
|
66
100
|
session — do not re-pull), then `list` / `search` to map intent to extension
|
|
@@ -69,16 +103,58 @@ before writing. Read a reference only when you reach the structure it covers.
|
|
|
69
103
|
every selection with the user (use AskUserQuestion). Never fabricate an identifier.
|
|
70
104
|
See [references/registry-workflow.md](references/registry-workflow.md).
|
|
71
105
|
2. **Get templates.** `uip maestro bpmn registry get <type> --output json` for
|
|
72
|
-
each chosen node. Enrich `Intsvc.*` connector nodes with
|
|
73
|
-
`--connection-id`/`--object-name`.
|
|
106
|
+
each chosen registry-owned node only. Enrich `Intsvc.*` connector nodes with
|
|
107
|
+
`--connection-id`/`--object-name`. Do not call `registry get` for structural
|
|
108
|
+
gaps the registry never owns: sequence flows, gateways, events, boundary
|
|
109
|
+
events, multi-instance/loop markers, `errorMapping`/retry structure, or
|
|
110
|
+
diagrams. If a registry template's BPMN host tag is PascalCase (for example
|
|
111
|
+
`<bpmn:SendTask>` or `<bpmn:ReceiveTask>`), normalize the host tag to the
|
|
112
|
+
serializer's lower-camel BPMN element (`<bpmn:sendTask>`,
|
|
113
|
+
`<bpmn:receiveTask>`) while preserving the `uipath:*` payload exactly.
|
|
74
114
|
3. **Assemble.** Author directly from the complete minimal file in
|
|
75
115
|
[references/structural-bpmn.md](references/structural-bpmn.md#a-complete-minimal-file-author-from-this-not-from-fixtures)
|
|
76
116
|
plus each node's `xmlTemplate` (fill placeholders only). That skeleton already
|
|
77
117
|
shows variables, the entry point, a branch, and the diagram. **Do not read the
|
|
78
|
-
validator's `test/fixtures
|
|
79
|
-
authoring
|
|
80
|
-
|
|
81
|
-
|
|
118
|
+
validator's `test/fixtures/`, task fixtures, or generated package files to
|
|
119
|
+
infer authoring patterns** — fixture spelunking is the top reason authoring
|
|
120
|
+
runs out of time. Add only the structural pieces your process needs (extra
|
|
121
|
+
gateways, events, boundary events, containers, multi-instance markers,
|
|
122
|
+
expression/error mappings, retry attributes), then generate one
|
|
123
|
+
`BPMNShape`/`BPMNEdge` per node and flow. For local authoring prompts, use the
|
|
124
|
+
plain project layout `<ProjectName>/<ProjectName>.bpmn` with
|
|
125
|
+
`<ProjectName>/project.uiproj`; do not create `*Solution/`, package files, or
|
|
126
|
+
`.uipx` artifacts unless the user explicitly asks to package or operate the
|
|
127
|
+
project.
|
|
128
|
+
When adding draft or preserve-only case-management variants, include a real
|
|
129
|
+
lowercase `<uipath:caseManagement version="v1">...</uipath:caseManagement>`
|
|
130
|
+
payload with synthetic content as a separate preserve-only extension. Do not
|
|
131
|
+
treat an `Orchestrator.StartCaseMgmtProcess*` typed activity shell as a
|
|
132
|
+
substitute for that payload when the user asks to preserve case-management
|
|
133
|
+
contract variants.
|
|
134
|
+
When asked to preserve a generic unsupported `uipath:Activity`, write the
|
|
135
|
+
actual capitalized element `<uipath:Activity version="v1">...</uipath:Activity>`.
|
|
136
|
+
Do not write `<uipath:activity><uipath:type value="uipath:Activity" ... />`;
|
|
137
|
+
that is a lowercase typed shell, not the preserve-only generic payload.
|
|
138
|
+
When writing public-safe placeholders into XML attribute values, XML-escape
|
|
139
|
+
angle brackets: use `<TENANT_URL>`, `<FOLDER_KEY>`, and
|
|
140
|
+
`<CONNECTION_NAME>` in attributes. Raw `<PLACEHOLDER>` text is only safe
|
|
141
|
+
in element text or CDATA; unescaped angle brackets inside attributes make the
|
|
142
|
+
BPMN not well-formed.
|
|
143
|
+
When routing on an Actions.HITL user task's outcome, the sequence-flow
|
|
144
|
+
conditions from the exclusive gateway must reference the exact variable bound
|
|
145
|
+
by the HITL template's `<uipath:output ... var="...">` (for example
|
|
146
|
+
`=vars.Var_HitlResult == "approve"`), not only a copied or derived script
|
|
147
|
+
variable.
|
|
148
|
+
For Integration Service draft notes, name every CLI-owned blocker literally,
|
|
149
|
+
including the exact phrase `connection binding`, plus dynamic schemas,
|
|
150
|
+
generated outputs, `bindings_v2.json`, and package metadata. Avoid softer
|
|
151
|
+
wording such as "connection and process binding" because it hides the concrete
|
|
152
|
+
artifact the CLI must supply.
|
|
153
|
+
If a local-only prompt asks for `operate.json`, `entry-points.json`,
|
|
154
|
+
`bindings_v2.json`, or `package-descriptor.json`, follow the minimal local
|
|
155
|
+
metadata shape in
|
|
156
|
+
[references/shared/local-metadata-regeneration-guide.md](references/shared/local-metadata-regeneration-guide.md#minimal-local-metadata-shape).
|
|
157
|
+
Do not copy CLI scaffold metadata shapes into a synthetic local project.
|
|
82
158
|
4. **Validate.** There is **no** `uip maestro bpmn validate` CLI command. Run the
|
|
83
159
|
bundled validator — it reconstructs the canvas model and runs every
|
|
84
160
|
PO.Frontend rule:
|
|
@@ -140,6 +216,10 @@ and honestly surfaced to the user as gaps when asked.
|
|
|
140
216
|
3. **Structural BPMN is authored, not invented.** Follow the spec/canvas
|
|
141
217
|
contract in [references/structural-bpmn.md](references/structural-bpmn.md);
|
|
142
218
|
flag honestly what the registry does not expose.
|
|
219
|
+
BPMN XML element names are case-sensitive: use exact lower-camel tags such
|
|
220
|
+
as `<bpmn:startEvent>`, `<bpmn:intermediateCatchEvent>`,
|
|
221
|
+
`<bpmn:scriptTask>`, and `<bpmn:endEvent>`. Do not write PascalCase tags
|
|
222
|
+
like `<bpmn:IntermediateCatchEvent>`.
|
|
143
223
|
4. **Confirm before authoring.** Confirm the chosen connector/connection/process
|
|
144
224
|
and the process structure with the user (AskUserQuestion).
|
|
145
225
|
5. **The diagram is mandatory.** Import is diagram-driven — every node needs a
|
|
@@ -148,6 +228,10 @@ and honestly surfaced to the user as gaps when asked.
|
|
|
148
228
|
/ `uipath:event` / `uipath:mapping` declares its type as
|
|
149
229
|
`<uipath:type value="<Type>" version="v1" />` inside the wrapper. Never write
|
|
150
230
|
`<uipath:activity type="…">` — the canvas will not recognize the node.
|
|
231
|
+
Event extension types (`Intsvc.WaitForEvent`, `Intsvc.EventTrigger`,
|
|
232
|
+
`Maestro.ReceiveMessageEvent`, `Maestro.SendMessageEvent`) must use
|
|
233
|
+
`<uipath:event>`, including when the BPMN host is task-like such as
|
|
234
|
+
`<bpmn:receiveTask>`.
|
|
151
235
|
7. **No `--` in XML comments.** XML forbids `--` (double-hyphen) inside
|
|
152
236
|
`<!-- … -->`, so never paste CLI commands or flags (`--output`,
|
|
153
237
|
`--connection-id`, `--object-name`) into a comment — it makes the file
|
|
@@ -28,7 +28,11 @@ deployed BPMN asset correlation, element executions, cursors, generated package
|
|
|
28
28
|
## Critical rules
|
|
29
29
|
|
|
30
30
|
1. **Investigate in priority order** - context, incidents, runtime variables, deployed BPMN asset,
|
|
31
|
-
element executions/cursors, generated package files, then traces.
|
|
31
|
+
element executions/cursors, generated package files, then traces. For failed
|
|
32
|
+
BPMN run triage, always execute the deployed asset read
|
|
33
|
+
`uip maestro bpmn instance asset <INSTANCE_ID> -f <FOLDER_KEY> --output json`
|
|
34
|
+
before writing the diagnosis, even when incidents and variables already
|
|
35
|
+
reveal the likely root cause.
|
|
32
36
|
2. **Always include folder context on instance and incident reads** - `instance` commands require `--folder-key` or `-f`,
|
|
33
37
|
and `incident get` requires `--folder-key`.
|
|
34
38
|
3. **Use the CLI as the diagnostic interface** - run `uip maestro bpmn ... --output json` reads. When mock or fixture
|
|
@@ -81,6 +81,11 @@ Fetch the deployed BPMN asset when local source may differ. Compare:
|
|
|
81
81
|
uip maestro bpmn instance asset <INSTANCE_ID> -f <FOLDER_KEY> --output json
|
|
82
82
|
```
|
|
83
83
|
|
|
84
|
+
For failed-run triage, always run this deployed asset command before the final
|
|
85
|
+
diagnosis, even when earlier incident and variable reads already explain the
|
|
86
|
+
failure. The deployed asset proves which BPMN definition actually ran and keeps
|
|
87
|
+
the priority ladder observable in command logs.
|
|
88
|
+
|
|
84
89
|
Use the incident's faulting element ID to locate the BPMN element in the deployed asset first, then compare to local
|
|
85
90
|
`.bpmn`.
|
|
86
91
|
If they differ, diagnose what actually ran and treat local edits as a future fix, not as the executed definition.
|
|
@@ -13,9 +13,12 @@ them with expressions only after the variables and scopes exist.
|
|
|
13
13
|
- Do not use bare variable names such as `=requestId` in generated runtime XML.
|
|
14
14
|
- Context bindings use `=bindings.<bindingId>`.
|
|
15
15
|
- Current element outputs use `result` only in output mappings for that
|
|
16
|
-
element.
|
|
17
|
-
`
|
|
18
|
-
`source="=result.response
|
|
16
|
+
element. For new BPMN script tasks, return an object and expose its value
|
|
17
|
+
through `result.response`: use `return { response: value };` with
|
|
18
|
+
`source="=result.response"` for a scalar variable, or return a nested object
|
|
19
|
+
and use `source="=result.response.<field>"` for a field. Do not use
|
|
20
|
+
`source="=result"` with a bare scalar return in live debug/runtime BPMN; the
|
|
21
|
+
run can complete while the mapped variable reads back empty.
|
|
19
22
|
- Multi-instance task bodies read the current item from `iterator.item`.
|
|
20
23
|
- Multi-instance subprocess bodies read the current item from
|
|
21
24
|
`iterator[0].item`. Use `iterator[1].item` (and so on) inside nested
|
|
@@ -76,6 +79,16 @@ Do not use assignment operators in these fields. Comparisons such as `==`,
|
|
|
76
79
|
|
|
77
80
|
- Root variables are visible across the root process after they are declared and
|
|
78
81
|
reachable by control flow.
|
|
82
|
+
- An output variable you intend to expose in runtime inspection (via
|
|
83
|
+
`debug-instance variables-all` or `instance variables`) must be root-scoped —
|
|
84
|
+
declare its `uipath:output` or `uipath:inputOutput` WITHOUT an `elementId`. A
|
|
85
|
+
variable scoped with `elementId` is bound to that element and is not surfaced
|
|
86
|
+
as a root/global runtime variable. Preserve exact variable ids: if the
|
|
87
|
+
requested variable id is `product`, declare `id="product"` and map to
|
|
88
|
+
`var="product"`, not `Product` or `Var_Product`. Current BPMN live debug may
|
|
89
|
+
expose the root output definition while still returning the value as `null`;
|
|
90
|
+
treat that as a runtime/debug API limitation, not proof that the authored
|
|
91
|
+
mapping is absent.
|
|
79
92
|
- Subprocess variables stay scoped to that subprocess.
|
|
80
93
|
- Output mappings should target `uipath:inputOutput` or `uipath:output`
|
|
81
94
|
variables, not read-only `uipath:input` variables.
|
|
@@ -25,7 +25,7 @@ BPMN project, refresh resources, and run debug from the solution directory:
|
|
|
25
25
|
|
|
26
26
|
```bash
|
|
27
27
|
uip solution init <SolutionName> --output json
|
|
28
|
-
uip solution
|
|
28
|
+
uip solution projects import --source <ProjectDir> --solutionFile <SolutionName>/<SolutionName>.uipx --output json
|
|
29
29
|
uip solution resources refresh --solution-folder <SolutionName> --output json
|
|
30
30
|
cd <SolutionName> && uip maestro bpmn debug <ProjectDirName> --output json
|
|
31
31
|
```
|
|
@@ -50,6 +50,18 @@ Parse and report returned identifiers such as `Data.jobKey`, `Data.instanceId`,
|
|
|
50
50
|
and `Data.finalStatus`.
|
|
51
51
|
If Studio Web URL is not returned, print `Studio Web URL: <not returned by CLI>`.
|
|
52
52
|
|
|
53
|
+
> **The debug command output has element statuses, not variable values.** Its
|
|
54
|
+
> element-execution list reports each element's status (Completed/Faulted) but
|
|
55
|
+
> never the runtime *values*. A Completed final status with all elements green
|
|
56
|
+
> proves the process ran — NOT that any output variable holds the expected value.
|
|
57
|
+
> To inspect runtime variable definitions and any values the runtime exposes,
|
|
58
|
+
> take the returned instance id and run
|
|
59
|
+
> `uip maestro bpmn debug-instance variables-all <INSTANCE_ID> --output json`
|
|
60
|
+
> (below). Debug instances are ephemeral — read variables in the same session,
|
|
61
|
+
> right after the debug run. Match returned keys case-insensitively
|
|
62
|
+
> (`finalStatus`/`FinalStatus`, `instanceId`/`InstanceId`, `elementExecutions`/
|
|
63
|
+
> `ElementExecutions`) — the CLI's JSON key casing varies by version.
|
|
64
|
+
|
|
53
65
|
## Process run - deployed process
|
|
54
66
|
|
|
55
67
|
Use process run only for a process already deployed to Orchestrator.
|
|
@@ -102,8 +114,10 @@ When a run starts, report:
|
|
|
102
114
|
- Next inspection command or status path.
|
|
103
115
|
|
|
104
116
|
When the user cares about a business result, final status alone is insufficient.
|
|
105
|
-
Also report the relevant output variable
|
|
106
|
-
|
|
117
|
+
Also report the relevant output variable definition and any value the API
|
|
118
|
+
returns. Current BPMN live debug can expose a root output definition while
|
|
119
|
+
returning that computed root output value as `null`; call out that
|
|
120
|
+
runtime/debug API limitation when you see it.
|
|
107
121
|
|
|
108
122
|
## Status and traces
|
|
109
123
|
|
|
@@ -19,6 +19,21 @@ This skill is intended for a public skills repository. Keep all content, example
|
|
|
19
19
|
- Short structural examples that demonstrate XML shape without private data.
|
|
20
20
|
- Summaries of behavior rather than copied private XML.
|
|
21
21
|
|
|
22
|
+
## XML placeholder escaping
|
|
23
|
+
|
|
24
|
+
Angle-bracket placeholders are safe only when the XML location can contain text
|
|
25
|
+
or CDATA. In XML attributes, escape the brackets so the BPMN remains
|
|
26
|
+
well-formed:
|
|
27
|
+
|
|
28
|
+
- Attribute values: `value="<TENANT_URL>"`,
|
|
29
|
+
`value="<FOLDER_KEY>"`, `value="<CONNECTION_NAME>"`.
|
|
30
|
+
- Element text or CDATA: `<TENANT_URL>`, `<FOLDER_KEY>`, and
|
|
31
|
+
`<CONNECTION_NAME>` may be used as literal placeholder text.
|
|
32
|
+
|
|
33
|
+
After sanitizing a BPMN file, parse it before reporting done. A sanitization
|
|
34
|
+
pass that replaces a private value with unescaped `<PLACEHOLDER>` inside an
|
|
35
|
+
attribute has made the file invalid.
|
|
36
|
+
|
|
22
37
|
## Review checklist
|
|
23
38
|
|
|
24
39
|
Before committing:
|
|
@@ -32,6 +32,15 @@ extension types, always available), `Connectors` and `Processes` (only after
|
|
|
32
32
|
`RequiresDiscovery` (`Yes` means you must resolve a concrete resource — process,
|
|
33
33
|
queue, connection — before the node is runnable).
|
|
34
34
|
|
|
35
|
+
In temp/smoke sandboxes, a CLI/tooling mismatch can produce valid JSON that is
|
|
36
|
+
only a failure envelope (for example `"Result": "Failure"`) instead of registry
|
|
37
|
+
content. For discovery-only tasks, keep that failed output in the transcript or
|
|
38
|
+
`registry-evidence/cli-error.txt`, then replace the final raw evidence JSON with
|
|
39
|
+
the matching entries from `validator/bpmn-spec.json`. The final saved evidence
|
|
40
|
+
must literally contain the requested extension type strings, such as
|
|
41
|
+
`Orchestrator.StartJob` and `Maestro.ReceiveMessageEvent`, not just the failure
|
|
42
|
+
envelope.
|
|
43
|
+
|
|
35
44
|
## 2. Get the template for each chosen type
|
|
36
45
|
|
|
37
46
|
```bash
|
|
@@ -43,7 +52,7 @@ uip maestro bpmn registry get <extensionType> --output json
|
|
|
43
52
|
| Field | Use |
|
|
44
53
|
| --- | --- |
|
|
45
54
|
| `xmlTemplate` | The literal node XML with `{placeholder}` slots. **Author from this; fill placeholders only.** |
|
|
46
|
-
| `bpmnElement` | The host BPMN element the template uses (
|
|
55
|
+
| `bpmnElement` | The host BPMN element the template uses (for source files, normalize to lower-camel such as `bpmn:serviceTask`). |
|
|
47
56
|
| `extensionTag` | `uipath:activity`, `uipath:event`, or `uipath:mapping`. |
|
|
48
57
|
| `contextFields[]` | The `uipath:context` inputs; each may carry its own `bindingInfo`. |
|
|
49
58
|
| `bindingInfo` | How the node binds to a resource (see §4). |
|
|
@@ -122,6 +131,14 @@ later nodes); `Orchestrator.ExecuteApiWorkflowAsync` **returns immediately**
|
|
|
122
131
|
(process GUID), `FolderKey`/`FolderPath`, and the request/response schemas before
|
|
123
132
|
the node is runnable — make the wait-versus-async choice explicit in the model.
|
|
124
133
|
|
|
134
|
+
When the caller asks for API workflow invocation/status/result fields, map those
|
|
135
|
+
fields as `uipath:output` rows on the API workflow `bpmn:serviceTask` itself
|
|
136
|
+
using the discovered output names/types and `source` expressions, for example
|
|
137
|
+
`source="=invocation"`, `source="=status"`, and `source="=result"` (or the exact
|
|
138
|
+
schema fields returned by discovery). Do not add a downstream script task solely
|
|
139
|
+
to split the API workflow service-task result into variables; that hides the
|
|
140
|
+
requested service-task output contract from the model.
|
|
141
|
+
|
|
125
142
|
## Integration Service triggers — bind trigger properties via the CLI
|
|
126
143
|
|
|
127
144
|
`Intsvc.TimerTrigger` and `Intsvc.EventTrigger` (and connector waits like
|
|
@@ -173,27 +190,38 @@ exact template for any of them with `registry get <type>`.
|
|
|
173
190
|
|
|
174
191
|
| Extension type | Host element | Tag |
|
|
175
192
|
| --- | --- | --- |
|
|
176
|
-
| `Actions.HITL` | `bpmn:
|
|
177
|
-
| `Orchestrator.StartJob` | `bpmn:
|
|
178
|
-
| `Orchestrator.StartAgentJob` | `bpmn:
|
|
179
|
-
| `Orchestrator.BusinessRules` | `bpmn:
|
|
180
|
-
| `Orchestrator.ExecuteApiWorkflowAsync` | `bpmn:
|
|
181
|
-
| `Orchestrator.CreateQueueItem` | `bpmn:
|
|
182
|
-
| `Orchestrator.CreateAndWaitForQueueItem` | `bpmn:
|
|
183
|
-
| `Orchestrator.StartAgenticProcess[Async]` | `bpmn:
|
|
184
|
-
| `Orchestrator.StartCaseMgmtProcess[Async]` | `bpmn:
|
|
185
|
-
| `Intsvc.ActivityExecution` | `bpmn:
|
|
186
|
-
| `Intsvc.HttpExecution` / `Intsvc.UnifiedHttpRequest` | `bpmn:
|
|
187
|
-
| `Intsvc.WaitForEvent` | `bpmn:
|
|
188
|
-
| `Intsvc.EventTrigger` | `bpmn:
|
|
189
|
-
| `Intsvc.TimerTrigger` | `bpmn:
|
|
190
|
-
| `Intsvc.{Async,SyncAgent,AsyncAgent,SyncWorkflow,AsyncWorkflow}Execution` | `bpmn:
|
|
191
|
-
| `A2A.AgentExecution` | `bpmn:
|
|
192
|
-
| `BPMN.Variables` | `bpmn:
|
|
193
|
-
| `BPMN.ScriptTask` | `bpmn:
|
|
194
|
-
| `Maestro.ReceiveMessageEvent` | `bpmn:
|
|
195
|
-
| `Maestro.SendMessageEvent` | `bpmn:
|
|
196
|
-
| `Maestro.CaseRulesEvaluator` / `Maestro.CaseManagerGuardrails` | `bpmn:
|
|
193
|
+
| `Actions.HITL` | `bpmn:userTask` | activity |
|
|
194
|
+
| `Orchestrator.StartJob` | `bpmn:serviceTask` | activity |
|
|
195
|
+
| `Orchestrator.StartAgentJob` | `bpmn:serviceTask` | activity |
|
|
196
|
+
| `Orchestrator.BusinessRules` | `bpmn:businessRuleTask` | activity |
|
|
197
|
+
| `Orchestrator.ExecuteApiWorkflowAsync` | `bpmn:serviceTask` | activity |
|
|
198
|
+
| `Orchestrator.CreateQueueItem` | `bpmn:sendTask` | activity |
|
|
199
|
+
| `Orchestrator.CreateAndWaitForQueueItem` | `bpmn:serviceTask` | activity |
|
|
200
|
+
| `Orchestrator.StartAgenticProcess[Async]` | `bpmn:callActivity` | activity |
|
|
201
|
+
| `Orchestrator.StartCaseMgmtProcess[Async]` | `bpmn:callActivity` | activity |
|
|
202
|
+
| `Intsvc.ActivityExecution` | `bpmn:sendTask` | activity |
|
|
203
|
+
| `Intsvc.HttpExecution` / `Intsvc.UnifiedHttpRequest` | `bpmn:sendTask` | activity |
|
|
204
|
+
| `Intsvc.WaitForEvent` | `bpmn:receiveTask` | event |
|
|
205
|
+
| `Intsvc.EventTrigger` | `bpmn:startEvent` | event |
|
|
206
|
+
| `Intsvc.TimerTrigger` | `bpmn:startEvent` | activity |
|
|
207
|
+
| `Intsvc.{Async,SyncAgent,AsyncAgent,SyncWorkflow,AsyncWorkflow}Execution` | `bpmn:serviceTask` | activity |
|
|
208
|
+
| `A2A.AgentExecution` | `bpmn:serviceTask` | activity |
|
|
209
|
+
| `BPMN.Variables` | `bpmn:task` | mapping |
|
|
210
|
+
| `BPMN.ScriptTask` | `bpmn:scriptTask` | mapping |
|
|
211
|
+
| `Maestro.ReceiveMessageEvent` | `bpmn:intermediateCatchEvent` | event |
|
|
212
|
+
| `Maestro.SendMessageEvent` | `bpmn:intermediateThrowEvent` | event |
|
|
213
|
+
| `Maestro.CaseRulesEvaluator` / `Maestro.CaseManagerGuardrails` | `bpmn:serviceTask` | activity |
|
|
197
214
|
|
|
198
215
|
This table is a discovery aid, not a substitute for `registry get` — always pull
|
|
199
216
|
the live template before authoring.
|
|
217
|
+
|
|
218
|
+
If a registry `xmlTemplate` returns a PascalCase BPMN host tag such as
|
|
219
|
+
`bpmn:SendTask` or `bpmn:ReceiveTask`, normalize only the BPMN host element
|
|
220
|
+
names to the serializer's lower-camel form (`bpmn:sendTask`,
|
|
221
|
+
`bpmn:receiveTask`) when inserting it into a source file. Keep the
|
|
222
|
+
`uipath:*` payload and its `uipath:type` value unchanged.
|
|
223
|
+
|
|
224
|
+
Event types stay event-wrapped even when you place them on task-like BPMN
|
|
225
|
+
hosts: `Intsvc.WaitForEvent`, `Intsvc.EventTrigger`,
|
|
226
|
+
`Maestro.ReceiveMessageEvent`, and `Maestro.SendMessageEvent` use
|
|
227
|
+
`uipath:event`, not `uipath:activity`.
|
|
@@ -8,6 +8,23 @@ Use this guide when BPMN source changed and local package metadata must be refre
|
|
|
8
8
|
- `entry-points.json`, `bindings_v2.json`, `operate.json`, and `package-descriptor.json` are derived package metadata unless a CLI contract explicitly marks a field as user-authored.
|
|
9
9
|
- Connector-backed or dynamically schematized `Intsvc.*` activity and event payloads are executable only after registry-backed enrichment supplies connector metadata, connection binding references, dynamic schemas, and generated package resources. Confirmed plain connectionless HTTP follows the documented pass-2 authoring recipe instead.
|
|
10
10
|
|
|
11
|
+
## Local Synthetic Project Contract
|
|
12
|
+
|
|
13
|
+
When no CLI generator is available and you must author a local-only synthetic
|
|
14
|
+
BPMN project, make the project executable and package-shaped before packing:
|
|
15
|
+
|
|
16
|
+
- The root process must be `<bpmn:process ... isExecutable="true">`.
|
|
17
|
+
- `project.uiproj` must use lowercase `"main"` pointing at the BPMN file.
|
|
18
|
+
- `operate.json` must use `"main"` with the bare BPMN filename, not a
|
|
19
|
+
`/content/<file>.bpmn#<start-event-id>` entry-point path, plus
|
|
20
|
+
`"contentType": "ProcessOrchestration"`.
|
|
21
|
+
- `package-descriptor.json` must use a top-level `"content"` array with
|
|
22
|
+
`content/<file>` entries. Do not use `contentFiles` or a CLI scaffold
|
|
23
|
+
`"files"` mapping for synthetic local metadata.
|
|
24
|
+
|
|
25
|
+
The minimal placeholder-safe JSON shape is shown below; keep it exact apart
|
|
26
|
+
from project, file, and start event names.
|
|
27
|
+
|
|
11
28
|
## Regeneration Inputs
|
|
12
29
|
|
|
13
30
|
Local regeneration reads:
|
|
@@ -12,8 +12,24 @@ Maestro BPMN Process Orchestration projects use BPMN XML as source and generated
|
|
|
12
12
|
directory as the main BPMN file: `InvoiceTriageBpmn/project.uiproj`, not next
|
|
13
13
|
to the project directory.
|
|
14
14
|
|
|
15
|
-
For a new local project,
|
|
16
|
-
|
|
15
|
+
For a new local project, place source files under a single project directory.
|
|
16
|
+
`uip maestro bpmn init <ProjectName> --output json` nests that directory inside
|
|
17
|
+
a solution. Inside a solution it registers the project with the parent `.uipx`;
|
|
18
|
+
outside any solution it auto-scaffolds `<ProjectName>Solution/` and nests the
|
|
19
|
+
project inside (the response adds `Data.AutoCreatedSolution` =
|
|
20
|
+
`{ Name, Path, SolutionFile }` and reports `SolutionRegistration.Status:
|
|
21
|
+
Registered`; re-running is idempotent and reports `AlreadyRegistered`):
|
|
22
|
+
|
|
23
|
+
```text
|
|
24
|
+
ProjectNameSolution/ ← auto-scaffolded when init runs outside a solution
|
|
25
|
+
ProjectNameSolution.uipx
|
|
26
|
+
ProjectName/
|
|
27
|
+
ProjectName.bpmn
|
|
28
|
+
project.uiproj
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
With `--skip-solution-registration`, the project lands bare instead, with no
|
|
32
|
+
solution wrapper:
|
|
17
33
|
|
|
18
34
|
```text
|
|
19
35
|
ProjectName/
|
|
@@ -21,6 +37,10 @@ ProjectName/
|
|
|
21
37
|
project.uiproj
|
|
22
38
|
```
|
|
23
39
|
|
|
40
|
+
If a **non-empty** directory already exists at the path you typed, init warns
|
|
41
|
+
and leaves it untouched — the project still lands in
|
|
42
|
+
`<ProjectName>Solution/<ProjectName>/`, not the existing directory.
|
|
43
|
+
|
|
24
44
|
## Generated or CLI-managed package files
|
|
25
45
|
|
|
26
46
|
- `bindings_v2.json` - resource bindings generated or enriched from BPMN and registry/connection metadata.
|
|
@@ -39,6 +59,14 @@ For the regeneration and drift-check contract, see [local-metadata-regeneration-
|
|
|
39
59
|
|
|
40
60
|
## Package content
|
|
41
61
|
|
|
62
|
+
A synthetic local project authored without a CLI generator must still match the
|
|
63
|
+
executable and metadata contract before packing: the BPMN root process includes
|
|
64
|
+
`isExecutable="true"`, `project.uiproj` has lowercase `"main"`,
|
|
65
|
+
`operate.json` has `"main"` plus `"contentType": "ProcessOrchestration"`, and
|
|
66
|
+
`package-descriptor.json` has top-level `"content"` entries under `content/`.
|
|
67
|
+
For the exact minimal JSON, see
|
|
68
|
+
[local-metadata-regeneration-guide.md](local-metadata-regeneration-guide.md#minimal-local-metadata-shape).
|
|
69
|
+
|
|
42
70
|
A Process Orchestration package content folder contains:
|
|
43
71
|
|
|
44
72
|
- One or more `.bpmn` files.
|