Skip to content

Prerequisites

BotCity Account

The main prerequisite to use the BotCity Studio SDK is to have a BotCity account.

If you don't have one yet, you can create one by clicking here.

Java

All tools from the BotCity Studio SDK are written in Java.

In order to use the tools, you need to have Java 11 or higher. If you don't have it yet, you can download it from Java download page.

Development Environment

Java

To be able to develop automations using Java, you need to have Java SDK version 11 or higher installed.

If you don't have it yet, you can download it from Java Downloads page.

You will also need Maven 3.5 or higher. If you don't have it yet, you can download it from Maven 3 download page.

Python

For Python development you need to have Python 3.7 or higher installed. If you don't have it yet, you can download it from Python 3 download page.

Additional dependencies will vary according to your needs so please pay attention to the documentation of each tool.

Node

For Node development you will need Node 16 or higher installed on your machine. If you don't already have it, you can download it from Node download page.

Runtime Environment

The runtime environment is composed by the BotCity Runner and other additional dependencies that are required to run your automation.

As the BotCity Runner is a Java application, you need to have Java 11 or higher installed as mentioned above.

If you intend to run also Python automation on your environment, you will need to have Python 3.7 or higher installed as well as the following dependencies:

Important

If you are running the BotCity Runner on a Linux machine and using the system Python, you will need to install the following dependencies:

  • python3.8-pip
  • python3.8-virtualenv

Note

The package names above are for Debian/Ubuntu based Linux distributions.

For other distributions please refer to your distribution's documentation.

Problems with blocking environments

If you are trying to use BotCity's tools in a corporate environment, you may encounter some issues related to environment locks.

Here are some of the most common issues when using the BotCity Studio SDK in blocking environments:

  • Installation through the Wizard is stuck at 0%.
  • Failed to log in to BotCity Studio.
  • Authentication error when starting BotCity Runner.

If you have observed any of the issues above, we recommend contacting your company's IT team and requesting the following access permissions:

Connecting to BotCity Maestro

The Maestro orchestrator works in the cloud, and the Runner communicates with the Maestro via HTTPS (443), but it does not occupy this port; it just needs it to be open for communication.

Requirements for using BotCity tools in blocking environments:

  • Firewall permission to access https://*.botcity.dev/ (port 443 HTTPS)
  • Firewall permission to access https://sdk.botcity.dev/ (port 443 HTTPS)
  • Firewall permission to access https://auth.botcity.dev/ (port 443 HTTPS)

Using Python in automation development

If Python is used to develop automation, it will be necessary:

  • Firewall permission to access https://pypi.org/* (Python Package Index - PyPI)
  • Python 3.8 or higher installed
  • Installation of the pip, virtualenv and setuptools packages

Using Java in automation development

If Java is used to develop automation, it will be necessary:

  • Firewall permission to access https://repo1.maven.org/maven2/ (Maven Central)
  • Firewall permission to access https://devtools.botcity.dev:8081/ (Nexus BotCity)