DOCSEARCHbyAlgolia
Submit Docs

BotCity Documentation

website·Indexed 34 days ago

https://documentation.botcity.dev

Documentation for BotCity's automation platform, featuring guides on web automations, CLI tools, and a wide array of plugins for integrating with AWS (SQS, Lambda, Secrets Manager, Textract), Google (Sheets, Calendar, Gmail, Drive, Cloud Vision), Microsoft 365 (Outlook, Excel, OneDrive, SharePoint), Slack, and Twilio WhatsApp.

Tokens
95.3K
Snippets
447
Records
858
Agent score
65%

What's inside BotCity

  1. Introduction to BotCity Orchestrator

    BotCity Orchestrator is an automation platform designed to support the full lifecycle of bots and automations. It bridges the gap between development and production by providing tools for deploying solutions, setting up runtime environments, and managing the operational phase of automations. Key capabilities include monitoring automations in runtime, synchronizing correlated processes, scheduling tasks, visualizing alerts and reports, and error handling.

  2. Overview of BotCity Amazon AWS Plugins

    BotCity provides a set of curated plugins to interact with various Amazon AWS services. Available plugins include:

    • S3: Manage buckets, files, and folders.
    • Secrets Manager: Create, list, retrieve, and update secrets.
    • SQS (Simple Queue Service): Create queues and handle message sending/receiving.
    • Lambda: Manage functions, retrieve aliases, and access function information.
    • Textract: Perform text extraction from images and documents.

  3. Overview of BotCity IP Allowlist

    The IP Allowlist is an access control feature that restricts access to the BotCity platform and API to a predefined set of authorized IP addresses. This is typically used to ensure access only from internal company networks, corporate VPNs, or environments with fixed IPs. Only users with the Administrator role can access and modify these settings.

  4. Overview of BotCity Google Service Plugins

    BotCity provides a suite of plugins to integrate with various Google services, allowing developers to automate tasks across the following platforms:

    • Gmail: Manage messages, attachments, filters, and labels.
    • Calendar: Create, retrieve, update, and delete calendar events.
    • Cloud Vision: Perform OCR and text extraction from images and documents.
    • Drive: Upload and download files with minimal code.
    • Sheets: Programmatically interact with and collaborate on spreadsheets via an API.

  5. Overview of BotCity Session Manager

    BotCity Session Manager is a desktop console application (CLI) that manages the activation and deactivation of sessions on remote machines based on demand from the BotCity Orchestrator task queue. It is designed to reduce Runner idle time and optimize resource scalability for enterprises.

    Key capabilities include:

    • Automated Resource Activation: Activates remote machines as the number of pending tasks in the Orchestrator increases.
    • Dynamic Deactivation: Releases and deactivates resources once tasks are completed and the queue is empty to reduce operational costs.
    • IT Compliance: Minimizes the window of active user sessions, reducing the risk of unauthorized access by closing sessions immediately after automation workflows finish.
    • Windows Service Integration: Can be installed as a Windows Service to run continuously in the background.

  6. Overview of BotCity Orchestrator Webhooks

    Webhooks allow the BotCity Orchestrator to send real-time operational events to any configured HTTP endpoint (e.g., Slack, Microsoft Teams, Datadog, Power BI, Google Chat). This eliminates the need to poll the Orchestrator API or maintain helper automations for notifications.

    Access Requirements:

    • Available only on paid plans.
    • Only users with the Administrator role can create, edit, delete, activate, or deactivate webhooks.

  7. Overview of the BeaPro Framework

    The BeaPro (BotCity Enterprise Automation Process) is a production-ready automation framework built on top of BotCity. It provides a pre-configured scaffolding that handles state management, structured error handling, and integration with the BotCity Orchestrator, allowing developers to focus on automation logic rather than infrastructure.

  8. Overview of BotCity Studio SDK components

    The BotCity Studio SDK is an all-in-one package used to build, deploy, and run BotCity automations. It consists of the following tools:

    • BotCity Studio: Tool for generating automatic code to interact with graphical elements.
    • BotCity Runner: Software responsible for executing tasks created in the Orchestrator.
    • BotCity CLI: Command line interface for automation management.
    • Session Manager: Tool for managing bot sessions.

  10. Overview of BotCity Runner Observability Features

    Starting with version 3.5.0, BotCity Runner includes observability tools to monitor and troubleshoot automation performance. Key features include:

    • Structured Logging: Support for TEXT or JSON formats with contextual metadata.
    • OpenTelemetry Integration: Ability to export logs to any OTLP-compatible backend.
    • MDC Context Propagation: Ensures consistent correlation across log entries for easier tracing.

  11. Overview of the BotCity Platform

    BotCity is a centralized platform designed for the governance, orchestration, and observability of automations, AI agents, and Python scripts. It provides a secure environment to execute, monitor, and scale automated solutions.

  12. Overview of BotCity Session Manager

    The Session Manager manages the allocation of automation tasks among available Runners across multiple hosts. It monitors the BotCity Orchestrator task queue and triggers host management when new tasks are created. It is designed for environments where multiple Runners are distributed across remote machines, typically with one Runner controlling the screen and others running background processes to avoid interference.

    Deployment Requirements:

    • The machine hosting Session Manager must have RDP access to the target hosts.
    • It must have HTTPS communication (Port 443) enabled with the BotCity Orchestrator.
    • Suggested dedicated environment: Linux OS with 2GB RAM.