@uipath/solution-tool 1.206.0-preview.301 → 1.207.0-preview.305
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/dist/{archive-extract-ma0gy822.js → archive-extract-afgwacbg.js} +3 -3
- package/dist/{cleanup-command-service-8whhrsvy.js → cleanup-command-service-j9kawew9.js} +20 -15
- package/dist/deploy-delete-service-1erqap9a.js +23 -0
- package/dist/deploy-run-service-jbs6dxye.js +24 -0
- package/dist/{deploy-status-service-at6cxp1a.js → deploy-status-service-4zn90vds.js} +49 -25
- package/dist/deploy.js +21 -20
- package/dist/{deployment-search-40dknsk1.js → deployment-search-dwzahe4v.js} +9 -9
- package/dist/feed-resolver-d14rdjss.js +31 -0
- package/dist/feed-scope-failure-w16mze3z.js +20 -0
- package/dist/{feed-session-dvyfw5k7.js → feed-session-f2sby6t8.js} +6 -6
- package/dist/{first-party-service-6gf3n6d8.js → first-party-service-7cggb17y.js} +1 -1
- package/dist/folder-runtime-check-586c41dq.js +25 -0
- package/dist/{governance-options-am1hfj5b.js → governance-options-y2xsv7ff.js} +7 -7
- package/dist/{packager-tool-5vf0v538.js → index-6ma58k47.js} +33 -708
- package/dist/{index-p3x7ztdr.js → index-795rsz0e.js} +1 -1
- package/dist/{index-yjvmjpdn.js → index-pzkzbqbs.js} +12 -11
- package/dist/{index-1cfw8mj0.js → index-wfqzwh7k.js} +9 -7
- package/dist/index.js +26 -26
- package/dist/init.js +10 -10
- package/dist/{list-vsecskj1.js → list-6pe1nab5.js} +11 -11
- package/dist/models/pack-command-types.d.ts +12 -0
- package/dist/{node-vndr59bc.js → node-13wj5mzd.js} +6 -6
- package/dist/pack-command-service-j9bqnsn1.js +32 -0
- package/dist/{pack-project-re7s480k.js → pack-project-3sdddc42.js} +21 -18
- package/dist/pack.js +25 -22
- package/dist/{package-id-rx8gq6y2.js → package-id-5j4q232a.js} +3 -3
- package/dist/{packager-tool-vgrswa8p.js → packager-tool-1db1wqdy.js} +30 -8
- package/dist/{packager-tool-vx2c68sb.js → packager-tool-1dsxhz1r.js} +2 -2
- package/dist/{packager-tool-t2r6z24f.js → packager-tool-1tvhgac9.js} +15 -6
- package/dist/{packager-tool-4pt71nf1.js → packager-tool-2atxqqgd.js} +49 -24
- package/dist/packager-tool-3ft8hywr.js +449 -0
- package/dist/{packager-tool-g1c0xdh2.js → packager-tool-46x80z85.js} +8 -4
- package/dist/{packager-tool-gjfb0wcy.js → packager-tool-4hm40a32.js} +8 -74
- package/dist/{packager-tool-f15an17m.js → packager-tool-5p1vy335.js} +1 -1
- package/dist/packager-tool-612prgtc.js +140 -0
- package/dist/packager-tool-7gqn5apd.js +72 -0
- package/dist/{packager-tool-aws5w512.js → packager-tool-887bkh9y.js} +1 -1
- package/dist/{packager-tool-vj88gh5b.js → packager-tool-8tckw03n.js} +28 -9
- package/dist/{packager-tool-9vtp28fb.js → packager-tool-93qy1v8m.js} +52 -15
- package/dist/{packager-tool-fx4ws49n.js → packager-tool-cenfraf4.js} +2 -2
- package/dist/{packager-tool-chff74yz.js → packager-tool-cr1khqtm.js} +103 -166
- package/dist/{packager-tool-6tn79r1b.js → packager-tool-da3hvfyn.js} +528 -202
- package/dist/{packager-tool-2zn98p5r.js → packager-tool-dd937g7k.js} +4 -4
- package/dist/{packager-tool-a7s0gbxs.js → packager-tool-devc4w73.js} +7 -2
- package/dist/{packager-tool-v7h8s6yj.js → packager-tool-ewbkaecg.js} +18 -11
- package/dist/{packager-tool-d7v4083a.js → packager-tool-g08b669a.js} +22 -18
- package/dist/{packager-tool-m07vyk89.js → packager-tool-gb3dq79g.js} +36 -9
- package/dist/{packager-tool-395kmy70.js → packager-tool-gmbcn83x.js} +3 -3
- package/dist/{packager-tool-btz44ase.js → packager-tool-jhtsana2.js} +119 -52
- package/dist/{packager-tool-4rvfxkyh.js → packager-tool-jtg2arr8.js} +20 -8
- package/dist/{packager-tool-t39pjz7n.js → packager-tool-jtvhkavz.js} +48 -6
- package/dist/packager-tool-kffz64hn.js +279 -0
- package/dist/{packager-tool-p5322gew.js → packager-tool-kmwjscby.js} +88 -10
- package/dist/{packager-tool-ppj5f4y7.js → packager-tool-n1zrk6zv.js} +4 -2
- package/dist/{packager-tool-avrdp2za.js → packager-tool-pmc5txbm.js} +4 -6
- package/dist/{packager-tool-egc54x78.js → packager-tool-qhht1tc9.js} +2408 -771
- package/dist/{packager-tool-zcqfq3vc.js → packager-tool-qm876ezh.js} +84 -29
- package/dist/{packager-tool-resolver-30hxk8vm.js → packager-tool-resolver-y52kztnx.js} +6 -6
- package/dist/{packager-tool-3ejz0af8.js → packager-tool-rhg3mwkn.js} +14 -8
- package/dist/{packager-tool-ckrt4gyr.js → packager-tool-t9zked1m.js} +3 -3
- package/dist/{packager-tool-36w7az7k.js → packager-tool-tat0qs6z.js} +26 -10
- package/dist/packager-tool-tf0rn1tp.js +741 -0
- package/dist/{packager-tool-p5aar2k0.js → packager-tool-tmba5jv0.js} +140 -10
- package/dist/{packager-tool-vk3e239z.js → packager-tool-tqe3m1xp.js} +6 -6
- package/dist/{packager-tool-1ctvbx0h.js → packager-tool-tr3ttz5c.js} +1 -1
- package/dist/{packager-tool-k9dk39tg.js → packager-tool-txygqgb2.js} +3 -3
- package/dist/packager-tool-v6jcys3s.js +46 -0
- package/dist/packager-tool-w35s60sx.js +179 -0
- package/dist/{packager-tool-axqk17xw.js → packager-tool-xbfr6y2x.js} +142 -34
- package/dist/{packager-tool-2qsbh4kd.js → packager-tool-yfcscjfp.js} +50 -12
- package/dist/{packager-tool-ay4j9x92.js → packager-tool-ykq6gmhc.js} +19 -8
- package/dist/packager-tool.js +2 -2
- package/dist/prepare-solution-resources-sk3tyy8b.js +26 -0
- package/dist/{project-command-utils-82tja3k0.js → project-command-utils-7ygs8xq0.js} +20 -13
- package/dist/project-contributions-nzh06q0y.js +31 -0
- package/dist/project-identity-telemetry-47k2g7nq.js +18 -0
- package/dist/publish.js +14 -14
- package/dist/{resource-mutations-h6wfdqr4.js → resource-mutations-qcz2vcxe.js} +9 -9
- package/dist/{resource-version-lookup-xzgnvr48.js → resource-version-lookup-w3kzh4z9.js} +9 -9
- package/dist/resource.js +9 -9
- package/dist/{restore-command-service-wgqxp5tb.js → restore-command-service-m6c8fb7q.js} +20 -15
- package/dist/run-service-cmrzccnm.js +1055 -0
- package/dist/services/deploy-activate-service.d.ts +5 -2
- package/dist/services/deploy-config-file.d.ts +24 -0
- package/dist/services/deploy-delete-service.d.ts +1 -1
- package/dist/services/deploy-run-service.d.ts +8 -1
- package/dist/services/deploy-uninstall-service.d.ts +4 -2
- package/dist/services/deploy-upgrade-service.d.ts +23 -2
- package/dist/services/deployment-feed-locator.d.ts +19 -6
- package/dist/services/deployment-links.d.ts +16 -0
- package/dist/services/deployment-progress.d.ts +10 -0
- package/dist/services/deployment-search.d.ts +15 -2
- package/dist/services/deployment-state.d.ts +9 -0
- package/dist/services/feed-resolver.d.ts +17 -0
- package/dist/services/feed-selection.d.ts +59 -0
- package/dist/services/folder-runtime-check.d.ts +107 -0
- package/dist/services/incomplete-feed-sweep.d.ts +6 -0
- package/dist/services/pack-command-service.d.ts +6 -0
- package/dist/services/pack-project.d.ts +1 -1
- package/dist/services/package-metadata-rewrite.d.ts +13 -0
- package/dist/services/personal-workspace-resolver.d.ts +4 -1
- package/dist/services/prepare-solution-resources.d.ts +11 -6
- package/dist/services/project-contributions.d.ts +26 -2
- package/dist/services/project-identity-telemetry.d.ts +31 -0
- package/dist/services/solution-members.d.ts +31 -0
- package/dist/{ship-telemetry-19gx83af.js → ship-telemetry-9djqndmy.js} +4 -4
- package/dist/{solution-auth-jxcgd2m0.js → solution-auth-0e3qm74f.js} +3 -3
- package/dist/{solution-definition-helper-tqwd6cxn.js → solution-definition-helper-bkyhs1bd.js} +1 -1
- package/dist/{solution-identity-c23d9bfv.js → solution-identity-j63p6n81.js} +4 -4
- package/dist/templates/AGENTS.md +131 -24
- package/dist/tool.js +26 -26
- package/package.json +2 -2
- package/dist/deploy-delete-service-dwd4qb1m.js +0 -23
- package/dist/deploy-run-service-0kzfrvnn.js +0 -23
- package/dist/feed-resolver-w4y5aspe.js +0 -27
- package/dist/feed-scope-failure-4ef9zxcx.js +0 -20
- package/dist/pack-command-service-k7ebbfya.js +0 -29
- package/dist/packager-tool-vrqbbh01.js +0 -182
- package/dist/packager-tool-wwzg88qy.js +0 -74
- package/dist/prepare-solution-resources-h7zvnncd.js +0 -26
- package/dist/project-contributions-xx560n8y.js +0 -27
- package/dist/run-service-2rc4we5q.js +0 -506
|
@@ -1,3 +1,34 @@
|
|
|
1
|
+
import type { SolutionImportResponse } from "@uipath/solution-sdk";
|
|
1
2
|
import { type ProjectActivityObserver } from "@uipath/solutionpackager-tool-core";
|
|
2
3
|
/** One observer per invocation. Only projects actually reached get a row. */
|
|
3
4
|
export declare function createProjectActivityObserver(commandName: string): ProjectActivityObserver | undefined;
|
|
5
|
+
/** What the upload handler holds once Studio Web has accepted the solution. */
|
|
6
|
+
export interface UploadedSolution {
|
|
7
|
+
/** The directory holding the `.uipx` and the member folders. */
|
|
8
|
+
solutionDir: string;
|
|
9
|
+
/** The solution id Studio Web returned. */
|
|
10
|
+
solutionId: string | undefined;
|
|
11
|
+
/** The import or overwrite response body. */
|
|
12
|
+
response: SolutionImportResponse;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* One `Cli.ProjectActivity` row per uploaded member whose local id could be
|
|
16
|
+
* read, linking the project id Studio Web assigned (`ProjectKey`) to the id
|
|
17
|
+
* the local manifest still holds (`PreviousProjectKey`, only when the two
|
|
18
|
+
* differ). The upload is the one moment the CLI holds both: Studio Web keeps
|
|
19
|
+
* the local id nowhere, and the local manifest keeps the old id until a
|
|
20
|
+
* download.
|
|
21
|
+
*
|
|
22
|
+
* Members are matched to the response by the `.uipx` member id, which Studio
|
|
23
|
+
* Web returns as each project's `designId`: it writes it on import, and an
|
|
24
|
+
* overwrite either matches an existing project by it or re-imports the member
|
|
25
|
+
* and writes it, so the body the upload already received is the one source
|
|
26
|
+
* and nothing is looked up. The row rule: a row only when the member's factory
|
|
27
|
+
* has an identity reader and it read a GUID; a member whose type has no
|
|
28
|
+
* reader, whose manifest has no id or an unreadable one, whose read ran past
|
|
29
|
+
* the identity budget, or that the response does not name, gets none, with
|
|
30
|
+
* the reason at debug. Called after the output and the ship event, so the
|
|
31
|
+
* reads delay nothing the user sees; it never throws, so a failure cannot
|
|
32
|
+
* change the exit code.
|
|
33
|
+
*/
|
|
34
|
+
export declare function trackUploadedProjectIdentities(upload: UploadedSolution): Promise<void>;
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type { IFileSystem } from "@uipath/filesystem";
|
|
2
|
+
/** One project in a solution, as the run and upload paths need it. */
|
|
3
|
+
export interface SolutionProjectEntry {
|
|
4
|
+
name: string;
|
|
5
|
+
projectType: string;
|
|
6
|
+
/**
|
|
7
|
+
* The project *directory*, relative to the solution directory. Empty when
|
|
8
|
+
* the project sits at the solution root.
|
|
9
|
+
*/
|
|
10
|
+
relativePath: string;
|
|
11
|
+
/**
|
|
12
|
+
* The manifest's own id for the project (`.uipx` `Projects[].Id`).
|
|
13
|
+
*
|
|
14
|
+
* Read because `SolutionProjectRef.designId` declares it and a JIT process
|
|
15
|
+
* map wants it: it is the only stable identity a project has before the
|
|
16
|
+
* solution has been synced anywhere, and the one Studio Web keeps as the
|
|
17
|
+
* project's design id after an upload. Optional because the field is
|
|
18
|
+
* optional in the schema.
|
|
19
|
+
*/
|
|
20
|
+
designId?: string;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Read the projects out of a solution's `.uipx`.
|
|
24
|
+
*
|
|
25
|
+
* Shares the `.uipx` shape with the packager resolver rather than the loader in
|
|
26
|
+
* `@uipath/solution-packager`: that one resolves the whole packaging model, and
|
|
27
|
+
* the callers here need three fields. In its own module, apart from the
|
|
28
|
+
* executor resolver, so the upload handler (in the browser bundle) can read a
|
|
29
|
+
* solution's members without pulling `@uipath/project-executor` in.
|
|
30
|
+
*/
|
|
31
|
+
export declare function readSolutionProjects(solutionDir: string, fs: IFileSystem): Promise<SolutionProjectEntry[]>;
|
|
@@ -2,10 +2,10 @@ import {
|
|
|
2
2
|
summarizeShipProjectTypes2,
|
|
3
3
|
inspectSolutionPackageProjectTypes2,
|
|
4
4
|
trackSolutionShipSucceeded2
|
|
5
|
-
} from "./packager-tool-
|
|
6
|
-
import"./packager-tool-
|
|
7
|
-
import"./packager-tool-
|
|
8
|
-
import"./packager-tool-
|
|
5
|
+
} from "./packager-tool-txygqgb2.js";
|
|
6
|
+
import"./packager-tool-xbfr6y2x.js";
|
|
7
|
+
import"./packager-tool-gb3dq79g.js";
|
|
8
|
+
import"./packager-tool-1db1wqdy.js";
|
|
9
9
|
import"./packager-tool-rj2d1g0w.js";
|
|
10
10
|
export {
|
|
11
11
|
inspectSolutionPackageProjectTypes2 as inspectSolutionPackageProjectTypes,
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import {
|
|
2
2
|
getSolutionAuthContext2
|
|
3
|
-
} from "./packager-tool-
|
|
4
|
-
import"./packager-tool-
|
|
5
|
-
import"./packager-tool-
|
|
3
|
+
} from "./packager-tool-n1zrk6zv.js";
|
|
4
|
+
import"./packager-tool-jtvhkavz.js";
|
|
5
|
+
import"./packager-tool-1db1wqdy.js";
|
|
6
6
|
export {
|
|
7
7
|
getSolutionAuthContext2 as getSolutionAuthContext
|
|
8
8
|
};
|
|
@@ -4,10 +4,10 @@ import {
|
|
|
4
4
|
captureExtractedSolution2,
|
|
5
5
|
captureSolutionIdentity2,
|
|
6
6
|
captureSolutionMember2
|
|
7
|
-
} from "./packager-tool-
|
|
8
|
-
import"./packager-tool-
|
|
9
|
-
import"./packager-tool-
|
|
10
|
-
import"./packager-tool-
|
|
7
|
+
} from "./packager-tool-t9zked1m.js";
|
|
8
|
+
import"./packager-tool-xbfr6y2x.js";
|
|
9
|
+
import"./packager-tool-gb3dq79g.js";
|
|
10
|
+
import"./packager-tool-1db1wqdy.js";
|
|
11
11
|
export {
|
|
12
12
|
captureExtractedSolution2 as captureExtractedSolution,
|
|
13
13
|
capturePackedSolutionIdentity2 as capturePackedSolutionIdentity,
|
package/dist/templates/AGENTS.md
CHANGED
|
@@ -75,13 +75,13 @@ Install the skills with `uip skills install`. The general-purpose `uipath-platfo
|
|
|
75
75
|
|
|
76
76
|
A `BusinessRules` project gets its `businessRule` resource when it is added to the solution, and `uip solution resources refresh` regenerates it if it goes missing. `Library` and `Tests` projects declare no solution resources, and refresh skips them.
|
|
77
77
|
|
|
78
|
-
**`Library` is not a project type here.** A library is a reusable `.nupkg` consumed as a NuGet dependency, so `projects add` / `import` reject it and auto-registration returns `SolutionRegistration.Status: "Skipped"`. Publish it on its own (`uip rpa pack <project-dir> <output-path>`, then `uip or libraries upload --file <nupkg-path>`) and either reference it from a project's dependencies or attach it to this solution as a resource: `uip solution resources add --source remote --kind Library --name <library-name>`.
|
|
78
|
+
**`Library` is not a project type here.** A library is a reusable `.nupkg` consumed as a NuGet dependency, so `projects add` / `import` reject it (`ErrorCode: not_supported`) and auto-registration returns `SolutionRegistration.Status: "Skipped"`. Publish it on its own (`uip rpa pack <project-dir> <output-path>`, then `uip or libraries upload --file <nupkg-path>`) and either reference it from a project's dependencies or attach it to this solution as a resource: `uip solution resources add --source remote --kind Library --name <library-name>`.
|
|
79
79
|
|
|
80
80
|
The type lives in either `project.uiproj` (top-level `ProjectType`) or `project.json` (`designOptions.outputType`, falling back to top-level `ProjectType` when `outputType` is absent — read or write either field). A third form exists but is narrow: `uipath.json` is read as a project manifest **only** for a code-first Functions project, which is recognised by a `functions` map inside it. Other project kinds keep a `uipath.json` for their own config — a coded app stores its SDK settings there — and that file is not what registers them: a coded app is registered from the `project.uiproj` that `uip codedapp init <path>` writes. Pointing a solution at a coded app's `uipath.json` (or at its `package.json`) fails, because neither carries a `ProjectType`.
|
|
81
81
|
|
|
82
82
|
The `init` scaffolders above auto-register when run inside a solution directory (unless `--skip-solution-registration` is passed). For other scaffolders, register the project with the solution after scaffolding: use `uip solution projects add <project-path> [<solution-file>]` when the project already lives inside the solution directory (registers in place, no copy), or `uip solution projects import <path>` to copy a project from outside the solution dir into it and register it. If you pass an unknown type to those commands, they reject with the exhaustive accepted list — trust that error over this table. `uip solution pack` rejects the same way: a `Projects[]` entry whose `Type` no packager handles fails with `ErrorCode: invalid_argument`, naming the project, the accepted types, and how to drop the entry, rather than attempting the pack.
|
|
83
83
|
|
|
84
|
-
`projects add` and `projects remove` take **either** the project folder or its manifest file: `uip solution projects remove my-app` and `uip solution projects remove my-app/project.uiproj` do the same thing. That matters because the `.uipx` records a project by its manifest file (`ProjectRelativePath: "my-app/project.uiproj"`), so the path `pack` quotes back when it refuses an entry can be pasted straight into `remove`. `projects import` is the exception — its argument is an external folder to copy, so give it a directory.
|
|
84
|
+
`projects add` and `projects remove` take **either** the project folder or its manifest file: `uip solution projects remove my-app` and `uip solution projects remove my-app/project.uiproj` do the same thing. That matters because the `.uipx` records a project by its manifest file (`ProjectRelativePath: "my-app/project.uiproj"`), so the path `pack` quotes back when it refuses an entry can be pasted straight into `remove`. `projects import` is the exception — its argument is an external folder to copy, so give it a directory. Every `projects import` failure names its cause in `Message` and the next step in `Instructions`: a source folder or solution file that is not there is `ErrorCode: not_found`; a file instead of a folder, a folder with no project manifest, or a project already in the solution is `invalid_argument`.
|
|
85
85
|
|
|
86
86
|
**Member package ids come from folder names, and pack refuses the ones a feed cannot store.** Each member is published under `<solution>.<project-type>.<member-folder>` — the solution's own `.uipx` name, the short type (`Rpa`, `Case`, `Flow`, …) and the member's folder inside the solution. The name a project declares for itself is not used, and `--name` renames the archive only. Two limits ride on that, both checked before anything is packed and both reported as `ErrorCode: invalid_argument` / `Retry: RetryWillNotFix`:
|
|
87
87
|
|
|
@@ -153,39 +153,47 @@ uip solution deploy status <pipeline-deployment-id> # that run's progress and
|
|
|
153
153
|
uip solution deploy list
|
|
154
154
|
```
|
|
155
155
|
|
|
156
|
-
`deploy run` also takes `--parent-folder-key <key>` in place of `--parent-folder-path`, `--personal-workspace` to deploy into your Personal Workspace instead of the tenant, and `--feed <name-or-key>` to deploy a package published to another feed (see "Package Identity and Publishing").
|
|
156
|
+
`deploy run` also takes `--parent-folder-key <key>` in place of `--parent-folder-path`, `--personal-workspace` to deploy into your Personal Workspace instead of the tenant, and `--feed <name-or-key>` to deploy a package published to another feed (see "Package Identity and Publishing"). `deploy config get` takes the same `--personal-workspace` / `--feed <name-or-key>` to read a package published only to that feed; without either it reads the tenant feed.
|
|
157
157
|
|
|
158
158
|
**Listing one folder's deployments.** `uip solution deploy list --folder-path <path>` (or `--folder-key <key>`) lists the deployments installed into that folder. The Solutions search does the filtering, so `--limit`, `--offset` and `Pagination.Total` all count matching deployments: page with `--offset <previous Offset + Returned>` while `Pagination.HasMore` is true. The match is on the folder's **full path** (`Shared/Finance`, not `Finance`), exact and not case-sensitive, and deployments in its subfolders are **not** included — list each subfolder with its own call. `FolderPath` is the folder the deployment was installed *into*; a row's `FolderKey` is the deployment's own solution folder one level below it, so passing that key to `--folder-key` matches no deployment — use the key of the `FolderPath` folder instead.
|
|
159
159
|
|
|
160
160
|
**Every deploy waits, and validates first.** `deploy run` — tenant, `--personal-workspace` or `--feed` — goes through the Pipelines install, which validates the package against the target *before* it schedules the install, then polls the run to a terminal state and reports `Status: "DeploymentSucceeded"` with `DeploymentKey`, `PipelineDeploymentId` and `InstanceId`. A validation failure ends in `Status: ValidationFailed` with the per-resource errors in `Instructions`, and nothing is installed. `--timeout <seconds>` (default 360) bounds each polling phase; running out exits `2` with `ErrorCode: timeout` and `Retry: RetryLater` — "may still be running", so check `uip solution deploy status <pipeline-deployment-id>` rather than treating it as a failed install. A wait that stops early because the status reads keep failing exits `1` with the `ErrorCode` of that failure — `network_error` with `Retry: RetryLater` for a dropped connection — and the deploy may still be running, so check its status the same way before you run it again. `solution publish --wait` reports a failed wait the same way. On `deploy run`, `deploy activate`, `deploy uninstall`, `publish`, `projects publish` and `projects resync`, `--timeout` and `--poll-interval` take a whole number of 1 or more: `abc`, `1.5`, `0` or a negative number is refused before anything is sent (exit `3`, `ErrorCode: invalid_argument`), so there is no "no timeout" value. `--wait` is accepted for backwards compatibility and does nothing. **Folder feeds from CI/CD.** An external app (client-credentials login) can deploy into a folder feed with `--feed` only on a server that applies the feed to client-credentials requests. Before the first feed-scoped request the CLI asks the server once — a single-row search sent with the feed, on the route the command itself uses (the deployment search; the package search for `publish`, `packages list` and `packages delete`, so the question needs no scope the command does not), answered with an `X-UIPATH-FolderKey` echo on the response when the server ran it in that feed — and refuses (`ErrorCode: permission_denied`) when the echo is missing or the question fails, because an older server ignores the feed header on that token type and the install would land on the tenant feed under the requested name. `solution publish --feed` from an external app is guarded the same way and uploads nothing on such a server: the upload picks its feed by `locationKey`, but the `--wait` version read is scoped by the header alone and would read the tenant feed. The question is a read, so it needs that route's read scope next to the command's own: `Solutions.Packages.Read` for `publish`, `packages list` and `packages delete`, `Solutions.Deployments.Read` for the deploy verbs. An app holding only the write scope is refused by its own check, and the refusal names the read scope to add. The app's OAuth scope (`Solutions.Deployments`) is the whole authorization there: it reaches every folder feed in the tenant. Without a Studio Web (`StudioWebS2S`) grant an external app cannot list feeds (`solution feeds list` answers it with 401); then give `--feed` the feed's **folder key** or the path of the Orchestrator folder that owns the feed. A path is looked up through Orchestrator and needs the app's `OR.Folders` scope; a key is used as given, so `solution publish --feed <key>` needs no extra scope, while `deploy run --feed <key>` still reads the feed folder's path through Orchestrator (the install is addressed by path) and needs `OR.Folders` too — without it the deploy fails before anything is installed, with `ErrorCode: permission_denied` and instructions naming that scope. With the `StudioWebS2S` grant a feed name resolves through the listing as for a user. `--personal-workspace` is always refused to an external app, before anything is requested — an app has no Personal Workspace of its own. A `--feed` that names the tenant feed is fine from CI/CD, as is omitting the flag. Reading a feed follows the same rule: `deploy list` and `deploy status` with a folder-feed `--feed` work for an external app on such a server and are refused (`ErrorCode: permission_denied`) on an older one, instead of showing the tenant feed's records under that feed's name. A session whose kind cannot be read from its token is refused the same way; `uip login` records an interactive login as a user session.
|
|
161
161
|
|
|
162
|
+
**Progress while waiting.** `deploy run`, `deploy upgrade` (unless `--no-wait`), `deploy activate` and `deploy uninstall` print plain progress lines to stderr on terminals and in CI. Each observed status change is printed, with an elapsed-time heartbeat after at least 30 seconds without an update. Lines show the server's pipeline, operation, deployment and activation statuses when available; no percentage is estimated. `--log-file` sends progress to the log file instead of stderr; `--log-level error` silences it. Stdout, including the final `--output json` envelope, is unchanged.
|
|
163
|
+
|
|
162
164
|
**Upgrading in place.** `uip solution deploy upgrade <deployment-key>` (the `Key` from `deploy list`) or `uip solution deploy upgrade --name <deployment-name> --package-name <pkg>` moves an existing deployment to another published version of its package (newest by default, or `--version <version>`) and keeps the values already set on it. Both forms work from a CI/CD pipeline signed in as an external app. With a key, the deployment's name, package and feed are read from the server, so no `--package-name` or `--personal-workspace` is needed, and the result also carries `FromVersion` and `InstallDeploymentKey` — the key that stays the same across upgrades, so store that one rather than `DeploymentKey`, which changes with every upgrade. It uses the same Pipelines install, so it validates before it installs: on success it reports `Status: "DeploymentSucceeded"`, `Operation`, `DeploymentStatus`, `Actions`, `ToVersion`, `PipelineDeploymentId` and `DeploymentKey`; on a validation failure it reports the errors and the deployment stays on its current version. `--no-wait` returns `Status: "Accepted"` as soon as the install is queued. An external app can upgrade a folder-feed or Personal Workspace deployment by key only on a server that applies the feed to client-credentials requests (the same one-time check as `deploy run --feed`); on an older server it is refused and needs a user session. Tenant-feed deployments work everywhere.
|
|
163
165
|
|
|
166
|
+
**Changing a live deployment's configuration.** `deploy upgrade` also takes `--config-file <file>`, the same JSON / YAML file `deploy run` takes (`deploy config get <package> --package-version <version> -d config.json`, edited with `config set` / `config link`), and sends it with the install. With `--version` set to the deployed version nothing else moves: the run reports `Operation: "ConfigurationChange"`, on the same deployment, with its history and `InstallDeploymentKey` kept. This is how a deployment's resources are linked to existing ones after it is installed — for example an authenticated connection in place of the unauthenticated one a first deploy created. Each resource the file names is applied as written, so a file straight from `config get` sets those resources back to the package defaults (an empty required value, such as an asset's, is refused outright); a resource the file leaves out keeps the values the deployment has. Keep only the resources you change in the file. A rejected attempt leaves a pending draft like any other (below): fix the file, then run the `--discard-draft` command the refusal prints, which carries the same `--config-file`. When the server asks to permanently delete installed copies the file's links replace, keeping the copies means deleting those resources' entries from the file first (not `deploy config unlink`, which keeps the entry and resets the resource to the package defaults), then running that `--discard-draft` command: re-sending the file with the links still in it asks for the deletion again.
|
|
167
|
+
|
|
164
168
|
**Key or name — how the two forms differ.** The key form makes one extra Pipelines call, the deployment lookup, and needs nothing else: it works on any server that has that lookup. On a server without it, a user session reads the key through the Solutions API instead (tenant feed, or your Personal Workspace with `--personal-workspace`; a folder-feed deployment needs the name form) and the result carries no `FromVersion`; an external app gets `ErrorCode: not_found`, and the message points at the name form. The name form needs `--package-name` because the install route is addressed by name and nothing name-keyed in Pipelines reports a deployment's package; with `--version` as well it makes no version lookup. It does check the name exists first (the same route would otherwise treat an unknown name as a fresh install and create a deployment), so a typo fails with `ErrorCode: not_found` instead of deploying. A name whose deployment was *uninstalled* is caught the same way — the CLI checks the deployment search, which an external app can read only on servers that serve the Pipelines search — so from CI/CD on an older server address such a deployment by key, which reads its status. Find the key, the name and the package with `uip solution deploy list`.
|
|
165
169
|
|
|
166
170
|
**`Operation` tells you what actually happened.** The endpoint is unified, so asking for the version already deployed is a *configuration change*, not a version move. `Operation: "VersionChange"` means the version moved; `"ConfigurationChange"` means it did not. Check it rather than assuming `DeploymentSucceeded` implies a new version. `DeploymentStatus` says whether the new version runs: `SuccessfulActivate` means it does; `SuccessfulInstall` with `SetupActivation` in `Actions` means it is installed but the previous version keeps running until activation is set up (`uip solution deploy activate`, or Setup activation in Orchestrator).
|
|
167
171
|
|
|
168
|
-
**A rejected attempt leaves a pending draft.** When a `deploy run` or `deploy upgrade` stops at `ValidationFailed` (or a conflict or scheduling error), nothing is installed and the live version keeps running, but the attempt stays behind as a *draft* — its key is the `deploymentKey` in the failure's `Instructions`. While the draft exists it owns the deployment, as in the Orchestrator UI (which offers only "continue editing" and "delete draft"): re-running the same `deploy run` with a corrected `--config-file` and the **draft's** version re-validates it with the new file (settings and resource links the file does not name keep the rejected values). Any other version is refused before anything is sent (`ErrorCode: invalid_argument`) — including the version that is live now, which the server would otherwise answer by installing the draft's version instead. Under an external app that check only warns and the deploy goes ahead — and the server then runs the draft, installing the draft's version — so from CI/CD ask only for the draft's version, or discard the draft first. `deploy upgrade`
|
|
172
|
+
**A rejected attempt leaves a pending draft.** When a `deploy run` or `deploy upgrade` stops at `ValidationFailed` (or a conflict or scheduling error), nothing is installed and the live version keeps running, but the attempt stays behind as a *draft* — its key is the `deploymentKey` in the failure's `Instructions`. While the draft exists it owns the deployment, as in the Orchestrator UI (which offers only "continue editing" and "delete draft"): re-running the same `deploy run` with a corrected `--config-file` and the **draft's** version re-validates it with the new file (settings and resource links the file does not name keep the rejected values). Any other version is refused before anything is sent (`ErrorCode: invalid_argument`) — including the version that is live now, which the server would otherwise answer by installing the draft's version instead. Under an external app that check only warns and the deploy goes ahead — and the server then runs the draft, installing the draft's version — so from CI/CD ask only for the draft's version, or discard the draft first. `deploy upgrade` refuses a deployment with a pending draft, with or without `--config-file`, (`ErrorCode: invalid_argument`, naming the draft's key and version) rather than re-run the rejected attempt; once the cause is fixed, `uip solution deploy upgrade <draft-or-deployment-key> --discard-draft` deletes the draft and upgrades the live version with its own configuration (plus the `--config-file` you pass with it), and reports the deleted key as `DiscardedDraftKey`. Address the deployment by key for this from CI/CD — on an older server the name form can only find the draft with a user session. A draft still being validated cannot be discarded yet (`Retry: RetryLater`). A Setup activation started in Orchestrator and left unfinished is a draft too, of the live version: both commands refuse while it exists and name it as such — finish it in Orchestrator, or discard it the same way. A deployment whose *first* install never completed has nothing to upgrade: fix and re-run its `deploy run`, or, to deploy another version, delete the draft with `uip solution deploy delete <name> --yes` (plus the deploy's `--personal-workspace` / `--feed` flag) and run `deploy run` again — `deploy run` names that command when it refuses.
|
|
169
173
|
|
|
170
|
-
**Replacing an installed resource with a link deletes it.** When a `deploy run` config file (or the new version in a `deploy upgrade`) links a resource that the deployment already installed, the server deletes the installed copy and its data — and asks for confirmation first. Without `--acknowledge-permanent-deletion` the command stops (`ErrorCode: invalid_argument`), lists the resources in `Message` and in `Data.PermanentDeletionResources`, and installs nothing; the attempt is kept as a pending draft. Re-run the same command with `--acknowledge-permanent-deletion` to confirm — for `deploy upgrade` do **not** add `--discard-draft`, which would drop the links being confirmed (the command refuses the two together on such a draft); the flag lets the same-version draft through: each listed resource is acknowledged, the same install runs once more, and the success output names them in `PermanentlyDeletedResources`. If that re-run is refused before it runs (e.g. a `429`), nothing was deleted but the acknowledgement stays on the draft: the next run of the same command deletes them without asking. To keep the installed copies, remove the links instead (`deploy config unlink` for `deploy run`; for `deploy upgrade`, `--discard-draft` without the flag, or remove them in Orchestrator). The flag is independent of `--yes`, and nothing ever prompts.
|
|
174
|
+
**Replacing an installed resource with a link deletes it.** When a `deploy run` or `deploy upgrade` config file (or the new version in a `deploy upgrade`) links a resource that the deployment already installed, the server deletes the installed copy and its data — and asks for confirmation first. Without `--acknowledge-permanent-deletion` the command stops (`ErrorCode: invalid_argument`), lists the resources in `Message` and in `Data.PermanentDeletionResources`, and installs nothing; the attempt is kept as a pending draft. Re-run the same command with `--acknowledge-permanent-deletion` to confirm — for `deploy upgrade` do **not** add `--discard-draft`, which would drop the links being confirmed (the command refuses the two together on such a draft); the flag lets the same-version draft through: each listed resource is acknowledged, the same install runs once more, and the success output names them in `PermanentlyDeletedResources`. If that re-run is refused before it runs (e.g. a `429`), nothing was deleted but the acknowledgement stays on the draft: the next run of the same command deletes them without asking. To keep the installed copies, remove the links instead (`deploy config unlink` for `deploy run`; for `deploy upgrade`, `--discard-draft` without the flag, or remove them in Orchestrator). The flag is independent of `--yes`, and nothing ever prompts.
|
|
171
175
|
|
|
172
176
|
**One deployment per package.** `deploy run` always creates a *new* deployment in a *new* Orchestrator folder — it never updates an existing one, and it cannot deploy into a folder that already exists (Orchestrator renames the folder instead, `MySolution` -> `MySolution 1`). So if the package is already deployed, the command stops and lists the existing deployments rather than quietly adding another folder. That check is best-effort, not a guarantee: a failed lookup only logs a warning, and a CI job signed in with an application (client-credentials) account is never stopped by it — an existing deployment is reported as a warning and the deploy goes ahead (on servers without the Pipelines deployment search the check is skipped, with a warning). In automation, track what you have already deployed instead of relying on the stop. To ship a new version, upgrade the existing deployment in place with `uip solution deploy upgrade <deployment-key>`; to start over, `deploy uninstall`, then `deploy delete` to clear the record it leaves in `deploy list` (that record does not block a redeploy — `blocksRedeploy` lets an uninstalled deployment through — so the delete is housekeeping, not a prerequisite). Pass `--yes` only when you really do want a second, independent copy, and give it a different `--name`: the install is keyed on the deployment name, so re-using an existing one updates that deployment in place instead. While you are still iterating, validate locally (`solution pack --dry-run`) instead of deploying each attempt.
|
|
173
177
|
|
|
178
|
+
**Debugging is not deploying.** To debug, run or test the solution, run its lead project — the one the user names, or the one that starts the process and calls the others — with that project type's debug command: `uip maestro flow debug <project-dir>`, `uip maestro case debug <project-dir>`, `uip agent debug <project-dir>`, or `uip rpa debug start --file-path <file> --project-dir <project-dir>`. Run `uip solution resources refresh` first. A debug runs in your Personal Workspace, the same way as the Debug button in Studio and Studio Web: it publishes no package, creates no deployment and creates no folder. Use `pack` → `publish` → `deploy run` only when you mean to deploy.
|
|
179
|
+
|
|
174
180
|
**Activation lifecycle.** `deploy run` activates by default. To split the steps:
|
|
175
181
|
|
|
176
182
|
```bash
|
|
177
183
|
uip solution deploy run --skip-activate ... # leaves "Inactive (Ready to activate)"
|
|
178
|
-
uip solution deploy activate <deployment
|
|
179
|
-
uip solution deploy uninstall <deployment
|
|
180
|
-
uip solution deploy uninstall <deployment
|
|
181
|
-
uip solution deploy delete <deployment
|
|
184
|
+
uip solution deploy activate <deployment> # activate later
|
|
185
|
+
uip solution deploy uninstall <deployment> --yes # remove the deployment + its resources (--yes required; the CLI never prompts)
|
|
186
|
+
uip solution deploy uninstall <deployment> --force # same, past uncompleted jobs and the permanent deletion of resources replaced by links (implies --yes)
|
|
187
|
+
uip solution deploy delete <deployment> --yes # remove what uninstall leaves behind (--yes required)
|
|
182
188
|
```
|
|
183
189
|
|
|
184
190
|
`deploy run` reports `ActivationStatus: SuccessfulActivate` when the deployment runs. When the install landed but a resource needs "Setup activation" in Orchestrator first, it is still `Result: Success`, with `ActivationStatus: NeedsSetupToActivate`, `PendingResources` and `NextSteps` — the deployment exists, so do **not** run the deploy again; complete the setup, then `deploy activate`. When the server already reports that state after the install, `deploy run` does not try to activate (the service would refuse it). `ReadyToActivate` in the same place means the install landed and the command could not activate it: run `deploy activate`.
|
|
185
191
|
|
|
192
|
+
**A folder needs a runtime for its unattended jobs.** Once the package is installed, `deploy run` and `deploy upgrade` check that the deployment's folder has a runtime its processes' unattended jobs can start on, from the package's own process list and `uip or folders runtimes` (it counts machines the folder inherits from its parents). An RPA process needs one of Serverless, Unattended, NonProduction, TestAutomation, AutomationCloud, AutomationCloudTestAutomation, AppTest or PerformanceTest slots (plus Development in a Personal Workspace); a test case one of Serverless, ServerlessTestAutomation, TestAutomation, AutomationCloud, AutomationCloudTestAutomation, AppTest or Unattended; an MCP server a serverless machine. Apps, agents, flows, API workflows, functions, cases, business rules and BPMN processes are not checked: they need no machine in the folder. Neither is a process the deployment links to an existing one (`deploy config link`): its jobs run in the linked process's folder. The folder read has no Attended row (attended is licensed per user), so the warning speaks only of triggers and Orchestrator-started jobs; running the process attended from Assistant is not affected. Each process the folder cannot run unattended is one line in `Data.Warnings`, also printed on stderr, naming the folder, the process and the fix — assign a machine to the folder (`uip or machines list`, then `uip or machines assign <machine-key> --folder-path <folder>`), and confirm with `uip or folders runtimes --folder-path <folder>`. When the check cannot run — the login cannot read the folder's runtimes (an external app without the `OR.Machines` scope, say), a lookup fails, or it does not finish within 10 seconds — `Data.Warnings` says so instead. When a user session's read of the deployment's links fails, the warning adds that the process may be linked. Either way the command still reports `Result: Success` with its usual exit code: the deployment exists, so do **not** deploy again — fix the folder. `Data.Warnings` is absent when there is nothing to say.
|
|
193
|
+
|
|
186
194
|
`uninstall`, `delete`, `activate` and `status` take the deployment **name** as a positional argument (no `--name` flag). `status` also accepts a **deployment key** (from `deploy list` or `deploy upgrade` — the form that diagnoses a stale key) or the **pipeline deployment ID** from `deploy run` (that run's progress and errors, `Code: SolutionDeployStatus`); by name or key it answers `Code: SolutionDeployment` and reports the record's `Operation`, `OperationStatus`, `ActivationStatus`, `Actions`, and `NextSteps` when it is not live. A name is found across feeds; a key outside the tenant feed needs `--personal-workspace` or `--feed <name-or-key>`, as with `deploy list`. `Superseded: null` means the CLI could not tell — the chain search failed or holds no row for the key — and the fields are the requested record's own; take the current key from `deploy list`.
|
|
187
195
|
|
|
188
|
-
**Two status axes.** `OperationStatus: Successful` means the last operation's content landed. `ActivationStatus: Active` means the deployment runs. An upgrade can land `Successful` *and* `NeedsSetupToActivate`: the new version is installed but does not run until "Setup activation" is completed in Orchestrator (Tenant > Solutions > Deployments); the previous version keeps running meanwhile. The UI words the same states differently: `NeedsSetupToActivate` shows as **Inactive (Needs setup)**, `Operation: VersionChange` as **Change version**, `Operation: ActivationSetup` as **Activation setup** — and the UI lists every record of a deployment, where `deploy list` shows only the newest. `deploy upgrade` reports both axes; when not `Active` it adds `PendingResources` (the resources the service flags as needing configuration — Integration Service connections, typically — each with the `Reason` the activation validation gives, such as a connection that needs authenticating, and the Orchestrator `FolderPaths` it lives in when the server reports them) and `NextSteps`. On current servers this works the same for an external app (CI/CD) as for a user session; on older servers an external app may see `ActivationStatus` without `PendingResources`, and `NextSteps` say the resources could not be read.
|
|
196
|
+
**Two status axes.** `OperationStatus: Successful` means the last operation's content landed. `ActivationStatus: Active` means the deployment runs. An upgrade can land `Successful` *and* `NeedsSetupToActivate`: the new version is installed but does not run until "Setup activation" is completed in Orchestrator (Tenant > Solutions > Deployments); the previous version keeps running meanwhile. The UI words the same states differently: `NeedsSetupToActivate` shows as **Inactive (Needs setup)**, `Operation: VersionChange` as **Change version**, `Operation: ActivationSetup` as **Activation setup** — and the UI lists every record of a deployment, where `deploy list` shows only the newest. `deploy upgrade` reports both axes; when not `Active` it adds `PendingResources` (the resources the service flags as needing configuration — Integration Service connections, typically — each with the `Reason` the activation validation gives, such as a connection that needs authenticating, and the Orchestrator `FolderPaths` it lives in when the server reports them) and `NextSteps`. On current servers this works the same for an external app (CI/CD) as for a user session; on older servers an external app may see `ActivationStatus` without `PendingResources`, and `NextSteps` say the resources could not be read. To link those resources to existing ones from the CLI, follow `NextSteps`: `deploy config get <package> --package-version <deployed-version> -d config.json` (plus the deployment's `--personal-workspace` / `--feed` when it is not in the tenant feed; the steps print it, and always pin the version — fill a printed `<deployed-version>` placeholder rather than dropping the flag, since an upgrade without `--version` moves to the newest version), `deploy config link config.json <resource> --name <existing> --folder-path <folder>` for each one, keep only those resources in the file, then `deploy upgrade <deployment-key> --version <deployed-version> --config-file config.json` (a configuration change on the same deployment — see "Changing a live deployment's configuration") and `deploy activate <name>`. **Do not uninstall a deployment to relink it**: that throws its history away. Authenticating a connection in place is done in Orchestrator's "Setup activation"; the `resource`/`resources` verbs edit the solution project, not a deployment. `deploy activate` is refused (`4007 … cannot be activated`) until one of the two is done.
|
|
189
197
|
|
|
190
198
|
**A key is one record, not the deployment.** Every operation creates a new deployment record with its own key: `deploy run` the Install record, `deploy upgrade` a VersionChange one (`DeploymentKey` in its output; `InstallDeploymentKey` is the one that never changes). `deploy list` shows the newest per deployment. A key from before an upgrade is *superseded*: the Solutions record still answers as it was — old version, `Active`, `Upgrade` offered — but `deploy upgrade <key>` resolves it to the deployment's current generation through the Pipelines lookup and upgrades that, and `deploy status <key>` reports `Superseded: true` with `CurrentDeploymentKey`. Store `InstallDeploymentKey`, or take the current key from `deploy list`.
|
|
191
199
|
|
|
@@ -203,9 +211,11 @@ So a full clean-up of a live deployment is two commands: `uninstall` removes its
|
|
|
203
211
|
|
|
204
212
|
`uninstall` waits out an operation that blocks it: when Orchestrator refuses because the deployment still has something running, the CLI polls until that finishes and then sends the request again, all inside `--timeout` (which covers the whole command, the status poll included). If it is still busy when the timeout expires you get exit `2` with `ErrorCode: timeout` and `Retry: RetryLater` — retry later, do not treat it as permanent. A refusal for any other reason (superseded, inactive, unknown name) still fails immediately with exit `1`.
|
|
205
213
|
|
|
214
|
+
`<deployment>` on `activate`, `uninstall` and `delete` is the deployment's name or its `Key` from `deploy list`. A key is looked up through the Pipelines deployment lookup, which spans every feed and gives the deployment's name and feed, so no feed flag is needed next to it (the feed the record lives in wins over one you pass), and a superseded key acts on the deployment's current record. `Data.DeploymentName` is the name the key resolved to. A GUID that is no key is tried as a name; when neither matches, the failure says `No deployment with the key or name '<guid>' was found` (`ErrorCode: not_found`). A key that cannot be read (an outage, a refused login) is reported as that failure, never as not found. `delete` by key deletes only the record the key resolved to: when the deployment search does not list that record yet (it is an index and can lag), it deletes nothing and fails with `Retry: RetryLater`, so retry the same command a moment later. Under an external-app login, a key whose record lives in a folder feed or a Personal Workspace is refused (`feed_requires_user_session`) on a server that does not apply the feed to client-credentials requests, as with `--feed`.
|
|
215
|
+
|
|
206
216
|
`uninstall` and `activate` do not need a feed flag: without one they find the deployment themselves — tenant feed first, then your Personal Workspace, then the folder feeds you can reach — and scope their requests to whatever feed holds it. So the `deploy activate <name>` that `--skip-activate` points you at works the same on a `--personal-workspace` or `--feed` deployment as on a tenant one. The cost is a lookup per feed until the name is found, and a name that exists in no feed you can see is reported as not found rather than as a blocked uninstall. When you know the feed, pass it: `uninstall`, `activate` and `delete` take `--personal-workspace` or `--feed <name-or-key>` (a `Name` or `Key` from `uip solution feeds list`) and then search that feed alone. The commands the CLI prints as next steps already carry the flag for the feed the deployment was found in. With `--feed` naming a folder feed, an external-app (client-credentials) login works only on a server that applies the feed to client-credentials requests, and is refused on an older one; `--personal-workspace` is always refused to an external app.
|
|
207
217
|
|
|
208
|
-
`deploy delete` and `deploy status <name>` (without a feed flag) find a name the same way. All four say "not found" only when every feed answered — with one exception: under an external-app login, `deploy status <guid>` for a GUID that is no deployment key still says "not found" when only the feeds after the tenant could not be searched, or when the tenant search refused the login (401/403), because an app login cannot read those feeds at all. When a feed cannot be searched — the feed service is down or refuses the session, the list of feeds cannot be read or gives a feed no key, or the tenant search itself fails — and no other feed has the name, they fail with a message that names the feeds they could not search instead of calling the name unknown. `ErrorCode` then comes from that failure (`server_error`, `network_error`, `authentication_required`, `permission_denied`, …, or `unknown_error` when it has no known class) and is never `not_found`; `Retry` follows it — `RetryLater` for an outage, `RetryWillNotFix` for a 401 or 403, and also `RetryWillNotFix` when every feed that could not be searched is one the list gives no key, since a retry gets the same list. Do not treat the name as wrong: do what `Instructions` say (log in again, fix the session's access, or retry later). To check one feed yourself, pass `--personal-workspace` or `--feed <name-or-key>` to `deploy status` or `deploy list`, or to the `activate`, `uninstall` or `delete` you meant to run — but `--feed` is resolved through the same list of feeds, so when that list is what failed only `--personal-workspace` helps, and `--feed` cannot pick a feed the list gives no key. When the tenant feed refuses an `activate` or `uninstall` for its own reason (401, 403, 409, 422, 429, a 5xx), that failure is reported as it is.
|
|
218
|
+
`deploy delete` and `deploy status <name>` (without a feed flag) find a name the same way. Without a feed flag, `deploy status <name>` also answers for a deployment you uninstalled, as `deploy list` shows it (`Operation: Uninstall`, `ActivationStatus: None`, `Actions: ["Delete"]`), unless a feed holds a live deployment of that name. When a feed that could not be searched may come back on a retry (an outage), it fails like a missed name instead, with `Retry: RetryLater`, since that feed may hold the live deployment. When no retry can reach it (an external-app login that cannot list feeds skips all but the tenant feed), it shows the uninstalled record, and the first `NextSteps` line names the feeds it could not search. With `--personal-workspace` or `--feed`, `deploy status <name>` shows that feed's newest record, uninstalled or not. A name no feed knows is `ErrorCode: not_found`, `Retry: RetryWillNotFix`. All four say "not found" only when every feed answered — with one exception: under an external-app login, `deploy status <guid>` for a GUID that is no deployment key still says "not found" when only the feeds after the tenant could not be searched, or when the tenant search refused the login (401/403), because an app login cannot read those feeds at all. When a feed cannot be searched — the feed service is down or refuses the session, the list of feeds cannot be read or gives a feed no key, or the tenant search itself fails — and no other feed has the name, they fail with a message that names the feeds they could not search instead of calling the name unknown. `ErrorCode` then comes from that failure (`server_error`, `network_error`, `authentication_required`, `permission_denied`, …, or `unknown_error` when it has no known class) and is never `not_found`; `Retry` follows it — `RetryLater` for an outage, `RetryWillNotFix` for a 401 or 403, and also `RetryWillNotFix` when every feed that could not be searched is one the list gives no key, since a retry gets the same list. Do not treat the name as wrong: do what `Instructions` say (log in again, fix the session's access, or retry later). To check one feed yourself, pass `--personal-workspace` or `--feed <name-or-key>` to `deploy status` or `deploy list`, or to the `activate`, `uninstall` or `delete` you meant to run — but `--feed` is resolved through the same list of feeds, so when that list is what failed only `--personal-workspace` helps, and `--feed` cannot pick a feed the list gives no key. When the tenant feed refuses an `activate` or `uninstall` for its own reason (401, 403, 409, 422, 429, a 5xx), that failure is reported as it is.
|
|
209
219
|
|
|
210
220
|
## Dependency Feeds
|
|
211
221
|
|
|
@@ -285,11 +295,13 @@ uip solution publish ./out/<package>.zip --wait # block until th
|
|
|
285
295
|
|
|
286
296
|
`--feed` and `--personal-workspace` cannot be combined. Deploy a package from the feed it was published to: `deploy run` takes the same `--feed <name-or-key>` or `--personal-workspace`.
|
|
287
297
|
|
|
298
|
+
`publish` checks its argument before it uploads anything: a path with no file is `ErrorCode: not_found`, and a file that is not the solution `.zip` (a solution source, a project `.nupkg`, any other type) is `invalid_argument`, with the pack command to run in `Instructions`.
|
|
299
|
+
|
|
288
300
|
`publish` also accepts `--package-name` / `--package-version`, but those rewrite `solutionMetadata.json` inside the `.zip`, so they only work on a package produced by `uip solution pack`. Prefer packing with the name and version you want.
|
|
289
301
|
|
|
290
302
|
```bash
|
|
291
303
|
uip solution packages list --limit 100 # what's published to the tenant feed
|
|
292
|
-
uip solution packages download <package-name> [package-version] # pull a .zip back from the tenant feed (latest if version omitted; -d for the destination)
|
|
304
|
+
uip solution packages download <package-name> [package-version] # pull a .zip back from the tenant feed (latest if version omitted; -d for the destination); Data.SolutionId names the solution it was packed from
|
|
293
305
|
uip solution packages delete <package-name> <package-version> --yes # remove a version (--yes required)
|
|
294
306
|
```
|
|
295
307
|
|
|
@@ -331,10 +343,14 @@ uip solution delete <solution-id> --yes # remove a solution from Studio Web (
|
|
|
331
343
|
|
|
332
344
|
The bundle `upload` sends leaves out `.venv`, `node_modules`, `__pycache__`, `.git`, `.local` and `.flow-sdk` folders and `.env` / `.env.*` files on its own. To leave more out, add a `.uipignore` file at the solution root (or inside a project, where its patterns apply to that project only) using `.gitignore` syntax — `dist/`, `*.log`, `!keep.log`, `MyAgent/generated/`; a line-leading `#` is a comment. A pattern that would drop a project the `.uipx` lists is refused — remove the project with `uip solution projects remove` instead. `uip codedapp push` honors the same file (its older `.uipathignore` is deprecated — use `.uipignore`). `solution pack` does not read it.
|
|
333
345
|
|
|
346
|
+
Studio Web refuses a file inside a project folder whose name holds a control character or any of `: * ? " < > |` (a folder name holding one is fine). `upload` checks for this before it sends anything and fails with `ErrorCode: invalid_argument`, naming each such file; rename it, or leave it out with `.uipignore`.
|
|
347
|
+
|
|
334
348
|
If Studio Web refuses the upload with 401 or 403, do **not** re-run `uip login` — the CLI checks the session and its token expiry before it calls, so the token was valid and re-authenticating produces the same one. The failure is about what the acting identity may do in Studio Web (for a CI pipeline: the external application's `StudioWebS2S` grants) or about the tenant the bundled `SolutionId` belongs to. The envelope's `Instructions` name both, and an application 401 is reported as `ErrorCode: permission_denied` rather than `authentication_required`.
|
|
335
349
|
|
|
336
350
|
If `solution upload` or `solution delete` fails while checking the session, it reports the actual auth failure before contacting Studio Web. `Result: ConfigError` with `ErrorCode: configuration_error` means an environment auth setting is invalid or missing; fix the setting named in `Message`. A missing session asks for `uip login`, while a session without the required organization or tenant asks you to select an active tenant with `uip login tenant set <tenant>`.
|
|
337
351
|
|
|
352
|
+
`download` takes a **Studio Web solution ID** — not a project key, process key, deployment key or package name; any of those answers `ErrorCode: not_found`. To get back to the source of a *deployed* solution, go through its package: `uip solution deploy list --folder-path <parent-folder>` gives the deployment's `PackageName` and `PackageVersion`, and `uip solution packages download <package-name> <package-version>` reports `Data.SolutionId`, the solution the package was packed from. When that solution is in Studio Web (it was built there, or uploaded with `solution upload`), `uip solution download <SolutionId> --extract` exports its editable source; when it is not, the downloaded `.zip` — the published package — is all the tenant holds.
|
|
353
|
+
|
|
338
354
|
`download` writes the `.uis` archive and nothing else — extraction is opt-in. Pass `--extract` to also unzip it into a sibling directory named after the archive; that directory is a working solution tree, with the `.uipx` manifest at its root. `--extract` also drops `AGENTS.md` and `CLAUDE.md` there so an agent picking the solution up has the same briefing `uip solution init` writes. It only fills gaps: a file the archive already carried is left alone, and the paths actually written come back in `Data.BriefingFiles`. Without `--extract` you get the zip only, and no briefing files — there is no solution directory to put them in.
|
|
339
355
|
|
|
340
356
|
Two more verbs act on a **cloud** solution project rather than the local tree — do not confuse them with the local `projects add` / `import` / `remove` / `list` membership commands above:
|
|
@@ -368,7 +384,7 @@ Packaging stages the selected source after copying other files and inlines its `
|
|
|
368
384
|
After editing a project's bindings, or after `solution projects import` (which doesn't auto-sync resources), reconcile the solution-level inventory:
|
|
369
385
|
|
|
370
386
|
```bash
|
|
371
|
-
uip solution resources refresh # re-scan every project,
|
|
387
|
+
uip solution resources refresh # re-scan every project, add resources for new bindings
|
|
372
388
|
```
|
|
373
389
|
|
|
374
390
|
`solution resources refresh` creates new resources for bindings not yet in the solution and imports from Orchestrator when a matching resource already exists.
|
|
@@ -377,6 +393,8 @@ It also generates or regenerates each project's own resources (its `package` and
|
|
|
377
393
|
|
|
378
394
|
**Refresh is import-only for cloud resources. It never overwrites an imported resource** — that is what keeps your local edits (a renamed resource, a patched retry count) from being wiped on every re-scan. So if you change an entity, queue or asset **in the cloud** after importing it, `refresh` will not pick the change up: it reports the resource under `Skipped` and leaves it alone. To pull the new cloud definition, use `resources edit --source remote` (below).
|
|
379
395
|
|
|
396
|
+
**Refresh never removes a resource either.** Delete the task or node that bound a process or app and its declaration stays in the solution, and deploy still provisions it. When every project's bindings were read, `refresh`, `pack` and `upload` warn about each process or app no binding names and no other resource depends on: `process "<name>" is declared in the solution but no project binds it, and deploy still provisions it. If nothing needs it, remove it: uip solution resources remove <key>` (in `Data.Warnings` for refresh, on stderr for all three). Nothing is deleted for you: run that command if the resource is no longer needed. A project's own resources and queues, assets and other kinds are not checked.
|
|
397
|
+
|
|
380
398
|
**A failed Resource Catalog call is not a "not found".** `resources refresh`, `pack`, `upload`, `projects add` and `projects import` look each binding up in the Resource Catalog. When that lookup fails — the catalog refuses the login with 401/403, it is unreachable, or (for `pack`, which runs without a login) there is no login — nothing is created for the binding, because a local stub would deploy as a new, empty resource instead of the one in the cloud. The same goes for a resource the catalog found but whose import was refused. A binding the solution already holds keeps that resource as it is. Refresh reports what it could not check in `Data.Warnings` and exits `0`; `projects add` / `import` log it as a warning. `pack` and `upload` fail when a binding the solution does **not** hold could not be resolved: `ErrorCode: permission_denied` for a refused login (`Retry: RetryWillNotFix`), `server_error` or `rate_limited` (`Retry: RetryLater`) when the catalog is down or throttling, and — `pack` only — `authentication_required` with no login. `resources refresh` and `upload` check the login before they start, so with no login they fail on that check instead, as before. After no login or a 401/403 the rest of the bindings are not looked up. A resource the solution provisions itself from a project's own files — a case role — is never looked up, so a solution whose only unresolved bindings are case roles packs with no login. From CI/CD, run `uip solution resources refresh` under a login the catalog accepts (a user login), commit the solution's resources, and the pipeline's `pack` then uses them as they are. An import that fails for any other reason still falls back to a local resource, and says so in the warnings.
|
|
381
399
|
|
|
382
400
|
`pack` and `upload` also stop if a project's contributed bindings are invalid. Fix the project's source file or inline agent and retry; these commands do not ship a solution with missing resources.
|
|
@@ -393,8 +411,26 @@ resource's `spec.actionSchema`. Two things follow:
|
|
|
393
411
|
`webAppManifest.json` does not parse, or a Coded Action project whose
|
|
394
412
|
`action-schema.json` is missing or does not parse, for example. The message
|
|
395
413
|
names the file and the project, and the envelope carries
|
|
396
|
-
`ErrorCode: invalid_argument`.
|
|
397
|
-
|
|
414
|
+
`ErrorCode: invalid_argument`. No solution resource is synced before that
|
|
415
|
+
check passes, so fix the file and re-run the command.
|
|
416
|
+
- Before that check, `pack` and `upload` give each project one round to bring
|
|
417
|
+
the resources it owns in step with its own sources. A Flow project uses it
|
|
418
|
+
for Extract document nodes: every processor an Extract document node defines
|
|
419
|
+
has its
|
|
420
|
+
`resources/solution_folder/idpProcessor/extraction/<Name>.json` regenerated
|
|
421
|
+
from the node, and one is created when missing. That round can fail the
|
|
422
|
+
command on its own, with `ErrorCode: invalid_argument` and one of two codes:
|
|
423
|
+
`idp_processor_duplicate_author` when two Extract document nodes define one
|
|
424
|
+
processor, and `idp_processor_unprovisioned` when a node names no processor the
|
|
425
|
+
runtime can resolve — none at all, or a processor folder without its name — packing it would ship an extraction that faults at run time, and
|
|
426
|
+
inventing an identity inside a build writes a source file nobody asked it to,
|
|
427
|
+
so the message names `uip maestro flow nodes provision` as the fix instead.
|
|
428
|
+
The messages name the nodes, and the project that reports the problem writes
|
|
429
|
+
nothing. Projects are prepared in turn, so in a solution holding several Flow
|
|
430
|
+
projects one prepared earlier may already have regenerated its own resource
|
|
431
|
+
files; those come from its own nodes, and the next pack writes them the same
|
|
432
|
+
way. What the round writes is the resource files themselves; your project's
|
|
433
|
+
own files are its input.
|
|
398
434
|
|
|
399
435
|
For project types whose resources do not depend on a tool contribution, refresh
|
|
400
436
|
does not warn when the installed tool has nothing to contribute. Use
|
|
@@ -413,12 +449,65 @@ that matters.
|
|
|
413
449
|
|
|
414
450
|
### A coded app's build output
|
|
415
451
|
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
452
|
+
`uip solution pack` **builds every coded app it packs**, the way packing an RPA
|
|
453
|
+
project compiles it, so a CI pipeline needs no build step of its own — only
|
|
454
|
+
Node.js on the runner. In the folder that holds the app's `package.json` (the
|
|
455
|
+
nearest one above the bundle folder), pack installs the dependencies when
|
|
456
|
+
`node_modules/` is missing, then runs the `build` script, with the package
|
|
457
|
+
manager the lockfile names: `package-lock.json` → `npm ci`, `pnpm-lock.yaml` →
|
|
458
|
+
`pnpm install --frozen-lockfile`, `yarn.lock` → `yarn install
|
|
459
|
+
--frozen-lockfile`, `bun.lock` → `bun install --frozen-lockfile`, none →
|
|
460
|
+
`npm install` (which writes a `package-lock.json`). It skips the build when the
|
|
461
|
+
bundle folder is there and the app's files match the last build: pack keeps a
|
|
462
|
+
SHA-256 of the app's files (except `node_modules/`) in `.uipath-build.json`
|
|
463
|
+
beside `package.json`, and rebuilds when a file changed, was added or removed,
|
|
464
|
+
or the bundle folder is gone. Git-ignore that file. An app whose
|
|
465
|
+
`package.json` has no `build` script, or that has no `package.json`, is packed
|
|
466
|
+
from its existing folder as it is — and when that folder is missing, pack fails
|
|
467
|
+
with `ErrorCode: invalid_argument` and says to add a `build` script or repoint
|
|
468
|
+
`config.bundlePath`. `uip codedapp pack <dist>` never builds: it packs the
|
|
469
|
+
folder it is given.
|
|
470
|
+
|
|
471
|
+
`--skip-build` turns the install and the build off for every coded app in the
|
|
472
|
+
pack, which then ships whatever `config.bundlePath` already holds. Use it when
|
|
473
|
+
an earlier pipeline step built the app, or when the pack step cannot reach the
|
|
474
|
+
package registry. A stale `dist/` then ships as it is, and a missing one fails
|
|
475
|
+
the pack with `ErrorCode: invalid_argument` and `Instructions` to build the app
|
|
476
|
+
first:
|
|
477
|
+
|
|
478
|
+
```bash
|
|
479
|
+
(cd my-app/source && npm ci && npm run build) # the pipeline builds the app
|
|
480
|
+
uip solution pack . ./out --skip-build # pack ships that output
|
|
481
|
+
```
|
|
482
|
+
|
|
483
|
+
`solution pack --dry-run` builds too, in its temporary copy of the solution,
|
|
484
|
+
and leaves your folder untouched. The copy leaves `node_modules/` behind, so
|
|
485
|
+
when the app needs a build, a dry run installs its dependencies from scratch
|
|
486
|
+
and needs the same registry access a real pack does. An app whose build is
|
|
487
|
+
current is not rebuilt, so it needs neither. A `.uis` input also installs from
|
|
488
|
+
scratch: an uploaded bundle never carries `node_modules/`.
|
|
489
|
+
|
|
490
|
+
The install and the build run with the environment `uip` was started with, so
|
|
491
|
+
`PATH`, proxy and registry settings (a private feed's token included) apply.
|
|
492
|
+
The CLI's own UiPath token is taken out — `UIPATH_CLI_AUTH_TOKEN` and
|
|
493
|
+
`UIPATH_ACCESS_TOKEN` are not set in the build — so a build that needs a
|
|
494
|
+
UiPath credential has to get it under a name of its own.
|
|
495
|
+
|
|
496
|
+
A build that fails, or a package manager that is not on `PATH`, fails the pack
|
|
497
|
+
with `ErrorCode: invalid_argument` / `Retry: RetryWillNotFix`: `Message` names
|
|
498
|
+
the folder, the command and its exit code, followed by the end of the build
|
|
499
|
+
output, and `Instructions` say which command to run there. Fix the build —
|
|
500
|
+
retrying will not help. An install that fails is different: it fails with
|
|
501
|
+
`ErrorCode: execution_failed` / `Retry: RetryLater`, since the cause is often
|
|
502
|
+
the package registry or the network rather than the app. Read the output in
|
|
503
|
+
`Message`: if the registry could not be reached, pack again once it can (or
|
|
504
|
+
build the app in an earlier step and pass `--skip-build`); otherwise run the
|
|
505
|
+
install command it names in that folder and fix what it reports.
|
|
506
|
+
|
|
507
|
+
The folder that gets packed is `config.bundlePath` in the app's
|
|
508
|
+
`webAppManifest.json`, relative to the project directory — `source/dist` for an
|
|
509
|
+
app `uip codedapp init` scaffolded inside a solution, `dist` for a standalone
|
|
510
|
+
one. The build has to write there.
|
|
422
511
|
|
|
423
512
|
Pack **fails** when that folder holds no HTML entry point (`index.html`,
|
|
424
513
|
`main.html` or `app.html`, unless `config.mainFile` selects another HTML file),
|
|
@@ -483,8 +572,11 @@ A resource is either **virtual** — declared locally now, provisioned when the
|
|
|
483
572
|
uip solution resources add --source local --kind Queue --name InvoiceQueue
|
|
484
573
|
uip solution resources add --source local --kind Asset --type Credential --name ApiLogin
|
|
485
574
|
uip solution resources add --source remote --kind Process --name Existing --folder-path Shared
|
|
575
|
+
uip solution resources add --source remote --kind Queue --cloud-key <resource-key>
|
|
486
576
|
```
|
|
487
577
|
|
|
578
|
+
`--cloud-key` (remote only) imports that exact resource instead of searching by name, so `--name` is optional with it: the resource keeps its cloud name. Pass `--name` too and it must match that name (case-insensitive), or the add fails with `ErrorCode: invalid_argument` and `Instructions` naming the real one. Find the key with `uip solution resources list --source remote --kind <kind>`.
|
|
579
|
+
|
|
488
580
|
`--type` picks the subtype for kinds that have one. For assets it takes the Orchestrator name (`Text`, `Integer`, `Bool`, `Credential`, `Secret`) or the solution name (`stringAsset`, `integerAsset`, `booleanAsset`, `credentialAsset`, `secretAsset`), case-insensitive. A subtype the kind does not have fails with `ErrorCode: invalid_argument`, and `Instructions` lists the valid ones. A kind with no subtypes (a queue) refuses `--type`; a connection's connector type passes through. An empty `--type ""` is refused for every kind; leave the option out instead. With `--source local`, adding a name that already exists with a different `--type` fails instead of returning the existing one. With `--source remote`, `--type` must match the resource's own type: it narrows same-name matches and never changes what gets imported.
|
|
489
581
|
|
|
490
582
|
`--name` is checked before anything is written, because a local resource becomes a file under `resources/solution_folder/<kind>/<name>.json`: a blank or whitespace-only name, a name over 256 characters, or one containing path separators, control characters or any of `: * ? " < > |` fails with `Result: Failure` and a `Message` that names the option (`--name must not be blank`, `--name contains unsafe characters`). `uip agent memory add` runs the same check on `--memory-space` when it declares a memory space in the solution.
|
|
@@ -533,6 +625,8 @@ uip solution resources edit <resource-key> --source remote --force # apply it
|
|
|
533
625
|
uip solution resources remove <resource-key>
|
|
534
626
|
```
|
|
535
627
|
|
|
628
|
+
`remove` refuses three kinds of resource and exits `1` with `ErrorCode: invalid_argument`: a project's own resources (remove the project with `uip solution projects remove <project-path>`), a resource another one still references (remove that one first), and a `package` declaration, which goes only with the resource that pins it. Retrying the same key never helps.
|
|
629
|
+
|
|
536
630
|
`get` reads the solution first. Only a key the solution does not declare is read from the tenant instead (the resource catalog, then an export). Any other local failure is reported as it is and exits `1`; it is never answered with a tenant copy of the same key, so fix the solution rather than retrying.
|
|
537
631
|
|
|
538
632
|
### Picking up a cloud change: `edit --source remote`
|
|
@@ -633,6 +727,17 @@ Standard failure shape: `{ "Result": "Failure", "ErrorCode": "<code>", "Message"
|
|
|
633
727
|
|
|
634
728
|
List commands always return `Data: []` on empty results — never a message object — so consumers can rely on a consistent array shape.
|
|
635
729
|
|
|
730
|
+
After a successful `deploy run`, `deploy upgrade` (when waiting), or `deploy activate`,
|
|
731
|
+
`Data.OrchestratorUrl` opens the deployment in Orchestrator's Solutions tab.
|
|
732
|
+
`Data.FolderUrl` opens the automations page in the installed solution folder when its key is known.
|
|
733
|
+
Both use the session's base URL, organization name, and tenant name. The CLI
|
|
734
|
+
also writes `Deployed: <url>` at info level to stderr (or the configured
|
|
735
|
+
log file); pass `--log-level info` to show it. If the deployment key is unavailable, the URL opens its feed's
|
|
736
|
+
Solutions tab; a missing folder key omits `FolderUrl`. Missing browser
|
|
737
|
+
session coordinates or a URL construction error omit both fields without
|
|
738
|
+
changing the deploy result. `--no-wait`
|
|
739
|
+
upgrade only reports acceptance and omits these links.
|
|
740
|
+
|
|
636
741
|
## Discovering Commands
|
|
637
742
|
|
|
638
743
|
This file is a starting map, not a reference. The live source of truth is the CLI itself:
|
|
@@ -669,11 +774,13 @@ Adjacent groups commonly used alongside solutions:
|
|
|
669
774
|
| Symptom | First thing to check |
|
|
670
775
|
|---|---|
|
|
671
776
|
| `Not authenticated` / 401 | `uip login`, then re-run |
|
|
672
|
-
| `pack` fails with `Context.ErrorCode: case_role_unbound` | A Case project's `metadata.caseRoles` declares a role that has no `Role` entry in its `bindings_v2.json`, so the pack would deploy without it. Run `uip maestro case bindings sync <plan>` in that project (the message names the plan file and the directory), then pack again. The sync writes one `Role` entry per role; pack mints the role resource from it and writes the role's permissions onto that resource, as Studio Web's publish writes them (a retired `CaseManagement.Cases.Manage` and, on a stage role, a permission a stage cannot grant are left out) |
|
|
777
|
+
| `pack` fails with `Context.ErrorCode: case_role_unbound` | A Case project's `metadata.caseRoles` declares a role that has no `Role` entry in its `bindings_v2.json`, so the pack would deploy without it. Run `uip maestro case bindings sync <plan>` in that project (the message names the plan file and the directory), then pack again. The sync writes one `Role` entry per role; pack mints the role resource from it and writes the role's permissions onto that resource, as Studio Web's publish writes them (a retired `CaseManagement.Cases.Manage` and, on a stage role, a permission a stage cannot grant are left out). A debug run's pack leaves a role with no `Role` entry out instead of failing |
|
|
673
778
|
| `pack` fails with `Context.ErrorCode: case_role_name_collision` | One Case project declares two roles whose names differ only by letter case. The schema keeps them apart, but the solution stores one role resource per name regardless of case, so they would deploy as one. Rename one of them in the Case Designer, run `uip maestro case bindings sync <plan>` in that project, then pack again |
|
|
674
779
|
| `pack` fails with `Context.ErrorCode: contribution_conflict` (`Projects '…', '…' each contribute a 'role' named '…' with different actions`) | Two Case projects in the solution declare a case role of the same name with different permissions. A role is one resource for the whole solution, so the pack refuses rather than pick one. Give both plans the same permissions for that role, or rename one of them, then run `uip maestro case bindings sync <plan>` in the project you changed and pack again |
|
|
675
780
|
| `upload` fails with 401/403 and `ErrorCode: permission_denied` | Not a login problem — the token was valid when the call went out, so `uip login` mints the same one. Read `Instructions`: for a session on an external application, check that the app has the Studio Web (`StudioWebS2S`) grants, not only the Orchestrator and Solutions ones; for a user, check Studio Web access in the tenant. Then confirm the `SolutionId` in the `.uipx` belongs to the tenant you are logged into — one from another tenant is refused, not reported missing |
|
|
781
|
+
| `upload` of a `.uis` fails with HTTP 500 and `Context.ErrorCode: 20039` (`Path contains invalid characters`) | A file inside a project folder has a name holding a control character or one of `: * ? " < > |`, and Studio Web does not say which. Retrying fails the same way. Rename the file, or upload the solution directory instead, which names the file before sending anything |
|
|
676
782
|
| `packages list` or `deploy list` fails with `ErrorCode: permission_denied` from a CI/CD pipeline | Both accept an external app on servers that serve their Pipelines search (`POST /v1/pipelines/packages/search`, `POST /v1/pipelines/deployments/search`). An app is refused only on an older server, which has just the user-only search (the message says so), or with `--personal-workspace`, or with a folder `--feed` on a server that does not yet apply the feed to an app's requests (a `--feed` naming the tenant feed works). A `--feed` name is checked against the Studio Web publish locations, which an app reads only with a `StudioWebS2S` grant; without it the CLI uses a `--feed` folder key as given and looks a folder path up through Orchestrator (`OR.Folders`), and the message names those options when that fails too. `uip login` with the same app mints the same kind of token; run the listing under a user session, or drop the feed flag to list the tenant feed. The same goes for `--personal-workspace` on any command: an external app has no Personal Workspace. |
|
|
783
|
+
| `deploy run` fails with `ErrorCode: permission_denied` and `Message` `Forbidden (403). Your account has no permission to deploy into …` | The install was refused for the target: the folder named in `Message` (the tenant root when none is named, or your Personal Workspace). The cause is a missing folder role, not the token's scopes, so `uip login` or re-checking scopes will not help. Ask a tenant administrator for `SolutionDeployments.Create` (tenant) or `FolderSolutionDeployments.Create` (that folder), or deploy into another folder with `--parent-folder-path`, or into `--personal-workspace`. An external app also needs the `Solutions.Deployments.Write` scope. The server's own reply follows `Details:` in `Instructions` |
|
|
677
784
|
| `pack` or `upload` fails with `ErrorCode: permission_denied` (or `pack` with `authentication_required`) and a message naming the Resource Catalog | The catalog refused the login (or there was none), so bindings the solution does not hold yet could not be resolved, and the command will not pack them as empty stubs. Run `uip solution resources refresh` under a user login, commit the solution's resources, then re-run. Bindings already in the solution are fine as they are |
|
|
678
785
|
| Command targets the wrong tenant | `uip login tenant set <tenant>`; verify with `uip login status` |
|
|
679
786
|
| Pack succeeds but publish 409s | Version conflict — bump the version (`uip solution pack . ./out -v <new-version>`) and publish that. Do not delete the published version to reuse its number: anything deployed from it depends on it. Delete it only when the user asks for it — `uip solution packages delete <package-name> <version> --yes`. The CLI never prompts, so `--yes` is the only check; ask the user first |
|
|
@@ -681,12 +788,12 @@ Adjacent groups commonly used alongside solutions:
|
|
|
681
788
|
| `HTTP 400 … cannot be uninstalled` (error `4007`) | The deployment is not uninstallable in its state — superseded, already uninstalled, or left by a failed install. Read `Instructions`: when its `Actions` list offers `Delete`, remove the record with `uip solution deploy delete <name> --yes`. An operation still running is the other cause, and that one clears by itself (`Retry: RetryLater`) |
|
|
682
789
|
| `deploy uninstall` fails with `Message` "Uninstall failed with status: FailedUninstall: this deployment has uncompleted jobs…" or "…permanently deletes these resources and their data: …", or "Deployment '<name>' was not uninstalled: …" | Orchestrator wants explicit consent: the deployment has uncompleted jobs (`Data.JobsNotInFinalState: true`), or uninstalling it permanently deletes resources that were replaced by links (`Data.PermanentDeletionResources`; the "was not uninstalled" form is the synchronous HTTP 409, error `4026`). Re-run with `--force` only if that is acceptable; otherwise let the jobs finish first. Retrying without `--force` does not help (`Retry: RetryWillNotFix`) |
|
|
683
790
|
| `deploy uninstall` fails with `Message` "Deployment '<name>' was not uninstalled: its Uninstall validation reports errors that --force cannot get past: …" | The deployment also awaits the permanent-deletion confirmation, but its validation holds an error `--force` does not skip (named after the colon, with its code). Resolve that in Orchestrator and run the uninstall again without `--force` (`Retry: RetryLater`); it then asks for the confirmation on its own |
|
|
684
|
-
| `deploy upgrade` reported `Status: DeploymentSucceeded` but the old version still runs | Read `DeploymentStatus` and `ActivationStatus` in the same output. `SuccessfulInstall` / `NeedsSetupToActivate` means the new version is installed and waits for "Setup activation" in Orchestrator; `PendingResources` names what needs configuring and why (`Reason`, from the activation validation, e.g. `[CNS1072] You will need to authenticate this connection before proceeding further`) and `NextSteps` the step. `ReadyToActivate` means `uip solution deploy activate <name>` is all that is left. Do not run the upgrade again — the content is already there |
|
|
791
|
+
| `deploy upgrade` reported `Status: DeploymentSucceeded` but the old version still runs | Read `DeploymentStatus` and `ActivationStatus` in the same output. `SuccessfulInstall` / `NeedsSetupToActivate` means the new version is installed and waits for "Setup activation" in Orchestrator, or for its resources to be linked with `deploy upgrade --version <deployed-version> --config-file` (the step `NextSteps` names); `PendingResources` names what needs configuring and why (`Reason`, from the activation validation, e.g. `[CNS1072] You will need to authenticate this connection before proceeding further`) and `NextSteps` the step. `ReadyToActivate` means `uip solution deploy activate <name>` is all that is left. Do not run the upgrade again — the content is already there |
|
|
685
792
|
| `Another upgrade has already started for this deployment` (error `4005`) | The key you passed is superseded by a later record; nothing is running. The CLI names the current record — use that key (`uip solution deploy list` shows it). If the current record is already at the version you want, there is nothing to upgrade |
|
|
686
793
|
| `deploy run` succeeded with `ActivationStatus: NeedsSetupToActivate` and the deployment does not run | Expected: the install landed, and a resource needs "Setup activation" in Orchestrator before activation. `PendingResources` names what needs configuring and why (`Reason`, from the activation validation, e.g. `[CNS1072] You will need to authenticate this connection before proceeding further`) and `NextSteps` the step. `Status` may read `ValidationFailed` there: that is the pipeline's word for the activation validation it ran after the install, and `NextSteps` open with its errors. Do not deploy again (the deployment exists); complete the setup, then `uip solution deploy activate <name>` |
|
|
687
794
|
| `deploy activate` refused with `cannot be activated` (error `4007`) on an installed deployment | The deployment needs "Setup activation" first (`ActivationStatus: NeedsSetupToActivate`); `Instructions` list the resources that need configuration. Complete the setup in Orchestrator, then activate. `deploy status <key>` shows the same state |
|
|
688
795
|
| `deploy run` fails on a resource conflict | `uip solution deploy config link config.json <resource> --name <existing> --folder-path <path>` to map to the existing one, or change `conflictFixingAction` via `config set` |
|
|
689
|
-
| The deployment is stuck in `Draft` and `deploy activate` won't take it | Read `Operation` first. `ActivationSetup` + `Draft` is a "Setup activation" someone started in Orchestrator and did not finish — complete it there (the UI lists it as `Activation setup · Draft`); `deploy status <key>` names the resources it waits for. To discard it instead, `uip solution deploy delete <name> --yes` removes the draft alone and the deployment returns to its previous record (still needing setup). `VersionChange` + `Draft` is an upgrade queued and never installed. An `Install` `Draft` is a deploy whose install never completed — validation rejected something. It never advances on its own (a deployment passes through `Draft` for a moment right after you fire the command, but not once the command has returned). The reasons are in the failure's `Instructions` (`Validation:` / `Conflicts:`) on every feed, next to the draft's key; fix them with `uip solution deploy config set` / `deploy config link`, then run your original `uip solution deploy run …` again with `--config-file config.json` added and the **same** `--name` and `--package-version` — it still needs `--package-name` and `--folder-name`. A `Draft` left by an install does not block that rerun; one left by an update of a live deployment needs `--yes`, because the package is already deployed. While a draft exists any other version is refused, `deploy upgrade` included — to drop
|
|
796
|
+
| The deployment is stuck in `Draft` and `deploy activate` won't take it | Read `Operation` first. `ActivationSetup` + `Draft` is a "Setup activation" someone started in Orchestrator and did not finish — complete it there (the UI lists it as `Activation setup · Draft`); `deploy status <key>` names the resources it waits for. To discard it instead, `uip solution deploy delete <name> --yes` removes the draft alone and the deployment returns to its previous record (still needing setup). `VersionChange` + `Draft` is an upgrade queued and never installed. An `Install` `Draft` is a deploy whose install never completed — validation rejected something. It never advances on its own (a deployment passes through `Draft` for a moment right after you fire the command, but not once the command has returned). The reasons are in the failure's `Instructions` (`Validation:` / `Conflicts:`) on every feed, next to the draft's key; fix them with `uip solution deploy config set` / `deploy config link`, then run your original `uip solution deploy run …` again with `--config-file config.json` added and the **same** `--name` and `--package-version` — it still needs `--package-name` and `--folder-name`. A `Draft` left by an install does not block that rerun; one left by an update of a live deployment needs `--yes`, because the package is already deployed. While a draft exists any other version is refused, `deploy upgrade` included — to drop a draft left by an update instead, run `uip solution deploy upgrade <draft-key> --discard-draft`; an `Install` draft has no live version to upgrade, so drop it with `uip solution deploy delete <name> --yes`. Delete draft in Orchestrator works for both. To look at it, `uip solution deploy list` needs the same `--personal-workspace` / `--feed <name-or-key>` flag the deploy used — plain `deploy list` is tenant-scoped and shows no row for those deployments at all |
|
|
690
797
|
| `Resource key <key> is used by: <file>, <file>` (or `Node already added to the graph` from an older CLI) | Two resource files carry one key. Keep the file whose `name` other resource files and the projects' bindings reference, delete the rest, then run `uip solution resources refresh`. For `(missing)` or `""`, the files are different resources: give each its own unique `key` instead of deleting |
|
|
691
798
|
| `Resource not found` after deploy | `uip solution resources refresh` to re-sync from each project's `bindings_v2.json`; if still missing, the resource was never declared in any project |
|
|
692
799
|
| A cloud change (new entity field, changed queue setting) never reaches the solution | Expected: `refresh` is import-only and reports the resource under `Skipped`. Pull it with `uip solution resources edit <resource-key> --source remote --force` |
|
package/dist/tool.js
CHANGED
|
@@ -1,32 +1,32 @@
|
|
|
1
1
|
import {
|
|
2
2
|
metadata2,
|
|
3
3
|
registerCommands2
|
|
4
|
-
} from "./packager-tool-
|
|
5
|
-
import"./packager-tool-
|
|
6
|
-
import"./packager-tool-
|
|
7
|
-
import"./packager-tool-
|
|
8
|
-
import"./packager-tool-
|
|
9
|
-
import"./packager-tool-
|
|
10
|
-
import"./packager-tool-
|
|
11
|
-
import"./packager-tool-
|
|
12
|
-
import"./packager-tool-
|
|
13
|
-
import"./packager-tool-
|
|
14
|
-
import"./packager-tool-
|
|
15
|
-
import"./packager-tool-
|
|
16
|
-
import"./packager-tool-
|
|
17
|
-
import"./packager-tool-
|
|
18
|
-
import"./packager-tool-
|
|
19
|
-
import"./packager-tool-
|
|
20
|
-
import"./packager-tool-
|
|
21
|
-
import"./packager-tool-
|
|
22
|
-
import"./packager-tool-
|
|
23
|
-
import"./packager-tool-
|
|
24
|
-
import"./packager-tool-
|
|
25
|
-
import"./packager-tool-
|
|
26
|
-
import"./packager-tool-
|
|
27
|
-
import"./packager-tool-
|
|
28
|
-
import"./packager-tool-
|
|
29
|
-
import"./packager-tool-
|
|
4
|
+
} from "./packager-tool-da3hvfyn.js";
|
|
5
|
+
import"./packager-tool-1dsxhz1r.js";
|
|
6
|
+
import"./packager-tool-txygqgb2.js";
|
|
7
|
+
import"./packager-tool-3ft8hywr.js";
|
|
8
|
+
import"./packager-tool-pmc5txbm.js";
|
|
9
|
+
import"./packager-tool-jhtsana2.js";
|
|
10
|
+
import"./packager-tool-612prgtc.js";
|
|
11
|
+
import"./packager-tool-tmba5jv0.js";
|
|
12
|
+
import"./packager-tool-tat0qs6z.js";
|
|
13
|
+
import"./packager-tool-1tvhgac9.js";
|
|
14
|
+
import"./packager-tool-rhg3mwkn.js";
|
|
15
|
+
import"./packager-tool-cenfraf4.js";
|
|
16
|
+
import"./packager-tool-tr3ttz5c.js";
|
|
17
|
+
import"./packager-tool-8tckw03n.js";
|
|
18
|
+
import"./packager-tool-ewbkaecg.js";
|
|
19
|
+
import"./packager-tool-tqe3m1xp.js";
|
|
20
|
+
import"./packager-tool-t9zked1m.js";
|
|
21
|
+
import"./packager-tool-93qy1v8m.js";
|
|
22
|
+
import"./packager-tool-46x80z85.js";
|
|
23
|
+
import"./packager-tool-qhht1tc9.js";
|
|
24
|
+
import"./packager-tool-n1zrk6zv.js";
|
|
25
|
+
import"./packager-tool-kmwjscby.js";
|
|
26
|
+
import"./packager-tool-jtvhkavz.js";
|
|
27
|
+
import"./packager-tool-xbfr6y2x.js";
|
|
28
|
+
import"./packager-tool-gb3dq79g.js";
|
|
29
|
+
import"./packager-tool-1db1wqdy.js";
|
|
30
30
|
import"./packager-tool-rj2d1g0w.js";
|
|
31
31
|
export {
|
|
32
32
|
metadata2 as metadata,
|