Skip to content

Commit ae13815

Browse files
fix(uipath-solution): use actual UI label "Activate deployment" [CA-233] (#4869) (#5003)
1 parent 91caca5 commit ae13815

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

‎skill-flavors/studioweb/uipath-solution/SKILL.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
2121
> **Any key of the deployment reaches it.** `uip solution deploy upgrade <key>` resolves the key through the Pipelines by-key lookup to the deployment's current generation, so the `Key` from `uip solution deploy list` and a stored `InstallDeploymentKey` both work; store `InstallDeploymentKey`, the one that never changes across upgrades. `uip solution deploy status <key>` answers `Superseded: true` and names the current key when the one you hold is stale.
2222
23-
> **Deploy is asynchronous in two phases.** `deploy run` installs, polls to a terminal status, then activates unless `--skip-activate`; success is `Status: DeploymentSucceeded` with `ActivationStatus: SuccessfulActivate`. Read `ActivationStatus` when it is anything else: `NeedsSetupToActivate` means a resource needs "Setup activation" in Orchestrator first and `deploy activate` is refused with `4007` until then (the run is still a success; `PendingResources` names the resource and why); `ReadyToActivate` or a failed activation means fix the cause and run `uip solution deploy activate <name>`. The deployment exists either way — never redeploy. Check state with `uip solution deploy status` / `deploy list`.
23+
> **Deploy is asynchronous in two phases.** `deploy run` installs, polls to a terminal status, then activates unless `--skip-activate`; success is `Status: DeploymentSucceeded` with `ActivationStatus: SuccessfulActivate`. Read `ActivationStatus` when it is anything else: `NeedsSetupToActivate` means a resource needs activation setup in Orchestrator first (click **Activate deployment** on the deployment) and `deploy activate` is refused with `4007` until then (the run is still a success; `PendingResources` names the resource and why); `ReadyToActivate` or a failed activation means fix the cause and run `uip solution deploy activate <name>`. The deployment exists either way — never redeploy. Check state with `uip solution deploy status` / `deploy list`.
2424
<!--skill-flavor:solution-lifecycle-steps:end-->
2525
2626
<!--skill-flavor:when-to-use-uipx:start-->

‎skills/uipath-solution/references/activate-and-manage.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,10 +147,10 @@ On newer CLI builds a successful upgrade also checks that the deployment's folde
147147
- On a CLI build without the flag the option is unknown; against a server that predates the confirmation, the upgrade never reaches a terminal status and the command reports its usual timeout (`did not finish within …s`, "It may still be running").
148148
- By default the command **waits** for the install to reach a terminal state (`--timeout <seconds>`, default 300; `--poll-interval <ms>`, default 5000). Pass `--no-wait` to return as soon as the install is accepted.
149149
- A failure reports the server's reason (for example `Solution folder not found` when the deployment's solution folder was deleted), not a bare status. The reason normally comes from the pipeline run itself; when the run record has already been recycled the CLI reads the deployment's validation result instead, and says `the server reported no reason.` only when the server genuinely gives none.
150-
- **`Status: DeploymentSucceeded` does not mean the new version runs.** Read `DeploymentStatus` and `ActivationStatus` in the same output. `SuccessfulInstall` / `NeedsSetupToActivate` means the new version is installed but does not run until "Setup activation" is completed in Orchestrator (Tenant > Solutions > Deployments; the UI shows the deployment as **Inactive (Needs setup)**) — typically an Integration Service connection whose configuration the upgrade could not carry over; `PendingResources` names it with the `Reason` the activation validation gives and the Orchestrator folders it lives in (`FolderPaths`), and `NextSteps` says what to do. On current servers this report is the same for an external app (CI/CD) as for a user session. The old version keeps running meanwhile. Do **not** run the upgrade again: the content is already there. The CLI has no command for this step on an existing deployment (`deploy config link` only serves a new `deploy run`, and `deploy upgrade` takes no config file), and `deploy activate` is refused with `4007 … cannot be activated` until it is done. `ReadyToActivate` / `Inactive` is different: run `uip solution deploy activate <deployment-name>`. A pipeline that ends at `ValidationFailed` while the record reports `SuccessfulInstall` is reported the same way — the install landed and the errors, which open `NextSteps`, come from the activation validation the pipeline runs after the install (measured on both `deploy run` and `deploy upgrade`) — not as a rejected attempt.
150+
- **`Status: DeploymentSucceeded` does not mean the new version runs.** Read `DeploymentStatus` and `ActivationStatus` in the same output. `SuccessfulInstall` / `NeedsSetupToActivate` means the new version is installed but does not run until activation setup is completed in Orchestrator (Tenant > Solutions > Deployments; click **Activate deployment** on the deployment, which the UI shows as **Inactive (Needs setup)**) — typically an Integration Service connection whose configuration the upgrade could not carry over; `PendingResources` names it with the `Reason` the activation validation gives and the Orchestrator folders it lives in (`FolderPaths`), and `NextSteps` says what to do. On current servers this report is the same for an external app (CI/CD) as for a user session. The old version keeps running meanwhile. Do **not** run the upgrade again: the content is already there. The CLI has no command for this step on an existing deployment (`deploy config link` only serves a new `deploy run`, and `deploy upgrade` takes no config file), and `deploy activate` is refused with `4007 … cannot be activated` until it is done. `ReadyToActivate` / `Inactive` is different: run `uip solution deploy activate <deployment-name>`. A pipeline that ends at `ValidationFailed` while the record reports `SuccessfulInstall` is reported the same way — the install landed and the errors, which open `NextSteps`, come from the activation validation the pipeline runs after the install (measured on both `deploy run` and `deploy upgrade`) — not as a rejected attempt.
151151
- **Any published version of the same package is a valid target.** Omit `--version` to take the newest (one extra lookup), or pass `--version <version>` for a specific one — including an older version, to step back. Requesting the version already deployed is not refused; it comes back as `Operation: "ConfigurationChange"` (see above) — unless a pending draft is in the way, which is refused whatever the version (see above), the one exception being a same-version draft that awaits permanent-deletion consent, which `--acknowledge-permanent-deletion` re-runs.
152152
- **A key is one record, not the deployment.** `deploy run`, `deploy upgrade` and the Orchestrator wizard each create a new deployment record with its own key; `deploy list` shows the newest one, and `InstallDeploymentKey` is the one that never changes. A key from before an upgrade is *superseded*: `deploy upgrade <key>` resolves it to the deployment's current generation through the Pipelines lookup and upgrades that; on a server without the lookup, a user session's fallback reads the record's name and continues as the name form, so the version you ask for is what moves, and asking for the version already live is a `ConfigurationChange`. `deploy status <key>` answers `Superseded: true` with `CurrentDeploymentKey`. Store `InstallDeploymentKey`, or take the current key from `deploy list`.
153-
- **An abandoned "Setup activation" has an exit.** Starting the wizard in Orchestrator and leaving it creates an `ActivationSetup` / `Draft` record on top (`Actions: [Install, Delete]`). `uip solution deploy delete <deployment-name> --yes` removes that record alone; the installed record is the head again, still `NeedsSetupToActivate`, folder and resources untouched. Finishing the wizard instead lands `ActivationSetup` / `Successful` / `Active`.
153+
- **An abandoned activation wizard has an exit.** Starting the wizard in Orchestrator and leaving it creates an `ActivationSetup` / `Draft` record on top (`Actions: [Install, Delete]`). `uip solution deploy delete <deployment-name> --yes` removes that record alone; the installed record is the head again, still `NeedsSetupToActivate`, folder and resources untouched. Finishing the wizard instead lands `ActivationSetup` / `Successful` / `Active`.
154154
- The server decides what may be upgraded, and refuses synchronously — before any `PipelineDeploymentId` exists — when the deployment name does not exist, when it belongs to a different package than `--package-name`, when an operation is already in progress on it, when a pending draft for another version stands in the way (reported as the pending-draft refusal above), or when it is not in an upgradeable state. A deployment an **earlier CLI version** left in `ValidateError` (the late-validation state described above) is upgradeable on current Orchestrator, which is how you move it on; on an older Automation Solutions build it is refused, and uninstall-and-redeploy is the only way out.
155155

156156
## Step 3: Uninstall a Deployment

‎skills/uipath-solution/references/pack-and-deploy.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ uip solution deploy run -n "InvoiceAutomation-v2" \
164164
--folder-name "MySolutionFolder" --output json
165165
```
166166

167-
A successful run returns `Status: DeploymentSucceeded` and `ActivationStatus: SuccessfulActivate`, along with `DeploymentKey`, `PipelineDeploymentId`, `InstanceId`, and the [deployment links](#open-the-deployment-in-orchestrator) `OrchestratorUrl` / `FolderUrl` (when available). When a resource needs "Setup activation" in Orchestrator before the deployment can be activated — an Integration Service connection that must be authenticated, typically — the run is still `Result: Success`: the install landed, `ActivationStatus: NeedsSetupToActivate`, `PendingResources` names each resource with its `Reason` (`[CNS1072] You will need to authenticate this connection before proceeding further`) and its Orchestrator folders (`FolderPaths`, `null` when the server does not report them), and `NextSteps` gives the Orchestrator step. When the server already reports that state after the install, `deploy run` does not attempt the activation. Do **not** run the deploy again: the deployment exists. On such a run the pipeline itself can end at `ValidationFailed` **after** the install landed (the deployment record reports `SuccessfulInstall`); the CLI still reports the deployment, keeps the pipeline's word in `Status`, and opens `NextSteps` with the pipeline's errors, which come from the activation validation the pipeline runs after the install. `ReadyToActivate` means the install landed and the activation did not run: `uip solution deploy activate <name>`. Any other refused activation is a failure with `Retry activation with: uip solution deploy activate <name>`.
167+
A successful run returns `Status: DeploymentSucceeded` and `ActivationStatus: SuccessfulActivate`, along with `DeploymentKey`, `PipelineDeploymentId`, `InstanceId`, and the [deployment links](#open-the-deployment-in-orchestrator) `OrchestratorUrl` / `FolderUrl` (when available). When a resource needs activation setup in Orchestrator (click **Activate deployment** on the deployment) before it can be activated — an Integration Service connection that must be authenticated, typically — the run is still `Result: Success`: the install landed, `ActivationStatus: NeedsSetupToActivate`, `PendingResources` names each resource with its `Reason` (`[CNS1072] You will need to authenticate this connection before proceeding further`) and its Orchestrator folders (`FolderPaths`, `null` when the server does not report them), and `NextSteps` gives the Orchestrator step. When the server already reports that state after the install, `deploy run` does not attempt the activation. Do **not** run the deploy again: the deployment exists. On such a run the pipeline itself can end at `ValidationFailed` **after** the install landed (the deployment record reports `SuccessfulInstall`); the CLI still reports the deployment, keeps the pipeline's word in `Status`, and opens `NextSteps` with the pipeline's errors, which come from the activation validation the pipeline runs after the install. `ReadyToActivate` means the install landed and the activation did not run: `uip solution deploy activate <name>`. Any other refused activation is a failure with `Retry activation with: uip solution deploy activate <name>`.
168168

169169
This holds on **every** feed. A `--feed` or `--personal-workspace` deploy goes through the same Pipelines install as a tenant one, so it validates the package against the target before installing and waits for the run to reach a terminal state — it does not return early. A configuration the target rejects fails the command (exit `1`, `ErrorCode: invalid_argument`, `ValidationFailed` in `Message`) with the per-resource errors in `Instructions`, and nothing is provisioned — that is a `ValidationFailed` before the install; the one whose record reports `SuccessfulInstall` is the landed case above, and a success. (`--wait` is still accepted and does nothing; older CLI versions needed it on those feeds.)
170170

0 commit comments

Comments
 (0)