- Introduction
- Managing solution projects and packages
- Managing solution deployments
- Best practices
Solutions user guide
Deploying a solution means installing a solution package as a new deployment in an Orchestrator folder. For more information about solution deployments, see Understanding the solution development lifecycle.
You can initiate a solution deployment from either Studio Web or Orchestrator. Both surfaces drive the same underlying deployment experience: Studio Web is the originating surface, designed for solution authors who want to package and deploy in a single flow; Orchestrator is the administrative surface, designed for tenant administrators managing deployments at scale. This page documents the Orchestrator flow.
The Orchestrator deploy flow requires a solution package that has already been published to a feed. You can publish a package from Studio Web or Studio Desktop before deploying here.
This step is typically performed by an administrator.
Open the Deploy workflow
You can open the Deploy workflow from any of the following locations in Orchestrator:
- Deployments tab — Select + Deploy in the upper-right corner.
- Packages tab — Select the Deploy row action for the package you want to deploy.
- Package sidebar — Open a package to expand its sidebar, then select Deploy in the upper-right corner of the sidebar.
- Versions tab of the Package sidebar — Select the Deploy row action for the specific package version you want to deploy.
All four paths open the same Deploy workflow on the Setup form. The breadcrumb at the top reads Tenant > Solutions > Deployments > Deploy.
Complete the Setup form
The Setup form is where you define what to deploy, where it lands, and how it activates. Fill in the following fields:
| Field | Description |
|---|---|
| Package | Select the solution package to deploy from the dropdown. The list shows all packages published to your tenant feed. |
| Version | The package version to install. Defaults to the latest published version. Select a different version from the dropdown if needed. The publish date, description, and feed location are shown below the field. |
| Deployment name | A required, tenant-unique name for this deployment. Auto-filled from the package name. |
| Location | The folder where the solution folder will be created. Defaults to Install as root folder. Select an existing folder from the dropdown to nest the solution inside it. |
| Solution folder name | The name of the subfolder created inside the destination. Mirrors the deployment name by default. Edit to use a different name. |
| Activate immediately | Toggle (on by default). When enabled, triggers in the solution are activated as soon as the deployment completes. |
| Set up runtime | Toggle (on by default). When enabled, a Default Serverless template is automatically attached to the target folder if one is not already present or inherited. Disable this if you want to configure machine templates manually. |
The form pre-fills smartly: the package name flows into Deployment name, and Deployment name flows into Solution folder name. You can override any of these values independently.
Run the deployment
After completing the Setup form, choose one of the following options at the bottom of the form:
-
Deploy — validates the configuration and runs the deployment immediately. The workflow progresses through the following steps shown in the left navigation rail:
Step Description Configure The deployment configuration is validated and applied. Deploy Solution folders are created in the target location and resources are provisioned. Activate Triggers and activation are set up, if Activate immediately is enabled. -
Customize (select the dropdown arrow on the Deploy button) — opens the resource explorer so you can review and configure individual solution components before the deployment runs. After reviewing components, select Continue to deploy to proceed.
Re-use existing components (optional)
When you select Customize, the resource explorer shows all components in the solution package. If a component with the same name already exists in the tenant, you can link the solution to it instead of creating a new one.
This option is available for Assets, Storage buckets, Webhooks, and Queues. For each conflict, you can:
- Keep the existing component and not create an additional one.
- Keep the existing component and add new fields from the solution (existing fields are not altered).
- Rename the conflicting resource in the respective service.
- Rename the resource in the solution deployment, if possible.
To link an existing component:
- In the resource explorer, select the component you want to link.
- Select Link to existing.
- In the dialog, select the component you want to link to.
- Select Link.
Monitor deployment status
After the deployment starts, you can monitor progress from the workflow view or from the Deployments tab in Solutions. The following statuses are possible:
| Status | Description |
|---|---|
| In progress | The deployment operation is running. |
| Successful | The deployment completed and all components are installed. |
| Failed | The deployment failed and an automatic rollback was performed. |
| Failed Rollback | The deployment failed and some components require manual cleanup. |
For details about all statuses, see Deployment statuses.
Activate the deployment
If the solution contains apps and they are not activated using the provided link, the deployment activation fails. See the Orchestrator and Apps documentation for detailed instructions.
After a successful deployment, Orchestrator evaluates activation readiness. The deployment appears in the Deployments tab with one of the following statuses:
-
Inactive (Ready to activate): No additional configuration is required. Select the More Actions icon, then select Activate deployment.
-
Inactive (Needs setup to activate): Additional prerequisites must be completed before activation:
-
Select the More Actions icon and choose Set up activation.
-
Review the activation validation results and complete the required items:
- Add accounts and assign roles.
- Add machines to solution folders.
- Define account-machine mappings, if needed.
- Define asset values per robot, if applicable.
- Activate apps used in the solution.
- Fill in bindings for process-type components, if applicable.
Note:When deploying a solution, a Default Serverless template may be automatically attached to the target folder if the Set up runtime toggle was enabled on the Setup form.
- This ensures the solution can run without manually configuring machine templates.
- If a serverless template is already inherited, no additional template is attached.
-
Resolve the listed items.
-
Select Validate.
-
Select Activate.
-