@uipath/skills 1.195.0 → 1.196.0
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 +16 -10
- package/README.md +39 -4
- package/assets/skill-status.json +189 -0
- package/assets/uip-catalog-snapshot.json +67 -97
- package/commands/install-permissions.md +46 -2
- package/hooks/suggest-permissions.sh +0 -0
- package/hooks/validate-skill-descriptions.sh +0 -0
- package/package.json +1 -1
- package/skills/uipath-admin/SKILL.md +6 -7
- package/skills/uipath-admin/references/audit-commands.md +32 -10
- package/skills/uipath-admin/references/audit-workflow-guide.md +25 -6
- package/skills/uipath-admin/references/ip-restriction/ip-restriction-commands.md +1 -1
- package/skills/uipath-agents/SKILL.md +5 -3
- package/skills/uipath-agents/references/coded/embedding-in-flows.md +6 -0
- package/skills/uipath-agents/references/coded/flow-integration.md +1 -0
- package/skills/uipath-agents/references/coded/frameworks/langgraph-integration.md +2 -2
- package/skills/uipath-agents/references/coded/frameworks/llamaindex-integration.md +1 -1
- package/skills/uipath-agents/references/coded/frameworks/openai-agents-integration.md +5 -1
- package/skills/uipath-agents/references/coded/lifecycle/build.md +1 -0
- package/skills/uipath-agents/references/coded/lifecycle/evaluate.md +8 -6
- package/skills/uipath-agents/references/coded/quickstart.md +17 -12
- package/skills/uipath-agents/references/lowcode/agent-definition.md +17 -16
- package/skills/uipath-agents/references/lowcode/capabilities/built-in-tools/analyze-attachments.md +2 -2
- package/skills/uipath-agents/references/lowcode/capabilities/built-in-tools/batch-transform/impl-json.md +1 -1
- package/skills/uipath-agents/references/lowcode/capabilities/built-in-tools/built-in-tools.md +4 -4
- package/skills/uipath-agents/references/lowcode/capabilities/built-in-tools/deeprag/impl-json.md +1 -1
- package/skills/uipath-agents/references/lowcode/capabilities/context/context.md +1 -1
- package/skills/uipath-agents/references/lowcode/capabilities/context/datafabric.md +1 -1
- package/skills/uipath-agents/references/lowcode/capabilities/context/index.md +12 -12
- package/skills/uipath-agents/references/lowcode/capabilities/escalation/escalation.md +14 -14
- package/skills/uipath-agents/references/lowcode/capabilities/guardrails/guardrails-recommend.md +1 -1
- package/skills/uipath-agents/references/lowcode/capabilities/guardrails/guardrails.md +23 -20
- package/skills/uipath-agents/references/lowcode/capabilities/inline-in-flow/inline-in-flow.md +27 -26
- package/skills/uipath-agents/references/lowcode/capabilities/integration-service/integration-service.md +12 -13
- package/skills/uipath-agents/references/lowcode/capabilities/mcp/mcp.md +133 -0
- package/skills/uipath-agents/references/lowcode/capabilities/memory/memory.md +9 -9
- package/skills/uipath-agents/references/lowcode/capabilities/process/process.md +25 -24
- package/skills/uipath-agents/references/lowcode/capabilities/process/solution-files.md +6 -6
- package/skills/uipath-agents/references/lowcode/critical-rules.md +17 -17
- package/skills/uipath-agents/references/lowcode/debug.md +55 -0
- package/skills/uipath-agents/references/lowcode/evaluations/evaluate.md +6 -6
- package/skills/uipath-agents/references/lowcode/evaluations/evaluation-sets.md +1 -1
- package/skills/uipath-agents/references/lowcode/evaluations/evaluators.md +3 -3
- package/skills/uipath-agents/references/lowcode/evaluations/running-evaluations.md +8 -8
- package/skills/uipath-agents/references/lowcode/lowcode.md +18 -12
- package/skills/uipath-agents/references/lowcode/model-selection-guide.md +3 -3
- package/skills/uipath-agents/references/lowcode/project-lifecycle.md +53 -33
- package/skills/uipath-agents/references/lowcode/solution-resources.md +8 -8
- package/skills/uipath-api-workflow/SKILL.md +32 -83
- package/skills/uipath-api-workflow/references/cli-reference.md +40 -26
- package/skills/uipath-api-workflow/references/connector-activity-discovery.md +75 -23
- package/skills/uipath-api-workflow/references/troubleshooting.md +4 -12
- package/skills/uipath-automation-discovery/SKILL.md +234 -0
- package/skills/uipath-automation-discovery/references/intake-guide.md +85 -0
- package/skills/uipath-automation-discovery/references/mining-guide.md +156 -0
- package/skills/uipath-automation-discovery/references/report-template.md +95 -0
- package/skills/uipath-coded-apps/SKILL.md +0 -2
- package/skills/uipath-data-fabric/SKILL.md +0 -2
- package/skills/uipath-feedback/SKILL.md +1 -1
- package/skills/uipath-governance/SKILL.md +0 -2
- package/skills/uipath-human-in-the-loop/SKILL.md +2 -3
- package/skills/uipath-maestro-bpmn/.maintenance/check-all.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-anchors.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-depth.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-link-text.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-links.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-orphans.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-plugin-pairs.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-template.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-uip-commands.sh +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-validation-fixtures.py +0 -0
- package/skills/uipath-maestro-bpmn/.maintenance/check-validation-fixtures.sh +0 -0
- package/skills/uipath-maestro-bpmn/references/author/references/task-recipes/api-workflow.md +1 -1
- package/skills/uipath-maestro-bpmn/references/operate/references/run.md +1 -1
- package/skills/uipath-maestro-bpmn/references/shared/local-metadata-regeneration-guide.md +2 -2
- package/skills/uipath-maestro-bpmn/references/shared/wrapper-shells.md +1 -1
- package/skills/uipath-maestro-case/SKILL.md +22 -27
- package/skills/uipath-maestro-case/references/bindings-and-expressions.md +7 -1
- package/skills/uipath-maestro-case/references/bindings-v2-sync.md +7 -16
- package/skills/uipath-maestro-case/references/case-commands.md +9 -9
- package/skills/uipath-maestro-case/references/case-editing-operations.md +51 -67
- package/skills/uipath-maestro-case/references/case-schema.md +74 -138
- package/skills/uipath-maestro-case/references/connector-integration.md +32 -5
- package/skills/uipath-maestro-case/references/connector-trigger-common.md +39 -12
- package/skills/uipath-maestro-case/references/evals/evals.json +9 -23
- package/skills/uipath-maestro-case/references/implementation.md +24 -24
- package/skills/uipath-maestro-case/references/phased-execution.md +24 -38
- package/skills/uipath-maestro-case/references/placeholder-tasks.md +9 -9
- package/skills/uipath-maestro-case/references/planning.md +20 -79
- package/skills/uipath-maestro-case/references/plugins/case/impl-json.md +15 -122
- package/skills/uipath-maestro-case/references/plugins/case/planning.md +3 -1
- package/skills/uipath-maestro-case/references/plugins/conditions/case-exit-conditions/impl-json.md +10 -22
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-entry-conditions/impl-json.md +7 -5
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-entry-conditions/planning.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-exit-conditions/impl-json.md +5 -5
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-exit-conditions/planning.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/conditions/task-entry-conditions/impl-json.md +4 -4
- package/skills/uipath-maestro-case/references/plugins/logging/impl-json.md +10 -0
- package/skills/uipath-maestro-case/references/plugins/sla/impl-json.md +10 -42
- package/skills/uipath-maestro-case/references/plugins/sla/planning.md +5 -5
- package/skills/uipath-maestro-case/references/plugins/stages/impl-json.md +8 -79
- package/skills/uipath-maestro-case/references/plugins/stages/planning.md +7 -14
- package/skills/uipath-maestro-case/references/plugins/tasks/agent/impl-json.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/agent/planning.md +3 -2
- package/skills/uipath-maestro-case/references/plugins/tasks/api-workflow/impl-json.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/api-workflow/planning.md +3 -2
- package/skills/uipath-maestro-case/references/plugins/tasks/case-management/impl-json.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/case-management/planning.md +4 -3
- 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 +12 -7
- 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 +2 -0
- package/skills/uipath-maestro-case/references/plugins/tasks/process/impl-json.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/process/planning.md +4 -3
- package/skills/uipath-maestro-case/references/plugins/tasks/rpa/impl-json.md +1 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/rpa/planning.md +4 -3
- package/skills/uipath-maestro-case/references/plugins/tasks/wait-for-timer/impl-json.md +3 -0
- package/skills/uipath-maestro-case/references/plugins/triggers/event/impl-json.md +6 -7
- package/skills/uipath-maestro-case/references/plugins/triggers/event/planning.md +4 -2
- package/skills/uipath-maestro-case/references/plugins/triggers/manual/impl-json.md +4 -27
- package/skills/uipath-maestro-case/references/plugins/triggers/timer/impl-json.md +8 -20
- package/skills/uipath-maestro-case/references/plugins/variables/bindings/impl-json.md +6 -11
- package/skills/uipath-maestro-case/references/plugins/variables/global-vars/impl-json.md +15 -30
- package/skills/uipath-maestro-case/references/plugins/variables/global-vars/planning.md +4 -4
- package/skills/uipath-maestro-case/references/plugins/variables/io-binding/impl-json.md +8 -7
- package/skills/uipath-maestro-case/references/registry-discovery.md +4 -4
- package/skills/uipath-maestro-case/references/sdd-generation-rules.md +12 -10
- package/skills/uipath-maestro-case/references/troubleshooting-guide.md +1 -1
- package/skills/uipath-maestro-flow/.maintenance/check-all.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-anchors.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-depth.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-link-text.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-links.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-orphans.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-plugin-pairs.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-template.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-uip-commands.sh +0 -0
- package/skills/uipath-maestro-flow/.maintenance/check-versions.sh +0 -0
- package/skills/uipath-maestro-flow/SKILL.md +9 -6
- package/skills/uipath-maestro-flow/references/author/CAPABILITY.md +4 -4
- package/skills/uipath-maestro-flow/references/author/references/brownfield.md +17 -2
- package/skills/uipath-maestro-flow/references/author/references/editing-operations-cli.md +1 -1
- package/skills/uipath-maestro-flow/references/author/references/editing-operations-json.md +3 -3
- package/skills/uipath-maestro-flow/references/author/references/editing-operations.md +9 -9
- package/skills/uipath-maestro-flow/references/author/references/greenfield.md +13 -10
- package/skills/uipath-maestro-flow/references/author/references/planning-arch.md +75 -5
- package/skills/uipath-maestro-flow/references/author/references/planning-impl.md +2 -1
- package/skills/uipath-maestro-flow/references/author/references/plugins/connector/impl.md +14 -4
- package/skills/uipath-maestro-flow/references/author/references/plugins/connector-trigger/impl.md +20 -4
- package/skills/uipath-maestro-flow/references/author/references/plugins/hitl/impl.md +5 -5
- package/skills/uipath-maestro-flow/references/author/references/plugins/hitl/planning.md +5 -5
- package/skills/uipath-maestro-flow/references/author/references/plugins/http/impl-connector.md +81 -0
- package/skills/uipath-maestro-flow/references/author/references/plugins/http/impl-manual.md +63 -0
- package/skills/uipath-maestro-flow/references/author/references/plugins/http/impl.md +59 -57
- package/skills/uipath-maestro-flow/references/author/references/plugins/http/planning.md +8 -7
- package/skills/uipath-maestro-flow/references/author/references/plugins/inline-agent/impl.md +23 -23
- package/skills/uipath-maestro-flow/references/author/references/plugins/inline-agent/planning.md +2 -2
- package/skills/uipath-maestro-flow/references/diagnose/CAPABILITY.md +1 -1
- package/skills/uipath-maestro-flow/references/diagnose/references/failure-modes.md +6 -6
- package/skills/uipath-maestro-flow/references/evaluate/CAPABILITY.md +2 -2
- package/skills/uipath-maestro-flow/references/evaluate/references/upload-safety.md +1 -1
- package/skills/uipath-maestro-flow/references/operate/CAPABILITY.md +8 -8
- package/skills/uipath-maestro-flow/references/operate/references/run.md +2 -2
- package/skills/uipath-maestro-flow/references/operate/references/ship.md +7 -7
- package/skills/uipath-maestro-flow/references/shared/cli-commands.md +19 -17
- package/skills/uipath-maestro-flow/references/shared/cli-conventions.md +1 -1
- package/skills/uipath-maestro-flow/references/shared/file-format.md +1 -1
- package/skills/uipath-maestro-flow/references/shared/ux-narration-and-todos.md +7 -7
- package/skills/uipath-planner/SKILL.md +110 -74
- package/skills/{uipath-solution → uipath-planner}/assets/templates/agent-sdd-template.md +3 -3
- package/skills/{uipath-solution → uipath-planner}/assets/templates/api-workflow-sdd-template.md +4 -4
- package/skills/{uipath-solution → uipath-planner}/assets/templates/case-sdd-template.md +4 -4
- package/skills/{uipath-solution → uipath-planner}/assets/templates/coded-app-sdd-template.md +3 -3
- package/skills/{uipath-solution → uipath-planner}/assets/templates/flow-sdd-template.md +4 -4
- package/skills/{uipath-solution → uipath-planner}/assets/templates/rpa-sdd-template.md +11 -11
- package/skills/uipath-planner/references/multi-skill-patterns-guide.md +3 -3
- package/skills/uipath-planner/references/non-pdd-lane-guide.md +10 -6
- package/skills/uipath-planner/references/pdd-driven-lane-guide.md +17 -7
- package/skills/uipath-planner/references/plan-and-tasks-format.md +2 -2
- package/skills/{uipath-solution/references/design → uipath-planner/references}/product-selection-guide.md +8 -8
- package/skills/{uipath-solution/references/design → uipath-planner/references}/rpa-product-guide.md +1 -1
- package/skills/{uipath-solution/references/design → uipath-planner/references}/sdd-generation-guide.md +26 -39
- package/skills/{uipath-solution/references/design → uipath-planner/references}/tenant-library-search-guide.md +7 -7
- package/skills/uipath-platform/SKILL.md +21 -48
- package/skills/uipath-platform/references/integration-service/http-request.md +5 -2
- package/skills/uipath-platform/references/integration-service/reference-resolution.md +19 -1
- package/skills/uipath-platform/references/integration-service/triggers.md +21 -5
- package/skills/uipath-platform/references/licensing/consumables-report.md +1 -1
- package/skills/uipath-platform/references/licensing/tenant-allocations.md +1 -1
- package/skills/uipath-platform/references/licensing/user-licenses-allocations.md +1 -1
- package/skills/uipath-platform/references/{resources → orchestrator}/manage-assets.md +37 -34
- package/skills/uipath-platform/references/orchestrator/manage-sessions.md +1 -1
- package/skills/uipath-platform/references/orchestrator/orchestrator.md +4 -31
- package/skills/uipath-platform/references/{resources → orchestrator}/process-queues.md +61 -50
- package/skills/uipath-platform/references/{resources → orchestrator}/resources.md +21 -21
- package/skills/uipath-platform/references/orchestrator/run-jobs.md +26 -14
- package/skills/uipath-platform/references/orchestrator/setup-environment.md +20 -16
- package/skills/uipath-platform/references/orchestrator/tenant-admin.md +7 -7
- package/skills/uipath-platform/references/{resources → orchestrator}/triggers-and-webhooks.md +41 -37
- package/skills/uipath-platform/references/{resources → orchestrator}/work-with-storage.md +56 -34
- package/skills/uipath-platform/references/uip-commands.md +20 -19
- package/skills/uipath-review/SKILL.md +81 -7
- package/skills/uipath-review/references/agents/agent-common-issues.md +42 -0
- package/skills/uipath-review/references/agents/agent-review-checklist.md +79 -57
- package/skills/uipath-review/references/agents/agents-coded-rules.md +160 -0
- package/skills/uipath-review/references/agents/agents-common-rules.md +32 -0
- package/skills/uipath-review/references/agents/agents-lowcode-rules.md +128 -0
- package/skills/uipath-review/references/platform/platform-resources-checklist.md +2 -2
- package/skills/uipath-review/references/review-workflow-guide.md +1 -1
- package/skills/uipath-review/references/rpa/rpa-review-checklist.md +2 -2
- package/skills/uipath-review/references/rule-catalog-workflow.md +90 -0
- package/skills/uipath-review/references/rule-format.md +91 -0
- package/skills/uipath-rpa/SKILL.md +16 -6
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/CreateEntityRecord.md +149 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/CreateMultipleEntityRecords.md +67 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/DeleteEntityRecord.md +44 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/DeleteFileFromRecordField.md +56 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/DeleteMultipleEntityRecords.md +65 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/DownloadFileFromRecordField.md +115 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/GetEntityRecordById.md +50 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/QueryEntityRecords.md +69 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/UpdateEntityRecord.md +120 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/UpdateMultipleEntityRecords.md +67 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/UploadFileToRecordField.md +103 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/guides/data-service-filter-builder-guide.md +461 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/overview.md +355 -0
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/AppendRangeX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/AutoFillX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/AutoFitX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ChangeDataRangeModification.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ChangePivotTableDataSourceX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ClearRangeX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/CopyPasteRangeX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/CreatePivotTableXv2.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/CreateTableX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/DeleteColumnX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/DeleteRowsX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/DeleteSheetX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/DuplicateSheetX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ExecuteMacroArgumentX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ExecuteMacroX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ExportExcelToCsvX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/FillRangeX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/FilterPivotTableX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/FilterX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/FindFirstLastDataRowX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/FindReplaceValueX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/FormatRangeX.md +2 -2
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/InsertColumnX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/InsertExcelChartX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/InsertRowsX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/InsertSheetX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/InvokeVBAArgumentX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/InvokeVBAX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/LookupX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/PivotTableFieldX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ProtectSheetX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ReadCellFormulaX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/ReadCellValueX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/RefreshPivotTableX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/RemoveDuplicatesX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/RenameSheetX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/SaveAsPdfX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/SaveExcelFileX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/SortColumnX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/SortX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/UnprotectSheetX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/UpdateChartX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/VLookupX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/WriteCellX.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Excel.Activities/3.5/activities/overview.md +2 -2
- package/skills/uipath-rpa/references/activity-docs/UiPath.GSuite.Activities/3.8/activities/overview.md +2 -2
- package/skills/uipath-rpa/references/activity-docs/UiPath.Mail.Activities/2.8/activities/overview.md +2 -2
- package/skills/uipath-rpa/references/activity-docs/UiPath.MicrosoftOffice365.Activities/3.8/activities/SendMailConnections.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.MicrosoftOffice365.Activities/3.8/activities/overview.md +3 -3
- package/skills/uipath-rpa/references/activity-docs/UiPath.Presentations.Activities/2.5/activities/overview.md +2 -2
- package/skills/uipath-rpa/references/activity-docs/UiPath.System.Activities/25.10/activities/overview.md +1 -1
- package/skills/uipath-rpa/references/activity-docs/UiPath.Word.Activities/2.5/activities/overview.md +2 -2
- package/skills/uipath-rpa/references/cli-reference.md +108 -554
- package/skills/uipath-rpa/references/coded/coding-guidelines.md +1 -1
- package/skills/uipath-rpa/references/coded/operations-guide.md +3 -3
- package/skills/uipath-rpa/references/coded/third-party-packages-guide.md +1 -1
- package/skills/uipath-rpa/references/connector-capabilities.md +3 -2
- package/skills/uipath-rpa/references/debugging.md +43 -36
- package/skills/uipath-rpa/references/environment-setup.md +3 -3
- package/skills/uipath-rpa/references/is-connector-xaml-guide.md +3 -3
- package/skills/uipath-rpa/references/library-authoring-guide.md +226 -0
- package/skills/uipath-rpa/references/project-structure-guide.md +43 -0
- package/skills/uipath-rpa/references/publishing-guide.md +5 -5
- package/skills/uipath-rpa/references/tenant-library-search-guide.md +18 -14
- package/skills/uipath-rpa/references/testing-guide.md +6 -6
- package/skills/uipath-rpa/references/trigger-pattern-guide.md +2 -2
- package/skills/uipath-rpa/references/ui-automation-guide.md +43 -6
- package/skills/uipath-rpa/references/uia-configure-target-workflows.md +2 -2
- package/skills/uipath-rpa/references/uia-prerequisites.md +1 -1
- package/skills/uipath-rpa/references/validation-guide.md +4 -4
- package/skills/uipath-rpa/references/xaml/canvas-layout-guide.md +4 -1
- package/skills/uipath-rpa/references/xaml/common-pitfalls.md +18 -6
- package/skills/uipath-rpa/references/xaml/long-running-workflow-guide.md +304 -0
- package/skills/uipath-rpa/references/xaml/xaml-basics-and-rules.md +3 -0
- package/skills/uipath-solution/SKILL.md +23 -125
- package/skills/uipath-solution/references/{operate/activate-and-manage.md → activate-and-manage.md} +1 -1
- package/skills/uipath-solution/references/{operate/develop-solution.md → develop-solution.md} +43 -37
- package/skills/uipath-solution/references/{operate/pack-and-deploy.md → pack-and-deploy.md} +3 -3
- package/skills/uipath-solution/references/{operate/scenarios → scenarios}/intra-solution-references.md +2 -2
- package/skills/uipath-solution/references/{operate/scenarios → scenarios}/manual-edits.md +4 -4
- package/skills/uipath-solution/references/{operate/scenarios → scenarios}/same-name-across-folders.md +2 -2
- package/skills/uipath-solution/references/{operate/scenarios → scenarios}/shared-cloud-resource.md +3 -3
- package/skills/uipath-solution/references/{operate/scenarios → scenarios}/virtual-resource.md +4 -4
- package/skills/uipath-solution/references/{operate/scenarios.md → scenarios.md} +5 -5
- package/skills/uipath-solution/references/{operate/solution-overview.md → solution-overview.md} +3 -3
- package/skills/uipath-tasks/SKILL.md +0 -2
- package/skills/uipath-test/SKILL.md +26 -7
- package/skills/uipath-troubleshoot/agents/triage.md +6 -4
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/overview.md +55 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/add-queue-item-failed.md +58 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/application-launch-failed.md +56 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/browser-open-or-attach-failed.md +59 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/file-operation-failed.md +60 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/foreach-row-failed.md +56 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/image-target-not-found.md +56 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/invoke-code-failed.md +54 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/invoke-workflow-failed.md +58 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/kill-process-failed.md +49 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/ui-activity-configuration-error.md +80 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/ui-activity-timeout.md +61 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/ui-element-interaction-failed.md +61 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/playbooks/ui-element-not-found.md +64 -0
- package/skills/uipath-troubleshoot/references/activity-packages/classic-activities/summary.md +24 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/read-range-file-locked.md +142 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/read-range-file-not-found.md +140 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/read-range-null-reference.md +119 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/read-range-sheet-not-found.md +146 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/playbooks/write-cell-failures.md +131 -0
- package/skills/uipath-troubleshoot/references/activity-packages/excel-activities/summary.md +5 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/investigation_guide.md +1 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/overview.md +16 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/activity-configuration-error.md +42 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/ambiguous-selector.md +131 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/application-not-found.md +84 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/application-open-failed.md +46 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/browser-navigation-failed.md +45 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/click-coordinate-off-screen.md +120 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/disabled-element.md +0 -2
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/element-found-not-actionable.md +43 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/healing-agent-no-license.md +12 -12
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/healing-agent-orch-issues.md +108 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/inject-js-failed.md +41 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/scope-container-wrong-page.md +7 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/select-item-no-items.md +37 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/selector-failure-manual.md +2 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/timeout-issue.md +2 -2
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/verify-execution-failure.md +120 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/wrong-target-application.md +41 -0
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/summary.md +12 -0
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/guardrail-violation.md +111 -0
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/is-connection-disabled.md +90 -0
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/is-invalid-credentials.md +123 -0
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/is-invalid-element-instance.md +96 -0
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/llm-insufficient-information.md +1 -1
- package/skills/uipath-troubleshoot/references/products/agents/summary.md +4 -0
- package/skills/uipath-troubleshoot/references/products/orchestrator/investigation_guide.md +7 -7
- package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-pending-no-host.md +3 -1
- package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-pending-stale-dispatch.md +2 -0
- package/skills/uipath-troubleshoot/references/products/orchestrator/playbooks/job-stopped-exit-code-0x40010004.md +104 -0
- package/skills/uipath-troubleshoot/references/products/orchestrator/summary.md +1 -0
- package/skills/uipath-troubleshoot/references/summary.md +10 -1
- package/version-manifest.json +2 -2
- package/skills/uipath-ixp/SKILL.md +0 -84
- package/skills/uipath-ixp/references/cli-reference.md +0 -113
- package/skills/uipath-ixp/references/improve-prompts-guide.md +0 -283
- package/skills/uipath-ixp/references/label-documents-guide.md +0 -175
- package/skills/uipath-ixp/references/project-setup-guide.md +0 -90
- package/skills/uipath-maestro-case/references/plugins/edges/impl-json.md +0 -152
- package/skills/uipath-maestro-case/references/plugins/edges/planning.md +0 -93
- /package/skills/{uipath-solution/references/design → uipath-planner/references}/package-selection-guide.md +0 -0
- /package/skills/{uipath-solution/references/design → uipath-planner/references}/pdd-analysis-guide.md +0 -0
- /package/skills/uipath-solution/references/{operate/scenarios → scenarios}/failure-modes.md +0 -0
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Create work queues, add items for distributed processing, track progress, and manage review cycles.
|
|
4
4
|
|
|
5
|
-
> For full option details on any command, use `--help` (e.g., `uip
|
|
5
|
+
> For full option details on any command, use `--help` (e.g., `uip or queues create --help`).
|
|
6
6
|
|
|
7
7
|
## When to Use
|
|
8
8
|
|
|
@@ -11,7 +11,7 @@ Create work queues, add items for distributed processing, track progress, and ma
|
|
|
11
11
|
|
|
12
12
|
## Prerequisites
|
|
13
13
|
|
|
14
|
-
- Authenticated
|
|
14
|
+
- Authenticated — verify with `uip login status`; if not logged in, ask the user to run `uip login` (it opens an interactive browser flow)
|
|
15
15
|
- Target folder exists (`uip or folders list`)
|
|
16
16
|
|
|
17
17
|
## Flow
|
|
@@ -21,7 +21,7 @@ graph LR
|
|
|
21
21
|
A[queues create] --> B[queue-items add]
|
|
22
22
|
B --> C[queue-items list]
|
|
23
23
|
C --> D[queue-items get]
|
|
24
|
-
D --> E[
|
|
24
|
+
D --> E[queue-items update]
|
|
25
25
|
E --> F{Outcome}
|
|
26
26
|
F -->|Failed| G[get-history]
|
|
27
27
|
G --> H[set-reviewer]
|
|
@@ -36,7 +36,7 @@ graph LR
|
|
|
36
36
|
### Create a Queue
|
|
37
37
|
|
|
38
38
|
```bash
|
|
39
|
-
uip
|
|
39
|
+
uip or queues create "InvoiceQueue" \
|
|
40
40
|
--folder-path "Finance" --max-retries 3 --auto-retry \
|
|
41
41
|
--enforce-unique-reference --output json
|
|
42
42
|
```
|
|
@@ -57,7 +57,7 @@ Key options:
|
|
|
57
57
|
### List Queues
|
|
58
58
|
|
|
59
59
|
```bash
|
|
60
|
-
uip
|
|
60
|
+
uip or queues list --folder-path "Finance" --output json
|
|
61
61
|
```
|
|
62
62
|
|
|
63
63
|
Filter by name with `--name` (contains match). Paginate with `--limit` / `--offset`.
|
|
@@ -66,36 +66,38 @@ Filter by name with `--name` (contains match). Paginate with `--limit` / `--offs
|
|
|
66
66
|
|
|
67
67
|
```bash
|
|
68
68
|
# Get queue details (cross-folder, no --folder-path needed)
|
|
69
|
-
uip
|
|
69
|
+
uip or queues get <queue-key> --output json
|
|
70
70
|
|
|
71
71
|
# Update queue properties (cross-folder)
|
|
72
|
-
uip
|
|
72
|
+
uip or queues update <queue-key> --max-retries 5 --no-auto-retry --output json
|
|
73
73
|
|
|
74
|
-
# Delete queue (cross-folder)
|
|
75
|
-
|
|
74
|
+
# Delete queue (cross-folder). Refuses if the queue still has items;
|
|
75
|
+
# pass --force to delete it and its items anyway.
|
|
76
|
+
uip or queues delete <queue-key> --yes --output json
|
|
77
|
+
uip or queues delete <queue-key> --force --output json
|
|
76
78
|
```
|
|
77
79
|
|
|
78
80
|
### Share a Queue Across Folders
|
|
79
81
|
|
|
80
82
|
```bash
|
|
81
83
|
# Share with another folder
|
|
82
|
-
uip
|
|
84
|
+
uip or queues share <queue-key> --folder-path "Production" --output json
|
|
83
85
|
|
|
84
86
|
# Check which folders have access
|
|
85
|
-
uip
|
|
87
|
+
uip or queues get-folders <queue-key> --output json
|
|
86
88
|
|
|
87
89
|
# Remove from a folder
|
|
88
|
-
uip
|
|
90
|
+
uip or queues unshare <queue-key> --folder-path "Production" --output json
|
|
89
91
|
```
|
|
90
92
|
|
|
91
93
|
### Queue Processing Stats
|
|
92
94
|
|
|
93
95
|
```bash
|
|
94
96
|
# Stats for a specific queue (item counts, exception counts, processing times)
|
|
95
|
-
uip
|
|
97
|
+
uip or queues get-stats --folder-path "Finance" --key <queue-key> --output json
|
|
96
98
|
|
|
97
99
|
# Stats across queues in a folder, narrowed by name and a processing-window
|
|
98
|
-
uip
|
|
100
|
+
uip or queues get-stats --folder-path "Finance" \
|
|
99
101
|
--name "Invoice" \
|
|
100
102
|
--from "2026-04-01T00:00:00Z" --to "2026-04-30T23:59:59Z" \
|
|
101
103
|
--output json
|
|
@@ -110,7 +112,7 @@ uip resource queues get-stats --folder-path "Finance" \
|
|
|
110
112
|
### Add a Single Item
|
|
111
113
|
|
|
112
114
|
```bash
|
|
113
|
-
uip
|
|
115
|
+
uip or queue-items add "InvoiceQueue" \
|
|
114
116
|
--folder-path "Finance" \
|
|
115
117
|
--specific-content '{"InvoiceId":"INV-001","Amount":1500.00,"Vendor":"Acme"}' \
|
|
116
118
|
--priority High --reference "INV-001" \
|
|
@@ -123,7 +125,7 @@ The `add` command takes a **queue name** (not key). Key options: `--specific-con
|
|
|
123
125
|
### Bulk Add Items
|
|
124
126
|
|
|
125
127
|
```bash
|
|
126
|
-
uip
|
|
128
|
+
uip or queue-items bulk-add "InvoiceQueue" \
|
|
127
129
|
--folder-path "Finance" \
|
|
128
130
|
--queue-items '[
|
|
129
131
|
{"specificContent":{"InvoiceId":"INV-002","Amount":2000},"priority":"High"},
|
|
@@ -141,44 +143,51 @@ The `bulk-add` command also takes a **queue name**. Use `--commit-type` to contr
|
|
|
141
143
|
| `StopOnFirstFailure` | Commits items until the first failure, then stops |
|
|
142
144
|
| `ProcessAllIndependently` | Processes each item independently (default) |
|
|
143
145
|
|
|
146
|
+
> The bulk-add API returns only a success flag and the list of failed items -- it does **not** return the created item keys. If you need the keys (e.g. to attach data or dispatch jobs), add items one at a time with `add` (which returns the created item), or `list --queue-name` afterward.
|
|
147
|
+
|
|
144
148
|
### List and Get Items
|
|
145
149
|
|
|
146
150
|
```bash
|
|
147
151
|
# List items filtered by queue and status
|
|
148
|
-
uip
|
|
152
|
+
uip or queue-items list --folder-path "Finance" \
|
|
149
153
|
--queue-name "InvoiceQueue" --status Failed --output json
|
|
150
154
|
|
|
155
|
+
# List items across all accessible folders
|
|
156
|
+
uip or queue-items list --all-folders --status Failed --output json
|
|
157
|
+
|
|
151
158
|
# Get a single item by its unique key
|
|
152
|
-
uip
|
|
159
|
+
uip or queue-items get <item-unique-key> --folder-path "Finance" --output json
|
|
153
160
|
```
|
|
154
161
|
|
|
155
162
|
Filter with `--queue-name` (exact match), `--queue-definition-key` (GUID), or `--status` (New, InProgress, Failed, Successful, Abandoned, Retried, Deleted).
|
|
156
163
|
|
|
157
|
-
### Update
|
|
164
|
+
### Update and Delete
|
|
158
165
|
|
|
159
166
|
```bash
|
|
160
167
|
# Update item properties (only provided fields change)
|
|
161
|
-
uip
|
|
162
|
-
--
|
|
168
|
+
uip or queue-items update <item-unique-key> --folder-path "Finance" \
|
|
169
|
+
--priority High --output json
|
|
163
170
|
|
|
164
|
-
#
|
|
165
|
-
uip
|
|
166
|
-
--folder-path "Finance" --output json
|
|
171
|
+
# Delete a single item by key
|
|
172
|
+
uip or queue-items delete <item-unique-key> --folder-path "Finance" --yes --output json
|
|
167
173
|
|
|
168
|
-
# Delete
|
|
169
|
-
uip
|
|
170
|
-
uip resource queue-items delete-bulk <key1> <key2> --folder-path "Finance" --output json
|
|
174
|
+
# Delete several items in one call
|
|
175
|
+
uip or queue-items delete-bulk <key1> <key2> --folder-path "Finance" --yes --output json
|
|
171
176
|
```
|
|
172
177
|
|
|
178
|
+
`update` changes `--priority`, `--due-date`, `--defer-date`, and `--specific-content`. Progress is a work-in-progress message a running robot reports, so the CLI does not let you set it.
|
|
179
|
+
|
|
180
|
+
`delete` (one key) and `delete-bulk` (a list of keys) are a **soft-delete**: the item's status changes to `Deleted`; it is not permanently removed.
|
|
181
|
+
|
|
173
182
|
### Get History and Retry Info
|
|
174
183
|
|
|
175
184
|
```bash
|
|
176
|
-
uip
|
|
177
|
-
uip
|
|
178
|
-
uip
|
|
185
|
+
uip or queue-items get-history <item-unique-key> --folder-path "Finance" --output json
|
|
186
|
+
uip or queue-items get-last-retry <item-key> --folder-path "Finance" --output json
|
|
187
|
+
uip or queue-items has-video <item-unique-key> --folder-path "Finance" --output json
|
|
179
188
|
```
|
|
180
189
|
|
|
181
|
-
Note: `get-last-retry` uses the item `
|
|
190
|
+
Note: `get-last-retry` uses the item `Key` field (shared across retries), not `UniqueKey`. Curated list/get output includes both.
|
|
182
191
|
|
|
183
192
|
---
|
|
184
193
|
|
|
@@ -190,28 +199,28 @@ When queue items fail, a reviewer can inspect them and decide whether to retry,
|
|
|
190
199
|
|
|
191
200
|
```bash
|
|
192
201
|
# List available reviewers in the folder
|
|
193
|
-
uip
|
|
202
|
+
uip or queue-items get-reviewers --folder-path "Finance" --output json
|
|
194
203
|
|
|
195
204
|
# Assign a reviewer to one or more items
|
|
196
|
-
uip
|
|
205
|
+
uip or queue-items set-reviewer <key1> <key2> \
|
|
197
206
|
--folder-path "Finance" \
|
|
198
|
-
--user-
|
|
207
|
+
--user-key <reviewer-key> \
|
|
199
208
|
--output json
|
|
200
209
|
```
|
|
201
210
|
|
|
202
211
|
### Set Review Status
|
|
203
212
|
|
|
204
213
|
```bash
|
|
205
|
-
uip
|
|
214
|
+
uip or queue-items set-review-status Retried <key1> <key2> \
|
|
206
215
|
--folder-path "Finance" --output json
|
|
207
216
|
```
|
|
208
217
|
|
|
209
|
-
Valid review statuses: `
|
|
218
|
+
Valid review statuses: `None`, `InReview`, `Verified`, `Retried`. The status is the first positional argument, followed by one or more item keys.
|
|
210
219
|
|
|
211
220
|
### Remove Reviewer
|
|
212
221
|
|
|
213
222
|
```bash
|
|
214
|
-
uip
|
|
223
|
+
uip or queue-items unset-reviewer <key1> <key2> \
|
|
215
224
|
--folder-path "Finance" --output json
|
|
216
225
|
```
|
|
217
226
|
|
|
@@ -221,27 +230,27 @@ uip resource queue-items unset-reviewer <key1> <key2> \
|
|
|
221
230
|
|
|
222
231
|
```bash
|
|
223
232
|
# 1. Create the queue
|
|
224
|
-
uip
|
|
233
|
+
uip or queues create "InvoiceQueue" \
|
|
225
234
|
--folder-path "Finance" --max-retries 3 --auto-retry \
|
|
226
235
|
--enforce-unique-reference --output json
|
|
227
236
|
|
|
228
237
|
# 2. Add work items (dispatcher)
|
|
229
|
-
uip
|
|
238
|
+
uip or queue-items add "InvoiceQueue" --folder-path "Finance" \
|
|
230
239
|
--specific-content '{"InvoiceId":"INV-001","Amount":1500}' \
|
|
231
240
|
--reference "INV-001" --priority High --output json
|
|
232
241
|
|
|
233
242
|
# 3. Check for failed items (after performer runs)
|
|
234
|
-
uip
|
|
243
|
+
uip or queue-items list --folder-path "Finance" \
|
|
235
244
|
--queue-name "InvoiceQueue" --status Failed --output json
|
|
236
245
|
|
|
237
246
|
# 4. Investigate a failed item
|
|
238
|
-
uip
|
|
247
|
+
uip or queue-items get-history <failed-item-key> \
|
|
239
248
|
--folder-path "Finance" --output json
|
|
240
249
|
|
|
241
250
|
# 5. Assign reviewer and mark as reviewed
|
|
242
|
-
uip
|
|
243
|
-
--folder-path "Finance" --user-
|
|
244
|
-
uip
|
|
251
|
+
uip or queue-items set-reviewer <failed-item-key> \
|
|
252
|
+
--folder-path "Finance" --user-key <reviewer-key> --output json
|
|
253
|
+
uip or queue-items set-review-status Retried <failed-item-key> \
|
|
245
254
|
--folder-path "Finance" --output json
|
|
246
255
|
```
|
|
247
256
|
|
|
@@ -280,16 +289,18 @@ None --> InReview (reviewer assigned) --> Verified | Retried
|
|
|
280
289
|
|
|
281
290
|
| Field | Scope | Use with |
|
|
282
291
|
|-------|-------|----------|
|
|
283
|
-
| `
|
|
284
|
-
| `
|
|
292
|
+
| `UniqueKey` | Unique per attempt | `get`, `update`, `delete`, `get-history`, `has-video` |
|
|
293
|
+
| `Key` | Shared across retries | `get-last-retry` |
|
|
285
294
|
| Queue definition key | Queue identifier | `list --queue-definition-key`, `queues get` |
|
|
286
295
|
|
|
296
|
+
Curated queue-item rows expose both `Key` and `UniqueKey` (PascalCase). With `--all-fields` you get the raw DTO instead, where the same fields are `key` / `uniqueKey`.
|
|
297
|
+
|
|
287
298
|
### Common Pitfalls
|
|
288
299
|
|
|
289
300
|
- `--specific-content` must be **flat key-value JSON** -- no nested objects or arrays.
|
|
290
|
-
- All `queue-items` commands require `--folder-path` or `--folder-key` (items are folder-scoped).
|
|
301
|
+
- All `queue-items` commands require `--folder-path` or `--folder-key` (items are folder-scoped). Exception: `list` can take `--all-folders` instead to query across all accessible folders.
|
|
291
302
|
- `set-review-status` takes the **status first**, then the item key(s) -- not the other way around.
|
|
292
|
-
- `set-reviewer` requires `--user-
|
|
303
|
+
- `set-reviewer` requires `--user-key` (GUID, not a numeric ID). Use `get-reviewers` to find reviewer keys.
|
|
293
304
|
- Queue `get`, `update`, and `delete` are **cross-folder** (no `--folder-path` needed). Queue item commands are **not**.
|
|
294
305
|
- `--auto-retry` is enabled by default. Use `--no-auto-retry` to disable.
|
|
295
306
|
|
|
@@ -297,6 +308,6 @@ None --> InReview (reviewer assigned) --> Verified | Retried
|
|
|
297
308
|
|
|
298
309
|
## Related
|
|
299
310
|
|
|
300
|
-
- [resources.md](resources.md) --
|
|
311
|
+
- [resources.md](resources.md) -- Orchestrator resources overview and libraries
|
|
301
312
|
- [Triggers & Webhooks](triggers-and-webhooks.md) -- Queue triggers fire automations when item count exceeds a threshold
|
|
302
|
-
- [Setup Environment](
|
|
313
|
+
- [Setup Environment](setup-environment.md) -- Folder and machine setup
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# Resources (`uip
|
|
1
|
+
# Resources (`uip or`)
|
|
2
2
|
|
|
3
3
|
Manage Orchestrator resources -- assets, queues, queue items, buckets, files, triggers, libraries, and webhooks.
|
|
4
4
|
|
|
5
|
-
> **Important:** These commands
|
|
5
|
+
> **Important:** These commands live under `uip or` (the former standalone resource tool was retired and folded into `uip or`). The old `storage-buckets`/`storage-bucket-files` names are now `buckets`/`bucket-files`.
|
|
6
6
|
|
|
7
|
-
> For full option details on any command, use `--help` (e.g., `uip
|
|
7
|
+
> For full option details on any command, use `--help` (e.g., `uip or assets list --help`).
|
|
8
8
|
|
|
9
9
|
---
|
|
10
10
|
|
|
@@ -25,7 +25,7 @@ Manage Orchestrator resources -- assets, queues, queue items, buckets, files, tr
|
|
|
25
25
|
## Command Tree
|
|
26
26
|
|
|
27
27
|
```
|
|
28
|
-
uip
|
|
28
|
+
uip or
|
|
29
29
|
├── assets (9 verbs)
|
|
30
30
|
├── queues (8 verbs)
|
|
31
31
|
├── queue-items (15 verbs)
|
|
@@ -57,44 +57,44 @@ Libraries are tenant-scoped -- no folder context needed.
|
|
|
57
57
|
|
|
58
58
|
| Command | Description |
|
|
59
59
|
|---------|-------------|
|
|
60
|
-
| `uip
|
|
61
|
-
| `uip
|
|
62
|
-
| `uip
|
|
63
|
-
| `uip
|
|
64
|
-
| `uip
|
|
65
|
-
| `uip
|
|
60
|
+
| `uip or libraries list` | List libraries in the tenant feed. Options: `--limit <N>` (default 50), `--offset <N>`, `--sort-by "<field> <asc\|desc>"`, `--all-fields`. No native search — filter client-side via global `--output-filter "<JMESPath>"`. Returns curated rows: `Key`, `Title`, `Version`, `Authors`, `Published`, `IsLatestVersion`, `IsPrerelease`, `ProjectType`. Note: `Published` is often empty on list rows (the bare collection endpoint doesn't populate it server-side); `get`/`versions` return it. |
|
|
61
|
+
| `uip or libraries get <key>` | Get library details. Key format is `PackageId:Version` (e.g., `MyLib:1.0.0`). Returns a curated detail view (adds `Description`, `PackageSize`, `Created`, `LastUpdated`, etc.); `--all-fields` for the raw DTO. Dates the feed doesn't track are returned as empty strings (the API serializes 0001-01-01 sentinels; the CLI strips them). |
|
|
62
|
+
| `uip or libraries versions <package-id>` | List all versions of a library by package ID (the `Title` from `list` output). Curated rows like `list`; `--all-fields` for raw. Fails with `Library not found` when the package ID doesn't exist (instead of an empty success). |
|
|
63
|
+
| `uip or libraries upload --file <path>` | Upload a `.nupkg` library package to the tenant feed. The file must exist (checked client-side). The default shared feed is read-only on many tenants — if upload fails with a read-only/feed-not-found error, enable Tenant Libraries in tenant settings or target a writable feed with `--feed-id` (`uip or feeds list`). |
|
|
64
|
+
| `uip or libraries download <key> --destination <path>` | Download a `.nupkg` to local disk. `--destination` creates missing parent dirs and overwrites an existing file. |
|
|
65
|
+
| `uip or libraries delete <key>` | Delete a specific library version. Key format is `PackageId:Version` (validated client-side). |
|
|
66
66
|
|
|
67
67
|
```bash
|
|
68
68
|
# List libraries (first 500). Default --limit is 50; bump it for tenants with many libraries.
|
|
69
|
-
uip
|
|
69
|
+
uip or libraries list --limit 500 --output json
|
|
70
70
|
|
|
71
71
|
# Filter by name client-side. Title can be null — guard with `Title != null` or contains() will error.
|
|
72
|
-
uip
|
|
72
|
+
uip or libraries list --limit 500 \
|
|
73
73
|
--output-filter "[?Title != null && contains(Title, 'Excel')]" \
|
|
74
74
|
--output json
|
|
75
75
|
|
|
76
76
|
# Multi-keyword OR filter
|
|
77
|
-
uip
|
|
77
|
+
uip or libraries list --limit 500 \
|
|
78
78
|
--output-filter "[?Title != null && (contains(Title, 'Common') || contains(Title, 'Shared'))]" \
|
|
79
79
|
--output json
|
|
80
80
|
|
|
81
81
|
# Upload a library
|
|
82
|
-
uip
|
|
82
|
+
uip or libraries upload --file ./MyLibrary.1.0.0.nupkg --output json
|
|
83
83
|
|
|
84
84
|
# List versions, then download a specific one
|
|
85
|
-
uip
|
|
86
|
-
uip
|
|
85
|
+
uip or libraries versions "UiPath.System.Activities" --output json
|
|
86
|
+
uip or libraries download "UiPath.System.Activities:24.10.0" \
|
|
87
87
|
--destination ./system-activities.nupkg --output json
|
|
88
88
|
|
|
89
89
|
# Delete an old version
|
|
90
|
-
uip
|
|
90
|
+
uip or libraries delete "UiPath.System.Activities:24.4.0" --yes --output json
|
|
91
91
|
```
|
|
92
92
|
|
|
93
93
|
---
|
|
94
94
|
|
|
95
95
|
## Output Behavior
|
|
96
96
|
|
|
97
|
-
|
|
97
|
+
These commands return a **curated PascalCase view** by default — a focused projection of the most useful fields. Pass `--all-fields` on list/get-style commands to receive the raw API DTO instead (raw DTO keys are camelCase; the two shapes do not share casing). This matches the convention across all `uip or` commands; see [orchestrator.md](orchestrator.md).
|
|
98
98
|
|
|
99
99
|
List responses include a `Pagination` block:
|
|
100
100
|
|
|
@@ -111,6 +111,6 @@ When `HasMore` is `true`, increment `--offset` by `--limit` and fetch again. Con
|
|
|
111
111
|
|
|
112
112
|
## Related
|
|
113
113
|
|
|
114
|
-
- **Orchestrator** (`uip or`) — folders, jobs, processes, packages, users, machines → [
|
|
115
|
-
- **Solutions** (`uip solution`) — pack, publish, deploy solution packages → [`uipath-solution`](
|
|
116
|
-
- **Folder/user setup** — required before folder-scoped resources can be used → [
|
|
114
|
+
- **Orchestrator** (`uip or`) — folders, jobs, processes, packages, users, machines → [orchestrator.md](orchestrator.md)
|
|
115
|
+
- **Solutions** (`uip solution`) — pack, publish, deploy solution packages → [`uipath-solution`](/uipath:uipath-solution)
|
|
116
|
+
- **Folder/user setup** — required before folder-scoped resources can be used → [setup-environment.md](setup-environment.md)
|
|
@@ -13,7 +13,7 @@ Upload automation packages, bind them as processes, start jobs, and monitor exec
|
|
|
13
13
|
|
|
14
14
|
## Prerequisites
|
|
15
15
|
|
|
16
|
-
- Authenticated
|
|
16
|
+
- Authenticated — verify with `uip login status`; if not logged in, ask the user to run `uip login` (it opens an interactive browser flow)
|
|
17
17
|
- Target folder exists with machines assigned (see [setup-environment.md](setup-environment.md))
|
|
18
18
|
- Automation package (.nupkg) built and ready to upload
|
|
19
19
|
|
|
@@ -44,6 +44,8 @@ uip or packages upload ./MyProcess.1.0.0.nupkg --feed-id <feed-key> --output jso
|
|
|
44
44
|
|
|
45
45
|
Verify the upload and discover entry points before creating a process.
|
|
46
46
|
|
|
47
|
+
> **Feeds:** `packages get`, `packages versions`, and `processes create` look in the **tenant** feed by default. If the package lives in a folder-hierarchy feed (a standard folder with its own feed), pass `--feed-id <feed-key>` — otherwise these return empty / 404 even though the package exists. (`processes create` itself no longer pre-checks the feed, so it succeeds in a folder feed regardless.)
|
|
48
|
+
|
|
47
49
|
```bash
|
|
48
50
|
# Search for the uploaded package
|
|
49
51
|
uip or packages list --search "MyProcess" --output json
|
|
@@ -86,7 +88,7 @@ Key options:
|
|
|
86
88
|
|---|---|
|
|
87
89
|
| `--entry-point <path>` | Required for multi-entry-point packages |
|
|
88
90
|
| `--auto-update` / `--no-auto-update` | Auto-pick the latest package version on deploy |
|
|
89
|
-
| `--job-priority <Low\|Normal\|High>` | Default execution priority |
|
|
91
|
+
| `--job-priority <Low\|Normal\|High>` | Default execution priority. The CLI sets the matching `SpecificPriorityValue` band (Low=25, Normal=45, High=65) — the API derives the band from that value, so the change actually applies. |
|
|
90
92
|
| `--specific-priority <1-100>` | Numeric priority override (mutually exclusive with `--job-priority`). Use when you need fine-grained ordering inside the same priority bucket. |
|
|
91
93
|
| `--robot-size <Small\|Standard\|Medium\|Large>` | Cloud robot sizing for serverless runtimes |
|
|
92
94
|
| `--input-arguments <json>` | Default input arguments (merged with per-job inputs) |
|
|
@@ -94,7 +96,7 @@ Key options:
|
|
|
94
96
|
| `--tags <list>` | Comma-separated tags for filtering |
|
|
95
97
|
| `--hidden-for-attended` / `--visible-for-attended` | Toggle visibility to attended robot users |
|
|
96
98
|
| `--auto-create-triggers` / `--no-auto-create-triggers` | Auto-create connected triggers on deploy |
|
|
97
|
-
| `--retention-period <days>` + `--retention-action <Delete\|Archive\|None>` (+ `--retention-bucket <id>`) | Job retention policy |
|
|
99
|
+
| `--retention-period <days>` + `--retention-action <Delete\|Archive\|None>` (+ `--retention-bucket <id>`) | Job retention policy. `--retention-period` must be 1-180 (validated client-side). |
|
|
98
100
|
| `--stale-retention-period <days>` + `--stale-retention-action <Delete\|Archive\|None>` | Stale-job retention policy |
|
|
99
101
|
|
|
100
102
|
> The runtime kind (Unattended / Headless / NonProduction / AgentService / Serverless) is **not** a process-level setting; it's chosen per-job on `jobs start --runtime-type`. The process binds the package to a folder; runtime selection happens at execution time.
|
|
@@ -111,7 +113,7 @@ uip or processes resources <process-key-guid> --output json
|
|
|
111
113
|
|
|
112
114
|
# Edit fields after creation. Same flag set as `processes create` minus name/package-key/package-version,
|
|
113
115
|
# plus --healing-agent / --no-healing-agent (Autopilot for Robots toggle).
|
|
114
|
-
uip or processes
|
|
116
|
+
uip or processes update <process-key-guid> --description "Updated description" --output json
|
|
115
117
|
|
|
116
118
|
# Walk the package version history (every package version this release ever pointed at)
|
|
117
119
|
uip or processes version-history <process-key-guid> --output json
|
|
@@ -123,10 +125,10 @@ uip or processes update-version <process-key-guid> --package-version 1.0.2 --out
|
|
|
123
125
|
uip or processes rollback <process-key-guid> --output json
|
|
124
126
|
|
|
125
127
|
# Delete the process (release). Package itself stays in the feed.
|
|
126
|
-
uip or processes delete <process-key-guid> --output json
|
|
128
|
+
uip or processes delete <process-key-guid> --yes --output json
|
|
127
129
|
```
|
|
128
130
|
|
|
129
|
-
`processes
|
|
131
|
+
`processes update` uses `Mapper.Map<ReleaseDto, UiRelease>(dto)` server-side, which means missing fields on the request body are nulled. The CLI works around this by spreading `currentRelease` as the baseline before applying overrides — but if you build the body yourself by hand, `tags`, `arguments`, `videoRecordingSettings`, `targetFramework`, `robotSize`, `resourceOverwrites`, `remoteControlAccess`, `targetRuntime`, `publisherLicense`, etc. will silently get nulled.
|
|
130
132
|
|
|
131
133
|
## Step 4: Start Job
|
|
132
134
|
|
|
@@ -144,12 +146,13 @@ uip or jobs start <process-key> --folder-path "Production" \
|
|
|
144
146
|
|
|
145
147
|
Key options:
|
|
146
148
|
|
|
147
|
-
- `--input-arguments <json>` / `--input-file <path>` — pick one. `--input-arguments` inlines a JSON object; `--input-file` uploads a file as the job's `InputFile` argument.
|
|
149
|
+
- `--input-arguments <json>` / `--input-file <path>` — pick one. `--input-arguments` inlines a JSON object (validated client-side — invalid JSON is rejected before the call); `--input-file` uploads a file as the job's `InputFile` argument.
|
|
150
|
+
- **10K character cap on job arguments.** Orchestrator caps serialized input/output arguments at 10,240 characters for classic `StartJob` runs; an oversized output is silently dropped (the consuming workflow receives `null`, the job still reports Successful). `StartAgentJob` (agent runs) is not subject to the same cap in practice. Robot 2025.10.1+ removes the cap entirely ("Support for large input and output arguments"). If you hit it: pass big payloads via a storage bucket / queue item reference, or upgrade the Robot.
|
|
148
151
|
- `--attachment <[name=]path>` — upload one or more files and attach them to the job. Repeat the flag for multiple. Pair with `--attachment-id <guid>` to reuse an attachment that was previously uploaded.
|
|
149
152
|
- `--runtime-type <type>` — `Unattended`, `Headless`, `NonProduction`, `AgentService`, or `Serverless`. Picks the runtime kind the scheduler will use.
|
|
150
|
-
- `--strategy <strategy>` — `ModernJobsCount` (default; spawn N independent jobs, paired with `--jobs-count`), `All` (run on every available robot in the folder), `Specific` (use `--user-keys` / `--machine-keys`).
|
|
153
|
+
- `--strategy <strategy>` — one of `ModernJobsCount` (default; spawn N independent jobs, paired with `--jobs-count`), `All` (run on every available robot in the folder), `Specific` (use `--user-keys` / `--machine-keys`), or `JobsCount`. Validated client-side. `--jobs-count` must be a whole number greater than 0.
|
|
151
154
|
- `--user-keys <guids>` / `--machine-keys <guids>` — comma-separated GUIDs to pin the job to specific identities. With `--strategy ModernJobsCount` they restrict the candidate pool; with `Specific` they're required.
|
|
152
|
-
- `--healing-agent` — enable Autopilot for Robots (Healing Agent) just for this job, regardless of the process-level `--healing-agent` setting on `processes
|
|
155
|
+
- `--healing-agent` — enable Autopilot for Robots (Healing Agent) just for this job, regardless of the process-level `--healing-agent` setting on `processes update`. Useful for one-off self-healing without flipping the process default.
|
|
153
156
|
- `--reference <text>` — user-set reference (free-form string) attached to the job. Useful for correlation with external systems.
|
|
154
157
|
- `--environment-variables <json>` — JSON object of per-job environment variables. Merged on top of folder-/process-level env.
|
|
155
158
|
- `--run-as-me` — run under the caller's identity instead of resolving an unattended robot account in the folder.
|
|
@@ -170,8 +173,13 @@ uip or jobs list --state Running --folder-path "Production" --output json
|
|
|
170
173
|
|
|
171
174
|
# Filter by process name and date range
|
|
172
175
|
uip or jobs list --process-name "MyProcess" --folder-path "Production" --output json
|
|
176
|
+
|
|
177
|
+
# List jobs across all accessible folders
|
|
178
|
+
uip or jobs list --all-folders --state Faulted --output json
|
|
173
179
|
```
|
|
174
180
|
|
|
181
|
+
`jobs list` requires `--folder-path`, `--folder-key`, or `--all-folders` — a bare `jobs list` is rejected. (Older CLI versions listed tenant-wide by default; pass `--all-folders` for that behavior.)
|
|
182
|
+
|
|
175
183
|
## Step 6: Get Logs
|
|
176
184
|
|
|
177
185
|
```bash
|
|
@@ -190,7 +198,7 @@ Retrieve LLM and agentic execution traces for Agent-type processes:
|
|
|
190
198
|
uip or jobs traces <job-key> --output json
|
|
191
199
|
```
|
|
192
200
|
|
|
193
|
-
Traces are only available for processes that use UiPath Autopilot or Agent capabilities. For deeper span-level data, use `uip traces spans get [trace-id]` (or `uip traces spans get --job-key <key>`) — see [traces.md](../traces/traces.md).
|
|
201
|
+
Traces are only available for processes that use UiPath Autopilot or Agent capabilities. For a standard Process the result is an empty list, and the response adds an `Instructions` note saying so — that's how you tell "no traces recorded" apart from "this isn't an Agent process". For deeper span-level data, use `uip traces spans get [trace-id]` (or `uip traces spans get --job-key <key>`) — see [traces.md](../traces/traces.md).
|
|
194
202
|
|
|
195
203
|
Traces are cross-folder -- no `--folder-path` required.
|
|
196
204
|
|
|
@@ -217,19 +225,23 @@ uip or jobs history <job-key> --output json
|
|
|
217
225
|
Control running or suspended jobs:
|
|
218
226
|
|
|
219
227
|
```bash
|
|
220
|
-
# Stop a running job
|
|
228
|
+
# Stop a running job (SoftStop is best-effort -- a job whose activity ignores
|
|
229
|
+
# the cancellation token can still run to completion)
|
|
221
230
|
uip or jobs stop <job-key> --strategy SoftStop --output json
|
|
222
231
|
|
|
223
232
|
# Force-kill a job
|
|
224
233
|
uip or jobs stop <job-key> --strategy Kill --output json
|
|
225
234
|
|
|
226
|
-
# Restart a faulted or
|
|
235
|
+
# Restart a finished job (any outcome -- faulted, stopped, or successful).
|
|
236
|
+
# Returns the new run in the same { Jobs: [...] } shape as `jobs start`.
|
|
227
237
|
uip or jobs restart <job-key> --output json
|
|
228
238
|
|
|
229
239
|
# Resume a suspended job with new input
|
|
230
240
|
uip or jobs resume <job-key> --input-arguments '{"approved": true}' --output json
|
|
231
241
|
```
|
|
232
242
|
|
|
243
|
+
Jobs are immutable audit records -- there is no `jobs delete`. They age out per the binding process's retention period.
|
|
244
|
+
|
|
233
245
|
## Step 11: Manage Processes
|
|
234
246
|
|
|
235
247
|
Update, rollback, or edit processes after deployment:
|
|
@@ -242,7 +254,7 @@ uip or processes update-version <process-key> --output json
|
|
|
242
254
|
uip or processes rollback <process-key> --output json
|
|
243
255
|
|
|
244
256
|
# Edit process properties
|
|
245
|
-
uip or processes
|
|
257
|
+
uip or processes update <process-key> --output json
|
|
246
258
|
```
|
|
247
259
|
|
|
248
260
|
---
|
|
@@ -329,4 +341,4 @@ uip or packages download "MyProcess:1.0.0" --destination ./packages/ --output js
|
|
|
329
341
|
|
|
330
342
|
- [setup-environment.md](setup-environment.md) — Folder creation, machine assignment, user setup
|
|
331
343
|
- [traces.md](../traces/traces.md) — Deep-dive into LLM/agentic traces and spans
|
|
332
|
-
- Resources (assets, queues, buckets, triggers, webhooks, libraries) → [
|
|
344
|
+
- Resources (assets, queues, buckets, triggers, webhooks, libraries) → [resources.md](resources.md)
|
|
@@ -13,7 +13,7 @@ Create folders, assign users with roles, provision machines, and configure licen
|
|
|
13
13
|
|
|
14
14
|
## Prerequisites
|
|
15
15
|
|
|
16
|
-
1. Authenticated
|
|
16
|
+
1. Authenticated — verify with `uip login status`; if not, ask the user to run `uip login` (interactive browser flow)
|
|
17
17
|
2. Tenant selected: `uip login tenant set <tenant-name>`
|
|
18
18
|
3. Sufficient permissions: tenant-level admin or folder-create rights.
|
|
19
19
|
|
|
@@ -24,7 +24,7 @@ Create folders, assign users with roles, provision machines, and configure licen
|
|
|
24
24
|
```mermaid
|
|
25
25
|
graph LR
|
|
26
26
|
A[folders create] --> B[roles create]
|
|
27
|
-
B --> C[roles
|
|
27
|
+
B --> C[roles update<br/>add permissions]
|
|
28
28
|
C --> D[users import]
|
|
29
29
|
D --> E[users assign<br/>to folder + role]
|
|
30
30
|
E --> F[machines create]
|
|
@@ -105,7 +105,7 @@ Roles group permissions and are scoped to either the tenant or a folder. Create
|
|
|
105
105
|
uip or roles create --name "FinanceOperator" --type Folder --output json
|
|
106
106
|
|
|
107
107
|
# Add permissions to the role
|
|
108
|
-
uip or roles
|
|
108
|
+
uip or roles update <role-key> \
|
|
109
109
|
--add-permissions "Assets.View,Assets.Edit,Queues.View,Jobs.Create,Jobs.View" \
|
|
110
110
|
--output json
|
|
111
111
|
```
|
|
@@ -199,7 +199,7 @@ uip or users get <user-key-guid> --output json
|
|
|
199
199
|
uip or users list-available --folder-path "Finance" --search "jane" --output json
|
|
200
200
|
|
|
201
201
|
# Edit principal-level flags (this is the only place to grant unattended on a DirectoryUser)
|
|
202
|
-
uip or users
|
|
202
|
+
uip or users update <user-key-guid> \
|
|
203
203
|
--allow-unattended \
|
|
204
204
|
--license-type Unattended \
|
|
205
205
|
--unattended-username "DOMAIN\\jane.doe" --unattended-password "<secret-or-cred-store-name>" \
|
|
@@ -209,16 +209,16 @@ uip or users edit <user-key-guid> \
|
|
|
209
209
|
uip or users unassign <user-key-guid> --folder-path "Finance" --output json
|
|
210
210
|
```
|
|
211
211
|
|
|
212
|
-
Key flags on `users
|
|
212
|
+
Key flags on `users update`:
|
|
213
213
|
|
|
214
214
|
- **License toggles** (mutually exclusive pairs): `--allow-unattended`/`--deny-unattended`, `--allow-attended`/`--deny-attended`, `--allow-login`/`--deny-login`, `--allow-personal-workspace`/`--deny-personal-workspace`, `--active`/`--inactive`.
|
|
215
215
|
- `--license-type <Attended|Unattended|...>` — assigned license profile.
|
|
216
216
|
- `--unattended-username <user>` and `--unattended-password <pass>` — Windows account + secret used for unattended execution. Required by the API as a pair when first toggling `--allow-unattended` on a `DirectoryUser`. Username typically `DOMAIN\\name` format. Password may be a literal secret or the name of an entry in a credential store (paired with `--credential-store-key <guid>`).
|
|
217
217
|
- `--credential-store-key <guid>` — credential store backing `--unattended-password` when the secret is stored externally.
|
|
218
218
|
|
|
219
|
-
`DirectoryRobot` principals don't need `--unattended-username` / `--unattended-password` on import — the robot identity already carries its own credentials in IS. Use `users
|
|
219
|
+
`DirectoryRobot` principals don't need `--unattended-username` / `--unattended-password` on import — the robot identity already carries its own credentials in IS. Use `users update --license-type Unattended` on the robot key to set the license profile.
|
|
220
220
|
|
|
221
|
-
> **`users
|
|
221
|
+
> **`users update` does NOT expose role assignments.** It only touches tenant-side flags (license, session flags, unattended credentials). To change roles, use `uip or users assign` (folder roles), `uip or users assign-roles` (tenant roles), or `uip or roles users <role-key> --add-users/--remove-users` (single-role membership). Identity attributes like `--name`, `--surname`, `--email` on directory principals are sourced from Identity Service via sync — updating them via `users update` only updates the Orchestrator-side cached copy and may be overwritten on the next IS sync.
|
|
222
222
|
|
|
223
223
|
### Step 5: Assign Users to Folders
|
|
224
224
|
|
|
@@ -276,7 +276,7 @@ Verify: `uip or machines list --folder-path "Finance" --output json`.
|
|
|
276
276
|
uip or machines get <machine-key-guid> --output json
|
|
277
277
|
|
|
278
278
|
# Edit slots, name, description (PATCH semantics — only provided fields change)
|
|
279
|
-
uip or machines
|
|
279
|
+
uip or machines update <machine-key-guid> \
|
|
280
280
|
--unattended-slots 4 --headless-slots 2 \
|
|
281
281
|
--name "finance-runner-01-renamed" --output json
|
|
282
282
|
|
|
@@ -284,17 +284,19 @@ uip or machines edit <machine-key-guid> \
|
|
|
284
284
|
uip or machines unassign <machine-key-guid> --folder-path "Finance" --output json
|
|
285
285
|
|
|
286
286
|
# Delete the machine template entirely (tenant-level)
|
|
287
|
-
uip or machines delete <machine-key-guid> --output json
|
|
287
|
+
uip or machines delete <machine-key-guid> --yes --output json
|
|
288
288
|
|
|
289
289
|
# Bulk delete
|
|
290
|
-
uip or machines delete <key1> <key2> --output json
|
|
290
|
+
uip or machines delete <key1> <key2> --yes --output json
|
|
291
291
|
```
|
|
292
292
|
|
|
293
293
|
Notes:
|
|
294
294
|
|
|
295
|
-
- `machines
|
|
295
|
+
- `machines update` and `machines delete` resolve cross-folder by GUID — no `--folder-path` needed. `machines update` echoes the new name when you rename.
|
|
296
|
+
- Slot flags (`--unattended-slots`, `--headless-slots`, `--non-production-slots`, `--testing-slots`) must be whole numbers `>= 0` (validated client-side; `0` is allowed).
|
|
297
|
+
- `machines delete` removes the machine **and** any folder assignments it has (the assignments are re-creatable config, so there is no `--force` gate). It does not require unassigning first.
|
|
296
298
|
- Each folder accepts **one** Cloud Robots / Serverless machine. Trying to assign a second serverless to the same folder returns `HTTP 409: Only one Cloud Robots - Serverless is allowed per folder.`
|
|
297
|
-
- `machines list` defaults to all machines visible to the user. With `--folder-path` it
|
|
299
|
+
- `machines list` defaults to all machines visible to the user. With `--folder-path`/`--folder-key` it returns only machines assigned to that folder, each with `IsAssignedToFolder`. Use `--all-fields` for the raw DTO including slot subtypes (`automationCloudSlots`, `automationCloudTestAutomationSlots`, etc.) — note `--all-fields` emits the raw camelCase DTO.
|
|
298
300
|
|
|
299
301
|
### Step 8: Configure Licenses
|
|
300
302
|
|
|
@@ -332,7 +334,7 @@ uip or folders create "Finance" -d "Finance department automations" --output jso
|
|
|
332
334
|
uip or roles create --name "FinanceOperator" --type Folder --output json
|
|
333
335
|
# Response: { "Data": { "Key": "r1r2r3r4-..." } }
|
|
334
336
|
|
|
335
|
-
uip or roles
|
|
337
|
+
uip or roles update r1r2r3r4-... \
|
|
336
338
|
--add-permissions "Assets.View,Assets.Edit,Queues.View,Jobs.Create,Jobs.View,Processes.View" \
|
|
337
339
|
--output json
|
|
338
340
|
|
|
@@ -368,9 +370,9 @@ uip or machines list --folder-path "Finance" --output json
|
|
|
368
370
|
|
|
369
371
|
## Variations and Gotchas
|
|
370
372
|
|
|
371
|
-
###
|
|
373
|
+
### The mutation verb is `update` (`edit` is a deprecated alias)
|
|
372
374
|
|
|
373
|
-
|
|
375
|
+
All five admin nouns use `update`: `uip or folders update <key>`, `machines update`, `processes update`, `roles update`, `users update`. The old `edit` spelling still works as a hidden alias for backward compatibility, but new scripts should use `update`.
|
|
374
376
|
|
|
375
377
|
### Users can be assigned without roles
|
|
376
378
|
|
|
@@ -398,6 +400,8 @@ The role-resolver utility fetches all roles to map GUIDs to numeric IDs. For ten
|
|
|
398
400
|
|
|
399
401
|
Filtering options (`--type`, `--name`, `--path`, `--top-level`, `--sort-by`) only work with `--all`. Without `--all`, the command returns only folders the current user is assigned to and rejects filter flags.
|
|
400
402
|
|
|
403
|
+
`folders list --all` rows also include `FeedType` (e.g. `FolderHierarchy`, `Processes`); the plain `folders list` does not (the current-user folders API doesn't return it). Use `--all` or `folders get` when you need `FeedType`.
|
|
404
|
+
|
|
401
405
|
### Personal workspaces are flat
|
|
402
406
|
|
|
403
407
|
`uip or folders list --all --type personal` returns personal workspaces with a different shape (`Key`, `Name`, `OwnerName`, `OwnerKey`, `LastLogin`). The `--path` and `--top-level` flags are not supported because personal workspaces have no hierarchy.
|
|
@@ -407,4 +411,4 @@ Filtering options (`--type`, `--name`, `--path`, `--top-level`, `--sort-by`) onl
|
|
|
407
411
|
## Related
|
|
408
412
|
|
|
409
413
|
- [Run Jobs](run-jobs.md) — After setup, deploy packages and start jobs in the folder.
|
|
410
|
-
- Create assets, queues, and buckets in the folder → [
|
|
414
|
+
- Create assets, queues, and buckets in the folder → [resources.md](resources.md)
|