@uipath/skills 1.200.0 → 1.201.0-preview.433
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +1 -1
- package/.claude-plugin/plugin.json +1 -1
- package/.cursor-plugin/plugin.json +32 -0
- package/CODEOWNERS +25 -4
- package/README.md +1 -0
- package/assets/skill-status.json +8 -0
- package/assets/uip-catalog-snapshot.json +113 -41
- package/assets/uipath-icon.png +0 -0
- package/commands/install-permissions.md +1 -0
- package/package.json +3 -2
- package/skills/uipath-admin/SKILL.md +1 -1
- package/skills/uipath-admin/references/authorization/permission-catalog.md +61 -1
- package/skills/uipath-admin/references/authorization/role-management.md +3 -1
- package/skills/uipath-admin/references/diagnose/references/failure-modes.md +29 -4
- package/skills/uipath-admin/references/diagnose/references/troubleshooting-guide.md +13 -0
- package/skills/uipath-agents/SKILL.md +1 -0
- package/skills/uipath-agents/references/coded/capabilities/context-grounding.md +3 -3
- package/skills/uipath-agents/references/coded/capabilities/guardrails/guardrails-recommend.md +6 -1
- package/skills/uipath-agents/references/coded/capabilities/guardrails/guardrails.md +89 -1
- package/skills/uipath-agents/references/coded/embedding-in-flows.md +17 -1
- package/skills/uipath-agents/references/coded/frameworks/llamaindex-integration.md +64 -2
- package/skills/uipath-agents/references/coded/lifecycle/deployment.md +3 -0
- package/skills/uipath-agents/references/coded/lifecycle/environment-variables.md +90 -0
- package/skills/uipath-agents/references/coded/lifecycle/file-sync.md +3 -1
- package/skills/uipath-agents/references/coded/quickstart.md +10 -6
- package/skills/uipath-agents/references/lowcode/capabilities/guardrails/guardrails-recommend.md +20 -5
- package/skills/uipath-agents/references/lowcode/capabilities/guardrails/guardrails.md +13 -0
- package/skills/uipath-agents/references/lowcode/capabilities/inline-in-flow/inline-in-flow.md +1 -3
- package/skills/uipath-api-workflow/references/operating-published-workflows.md +17 -6
- package/skills/uipath-automationhub/SKILL.md +58 -0
- package/skills/uipath-automationhub/references/api-endpoints.md +140 -0
- package/skills/uipath-automationhub/references/get-process.md +69 -0
- package/skills/uipath-automationhub/references/publish-process.md +171 -0
- package/skills/uipath-coded-apps/SKILL.md +24 -11
- package/skills/uipath-coded-apps/references/commands-reference.md +29 -29
- package/skills/uipath-coded-apps/references/create-action-app.md +4 -0
- package/skills/uipath-coded-apps/references/create-web-app.md +10 -0
- package/skills/uipath-coded-apps/references/debug.md +16 -0
- package/skills/uipath-coded-apps/references/oauth-client-setup.md +3 -1
- package/skills/uipath-coded-apps/references/oauth-scopes.md +39 -4
- package/skills/uipath-coded-apps/references/pack-publish-deploy.md +37 -21
- package/skills/uipath-coded-apps/references/sdk/conversational-agent.md +2 -0
- package/skills/uipath-coded-apps/references/sdk/data-fabric.md +2 -0
- package/skills/uipath-coded-apps/references/sdk/orchestrator.md +2 -0
- package/skills/uipath-coded-apps/references/widgets/conversational-agent-chat.md +90 -0
- package/skills/uipath-coded-apps/references/widgets/datatable.md +97 -0
- package/skills/uipath-coded-apps/references/widgets/external-auth.md +97 -0
- package/skills/uipath-coded-apps/references/widgets/multi-file-upload.md +98 -0
- package/skills/uipath-coded-apps/references/widgets/pdf-viewer.md +122 -0
- package/skills/uipath-coded-apps/references/widgets/validation-station.md +1 -1
- package/skills/uipath-functions/SKILL.md +11 -0
- package/skills/uipath-insights/SKILL.md +52 -247
- package/skills/uipath-insights/references/filter-discovery-guide.md +106 -0
- package/skills/uipath-insights/references/investigation-playbook-guide.md +24 -16
- package/skills/uipath-insights/references/jobs-commands-guide.md +196 -53
- package/skills/uipath-ixp/SKILL.md +10 -4
- package/skills/uipath-ixp/references/cli-reference.md +59 -5
- package/skills/uipath-ixp/references/label-documents-guide.md +12 -5
- package/skills/uipath-maestro-bpmn/SKILL.md +27 -9
- package/skills/uipath-maestro-bpmn/references/diagnose/references/failure-modes.md +6 -3
- package/skills/uipath-maestro-bpmn/references/operate/CAPABILITY.md +1 -1
- package/skills/uipath-maestro-bpmn/references/operate/references/ship.md +9 -3
- package/skills/uipath-maestro-bpmn/references/registry-workflow.md +1 -1
- package/skills/uipath-maestro-bpmn/references/shared/local-metadata-regeneration-guide.md +18 -11
- package/skills/uipath-maestro-bpmn/references/structural-bpmn.md +13 -7
- package/skills/uipath-maestro-case/SKILL.md +138 -170
- package/skills/uipath-maestro-case/references/bindings-and-expressions.md +14 -1
- package/skills/uipath-maestro-case/references/bindings-v2-sync.md +25 -1
- package/skills/uipath-maestro-case/references/brownfield.md +7 -3
- package/skills/uipath-maestro-case/references/case-commands.md +63 -8
- package/skills/uipath-maestro-case/references/case-editing-operations.md +11 -8
- package/skills/uipath-maestro-case/references/case-schema.md +5 -3
- package/skills/uipath-maestro-case/references/case-spec-input-details.md +4 -0
- package/skills/uipath-maestro-case/references/connector-integration.md +3 -1
- package/skills/uipath-maestro-case/references/connector-trigger-impl.md +236 -0
- package/skills/uipath-maestro-case/references/connector-trigger-planning.md +300 -0
- package/skills/uipath-maestro-case/references/entry-points-sync.md +2 -0
- package/skills/uipath-maestro-case/references/evals/evals.json +33 -40
- package/skills/uipath-maestro-case/references/implementation.md +58 -13
- package/skills/uipath-maestro-case/references/phased-execution.md +87 -20
- package/skills/uipath-maestro-case/references/placeholder-tasks.md +3 -1
- package/skills/uipath-maestro-case/references/planning.md +26 -16
- package/skills/uipath-maestro-case/references/plugins/case/impl-json.md +2 -5
- 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 +3 -1
- package/skills/uipath-maestro-case/references/plugins/conditions/case-exit-conditions/planning.md +5 -3
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-entry-conditions/impl-json.md +4 -2
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-entry-conditions/planning.md +6 -4
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-exit-conditions/impl-json.md +6 -4
- package/skills/uipath-maestro-case/references/plugins/conditions/stage-exit-conditions/planning.md +6 -4
- package/skills/uipath-maestro-case/references/plugins/conditions/task-entry-conditions/impl-json.md +42 -3
- package/skills/uipath-maestro-case/references/plugins/conditions/task-entry-conditions/planning.md +6 -4
- package/skills/uipath-maestro-case/references/plugins/logging/impl-json.md +50 -32
- package/skills/uipath-maestro-case/references/plugins/sla/impl-json.md +2 -4
- package/skills/uipath-maestro-case/references/plugins/sla/planning.md +3 -1
- package/skills/uipath-maestro-case/references/plugins/stages/impl-json.md +1 -4
- package/skills/uipath-maestro-case/references/plugins/stages/planning.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/tasks/action/impl-json.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/tasks/action/planning.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/tasks/agent/impl-json.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/tasks/agent/planning.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/tasks/api-workflow/impl-json.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/tasks/api-workflow/planning.md +5 -3
- package/skills/uipath-maestro-case/references/plugins/tasks/case-management/impl-json.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/tasks/case-management/planning.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-activity/impl-json.md +43 -13
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-activity/planning.md +4 -2
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-trigger/impl-json.md +10 -7
- package/skills/uipath-maestro-case/references/plugins/tasks/connector-trigger/planning.md +5 -3
- package/skills/uipath-maestro-case/references/plugins/tasks/create-inline-common.md +3 -1
- package/skills/uipath-maestro-case/references/plugins/tasks/process/impl-json.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/tasks/process/planning.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/tasks/rpa/impl-json.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/tasks/rpa/planning.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/tasks/wait-for-timer/impl-json.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/tasks/wait-for-timer/planning.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/triggers/event/impl-json.md +9 -6
- package/skills/uipath-maestro-case/references/plugins/triggers/event/planning.md +5 -3
- package/skills/uipath-maestro-case/references/plugins/triggers/manual/impl-json.md +1 -4
- package/skills/uipath-maestro-case/references/plugins/triggers/manual/planning.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/triggers/timer/impl-json.md +1 -4
- package/skills/uipath-maestro-case/references/plugins/triggers/timer/planning.md +2 -0
- package/skills/uipath-maestro-case/references/plugins/variables/bindings/impl-json.md +3 -1
- package/skills/uipath-maestro-case/references/plugins/variables/global-vars/impl-json.md +40 -2
- package/skills/uipath-maestro-case/references/plugins/variables/global-vars/planning.md +12 -2
- package/skills/uipath-maestro-case/references/plugins/variables/io-binding/impl-json.md +8 -6
- package/skills/uipath-maestro-case/references/plugins/variables/io-binding/planning.md +17 -3
- package/skills/uipath-maestro-case/references/registry-discovery.md +9 -5
- package/skills/uipath-maestro-case/references/sla-response-shapes.md +3 -1
- package/skills/uipath-maestro-case/references/troubleshooting-guide.md +2 -0
- package/skills/uipath-maestro-case/scripts/audit_plan.py +231 -0
- package/skills/uipath-maestro-flow/references/author/CAPABILITY.md +8 -4
- package/skills/uipath-maestro-flow/references/author/references/editing-operations-cli.md +5 -3
- package/skills/uipath-maestro-flow/references/author/references/editing-operations-json.md +14 -4
- package/skills/uipath-maestro-flow/references/author/references/editing-operations.md +3 -3
- package/skills/uipath-maestro-flow/references/author/references/greenfield.md +12 -3
- package/skills/uipath-maestro-flow/references/author/references/planning-arch.md +17 -13
- package/skills/uipath-maestro-flow/references/author/references/planning-impl.md +1 -1
- package/skills/uipath-maestro-flow/references/author/references/plugins/agent/impl.md +49 -4
- package/skills/uipath-maestro-flow/references/author/references/plugins/connector/impl.md +59 -17
- package/skills/uipath-maestro-flow/references/author/references/plugins/connector-trigger/impl.md +3 -3
- package/skills/uipath-maestro-flow/references/author/references/plugins/http/impl-connector.md +3 -1
- package/skills/uipath-maestro-flow/references/author/references/plugins/http/impl-manual.md +3 -1
- package/skills/uipath-maestro-flow/references/author/references/plugins/http/impl.md +5 -2
- package/skills/uipath-maestro-flow/references/author/references/plugins/inline-agent/impl.md +31 -16
- package/skills/uipath-maestro-flow/references/author/references/plugins/ixp/impl.md +13 -4
- package/skills/uipath-maestro-flow/references/author/references/plugins/loop/impl.md +185 -25
- package/skills/uipath-maestro-flow/references/author/references/plugins/loop/planning.md +18 -10
- package/skills/uipath-maestro-flow/references/author/references/plugins/rpa/impl.md +9 -3
- package/skills/uipath-maestro-flow/references/author/references/plugins/terminate/impl.md +6 -3
- package/skills/uipath-maestro-flow/references/diagnose/references/failure-modes.md +68 -0
- package/skills/uipath-maestro-flow/references/shared/cli-commands.md +2 -1
- package/skills/uipath-maestro-flow/references/shared/file-format.md +36 -9
- package/skills/uipath-maestro-flow/references/shared/node-output-wiring.md +1 -1
- package/skills/uipath-maestro-flow/references/shared/ux-narration-and-todos.md +1 -1
- package/skills/uipath-maestro-flow/references/shared/variables-and-expressions.md +77 -20
- package/skills/uipath-planner/SKILL.md +30 -12
- package/skills/{uipath-maestro-case/assets/templates/sdd-template-examples.md → uipath-planner/assets/templates/case-sdd-examples.md} +18 -32
- package/skills/uipath-planner/assets/templates/case-sdd-template.md +289 -309
- package/skills/uipath-planner/references/case-design-lane-guide.md +288 -0
- package/skills/uipath-planner/references/multi-skill-patterns-guide.md +1 -1
- package/skills/uipath-planner/references/package-selection-guide.md +2 -2
- package/skills/uipath-planner/references/pdd-driven-lane-guide.md +5 -1
- package/skills/uipath-planner/references/product-selection-guide.md +2 -2
- package/skills/uipath-planner/references/sdd-generation-guide.md +16 -15
- package/skills/uipath-planner/scripts/audit_sdd.py +437 -0
- package/skills/uipath-platform/SKILL.md +7 -2
- package/skills/uipath-platform/references/data-fabric/choice-sets.md +1 -1
- package/skills/uipath-platform/references/data-fabric/data-fabric.md +1 -1
- package/skills/uipath-platform/references/data-fabric/entity-schema.md +37 -21
- package/skills/uipath-platform/references/data-fabric/file-attachments.md +1 -1
- package/skills/uipath-platform/references/guardrails/byo-configurations.md +205 -0
- package/skills/uipath-platform/references/traces/feedback.md +4 -2
- package/skills/uipath-platform/references/uip-commands.md +2 -2
- package/skills/uipath-review/SKILL.md +55 -52
- package/skills/uipath-review/references/agents/agent-grading-rubric.md +62 -40
- package/skills/uipath-review/references/agents/agents-coded-rules.md +7 -1
- package/skills/uipath-review/references/agents/agents-lowcode-rules.md +21 -2
- package/skills/uipath-review/references/agents/guardrails/coded-guardrails-review.md +78 -13
- package/skills/uipath-review/references/agents/guardrails/guardrails-review.md +11 -4
- package/skills/uipath-review/references/architecture-assessment-guide.md +1 -1
- package/skills/uipath-review/references/review-workflow-guide.md +19 -10
- package/skills/uipath-review/references/rule-catalog-workflow.md +6 -6
- package/skills/uipath-review/references/rule-format.md +1 -1
- package/skills/uipath-rpa/SKILL.md +1 -1
- package/skills/uipath-solution/SKILL.md +4 -4
- package/skills/uipath-solution/references/solution-overview.md +7 -2
- package/skills/uipath-tasks/SKILL.md +27 -1
- package/skills/uipath-tasks/references/task-catalogs.md +79 -0
- package/skills/uipath-tasks/references/task-data.md +45 -0
- package/skills/uipath-tasks/references/task-metadata.md +69 -0
- package/skills/uipath-test/SKILL.md +3 -3
- package/skills/uipath-test/references/test-result-report-guide.md +16 -1
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/ambiguous-selector.md +1 -1
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/scope-container-wrong-page.md +1 -1
- package/skills/uipath-troubleshoot/references/activity-packages/ui-automation/playbooks/verify-execution-failure.md +2 -2
- package/skills/uipath-troubleshoot/references/products/agents/playbooks/guardrail-violation.md +12 -0
- package/version-manifest.json +2 -2
- package/skills/uipath-maestro-case/assets/templates/sdd-template.md +0 -667
- package/skills/uipath-maestro-case/references/connector-trigger-common.md +0 -511
- package/skills/uipath-maestro-case/references/phase-0-interview.md +0 -279
- package/skills/uipath-maestro-case/references/sdd-generation-rules.md +0 -1026
- package/skills/uipath-review/references/agents/agent-common-issues.md +0 -401
- package/skills/uipath-review/references/agents/agent-review-checklist.md +0 -379
- /package/skills/{uipath-maestro-case → uipath-planner}/assets/templates/sdd-viewer.html +0 -0
|
@@ -1,276 +1,81 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: uipath-insights
|
|
3
|
-
description: "UiPath Insights job monitoring via `uip insights` — query job execution metrics, failure analysis, and process performance. Covers job KPIs, failure reasons, completion trends, process breakdowns. For Orchestrator job start/stop/logs→uipath-platform, root-cause analysis of specific errors→uipath-troubleshoot, RPA workflow authoring→uipath-rpa."
|
|
4
|
-
when_to_use: "User says 'job failures', 'automation health', 'job success rate', 'processing time', 'which processes fail the most', 'failure reasons', 'job trends', 'how many jobs ran', 'insights dashboard', 'job metrics', 'job KPIs', 'job performance', 'uncompleted jobs', 'pending jobs', 'faulted jobs', 'job timeline', 'process details'. Also 'uip insights', 'insights jobs'. NOT for starting/stopping jobs (uipath-platform), NOT for root-cause debugging of a specific job error (uipath-troubleshoot), NOT for queue metrics (
|
|
3
|
+
description: "UiPath Insights job monitoring via `uip insights` — query job execution metrics, failure analysis, and process performance. Covers job KPIs, failure reasons, completion trends, process breakdowns. Also filter discovery — folders, processes, queues, and machines with recent activity, for choosing exact scope before alerts or filtered queries. For Orchestrator job start/stop/logs→uipath-platform, root-cause analysis of specific errors→uipath-troubleshoot, RPA workflow authoring→uipath-rpa."
|
|
4
|
+
when_to_use: "User says 'job failures', 'automation health', 'job success rate', 'processing time', 'which processes fail the most', 'failure reasons', 'job trends', 'how many jobs ran', 'insights dashboard', 'job metrics', 'job KPIs', 'job performance', 'uncompleted jobs', 'pending jobs', 'faulted jobs', 'job timeline', 'process details', 'which folders can you see', 'what processes are active', 'find the folder key', 'discover queues', 'which machines reported', 'filter-folders', 'filter-processes'. Also 'uip insights', 'insights jobs'. NOT for starting/stopping jobs (uipath-platform), NOT for root-cause debugging of a specific job error (uipath-troubleshoot), NOT for queue item metrics (queue discovery is supported via filter-queues; metrics are not)."
|
|
5
5
|
allowed-tools: Bash, Read
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
# UiPath Insights
|
|
8
|
+
# UiPath Insights
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
Use `uip insights` for job monitoring and monitoring-scope discovery. Read the guide for the task before running commands.
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
## When to Use This Skill
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
-
|
|
19
|
-
- Investigating job failures (which processes fail most, what are the failure reasons)
|
|
20
|
-
- Monitoring job execution trends over time (completed/uncompleted timelines)
|
|
21
|
-
- Getting per-process performance breakdowns
|
|
22
|
-
- Drilling into specific failure details for investigation
|
|
23
|
-
|
|
24
|
-
> **Not in scope:** Starting, stopping, or managing individual jobs (use `uip or jobs` via uipath-platform). Root-cause debugging of a specific job's error (use uipath-troubleshoot). Queue item metrics, robot utilization, or dashboard CRUD (not yet available in CLI).
|
|
25
|
-
|
|
26
|
-
---
|
|
27
|
-
|
|
28
|
-
## Login & Tenant Setup
|
|
29
|
-
|
|
30
|
-
**Default to Production. Only switch environment/org/tenant when explicitly stated in the request.**
|
|
31
|
-
|
|
32
|
-
- If the request mentions no environment, use the current session (defaults to prod `cloud.uipath.com`)
|
|
33
|
-
- If the request explicitly names an environment/org/tenant, check `uip login status` and re-login if needed
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
# Check current environment, org, and tenant
|
|
37
|
-
uip login status --output json
|
|
38
|
-
|
|
39
|
-
# Login to a specific environment (production cloud is the default)
|
|
40
|
-
uip login --authority https://cloud.uipath.com --tenant MyTenant
|
|
41
|
-
|
|
42
|
-
# Switch tenant within the same environment
|
|
43
|
-
uip login tenant set MyTenant
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
---
|
|
14
|
+
- Job health, success rate, failure count, or processing time across a tenant, folder, or process
|
|
15
|
+
- Job trends over time, or a comparison between two periods
|
|
16
|
+
- Which processes fail most, and which failure reasons recur
|
|
17
|
+
- Whether jobs are stuck, pending, or still running
|
|
18
|
+
- Finding the exact folder key, process name, queue name, or machine name to scope a query by
|
|
47
19
|
|
|
48
20
|
## Critical Rules
|
|
49
21
|
|
|
50
|
-
1. **
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
5. **Start with summary, then drill down.** For any investigation, start with `summary` to get the big picture, then use specific subcommands to investigate areas of concern.
|
|
63
|
-
|
|
64
|
-
---
|
|
65
|
-
|
|
66
|
-
## Command Reference
|
|
67
|
-
|
|
68
|
-
All commands share these filter options:
|
|
69
|
-
|
|
70
|
-
| Option | Description |
|
|
71
|
-
|--------|-------------|
|
|
72
|
-
| `--time-range <minutes>` | Relative time range in minutes |
|
|
73
|
-
| `--started-after <epoch-ms>` | Absolute start time (Unix epoch ms) |
|
|
74
|
-
| `--started-before <epoch-ms>` | Absolute end time (Unix epoch ms) |
|
|
75
|
-
| `--folder-key <guid>` | Filter by folder key (repeatable) |
|
|
76
|
-
| `--process-name <name>` | Filter by process name (repeatable) |
|
|
77
|
-
| `--machine-name <name>` | Filter by machine name (repeatable) |
|
|
78
|
-
| `--timezone-offset <minutes>` | Client timezone offset from UTC |
|
|
79
|
-
|
|
80
|
-
### summary
|
|
81
|
-
|
|
82
|
-
Get job KPIs: total count, successful count, and average processing time.
|
|
83
|
-
|
|
84
|
-
```bash
|
|
85
|
-
uip insights jobs summary --time-range 1440 --output json
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
**Key Data fields:** `jobsCount`, `successfulJobsCount`, `averageProcessingTime`
|
|
89
|
-
|
|
90
|
-
**Use when:** User asks "how are my automations doing?" or "what's my job success rate?"
|
|
91
|
-
|
|
92
|
-
### completed-timeline
|
|
93
|
-
|
|
94
|
-
Get completed jobs over time, grouped by job state (successful, faulted, stopped, etc.).
|
|
95
|
-
|
|
96
|
-
```bash
|
|
97
|
-
uip insights jobs completed-timeline --time-range 1440 --output json
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
**Key Data fields:** `jobState`, `jobCountByTime`, `timestamp`
|
|
101
|
-
|
|
102
|
-
**Use when:** User asks "show me job completion trends" or "when do most jobs run?"
|
|
103
|
-
|
|
104
|
-
### uncompleted-timeline
|
|
105
|
-
|
|
106
|
-
Get running and pending jobs over time.
|
|
107
|
-
|
|
108
|
-
```bash
|
|
109
|
-
uip insights jobs uncompleted-timeline --time-range 1440 --output json
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
**Key Data fields:** `jobState`, `jobCountByTime`, `timestamp`
|
|
113
|
-
|
|
114
|
-
**Use when:** User asks "are there stuck jobs?" or "how many jobs are still running?"
|
|
115
|
-
|
|
116
|
-
### top-failures
|
|
117
|
-
|
|
118
|
-
Get processes ranked by failure count.
|
|
119
|
-
|
|
120
|
-
```bash
|
|
121
|
-
uip insights jobs top-failures --time-range 43200 --output json
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
**Key Data fields:** `processName`, `jobCountByTime`
|
|
125
|
-
|
|
126
|
-
**Use when:** User asks "which processes fail the most?" or "what's causing failures?"
|
|
22
|
+
1. **Use `--output json`.** `jobs` commands return `{ Result, Code, Data }`. `filter-*` commands add `Pagination` and `Instructions`; quote those `Instructions` in the explanation. A failure envelope carries `Result`, `Message`, `Instructions`, `ErrorCode`, and `Retry`, with no `Code` and no `Data`. Keys inside `Data` are PascalCase on the wire, so read `FolderKey` and `JobsCount`, not `folderKey` or `jobsCount`.
|
|
23
|
+
2. **One subcommand per invocation, written literally.** Do not chain, loop, or parameterize `uip insights` commands: no `&&` or `;` chains, no `for` loops, and no shell variables holding the subcommand name or flag values. Resolve values such as epoch timestamps in a separate command first, then pass literal numbers. Never write `$(date ...)` or `$VAR` into a flag value.
|
|
24
|
+
3. **Use only the flags the guides document.** Identity, organization, and tenant come from the active session. Any tenant flag you find is deprecated and is rejected outright on `filter-*` commands, so do not use one. If a filter is not in the guide's shared-options list, it does not exist.
|
|
25
|
+
4. **Every `jobs` command needs a time range.** Pass `--time-range <minutes>` (60 = 1h, 1440 = 24h, 10080 = 7d, 43200 = 30d), or both `--started-after` and `--started-before`. Omitting both is rejected locally and exits 1. `filter-*` commands take no time flags.
|
|
26
|
+
5. **Start with `summary`, then drill down.** After any scope discovery the task needs, begin a job investigation with `uip insights jobs summary` for the totals, then run the targeted subcommands. The summary supplies the denominator that makes a failure count meaningful.
|
|
27
|
+
6. **Treat empty data as bounded evidence.** Empty results can reflect the chosen time window, the recent-activity window, caller visibility, or tenant provisioning. They do not prove that a resource or event never existed.
|
|
28
|
+
7. **Use the CLI instead of raw Insights APIs.** It owns authentication, tenant routing, validation, and error handling.
|
|
29
|
+
8. **Do not retry automatically.** Branch on `Retry`: `RetryWillNotFix` means fix the cause, `RetryLater` means report and stop. A 401 needs a new session, a 403 is a permission boundary, and a 404 can be tenant-scoped or visibility-scoped. Each guide documents the error shapes for its own commands.
|
|
30
|
+
9. **Never run `uip login` yourself.** It opens an interactive browser flow that will hang the session. Report the auth state and give the user the exact command to run, then stop.
|
|
31
|
+
10. **Discover identifiers instead of guessing.** Use [`references/filter-discovery-guide.md`](references/filter-discovery-guide.md) to resolve monitoring scope. Page through all results before concluding a resource is absent.
|
|
32
|
+
11. **Hand off causal debugging.** Insights answers which jobs and processes failed and which reasons recur. It does not explain one job's exception or how to fix it. Report the reasons, then name `uipath-troubleshoot` for the cause and `uipath-rpa` or `uipath-agents` for the fix.
|
|
127
33
|
|
|
128
|
-
|
|
34
|
+
## Shared Workflow
|
|
129
35
|
|
|
130
|
-
|
|
36
|
+
1. Check the active login when the task will call UiPath Cloud:
|
|
131
37
|
|
|
132
|
-
```bash
|
|
133
|
-
uip
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
**Key Data fields:** `processExceptionReason`, `processName`, `robotName`, `jobsCount`
|
|
137
|
-
|
|
138
|
-
**Use when:** User asks "why are jobs failing?" or "what are the common error messages?"
|
|
139
|
-
|
|
140
|
-
### process-details
|
|
141
|
-
|
|
142
|
-
Get per-process job breakdown with counts by state.
|
|
143
|
-
|
|
144
|
-
```bash
|
|
145
|
-
uip insights jobs process-details --time-range 1440 --output json
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
**Key Data fields:** `processName`, `jobAggregate`
|
|
149
|
-
|
|
150
|
-
**Use when:** User asks "show me per-process stats" or "which process has the most faulted jobs?"
|
|
38
|
+
```bash
|
|
39
|
+
uip login status --output json
|
|
40
|
+
```
|
|
151
41
|
|
|
152
|
-
|
|
42
|
+
2. Read the guide the Task Navigation table below names for this task.
|
|
43
|
+
3. Run the subcommand and parse `Data` for the result. On `filter-*` commands also read `Pagination` for list completeness.
|
|
153
44
|
|
|
154
|
-
|
|
45
|
+
Default to the active Production session. Change authority, organization, or tenant only when the user explicitly names another environment or scope. Give the user the command to run rather than running it yourself:
|
|
155
46
|
|
|
156
47
|
```bash
|
|
157
|
-
uip
|
|
48
|
+
uip login --authority https://cloud.uipath.com --tenant MyTenant # named environment
|
|
49
|
+
uip login tenant set MyTenant # same environment, different tenant
|
|
158
50
|
```
|
|
159
51
|
|
|
160
|
-
|
|
52
|
+
## Task Navigation
|
|
161
53
|
|
|
162
|
-
|
|
54
|
+
| User's task | Read first |
|
|
55
|
+
|---|---|
|
|
56
|
+
| Check job health, success rate, trends, failures, stuck jobs, or compare periods | [`references/investigation-playbook-guide.md`](references/investigation-playbook-guide.md) |
|
|
57
|
+
| Choose a Jobs subcommand, flag, time range, or interpret its response fields | [`references/jobs-commands-guide.md`](references/jobs-commands-guide.md) |
|
|
58
|
+
| Answer which folders, processes, queues, or machines are visible, or resolve an exact folder key, process name, or machine name to filter by | [`references/filter-discovery-guide.md`](references/filter-discovery-guide.md) |
|
|
163
59
|
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
## Workflow: Investigate Job Health
|
|
60
|
+
Read only the guides the task needs. A job investigation that must first resolve a folder, process, or machine needs the filter guide, then the jobs guide.
|
|
167
61
|
|
|
168
|
-
|
|
62
|
+
## Scope Boundaries
|
|
169
63
|
|
|
170
|
-
|
|
171
|
-
# 1. Check login
|
|
172
|
-
uip login status --output json
|
|
173
|
-
|
|
174
|
-
# 2. Get the big picture — how many jobs ran? how many succeeded?
|
|
175
|
-
uip insights jobs summary --time-range 1440 --output json
|
|
176
|
-
|
|
177
|
-
# 3. If success rate is low, find which processes fail most
|
|
178
|
-
uip insights jobs top-failures --time-range 1440 --output json
|
|
179
|
-
|
|
180
|
-
# 4. Find out WHY they're failing
|
|
181
|
-
uip insights jobs failures-by-reason --time-range 1440 --output json
|
|
182
|
-
|
|
183
|
-
# 5. Drill into specific failure details
|
|
184
|
-
uip insights jobs failure-details --time-range 1440 --output json
|
|
185
|
-
|
|
186
|
-
# 6. For time-based trends, check timelines
|
|
187
|
-
uip insights jobs completed-timeline --time-range 10080 --output json
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
**Present findings clearly:** After gathering data, summarize for the user:
|
|
191
|
-
- Total jobs vs successful jobs (derive failure rate)
|
|
192
|
-
- Top failing processes by name
|
|
193
|
-
- Most common failure reasons
|
|
194
|
-
- Which machines are affected
|
|
195
|
-
- Whether failures are trending up or down
|
|
196
|
-
|
|
197
|
-
---
|
|
198
|
-
|
|
199
|
-
## Workflow: Filter by Folder or Process
|
|
200
|
-
|
|
201
|
-
When the user asks about a specific folder or process:
|
|
202
|
-
|
|
203
|
-
```bash
|
|
204
|
-
# Filter by folder
|
|
205
|
-
uip insights jobs summary --time-range 1440 --folder-key "abc-123-def" --output json
|
|
64
|
+
`uip insights` ships two command families: `jobs` and `filter-folders` / `filter-processes` / `filter-queues` / `filter-machines`. If a request needs anything else, say it is not available rather than guessing a subcommand.
|
|
206
65
|
|
|
207
|
-
|
|
208
|
-
|
|
66
|
+
| Request | Route |
|
|
67
|
+
|---|---|
|
|
68
|
+
| Start, stop, restart, or inspect logs for an individual Orchestrator job | `uipath-platform` |
|
|
69
|
+
| Diagnose the root cause of a specific job error | `uipath-troubleshoot` |
|
|
70
|
+
| Fix the workflow or agent that caused a failure | `uipath-rpa` or `uipath-agents` |
|
|
71
|
+
| Query queue item metrics | Not supported; `filter-queues` discovers queue scope only |
|
|
72
|
+
| Alert definitions, dashboards, or robot utilization | Not in the shipped `uip insights` surface |
|
|
209
73
|
|
|
210
|
-
|
|
211
|
-
uip insights jobs failures-by-reason --time-range 1440 \
|
|
212
|
-
--folder-key "abc-123-def" \
|
|
213
|
-
--process-name "Invoice_Processing" \
|
|
214
|
-
--output json
|
|
215
|
-
```
|
|
216
|
-
|
|
217
|
-
To discover available folder keys, use `uip or folders list --output json` (from the uipath-platform skill).
|
|
218
|
-
|
|
219
|
-
---
|
|
220
|
-
|
|
221
|
-
## Workflow: Absolute Time Range
|
|
222
|
-
|
|
223
|
-
When the user specifies an exact date range instead of "last N hours", use `--started-after`/`--started-before` (not `--time-range`).
|
|
224
|
-
|
|
225
|
-
**Two steps, two separate command invocations.** Resolve the dates to epoch milliseconds first, read the numbers from the output, then write the literal numbers into the `uip` command. Never embed `$(date ...)` substitutions or shell variables in `uip insights` flag values — if `date` fails silently (macOS and Linux flags differ), the flag becomes garbage and the query runs against the wrong window, and the logged command no longer shows what range was actually queried.
|
|
226
|
-
|
|
227
|
-
```bash
|
|
228
|
-
# Step 1 — resolve each boundary to epoch ms at UTC midnight (run this alone, read the output):
|
|
229
|
-
date -u -d "2026-07-01 00:00:00" +%s000 # Linux → 1782864000000
|
|
230
|
-
date -u -d "2026-07-06 00:00:00" +%s000 # Linux → 1783296000000
|
|
231
|
-
date -u -j -f "%Y-%m-%d %H:%M:%S" "2026-07-01 00:00:00" +%s000 # macOS → 1782864000000
|
|
232
|
-
```
|
|
233
|
-
|
|
234
|
-
```bash
|
|
235
|
-
# Step 2 — run each subcommand with the literal resolved values:
|
|
236
|
-
uip insights jobs summary --started-after 1782864000000 --started-before 1783296000000 --output json
|
|
237
|
-
```
|
|
238
|
-
```bash
|
|
239
|
-
uip insights jobs completed-timeline --started-after 1782864000000 --started-before 1783296000000 --output json
|
|
240
|
-
```
|
|
241
|
-
|
|
242
|
-
The end boundary is exclusive: "July 1st to July 5th" inclusive means `--started-after` = July 1 00:00:00 UTC and `--started-before` = July 6 00:00:00 UTC.
|
|
243
|
-
|
|
244
|
-
---
|
|
245
|
-
|
|
246
|
-
## Troubleshooting
|
|
247
|
-
|
|
248
|
-
| Error | Cause | Fix |
|
|
249
|
-
|-------|-------|-----|
|
|
250
|
-
| `Not logged in` | Auth expired | `uip login` |
|
|
251
|
-
| `time range is required` | Missing `--time-range` or `--started-after`/`--started-before` | Add `--time-range 1440` (or your preferred window) |
|
|
252
|
-
| `API request failed: 401` | Token doesn't have Insights access | Re-login; ensure the org has Insights enabled |
|
|
253
|
-
| `API request failed: 403` | User has no folder permissions | Check folder assignments in Orchestrator Admin |
|
|
254
|
-
| `API request failed: 500` | Server error (often missing time range on older deployments) | Ensure time range is provided in the request body |
|
|
255
|
-
| All Data fields are null/zero | No jobs ran in the given time window | Widen the `--time-range` (try 43200 for 30 days) |
|
|
256
|
-
|
|
257
|
-
---
|
|
258
|
-
|
|
259
|
-
## What NOT to Do
|
|
260
|
-
|
|
261
|
-
- **Don't call `uip insights jobs` without a time range.** The server returns a 500 with a misleading success-shaped response. Always pass `--time-range` or `--started-after`/`--started-before`.
|
|
262
|
-
- **Don't embed `$(date ...)` or shell variables in `uip insights` flag values.** Resolve times in a separate command first, then pass literal epoch-millisecond numbers. Literal values make the executed command auditable and immune to platform `date` differences.
|
|
263
|
-
- **Don't chain, loop, or parameterize `uip insights` subcommands in one invocation.** Run each subcommand as its own command with the subcommand name written literally — no `&&`/`;` chains, no `for` loops, no shell variables holding the subcommand name. One command per invocation keeps each subcommand's exit status and output attributable.
|
|
264
|
-
- **Don't start, stop, or manage individual jobs.** This skill is for monitoring and analytics only. Use `uip or jobs start/stop` via uipath-platform to manage jobs.
|
|
265
|
-
- **Don't construct raw API calls to the Insights endpoint.** The CLI handles auth headers (`X-UiPath-Internal-AccountName`, `X-UiPath-Internal-TenantName`), URL construction, and error handling. Hand-rolling `curl` or `fetch` calls will miss these.
|
|
266
|
-
- **Don't retry on auth errors.** If `uip insights jobs` returns 401 or "Not logged in", the fix is `uip login`, not retrying the same command.
|
|
267
|
-
- **Don't use this skill for root-cause debugging.** "Why did job X fail with error Y?" is a troubleshooting question — hand off to uipath-troubleshoot. This skill answers "which processes fail the most and what are the common reasons."
|
|
268
|
-
|
|
269
|
-
---
|
|
74
|
+
## Anti-patterns
|
|
270
75
|
|
|
271
|
-
|
|
76
|
+
- Do not add `--limit` or `--offset` to a `jobs` command. Only `filter-*` commands page.
|
|
77
|
+
- Do not reuse an identifier from an example. Folder keys, process names, and machine names come from a `filter-*` result or from the user.
|
|
272
78
|
|
|
273
|
-
|
|
79
|
+
## Completion Output
|
|
274
80
|
|
|
275
|
-
|
|
276
|
-
- [`references/investigation-playbook-guide.md`](references/investigation-playbook-guide.md) — Step-by-step playbooks for common investigation scenarios
|
|
81
|
+
Close with the answer, the window queried, the active organization and tenant, and the filters applied. For `filter-*` results, say whether every page was retrieved. For permission-limited or empty results, state what the result does and does not prove.
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
# Filter Discovery Commands
|
|
2
|
+
|
|
3
|
+
The `filter-*` commands list folders, processes, queues, and machines with recent Insights activity. Use them to resolve an exact scope before a Jobs request. They do not filter Jobs output.
|
|
4
|
+
|
|
5
|
+
Pass the returned values to `jobs` commands: `FolderKey` to `--folder-key`, `ProcessName` to `--process-name`, `MachineName` to `--machine-name`. There is no key-based flag for processes or machines, and `jobs` has no queue filter at all. Every `jobs` command also needs a time range, which these commands do not supply; see [`jobs-commands-guide.md`](jobs-commands-guide.md).
|
|
6
|
+
|
|
7
|
+
Keys inside `Data` are PascalCase on the wire. Read `FolderKey`, not `folderKey`.
|
|
8
|
+
|
|
9
|
+
## Shared Options
|
|
10
|
+
|
|
11
|
+
```text
|
|
12
|
+
--limit <number> Rows to return, 1 to 10000 (default 50)
|
|
13
|
+
--offset <number> Rows to skip before returning results (default 0)
|
|
14
|
+
--output <format> Output format: table, json, yaml, plain (always use json)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Rules
|
|
18
|
+
|
|
19
|
+
1. **No time flags.** `--time-range`, `--started-after`, and `--started-before` are rejected as unknown options. Do not add them.
|
|
20
|
+
2. **The 30-day window is fixed.** The backend applies a recent-activity window the caller cannot change. A resource idle for longer than 30 days is absent from every result.
|
|
21
|
+
3. **`--limit` and `--offset` page the CLI's own copy of the list, not the backend's.** `--limit` defaults to 50, so a 50-row result is a full page rather than a complete list. Read `Pagination.Total` and `Pagination.HasMore` to tell the difference.
|
|
22
|
+
4. **Results are permission-bounded.** Folders, processes, and queues are limited to folders the caller can access. Machines are tenant-wide.
|
|
23
|
+
|
|
24
|
+
## Errors
|
|
25
|
+
|
|
26
|
+
`filter-*` failures use three `Result` values. Branch on `Result`, not on `ErrorCode` alone.
|
|
27
|
+
|
|
28
|
+
| `Result` | `ErrorCode` | Exit | Cause |
|
|
29
|
+
|---|---|---|---|
|
|
30
|
+
| `ValidationError` | `invalid_argument` | 3 | A flag the command does not accept, or a bad value. Commander rejects it before the command runs |
|
|
31
|
+
| `AuthenticationError` | `authentication_required` | 2 | 401, or no usable session before any request is sent |
|
|
32
|
+
| `Failure` | `permission_denied` | 1 | 403. The caller has no permission on the folders in scope |
|
|
33
|
+
| `Failure` | `rate_limited` | 1 | 429. Report it and stop |
|
|
34
|
+
| `Failure` | `server_error` | 1 | 5xx backend fault |
|
|
35
|
+
| `Failure` | `network_error` | 1 | DNS, socket, proxy, or TLS failure |
|
|
36
|
+
| `Failure` | `unknown_error` | 1 | A malformed or misaligned response from the service |
|
|
37
|
+
|
|
38
|
+
Every failure also carries `Retry`; branch on it as described in SKILL.md Critical Rule 8.
|
|
39
|
+
|
|
40
|
+
## Commands
|
|
41
|
+
|
|
42
|
+
### filter-folders list
|
|
43
|
+
|
|
44
|
+
List folders with recent Insights activity that are visible to the current caller.
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
uip insights filter-folders list --output json
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
**Key Data fields:** `FolderName`, `FolderKey`
|
|
51
|
+
|
|
52
|
+
**Use when:** User asks which folders have recent activity, or a Jobs request needs an exact folder key.
|
|
53
|
+
|
|
54
|
+
### filter-processes list
|
|
55
|
+
|
|
56
|
+
List processes with recent Insights activity in visible folders.
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
uip insights filter-processes list --output json
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
**Key Data fields:** `ProcessName`, `FolderKey`
|
|
63
|
+
|
|
64
|
+
**Use when:** User asks which processes are active, or a Jobs request needs the exact process name and folder pairing.
|
|
65
|
+
|
|
66
|
+
### filter-queues list
|
|
67
|
+
|
|
68
|
+
List queues with recent Insights activity in visible folders.
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
uip insights filter-queues list --output json
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
**Key Data fields:** `QueueName`, `FolderKey`
|
|
75
|
+
|
|
76
|
+
**Use when:** User needs an exact queue and folder pairing for scope discovery. Do not present the output as queue item metrics.
|
|
77
|
+
|
|
78
|
+
### filter-machines list
|
|
79
|
+
|
|
80
|
+
List machines with recent Insights activity, tenant-wide.
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
uip insights filter-machines list --output json
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
**Key Data fields:** `MachineName`, `MachineKey`
|
|
87
|
+
|
|
88
|
+
**Use when:** User asks which machines recently reported activity, or a Jobs request needs an exact machine name.
|
|
89
|
+
|
|
90
|
+
## Discovery Workflow
|
|
91
|
+
|
|
92
|
+
1. Run the matching `filter-*` command.
|
|
93
|
+
2. If `Pagination.HasMore` is true, either raise `--limit` to fetch the remainder in one call, or page with `--offset` in separate invocations. One invocation per page, no shell loop and no variables:
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
uip insights filter-folders list --limit 10000 --output json # whole list in one call
|
|
97
|
+
uip insights filter-folders list --limit 50 --offset 50 --output json # or page
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
When paging, stop once `HasMore` is false, or after ten pages. If rows remain after ten pages, report how many were retrieved and that more exist.
|
|
101
|
+
3. Match the user's words against the returned name fields.
|
|
102
|
+
4. If one row matches, use its exact name or key.
|
|
103
|
+
5. If several rows match, ask the user to choose.
|
|
104
|
+
6. If no row matches across all pages, report that no visible candidate had activity in the last 30 days. Do not report that the resource does not exist.
|
|
105
|
+
|
|
106
|
+
For a folder that may exist without recent Insights activity, hand off to `uipath-platform` for the full visible Orchestrator inventory (`uip or folders list --output json`). The folder key is the `Key` field there, not `FolderKey`.
|
|
@@ -10,12 +10,13 @@ User asks about overall automation health, success rates, or general status.
|
|
|
10
10
|
# Step 1: Get the summary KPIs
|
|
11
11
|
uip insights jobs summary --time-range 1440 --output json
|
|
12
12
|
|
|
13
|
-
# Step 2: Interpret the results
|
|
14
|
-
# -
|
|
15
|
-
# -
|
|
16
|
-
# -
|
|
13
|
+
# Step 2: Interpret the results (Data keys are PascalCase)
|
|
14
|
+
# - JobsCount: total jobs in the time window
|
|
15
|
+
# - SuccessfulJobsCount: jobs that completed successfully
|
|
16
|
+
# - AverageProcessingTime: mean execution time. The CLI passes this through
|
|
17
|
+
# unchanged and does not label a unit, so do not state one to the user.
|
|
17
18
|
#
|
|
18
|
-
# Failure rate = (
|
|
19
|
+
# Failure rate = (JobsCount - SuccessfulJobsCount) / JobsCount * 100
|
|
19
20
|
#
|
|
20
21
|
# Thresholds (rules of thumb):
|
|
21
22
|
# < 5% failure rate → healthy
|
|
@@ -86,18 +87,20 @@ uip insights jobs process-details --time-range 1440 --output json
|
|
|
86
87
|
|
|
87
88
|
User wants to see if things are getting better or worse.
|
|
88
89
|
|
|
90
|
+
Resolve both week boundaries to epoch milliseconds first, with the platform-specific `date` recipes under Absolute Time Ranges in [`jobs-commands-guide.md`](jobs-commands-guide.md). Treat `--started-before` as exclusive: pass this Monday 00:00:00 UTC as the upper bound so the window covers all of last week.
|
|
91
|
+
|
|
89
92
|
```bash
|
|
90
93
|
# This week (last 7 days)
|
|
91
94
|
uip insights jobs summary --time-range 10080 --output json
|
|
92
95
|
|
|
93
|
-
#
|
|
94
|
-
#
|
|
96
|
+
# Last week: absolute boundaries, resolved per Absolute Time Ranges
|
|
97
|
+
# in jobs-commands-guide.md, passed as literal numbers
|
|
95
98
|
uip insights jobs summary \
|
|
96
99
|
--started-after <last-monday-epoch-ms> \
|
|
97
100
|
--started-before <this-monday-epoch-ms> \
|
|
98
101
|
--output json
|
|
99
102
|
|
|
100
|
-
# Compare
|
|
103
|
+
# Compare JobsCount, SuccessfulJobsCount, and AverageProcessingTime
|
|
101
104
|
# between the two results
|
|
102
105
|
```
|
|
103
106
|
|
|
@@ -105,27 +108,32 @@ uip insights jobs summary \
|
|
|
105
108
|
|
|
106
109
|
User asks about a specific Orchestrator folder.
|
|
107
110
|
|
|
111
|
+
Follow [`filter-discovery-guide.md`](filter-discovery-guide.md) for pagination, exact-match handling, and the limits of the 30-day activity window.
|
|
112
|
+
|
|
108
113
|
```bash
|
|
109
|
-
# Step 1: Find the folder key
|
|
110
|
-
uip
|
|
111
|
-
# Look for the folder's Key (GUID) in the output
|
|
114
|
+
# Step 1: Find the folder key
|
|
115
|
+
uip insights filter-folders list --output json
|
|
112
116
|
|
|
113
117
|
# Step 2: Query insights with folder filter
|
|
114
118
|
uip insights jobs summary --time-range 1440 \
|
|
115
|
-
--folder-key "
|
|
119
|
+
--folder-key "<FOLDER_KEY_FROM_STEP_1>" --output json
|
|
116
120
|
|
|
117
121
|
uip insights jobs top-failures --time-range 1440 \
|
|
118
|
-
--folder-key "
|
|
122
|
+
--folder-key "<FOLDER_KEY_FROM_STEP_1>" --output json
|
|
119
123
|
```
|
|
120
124
|
|
|
125
|
+
A folder with no recent Insights activity will not appear. Hand off to `uipath-platform` for the full visible inventory.
|
|
126
|
+
|
|
127
|
+
To scope by several folders or processes at once, repeat the flag once per value; see the repeatable-options rule in [`jobs-commands-guide.md`](jobs-commands-guide.md).
|
|
128
|
+
|
|
121
129
|
## Interpreting Array Data
|
|
122
130
|
|
|
123
131
|
Several endpoints return parallel arrays. The same index across arrays corresponds to the same entity:
|
|
124
132
|
|
|
125
133
|
```json
|
|
126
134
|
{
|
|
127
|
-
"
|
|
128
|
-
"
|
|
135
|
+
"ProcessName": ["ProcessA", "ProcessB", "ProcessC"],
|
|
136
|
+
"JobCountByTime": [[10, 5, 2]]
|
|
129
137
|
}
|
|
130
138
|
```
|
|
131
139
|
|
|
@@ -141,5 +149,5 @@ This means:
|
|
|
141
149
|
| User wants to start/stop/restart a specific job | `uipath-platform` (`uip or jobs start`) |
|
|
142
150
|
| User wants to read the logs of a failed job | `uipath-platform` (`uip or jobs logs`) |
|
|
143
151
|
| User wants to debug why a specific job error happened | `uipath-troubleshoot` |
|
|
144
|
-
| User wants to find a folder key to filter by | `
|
|
152
|
+
| User wants to find a folder key to filter by | `uip insights filter-folders list` (see [`filter-discovery-guide.md`](filter-discovery-guide.md)) |
|
|
145
153
|
| User wants to fix the code that's causing failures | `uipath-rpa` or `uipath-agents` |
|