Skip to content

Easy Deploy

With Easy Deploy, in just three steps, you will have your automation ready to be executed by our BotCity Maestro orchestrator.

The Easy Deploy process is divided into three steps:

  1. Creating an automation
  2. Deploying a bot
  3. Choosing where to run

First Step - Creating an automation

The first step is to fill in the name of our automation process.

Image--easy-deploy-automation-name

Second Step - Deploying a bot

The second step is to fill in the information about your bot. For that, it is necessary that you have already created and done the "build" process of a bot project.

How to create a bot

To manage a bot on the platform, we first need to create a project in the Java, Javascript, or Python structure that will be used to develop the bot.

To create a new bot project, follow the tutorials below:

Tip

In addition to template projects, you can also orchestrate your own custom projects.

See more details about orchestrate custom projects.

Building your bot project

To send the bot to Maestro you need to build the project. If you are in Windows run the build.bat file in the root directory of the project, otherwise run the build.sh file under Linux or macOS.

.\build.bat

./build.sh

Tip

If you get a permission error, make sure that your build.sh script has execution permission.

You can set the permission with the following command:

chmod +x build.sh

Java bots

For bots developed in Java, use the generated .jar file in the dist/ folder, if it generates two .jar files use the file with jar-with-dependencies in the filename.

Python bots

For bots developed in Python, use the generated .zip or .tar.gz file in the dist/ folder.

Javascript bots

For bots developed in Javascript, use a .zip file containing the project files such as the bot.js, resources folder and package.json.

At this point, you will upload the file referring to the bot, define which technology is being used, and finally, the name and version you want to use for the deployment.

Image-easy-deploy--automation-upload

Warning for legacy Python projects

For Python automation, if you are using a legacy project template, the bot identifier must match the id defined when creating the project.

If the auto-generated name is not the same as the ID of the created project, change it so that the identifiers match.

For legacy projects, the bot identifier appears in the name of the generated .tar.gz file being used.

Final Step - Choosing where to run

The third and final step is to define which Runner or Runners will be associated with this automation.

You can select an existing Runner or you can create a new one by entering an identifier on the text field.

Note

See more details on how to create and configure a Runner in the Runners section.

Image-easy-deploy-runner

Finishing this step, you will have your automation process associated with your robot and have defined where it will be executed.

Tip

You can see more details on orchestrating a bot step by step using the Easy Deploy functionality by accessing the Orchestrating Your Automation tutorial.

Success 🚀

You now have the option to create a new task for this automation.

Image-easy-deploy-4

By doing so, a new task will be queued and as soon as the Runners associated with the automation are active, the execution will start automatically.