Skip to content

BotCity Studio SDK

The BotCity Studio SDK is an all-in-one package containing all necessary tools to build, deploy and run your BotCity automations.

It includes the BotCity Studio, BotCity Runner and BotCity CLI (command line interface) tools.

Setup

The installation procedure for the BotCity Studio SDK is very simple and consist of only two steps:

  1. Download and Unpack the BotCity Wizard
  2. Follow the instructions on the screen

Download

In order to download the Wizard, just log in on your Maestro workspace and click on Download BotCity Studio, in the Developer section.

Download SDK

Tip

You can also access the BotCity Studio download page through Maestro's top left menu, represented by the icon: Maestro Menu

On the new page that opens, download the version compatible with your operating system.

Download SDK Options

After the download is completed, extract the downloaded archive and follow the instructions below.

Installing

After downloading and extracting, open the wizard-X.Y.Z where X.Y.Z are the Wizard's version.

Choose where to install

Install

Warning

Please be aware that installing at locations such as C:\... could cause permissions issues.

Try to avoid such locations or please make sure to fix the permissions accordingly.

Authenticating with BotCity Maestro

Configuring

Warning

For Server make sure to always use your BotCity Maestro URL.

If you have a custom subdomain it is very likely that your URL will be something like https://yourcompany.botcity.dev.

For the community version, please use https://developers.botcity.dev.

Configuring a BotCity Runner (optional step)

During this step you can optionally pick an existing Runner or create a new one.

If this is the first time that you are installing it, we strongly recommend creating one so you can run your automations.

Runner

Tip

In case you skip this step, you can always configure a Runner at the end of the installation process.

Almost there

finishing

Please wait while the download finishes and the SDK is being configured.

You are ready to go 🚀

Finish

Your setup is now finished!

Here are some actions which you can perform from this screen:

  • Change the version to a newer or previous version as well as to a development version
  • Configure a BotCity Runner
  • Launch BotCity Studio
  • Launch BotCity Runner as a background process or as a visual application (GUI)
  • Open the folder in which the SDK was installed

Tip

A copy of the Wizard is now available on the folder in which the SDK was installed. You can always launch it from there and come back to this screen.

Exploring the Contents

After extracting the downloaded archive, you will find the following folder structure:

.
├── BotCLI.bat
├── BotRunner-gui.bat
├── BotRunner.bat
├── BotStudio-2.15.0.exe
├── bin
├── conf
│   ├── conf.bcf
│   └── properties.json
├── lib
│   └── tesseract
├── run
├── venvs
└── win32
    └── java

.
├── BotCLI.sh
├── BotRunner-gui.sh
├── BotRunner.sh
├── BotStudio.sh
├── bin
├── conf
│   ├── conf.bcf
│   └── properties.json
├── lib
│   └── tesseract
├── run
└── venvs

On the root folder of the SDK, you will find the following files:

  • BotCLI.bat/BotCLI.sh: Wrapper for the BotCity CLI (command line interface) tool.
  • BotRunner-gui.bat/BotRunner-gui.sh: Launcher for the BotCity Runner tool in graphical mode.
  • BotRunner.bat/BotRunner.sh: Launcher for the BotCity Runner tool in headless mode.
  • BotStudio-X.Y.Z.exe/BotStudio.sh: Launcher for the BotCity Studio tool.
  • bin: Folder containing the binary jar files of the BotCity SDK.
  • conf: Folder containing the configuration files.
    • conf.bcf: BotCity Studio configuration file.
    • properties.json: BotCity Studio properties file (Use the Preferences menu to edit values, not directly on the file).
  • lib: Support libraries for the BotCity Studio.
  • run: Runtime folder for the BotCity Runner.
  • venvs: Runtime folder for the BotCity Runner's Python virtual environments.

Configuration

The configuration for the BotCity Studio SDK is done via the conf.bcf file located in the conf directory.

Using the Wizard this file is automatically generated for you but you can still customize it to your own needs.

Exploring the conf.bcf file

Let's take a look at the content of the conf.bcf file:

server=https://developers.botcity.dev
workspace=
key=
login=
machineId=<Your Machine ID Here>
logScreen=true
logApplication=true
  • server: BotCity Maestro server URL.
  • workspace: BotCity Maestro workspace.
  • key: BotCity Maestro API key located on the Dev. Environment page.
  • login: BotCity Maestro API User located on the Dev. Environment page.
  • machineId: Machine ID of the current machine. See Machines.
  • logScreen: Boolean option defining whether or not screenshots are periodically sent to the BotCity Studio.
  • logApplication: Boolean option defining whether or not BotCity Runner logs are periodically sent to the BotCity Studio.

Testing Your BotCity Studio SDK

The easiest way to test your BotCity Studio SDK is to use the BotCity CLI tool.

For that, open a terminal on the folder containing the BotCity Studio SDK and run the following command:

./BotCLI.bat bot list

./BotCLI.sh bot list

If your BotCity Studio SDK is properly configured, you should see the following output:

SUCCESS:
...

Note

If you see a SUCCESS message followed by an ERROR message, it means that your BotCity Studio SDK is properly configured but you probably have no bots deployed yet.

Next Steps

You are now ready to start developing your BotCity automations.

Let's go to the next step and start developing your first bot.