Skip to content

Easy Deploy¶

The automation deployment process can be complex. With that in mind, we created Easy Deploy, a feature designed to simplify the automation deployment process, making it more straightforward and intuitive.

With Easy Deploy, in just three steps your automation will be ready and available in the BotCity Orchestrator.

The Easy Deploy process allows you to create a new automation from scratch or update an existing automation in the Orchestrator.

This process is essentially divided into three stages:

  1. Create or update an Automation
  2. Deploy a bot
  3. Choose where to run

Screenshot of the BotCity Orchestrator, presenting the Easy Deploy feature. The page shows the first stage of the deployment or automation update process. On the screen there are two single-selection fields to choose between: creating a new automation or choosing an existing automation. At the bottom of the page, a help link: What do I need to proceed? Next to an advance button.

Create a new automation¶

To create a new automation process in the BotCity Orchestrator, access the Easy Deploy option in the side menu and follow these steps:

First Step — Create automation¶

In the first stage, select the option: Create new automation and fill in the following fields:

  • Automation name: Define a name for the automation being created. This name must be unique to identify the process.
  • Repository: Select the repository where the automation process will be allocated.
  • Description: Provide a brief description of the process to make it easier to identify the automation later.

Warning

The automation name must be unique, meaning no other automation with the same name can exist in the BotCity Orchestrator. Even if the automation is deleted from the platform, it is not possible to recreate another automation with the same identification name.

Screenshot of the BotCity Orchestrator, presenting the Easy Deploy feature. The page shows the first stage of the deployment process. On the screen, the 'create a new automation' single-selection field is checked, along with the fields to fill in information about the new automation: Automation name, repository and automation description. At the bottom of the page, a help link: What do I need to proceed? Next to an advance button.

Second Step — Deploy bot¶

In the second stage, select the bot's .zip file and fill in the following fields:

  • Version: Define the version of the code being deployed.
  • Bot ID: The bot's identification name. The same name as the automation can be used.
  • Technology: Select the technology used in the code development. Python, Java, JavaScript, Command

Build

The bot file has some important specifications. See more details about development and build in the Bots section of the Documentation.

Screenshot of the BotCity Orchestrator, presenting the Easy Deploy feature. The page shows the second stage of the deployment process. On the screen there is a bot file upload field and the fields to fill in information about the bot: Version, Bot ID, technology. At the bottom of the page, navigation buttons between stages to go back or advance.

Third Step — Execution options¶

In the third stage, define the execution environments by selecting one or more Runners.

Runner selection

The Runner selection contains all Runners created in the BotCity Orchestrator. For them to execute tasks, they must be installed in the execution environment and active. See more details about how to create and configure a Runner in the Runners section.

When choosing Runners, it should be considered that the environment where it was installed has the necessary resources for the execution of the process being deployed.

For example: a process that makes use of SAP requires the Runner's environment to have SAP installed and functional. If you select an environment that does not have the necessary resources, the process will not run.

Tutorial

You can see more details about the step-by-step orchestration of a bot using the Easy Deploy feature by accessing the tutorial Orchestrating your Automation.

Screenshot of the BotCity Orchestrator, presenting the Easy Deploy feature. The page shows the third stage of the deployment process. On the screen there is a multiple Runner selection field. At the bottom of the page, navigation buttons between stages to go back or advance.

Success 🚀¶

Upon completing the three stages, the options to create a new task or a scheduling rule for this automation will become available.

The basic execution cycle works as follows:

  • Create a task or schedule
  • The task enters the execution queue
  • The active Runner associated with the automation identifies and runs the process
  • The process finishes and records the execution information in the BotCity Orchestrator

Screenshot of the BotCity Orchestrator, presenting the Easy Deploy feature. The page shows the successful completion of the deployment process with two redirect option cards. The first to create a new task for the deployed automation, the second to create a scheduling rule for the automation.

Updating an existing automation¶

To update an existing automation process in the BotCity Orchestrator, access the Easy Deploy option in the side menu and follow these steps:

First Step — Update automation¶

In the first stage, select the option: Choose existing automation and fill in the following fields:

  • Repository: Select the repository where the automation process is allocated.
  • Automation: Select the automation you want to update.

Screenshot of the BotCity Orchestrator, presenting the Easy Deploy feature. The page shows the first stage of the update process. On the screen, the 'choose an existing automation' single-selection field is checked, along with the fields to select information about the existing automation: repository and automation. At the bottom of the page, a help link: What do I need to proceed? Next to an advance button.

Second Step — Update bot¶

In the second stage, select the bot's .zip file and fill in the following fields:

  • Version: Define the version of the code being deployed. This can be:
    • Same existing version: Overwrites the previous version.
    • New version: Keeps the previous one and creates a new version.
  • Technology: Select the technology used in the code development. Python, Java, JavaScript, Command.
  • Release: Check the Release this version option to make this the current version for execution.

Version

When keeping the same existing version of a bot, the project's .zip file will be overwritten, and it will not be possible to revert this action.

Build

Don't forget to create a new project build, generating a new .zip file with the updated code.

Screenshot of the BotCity Orchestrator, presenting the Easy Deploy feature. The page shows the second stage of the update process. On the screen there is a bot file upload field and the fields to fill in information about the bot: Version, technology and a checkbox to 'Release this version'. At the bottom of the page, navigation buttons between stages to go back or advance.

Third Step — Change execution environments¶

In the third stage, you can keep or change the Runners selected for the automation's execution.

Screenshot of the BotCity Orchestrator, presenting the Easy Deploy feature. The page shows the third stage of the update process. On the screen there is a multiple Runner selection field. At the bottom of the page, navigation buttons between stages to go back or advance.

Success 🚀¶

Upon completing the update, you will find all available versions in the Bots menu.