@uipath/skills 1.195.0

package/skills/uipath-platform/references/licensing/consumables-report.md

@@ -0,0 +1,217 @@
+# Consumables Report
+
+Report consumption of consumable license units (`AIU`, `AGU`, `RU`, `PLTU`, `HEAL`, `SPR`, `LU`, etc.) across the organization. Three report shapes: account-wide summary, daily breakdown by service, folder breakdown.
+
+> For full option details, run `uip platform licenses consumables get --help`.
+
+---
+
+## When to Use
+
+- Monthly chargeback / cost-allocation reporting per tenant
+- Capacity planning: confirm allocated vs consumed before bundle renewal
+- Drill into which folders are driving consumption of a specific unit (`folders` mode)
+- Daily trend analysis for a specific tenant × unit (`daily` mode)
+- Compare consumption across tenant pool vs overflow into org pool
+
+## Prerequisites
+
+1. Authenticated: `uip login`
+2. Org admin permissions to read account product allocations
+3. For `daily` / `folders` modes: know the target tenant name and consumable unit code
+
+---
+
+## Modes
+
+| Mode | Scope | Required Flags | Output |
+|------|-------|----------------|--------|
+| `summary` (default) | All active consumables × all tenants (or one tenant if `--tenant`) | None | One row per consumable × tenant; allocation + pool consumption columns |
+| `daily` | One tenant × one unit, day-by-day | `--tenant`, `--unit`, `--start-date`, `--end-date` | One row per (date, service) |
+| `folders` | One tenant × one unit, broken down by folder | `--tenant`, `--unit`, `--start-date`, `--end-date` | One row per folder |
+
+---
+
+## Mode 1: Summary
+
+Default mode. Iterates every active consumable in the account.
+
+```bash
+# All consumables, all tenants, each consumable's bundle window
+uip platform licenses consumables get --output json
+
+# Scope to one tenant
+uip platform licenses consumables get --tenant "<TENANT_NAME>" --output json
+
+# Override every consumable's window with a custom date range
+uip platform licenses consumables get \
+  --start-date 2026-04-01 --end-date 2026-04-30 --output json
+```
+
+```json
+{
+  "Result": "Success",
+  "Code": "LicensesConsumablesSummary",
+  "Data": [
+    {
+      "code": "AIU",
+      "name": "AI Units",
+      "totalUnitsInAccount": 5000,
+      "allocated": 1200,
+      "consumedFromOrgWithoutTenant": 30,
+      "startDate": "2023-11-14T22:13:20.000Z",
+      "endDate": "2027-09-15T18:40:00.000Z",
+      "tenantId": "296b7134-6691-43db-b48a-2d95ed3ab031",
+      "tenantName": "default",
+      "consumedFromTenantPool": 800,
+      "consumedFromOrgPool": 150
+    }
+  ]
+}
+```
+
+Field reference:
+
+| Field | Meaning |
+|-------|---------|
+| `code` / `name` | Product code and friendly name |
+| `totalUnitsInAccount` | Account purchase total for this consumable |
+| `allocated` | Account-level allocation |
+| `consumedFromOrgWithoutTenant` | Consumption not attributable to any tenant (zero when `--tenant` is set) |
+| `startDate` / `endDate` | Window in effect — bundle window by default, override range if `--start-date`/`--end-date` provided |
+| `tenantId` / `tenantName` | Per-tenant breakdown |
+| `consumedFromTenantPool` | Drawn from the tenant's reserved allocation |
+| `consumedFromOrgPool` | Drawn from the remaining account pool (overflow) |
+
+Row-shape rules:
+- **No `--tenant`, consumption across multiple tenants**: one row per (consumable, tenant)
+- **No `--tenant`, no tenant consumption**: single row per consumable with `tenantId: null`, `tenantName: ""`, and pool columns zeroed; `consumedFromOrgWithoutTenant` may be non-zero
+- **With `--tenant`**: one row per consumable for that tenant. Consumables with zero tenant activity still appear with zeroed pool columns
+
+## Mode 2: Daily Breakdown
+
+```bash
+uip platform licenses consumables get \
+  --mode daily \
+  --tenant "<TENANT_NAME>" \
+  --unit AIU \
+  --start-date 2026-04-01 \
+  --end-date 2026-04-30 \
+  --output json
+```
+
+```json
+{
+  "Result": "Success",
+  "Code": "LicensesConsumablesDaily",
+  "Data": [
+    {
+      "code": "AIU",
+      "name": "AI Units",
+      "tenantId": "296b7134-6691-43db-b48a-2d95ed3ab031",
+      "tenantName": "default",
+      "date": "2026-04-15",
+      "service": "orchestrator",
+      "consumedAmount": 24
+    }
+  ]
+}
+```
+
+`date` is `YYYY-MM-DD`. One row per (date, service) inside the range. `service` is the service that emitted the consumption (e.g., `orchestrator`, `aicenter`, `dataservice`).
+
+## Mode 3: Folder Breakdown
+
+```bash
+uip platform licenses consumables get \
+  --mode folders \
+  --tenant "<TENANT_NAME>" \
+  --unit AIU \
+  --start-date 2026-04-01 \
+  --end-date 2026-04-30 \
+  --output json
+```
+
+```json
+{
+  "Result": "Success",
+  "Code": "LicensesConsumablesFolders",
+  "Data": [
+    {
+      "code": "AIU",
+      "name": "AI Units",
+      "tenantId": "296b7134-6691-43db-b48a-2d95ed3ab031",
+      "tenantName": "default",
+      "folderKey": "11111111-1111-1111-1111-111111111111",
+      "folderName": "Shared",
+      "parentFolderKey": null,
+      "consumedBySelf": 42,
+      "processCountSelf": 3
+    }
+  ]
+}
+```
+
+| Field | Meaning |
+|-------|---------|
+| `folderKey` / `folderName` | Folder GUID and display name |
+| `parentFolderKey` | Parent GUID for nested folders; `null` at the root |
+| `consumedBySelf` | Consumption attributed to this folder only — does not include descendants |
+| `processCountSelf` | Distinct processes in this folder that contributed |
+
+Aggregate descendants client-side if needed — the API returns per-folder rows only.
+
+---
+
+## Flag Reference
+
+| Flag | Required In | Default | Notes |
+|------|-------------|---------|-------|
+| `--mode <summary\|daily\|folders>` | All modes | `summary` | Determines output shape |
+| `--tenant <name>` | `daily`, `folders` | All tenants | Matched by exact tenant name |
+| `--unit <code>` | `daily`, `folders` | All consumables | Case-insensitive product code (`AIU`, `aiu`, `Aiu` all match) |
+| `--start-date <iso>` | `daily`, `folders` | Bundle window | ISO 8601 (e.g., `2026-04-01` or `2026-04-01T00:00:00Z`) |
+| `--end-date <iso>` | `daily`, `folders` | Bundle window | ISO 8601, must be strictly after `--start-date` |
+
+Date range rules:
+- `--start-date` and `--end-date` must be passed together; passing only one is rejected
+- Both must parse as valid ISO 8601
+- `startDate >= endDate` is rejected
+- In `summary` mode, the range overrides each consumable's own bundle window
+- In `daily` / `folders` modes, the range is required
+
+---
+
+## Error Conditions
+
+| Error | Cause | Resolution |
+|-------|-------|------------|
+| `Invalid --mode '<value>'.` | Mode is not summary/daily/folders | Use one of the three allowed values |
+| `--mode daily requires: --tenant, --unit, --start-date, --end-date.` | Missing required flag(s) for the mode | Pass all four |
+| `--start-date and --end-date must be provided together.` | Only one of the pair was supplied | Pass both, or omit both |
+| `Invalid --start-date: '<value>'.` | Date doesn't parse as ISO 8601 | Use `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ` |
+| `--start-date must be strictly before --end-date.` | Range is empty or inverted | Provide a non-empty forward range |
+| `Tenant '<name>' not found in the current organization.` | No tenant with that exact name | Check spelling against `uip login tenant list`; available tenants are listed in the error |
+| `Unit '<code>' is not an active consumable in this organization.` | Code is not a consumable, or its bundle window is not currently active | Error lists available codes; pick one of those |
+
+---
+
+## Gotchas
+
+- **`summary` reports every active consumable.** It is potentially heavy on large accounts — scope with `--tenant` or `--unit` when iterating.
+- **Bundle window vs override.** With no `--start-date`/`--end-date`, every consumable in the summary uses its own window — rows can have different date ranges. The override applies the same range to all rows.
+- **`consumedFromOrgWithoutTenant` is zero under `--tenant`.** The CLI suppresses cross-tenant pool numbers when scoped to a single tenant; only `consumedFromTenantPool` and `consumedFromOrgPool` are populated.
+- **`consumedAmount` and `consumedBySelf` are point-in-time totals over the requested range** — not running totals. Re-running the same query later returns the same value once the window has closed.
+- **`--unit` is case-insensitive**, but other code references (`tenant licenses set`) are exact-case — don't carry the assumption.
+- **No pagination.** `daily` and `folders` modes return all rows in one response. For very large windows or folder counts, consider narrower ranges.
+- **`folders` mode is non-recursive.** `consumedBySelf` excludes child folders. Reconstruct the tree yourself if you need rolled-up totals.
+- **`PLTU` is dual-purpose.** It appears in both runtime allocation (`tenants licenses get`) and consumables reporting. Same code, different reporting axes.
+
+---
+
+## Related
+
+- [Licensing hub](licensing.md) — concepts, product code table, REST fallback
+- [Tenant Allocations](tenant-allocations.md) — set the allocations these reports consume from
+- [User & Group Licenses](user-licenses-allocations.md) — user-bundle allocation (separate license type)
+- [Full CLI command reference](../uip-commands.md)

package/skills/uipath-platform/references/licensing/licensing.md

@@ -0,0 +1,103 @@
+# Licensing (`uip platform`)
+
+Manage UiPath organization licensing — tenant allocations, user/group bundle assignments, and consumables reporting.
+
+> For full option details on any command, use `--help` (e.g., `uip platform tenants licenses get --help`).
+
+---
+
+## Common Flags
+
+All `uip platform` licensing commands share a set of cross-cutting options:
+
+| Flag | Scope | Purpose |
+|------|-------|---------|
+| `--organization <account-id>` | All commands | Override org account GUID. Defaults to org from current login. |
+| `--output json` | All commands | Emit structured JSON. Always use when parsing programmatically. |
+| `--input <path>` | `set` commands | Path to JSON file with the desired allocation. Body shape differs per command — see each workflow doc. |
+| `--limit <n>` | `groups rules` list commands | Max results to return (default 50). |
+| `--offset <n>` | `groups rules` list commands | Results to skip (default 0). |
+| `--sort-by <field>` | `groups rules` list commands | Sort field (e.g. `name`). |
+| `--sort-order <Asc\|Desc>` | `groups rules` list commands | Sort direction. Exact strings `Asc` or `Desc` (case-sensitive). |
+
+**Response envelope.** All commands emit `{Result, Code, Data, ...}`. `Code` identifies the payload (`TenantLicenses`, `UserLicensesSet`, `GroupRules`, `LicensesConsumablesSummary`, etc.). Paginated commands add a `Pagination` block — increment `--offset` by `--limit` until `Returned < Limit`.
+
+---
+
+## Workflow References
+
+| Workflow | File | Covers |
+|----------|------|--------|
+| Tenant Allocations | [tenant-allocations.md](tenant-allocations.md) | `tenants licenses get/set` — allocate license units to tenant pools |
+| User & Group Licenses | [user-licenses-allocations.md](user-licenses-allocations.md) | `users licenses get/set/available`, `groups rules get/details/set` — assign bundles directly or via group rules |
+| Consumables Report | [consumables-report.md](consumables-report.md) | `licenses consumables get --mode {summary,daily,folders}` — consumption reporting |
+
+---
+
+## Key Concepts
+
+### License Hierarchy
+
+```
+Account (organization)
+  +-- Total units in account (purchased pool)
+        +-- Tenant allocations         Reserved per tenant from account pool
+        |     +-- Tenant pool consumption    Jobs consume from tenant reservation
+        |     +-- Org pool consumption       Jobs overflow to remaining account pool
+        +-- User bundles               Per-seat licenses (RPA Developer, Attended, etc.)
+              +-- Direct assignment    Allocated to a specific user
+              +-- Group rule lease     Inherited from a group rule with optional quota
+```
+
+Tenant allocations and user bundles are **separate license types**. A tenant runs unattended jobs against its runtime allocation (`UNATT`, `RU`, `PLTU`); a developer uses a user-bundle license (`RPADEVPRONU`) to log into Studio.
+
+### Product Codes
+
+Product codes are the SKU identifier used everywhere in the CLI. The `friendlyName()` helper maps them to readable names:
+
+| Code | Friendly Name | Type |
+|------|---------------|------|
+| `RU` | Robot Units | Runtime |
+| `AIU` | AI Units | Consumable |
+| `AGU` | Agent Units | Consumable |
+| `PLTU` | Platform Units | Runtime/consumable |
+| `TEU` | Test Execution Units | Runtime |
+| `UNATT` | Unattended Robot | Runtime |
+| `UNATT-HOSTING` | Unattended Hosting Robot | Runtime |
+| `NONPR` | NonProduction Robot | Runtime |
+| `TAUNATT` | Test Automation Unattended Robot | Runtime |
+| `APPTESTR` | App Test Robot | Runtime |
+| `HEAL` / `HEALTEST` | Heals / Test Heals | Consumable |
+| `SPR` | ScreenPlay Runs | Consumable |
+| `FCCU` | Financial Crimes Units | Consumable |
+| `MRSU` | Medical Record Summarization Units | Consumable |
+| `LU` | Lending Units | Consumable |
+| `DSU` | Data Service Units | Consumable |
+| `PERFTEST` / `PERFTEST-RUNTIME` | Performance Testing | Runtime |
+
+User-bundle codes (e.g., `RPADEVPRONU`, `ATTUNU`, `TSTNU`) are not in the `friendlyName` table — they pass through unchanged.
+
+Unknown codes are returned verbatim; this is not an error.
+
+### Behavior Details
+
+Each concept is covered authoritatively in the linked workflow guide:
+
+- **Lease source: direct vs group** — `users licenses get` tags each row with `source`. See [user-licenses-allocations.md](user-licenses-allocations.md).
+- **Quotas in group rules** — `groups rules set` accepts optional `quota` per entry. See [user-licenses-allocations.md](user-licenses-allocations.md).
+- **Bundle window vs custom date range** — each consumable has its own window; `--start-date`/`--end-date` overrides. See [consumables-report.md](consumables-report.md).
+- **Idempotent tenant allocation** — `tenants licenses set` is an overlay, not a delta. See [tenant-allocations.md](tenant-allocations.md).
+
+---
+
+## REST API Fallback
+
+When the CLI does not cover an operation, use the License Resource Manager / License Accountant APIs directly with a stored token from `~/.uipath/.auth`. See [orchestrator.md - REST API](../orchestrator/orchestrator.md) for the auth pattern.
+
+---
+
+## Related
+
+- **Orchestrator licenses** — `uip or licenses` covers Orchestrator-scoped license toggles (license slots assigned to user/robot pairs in folders). See [Setup Environment](../orchestrator/setup-environment.md).
+- **Tenant settings** — `uip or settings` covers tenant operational settings (timezone, alerts, trigger behavior), not licensing. See [Tenant Admin](../orchestrator/tenant-admin.md).
+- **Full CLI command reference** — [uip-commands.md](../uip-commands.md)

package/skills/uipath-platform/references/licensing/tenant-allocations.md

@@ -0,0 +1,152 @@
+# Tenant License Allocations
+
+Allocate license units (`UNATT`, `RU`, `PLTU`, `NONPR`, etc.) from the account pool to specific tenants, and inspect what each tenant currently has reserved and consumed.
+
+> For full option details, run `uip platform tenants licenses get --help` or `... set --help`.
+
+---
+
+## When to Use
+
+- Provisioning a new tenant with a runtime allocation (e.g., 5 Unattended Robots)
+- Rebalancing licenses across tenants (move 10 RU from dev to prod)
+- Auditing per-tenant `allocated` vs `consumed` to find under- or over-provisioned tenants
+- Scripting CI/CD pipeline that bumps tenant capacity before a load test
+
+## Prerequisites
+
+1. Authenticated: `uip login`
+2. Org admin permissions to allocate licenses
+3. Tenant key (GUID) of the target tenant — discover with `uip or settings list --tenant <name>` or the Automation Cloud portal
+
+---
+
+## Commands
+
+| Command | What it does |
+|---------|--------------|
+| `uip platform tenants licenses get <tenant-key>` | Read current allocation, availability, and consumption per product code |
+| `uip platform tenants licenses set <tenant-key> --input <path>` | Overlay per-product quantities onto the tenant's existing service licenses |
+
+---
+
+## Step 1: Inspect Current Allocation
+
+```bash
+uip platform tenants licenses get <TENANT_KEY> --output json
+```
+
+Returns one row per product currently in an active interval (current time falls between `startDate` and `endDate`):
+
+```json
+{
+  "Result": "Success",
+  "Code": "TenantLicenses",
+  "Data": [
+    {
+      "code": "PLTU",
+      "name": "Platform Units",
+      "allocated": 300,
+      "availableForAllocation": 4700,
+      "allocatedAcrossOtherTenants": 0,
+      "totalUnitsInAccount": 5000,
+      "consumed": 50,
+      "startDate": "2023-11-14T22:13:20.000Z",
+      "endDate": "2027-09-15T18:40:00.000Z"
+    }
+  ]
+}
+```
+
+Field reference:
+
+| Field | Meaning |
+|-------|---------|
+| `allocated` | Units currently reserved for this tenant |
+| `availableForAllocation` | Units still free in the account pool (could be moved to this or any tenant) |
+| `allocatedAcrossOtherTenants` | Units reserved for other tenants |
+| `totalUnitsInAccount` | Account purchase total. Equals `allocated + availableForAllocation + allocatedAcrossOtherTenants` |
+| `consumed` | Units actually used by running jobs (subset of `allocated`) |
+| `startDate` / `endDate` | Bundle window in ISO 8601 |
+
+## Step 2: Prepare the Input File
+
+Create a JSON array of product entries with absolute target quantities:
+
+```json
+[
+  {"code": "UNATT", "quantity": 10},
+  {"code": "PLTU", "quantity": 500}
+]
+```
+
+Validation rules:
+- `code` must be a non-empty string
+- `quantity` must be a finite, non-negative number (zero is allowed — sets the allocation to zero)
+- Each `code` must already exist on the tenant's current service licenses (cannot introduce new product codes)
+
+## Step 3: Apply the Allocation
+
+```bash
+uip platform tenants licenses set <TENANT_KEY> --input ./delta.json --output json
+```
+
+Overlay semantics (`mergeProducts`):
+1. CLI reads the tenant's current per-service allocation
+2. For each input entry, the listed `quantity` replaces the current value for that `code`
+3. Codes already on the tenant but **not** in the input keep their current quantity
+4. The CLI auto-routes each code to the service license that owns it (orchestrator, dataservice, etc.)
+5. Re-running the same input is idempotent — safe to retry
+
+Returns one row per product per touched service license:
+
+```json
+{
+  "Result": "Success",
+  "Code": "TenantLicensesSet",
+  "Data": [
+    {"serviceType": "orchestrator", "code": "UNATT", "name": "Unattended Robot", "quantity": 10},
+    {"serviceType": "orchestrator", "code": "PLTU", "name": "Platform Units", "quantity": 500}
+  ]
+}
+```
+
+## Step 4: Verify
+
+Re-run `get` and confirm the new `allocated` values match the input.
+
+```bash
+uip platform tenants licenses get <TENANT_KEY> --output json
+```
+
+---
+
+## Error Conditions
+
+| Error | Cause | Resolution |
+|-------|-------|------------|
+| `No service licenses found for tenant '<key>'` | Wrong tenant GUID, or tenant has no provisioned services | Verify the tenant key against `uip or` or the portal |
+| `Cannot route product code(s) for tenant '<key>': <code>` | The product code is not already present on this tenant's service licenses | The CLI cannot introduce new codes. Use the UiPath portal to add the SKU first, then re-run `set` |
+| `Ambiguous routing for tenant '<key>': '<code>' (matches service types: ...)` | Same code exists on more than one of the tenant's service licenses | Resolve the duplicate allocation in the portal or via support, then retry |
+| `Invalid input JSON. "quantity" must be a finite, non-negative number.` | Bad input file | Fix the JSON; `quantity` must be ≥ 0 |
+| `Error connecting to the License Resource Manager.` | Auth expired or network issue | Re-run `uip login` |
+
+---
+
+## Gotchas
+
+- **`quantity` is absolute, not delta.** `{"code":"UNATT","quantity":5}` sets the tenant to 5 — it does not add 5 to the current value. Read `get` first to know the starting point.
+- **Codes are overlay, not replace.** A product already on the tenant but missing from the input keeps its current quantity. To zero out a code, include it explicitly with `quantity: 0`.
+- **Cannot add new product codes.** If a tenant doesn't have `AIU` on its service licenses, you cannot introduce it via `set`. Provision the SKU through the portal first.
+- **`availableForAllocation: 0`** means the account pool is exhausted. To allocate more to this tenant, first reduce another tenant's allocation or purchase additional units.
+- **`consumed` lags real-time.** It reflects accountant-side aggregation; expect minutes of delay after a job completes.
+- **Bundle window matters.** `get` filters out products outside the currently active interval — an expired bundle won't appear even if `allocated > 0` historically.
+
+---
+
+## Related
+
+- [Licensing hub](licensing.md) — concepts, product code table, REST fallback
+- [User & Group Licenses](user-licenses-allocations.md) — per-user/group bundle assignment (separate from tenant allocation)
+- [Consumables Report](consumables-report.md) — track consumption drawn from tenant pools
+- [Setup Environment](../orchestrator/setup-environment.md) — `uip or licenses toggle` for Orchestrator-scoped slot assignment