Solutions user guide

Linking components​

1. Select Link to existing in the Solution installer.

   

2. Select the existing component you want to link to from the component name dropdown list.

   

3. Select Link.

• Assets
• Storage buckets
• Webhooks
• Queues

Deploying a solution to a Personal Workspace​

Deploying a solution in Orchestrator​

1. Select the Solutions tab at tenant level.

2. Select the solution package you want to deploy. Choose the option that matches your workflow best.

   Scenario	Recommended action
   The package already exists in your tenant or personal workspace	Select an existing solution package.
   You want to create a new package from your project.	Create a new solution package.
   You are transferring a package from another tenant or environment.	Upload a solution package.

3. Deploy the desired version of the solution package. You can use the following options to deploy a solution:

   • Select the + Deploy button from the Deployments tab.
   • Select the Deploy button from the corresponding row in the Packages tab.
   • Select the inverted ellipsis menu (⋮) for a package in the Packages tab and choose Deploy.
   • Use the Quick Actions button for your tenant or personal workspace and choose Solution Deployment.
   • Browse to a specific package version and deploy it directly from the Package versions page.

4. In the Deploy a solution page, review and update the following details:
   Required fields

   • Package - Choose the package you want to deploy.
   Tip:

   Once you select a package, the Version field is displayed with details on package version, publish date, descriptiption, and author.

   • Deployment name - Fill in a unique name for the deployment.
   • Location - Choose where the solution folder will be created:
     • Install as root folder creates a new root folder
     • Select an existing folder.
       For more information on folders, including root folders, check the Folders page from the Orchestrator user guide.

   Optional fields

   • Advanced options - Expand to configure advanced options, such as activation strategy.
   • Use custom solution folder name - Toggle this button to configure a different name for the solution folder than the deployment name. The default value is the configured deployment name.
   • Activation strategy - Choose if you want to activate the deployment immediately or later.
     • Now - Activates the deployment as soon as it is created.
       Choose this option when:
       • All required resources, such as queues, storage buckets, connections, or assets, are already configured.
       • You want the solution to begin processing events right away.
         This is typically used in production environments.
     • Later - Installs the deployment but leaves all triggers disabled until you manually activate them.
       Choose this option when:
       • You want to review component configuration in Solution Explorer.
       • You need to connect additional resources beore enabling the automation.
       • The deployment requires validation or testing before going live.
         This is typically used in testing, staging, or complex setups that need adjustments.

5. Select Deploy, for Solutions to orchestrate the deployment across all affected services. If any additional information is required, the configuration screen is displayed.

6. Select Review to go to Overview & Configuration. Now you are prompted with the Solution explorer, which allows you to review the solution components, component properties, and files. Take the following into consideration:

   • You can filter the component properties from the Display dropdown to only display read-only, configurable, or empty fields.
   • You can link existing components. For details, refer to Linking components.

7. You can now save your solution as a draft or validate it and continue. The following image presents several typical validation errors.

   

   Note:

   If a component of the same name already exists in the tenant, your options are the following:

   • Keep the existing component and do not create an additional one.
   • Keep the existing component and add additional new fields from the solution. Note that this option does not alter existing fields.
   • Rename the conflicting resource in the respective service (for instance, Orchestrator, Action Center) in the target tenant.
   • Rename the resource in the solution deployment if possible.

8. Select Deploy, for Solutions to orchestrate the deployment across all affected services. A deployment can be successful or it can fail. You can view the deployment status in the deployment page.

   The following table describes the possible statuses of your deployment:

   Status	Behavior
   In progress	The deployment operation is in progress.
   Successful	The status changes from In progress to Successful, and all components are deployed.
   Failed	The status changes from In progress to Failed. In this case, an automatic rollback performed successfully. You can check the activation summary for more details and retry the operation.
   FailedRollback	The status changes from In progress to FailedRollback. In this case, since some components have already been deployed, make sure to manually clean up the components from the failed services.

   For an overview of all deployment statuses, refer to Checking the deployment status.

9. To complete the deployment, take the following steps.
   a. Add accounts and assign roles - Add user or robot accounts to the solution folder(s) and assign the required roles and permissions.
   For more information, check the Access control page from the Orchestrator user guide.
   b. Add machines - Make sure machines are assigned to the solution folder(s) that include processes.
   For more information, check the Managing machines page from the Orchestrator user guide.
   c. Define account-machine mappings - Define account-machine mappings if needed or use dynamic allocation.
   For more information, check the Configuring account-machine mappings page from the Orchestrator user guide.
   d. Define values for assets per robot - Define value(s) for assets per robot, if applicable. This step is not needed for assets set with global values.
   For more information, check the Managing assets in Orchestrator page from the Orchestrator user guide.
   e. Activate the apps used in the solution - If the solution contains apps, you must activate them using the provided link. Note that a new window opens, and you must wait for the apps activation confirmation before continuing the deployment activation.

   Note:

   If the solution contains apps, and you do not activate them using the provided link, the deployment activation fails.

   For more information, check the Apps in Solutions Management page from the Apps user guide.
   f. Fill in bindings for process-type components - If the solution contains processes, you must fill in any desired bindings. For example, editing agent-type processes allows the selection and usage of tools external to the solution.
   For more information, check the Managing processes page from the Orchestrator user guide.

10. In the Deployment screen, select Activate deployment. Activation enables your triggers.