@uipath/skills 1.195.0

package/skills/uipath-platform/references/resources/manage-assets.md

@@ -0,0 +1,277 @@
+# Manage Assets
+
+Create configuration assets, share them across folders, and manage credential rotation.
+
+> For full option details on any command, use `--help` (e.g., `uip resource assets create --help`).
+
+## When to Use
+
+- Setting up environment configuration (API URLs, feature flags, retry counts)
+- Managing secrets and credentials used by automations at runtime
+- Sharing configuration across multiple folders/teams
+- Rotating credentials without redeploying processes
+
+## Prerequisites
+
+- Authenticated (`uip login`)
+- Target folder exists (see [setup-environment.md](../orchestrator/setup-environment.md))
+- For Credential/Secret types: a credential store must exist (`uip or credential-stores list`)
+
+## Flow
+
+```mermaid
+graph LR
+    A[assets create] --> B[assets list]
+    B --> C[assets get]
+    B --> D[assets get-asset-value]
+    A --> E[assets share]
+    E --> F[assets get-folders]
+    F --> G[assets unshare]
+    A --> H[assets update]
+    H --> I[assets delete]
+```
+
+---
+
+## Step 1: Create Assets
+
+Create a named configuration value in a folder. Type defaults to Text.
+
+```bash
+uip resource assets create "ApiBaseUrl" "https://api.example.com" \
+  --folder-path "Finance" --type Text --output json
+
+uip resource assets create "MaxRetries" "3" \
+  --folder-path "Finance" --type Integer --output json
+
+uip resource assets create "FeatureEnabled" "true" \
+  --folder-path "Finance" --type Bool --output json
+```
+
+Key options:
+
+| Option | Description |
+|--------|-------------|
+| `--type <type>` | `Text` (default), `Bool`, `Integer`, `Credential`, `Secret` |
+| `--scope <scope>` | `Global` (default) or `PerRobot` |
+| `--description <text>` | Human-readable description |
+| `--tags <csv>` | Comma-separated tag names |
+| `--has-default` | Asset has a default value (default: true) |
+| `--credential-store-key <key>` | Required for Credential and Secret types |
+
+For Credential and Secret types, you must provide `--credential-store-key`:
+
+```bash
+uip resource assets create "DbPassword" "s3cret-value" \
+  --folder-path "Finance" --type Secret \
+  --credential-store-key <store-key> --output json
+
+uip resource assets create "ServiceAccount" "svc-user:p@ssw0rd" \
+  --folder-path "Finance" --type Credential \
+  --credential-store-key <store-key> --output json
+```
+
+## Step 2: List Assets
+
+List assets in a folder. Requires `--folder-path` or `--folder-key`.
+
+```bash
+uip resource assets list --folder-path "Finance" --output json
+
+# Filter by name (contains match)
+uip resource assets list --folder-path "Finance" --name "Api" --output json
+
+# Filter by type
+uip resource assets list --folder-path "Finance" --type Secret --output json
+```
+
+If the user already gives a folder name or path, pass it directly as
+`--folder-path`; do not call `uip or folders list` just to validate it. Stop
+after the `assets list --name ... --folder-path ... --output json` result if
+the asset is not present.
+
+## Step 3: Get Asset Details
+
+Get full asset metadata by key. Cross-folder -- no `--folder-path` needed.
+
+```bash
+uip resource assets get <asset-key> --output json
+```
+
+**Note:** Credential and secret values are NOT returned by `get`. Use `get-asset-value` to retrieve decrypted values.
+
+## Step 4: Get Asset Value
+
+Returns the decrypted asset value for the current user. Requires `--folder-path` or `--folder-key`.
+
+```bash
+uip resource assets get-asset-value <asset-key> \
+  --folder-path "Finance" --output json
+```
+
+This is the only way to retrieve credential/secret values from the CLI. The response includes the resolved value based on the current user's context (relevant for PerRobot-scoped assets).
+
+## Step 5: Update Asset
+
+Update an existing asset's value, type, scope, or metadata. Cross-folder -- no `--folder-path` needed.
+
+```bash
+# Update value
+uip resource assets update <asset-key> "https://api-v2.example.com" --output json
+
+# Update description and tags
+uip resource assets update <asset-key> --description "Updated endpoint" \
+  --tags "production,api" --output json
+
+# Change scope
+uip resource assets update <asset-key> --scope PerRobot --output json
+```
+
+Only provided fields are changed -- omitted fields keep their current values.
+
+## Step 6: Share Asset with Another Folder
+
+Make an asset accessible in an additional folder:
+
+```bash
+uip resource assets share <asset-key> --folder-path "Production" --output json
+```
+
+## Step 7: Check Where Shared
+
+List all folders where the asset is currently accessible:
+
+```bash
+uip resource assets get-folders <asset-key> --output json
+```
+
+Returns `accessibleFolders` (array of folders you can see) and `totalFoldersCount` (total, including folders you lack permission to view).
+
+## Step 8: Unshare
+
+Remove the asset from a folder:
+
+```bash
+uip resource assets unshare <asset-key> --folder-path "Production" --output json
+```
+
+## Step 9: Delete
+
+Delete the asset entirely. Cross-folder -- no `--folder-path` needed.
+
+```bash
+uip resource assets delete <asset-key> --output json
+```
+
+---
+
+## Credential Rotation Pattern
+
+Rotate a secret without downtime:
+
+```bash
+# 1. Create the replacement secret
+uip resource assets create "DbPassword-v2" "new-s3cret" \
+  --folder-path "Finance" --type Secret \
+  --credential-store-key <store-key> --output json
+
+# 2. Share with all folders that use it
+uip resource assets share <new-key> --folder-path "Production" --output json
+
+# 3. Update consuming processes to reference the new asset name
+#    (or update the original asset in-place if the name must stay the same)
+uip resource assets update <original-key> "new-s3cret" --output json
+
+# 4. Verify the new value resolves correctly
+uip resource assets get-asset-value <asset-key> \
+  --folder-path "Finance" --output json
+
+# 5. Delete the old version (if you created a new asset instead of updating)
+uip resource assets delete <old-key> --output json
+```
+
+---
+
+## Complete Example
+
+Set up environment configuration for a Finance folder with text, integer, and secret assets, then share the secret with Production:
+
+```bash
+# Create text asset
+uip resource assets create "ApiBaseUrl" "https://api.example.com" \
+  --folder-path "Finance" --type Text \
+  --description "Production API endpoint" --output json
+
+# Create integer asset
+uip resource assets create "MaxRetries" "5" \
+  --folder-path "Finance" --type Integer \
+  --description "Maximum retry attempts" --output json
+
+# Create secret asset (requires credential store)
+uip resource assets create "ApiKey" "sk-prod-abc123" \
+  --folder-path "Finance" --type Secret \
+  --credential-store-key <store-key> \
+  --description "Production API key" --output json
+
+# Share secret with Production folder
+uip resource assets share <api-key-asset-key> \
+  --folder-path "Production" --output json
+
+# Verify sharing
+uip resource assets get-folders <api-key-asset-key> --output json
+
+# Confirm value is accessible from Production
+uip resource assets get-asset-value <api-key-asset-key> \
+  --folder-path "Production" --output json
+```
+
+---
+
+## Variations and Gotchas
+
+### Credential format
+
+Credential type assets require `username:password` format. The colon separates the username from the password:
+
+```bash
+uip resource assets create "WinCred" "DOMAIN\\user:p@ssw0rd" \
+  --folder-path "Finance" --type Credential \
+  --credential-store-key <store-key> --output json
+```
+
+### `get` does NOT return credential/secret values
+
+`assets get` returns metadata only -- credential and secret values are redacted for security. Use `assets get-asset-value` to retrieve the actual decrypted value.
+
+### Cross-folder vs folder-scoped commands
+
+| Command | Folder required? |
+|---------|-----------------|
+| `list` | Yes (`--folder-path` or `--folder-key`) |
+| `create` | Yes |
+| `get-asset-value` | Yes |
+| `get` | No (cross-folder) |
+| `update` | No (cross-folder) |
+| `delete` | No (cross-folder) |
+| `get-folders` | No (cross-folder) |
+| `share` | Yes (target folder via `--folder-path` or `--folder-key`) |
+| `unshare` | Yes (target folder via `--folder-path` or `--folder-key`) |
+
+### `--credential-store-key` is required for Credential and Secret types
+
+If you omit it, the command fails with an explicit error. Use `uip or credential-stores list --output json` to find the key.
+
+### Bool values must be literal `true` or `false`
+
+Case-insensitive, but no other truthy/falsy values are accepted (not `1`, `0`, `yes`, `no`).
+
+### Integer must be a whole number
+
+Decimals and non-numeric strings are rejected.
+
+---
+
+## Related
+
+- [resources.md](resources.md) -- Overview of all resource commands
+- [setup-environment.md](../orchestrator/setup-environment.md) -- Create folders before creating assets

package/skills/uipath-platform/references/resources/process-queues.md

@@ -0,0 +1,302 @@
+# Process Queues
+
+Create work queues, add items for distributed processing, track progress, and manage review cycles.
+
+> For full option details on any command, use `--help` (e.g., `uip resource queues create --help`).
+
+## When to Use
+
+- Dispatcher-performer patterns, distributed work processing
+- Queue item review workflows (assign reviewers, set review status)
+
+## Prerequisites
+
+- Authenticated (`uip login`)
+- Target folder exists (`uip or folders list`)
+
+## Flow
+
+```mermaid
+graph LR
+    A[queues create] --> B[queue-items add]
+    B --> C[queue-items list]
+    C --> D[queue-items get]
+    D --> E[set-progress]
+    E --> F{Outcome}
+    F -->|Failed| G[get-history]
+    G --> H[set-reviewer]
+    H --> I[set-review-status]
+    F -->|Success| J[Done]
+```
+
+---
+
+## Queue Management
+
+### Create a Queue
+
+```bash
+uip resource queues create "InvoiceQueue" \
+  --folder-path "Finance" --max-retries 3 --auto-retry \
+  --enforce-unique-reference --output json
+```
+
+Key options:
+
+| Option | Description |
+|--------|-------------|
+| `--max-retries <n>` | Maximum retry attempts for failed items |
+| `--auto-retry` / `--no-auto-retry` | Automatically retry items that fail with ApplicationException (default: true) |
+| `--enforce-unique-reference` | Reject items with duplicate reference values |
+| `--encrypted` | Store queue item data encrypted |
+| `--retention-action` | Action for completed items: `Delete`, `Archive`, or `None` (default: Delete) |
+| `--retention-period <days>` | Days to retain completed items (default: 30) |
+| `--stale-retention-action` | Action for uncompleted items: `Delete`, `Archive`, or `None` (default: Delete) |
+| `--stale-retention-period <days>` | Days to retain uncompleted items (default: 180) |
+
+### List Queues
+
+```bash
+uip resource queues list --folder-path "Finance" --output json
+```
+
+Filter by name with `--name` (contains match). Paginate with `--limit` / `--offset`.
+
+### Get, Update, Delete
+
+```bash
+# Get queue details (cross-folder, no --folder-path needed)
+uip resource queues get <queue-key> --output json
+
+# Update queue properties (cross-folder)
+uip resource queues update <queue-key> --max-retries 5 --no-auto-retry --output json
+
+# Delete queue (cross-folder)
+uip resource queues delete <queue-key> --output json
+```
+
+### Share a Queue Across Folders
+
+```bash
+# Share with another folder
+uip resource queues share <queue-key> --folder-path "Production" --output json
+
+# Check which folders have access
+uip resource queues get-folders <queue-key> --output json
+
+# Remove from a folder
+uip resource queues unshare <queue-key> --folder-path "Production" --output json
+```
+
+### Queue Processing Stats
+
+```bash
+# Stats for a specific queue (item counts, exception counts, processing times)
+uip resource queues get-stats --folder-path "Finance" --key <queue-key> --output json
+
+# Stats across queues in a folder, narrowed by name and a processing-window
+uip resource queues get-stats --folder-path "Finance" \
+  --name "Invoice" \
+  --from "2026-04-01T00:00:00Z" --to "2026-04-30T23:59:59Z" \
+  --output json
+```
+
+`get-stats` returns aggregate metrics (totals, successes, failures, average handling time) — useful for dashboards or capacity planning. Without `--key` or `--name` it stats every queue in the folder. `--from` / `--to` filter on last-processed date in ISO 8601.
+
+---
+
+## Queue Item Lifecycle
+
+### Add a Single Item
+
+```bash
+uip resource queue-items add "InvoiceQueue" \
+  --folder-path "Finance" \
+  --specific-content '{"InvoiceId":"INV-001","Amount":1500.00,"Vendor":"Acme"}' \
+  --priority High --reference "INV-001" \
+  --defer-date "2026-04-23T09:00:00Z" --due-date "2026-04-25T17:00:00Z" \
+  --output json
+```
+
+The `add` command takes a **queue name** (not key). Key options: `--specific-content` (required, flat key-value JSON), `--priority` (High/Normal/Low, default Normal), `--reference` (max 128 chars), `--defer-date` / `--due-date` (ISO 8601).
+
+### Bulk Add Items
+
+```bash
+uip resource queue-items bulk-add "InvoiceQueue" \
+  --folder-path "Finance" \
+  --queue-items '[
+    {"specificContent":{"InvoiceId":"INV-002","Amount":2000},"priority":"High"},
+    {"specificContent":{"InvoiceId":"INV-003","Amount":750},"priority":"Normal"}
+  ]' \
+  --commit-type AllOrNothing \
+  --output json
+```
+
+The `bulk-add` command also takes a **queue name**. Use `--commit-type` to control failure handling:
+
+| Commit Type | Behavior |
+|-------------|----------|
+| `AllOrNothing` | Rolls back all items if any fail |
+| `StopOnFirstFailure` | Commits items until the first failure, then stops |
+| `ProcessAllIndependently` | Processes each item independently (default) |
+
+### List and Get Items
+
+```bash
+# List items filtered by queue and status
+uip resource queue-items list --folder-path "Finance" \
+  --queue-name "InvoiceQueue" --status Failed --output json
+
+# Get a single item by its unique key
+uip resource queue-items get <item-unique-key> --folder-path "Finance" --output json
+```
+
+Filter with `--queue-name` (exact match), `--queue-definition-key` (GUID), or `--status` (New, InProgress, Failed, Successful, Abandoned, Retried, Deleted).
+
+### Update, Set Progress, Delete
+
+```bash
+# Update item properties (only provided fields change)
+uip resource queue-items update <item-unique-key> --folder-path "Finance" \
+  --progress "Processing step 3/5" --priority High --output json
+
+# Set progress text (positional argument)
+uip resource queue-items set-progress <item-unique-key> "Validating invoice data" \
+  --folder-path "Finance" --output json
+
+# Delete single / bulk
+uip resource queue-items delete <item-unique-key> --folder-path "Finance" --output json
+uip resource queue-items delete-bulk <key1> <key2> --folder-path "Finance" --output json
+```
+
+### Get History and Retry Info
+
+```bash
+uip resource queue-items get-history <item-unique-key> --folder-path "Finance" --output json
+uip resource queue-items get-last-retry <item-key> --folder-path "Finance" --output json
+uip resource queue-items has-video <item-unique-key> --folder-path "Finance" --output json
+```
+
+Note: `get-last-retry` uses the item `key` field (shared across retries), not `uniqueKey`.
+
+---
+
+## Review Cycle
+
+When queue items fail, a reviewer can inspect them and decide whether to retry, abandon, or delete.
+
+### Assign a Reviewer
+
+```bash
+# List available reviewers in the folder
+uip resource queue-items get-reviewers --folder-path "Finance" --output json
+
+# Assign a reviewer to one or more items
+uip resource queue-items set-reviewer <key1> <key2> \
+  --folder-path "Finance" \
+  --user-id 42 \
+  --output json
+```
+
+### Set Review Status
+
+```bash
+uip resource queue-items set-review-status Retried <key1> <key2> \
+  --folder-path "Finance" --output json
+```
+
+Valid review statuses: `Retried`, `Abandoned`, `Deleted`. The status is the first positional argument, followed by one or more item keys.
+
+### Remove Reviewer
+
+```bash
+uip resource queue-items unset-reviewer <key1> <key2> \
+  --folder-path "Finance" --output json
+```
+
+---
+
+## Complete Example
+
+```bash
+# 1. Create the queue
+uip resource queues create "InvoiceQueue" \
+  --folder-path "Finance" --max-retries 3 --auto-retry \
+  --enforce-unique-reference --output json
+
+# 2. Add work items (dispatcher)
+uip resource queue-items add "InvoiceQueue" --folder-path "Finance" \
+  --specific-content '{"InvoiceId":"INV-001","Amount":1500}' \
+  --reference "INV-001" --priority High --output json
+
+# 3. Check for failed items (after performer runs)
+uip resource queue-items list --folder-path "Finance" \
+  --queue-name "InvoiceQueue" --status Failed --output json
+
+# 4. Investigate a failed item
+uip resource queue-items get-history <failed-item-key> \
+  --folder-path "Finance" --output json
+
+# 5. Assign reviewer and mark as reviewed
+uip resource queue-items set-reviewer <failed-item-key> \
+  --folder-path "Finance" --user-id 42 --output json
+uip resource queue-items set-review-status Retried <failed-item-key> \
+  --folder-path "Finance" --output json
+```
+
+---
+
+## Variations and Gotchas
+
+### Queue Item States
+
+Items progress through these states:
+
+```
+New --> InProgress --> Successful
+                  --> Failed (retryable via ApplicationException)
+                  --> Abandoned (manually abandoned)
+                  --> Retried (auto-retry created a new attempt)
+                  --> Deleted
+```
+
+### Exception Types
+
+| Type | Retryable | When to use |
+|------|-----------|-------------|
+| `ApplicationException` | Yes (auto-retry) | Transient failures (timeout, network error) |
+| `BusinessException` | No | Invalid data, business rule violations |
+
+Items that fail with `ApplicationException` are automatically retried (up to `--max-retries`) when `--auto-retry` is enabled.
+
+### Review Status Flow
+
+```
+None --> InReview (reviewer assigned) --> Verified | Retried
+```
+
+### Key Types
+
+| Field | Scope | Use with |
+|-------|-------|----------|
+| `uniqueKey` | Unique per attempt | `get`, `update`, `delete`, `set-progress`, `get-history`, `has-video` |
+| `key` | Shared across retries | `get-last-retry` |
+| Queue definition key | Queue identifier | `list --queue-definition-key`, `queues get` |
+
+### Common Pitfalls
+
+- `--specific-content` must be **flat key-value JSON** -- no nested objects or arrays.
+- All `queue-items` commands require `--folder-path` or `--folder-key` (items are folder-scoped).
+- `set-review-status` takes the **status first**, then the item key(s) -- not the other way around.
+- `set-reviewer` requires `--user-id` (numeric ID, not GUID). Use `get-reviewers` to find valid IDs.
+- Queue `get`, `update`, and `delete` are **cross-folder** (no `--folder-path` needed). Queue item commands are **not**.
+- `--auto-retry` is enabled by default. Use `--no-auto-retry` to disable.
+
+---
+
+## Related
+
+- [resources.md](resources.md) -- Resource tool overview and libraries
+- [Triggers & Webhooks](triggers-and-webhooks.md) -- Queue triggers fire automations when item count exceeds a threshold
+- [Setup Environment](../orchestrator/setup-environment.md) -- Folder and machine setup

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

@@ -0,0 +1,116 @@
+# Resources (`uip resource`)
+
+Manage Orchestrator resources -- assets, queues, queue items, buckets, files, triggers, libraries, and webhooks.
+
+> **Important:** These commands use `uip resource`, NOT `uip or`. The old `storage-buckets`/`storage-bucket-files` names have been renamed to `buckets`/`bucket-files`.
+
+> For full option details on any command, use `--help` (e.g., `uip resource assets list --help`).
+
+---
+
+## Common Flags
+
+| Flag | Scope | Purpose |
+|------|-------|---------|
+| `--tenant <name>` | All commands | Override the default tenant. |
+| `--output json` | All commands | Emit structured JSON. Always use this when parsing output programmatically. |
+| `--folder-path <path>` | Folder-scoped commands | Target folder by path (e.g., `"Finance"` or `"Finance/Invoicing"`). |
+| `--folder-key <key>` | Folder-scoped commands | Target folder by GUID key. |
+| `--limit <n>` | List commands | Number of items to return (default 50). |
+| `--offset <n>` | List commands | Number of items to skip for pagination. |
+| `--sort-by <field>` | List commands | OData-style sort (e.g., `'Name asc'`, `'Id desc'`). |
+
+---
+
+## Command Tree
+
+```
+uip resource
+  ├── assets              (9 verbs)
+  ├── queues              (8 verbs)
+  ├── queue-items         (15 verbs)
+  ├── buckets             (8 verbs)
+  ├── bucket-files        (8 verbs)
+  ├── triggers            (8 verbs)
+  ├── libraries           (6 verbs)
+  └── webhooks            (7 verbs)
+```
+
+---
+
+## Workflow References
+
+Each workflow doc covers a multi-command choreography for a specific goal. Load the one that matches your task.
+
+| Workflow | File | Covers |
+|----------|------|--------|
+| Manage Assets | [manage-assets.md](manage-assets.md) | Create, share, rotate, and delete assets |
+| Process Queues | [process-queues.md](process-queues.md) | Queues, queue items, transactions, reviews |
+| Work with Storage | [work-with-storage.md](work-with-storage.md) | Buckets, file upload/download, pre-signed URLs |
+| Triggers & Webhooks | [triggers-and-webhooks.md](triggers-and-webhooks.md) | Time/queue/API triggers, webhook management |
+
+---
+
+## Libraries
+
+Libraries are tenant-scoped -- no folder context needed.
+
+| Command | Description |
+|---------|-------------|
+| `uip resource libraries list` | List libraries in the tenant feed. Options: `--limit <N>` (default 50), `--offset <N>`, `--sort-by "<field> <asc\|desc>"`. No native search — filter client-side via global `--output-filter "<JMESPath>"`. Returns `Key`, `Title`, `Version`, `Authors`. |
+| `uip resource libraries get <key>` | Get library details. Key format is `PackageId:Version` (e.g., `MyLib:1.0.0`). Returns the full API DTO. |
+| `uip resource libraries versions <package-id>` | List all versions of a library by package ID (the `Title` from `list` output). |
+| `uip resource libraries upload --file <path>` | Upload a `.nupkg` library package to the tenant feed. |
+| `uip resource libraries download <key> --destination <path>` | Download a `.nupkg` to local disk. |
+| `uip resource libraries delete <key>` | Delete a specific library version. |
+
+```bash
+# List libraries (first 500). Default --limit is 50; bump it for tenants with many libraries.
+uip resource libraries list --limit 500 --output json
+
+# Filter by name client-side. Title can be null — guard with `Title != null` or contains() will error.
+uip resource libraries list --limit 500 \
+  --output-filter "[?Title != null && contains(Title, 'Excel')]" \
+  --output json
+
+# Multi-keyword OR filter
+uip resource libraries list --limit 500 \
+  --output-filter "[?Title != null && (contains(Title, 'Common') || contains(Title, 'Shared'))]" \
+  --output json
+
+# Upload a library
+uip resource libraries upload --file ./MyLibrary.1.0.0.nupkg --output json
+
+# List versions, then download a specific one
+uip resource libraries versions "UiPath.System.Activities" --output json
+uip resource libraries download "UiPath.System.Activities:24.10.0" \
+  --destination ./system-activities.nupkg --output json
+
+# Delete an old version
+uip resource libraries delete "UiPath.System.Activities:24.4.0" --output json
+```
+
+---
+
+## Output Behavior
+
+Resource tool commands return **full API responses** (all fields) by default. There is no `--all-fields` flag — the convention in `resource-tool` is raw camelCase DTO. (This differs from `orchestrator-tool`, which curates by default and exposes `--all-fields` for the raw view; see [`uipath-orchestrator`](../orchestrator/orchestrator.md).)
+
+List responses include a `Pagination` block:
+
+```json
+{
+  "Pagination": { "Returned": 50, "Limit": 50, "Offset": 0, "HasMore": true },
+  "Data": [...]
+}
+```
+
+When `HasMore` is `true`, increment `--offset` by `--limit` and fetch again. Continue until `HasMore` is `false` or `Returned < Limit`.
+
+---
+
+## Related
+
+- **Orchestrator** (`uip or`) — folders, jobs, processes, packages, users, machines → [`uipath-orchestrator`](../orchestrator/orchestrator.md)
+- **Solutions** (`uip solution`) — pack, publish, deploy solution packages → [`uipath-solution`](../solution/solution.md)
+- **Folder/user setup** — required before folder-scoped resources can be used → [`uipath-orchestrator/setup-environment`](../orchestrator/setup-environment.md)